com.sap.cloud.sdk.s4hana.datamodel.messaging.core

Class S4HanaMessageMetadata

java.lang.Object

com.sap.cloud.sdk.s4hana.datamodel.messaging.core.S4HanaMessageMetadata

public final class S4HanaMessageMetadata
extends Object

Contains metadata about the received message.

See Also:

https://github.com/cloudevents/spec/blob/v0.1/spec.md

Constructor Summary

Constructors

Constructor and Description
S4HanaMessageMetadata(String eventType, String eventTypeVersion, String cloudEventsVersion, String source, String eventId, ZonedDateTime eventTime, String schemaUrl, String contentType)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getCloudEventsVersion() The version of the CloudEvents specification which the event uses.
Optional<String>	getContentType() Describe the data encoding format.
String	getEventId() ID of the event.
Optional<ZonedDateTime>	getEventTime() Timestamp of when the event happened.
String	getEventType() Type of occurrence which has happened.
Optional<String>	getEventTypeVersion() The version of the eventType.
Optional<String>	getSchemaUrl() A link to the schema that the data attribute adheres to.
String	getSource() This describes the event producer.
int	hashCode()
static S4HanaMessageMetadata	of(S4HanaMessageParser.ParsedMetadata parsedParsedMetadata) Factory method to create a S4HanaMessageMetadata based on a parsed Metadata object.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

S4HanaMessageMetadata

public S4HanaMessageMetadata(@Nonnull
                             String eventType,
                             @Nullable
                             String eventTypeVersion,
                             @Nonnull
                             String cloudEventsVersion,
                             @Nonnull
                             String source,
                             @Nonnull
                             String eventId,
                             @Nullable
                             ZonedDateTime eventTime,
                             @Nullable
                             String schemaUrl,
                             @Nullable
                             String contentType)

Method Detail

getEventTypeVersion

@Nonnull
public Optional<String> getEventTypeVersion()

The version of the eventType. This enables the interpretation of data by eventual consumers, requires the consumer to be knowledgeable about the producer.

Returns:

An Optional that may contain the version of the eventType.

getEventTime

@Nonnull
public Optional<ZonedDateTime> getEventTime()

Timestamp of when the event happened.

Returns:

An Optional that may contain the timestamp.

getSchemaUrl

@Nonnull
public Optional<String> getSchemaUrl()

A link to the schema that the data attribute adheres to.

Returns:

An Optional that may contain the schema used to parse the data portion of the payload.

getContentType

@Nonnull
public Optional<String> getContentType()

Describe the data encoding format.

Returns:

An Optional that may contain the data encoding format.

of

@Nonnull
public static S4HanaMessageMetadata of(@Nonnull
                                                S4HanaMessageParser.ParsedMetadata parsedParsedMetadata)

Factory method to create a S4HanaMessageMetadata based on a parsed Metadata object.

Parameters:

parsedParsedMetadata - The metadata object parsed from the body of the received message.

Returns:

The metadata object to be used in the context of a received message.

getEventType

@Nonnull
public String getEventType()

Type of occurrence which has happened. Often this property is used for routing, observability, policy enforcement, etc.

getCloudEventsVersion

@Nonnull
public String getCloudEventsVersion()

The version of the CloudEvents specification which the event uses. This enables the interpretation of the context.

getSource

@Nonnull
public String getSource()

This describes the event producer. Often this will include information such as the type of the event source, the organization publishing the event, and some unique identifiers. The exact syntax and semantics behind the data encoded in the URI is event producer defined.

The value "http://SAPS4HANAOD" indicates that the message originated from SAP S/4HANA Cloud.

getEventId

@Nonnull
public String getEventId()

ID of the event. The semantics of this string are explicitly undefined to ease the implementation of producers. Enables deduplication.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object