Package software.amazon.awssdk.services.pinpoint.model

Interface EndpointBatchItem.Builder

All Superinterfaces:

CopyableBuilder<EndpointBatchItem.Builder,EndpointBatchItem>, SdkBuilder<EndpointBatchItem.Builder,EndpointBatchItem>

Enclosing class:

EndpointBatchItem

public static interface EndpointBatchItem.Builder
extends CopyableBuilder<EndpointBatchItem.Builder,EndpointBatchItem>

Method Summary

Modifier and Type	Method	Description
EndpointBatchItem.Builder	address(String address)	The address or token of the endpoint as provided by your push provider (e.g.
EndpointBatchItem.Builder	attributes(Map<String,? extends Collection<String>> attributes)	Custom attributes that your app reports to Amazon Pinpoint.
EndpointBatchItem.Builder	channelType(String channelType)	The channel type.
EndpointBatchItem.Builder	channelType(ChannelType channelType)	The channel type.
EndpointBatchItem.Builder	demographic(EndpointDemographic demographic)	The endpoint demographic attributes.
EndpointBatchItem.Builder	effectiveDate(String effectiveDate)	The last time the endpoint was updated.
EndpointBatchItem.Builder	endpointStatus(String endpointStatus)	The endpoint status.
EndpointBatchItem.Builder	id(String id)	The unique Id for the Endpoint in the batch.
EndpointBatchItem.Builder	location(EndpointLocation location)	The endpoint location attributes.
EndpointBatchItem.Builder	metrics(Map<String,Double> metrics)	Custom metrics that your app reports to Amazon Pinpoint.
EndpointBatchItem.Builder	optOut(String optOut)	Indicates whether a user has opted out of receiving messages with one of the following values: ALL – User receives all messages.
EndpointBatchItem.Builder	requestId(String requestId)	The unique ID for the most recent request to update the endpoint.
EndpointBatchItem.Builder	user(EndpointUser user)	Custom user-specific attributes that your app reports to Amazon Pinpoint.

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

copy

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

apply, build

Method Detail

address

EndpointBatchItem.Builder address(String address)

The address or token of the endpoint as provided by your push provider (e.g. DeviceToken or RegistrationId).

Parameters:

address - The address or token of the endpoint as provided by your push provider (e.g. DeviceToken or RegistrationId).

Returns:

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

attributes

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

Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create a segment.

Parameters:

attributes - Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create a segment.

Returns:

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

channelType

EndpointBatchItem.Builder channelType(String channelType)

The channel type. Valid values: APNS, GCM

Parameters:

channelType - The channel type. Valid values: APNS, GCM

Returns:

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

See Also:

ChannelType

channelType

EndpointBatchItem.Builder channelType(ChannelType channelType)

The channel type. Valid values: APNS, GCM

Parameters:

channelType - The channel type. Valid values: APNS, GCM

Returns:

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

See Also:

ChannelType

demographic

EndpointBatchItem.Builder demographic(EndpointDemographic demographic)

The endpoint demographic attributes.

Parameters:

demographic - The endpoint demographic attributes.

Returns:

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

effectiveDate

EndpointBatchItem.Builder effectiveDate(String effectiveDate)

The last time the endpoint was updated. Provided in ISO 8601 format.

Parameters:

effectiveDate - The last time the endpoint was updated. Provided in ISO 8601 format.

Returns:

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

endpointStatus

EndpointBatchItem.Builder endpointStatus(String endpointStatus)

The endpoint status. Can be either ACTIVE or INACTIVE. Will be set to INACTIVE if a delivery fails. Will be set to ACTIVE if the address is updated.

Parameters:

endpointStatus - The endpoint status. Can be either ACTIVE or INACTIVE. Will be set to INACTIVE if a delivery fails. Will be set to ACTIVE if the address is updated.

Returns:

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

id

EndpointBatchItem.Builder id(String id)

The unique Id for the Endpoint in the batch.

Parameters:

id - The unique Id for the Endpoint in the batch.

Returns:

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

location

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

metrics

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

EndpointBatchItem.Builder optOut(String optOut)

Indicates whether a user has opted out of receiving messages with one of the following values: ALL – User receives all messages. NONE – User receives no messages.

Parameters:

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

Returns:

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

requestId

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

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