Reference documentation and code samples for the Google Cloud Eventarc V1 Client class ChannelConnection.
A representation of the ChannelConnection resource.
A ChannelConnection is a resource which event providers create during the
activation process to establish a connection between the provider and the
subscriber channel.
Generated from protobuf messagegoogle.cloud.eventarc.v1.ChannelConnection
Namespace
Google \ Cloud \ Eventarc \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ name
string
Required. The name of the connection.
↳ uid
string
Output only. Server assigned ID of the resource. The server guarantees uniqueness and immutability until deleted.
↳ 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 inprojects/{project}/location/{location}/channels/{channel_id}format.
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.
getName
Required. The name of the connection.
Returns
Type
Description
string
setName
Required. The name of the connection.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getUid
Output only. Server assigned ID of the resource.
The server guarantees uniqueness and immutability until deleted.
Returns
Type
Description
string
setUid
Output only. Server assigned ID of the resource.
The server guarantees uniqueness and immutability until deleted.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getChannel
Required. The name of the connected subscriber Channel.
This is a weak reference to avoid cross project and cross accounts
references. This must be inprojects/{project}/location/{location}/channels/{channel_id}format.
Returns
Type
Description
string
setChannel
Required. The name of the connected subscriber Channel.
This is a weak reference to avoid cross project and cross accounts
references. This must be inprojects/{project}/location/{location}/channels/{channel_id}format.
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.
Returns
Type
Description
string
setActivationToken
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-09 UTC."],[],[],null,["# Google Cloud Eventarc V1 Client - Class ChannelConnection (2.1.5)\n\nVersion latestkeyboard_arrow_down\n\n- [2.1.5 (latest)](/php/docs/reference/cloud-eventarc/latest/V1.ChannelConnection)\n- [2.1.4](/php/docs/reference/cloud-eventarc/2.1.4/V1.ChannelConnection)\n- [2.0.1](/php/docs/reference/cloud-eventarc/2.0.1/V1.ChannelConnection)\n- [1.3.5](/php/docs/reference/cloud-eventarc/1.3.5/V1.ChannelConnection)\n- [1.2.2](/php/docs/reference/cloud-eventarc/1.2.2/V1.ChannelConnection)\n- [1.1.1](/php/docs/reference/cloud-eventarc/1.1.1/V1.ChannelConnection)\n- [1.0.5](/php/docs/reference/cloud-eventarc/1.0.5/V1.ChannelConnection) \nReference documentation and code samples for the Google Cloud Eventarc V1 Client class ChannelConnection.\n\nA representation of the ChannelConnection resource.\n\nA ChannelConnection is a resource which event providers create during the\nactivation process to establish a connection between the provider and the\nsubscriber channel.\n\nGenerated from protobuf message `google.cloud.eventarc.v1.ChannelConnection`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Eventarc \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nRequired. The name of the connection.\n\n### setName\n\nRequired. The name of the connection.\n\n### getUid\n\nOutput only. Server assigned ID of the resource.\n\nThe server guarantees uniqueness and immutability until deleted.\n\n### setUid\n\nOutput only. Server assigned ID of the resource.\n\nThe server guarantees uniqueness and immutability until deleted.\n\n### getChannel\n\nRequired. The name of the connected subscriber Channel.\n\nThis is a weak reference to avoid cross project and cross accounts\nreferences. This must be in\n`projects/{project}/location/{location}/channels/{channel_id}` format.\n\n### setChannel\n\nRequired. The name of the connected subscriber Channel.\n\nThis is a weak reference to avoid cross project and cross accounts\nreferences. This must be in\n`projects/{project}/location/{location}/channels/{channel_id}` format.\n\n### getCreateTime\n\nOutput only. The creation time.\n\n### hasCreateTime\n\n### clearCreateTime\n\n### setCreateTime\n\nOutput only. The creation time.\n\n### getUpdateTime\n\nOutput only. The last-modified time.\n\n### hasUpdateTime\n\n### clearUpdateTime\n\n### setUpdateTime\n\nOutput only. The last-modified time.\n\n### getActivationToken\n\nInput only. Activation token for the channel. The token will be used\nduring the creation of ChannelConnection to bind the channel with the\nprovider project. This field will not be stored in the provider resource.\n\n### setActivationToken\n\nInput only. Activation token for the channel. The token will be used\nduring the creation of ChannelConnection to bind the channel with the\nprovider project. This field will not be stored in the provider resource."]]
