Reference documentation and code samples for the Eventarc V1 API class Google::Cloud::Eventarc::V1::Channel.
A representation of the Channel resource.
A Channel is a resource on which event providers publish their events.
The published events are delivered through the transport associated with the
channel. Note that a channel is associated with exactly one event provider.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#activation_token
defactivation_token()->::String
Returns
(::String) — Output only. The activation token for the channel. The token must be used
by the provider to register the channel for publishing.
(::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/*.
#crypto_key_name=
defcrypto_key_name=(value)->::String
Parameter
value (::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/*.
Returns
(::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/*.
#name
defname()->::String
Returns
(::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.
#name=
defname=(value)->::String
Parameter
value (::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.
Returns
(::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.
#provider
defprovider()->::String
Returns
(::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}.
#provider=
defprovider=(value)->::String
Parameter
value (::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}.
Returns
(::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}.
#pubsub_topic
defpubsub_topic()->::String
Returns
(::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}.
#satisfies_pzs
defsatisfies_pzs()->::Boolean
Returns
(::Boolean) — Output only. Whether or not this Channel satisfies the requirements of
physical zone separation
(::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.
[[["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,["# Eventarc V1 API - Class Google::Cloud::Eventarc::V1::Channel (v2.1.0)\n\nVersion latestkeyboard_arrow_down\n\n- [2.1.0 (latest)](/ruby/docs/reference/google-cloud-eventarc-v1/latest/Google-Cloud-Eventarc-V1-Channel)\n- [2.0.1](/ruby/docs/reference/google-cloud-eventarc-v1/2.0.1/Google-Cloud-Eventarc-V1-Channel)\n- [1.3.0](/ruby/docs/reference/google-cloud-eventarc-v1/1.3.0/Google-Cloud-Eventarc-V1-Channel)\n- [1.2.0](/ruby/docs/reference/google-cloud-eventarc-v1/1.2.0/Google-Cloud-Eventarc-V1-Channel)\n- [1.1.0](/ruby/docs/reference/google-cloud-eventarc-v1/1.1.0/Google-Cloud-Eventarc-V1-Channel)\n- [1.0.1](/ruby/docs/reference/google-cloud-eventarc-v1/1.0.1/Google-Cloud-Eventarc-V1-Channel)\n- [0.10.0](/ruby/docs/reference/google-cloud-eventarc-v1/0.10.0/Google-Cloud-Eventarc-V1-Channel)\n- [0.9.2](/ruby/docs/reference/google-cloud-eventarc-v1/0.9.2/Google-Cloud-Eventarc-V1-Channel)\n- [0.8.0](/ruby/docs/reference/google-cloud-eventarc-v1/0.8.0/Google-Cloud-Eventarc-V1-Channel)\n- [0.7.0](/ruby/docs/reference/google-cloud-eventarc-v1/0.7.0/Google-Cloud-Eventarc-V1-Channel)\n- [0.6.0](/ruby/docs/reference/google-cloud-eventarc-v1/0.6.0/Google-Cloud-Eventarc-V1-Channel)\n- [0.5.0](/ruby/docs/reference/google-cloud-eventarc-v1/0.5.0/Google-Cloud-Eventarc-V1-Channel)\n- [0.4.0](/ruby/docs/reference/google-cloud-eventarc-v1/0.4.0/Google-Cloud-Eventarc-V1-Channel)\n- [0.3.0](/ruby/docs/reference/google-cloud-eventarc-v1/0.3.0/Google-Cloud-Eventarc-V1-Channel)\n- [0.2.1](/ruby/docs/reference/google-cloud-eventarc-v1/0.2.1/Google-Cloud-Eventarc-V1-Channel)\n- [0.1.4](/ruby/docs/reference/google-cloud-eventarc-v1/0.1.4/Google-Cloud-Eventarc-V1-Channel) \nReference documentation and code samples for the Eventarc V1 API class Google::Cloud::Eventarc::V1::Channel.\n\nA representation of the Channel resource.\nA Channel is a resource on which event providers publish their events.\nThe published events are delivered through the transport associated with the\nchannel. Note that a channel is associated with exactly one event provider. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #activation_token\n\n def activation_token() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Output only. The activation token for the channel. The token must be used by the provider to register the channel for publishing.\n\n### #create_time\n\n def create_time() -\u003e ::Google::Protobuf::Timestamp\n\n**Returns**\n\n- ([::Google::Protobuf::Timestamp](./Google-Protobuf-Timestamp)) --- Output only. The creation time.\n\n### #crypto_key_name\n\n def crypto_key_name() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt their event data.\n\n It must match the pattern\n `projects/*/locations/*/keyRings/*/cryptoKeys/*`.\n\n### #crypto_key_name=\n\n def crypto_key_name=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt their event data.\n\n\n It must match the pattern\n`projects/*/locations/*/keyRings/*/cryptoKeys/*`. \n**Returns**\n\n- (::String) --- Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt their event data.\n\n It must match the pattern\n `projects/*/locations/*/keyRings/*/cryptoKeys/*`.\n\n### #name\n\n def name() -\u003e ::String\n\n**Returns**\n\n- (::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.\n\n### #name=\n\n def name=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::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. \n**Returns**\n\n- (::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.\n\n### #provider\n\n def provider() -\u003e ::String\n\n**Returns**\n\n- (::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}`.\n\n### #provider=\n\n def provider=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::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}`. \n**Returns**\n\n- (::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}`.\n\n### #pubsub_topic\n\n def pubsub_topic() -\u003e ::String\n\n**Returns**\n\n- (::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}`.\n\n### #satisfies_pzs\n\n def satisfies_pzs() -\u003e ::Boolean\n\n**Returns**\n\n- (::Boolean) --- Output only. Whether or not this Channel satisfies the requirements of physical zone separation\n\n### #state\n\n def state() -\u003e ::Google::Cloud::Eventarc::V1::Channel::State\n\n**Returns**\n\n- ([::Google::Cloud::Eventarc::V1::Channel::State](./Google-Cloud-Eventarc-V1-Channel-State)) --- Output only. The state of a Channel.\n\n### #uid\n\n def uid() -\u003e ::String\n\n**Returns**\n\n- (::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.\n\n### #update_time\n\n def update_time() -\u003e ::Google::Protobuf::Timestamp\n\n**Returns**\n\n- ([::Google::Protobuf::Timestamp](./Google-Protobuf-Timestamp)) --- Output only. The last-modified time."]]
