Eventarc Publishing V1 API - Class Google::Cloud::Eventarc::Publishing::V1::CloudEvent (v1.3.0)

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

CloudEvent represents a vendor-neutral specification for defining the format of event data.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#attributes

def attributes() -> ::Google::Protobuf::Map{::String => ::Google::Cloud::Eventarc::Publishing::V1::CloudEvent::CloudEventAttributeValue}
Returns
  • (::Google::Protobuf::Map{::String => ::Google::Cloud::Eventarc::Publishing::V1::CloudEvent::CloudEventAttributeValue}) — Optional. Used for Optional & Extension Attributes

#attributes=

def attributes=(value) -> ::Google::Protobuf::Map{::String => ::Google::Cloud::Eventarc::Publishing::V1::CloudEvent::CloudEventAttributeValue}
Parameter
  • value (::Google::Protobuf::Map{::String => ::Google::Cloud::Eventarc::Publishing::V1::CloudEvent::CloudEventAttributeValue}) — Optional. Used for Optional & Extension Attributes
Returns
  • (::Google::Protobuf::Map{::String => ::Google::Cloud::Eventarc::Publishing::V1::CloudEvent::CloudEventAttributeValue}) — Optional. Used for Optional & Extension Attributes

#binary_data

def binary_data() -> ::String
Returns
  • (::String) — Optional. Binary data.

    Note: The following fields are mutually exclusive: binary_data, text_data, proto_data. If a field in that set is populated, all other fields in the set will automatically be cleared.

#binary_data=

def binary_data=(value) -> ::String
Parameter
  • value (::String) — Optional. Binary data.

    Note: The following fields are mutually exclusive: binary_data, text_data, proto_data. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::String) — Optional. Binary data.

    Note: The following fields are mutually exclusive: binary_data, text_data, proto_data. If a field in that set is populated, all other fields in the set will automatically be cleared.

#id

def id() -> ::String
Returns
  • (::String) — Required. Identifies the event. Producers MUST ensure that source + id is unique for each distinct event.

#id=

def id=(value) -> ::String
Parameter
  • value (::String) — Required. Identifies the event. Producers MUST ensure that source + id is unique for each distinct event.
Returns
  • (::String) — Required. Identifies the event. Producers MUST ensure that source + id is unique for each distinct event.

#proto_data

def proto_data() -> ::Google::Protobuf::Any
Returns
  • (::Google::Protobuf::Any) — Optional. Proto data.

    Note: The following fields are mutually exclusive: proto_data, binary_data, text_data. If a field in that set is populated, all other fields in the set will automatically be cleared.

#proto_data=

def proto_data=(value) -> ::Google::Protobuf::Any
Parameter
  • value (::Google::Protobuf::Any) — Optional. Proto data.

    Note: The following fields are mutually exclusive: proto_data, binary_data, text_data. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Protobuf::Any) — Optional. Proto data.

    Note: The following fields are mutually exclusive: proto_data, binary_data, text_data. If a field in that set is populated, all other fields in the set will automatically be cleared.

#source

def source() -> ::String
Returns
  • (::String) — Required. Identifies the context in which an event happened. URI-reference

#source=

def source=(value) -> ::String
Parameter
  • value (::String) — Required. Identifies the context in which an event happened. URI-reference
Returns
  • (::String) — Required. Identifies the context in which an event happened. URI-reference

#spec_version

def spec_version() -> ::String
Returns
  • (::String) — Required. The version of the CloudEvents specification which the event uses.

#spec_version=

def spec_version=(value) -> ::String
Parameter
  • value (::String) — Required. The version of the CloudEvents specification which the event uses.
Returns
  • (::String) — Required. The version of the CloudEvents specification which the event uses.

#text_data

def text_data() -> ::String
Returns
  • (::String) — Optional. Text data.

    Note: The following fields are mutually exclusive: text_data, binary_data, proto_data. If a field in that set is populated, all other fields in the set will automatically be cleared.

#text_data=

def text_data=(value) -> ::String
Parameter
  • value (::String) — Optional. Text data.

    Note: The following fields are mutually exclusive: text_data, binary_data, proto_data. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::String) — Optional. Text data.

    Note: The following fields are mutually exclusive: text_data, binary_data, proto_data. If a field in that set is populated, all other fields in the set will automatically be cleared.

#type

def type() -> ::String
Returns
  • (::String) — Required. This attribute contains a value describing the type of event related to the originating occurrence.

#type=

def type=(value) -> ::String
Parameter
  • value (::String) — Required. This attribute contains a value describing the type of event related to the originating occurrence.
Returns
  • (::String) — Required. This attribute contains a value describing the type of event related to the originating occurrence.