software.amazon.awssdk.services.pinpoint.model

Interface EndpointMessageResult.Builder

All Superinterfaces:

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

Enclosing class:

EndpointMessageResult

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

Method Summary

Modifier and Type	Method and Description
EndpointMessageResult.Builder	address(String address) Address that endpoint message was delivered to.
EndpointMessageResult.Builder	deliveryStatus(DeliveryStatus deliveryStatus) The delivery status of the message.
EndpointMessageResult.Builder	deliveryStatus(String deliveryStatus) The delivery status of the message.
EndpointMessageResult.Builder	messageId(String messageId) Unique message identifier associated with the message that was sent.
EndpointMessageResult.Builder	statusCode(Integer statusCode) Downstream service status code.
EndpointMessageResult.Builder	statusMessage(String statusMessage) Status message for message delivery.
EndpointMessageResult.Builder	updatedToken(String updatedToken) If token was updated as part of delivery.

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

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

address

EndpointMessageResult.Builder address(String address)

Address that endpoint message was delivered to.

Parameters:

address - Address that endpoint message was delivered to.

Returns:

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

deliveryStatus

EndpointMessageResult.Builder deliveryStatus(String deliveryStatus)

The delivery status of the message. Possible values: SUCCESS - The message was successfully delivered to the endpoint. TRANSIENT_FAILURE - A temporary error occurred. Amazon Pinpoint will attempt to deliver the message again later. FAILURE_PERMANENT - An error occurred when delivering the message to the endpoint. Amazon Pinpoint won't attempt to send the message again. TIMEOUT - The message couldn't be sent within the timeout period. QUIET_TIME - The local time for the endpoint was within the QuietTime for the campaign or app. DAILY_CAP - The endpoint has received the maximum number of messages it can receive within a 24-hour period. HOLDOUT - The endpoint was in a hold out treatment for the campaign. THROTTLED - Amazon Pinpoint throttled sending to this endpoint. EXPIRED - The endpoint address is expired. CAMPAIGN_CAP - The endpoint received the maximum number of messages allowed by the campaign. SERVICE_FAILURE - A service-level failure prevented Amazon Pinpoint from delivering the message. UNKNOWN - An unknown error occurred.

Parameters:

deliveryStatus - The delivery status of the message. Possible values: SUCCESS - The message was successfully delivered to the endpoint. TRANSIENT_FAILURE - A temporary error occurred. Amazon Pinpoint will attempt to deliver the message again later. FAILURE_PERMANENT - An error occurred when delivering the message to the endpoint. Amazon Pinpoint won't attempt to send the message again. TIMEOUT - The message couldn't be sent within the timeout period. QUIET_TIME - The local time for the endpoint was within the QuietTime for the campaign or app. DAILY_CAP - The endpoint has received the maximum number of messages it can receive within a 24-hour period. HOLDOUT - The endpoint was in a hold out treatment for the campaign. THROTTLED - Amazon Pinpoint throttled sending to this endpoint. EXPIRED - The endpoint address is expired. CAMPAIGN_CAP - The endpoint received the maximum number of messages allowed by the campaign. SERVICE_FAILURE - A service-level failure prevented Amazon Pinpoint from delivering the message. UNKNOWN - An unknown error occurred.

Returns:

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

See Also:

DeliveryStatus, DeliveryStatus

deliveryStatus

EndpointMessageResult.Builder deliveryStatus(DeliveryStatus deliveryStatus)

The delivery status of the message. Possible values: SUCCESS - The message was successfully delivered to the endpoint. TRANSIENT_FAILURE - A temporary error occurred. Amazon Pinpoint will attempt to deliver the message again later. FAILURE_PERMANENT - An error occurred when delivering the message to the endpoint. Amazon Pinpoint won't attempt to send the message again. TIMEOUT - The message couldn't be sent within the timeout period. QUIET_TIME - The local time for the endpoint was within the QuietTime for the campaign or app. DAILY_CAP - The endpoint has received the maximum number of messages it can receive within a 24-hour period. HOLDOUT - The endpoint was in a hold out treatment for the campaign. THROTTLED - Amazon Pinpoint throttled sending to this endpoint. EXPIRED - The endpoint address is expired. CAMPAIGN_CAP - The endpoint received the maximum number of messages allowed by the campaign. SERVICE_FAILURE - A service-level failure prevented Amazon Pinpoint from delivering the message. UNKNOWN - An unknown error occurred.

Parameters:

deliveryStatus - The delivery status of the message. Possible values: SUCCESS - The message was successfully delivered to the endpoint. TRANSIENT_FAILURE - A temporary error occurred. Amazon Pinpoint will attempt to deliver the message again later. FAILURE_PERMANENT - An error occurred when delivering the message to the endpoint. Amazon Pinpoint won't attempt to send the message again. TIMEOUT - The message couldn't be sent within the timeout period. QUIET_TIME - The local time for the endpoint was within the QuietTime for the campaign or app. DAILY_CAP - The endpoint has received the maximum number of messages it can receive within a 24-hour period. HOLDOUT - The endpoint was in a hold out treatment for the campaign. THROTTLED - Amazon Pinpoint throttled sending to this endpoint. EXPIRED - The endpoint address is expired. CAMPAIGN_CAP - The endpoint received the maximum number of messages allowed by the campaign. SERVICE_FAILURE - A service-level failure prevented Amazon Pinpoint from delivering the message. UNKNOWN - An unknown error occurred.

Returns:

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

See Also:

DeliveryStatus, DeliveryStatus

messageId

EndpointMessageResult.Builder messageId(String messageId)

Unique message identifier associated with the message that was sent.

Parameters:

messageId - Unique message identifier associated with the message that was sent.

Returns:

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

statusCode

EndpointMessageResult.Builder statusCode(Integer statusCode)

Downstream service status code.

Parameters:

statusCode - Downstream service status code.

Returns:

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

statusMessage

EndpointMessageResult.Builder statusMessage(String statusMessage)

Status message for message delivery.

Parameters:

statusMessage - Status message for message delivery.

Returns:

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

updatedToken

EndpointMessageResult.Builder updatedToken(String updatedToken)

If token was updated as part of delivery. (This is GCM Specific)

Parameters:

updatedToken - If token was updated as part of delivery. (This is GCM Specific)

Returns:

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