Google Cloud Eventarc V1 Client - Class GoogleChannelConfig (2.2.0)

Reference documentation and code samples for the Google Cloud Eventarc V1 Client class GoogleChannelConfig.

A GoogleChannelConfig is a resource that stores the custom settings respected by Eventarc first-party triggers in the matching region.

Once configured, first-party event data will be protected using the specified custom managed encryption key instead of Google-managed encryption keys.

Generated from protobuf message google.cloud.eventarc.v1.GoogleChannelConfig

Namespace

Google \ Cloud \ Eventarc \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Required. The resource name of the config. Must be in the format of, projects/{project}/locations/{location}/googleChannelConfig. In API responses, the config name always includes the projectID, regardless of whether the projectID or projectNumber was provided.

↳ update_time Google\Protobuf\Timestamp

Output only. The last-modified time.

↳ crypto_key_name string

Optional. Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt their event data. It must match the pattern projects/*/locations/*/keyRings/*/cryptoKeys/*.

↳ labels array|Google\Protobuf\Internal\MapField

Optional. Resource labels.

getName

Required. The resource name of the config. Must be in the format of, projects/{project}/locations/{location}/googleChannelConfig.

In API responses, the config name always includes the projectID, regardless of whether the projectID or projectNumber was provided.

Returns
Type Description
string

setName

Required. The resource name of the config. Must be in the format of, projects/{project}/locations/{location}/googleChannelConfig.

In API responses, the config name always includes the projectID, regardless of whether the projectID or projectNumber was provided.

Parameter
Name Description
var string
Returns
Type Description
$this

getUpdateTime

Output only. The last-modified time.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The last-modified time.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getCryptoKeyName

Optional. Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt their event data.

It must match the pattern projects/*/locations/*/keyRings/*/cryptoKeys/*.

Returns
Type Description
string

setCryptoKeyName

Optional. Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt their event data.

It must match the pattern projects/*/locations/*/keyRings/*/cryptoKeys/*.

Parameter
Name Description
var string
Returns
Type Description
$this

getLabels

Optional. Resource labels.

Returns
Type Description
Google\Protobuf\Internal\MapField

setLabels

Optional. Resource labels.

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this