Interface CloudEventOrBuilder (0.76.0)

Version latest

• 0.76.0 (latest)
• 0.75.0
• 0.74.0
• 0.73.0
• 0.72.0
• 0.70.0
• 0.68.0
• 0.67.0
• 0.64.0
• 0.63.0
• 0.62.0
• 0.60.0
• 0.59.0
• 0.58.0
• 0.57.0
• 0.56.0
• 0.55.0
• 0.54.0
• 0.53.0
• 0.52.0
• 0.51.0
• 0.49.0
• 0.48.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0

public interface CloudEventOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsAttributes(String key)

public abstract boolean containsAttributes(String key)

Optional. Used for Optional & Extension Attributes

map<string, .google.cloud.eventarc.publishing.v1.CloudEvent.CloudEventAttributeValue> attributes = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

getAttributes() (deprecated)

public abstract Map<String,CloudEvent.CloudEventAttributeValue> getAttributes()

Use #getAttributesMap() instead.

Returns
Type	Description
Map<String,CloudEventAttributeValue>

getAttributesCount()

public abstract int getAttributesCount()

Optional. Used for Optional & Extension Attributes

map<string, .google.cloud.eventarc.publishing.v1.CloudEvent.CloudEventAttributeValue> attributes = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int

getAttributesMap()

public abstract Map<String,CloudEvent.CloudEventAttributeValue> getAttributesMap()

Optional. Used for Optional & Extension Attributes

map<string, .google.cloud.eventarc.publishing.v1.CloudEvent.CloudEventAttributeValue> attributes = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Map<String,CloudEventAttributeValue>

getAttributesOrDefault(String key, CloudEvent.CloudEventAttributeValue defaultValue)

public abstract CloudEvent.CloudEventAttributeValue getAttributesOrDefault(String key, CloudEvent.CloudEventAttributeValue defaultValue)

Optional. Used for Optional & Extension Attributes

map<string, .google.cloud.eventarc.publishing.v1.CloudEvent.CloudEventAttributeValue> attributes = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
key	String
defaultValue	CloudEvent.CloudEventAttributeValue

Returns
Type	Description
CloudEvent.CloudEventAttributeValue

getAttributesOrThrow(String key)

public abstract CloudEvent.CloudEventAttributeValue getAttributesOrThrow(String key)

Optional. Used for Optional & Extension Attributes

map<string, .google.cloud.eventarc.publishing.v1.CloudEvent.CloudEventAttributeValue> attributes = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
key	String

Returns
Type	Description
CloudEvent.CloudEventAttributeValue

getBinaryData()

public abstract ByteString getBinaryData()

Optional. Binary data.

bytes binary_data = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The binaryData.

getDataCase()

public abstract CloudEvent.DataCase getDataCase()

Returns
Type	Description
CloudEvent.DataCase

getId()

public abstract String getId()

Required. Identifies the event. Producers MUST ensure that source + id is unique for each distinct event.

string id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The id.

getIdBytes()

public abstract ByteString getIdBytes()

Required. Identifies the event. Producers MUST ensure that source + id is unique for each distinct event.

string id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for id.

getProtoData()

public abstract Any getProtoData()

Optional. Proto data.

NOTE: The protoData field only functions as expected when the payload is specifically a CloudEvent message type, and can't be used for arbitrary protocol buffer messages. For any other protocol buffer type, you must serialize your proto message into bytes, and use the binaryData field instead.

.google.protobuf.Any proto_data = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Any	The protoData.

getProtoDataOrBuilder()

public abstract AnyOrBuilder getProtoDataOrBuilder()

Optional. Proto data.

NOTE: The protoData field only functions as expected when the payload is specifically a CloudEvent message type, and can't be used for arbitrary protocol buffer messages. For any other protocol buffer type, you must serialize your proto message into bytes, and use the binaryData field instead.

.google.protobuf.Any proto_data = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
AnyOrBuilder

getSource()

public abstract String getSource()

Required. Identifies the context in which an event happened. URI-reference

string source = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The source.

getSourceBytes()

public abstract ByteString getSourceBytes()

Required. Identifies the context in which an event happened. URI-reference

string source = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for source.

getSpecVersion()

public abstract String getSpecVersion()

Required. The version of the CloudEvents specification which the event uses.

string spec_version = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The specVersion.

getSpecVersionBytes()

public abstract ByteString getSpecVersionBytes()

Required. The version of the CloudEvents specification which the event uses.

string spec_version = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for specVersion.

getTextData()

public abstract String getTextData()

Optional. Text data.

string text_data = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The textData.

getTextDataBytes()

public abstract ByteString getTextDataBytes()

Optional. Text data.

string text_data = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for textData.

getType()

public abstract String getType()

Required. This attribute contains a value describing the type of event related to the originating occurrence.

string type = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The type.

getTypeBytes()

public abstract ByteString getTypeBytes()

Required. This attribute contains a value describing the type of event related to the originating occurrence.

string type = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for type.

hasBinaryData()

public abstract boolean hasBinaryData()

Optional. Binary data.

bytes binary_data = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the binaryData field is set.

hasProtoData()

public abstract boolean hasProtoData()

Optional. Proto data.

NOTE: The protoData field only functions as expected when the payload is specifically a CloudEvent message type, and can't be used for arbitrary protocol buffer messages. For any other protocol buffer type, you must serialize your proto message into bytes, and use the binaryData field instead.

.google.protobuf.Any proto_data = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the protoData field is set.

hasTextData()

public abstract boolean hasTextData()

Optional. Text data.

string text_data = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the textData field is set.