Resource: 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.
JSON representation |
---|
{ "name": string, "uid": string, "createTime": string, "updateTime": string, "provider": string, "state": enum ( |
Fields | |
---|---|
name |
Required. The resource name of the channel. Must be unique within the location on the project and must be in |
uid |
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. |
createTime |
Output only. The creation time. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
updateTime |
Output only. The last-modified time. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
provider |
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: |
state |
Output only. The state of a Channel. |
activationToken |
Output only. The activation token for the channel. The token must be used by the provider to register the channel for publishing. |
cryptoKeyName |
Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt their event data. It must match the pattern |
Union field
|
|
pubsubTopic |
Output only. The name of the Pub/Sub topic created and managed by Eventarc system as a transport for the event delivery. Format: |
State
State lists all the possible states of a Channel
Enums | |
---|---|
STATE_UNSPECIFIED |
Default value. This value is unused. |
PENDING |
The PENDING state indicates that a Channel has been created successfully and there is a new activation token available for the subscriber to use to convey the Channel to the provider in order to create a Connection. |
ACTIVE |
The ACTIVE state indicates that a Channel has been successfully connected with the event provider. An ACTIVE Channel is ready to receive and route events from the event provider. |
INACTIVE |
The INACTIVE state indicates that the Channel cannot receive events permanently. There are two possible cases this state can happen:
To re-establish a Connection with a provider, the subscriber should create a new Channel and give it to the provider. |
Methods |
|
---|---|
|
Create a new channel in a particular project and location. |
|
Delete a single channel. |
|
Get a single Channel. |
|
Gets the access control policy for a resource. |
|
List channels. |
|
Update a single channel. |
|
Sets the access control policy on the specified resource. |
|
Returns permissions that a caller has on the specified resource. |