Reference documentation and code samples for the Cloud KMS V1 Client class AutokeyConfig.
Cloud KMS Autokey configuration for a folder.
Generated from protobuf message google.cloud.kms.v1.AutokeyConfig
Namespace
Google \ Cloud \ Kms \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
↳ key_project
string
Optional. Name of the key project, e.g. projects/{PROJECT_ID}
or projects/{PROJECT_NUMBER}
, where Cloud KMS Autokey will provision a new CryptoKey
when a KeyHandle
is created. On UpdateAutokeyConfig
, the caller will require cloudkms.cryptoKeys.setIamPolicy
permission on this key project. Once configured, for Cloud KMS Autokey to function properly, this key project must have the Cloud KMS API activated and the Cloud KMS Service Agent for this key project must be granted the cloudkms.admin
role (or pertinent permissions). A request with an empty key project field will clear the configuration.
↳ state
int
Output only. The state for the AutokeyConfig.
↳ etag
string
Optional. A checksum computed by the server based on the value of other fields. This may be sent on update requests to ensure that the client has an up-to-date value before proceeding. The request will be rejected with an ABORTED error on a mismatched etag.
getName
Identifier. Name of the AutokeyConfig
resource, e.g. folders/{FOLDER_NUMBER}/autokeyConfig
.
string
setName
Identifier. Name of the AutokeyConfig
resource, e.g. folders/{FOLDER_NUMBER}/autokeyConfig
.
var
string
$this
getKeyProject
Optional. Name of the key project, e.g. projects/{PROJECT_ID}
or projects/{PROJECT_NUMBER}
, where Cloud KMS Autokey will provision a new CryptoKey
when a KeyHandle
is created. On UpdateAutokeyConfig
,
the caller will require cloudkms.cryptoKeys.setIamPolicy
permission on
this key project. Once configured, for Cloud KMS Autokey to function
properly, this key project must have the Cloud KMS API activated and the
Cloud KMS Service Agent for this key project must be granted the cloudkms.admin
role (or pertinent permissions). A request with an empty
key project field will clear the configuration.
string
setKeyProject
Optional. Name of the key project, e.g. projects/{PROJECT_ID}
or projects/{PROJECT_NUMBER}
, where Cloud KMS Autokey will provision a new CryptoKey
when a KeyHandle
is created. On UpdateAutokeyConfig
,
the caller will require cloudkms.cryptoKeys.setIamPolicy
permission on
this key project. Once configured, for Cloud KMS Autokey to function
properly, this key project must have the Cloud KMS API activated and the
Cloud KMS Service Agent for this key project must be granted the cloudkms.admin
role (or pertinent permissions). A request with an empty
key project field will clear the configuration.
var
string
$this
getState
Output only. The state for the AutokeyConfig.
int
setState
Output only. The state for the AutokeyConfig.
var
int
$this
getEtag
Optional. A checksum computed by the server based on the value of other fields. This may be sent on update requests to ensure that the client has an up-to-date value before proceeding. The request will be rejected with an ABORTED error on a mismatched etag.
string
setEtag
Optional. A checksum computed by the server based on the value of other fields. This may be sent on update requests to ensure that the client has an up-to-date value before proceeding. The request will be rejected with an ABORTED error on a mismatched etag.
var
string
$this
