Reference documentation and code samples for the Google Cloud Api Keys V2 Client class Key.
The representation of a key managed by the API Keys API.
Generated from protobuf message google.api.apikeys.v2.Key
Namespace
Google \ Cloud \ ApiKeys \ V2Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Output only. The resource name of the key. The name
has the form: projects/<PROJECT_NUMBER>/locations/global/keys/<KEY_ID>
. For example: projects/123456867718/locations/global/keys/b7ff1f9f-8275-410a-94dd-3855ee9b5dd2
NOTE: Key is a global resource; hence the only supported value for location is global
.
↳ uid
string
Output only. Unique id in UUID4 format.
↳ display_name
string
Human-readable display name of this key that you can modify. The maximum length is 63 characters.
↳ key_string
string
Output only. An encrypted and signed value held by this key. This field can be accessed only through the GetKeyString
method.
↳ create_time
Google\Protobuf\Timestamp
Output only. A timestamp identifying the time this key was originally created.
↳ update_time
↳ delete_time
Google\Protobuf\Timestamp
Output only. A timestamp when this key was deleted. If the resource is not deleted, this must be empty.
↳ annotations
array| Google\Protobuf\Internal\MapField
Annotations is an unstructured key-value map stored with a policy that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.
↳ restrictions
↳ etag
string
Output only. A checksum computed by the server based on the current value of the Key resource. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. See https://google.aip.dev/154 .
getName
Output only. The resource name of the key.
The name
has the form: projects/<PROJECT_NUMBER>/locations/global/keys/<KEY_ID>
.
For example: projects/123456867718/locations/global/keys/b7ff1f9f-8275-410a-94dd-3855ee9b5dd2
NOTE: Key is a global resource; hence the only supported value for
location is global
.
string
setName
Output only. The resource name of the key.
The name
has the form: projects/<PROJECT_NUMBER>/locations/global/keys/<KEY_ID>
.
For example: projects/123456867718/locations/global/keys/b7ff1f9f-8275-410a-94dd-3855ee9b5dd2
NOTE: Key is a global resource; hence the only supported value for
location is global
.
var
string
$this
getUid
Output only. Unique id in UUID4 format.
string
setUid
Output only. Unique id in UUID4 format.
var
string
$this
getDisplayName
Human-readable display name of this key that you can modify.
The maximum length is 63 characters.
string
setDisplayName
Human-readable display name of this key that you can modify.
The maximum length is 63 characters.
var
string
$this
getKeyString
Output only. An encrypted and signed value held by this key.
This field can be accessed only through the GetKeyString
method.
string
setKeyString
Output only. An encrypted and signed value held by this key.
This field can be accessed only through the GetKeyString
method.
var
string
$this
getCreateTime
Output only. A timestamp identifying the time this key was originally created.
hasCreateTime
clearCreateTime
setCreateTime
Output only. A timestamp identifying the time this key was originally created.
$this
getUpdateTime
Output only. A timestamp identifying the time this key was last updated.
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. A timestamp identifying the time this key was last updated.
$this
getDeleteTime
Output only. A timestamp when this key was deleted. If the resource is not deleted, this must be empty.
hasDeleteTime
clearDeleteTime
setDeleteTime
Output only. A timestamp when this key was deleted. If the resource is not deleted, this must be empty.
$this
getAnnotations
Annotations is an unstructured key-value map stored with a policy that may be set by external tools to store and retrieve arbitrary metadata.
They are not queryable and should be preserved when modifying objects.
setAnnotations
Annotations is an unstructured key-value map stored with a policy that may be set by external tools to store and retrieve arbitrary metadata.
They are not queryable and should be preserved when modifying objects.
$this
getRestrictions
Key restrictions.
hasRestrictions
clearRestrictions
setRestrictions
Key restrictions.
$this
getEtag
Output only. A checksum computed by the server based on the current value of the Key resource. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. See https://google.aip.dev/154 .
string
setEtag
Output only. A checksum computed by the server based on the current value of the Key resource. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. See https://google.aip.dev/154 .
var
string
$this
