Class: Google::Cloud::Eventarc::V1::Channel

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/eventarc/v1/channel.rb

Overview

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.

Defined Under Namespace

Modules: State

Instance Attribute Summary collapse

Instance Attribute Details

#activation_token ⇒ ::String (readonly)

Returns Output only. The activation token for the channel. The token must be used by the provider to register the channel for publishing.

Returns:

  • (::String) —

    Output only. The activation token for the channel. The token must be used by the provider to register the channel for publishing.



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'proto_docs/google/cloud/eventarc/v1/channel.rb', line 69

class Channel
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # State lists all the possible states of a Channel
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # The PENDING state indicates that a Channel has been created successfully
    # and there is a new activation token available for the subscriber to use
    # to convey the Channel to the provider in order to create a Connection.
    PENDING = 1

    # The ACTIVE state indicates that a Channel has been successfully
    # connected with the event provider.
    # An ACTIVE Channel is ready to receive and route events from the
    # event provider.
    ACTIVE = 2

    # The INACTIVE state indicates that the Channel cannot receive events
    # permanently. There are two possible cases this state can happen:
    #
    # 1. The SaaS provider disconnected from this Channel.
    # 2. The Channel activation token has expired but the SaaS provider
    #    wasn't connected.
    #
    # To re-establish a Connection with a provider, the subscriber
    # should create a new Channel and give it to the provider.
    INACTIVE = 3
  end
end

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The creation time.

Returns:



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'proto_docs/google/cloud/eventarc/v1/channel.rb', line 69

class Channel
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # State lists all the possible states of a Channel
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # The PENDING state indicates that a Channel has been created successfully
    # and there is a new activation token available for the subscriber to use
    # to convey the Channel to the provider in order to create a Connection.
    PENDING = 1

    # The ACTIVE state indicates that a Channel has been successfully
    # connected with the event provider.
    # An ACTIVE Channel is ready to receive and route events from the
    # event provider.
    ACTIVE = 2

    # The INACTIVE state indicates that the Channel cannot receive events
    # permanently. There are two possible cases this state can happen:
    #
    # 1. The SaaS provider disconnected from this Channel.
    # 2. The Channel activation token has expired but the SaaS provider
    #    wasn't connected.
    #
    # To re-establish a Connection with a provider, the subscriber
    # should create a new Channel and give it to the provider.
    INACTIVE = 3
  end
end

#crypto_key_name ⇒ ::String

Returns Optional. 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) —

    Optional. 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/*.



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'proto_docs/google/cloud/eventarc/v1/channel.rb', line 69

class Channel
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # State lists all the possible states of a Channel
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # The PENDING state indicates that a Channel has been created successfully
    # and there is a new activation token available for the subscriber to use
    # to convey the Channel to the provider in order to create a Connection.
    PENDING = 1

    # The ACTIVE state indicates that a Channel has been successfully
    # connected with the event provider.
    # An ACTIVE Channel is ready to receive and route events from the
    # event provider.
    ACTIVE = 2

    # The INACTIVE state indicates that the Channel cannot receive events
    # permanently. There are two possible cases this state can happen:
    #
    # 1. The SaaS provider disconnected from this Channel.
    # 2. The Channel activation token has expired but the SaaS provider
    #    wasn't connected.
    #
    # To re-establish a Connection with a provider, the subscriber
    # should create a new Channel and give it to the provider.
    INACTIVE = 3
  end
end

#name ⇒ ::String

Returns 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.



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'proto_docs/google/cloud/eventarc/v1/channel.rb', line 69

class Channel
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # State lists all the possible states of a Channel
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # The PENDING state indicates that a Channel has been created successfully
    # and there is a new activation token available for the subscriber to use
    # to convey the Channel to the provider in order to create a Connection.
    PENDING = 1

    # The ACTIVE state indicates that a Channel has been successfully
    # connected with the event provider.
    # An ACTIVE Channel is ready to receive and route events from the
    # event provider.
    ACTIVE = 2

    # The INACTIVE state indicates that the Channel cannot receive events
    # permanently. There are two possible cases this state can happen:
    #
    # 1. The SaaS provider disconnected from this Channel.
    # 2. The Channel activation token has expired but the SaaS provider
    #    wasn't connected.
    #
    # To re-establish a Connection with a provider, the subscriber
    # should create a new Channel and give it to the provider.
    INACTIVE = 3
  end
end

#provider ⇒ ::String

Returns 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}.



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'proto_docs/google/cloud/eventarc/v1/channel.rb', line 69

class Channel
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # State lists all the possible states of a Channel
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # The PENDING state indicates that a Channel has been created successfully
    # and there is a new activation token available for the subscriber to use
    # to convey the Channel to the provider in order to create a Connection.
    PENDING = 1

    # The ACTIVE state indicates that a Channel has been successfully
    # connected with the event provider.
    # An ACTIVE Channel is ready to receive and route events from the
    # event provider.
    ACTIVE = 2

    # The INACTIVE state indicates that the Channel cannot receive events
    # permanently. There are two possible cases this state can happen:
    #
    # 1. The SaaS provider disconnected from this Channel.
    # 2. The Channel activation token has expired but the SaaS provider
    #    wasn't connected.
    #
    # To re-establish a Connection with a provider, the subscriber
    # should create a new Channel and give it to the provider.
    INACTIVE = 3
  end
end

#pubsub_topic ⇒ ::String (readonly)

Returns 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}.

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}.



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'proto_docs/google/cloud/eventarc/v1/channel.rb', line 69

class Channel
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # State lists all the possible states of a Channel
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # The PENDING state indicates that a Channel has been created successfully
    # and there is a new activation token available for the subscriber to use
    # to convey the Channel to the provider in order to create a Connection.
    PENDING = 1

    # The ACTIVE state indicates that a Channel has been successfully
    # connected with the event provider.
    # An ACTIVE Channel is ready to receive and route events from the
    # event provider.
    ACTIVE = 2

    # The INACTIVE state indicates that the Channel cannot receive events
    # permanently. There are two possible cases this state can happen:
    #
    # 1. The SaaS provider disconnected from this Channel.
    # 2. The Channel activation token has expired but the SaaS provider
    #    wasn't connected.
    #
    # To re-establish a Connection with a provider, the subscriber
    # should create a new Channel and give it to the provider.
    INACTIVE = 3
  end
end

#state ⇒ ::Google::Cloud::Eventarc::V1::Channel::State (readonly)

Returns Output only. The state of a Channel.

Returns:



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'proto_docs/google/cloud/eventarc/v1/channel.rb', line 69

class Channel
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # State lists all the possible states of a Channel
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # The PENDING state indicates that a Channel has been created successfully
    # and there is a new activation token available for the subscriber to use
    # to convey the Channel to the provider in order to create a Connection.
    PENDING = 1

    # The ACTIVE state indicates that a Channel has been successfully
    # connected with the event provider.
    # An ACTIVE Channel is ready to receive and route events from the
    # event provider.
    ACTIVE = 2

    # The INACTIVE state indicates that the Channel cannot receive events
    # permanently. There are two possible cases this state can happen:
    #
    # 1. The SaaS provider disconnected from this Channel.
    # 2. The Channel activation token has expired but the SaaS provider
    #    wasn't connected.
    #
    # To re-establish a Connection with a provider, the subscriber
    # should create a new Channel and give it to the provider.
    INACTIVE = 3
  end
end

#uid ⇒ ::String (readonly)

Returns 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.

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.



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'proto_docs/google/cloud/eventarc/v1/channel.rb', line 69

class Channel
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # State lists all the possible states of a Channel
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # The PENDING state indicates that a Channel has been created successfully
    # and there is a new activation token available for the subscriber to use
    # to convey the Channel to the provider in order to create a Connection.
    PENDING = 1

    # The ACTIVE state indicates that a Channel has been successfully
    # connected with the event provider.
    # An ACTIVE Channel is ready to receive and route events from the
    # event provider.
    ACTIVE = 2

    # The INACTIVE state indicates that the Channel cannot receive events
    # permanently. There are two possible cases this state can happen:
    #
    # 1. The SaaS provider disconnected from this Channel.
    # 2. The Channel activation token has expired but the SaaS provider
    #    wasn't connected.
    #
    # To re-establish a Connection with a provider, the subscriber
    # should create a new Channel and give it to the provider.
    INACTIVE = 3
  end
end

#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The last-modified time.

Returns:



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'proto_docs/google/cloud/eventarc/v1/channel.rb', line 69

class Channel
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # State lists all the possible states of a Channel
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # The PENDING state indicates that a Channel has been created successfully
    # and there is a new activation token available for the subscriber to use
    # to convey the Channel to the provider in order to create a Connection.
    PENDING = 1

    # The ACTIVE state indicates that a Channel has been successfully
    # connected with the event provider.
    # An ACTIVE Channel is ready to receive and route events from the
    # event provider.
    ACTIVE = 2

    # The INACTIVE state indicates that the Channel cannot receive events
    # permanently. There are two possible cases this state can happen:
    #
    # 1. The SaaS provider disconnected from this Channel.
    # 2. The Channel activation token has expired but the SaaS provider
    #    wasn't connected.
    #
    # To re-establish a Connection with a provider, the subscriber
    # should create a new Channel and give it to the provider.
    INACTIVE = 3
  end
end