Interface PublicEndpoint.Builder

All Superinterfaces:
Buildable, CopyableBuilder<PublicEndpoint.Builder,PublicEndpoint>, SdkBuilder<PublicEndpoint.Builder,PublicEndpoint>, SdkPojo
Enclosing class:
PublicEndpoint
@Mutable @NotThreadSafe public static interface PublicEndpoint.Builder extends SdkPojo, CopyableBuilder<PublicEndpoint.Builder,PublicEndpoint>

  • Method Details

    • address

      PublicEndpoint.Builder address(String address)

      The unique identifier for the recipient, such as a device token, email address, or mobile phone number.

      Parameters:
      address - The unique identifier for the recipient, such as a device token, email address, or mobile phone number.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • attributes

      PublicEndpoint.Builder attributes(Map<String,? extends Collection<String>> attributes)

      One or more custom attributes that describe the endpoint by associating a name with an array of values. You can use these attributes as filter criteria when you create segments.

      Parameters:
      attributes - One or more custom attributes that describe the endpoint by associating a name with an array of values. You can use these attributes as filter criteria when you create segments.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • channelType

      PublicEndpoint.Builder channelType(String channelType)

      The channel that's used when sending messages or push notifications to the endpoint.

      Parameters:
      channelType - The channel that's used when sending messages or push notifications to the endpoint.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • channelType

      PublicEndpoint.Builder channelType(ChannelType channelType)

      The channel that's used when sending messages or push notifications to the endpoint.

      Parameters:
      channelType - The channel that's used when sending messages or push notifications to the endpoint.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • demographic

      PublicEndpoint.Builder demographic(EndpointDemographic demographic)

      The demographic information for the endpoint, such as the time zone and platform.

      Parameters:
      demographic - The demographic information for the endpoint, such as the time zone and platform.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • demographic

      default PublicEndpoint.Builder demographic(Consumer<EndpointDemographic.Builder> demographic)

      The demographic information for the endpoint, such as the time zone and platform.

      This is a convenience method that creates an instance of the EndpointDemographic.Builder avoiding the need to create one manually via EndpointDemographic.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to demographic(EndpointDemographic).

      Parameters:
      demographic - a consumer that will call methods on EndpointDemographic.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • effectiveDate

      PublicEndpoint.Builder effectiveDate(String effectiveDate)

      The date and time, in ISO 8601 format, when the endpoint was last updated.

      Parameters:
      effectiveDate - The date and time, in ISO 8601 format, when the endpoint was last updated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • endpointStatus

      PublicEndpoint.Builder endpointStatus(String endpointStatus)

      Specifies whether to send messages or push notifications to the endpoint. Valid values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint.

      Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.

      Parameters:
      endpointStatus - Specifies whether to send messages or push notifications to the endpoint. Valid values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint.

      Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.

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

    • location

      PublicEndpoint.Builder location(EndpointLocation location)

      The geographic information for the endpoint.

      Parameters:
      location - The geographic information for the endpoint.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • location

      default PublicEndpoint.Builder location(Consumer<EndpointLocation.Builder> location)

      The geographic information for the endpoint.

      This is a convenience method that creates an instance of the EndpointLocation.Builder avoiding the need to create one manually via EndpointLocation.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to location(EndpointLocation).

      Parameters:
      location - a consumer that will call methods on EndpointLocation.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • metrics

      PublicEndpoint.Builder metrics(Map<String,Double> metrics)

      One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.

      Parameters:
      metrics - One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • optOut

      PublicEndpoint.Builder optOut(String optOut)

      Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.

      Parameters:
      optOut - Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • requestId

      PublicEndpoint.Builder requestId(String requestId)

      A unique identifier that's generated each time the endpoint is updated.

      Parameters:
      requestId - A unique identifier that's generated each time the endpoint is updated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • user

      PublicEndpoint.Builder user(EndpointUser user)

      One or more custom user attributes that your app reports to Amazon Pinpoint for the user who's associated with the endpoint.

      Parameters:
      user - One or more custom user attributes that your app reports to Amazon Pinpoint for the user who's associated with the endpoint.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • user

      default PublicEndpoint.Builder user(Consumer<EndpointUser.Builder> user)

      One or more custom user attributes that your app reports to Amazon Pinpoint for the user who's associated with the endpoint.

      This is a convenience method that creates an instance of the EndpointUser.Builder avoiding the need to create one manually via EndpointUser.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to user(EndpointUser).

      Parameters:
      user - a consumer that will call methods on EndpointUser.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: