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 ( |
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/{channelId}
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.
createTime
string (
Timestamp
format)
Output only. The creation time.
Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z"
, "2014-10-02T15:01:23.045123456Z"
or "2014-10-02T15:01:23+05:30"
.
updateTime
string (
Timestamp
format)
Output only. The last-modified time.
Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z"
, "2014-10-02T15:01:23.045123456Z"
or "2014-10-02T15:01:23+05:30"
.
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/{providerId}
.
state
enum (
State
)
Output only. The state of a Channel.
activationToken
string
Output only. The activation token for the channel. The token must be used by the provider to register the channel for publishing.
cryptoKeyName
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/*
.
satisfiesPzs
boolean
Output only. Whether or not this Channel satisfies the requirements of physical zone separation
labels
map (key: string, value: string)
Optional. Resource labels.
An object containing a list of "key": value
pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }
.
Union field transport
.
transport
can be only one of the following:
pubsubTopic
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
State lists all the possible states of a Channel
STATE_UNSPECIFIED
PENDING
ACTIVE
INACTIVE
The INACTIVE state indicates that the Channel cannot receive events permanently. There are two possible cases this state can happen:
- The SaaS provider disconnected from this Channel.
- The Channel activation token has expired but the SaaS provider wasn't connected.
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. |
