Google Cloud Eventarc V1 Client - Class Channel (2.1.1)

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

A representation of the Channel resource.

A Channel is a resource on which event providers publish their events. The published events are delivered through the transport associated with the channel. Note that a channel is associated with exactly one event provider.

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

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 channel. Must be unique within the location on the project and must be in `projects/{project}/locations/{location}/channels/{channel_id}` format.
`↳ uid`	`string` Output only. Server assigned unique identifier for the channel. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
`↳ create_time`	`Google\Protobuf\Timestamp` Output only. The creation time.
`↳ update_time`	`Google\Protobuf\Timestamp` Output only. The last-modified time.
`↳ provider`	`string` The name of the event provider (e.g. Eventarc SaaS partner) associated with the channel. This provider will be granted permissions to publish events to the channel. Format: `projects/{project}/locations/{location}/providers/{provider_id}`.
`↳ pubsub_topic`	`string` Output only. The name of the Pub/Sub topic created and managed by Eventarc system as a transport for the event delivery. Format: `projects/{project}/topics/{topic_id}`.
`↳ state`	`int` Output only. The state of a Channel.
`↳ activation_token`	`string` Output only. The activation token for the channel. The token must be used by the provider to register the channel for publishing.
`↳ crypto_key_name`	`string` 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/`.
`↳ satisfies_pzs`	`bool` Output only. Whether or not this Channel satisfies the requirements of physical zone separation

getName

Required. The resource name of the channel. Must be unique within the location on the project and must be in projects/{project}/locations/{location}/channels/{channel_id} format.

Returns
Type	Description
`string`

setName

Required. The resource name of the channel. Must be unique within the location on the project and must be in projects/{project}/locations/{location}/channels/{channel_id} format.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getUid

Output only. Server assigned unique identifier for the channel. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.

Returns
Type	Description
`string`

setUid

Output only. Server assigned unique identifier for the channel. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCreateTime

Output only. The creation time.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasCreateTime

clearCreateTime

setCreateTime

Output only. The creation time.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

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`

getProvider

The name of the event provider (e.g. Eventarc SaaS partner) associated with the channel. This provider will be granted permissions to publish events to the channel. Format: projects/{project}/locations/{location}/providers/{provider_id}.

Returns
Type	Description
`string`

setProvider

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getPubsubTopic

Output only. The name of the Pub/Sub topic created and managed by Eventarc system as a transport for the event delivery. Format: projects/{project}/topics/{topic_id}.

Returns
Type	Description
`string`

hasPubsubTopic

setPubsubTopic

Output only. The name of the Pub/Sub topic created and managed by Eventarc system as a transport for the event delivery. Format: projects/{project}/topics/{topic_id}.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getState

Output only. The state of a Channel.

Returns
Type	Description
`int`

setState

Output only. The state of a Channel.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getActivationToken

Output only. The activation token for the channel. The token must be used by the provider to register the channel for publishing.

Returns
Type	Description
`string`

setActivationToken

Output only. The activation token for the channel. The token must be used by the provider to register the channel for publishing.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCryptoKeyName

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

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`

getSatisfiesPzs

Output only. Whether or not this Channel satisfies the requirements of physical zone separation

Returns
Type	Description
`bool`

setSatisfiesPzs

Output only. Whether or not this Channel satisfies the requirements of physical zone separation

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getTransport

Returns
Type	Description
`string`