channel_connections

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

Overview

Name	channel_connections
Type	Resource
Id	google.eventarc.channel_connections

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Required. The name of the connection.
activationToken	string	Input only. Activation token for the channel. The token will be used during the creation of ChannelConnection to bind the channel with the provider project. This field will not be stored in the provider resource.
channel	string	Required. The name of the connected subscriber Channel. This is a weak reference to avoid cross project and cross accounts references. This must be in projects/{project}/location/{location}/channels/{channel_id} format.
createTime	string (google-datetime)	Output only. The creation time.
labels	object	Optional. Resource labels.
uid	string	Output only. Server assigned ID of the resource. The server guarantees uniqueness and immutability until deleted.
updateTime	string (google-datetime)	Output only. The last-modified time.

list

Successful response

Name	Datatype	Description
name	string	Required. The name of the connection.
activationToken	string	Input only. Activation token for the channel. The token will be used during the creation of ChannelConnection to bind the channel with the provider project. This field will not be stored in the provider resource.
channel	string	Required. The name of the connected subscriber Channel. This is a weak reference to avoid cross project and cross accounts references. This must be in projects/{project}/location/{location}/channels/{channel_id} format.
createTime	string (google-datetime)	Output only. The creation time.
labels	object	Optional. Resource labels.
uid	string	Output only. Server assigned ID of the resource. The server guarantees uniqueness and immutability until 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, channelConnectionsId		Get a single ChannelConnection.
list	select	projectsId, locationsId	pageSize, pageToken	List channel connections.
create	insert	projectsId, locationsId	channelConnectionId	Create a new ChannelConnection in a particular project and location.
delete	delete	projectsId, locationsId, channelConnectionsId		Delete a single ChannelConnection.

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
channelConnectionsId	string
locationsId	string
projectsId	string
channelConnectionId	string
pageSize	integer (int32)
pageToken	string

SELECT examples

get

Get a single ChannelConnection.

SELECT
name,
activationToken,
channel,
createTime,
labels,
uid,
updateTime
FROM google.eventarc.channel_connections
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND channelConnectionsId = '{{ channelConnectionsId }}' -- required;

list

List channel connections.

SELECT
name,
activationToken,
channel,
createTime,
labels,
uid,
updateTime
FROM google.eventarc.channel_connections
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

INSERT examples

create

Create a new ChannelConnection in a particular project and location.

INSERT INTO google.eventarc.channel_connections (
data__name,
data__channel,
data__activationToken,
data__labels,
projectsId,
locationsId,
channelConnectionId
)
SELECT 
'{{ name }}',
'{{ channel }}',
'{{ activationToken }}',
'{{ labels }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ channelConnectionId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: channel_connections
  props:
    - name: projectsId
      value: string
      description: Required parameter for the channel_connections resource.
    - name: locationsId
      value: string
      description: Required parameter for the channel_connections resource.
    - name: name
      value: string
      description: >
        Required. The name of the connection.
        
    - name: channel
      value: string
      description: >
        Required. The name of the connected subscriber Channel. This is a weak reference to avoid cross project and cross accounts references. This must be in `projects/{project}/location/{location}/channels/{channel_id}` format.
        
    - name: activationToken
      value: string
      description: >
        Input only. Activation token for the channel. The token will be used during the creation of ChannelConnection to bind the channel with the provider project. This field will not be stored in the provider resource.
        
    - name: labels
      value: object
      description: >
        Optional. Resource labels.
        
    - name: channelConnectionId
      value: string

DELETE examples

delete

Delete a single ChannelConnection.

DELETE FROM google.eventarc.channel_connections
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND channelConnectionsId = '{{ channelConnectionsId }}' --required;