channels

Creates, updates, deletes, gets or lists a channels resource.

Overview

Name	channels
Type	Resource
Id	google.eventarc.channels

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
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.
activationToken	string	Output only. The activation token for the channel. The token must be used by the provider to register the channel for publishing.
createTime	string (google-datetime)	Output only. The creation time.
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/*.
labels	object	Optional. Resource labels.
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}.
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}.
satisfiesPzs	boolean	Output only. Whether or not this Channel satisfies the requirements of physical zone separation
state	string	Output only. The state of a Channel.
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.
updateTime	string (google-datetime)	Output only. The last-modified time.

list

Successful response

Name	Datatype	Description
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.
activationToken	string	Output only. The activation token for the channel. The token must be used by the provider to register the channel for publishing.
createTime	string (google-datetime)	Output only. The creation time.
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/*.
labels	object	Optional. Resource labels.
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}.
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}.
satisfiesPzs	boolean	Output only. Whether or not this Channel satisfies the requirements of physical zone separation
state	string	Output only. The state of a Channel.
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.
updateTime	string (google-datetime)	Output only. The last-modified time.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, channelsId		Get a single Channel.
list	select	projectsId, locationsId	pageSize, pageToken, orderBy	List channels.
create	insert	projectsId, locationsId	channelId, validateOnly	Create a new channel in a particular project and location.
patch	update	projectsId, locationsId, channelsId	updateMask, validateOnly	Update a single channel.
delete	delete	projectsId, locationsId, channelsId	validateOnly	Delete a single channel.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
channelsId	string
locationsId	string
projectsId	string
channelId	string
orderBy	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)
validateOnly	boolean

SELECT examples

get

Get a single Channel.

SELECT
name,
activationToken,
createTime,
cryptoKeyName,
labels,
provider,
pubsubTopic,
satisfiesPzs,
state,
uid,
updateTime
FROM google.eventarc.channels
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND channelsId = '{{ channelsId }}' -- required;

list

List channels.

SELECT
name,
activationToken,
createTime,
cryptoKeyName,
labels,
provider,
pubsubTopic,
satisfiesPzs,
state,
uid,
updateTime
FROM google.eventarc.channels
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND orderBy = '{{ orderBy }}';

INSERT examples

create

Create a new channel in a particular project and location.

INSERT INTO google.eventarc.channels (
data__name,
data__provider,
data__cryptoKeyName,
data__labels,
projectsId,
locationsId,
channelId,
validateOnly
)
SELECT 
'{{ name }}',
'{{ provider }}',
'{{ cryptoKeyName }}',
'{{ labels }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ channelId }}',
'{{ validateOnly }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: channels
  props:
    - name: projectsId
      value: string
      description: Required parameter for the channels resource.
    - name: locationsId
      value: string
      description: Required parameter for the channels resource.
    - name: name
      value: string
      description: >
        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.
        
    - name: provider
      value: string
      description: >
        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}`.
        
    - name: cryptoKeyName
      value: string
      description: >
        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/*`.
        
    - name: labels
      value: object
      description: >
        Optional. Resource labels.
        
    - name: channelId
      value: string
    - name: validateOnly
      value: boolean

UPDATE examples

patch

Update a single channel.

UPDATE google.eventarc.channels
SET 
data__name = '{{ name }}',
data__provider = '{{ provider }}',
data__cryptoKeyName = '{{ cryptoKeyName }}',
data__labels = '{{ labels }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND channelsId = '{{ channelsId }}' --required
AND updateMask = '{{ updateMask}}'
AND validateOnly = {{ validateOnly}}
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

delete

Delete a single channel.

DELETE FROM google.eventarc.channels
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND channelsId = '{{ channelsId }}' --required
AND validateOnly = '{{ validateOnly }}';