public static interface EndpointResponse.Builder extends SdkPojo, CopyableBuilder<EndpointResponse.Builder,EndpointResponse>
| Modifier and Type | Method and Description |
|---|---|
EndpointResponse.Builder |
address(String address)
The destination address for messages or push notifications that you send to the endpoint.
|
EndpointResponse.Builder |
applicationId(String applicationId)
The unique identifier for the application that's associated with the endpoint.
|
EndpointResponse.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.
|
EndpointResponse.Builder |
channelType(ChannelType channelType)
The channel that's used when sending messages or push notifications to the endpoint.
|
EndpointResponse.Builder |
channelType(String channelType)
The channel that's used when sending messages or push notifications to the endpoint.
|
EndpointResponse.Builder |
cohortId(String cohortId)
A number from 0-99 that represents the cohort that the endpoint is assigned to.
|
EndpointResponse.Builder |
creationDate(String creationDate)
The date and time, in ISO 8601 format, when the endpoint was created.
|
default EndpointResponse.Builder |
demographic(Consumer<EndpointDemographic.Builder> demographic)
The demographic information for the endpoint, such as the time zone and platform.
|
EndpointResponse.Builder |
demographic(EndpointDemographic demographic)
The demographic information for the endpoint, such as the time zone and platform.
|
EndpointResponse.Builder |
effectiveDate(String effectiveDate)
The date and time, in ISO 8601 format, when the endpoint was last updated.
|
EndpointResponse.Builder |
endpointStatus(String endpointStatus)
Specifies whether messages or push notifications are sent to the endpoint.
|
EndpointResponse.Builder |
id(String id)
The unique identifier that you assigned to the endpoint.
|
default EndpointResponse.Builder |
location(Consumer<EndpointLocation.Builder> location)
The geographic information for the endpoint.
|
EndpointResponse.Builder |
location(EndpointLocation location)
The geographic information for the endpoint.
|
EndpointResponse.Builder |
metrics(Map<String,Double> metrics)
One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.
|
EndpointResponse.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.
|
EndpointResponse.Builder |
requestId(String requestId)
The unique identifier for the most recent request to update the endpoint.
|
default EndpointResponse.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.
|
EndpointResponse.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.
|
equalsBySdkFields, sdkFieldscopyapplyMutation, buildEndpointResponse.Builder address(String address)
The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For example, the address for a push-notification channel is typically the token provided by a push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. The address for the SMS channel is a phone number in E.164 format, such as +12065550100. The address for the email channel is an email address.
address - The destination address for messages or push notifications that you send to the endpoint. The address
varies by channel. For example, the address for a push-notification channel is typically the token
provided by a push notification service, such as an Apple Push Notification service (APNs) device
token or a Firebase Cloud Messaging (FCM) registration token. The address for the SMS channel is a
phone number in E.164 format, such as +12065550100. The address for the email channel is an email
address.EndpointResponse.Builder applicationId(String applicationId)
The unique identifier for the application that's associated with the endpoint.
applicationId - The unique identifier for the application that's associated with the endpoint.EndpointResponse.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. For example, the value of a custom attribute named Interests might be: ["Science", "Music", "Travel"]. You can use these attributes as filter criteria when you create segments.
attributes - One or more custom attributes that describe the endpoint by associating a name with an array of
values. For example, the value of a custom attribute named Interests might be: ["Science", "Music",
"Travel"]. You can use these attributes as filter criteria when you create segments.EndpointResponse.Builder channelType(String channelType)
The channel that's used when sending messages or push notifications to the endpoint.
channelType - The channel that's used when sending messages or push notifications to the endpoint.ChannelType,
ChannelTypeEndpointResponse.Builder channelType(ChannelType channelType)
The channel that's used when sending messages or push notifications to the endpoint.
channelType - The channel that's used when sending messages or push notifications to the endpoint.ChannelType,
ChannelTypeEndpointResponse.Builder cohortId(String cohortId)
A number from 0-99 that represents the cohort that the endpoint is assigned to. Endpoints are grouped into cohorts randomly, and each cohort contains approximately 1 percent of the endpoints for an application. Amazon Pinpoint assigns cohorts to the holdout or treatment allocations for campaigns.
cohortId - A number from 0-99 that represents the cohort that the endpoint is assigned to. Endpoints are grouped
into cohorts randomly, and each cohort contains approximately 1 percent of the endpoints for an
application. Amazon Pinpoint assigns cohorts to the holdout or treatment allocations for campaigns.EndpointResponse.Builder creationDate(String creationDate)
The date and time, in ISO 8601 format, when the endpoint was created.
creationDate - The date and time, in ISO 8601 format, when the endpoint was created.EndpointResponse.Builder demographic(EndpointDemographic demographic)
The demographic information for the endpoint, such as the time zone and platform.
demographic - The demographic information for the endpoint, such as the time zone and platform.default EndpointResponse.Builder demographic(Consumer<EndpointDemographic.Builder> demographic)
The demographic information for the endpoint, such as the time zone and platform.
This is a convenience that creates an instance of theEndpointDemographic.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).demographic - a consumer that will call methods on EndpointDemographic.Builderdemographic(EndpointDemographic)EndpointResponse.Builder effectiveDate(String effectiveDate)
The date and time, in ISO 8601 format, when the endpoint was last updated.
effectiveDate - The date and time, in ISO 8601 format, when the endpoint was last updated.EndpointResponse.Builder endpointStatus(String endpointStatus)
Specifies whether messages or push notifications are sent to the endpoint. Possible 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.
endpointStatus - Specifies whether messages or push notifications are sent to the endpoint. Possible 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.
EndpointResponse.Builder id(String id)
The unique identifier that you assigned to the endpoint. The identifier should be a globally unique identifier (GUID) to ensure that it doesn't conflict with other endpoint identifiers that are associated with the application.
id - The unique identifier that you assigned to the endpoint. The identifier should be a globally unique
identifier (GUID) to ensure that it doesn't conflict with other endpoint identifiers that are
associated with the application.EndpointResponse.Builder location(EndpointLocation location)
The geographic information for the endpoint.
location - The geographic information for the endpoint.default EndpointResponse.Builder location(Consumer<EndpointLocation.Builder> location)
The geographic information for the endpoint.
This is a convenience that creates an instance of theEndpointLocation.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).location - a consumer that will call methods on EndpointLocation.Builderlocation(EndpointLocation)EndpointResponse.Builder metrics(Map<String,Double> metrics)
One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.
metrics - One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.EndpointResponse.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.
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.EndpointResponse.Builder requestId(String requestId)
The unique identifier for the most recent request to update the endpoint.
requestId - The unique identifier for the most recent request to update the endpoint.EndpointResponse.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.
user - One or more custom user attributes that your app reports to Amazon Pinpoint for the user who's
associated with the endpoint.default EndpointResponse.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 that creates an instance of theEndpointUser.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).user - a consumer that will call methods on EndpointUser.Builderuser(EndpointUser)Copyright © 2020. All rights reserved.