A service account in the Identity and Access Management API.

To create a service account, specify the project_id and the account_id
for the account. The account_id is unique within the project, and is used
to generate the service account email address and a stable
unique_id.
If the account already exists, the account's resource name is returned
in the format of projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}. The caller
can use the name in other methods to access the account.
All other methods can identify the service account using the format
projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}.
Using - as a wildcard for the PROJECT_ID will infer the project from
the account. The ACCOUNT value can be the email address or the
unique_id of the service account.

Generated from protobuf message google.iam.admin.v1.ServiceAccount

CloneableInstantiable
ExtendsGoogle\Protobuf\Internal\Message
Methods
public __construct( $data = NULL)
 

Constructor.

    public Google\Protobuf\Internal\Message::byteSize()
     
    • ignore
    public Google\Protobuf\Internal\Message::clear()
     

    Clear all containing fields.

    • return
    public Google\Protobuf\Internal\Message::discardUnknownFields()
     

    Clear all unknown fields previously parsed.

    • return
    public getDisplayName()
     

    Optional. A user-specified name for the service account.

    Must be less than or equal to 100 UTF-8 bytes.

    Generated from protobuf field string display_name = 6;

    • return string
    public getEmail()
     

    @OutputOnly The email address of the service account.

    Generated from protobuf field string email = 5;

    • return string
    public getEtag()
     

    Optional. Note: etag is an inoperable legacy field that is only returned
    for backwards compatibility.

    Generated from protobuf field bytes etag = 7;

    • return string
    public getName()
     

    The resource name of the service account in the following format:
    projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}.

    Requests using - as a wildcard for the PROJECT_ID will infer the
    project from the account and the ACCOUNT value can be the email
    address or the unique_id of the service account.
    In responses the resource name will always be in the format
    projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}.

    Generated from protobuf field string name = 1;

    • return string
    public getOauth2ClientId()
     

    @OutputOnly. The OAuth2 client id for the service account.

    This is used in conjunction with the OAuth2 clientconfig API to make
    three legged OAuth2 (3LO) flows to access the data of Google users.

    Generated from protobuf field string oauth2_client_id = 9;

    • return string
    public getProjectId()
     

    @OutputOnly The id of the project that owns the service account.

    Generated from protobuf field string project_id = 2;

    • return string
    public getUniqueId()
     

    @OutputOnly The unique and stable id of the service account.

    Generated from protobuf field string unique_id = 4;

    • return string
    public Google\Protobuf\Internal\Message::jsonByteSize()
     
    • ignore
    public Google\Protobuf\Internal\Message::mergeFrom( $msg)
     

    Merges the contents of the specified message into current message.

    This method merges the contents of the specified message into the
    current message. Singular fields that are set in the specified message
    overwrite the corresponding fields in the current message. Repeated
    fields are appended. Map fields key-value pairs are overwritten.
    Singular/Oneof sub-messages are recursively merged. All overwritten
    sub-messages are deep-copied.

    • return
    public Google\Protobuf\Internal\Message::mergeFromJsonString( $data, $ignore_unknown = false)
     

    Parses a json string to protobuf message.

    This function takes a string in the json wire format, matching the
    encoding output by serializeToJsonString().
    See mergeFrom() for merging behavior, if the field is already set in the
    specified message.

    • return
    • throws Exception Invalid data.
    public Google\Protobuf\Internal\Message::mergeFromString( $data)
     

    Parses a protocol buffer contained in a string.

    This function takes a string in the (non-human-readable) binary wire
    format, matching the encoding output by serializeToString().
    See mergeFrom() for merging behavior, if the field is already set in the
    specified message.

    • return
    • throws Exception Invalid data.
    public Google\Protobuf\Internal\Message::parseFromJsonStream( $input, $ignore_unknown)
     
    • ignore
    public Google\Protobuf\Internal\Message::parseFromStream( $input)
     
    • ignore
    public Google\Protobuf\Internal\Message::serializeToJsonStream( $output)
     
    • ignore
    public Google\Protobuf\Internal\Message::serializeToJsonString()
     

    Serialize the message to json string.

    • return string Serialized json protobuf data.
    public Google\Protobuf\Internal\Message::serializeToStream( $output)
     
    • ignore
    public Google\Protobuf\Internal\Message::serializeToString()
     

    Serialize the message to string.

    • return string Serialized binary protobuf data.
    public setDisplayName( $var)
     

    Optional. A user-specified name for the service account.

    Must be less than or equal to 100 UTF-8 bytes.

    Generated from protobuf field string display_name = 6;

    • return $this
    public setEmail( $var)
     

    @OutputOnly The email address of the service account.

    Generated from protobuf field string email = 5;

    • return $this
    public setEtag( $var)
     

    Optional. Note: etag is an inoperable legacy field that is only returned
    for backwards compatibility.

    Generated from protobuf field bytes etag = 7;

    • return $this
    public setName( $var)
     

    The resource name of the service account in the following format:
    projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}.

    Requests using - as a wildcard for the PROJECT_ID will infer the
    project from the account and the ACCOUNT value can be the email
    address or the unique_id of the service account.
    In responses the resource name will always be in the format
    projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}.

    Generated from protobuf field string name = 1;

    • return $this
    public setOauth2ClientId( $var)
     

    @OutputOnly. The OAuth2 client id for the service account.

    This is used in conjunction with the OAuth2 clientconfig API to make
    three legged OAuth2 (3LO) flows to access the data of Google users.

    Generated from protobuf field string oauth2_client_id = 9;

    • return $this
    public setProjectId( $var)
     

    @OutputOnly The id of the project that owns the service account.

    Generated from protobuf field string project_id = 2;

    • return $this
    public setUniqueId( $var)
     

    @OutputOnly The unique and stable id of the service account.

    Generated from protobuf field string unique_id = 4;

    • return $this
    Methods
    protected Google\Protobuf\Internal\Message::mergeFromArray(array $array)
     

    Populates the message from a user-supplied PHP array. Array keys
    correspond to Message properties and nested message properties.

    Example:

    $message->mergeFromArray([
        'name' => 'This is a message name',
        'interval' => [
             'startTime' => time() - 60,
             'endTime' => time(),
        ]
    ]);
    

    This method will trigger an error if it is passed data that cannot
    be converted to the correct type. For example, a StringValue field
    must receive data that is either a string or a StringValue object.

    • return
    protected Google\Protobuf\Internal\Message::mergeFromJsonArray( $array, $ignore_unknown)
    protected Google\Protobuf\Internal\Message::readOneof( $number)
    protected Google\Protobuf\Internal\Message::readWrapperValue( $member)
    protected Google\Protobuf\Internal\Message::whichOneof( $oneof_name)
    protected Google\Protobuf\Internal\Message::writeOneof( $number, $value)
    protected Google\Protobuf\Internal\Message::writeWrapperValue( $member, $value)
    Properties
    private $display_name
     

    Optional. A user-specified name for the service account.

    Must be less than or equal to 100 UTF-8 bytes.

    Generated from protobuf field string display_name = 6;

    private $email
     

    @OutputOnly The email address of the service account.

    Generated from protobuf field string email = 5;

    private $etag
     

    Optional. Note: etag is an inoperable legacy field that is only returned
    for backwards compatibility.

    Generated from protobuf field bytes etag = 7;

    private $name
     

    The resource name of the service account in the following format:
    projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}.

    Requests using - as a wildcard for the PROJECT_ID will infer the
    project from the account and the ACCOUNT value can be the email
    address or the unique_id of the service account.
    In responses the resource name will always be in the format
    projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}.

    Generated from protobuf field string name = 1;

    private $oauth2_client_id
     

    @OutputOnly. The OAuth2 client id for the service account.

    This is used in conjunction with the OAuth2 clientconfig API to make
    three legged OAuth2 (3LO) flows to access the data of Google users.

    Generated from protobuf field string oauth2_client_id = 9;

    private $project_id
     

    @OutputOnly The id of the project that owns the service account.

    Generated from protobuf field string project_id = 2;

    private $unique_id
     

    @OutputOnly The unique and stable id of the service account.

    Generated from protobuf field string unique_id = 4;

    Methods
    private Google\Protobuf\Internal\Message::appendHelper( $field, $append_value)
    private Google\Protobuf\Internal\Message::convertJsonValueToProtoValue( $value, $field, $ignore_unknown, $is_map_key = false)
    private Google\Protobuf\Internal\Message::defaultValue( $field)
     
    • ignore
    private Google\Protobuf\Internal\Message::existField( $field)
     
    • ignore
    private Google\Protobuf\Internal\Message::fieldByteSize( $field)
     
    • ignore
    private Google\Protobuf\Internal\Message::fieldDataOnlyByteSize( $field, $value)
     
    • ignore
    private Google\Protobuf\Internal\Message::fieldDataOnlyJsonByteSize( $field, $value)
     
    • ignore
    private Google\Protobuf\Internal\Message::fieldJsonByteSize( $field)
     
    • ignore
    private Google\Protobuf\Internal\Message::initWithDescriptor(Google\Protobuf\Internal\Descriptor $desc)
     
    • ignore
    private Google\Protobuf\Internal\Message::initWithGeneratedPool()
     
    • ignore
    private Google\Protobuf\Internal\Message::kvUpdateHelper( $field, $update_key, $update_value)
    private Google\Protobuf\Internal\Message::mergeFromArrayJsonImpl( $array, $ignore_unknown)
    private static Google\Protobuf\Internal\Message::normalizeArrayElementsToMessageType( $value, $class)
     

    Tries to normalize the elements in $value into a provided protobuf
    wrapper type $class. If $value is any type other than array, we do
    not do any conversion, and instead rely on the existing protobuf
    type checking. If $value is an array, we process each element and
    try to convert it to an instance of $class.

      private static Google\Protobuf\Internal\Message::normalizeToMessageType( $value, $class)
       

      Tries to normalize $value into a provided protobuf wrapper type $class.

      If $value is any type other than an object, we attempt to construct an
      instance of $class and assign $value to it using the setValue method
      shared by all wrapper types.

      This method will raise an error if it receives a type that cannot be
      assigned to the wrapper type via setValue.

        private Google\Protobuf\Internal\Message::parseFieldFromStream( $tag, $input, $field)
         
        • ignore
        private static Google\Protobuf\Internal\Message::parseFieldFromStreamNoTag( $input, $field, $value)
         
        • ignore
        private Google\Protobuf\Internal\Message::repeatedFieldDataOnlyByteSize( $field)
         
        • ignore
        private Google\Protobuf\Internal\Message::serializeFieldToJsonStream( $output, $field)
         
        • ignore
        private Google\Protobuf\Internal\Message::serializeFieldToStream( $output, $field)
         
        • ignore
        private Google\Protobuf\Internal\Message::serializeMapFieldToStream( $field, $output)
         
        • ignore
        private Google\Protobuf\Internal\Message::serializeRepeatedFieldToStream( $field, $output)
         
        • ignore
        private Google\Protobuf\Internal\Message::serializeSingularFieldToStream( $field, $output)
         
        • ignore
        private Google\Protobuf\Internal\Message::skipField( $input, $tag)
         
        • ignore
        Methods
        private static Google\Protobuf\Internal\Message::normalizeArrayElementsToMessageType( $value, $class)
         

        Tries to normalize the elements in $value into a provided protobuf
        wrapper type $class. If $value is any type other than array, we do
        not do any conversion, and instead rely on the existing protobuf
        type checking. If $value is an array, we process each element and
        try to convert it to an instance of $class.

          private static Google\Protobuf\Internal\Message::normalizeToMessageType( $value, $class)
           

          Tries to normalize $value into a provided protobuf wrapper type $class.

          If $value is any type other than an object, we attempt to construct an
          instance of $class and assign $value to it using the setValue method
          shared by all wrapper types.

          This method will raise an error if it receives a type that cannot be
          assigned to the wrapper type via setValue.

            private static Google\Protobuf\Internal\Message::parseFieldFromStreamNoTag( $input, $field, $value)
             
            • ignore
            © 2020 Bruce Wells
            Search Namespaces \ Classes
            ConfigurationNumbers (0-9.) only