Skip to main content

channels

Overview

Namechannels
TypeResource
Idgoogle.eventarc.channels

Fields

NameDatatypeDescription
namestringRequired. 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.
createTimestringOutput only. The creation time.
activationTokenstringOutput only. The activation token for the channel. The token must be used by the provider to register the channel for publishing.
providerstringThe 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}.
cryptoKeyNamestringResource 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/*.
uidstringOutput only. Server assigned unique identifier for the channel. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
pubsubTopicstringOutput 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}.
statestringOutput only. The state of a Channel.
updateTimestringOutput only. The last-modified time.

Methods

NameAccessible byRequired ParamsDescription
getSELECTchannelsId, locationsId, projectsIdGet a single Channel.
listSELECTlocationsId, projectsIdList channels.
createINSERTlocationsId, projectsIdCreate a new channel in a particular project and location.
deleteDELETEchannelsId, locationsId, projectsIdDelete a single channel.
_listEXEClocationsId, projectsIdList channels.
patchEXECchannelsId, locationsId, projectsIdUpdate a single channel.