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 \ V1Methods
__construct
Constructor.
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
↳ update_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.
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.
var
string
$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.
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.
var
string
$this
getCreateTime
Output only. The creation time.
hasCreateTime
clearCreateTime
setCreateTime
Output only. The creation time.
$this
getUpdateTime
Output only. The last-modified time.
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The last-modified time.
$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}
.
string
setProvider
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}
.
var
string
$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}
.
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}
.
var
string
$this
getState
Output only. The state of a Channel.
int
setState
Output only. The state of a Channel.
var
int
$this
getActivationToken
Output only. The activation token for the channel. The token must be used by the provider to register the channel for publishing.
string
setActivationToken
Output only. The activation token for the channel. The token must be used by the provider to register the channel for publishing.
var
string
$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/*
.
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/*
.
var
string
$this
getSatisfiesPzs
Output only. Whether or not this Channel satisfies the requirements of physical zone separation
bool
setSatisfiesPzs
Output only. Whether or not this Channel satisfies the requirements of physical zone separation
var
bool
$this
getTransport
string
