software.amazon.awssdk.services.pinpoint.model

Interface EndpointRequest.Builder

All Superinterfaces:

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

Enclosing class:

EndpointRequest

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

Method Summary

Modifier and Type	Method and Description
EndpointRequest.Builder	address(String address) The destination for messages that you send to this endpoint.
EndpointRequest.Builder	attributes(Map<String,? extends Collection<String>> attributes) Custom attributes that describe the endpoint by associating a name with an array of values.
EndpointRequest.Builder	channelType(ChannelType channelType) The channel type.
EndpointRequest.Builder	channelType(String channelType) The channel type.
default EndpointRequest.Builder	demographic(Consumer<EndpointDemographic.Builder> demographic) Demographic attributes for the endpoint.
EndpointRequest.Builder	demographic(EndpointDemographic demographic) Demographic attributes for the endpoint.
EndpointRequest.Builder	effectiveDate(String effectiveDate) The date and time when the endpoint was updated, shown in ISO 8601 format.
EndpointRequest.Builder	endpointStatus(String endpointStatus) Unused.
default EndpointRequest.Builder	location(Consumer<EndpointLocation.Builder> location) The endpoint location attributes.
EndpointRequest.Builder	location(EndpointLocation location) The endpoint location attributes.
EndpointRequest.Builder	metrics(Map<String,Double> metrics) Custom metrics that your app reports to Amazon Pinpoint.
EndpointRequest.Builder	optOut(String optOut) Indicates whether a user has opted out of receiving messages with one of the following values: ALL - User has opted out of all messages.
EndpointRequest.Builder	requestId(String requestId) The unique ID for the most recent request to update the endpoint.
default EndpointRequest.Builder	user(Consumer<EndpointUser.Builder> user) Custom user-specific attributes that your app reports to Amazon Pinpoint.
EndpointRequest.Builder	user(EndpointUser user) Custom user-specific attributes that your app reports to Amazon Pinpoint.

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

EndpointRequest.Builder address(String address)

The destination for messages that you send to this endpoint. The address varies by channel. For mobile push channels, use the token provided by the push notification service, such as the APNs device token or the FCM registration token. For the SMS channel, use a phone number in E.164 format, such as +12065550100. For the email channel, use an email address.

Parameters:

address - The destination for messages that you send to this endpoint. The address varies by channel. For mobile push channels, use the token provided by the push notification service, such as the APNs device token or the FCM registration token. For the SMS channel, use a phone number in E.164 format, such as +12065550100. For the email channel, use an email address.

Returns:

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

attributes

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

Custom attributes that describe the endpoint by associating a name with an array of values. For example, an attribute named "interests" might have the values ["science", "politics", "travel"]. You can use these attributes as selection criteria when you create a segment of users to engage with a messaging campaign. The following characters are not recommended in attribute names: # : ? \ /. The Amazon Pinpoint console does not display attributes that include these characters in the name. This limitation does not apply to attribute values.

Parameters:

attributes - Custom attributes that describe the endpoint by associating a name with an array of values. For example, an attribute named "interests" might have the values ["science", "politics", "travel"]. You can use these attributes as selection criteria when you create a segment of users to engage with a messaging campaign. The following characters are not recommended in attribute names: # : ? \ /. The Amazon Pinpoint console does not display attributes that include these characters in the name. This limitation does not apply to attribute values.

Returns:

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

channelType

EndpointRequest.Builder channelType(String channelType)

The channel type. Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU

Parameters:

channelType - The channel type. Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU

Returns:

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

See Also:

ChannelType, ChannelType

channelType

EndpointRequest.Builder channelType(ChannelType channelType)

The channel type. Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU

Parameters:

channelType - The channel type. Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU

Returns:

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

See Also:

ChannelType, ChannelType

demographic

EndpointRequest.Builder demographic(EndpointDemographic demographic)

Demographic attributes for the endpoint.

Parameters:

demographic - Demographic attributes for the endpoint.

Returns:

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

demographic

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

Demographic attributes for the endpoint. This is a convenience 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:

demographic(EndpointDemographic)

effectiveDate

EndpointRequest.Builder effectiveDate(String effectiveDate)

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

Parameters:

effectiveDate - The date and time when the endpoint was updated, shown in ISO 8601 format.

Returns:

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

endpointStatus

EndpointRequest.Builder endpointStatus(String endpointStatus)

Unused.

Parameters:

endpointStatus - Unused.

Returns:

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

location

EndpointRequest.Builder location(EndpointLocation location)

The endpoint location attributes.

Parameters:

location - The endpoint location attributes.

Returns:

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

location

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

The endpoint location attributes. This is a convenience 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:

location(EndpointLocation)

metrics

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

Custom metrics that your app reports to Amazon Pinpoint.

Parameters:

metrics - Custom metrics that your app reports to Amazon Pinpoint.

Returns:

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

optOut

EndpointRequest.Builder optOut(String optOut)

Indicates whether a user has opted out of receiving messages with one of the following values: ALL - User has opted out of all messages. NONE - Users has not opted out and receives all messages.

Parameters:

optOut - Indicates whether a user has opted out of receiving messages with one of the following values: ALL - User has opted out of all messages. NONE - Users has not opted out and receives all messages.

Returns:

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

requestId

EndpointRequest.Builder requestId(String requestId)

The unique ID for the most recent request to update the endpoint.

Parameters:

requestId - The unique ID for the most recent request to update the endpoint.

Returns:

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

user

EndpointRequest.Builder user(EndpointUser user)

Custom user-specific attributes that your app reports to Amazon Pinpoint.

Parameters:

user - Custom user-specific attributes that your app reports to Amazon Pinpoint.

Returns:

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

user

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

Custom user-specific attributes that your app reports to Amazon Pinpoint. This is a convenience 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:

user(EndpointUser)