io.sphere.sdk.subscriptions

Interface MessageSubscriptionPayload<T>

Type Parameters:

T - the resource type MessageSubscription.getResourceTypeId()

All Superinterfaces:

Payload<T>

public interface MessageSubscriptionPayload<T>
extends Payload<T>

This payload will be sent for a MessageSubscription.

Method Summary

Modifier and Type	Method and Description
default <M extends Message> M	as(Class<M> messageClass) Returns getMessage() as a message of the given message class.
Message	getMessage() The message payload will always contain the common fields: Resource.getId() Resource.getVersion() Message.getSequenceNumber() Message.getResourceVersion() Resource.getCreatedAt() Resource.getLastModifiedAt() for any message.
PayloadNotIncluded	getPaylaodNotIncluded()
default boolean	hasCompleteMessage() Returns true iff.

Methods inherited from interface io.sphere.sdk.subscriptions.Payload

getNotificationType, getProjectKey, getResource, getResourceUserProvidedIdentifiers

Method Detail

getMessage

Message getMessage()

The message payload will always contain the common fields:

• Resource.getId()
• Resource.getVersion()
• Message.getSequenceNumber()
• Message.getResourceVersion()
• Resource.getCreatedAt()
• Resource.getLastModifiedAt()

for any message. If the payload fits within the size limit of you message queue (the limit is often 256kb), all additional fields for the specific message are included as well (along with the Message.getType() property). If the payload did not fit, it can be retrieved from the Messages endpoint if messages are enabled.

You can check if this payloads contains a complete message with hasCompleteMessage(). In this case you can use as(Class) to retrieve the typed message.

Returns:

the message payload

getPaylaodNotIncluded

@Nullable
PayloadNotIncluded getPaylaodNotIncluded()

Returns:

hasCompleteMessage

default boolean hasCompleteMessage()

Returns true iff. this payload contains a complete message.

Returns:

true iff. this payload contains a complete message

See Also:

getMessage()

as

default <M extends Message> M as(Class<M> messageClass)

Returns getMessage() as a message of the given message class.

Type Parameters:

M - the message type

Parameters:

messageClass - the message class

Returns:

the typed message

Throws:

IllegalStateException - if this payload contains an incomplete message hasCompleteMessage()