software.amazon.awssdk.services.pinpoint.model

Interface MessageResult.Builder

All Superinterfaces:

Buildable, CopyableBuilder<MessageResult.Builder,MessageResult>, SdkBuilder<MessageResult.Builder,MessageResult>, SdkPojo

Enclosing class:

MessageResult

public static interface MessageResult.Builder
extends SdkPojo, CopyableBuilder<MessageResult.Builder,MessageResult>

Method Summary

Modifier and Type	Method and Description
MessageResult.Builder	deliveryStatus(DeliveryStatus deliveryStatus) The delivery status of the message.
MessageResult.Builder	deliveryStatus(String deliveryStatus) The delivery status of the message.
MessageResult.Builder	messageId(String messageId) The unique identifier for the message that was sent.
MessageResult.Builder	statusCode(Integer statusCode) The downstream service status code for delivering the message.
MessageResult.Builder	statusMessage(String statusMessage) The status message for delivering the message.
MessageResult.Builder	updatedToken(String updatedToken) For push notifications that are sent through the GCM channel, specifies whether the endpoint's device registration token was updated as part of delivering the message.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

deliveryStatus

MessageResult.Builder deliveryStatus(String deliveryStatus)

The delivery status of the message. Possible values are:

• DUPLICATE - The endpoint address is a duplicate of another endpoint address. Amazon Pinpoint won't attempt to send the message again.

• OPT_OUT - The user who's associated with the endpoint address has opted out of receiving messages from you. Amazon Pinpoint won't attempt to send the message again.

• PERMANENT_FAILURE - An error occurred when delivering the message to the endpoint address. Amazon Pinpoint won't attempt to send the message again.

• SUCCESSFUL - The message was successfully delivered to the endpoint address.

• TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint won't attempt to send the message again.

• THROTTLED - Amazon Pinpoint throttled the operation to send the message to the endpoint address.

• TIMEOUT - The message couldn't be sent within the timeout period.

• UNKNOWN_FAILURE - An unknown error occurred.

Parameters:

deliveryStatus - The delivery status of the message. Possible values are:

• DUPLICATE - The endpoint address is a duplicate of another endpoint address. Amazon Pinpoint won't attempt to send the message again.

• OPT_OUT - The user who's associated with the endpoint address has opted out of receiving messages from you. Amazon Pinpoint won't attempt to send the message again.

• PERMANENT_FAILURE - An error occurred when delivering the message to the endpoint address. Amazon Pinpoint won't attempt to send the message again.

• SUCCESSFUL - The message was successfully delivered to the endpoint address.

• TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint won't attempt to send the message again.

• THROTTLED - Amazon Pinpoint throttled the operation to send the message to the endpoint address.

• TIMEOUT - The message couldn't be sent within the timeout period.

• UNKNOWN_FAILURE - An unknown error occurred.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DeliveryStatus, DeliveryStatus

deliveryStatus

MessageResult.Builder deliveryStatus(DeliveryStatus deliveryStatus)

The delivery status of the message. Possible values are:

• DUPLICATE - The endpoint address is a duplicate of another endpoint address. Amazon Pinpoint won't attempt to send the message again.

• OPT_OUT - The user who's associated with the endpoint address has opted out of receiving messages from you. Amazon Pinpoint won't attempt to send the message again.

• PERMANENT_FAILURE - An error occurred when delivering the message to the endpoint address. Amazon Pinpoint won't attempt to send the message again.

• SUCCESSFUL - The message was successfully delivered to the endpoint address.

• TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint won't attempt to send the message again.

• THROTTLED - Amazon Pinpoint throttled the operation to send the message to the endpoint address.

• TIMEOUT - The message couldn't be sent within the timeout period.

• UNKNOWN_FAILURE - An unknown error occurred.

Parameters:

deliveryStatus - The delivery status of the message. Possible values are:

• DUPLICATE - The endpoint address is a duplicate of another endpoint address. Amazon Pinpoint won't attempt to send the message again.

• OPT_OUT - The user who's associated with the endpoint address has opted out of receiving messages from you. Amazon Pinpoint won't attempt to send the message again.

• PERMANENT_FAILURE - An error occurred when delivering the message to the endpoint address. Amazon Pinpoint won't attempt to send the message again.

• SUCCESSFUL - The message was successfully delivered to the endpoint address.

• TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint won't attempt to send the message again.

• THROTTLED - Amazon Pinpoint throttled the operation to send the message to the endpoint address.

• TIMEOUT - The message couldn't be sent within the timeout period.

• UNKNOWN_FAILURE - An unknown error occurred.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DeliveryStatus, DeliveryStatus

messageId

MessageResult.Builder messageId(String messageId)

The unique identifier for the message that was sent.

Parameters:

messageId - The unique identifier for the message that was sent.

Returns:

Returns a reference to this object so that method calls can be chained together.

statusCode

MessageResult.Builder statusCode(Integer statusCode)

The downstream service status code for delivering the message.

Parameters:

statusCode - The downstream service status code for delivering the message.

Returns:

Returns a reference to this object so that method calls can be chained together.

statusMessage

MessageResult.Builder statusMessage(String statusMessage)

The status message for delivering the message.

Parameters:

statusMessage - The status message for delivering the message.

Returns:

Returns a reference to this object so that method calls can be chained together.

updatedToken

MessageResult.Builder updatedToken(String updatedToken)

For push notifications that are sent through the GCM channel, specifies whether the endpoint's device registration token was updated as part of delivering the message.

Parameters:

updatedToken - For push notifications that are sent through the GCM channel, specifies whether the endpoint's device registration token was updated as part of delivering the message.

Returns:

Returns a reference to this object so that method calls can be chained together.