Interface EndpointBatchItem.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<EndpointBatchItem.Builder,
,EndpointBatchItem> SdkBuilder<EndpointBatchItem.Builder,
,EndpointBatchItem> SdkPojo
- Enclosing class:
EndpointBatchItem
-
Method Summary
Modifier and TypeMethodDescriptionThe destination address for messages or push notifications that you send to the endpoint.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.channelType
(String channelType) The channel to use when sending messages or push notifications to the endpoint.channelType
(ChannelType channelType) The channel to use when sending messages or push notifications to the endpoint.default EndpointBatchItem.Builder
demographic
(Consumer<EndpointDemographic.Builder> demographic) The demographic information for the endpoint, such as the time zone and platform.demographic
(EndpointDemographic demographic) The demographic information for the endpoint, such as the time zone and platform.effectiveDate
(String effectiveDate) The date and time, in ISO 8601 format, when the endpoint was created or updated.endpointStatus
(String endpointStatus) Specifies whether to send messages or push notifications to the endpoint.The unique identifier for the endpoint in the context of the batch.default EndpointBatchItem.Builder
location
(Consumer<EndpointLocation.Builder> location) The geographic information for the endpoint.location
(EndpointLocation location) The geographic information for the endpoint.One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you.The unique identifier for the request to create or update the endpoint.default EndpointBatchItem.Builder
user
(Consumer<EndpointUser.Builder> user) One or more custom attributes that describe the user who's associated with the endpoint.user
(EndpointUser user) One or more custom attributes that describe the user who's associated with the endpoint.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
address
The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For a push-notification channel, use the token provided by the push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. For the SMS channel, use a phone number in E.164 format, such as +12065550100. For the email channel, use an email address.
- Parameters:
address
- The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For a push-notification channel, use the token provided by the push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. For the SMS channel, use a phone number in E.164 format, such as +12065550100. For the email channel, use an email address.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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. Attribute names are case sensitive.
An attribute name can contain up to 50 characters. An attribute value can contain up to 100 characters. When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (\), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This restriction doesn't apply to attribute values.
- Parameters:
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. Attribute names are case sensitive.An attribute name can contain up to 50 characters. An attribute value can contain up to 100 characters. When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (\), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This restriction doesn't apply to attribute values.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
channelType
The channel to use when sending messages or push notifications to the endpoint.
- Parameters:
channelType
- The channel to use when sending messages or push notifications to the endpoint.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
channelType
The channel to use when sending messages or push notifications to the endpoint.
- Parameters:
channelType
- The channel to use when sending messages or push notifications to the endpoint.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
demographic
The demographic information for the endpoint, such as the time zone and platform.
- Parameters:
demographic
- The demographic information for the endpoint, such as the time zone and platform.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 viaEndpointDemographic.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todemographic(EndpointDemographic)
.- Parameters:
demographic
- a consumer that will call methods onEndpointDemographic.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
effectiveDate
The date and time, in ISO 8601 format, when the endpoint was created or updated.
- Parameters:
effectiveDate
- The date and time, in ISO 8601 format, when the endpoint was created or updated.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
id
The unique identifier for the endpoint in the context of the batch.
- Parameters:
id
- The unique identifier for the endpoint in the context of the batch.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
location
The geographic information for the endpoint.
- Parameters:
location
- The geographic information for the endpoint.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 viaEndpointLocation.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tolocation(EndpointLocation)
.- Parameters:
location
- a consumer that will call methods onEndpointLocation.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
metrics
One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.
- Parameters:
metrics
- One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
requestId
The unique identifier for the request to create or update the endpoint.
- Parameters:
requestId
- The unique identifier for the request to create or update the endpoint.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
user
One or more custom attributes that describe the user who's associated with the endpoint.
- Parameters:
user
- One or more custom attributes that describe the user who's associated with the endpoint.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
user
One or more custom attributes that describe 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 viaEndpointUser.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed touser(EndpointUser)
.- Parameters:
user
- a consumer that will call methods onEndpointUser.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-