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

Interface EndpointResponse.Builder

All Superinterfaces:

CopyableBuilder<EndpointResponse.Builder,EndpointResponse>, SdkBuilder<EndpointResponse.Builder,EndpointResponse>

Enclosing class:

EndpointResponse

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

Method Summary

Modifier and Type	Method	Description
EndpointResponse.Builder	address(String address)	The address or token of the endpoint as provided by your push provider (e.g.
EndpointResponse.Builder	applicationId(String applicationId)	The ID of the application associated with the endpoint.
EndpointResponse.Builder	attributes(Map<String,? extends Collection<String>> attributes)	Custom attributes that your app reports to Amazon Pinpoint.
EndpointResponse.Builder	channelType(String channelType)	The channel type.
EndpointResponse.Builder	channelType(ChannelType channelType)	The channel type.
EndpointResponse.Builder	cohortId(String cohortId)	A number from 0 - 99 that represents the cohort the endpoint is assigned to.
EndpointResponse.Builder	creationDate(String creationDate)	The last time the endpoint was created.
EndpointResponse.Builder	demographic(EndpointDemographic demographic)	The endpoint demographic attributes.
EndpointResponse.Builder	effectiveDate(String effectiveDate)	The last time the endpoint was updated.
EndpointResponse.Builder	endpointStatus(String endpointStatus)	The endpoint status.
EndpointResponse.Builder	id(String id)	The unique ID that you assigned to the endpoint.
EndpointResponse.Builder	location(EndpointLocation location)	The endpoint location attributes.
EndpointResponse.Builder	metrics(Map<String,Double> metrics)	Custom metrics that your app reports to Amazon Pinpoint.
EndpointResponse.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.
EndpointResponse.Builder	requestId(String requestId)	The unique ID for the most recent request to update the endpoint.
EndpointResponse.Builder	shardId(String shardId)	The ShardId of endpoint
EndpointResponse.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

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

applicationId

EndpointResponse.Builder applicationId(String applicationId)

The ID of the application associated with the endpoint.

Parameters:

applicationId - The ID of the application associated with the endpoint.

Returns:

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

attributes

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

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

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

cohortId

EndpointResponse.Builder cohortId(String cohortId)

A number from 0 - 99 that represents the cohort the endpoint is assigned to. Endpoints are grouped into cohorts randomly, and each cohort contains approximately 1 percent of the endpoints for an app. Amazon Pinpoint assigns cohorts to the holdout or treatment allocations for a campaign.

Parameters:

cohortId - A number from 0 - 99 that represents the cohort the endpoint is assigned to. Endpoints are grouped into cohorts randomly, and each cohort contains approximately 1 percent of the endpoints for an app. Amazon Pinpoint assigns cohorts to the holdout or treatment allocations for a campaign.

Returns:

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

creationDate

EndpointResponse.Builder creationDate(String creationDate)

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

Parameters:

creationDate - The last time the endpoint was created. Provided in ISO 8601 format.

Returns:

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

demographic

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

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

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

EndpointResponse.Builder id(String id)

The unique ID that you assigned to the endpoint. The ID should be a globally unique identifier (GUID) to ensure that it is unique compared to all other endpoints for the application.

Parameters:

id - The unique ID that you assigned to the endpoint. The ID should be a globally unique identifier (GUID) to ensure that it is unique compared to all other endpoints for the application.

Returns:

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

location

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

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

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

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

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

shardId

EndpointResponse.Builder shardId(String shardId)

The ShardId of endpoint

Parameters:

shardId - The ShardId of endpoint

Returns:

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