@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class EndpointBatchItem extends Object implements Serializable, Cloneable, StructuredPojo
Specifies an endpoint to create or update and the settings and attributes to set or change for the endpoint.
Constructor and Description |
---|
EndpointBatchItem() |
Modifier and Type | Method and Description |
---|---|
EndpointBatchItem |
addAttributesEntry(String key,
List<String> value)
Add a single Attributes entry
|
EndpointBatchItem |
addMetricsEntry(String key,
Double value)
Add a single Metrics entry
|
EndpointBatchItem |
clearAttributesEntries()
Removes all the entries added into Attributes.
|
EndpointBatchItem |
clearMetricsEntries()
Removes all the entries added into Metrics.
|
EndpointBatchItem |
clone() |
boolean |
equals(Object obj) |
String |
getAddress()
The destination address for messages or push notifications that you send to the endpoint.
|
Map<String,List<String>> |
getAttributes()
One or more custom attributes that describe the endpoint by associating a name with an array of values.
|
String |
getChannelType()
The channel to use when sending messages or push notifications to the endpoint.
|
EndpointDemographic |
getDemographic()
The demographic information for the endpoint, such as the time zone and platform.
|
String |
getEffectiveDate()
The date and time, in ISO 8601 format, when the endpoint was created or updated.
|
String |
getEndpointStatus()
Specifies whether to send messages or push notifications to the endpoint.
|
String |
getId()
The unique identifier for the endpoint in the context of the batch.
|
EndpointLocation |
getLocation()
The geographic information for the endpoint.
|
Map<String,Double> |
getMetrics()
One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.
|
String |
getOptOut()
Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push
notifications from you.
|
String |
getRequestId()
The unique identifier for the request to create or update the endpoint.
|
EndpointUser |
getUser()
One or more custom attributes that describe the user who's associated with the endpoint.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setAddress(String address)
The destination address for messages or push notifications that you send to the endpoint.
|
void |
setAttributes(Map<String,List<String>> attributes)
One or more custom attributes that describe the endpoint by associating a name with an array of values.
|
void |
setChannelType(ChannelType channelType)
The channel to use when sending messages or push notifications to the endpoint.
|
void |
setChannelType(String channelType)
The channel to use when sending messages or push notifications to the endpoint.
|
void |
setDemographic(EndpointDemographic demographic)
The demographic information for the endpoint, such as the time zone and platform.
|
void |
setEffectiveDate(String effectiveDate)
The date and time, in ISO 8601 format, when the endpoint was created or updated.
|
void |
setEndpointStatus(String endpointStatus)
Specifies whether to send messages or push notifications to the endpoint.
|
void |
setId(String id)
The unique identifier for the endpoint in the context of the batch.
|
void |
setLocation(EndpointLocation location)
The geographic information for the endpoint.
|
void |
setMetrics(Map<String,Double> metrics)
One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.
|
void |
setOptOut(String optOut)
Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push
notifications from you.
|
void |
setRequestId(String requestId)
The unique identifier for the request to create or update the endpoint.
|
void |
setUser(EndpointUser user)
One or more custom attributes that describe the user who's associated with the endpoint.
|
String |
toString()
Returns a string representation of this object.
|
EndpointBatchItem |
withAddress(String address)
The destination address for messages or push notifications that you send to the endpoint.
|
EndpointBatchItem |
withAttributes(Map<String,List<String>> attributes)
One or more custom attributes that describe the endpoint by associating a name with an array of values.
|
EndpointBatchItem |
withChannelType(ChannelType channelType)
The channel to use when sending messages or push notifications to the endpoint.
|
EndpointBatchItem |
withChannelType(String channelType)
The channel to use when sending messages or push notifications to the endpoint.
|
EndpointBatchItem |
withDemographic(EndpointDemographic demographic)
The demographic information for the endpoint, such as the time zone and platform.
|
EndpointBatchItem |
withEffectiveDate(String effectiveDate)
The date and time, in ISO 8601 format, when the endpoint was created or updated.
|
EndpointBatchItem |
withEndpointStatus(String endpointStatus)
Specifies whether to send messages or push notifications to the endpoint.
|
EndpointBatchItem |
withId(String id)
The unique identifier for the endpoint in the context of the batch.
|
EndpointBatchItem |
withLocation(EndpointLocation location)
The geographic information for the endpoint.
|
EndpointBatchItem |
withMetrics(Map<String,Double> metrics)
One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.
|
EndpointBatchItem |
withOptOut(String optOut)
Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push
notifications from you.
|
EndpointBatchItem |
withRequestId(String requestId)
The unique identifier for the request to create or update the endpoint.
|
EndpointBatchItem |
withUser(EndpointUser user)
One or more custom attributes that describe the user who's associated with the endpoint.
|
public void setAddress(String 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.
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.public String getAddress()
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.
public EndpointBatchItem withAddress(String 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.
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.public Map<String,List<String>> getAttributes()
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.
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.
public void setAttributes(Map<String,List<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. 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.
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.
public EndpointBatchItem withAttributes(Map<String,List<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. 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.
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.
public EndpointBatchItem addAttributesEntry(String key, List<String> value)
public EndpointBatchItem clearAttributesEntries()
public void setChannelType(String channelType)
The channel to use when sending messages or push notifications to the endpoint.
channelType
- The channel to use when sending messages or push notifications to the endpoint.ChannelType
public String getChannelType()
The channel to use when sending messages or push notifications to the endpoint.
ChannelType
public EndpointBatchItem withChannelType(String channelType)
The channel to use when sending messages or push notifications to the endpoint.
channelType
- The channel to use when sending messages or push notifications to the endpoint.ChannelType
public void setChannelType(ChannelType channelType)
The channel to use when sending messages or push notifications to the endpoint.
channelType
- The channel to use when sending messages or push notifications to the endpoint.ChannelType
public EndpointBatchItem withChannelType(ChannelType channelType)
The channel to use when sending messages or push notifications to the endpoint.
channelType
- The channel to use when sending messages or push notifications to the endpoint.ChannelType
public void setDemographic(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.public EndpointDemographic getDemographic()
The demographic information for the endpoint, such as the time zone and platform.
public EndpointBatchItem withDemographic(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.public void setEffectiveDate(String effectiveDate)
The date and time, in ISO 8601 format, when the endpoint was created or updated.
effectiveDate
- The date and time, in ISO 8601 format, when the endpoint was created or updated.public String getEffectiveDate()
The date and time, in ISO 8601 format, when the endpoint was created or updated.
public EndpointBatchItem withEffectiveDate(String effectiveDate)
The date and time, in ISO 8601 format, when the endpoint was created or updated.
effectiveDate
- The date and time, in ISO 8601 format, when the endpoint was created or updated.public void setEndpointStatus(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.
public String getEndpointStatus()
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.
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.
public EndpointBatchItem withEndpointStatus(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.
public void setId(String id)
The unique identifier for the endpoint in the context of the batch.
id
- The unique identifier for the endpoint in the context of the batch.public String getId()
The unique identifier for the endpoint in the context of the batch.
public EndpointBatchItem withId(String id)
The unique identifier for the endpoint in the context of the batch.
id
- The unique identifier for the endpoint in the context of the batch.public void setLocation(EndpointLocation location)
The geographic information for the endpoint.
location
- The geographic information for the endpoint.public EndpointLocation getLocation()
The geographic information for the endpoint.
public EndpointBatchItem withLocation(EndpointLocation location)
The geographic information for the endpoint.
location
- The geographic information for the endpoint.public Map<String,Double> getMetrics()
One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.
public void setMetrics(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.public EndpointBatchItem withMetrics(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.public EndpointBatchItem addMetricsEntry(String key, Double value)
public EndpointBatchItem clearMetricsEntries()
public void setOptOut(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.public String getOptOut()
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.
public EndpointBatchItem withOptOut(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.public void setRequestId(String requestId)
The unique identifier for the request to create or update the endpoint.
requestId
- The unique identifier for the request to create or update the endpoint.public String getRequestId()
The unique identifier for the request to create or update the endpoint.
public EndpointBatchItem withRequestId(String requestId)
The unique identifier for the request to create or update the endpoint.
requestId
- The unique identifier for the request to create or update the endpoint.public void setUser(EndpointUser user)
One or more custom attributes that describe the user who's associated with the endpoint.
user
- One or more custom attributes that describe the user who's associated with the endpoint.public EndpointUser getUser()
One or more custom attributes that describe the user who's associated with the endpoint.
public EndpointBatchItem withUser(EndpointUser user)
One or more custom attributes that describe the user who's associated with the endpoint.
user
- One or more custom attributes that describe the user who's associated with the endpoint.public String toString()
toString
in class Object
Object.toString()
public EndpointBatchItem clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.