software.amazon.awssdk.services.pinpoint.model

Interface EndpointResponse.Builder

All Superinterfaces:

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

Enclosing class:

EndpointResponse

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

Method Summary

Modifier and Type	Method and Description
EndpointResponse.Builder	address(String address) The address of the endpoint as provided by your push provider.
EndpointResponse.Builder	applicationId(String applicationId) The ID of the application that is associated with the endpoint.
EndpointResponse.Builder	attributes(Map<String,? extends Collection<String>> attributes) Custom attributes that describe the endpoint by associating a name with an array of values.
EndpointResponse.Builder	channelType(ChannelType channelType) The channel type.
EndpointResponse.Builder	channelType(String 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 date and time when the endpoint was created, shown in ISO 8601 format.
default EndpointResponse.Builder	demographic(Consumer<EndpointDemographic.Builder> demographic) The endpoint demographic attributes.
EndpointResponse.Builder	demographic(EndpointDemographic demographic) The endpoint demographic attributes.
EndpointResponse.Builder	effectiveDate(String effectiveDate) The date and time when the endpoint was last updated, shown in ISO 8601 format.
EndpointResponse.Builder	endpointStatus(String endpointStatus) Unused.
EndpointResponse.Builder	id(String id) The unique ID that you assigned to the endpoint.
default EndpointResponse.Builder	location(Consumer<EndpointLocation.Builder> location) The endpoint location attributes.
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 has opted out of all messages.
EndpointResponse.Builder	requestId(String requestId) The unique ID for the most recent request to update the endpoint.
default EndpointResponse.Builder	user(Consumer<EndpointUser.Builder> user) Custom user-specific attributes that your app reports to Amazon Pinpoint.
EndpointResponse.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

EndpointResponse.Builder address(String address)

The address of the endpoint as provided by your push provider. For example, the DeviceToken or RegistrationId.

Parameters:

address - The address of the endpoint as provided by your push provider. For example, the 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 that is associated with the endpoint.

Parameters:

applicationId - The ID of the application that is 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 describe the endpoint by associating a name with an array of values. For example, an attribute named "interests" might have the following values: ["science", "politics", "travel"]. You can use these attributes as selection criteria when you create segments. The Amazon Pinpoint console can't display attribute names that include the following characters: hash/pound sign (#), colon (:), question mark (?), backslash (\), and forward slash (/). For this reason, you should avoid using these characters in the names of custom attributes.

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 following values: ["science", "politics", "travel"]. You can use these attributes as selection criteria when you create segments. The Amazon Pinpoint console can't display attribute names that include the following characters: hash/pound sign (#), colon (:), question mark (?), backslash (\), and forward slash (/). For this reason, you should avoid using these characters in the names of custom attributes.

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: 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

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

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 date and time when the endpoint was created, shown in ISO 8601 format.

Parameters:

creationDate - The date and time when the endpoint was created, shown 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.

demographic

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

The endpoint demographic attributes. 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

EndpointResponse.Builder effectiveDate(String effectiveDate)

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

Parameters:

effectiveDate - The date and time when the endpoint was last updated, shown 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)

Unused.

Parameters:

endpointStatus - Unused.

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 doesn't conflict with other endpoint IDs associated with 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 doesn't conflict with other endpoint IDs associated with 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.

location

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

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

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.

user

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