Eventarc V1 API - Class Google::Cloud::Eventarc::V1::Channel (v1.2.0)

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

def activation_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.

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#crypto_key_name

def crypto_key_name() -> ::String
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/*.

#crypto_key_name=

def crypto_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

def name() -> ::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=

def name=(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

def provider() -> ::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=

def provider=(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

def pubsub_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

def satisfies_pzs() -> ::Boolean
Returns
  • (::Boolean) — Output only. Whether or not this Channel satisfies the requirements of physical zone separation

#state

def state() -> ::Google::Cloud::Eventarc::V1::Channel::State
Returns

#uid

def uid() -> ::String
Returns
  • (::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.

#update_time

def update_time() -> ::Google::Protobuf::Timestamp
Returns