Google Cloud Tasks V2 Client - Class CmekConfig (2.3.0)

Reference documentation and code samples for the Google Cloud Tasks V2 Client class CmekConfig.

Describes the customer-managed encryption key (CMEK) configuration associated with a project and location.

Generated from protobuf message google.cloud.tasks.v2.CmekConfig

Namespace

Google \ Cloud \ Tasks \ V2

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

Output only. The config resource name which includes the project and location and must end in 'cmekConfig', in the format projects/PROJECT_ID/locations/LOCATION_ID/cmekConfig
↳ kms_key string

Resource name of the Cloud KMS key, of the form projects/PROJECT_ID/locations/LOCATION_ID/keyRings/KEY_RING_ID/cryptoKeys/KEY_ID, that will be used to encrypt the Queues & Tasks in the region. Setting this as blank will turn off CMEK encryption.

getName

Output only. The config resource name which includes the project and location and must end in 'cmekConfig', in the format projects/PROJECT_ID/locations/LOCATION_ID/cmekConfig

Returns
Type Description
string

setName

Output only. The config resource name which includes the project and location and must end in 'cmekConfig', in the format projects/PROJECT_ID/locations/LOCATION_ID/cmekConfig

Parameter
Name Description
var string
Returns
Type Description
$this

getKmsKey

Resource name of the Cloud KMS key, of the form projects/PROJECT_ID/locations/LOCATION_ID/keyRings/KEY_RING_ID/cryptoKeys/KEY_ID, that will be used to encrypt the Queues & Tasks in the region. Setting this as blank will turn off CMEK encryption.

Returns
Type Description
string

setKmsKey

Resource name of the Cloud KMS key, of the form projects/PROJECT_ID/locations/LOCATION_ID/keyRings/KEY_RING_ID/cryptoKeys/KEY_ID, that will be used to encrypt the Queues & Tasks in the region. Setting this as blank will turn off CMEK encryption.

Parameter
Name Description
var string
Returns
Type Description
$this