channels

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

Overview

Name	channels
Type	Resource
Id	google.eventarc.channels

Fields

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	Output only. The creation time.
cryptoKeyName	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/*.
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	Output only. The last-modified time.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	channelsId, locationsId, projectsId	Get a single Channel.
list	SELECT	locationsId, projectsId	List channels.
create	INSERT	locationsId, projectsId	Create a new channel in a particular project and location.
delete	DELETE	channelsId, locationsId, projectsId	Delete a single channel.
patch	UPDATE	channelsId, locationsId, projectsId	Update a single channel.

SELECT examples

List channels.

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

INSERT example

Use the following StackQL query and manifest file to create a new channels resource.

All Properties

/*+ create */
INSERT INTO google.eventarc.channels (
locationsId,
projectsId,
name,
provider,
cryptoKeyName
)
SELECT 
'{{ locationsId }}',
'{{ projectsId }}',
'{{ name }}',
'{{ provider }}',
'{{ cryptoKeyName }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: name
      value: string
    - name: uid
      value: string
    - name: createTime
      value: string
    - name: updateTime
      value: string
    - name: provider
      value: string
    - name: pubsubTopic
      value: string
    - name: state
      value: string
    - name: activationToken
      value: string
    - name: cryptoKeyName
      value: string
    - name: satisfiesPzs
      value: boolean

UPDATE example

Updates a channels resource.

/*+ update */
UPDATE google.eventarc.channels
SET 
name = '{{ name }}',
provider = '{{ provider }}',
cryptoKeyName = '{{ cryptoKeyName }}'
WHERE 
channelsId = '{{ channelsId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

DELETE example

Deletes the specified channels resource.

/*+ delete */
DELETE FROM google.eventarc.channels
WHERE channelsId = '{{ channelsId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';