Google Cloud Observability V1 Client - Class CmekSettings (0.1.0)

Reference documentation and code samples for the Google Cloud Observability V1 Client class CmekSettings.

Settings for configuring CMEK for a bucket.

Generated from protobuf message google.cloud.observability.v1.CmekSettings

Namespace

Google \ Cloud \ Observability \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ kms_key`	`string` Optional. The resource name for the configured Cloud KMS key. The format is: projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY] For example: projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key
`↳ kms_key_version`	`string` Output only. The CryptoKeyVersion resource name for the configured Cloud KMS key. The format is: projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]/cryptoKeyVersions/[VERSION] For example: projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key/cryptoKeyVersions/1 This read-only field is used to convey the specific configured CryptoKeyVersion of the `kms_key` that has been configured. It is populated when the CMEK settings are bound to a single key version.
`↳ service_account_id`	`string` Output only. The service account used to access the key.

getKmsKey

Optional. The resource name for the configured Cloud KMS key. The format is: projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY] For example: projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key

Returns
Type	Description
`string`

setKmsKey

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getKmsKeyVersion

Output only. The CryptoKeyVersion resource name for the configured Cloud KMS key. The format is: projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]/cryptoKeyVersions/[VERSION] For example: projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key/cryptoKeyVersions/1 This read-only field is used to convey the specific configured CryptoKeyVersion of the kms_key that has been configured. It is populated when the CMEK settings are bound to a single key version.

Returns
Type	Description
`string`

setKmsKeyVersion

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getServiceAccountId

Output only. The service account used to access the key.

Returns
Type	Description
`string`

setServiceAccountId