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

Reference documentation and code samples for the Eventarc V1 API class Google::Cloud::Eventarc::V1::Enrollment.

An enrollment represents a subscription for messages on a particular message bus. It defines a matching criteria for messages on the bus and the subscriber endpoint where matched messages should be delivered.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#annotations

def annotations() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Optional. Resource annotations.

#annotations=

def annotations=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — Optional. Resource annotations.
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Optional. Resource annotations.

#cel_match

def cel_match() -> ::String
Returns
  • (::String) — Required. A CEL expression identifying which messages this enrollment applies to.

#cel_match=

def cel_match=(value) -> ::String
Parameter
  • value (::String) — Required. A CEL expression identifying which messages this enrollment applies to.
Returns
  • (::String) — Required. A CEL expression identifying which messages this enrollment applies to.

#create_time

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

#destination

def destination() -> ::String
Returns
  • (::String) — Required. Destination is the Pipeline that the Enrollment is delivering to. It must point to the full resource name of a Pipeline. Format: "projects/{PROJECT_ID}/locations/{region}/pipelines/{PIPELINE_ID)"

#destination=

def destination=(value) -> ::String
Parameter
  • value (::String) — Required. Destination is the Pipeline that the Enrollment is delivering to. It must point to the full resource name of a Pipeline. Format: "projects/{PROJECT_ID}/locations/{region}/pipelines/{PIPELINE_ID)"
Returns
  • (::String) — Required. Destination is the Pipeline that the Enrollment is delivering to. It must point to the full resource name of a Pipeline. Format: "projects/{PROJECT_ID}/locations/{region}/pipelines/{PIPELINE_ID)"

#display_name

def display_name() -> ::String
Returns
  • (::String) — Optional. Resource display name.

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::String) — Optional. Resource display name.
Returns
  • (::String) — Optional. Resource display name.

#etag

def etag() -> ::String
Returns
  • (::String) — Output only. This checksum is computed by the server based on the value of other fields, and might be sent only on update and delete requests to ensure that the client has an up-to-date value before proceeding.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Optional. Resource labels.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — Optional. Resource labels.
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Optional. Resource labels.

#message_bus

def message_bus() -> ::String
Returns
  • (::String) — Required. Resource name of the message bus identifying the source of the messages. It matches the form projects/{project}/locations/{location}/messageBuses/{messageBus}.

#message_bus=

def message_bus=(value) -> ::String
Parameter
  • value (::String) — Required. Resource name of the message bus identifying the source of the messages. It matches the form projects/{project}/locations/{location}/messageBuses/{messageBus}.
Returns
  • (::String) — Required. Resource name of the message bus identifying the source of the messages. It matches the form projects/{project}/locations/{location}/messageBuses/{messageBus}.

#name

def name() -> ::String
Returns
  • (::String) — Identifier. Resource name of the form projects/{project}/locations/{location}/enrollments/{enrollment}

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Identifier. Resource name of the form projects/{project}/locations/{location}/enrollments/{enrollment}
Returns
  • (::String) — Identifier. Resource name of the form projects/{project}/locations/{location}/enrollments/{enrollment}

#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