@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class EndpointResponse extends Object implements Serializable, Cloneable, StructuredPojo
Provides information about the channel type and other settings for an endpoint.
Constructor and Description |
---|
EndpointResponse() |
Modifier and Type | Method and Description |
---|---|
EndpointResponse |
addAttributesEntry(String key,
List<String> value)
Add a single Attributes entry
|
EndpointResponse |
addMetricsEntry(String key,
Double value)
Add a single Metrics entry
|
EndpointResponse |
clearAttributesEntries()
Removes all the entries added into Attributes.
|
EndpointResponse |
clearMetricsEntries()
Removes all the entries added into Metrics.
|
EndpointResponse |
clone() |
boolean |
equals(Object obj) |
String |
getAddress()
The destination address for messages or push notifications that you send to the endpoint.
|
String |
getApplicationId()
The unique identifier for the application that's associated with 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 that's used when sending messages or push notifications to the endpoint.
|
String |
getCohortId()
A number from 0-99 that represents the cohort that the endpoint is assigned to.
|
String |
getCreationDate()
The date and time, in ISO 8601 format, when the endpoint was created.
|
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 last updated.
|
String |
getEndpointStatus()
Specifies whether messages or push notifications are sent to the endpoint.
|
String |
getId()
The unique identifier that you assigned to the endpoint.
|
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 most recent request to update the endpoint.
|
EndpointUser |
getUser()
One or more custom user attributes that your app reports to Amazon Pinpoint for 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 |
setApplicationId(String applicationId)
The unique identifier for the application that's associated with 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 that's used when sending messages or push notifications to the endpoint.
|
void |
setChannelType(String channelType)
The channel that's used when sending messages or push notifications to the endpoint.
|
void |
setCohortId(String cohortId)
A number from 0-99 that represents the cohort that the endpoint is assigned to.
|
void |
setCreationDate(String creationDate)
The date and time, in ISO 8601 format, when the endpoint was created.
|
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 last updated.
|
void |
setEndpointStatus(String endpointStatus)
Specifies whether messages or push notifications are sent to the endpoint.
|
void |
setId(String id)
The unique identifier that you assigned to the endpoint.
|
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 most recent request to update the endpoint.
|
void |
setUser(EndpointUser user)
One or more custom user attributes that your app reports to Amazon Pinpoint for the user who's associated with
the endpoint.
|
String |
toString()
Returns a string representation of this object.
|
EndpointResponse |
withAddress(String address)
The destination address for messages or push notifications that you send to the endpoint.
|
EndpointResponse |
withApplicationId(String applicationId)
The unique identifier for the application that's associated with the endpoint.
|
EndpointResponse |
withAttributes(Map<String,List<String>> attributes)
One or more custom attributes that describe the endpoint by associating a name with an array of values.
|
EndpointResponse |
withChannelType(ChannelType channelType)
The channel that's used when sending messages or push notifications to the endpoint.
|
EndpointResponse |
withChannelType(String channelType)
The channel that's used when sending messages or push notifications to the endpoint.
|
EndpointResponse |
withCohortId(String cohortId)
A number from 0-99 that represents the cohort that the endpoint is assigned to.
|
EndpointResponse |
withCreationDate(String creationDate)
The date and time, in ISO 8601 format, when the endpoint was created.
|
EndpointResponse |
withDemographic(EndpointDemographic demographic)
The demographic information for the endpoint, such as the time zone and platform.
|
EndpointResponse |
withEffectiveDate(String effectiveDate)
The date and time, in ISO 8601 format, when the endpoint was last updated.
|
EndpointResponse |
withEndpointStatus(String endpointStatus)
Specifies whether messages or push notifications are sent to the endpoint.
|
EndpointResponse |
withId(String id)
The unique identifier that you assigned to the endpoint.
|
EndpointResponse |
withLocation(EndpointLocation location)
The geographic information for the endpoint.
|
EndpointResponse |
withMetrics(Map<String,Double> metrics)
One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.
|
EndpointResponse |
withOptOut(String optOut)
Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push
notifications from you.
|
EndpointResponse |
withRequestId(String requestId)
The unique identifier for the most recent request to update the endpoint.
|
EndpointResponse |
withUser(EndpointUser user)
One or more custom user attributes that your app reports to Amazon Pinpoint for 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 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.public String getAddress()
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.
public EndpointResponse withAddress(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.public void setApplicationId(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.public String getApplicationId()
The unique identifier for the application that's associated with the endpoint.
public EndpointResponse withApplicationId(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.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.
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.
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.public EndpointResponse 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.
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.public EndpointResponse addAttributesEntry(String key, List<String> value)
public EndpointResponse clearAttributesEntries()
public void setChannelType(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
public String getChannelType()
The channel that's used when sending messages or push notifications to the endpoint.
ChannelType
public EndpointResponse withChannelType(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
public void setChannelType(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
public EndpointResponse withChannelType(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
public void setCohortId(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.public String getCohortId()
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.
public EndpointResponse withCohortId(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.public void setCreationDate(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.public String getCreationDate()
The date and time, in ISO 8601 format, when the endpoint was created.
public EndpointResponse withCreationDate(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.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 EndpointResponse 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 last updated.
effectiveDate
- The date and time, in ISO 8601 format, when the endpoint was last updated.public String getEffectiveDate()
The date and time, in ISO 8601 format, when the endpoint was last updated.
public EndpointResponse withEffectiveDate(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.public void setEndpointStatus(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.
public String getEndpointStatus()
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.
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 EndpointResponse withEndpointStatus(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.
public void setId(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.public String getId()
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.
public EndpointResponse withId(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.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 EndpointResponse 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 EndpointResponse 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 EndpointResponse addMetricsEntry(String key, Double value)
public EndpointResponse 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 EndpointResponse 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 most recent request to update the endpoint.
requestId
- The unique identifier for the most recent request to update the endpoint.public String getRequestId()
The unique identifier for the most recent request to update the endpoint.
public EndpointResponse withRequestId(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.public void setUser(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.public EndpointUser getUser()
One or more custom user attributes that your app reports to Amazon Pinpoint for the user who's associated with the endpoint.
public EndpointResponse withUser(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.public String toString()
toString
in class Object
Object.toString()
public EndpointResponse clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.