Represents a service account key.

A service account has two sets of key-pairs: user-managed, and
system-managed.
User-managed key-pairs can be created and deleted by users. Users are
responsible for rotating these keys periodically to ensure security of
their service accounts. Users retain the private key of these key-pairs,
and Google retains ONLY the public key.
System-managed keys are automatically rotated by Google, and are used for
signing for a maximum of two weeks. The rotation process is probabilistic,
and usage of the new key will gradually ramp up and down over the key's
lifetime. We recommend caching the public key set for a service account for
no more than 24 hours to ensure you have access to the latest keys.
Public keys for all service accounts are also published at the OAuth2
Service Account API.

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

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 getKeyAlgorithm()
     

    Specifies the algorithm (and possibly key size) for the key.

    Generated from protobuf field .google.iam.admin.v1.ServiceAccountKeyAlgorithm key_algorithm = 8;

    • return int
    public getName()
     

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

    Generated from protobuf field string name = 1;

    • return string
    public getPrivateKeyData()
     

    The private key data. Only provided in CreateServiceAccountKey
    responses. Make sure to keep the private key data secure because it
    allows for the assertion of the service account identity.

    When base64 decoded, the private key data can be used to authenticate with
    Google API client libraries and with
    gcloud
    auth activate-service-account
    .

    Generated from protobuf field bytes private_key_data = 3;

    • return string
    public getPrivateKeyType()
     

    The output format for the private key.

    Only provided in CreateServiceAccountKey responses, not
    in GetServiceAccountKey or ListServiceAccountKey responses.
    Google never exposes system-managed private keys, and never retains
    user-managed private keys.

    Generated from protobuf field .google.iam.admin.v1.ServiceAccountPrivateKeyType private_key_type = 2;

    • return int
    public getPublicKeyData()
     

    The public key data. Only provided in GetServiceAccountKey responses.

    Generated from protobuf field bytes public_key_data = 7;

    • return string
    public getValidAfterTime()
     

    The key can be used after this timestamp.

    Generated from protobuf field .google.protobuf.Timestamp valid_after_time = 4;

    public getValidBeforeTime()
     

    The key can be used before this timestamp.

    For system-managed key pairs, this timestamp is the end time for the
    private key signing operation. The public key could still be used
    for verification for a few hours after this time.

    Generated from protobuf field .google.protobuf.Timestamp valid_before_time = 5;

    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 setKeyAlgorithm( $var)
     

    Specifies the algorithm (and possibly key size) for the key.

    Generated from protobuf field .google.iam.admin.v1.ServiceAccountKeyAlgorithm key_algorithm = 8;

    • return $this
    public setName( $var)
     

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

    Generated from protobuf field string name = 1;

    • return $this
    public setPrivateKeyData( $var)
     

    The private key data. Only provided in CreateServiceAccountKey
    responses. Make sure to keep the private key data secure because it
    allows for the assertion of the service account identity.

    When base64 decoded, the private key data can be used to authenticate with
    Google API client libraries and with
    gcloud
    auth activate-service-account
    .

    Generated from protobuf field bytes private_key_data = 3;

    • return $this
    public setPrivateKeyType( $var)
     

    The output format for the private key.

    Only provided in CreateServiceAccountKey responses, not
    in GetServiceAccountKey or ListServiceAccountKey responses.
    Google never exposes system-managed private keys, and never retains
    user-managed private keys.

    Generated from protobuf field .google.iam.admin.v1.ServiceAccountPrivateKeyType private_key_type = 2;

    • return $this
    public setPublicKeyData( $var)
     

    The public key data. Only provided in GetServiceAccountKey responses.

    Generated from protobuf field bytes public_key_data = 7;

    • return $this
    public setValidAfterTime( $var)
     

    The key can be used after this timestamp.

    Generated from protobuf field .google.protobuf.Timestamp valid_after_time = 4;

    • return $this
    public setValidBeforeTime( $var)
     

    The key can be used before this timestamp.

    For system-managed key pairs, this timestamp is the end time for the
    private key signing operation. The public key could still be used
    for verification for a few hours after this time.

    Generated from protobuf field .google.protobuf.Timestamp valid_before_time = 5;

    • 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 $key_algorithm
     

    Specifies the algorithm (and possibly key size) for the key.

    Generated from protobuf field .google.iam.admin.v1.ServiceAccountKeyAlgorithm key_algorithm = 8;

    private $name
     

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

    Generated from protobuf field string name = 1;

    private $private_key_data
     

    The private key data. Only provided in CreateServiceAccountKey
    responses. Make sure to keep the private key data secure because it
    allows for the assertion of the service account identity.

    When base64 decoded, the private key data can be used to authenticate with
    Google API client libraries and with
    gcloud
    auth activate-service-account
    .

    Generated from protobuf field bytes private_key_data = 3;

    private $private_key_type
     

    The output format for the private key.

    Only provided in CreateServiceAccountKey responses, not
    in GetServiceAccountKey or ListServiceAccountKey responses.
    Google never exposes system-managed private keys, and never retains
    user-managed private keys.

    Generated from protobuf field .google.iam.admin.v1.ServiceAccountPrivateKeyType private_key_type = 2;

    private $public_key_data
     

    The public key data. Only provided in GetServiceAccountKey responses.

    Generated from protobuf field bytes public_key_data = 7;

    private $valid_after_time
     

    The key can be used after this timestamp.

    Generated from protobuf field .google.protobuf.Timestamp valid_after_time = 4;

    private $valid_before_time
     

    The key can be used before this timestamp.

    For system-managed key pairs, this timestamp is the end time for the
    private key signing operation. The public key could still be used
    for verification for a few hours after this time.

    Generated from protobuf field .google.protobuf.Timestamp valid_before_time = 5;

    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