Package 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 Details

    • address

      EndpointMessageResult.Builder address(String address)

      The endpoint address that the message was delivered to.

      Parameters:
      address - The endpoint address that the 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 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 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. Amazon Pinpoint won't attempt to send the message again.

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

      • 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.

      • 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 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. Amazon Pinpoint won't attempt to send the message again.

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

      • 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.

      • UNKNOWN_FAILURE - An unknown error occurred.

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

    • deliveryStatus

      EndpointMessageResult.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 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. Amazon Pinpoint won't attempt to send the message again.

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

      • 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.

      • 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 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. Amazon Pinpoint won't attempt to send the message again.

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

      • 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.

      • UNKNOWN_FAILURE - An unknown error occurred.

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

    • messageId

      EndpointMessageResult.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

      EndpointMessageResult.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

      EndpointMessageResult.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

      EndpointMessageResult.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.