public static interface PublicEndpoint.Builder extends SdkPojo, CopyableBuilder<PublicEndpoint.Builder,PublicEndpoint>
| Modifier and Type | Method and Description |
|---|---|
PublicEndpoint.Builder |
address(String address)
The unique identifier for the recipient, such as a device token, email address, or mobile phone number.
|
PublicEndpoint.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.
|
PublicEndpoint.Builder |
channelType(ChannelType channelType)
The channel that's used when sending messages or push notifications to the endpoint.
|
PublicEndpoint.Builder |
channelType(String channelType)
The channel that's used when sending messages or push notifications to the endpoint.
|
default PublicEndpoint.Builder |
demographic(Consumer<EndpointDemographic.Builder> demographic)
The demographic information for the endpoint, such as the time zone and platform.
|
PublicEndpoint.Builder |
demographic(EndpointDemographic demographic)
The demographic information for the endpoint, such as the time zone and platform.
|
PublicEndpoint.Builder |
effectiveDate(String effectiveDate)
The date and time, in ISO 8601 format, when the endpoint was last updated.
|
PublicEndpoint.Builder |
endpointStatus(String endpointStatus)
Specifies whether to send messages or push notifications to the endpoint.
|
default PublicEndpoint.Builder |
location(Consumer<EndpointLocation.Builder> location)
The geographic information for the endpoint.
|
PublicEndpoint.Builder |
location(EndpointLocation location)
The geographic information for the endpoint.
|
PublicEndpoint.Builder |
metrics(Map<String,Double> metrics)
One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.
|
PublicEndpoint.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.
|
PublicEndpoint.Builder |
requestId(String requestId)
A unique identifier that's generated each time the endpoint is updated.
|
default PublicEndpoint.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.
|
PublicEndpoint.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, buildPublicEndpoint.Builder address(String address)
The unique identifier for the recipient, such as a device token, email address, or mobile phone number.
address - The unique identifier for the recipient, such as a device token, email address, or mobile phone
number.PublicEndpoint.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. 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. You can use these attributes as filter criteria when you create segments.PublicEndpoint.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,
ChannelTypePublicEndpoint.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,
ChannelTypePublicEndpoint.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 PublicEndpoint.Builder demographic(Consumer<EndpointDemographic.Builder> demographic)
The demographic information for the endpoint, such as the time zone and platform.
This is a convenience method 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)PublicEndpoint.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.PublicEndpoint.Builder endpointStatus(String endpointStatus)
Specifies whether to send messages or push notifications to the endpoint. Valid 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 to send messages or push notifications to the endpoint. Valid 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.
PublicEndpoint.Builder location(EndpointLocation location)
The geographic information for the endpoint.
location - The geographic information for the endpoint.default PublicEndpoint.Builder location(Consumer<EndpointLocation.Builder> location)
The geographic information for the endpoint.
This is a convenience method 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)PublicEndpoint.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.PublicEndpoint.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.PublicEndpoint.Builder requestId(String requestId)
A unique identifier that's generated each time the endpoint is updated.
requestId - A unique identifier that's generated each time the endpoint is updated.PublicEndpoint.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 PublicEndpoint.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 method 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 © 2022. All rights reserved.