public class EndpointResponse extends Object implements Serializable
Constructor and Description |
---|
EndpointResponse() |
Modifier and Type | Method and Description |
---|---|
EndpointResponse |
addAttributesEntry(String key,
List<String> value)
Custom attributes that describe the endpoint by associating a name with
an array of values.
|
EndpointResponse |
addMetricsEntry(String key,
Double value)
Custom metrics that your app reports to Amazon Pinpoint.
|
EndpointResponse |
clearAttributesEntries()
Removes all the entries added into Attributes.
|
EndpointResponse |
clearMetricsEntries()
Removes all the entries added into Metrics.
|
boolean |
equals(Object obj) |
String |
getAddress()
The address of the endpoint as provided by your push provider.
|
String |
getApplicationId()
The ID of the application that is associated with the endpoint.
|
Map<String,List<String>> |
getAttributes()
Custom attributes that describe the endpoint by associating a name with
an array of values.
|
String |
getChannelType()
The channel type.
|
String |
getCohortId()
A number from 0-99 that represents the cohort the endpoint is assigned
to.
|
String |
getCreationDate()
The date and time when the endpoint was created, shown in ISO 8601
format.
|
EndpointDemographic |
getDemographic()
The endpoint demographic attributes.
|
String |
getEffectiveDate()
The date and time when the endpoint was last updated, shown in ISO 8601
format.
|
String |
getEndpointStatus()
Unused.
|
String |
getId()
The unique ID that you assigned to the endpoint.
|
EndpointLocation |
getLocation()
The endpoint location attributes.
|
Map<String,Double> |
getMetrics()
Custom metrics that your app reports to Amazon Pinpoint.
|
String |
getOptOut()
Indicates whether a user has opted out of receiving messages with one of
the following values: ALL - User has opted out of all messages.
|
String |
getRequestId()
The unique ID for the most recent request to update the endpoint.
|
EndpointUser |
getUser()
Custom user-specific attributes that your app reports to Amazon Pinpoint.
|
int |
hashCode() |
void |
setAddress(String address)
The address of the endpoint as provided by your push provider.
|
void |
setApplicationId(String applicationId)
The ID of the application that is associated with the endpoint.
|
void |
setAttributes(Map<String,List<String>> attributes)
Custom attributes that describe the endpoint by associating a name with
an array of values.
|
void |
setChannelType(ChannelType channelType)
The channel type.
|
void |
setChannelType(String channelType)
The channel type.
|
void |
setCohortId(String cohortId)
A number from 0-99 that represents the cohort the endpoint is assigned
to.
|
void |
setCreationDate(String creationDate)
The date and time when the endpoint was created, shown in ISO 8601
format.
|
void |
setDemographic(EndpointDemographic demographic)
The endpoint demographic attributes.
|
void |
setEffectiveDate(String effectiveDate)
The date and time when the endpoint was last updated, shown in ISO 8601
format.
|
void |
setEndpointStatus(String endpointStatus)
Unused.
|
void |
setId(String id)
The unique ID that you assigned to the endpoint.
|
void |
setLocation(EndpointLocation location)
The endpoint location attributes.
|
void |
setMetrics(Map<String,Double> metrics)
Custom metrics that your app reports to Amazon Pinpoint.
|
void |
setOptOut(String optOut)
Indicates whether a user has opted out of receiving messages with one of
the following values: ALL - User has opted out of all messages.
|
void |
setRequestId(String requestId)
The unique ID for the most recent request to update the endpoint.
|
void |
setUser(EndpointUser user)
Custom user-specific attributes that your app reports to Amazon Pinpoint.
|
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
EndpointResponse |
withAddress(String address)
The address of the endpoint as provided by your push provider.
|
EndpointResponse |
withApplicationId(String applicationId)
The ID of the application that is associated with the endpoint.
|
EndpointResponse |
withAttributes(Map<String,List<String>> attributes)
Custom attributes that describe the endpoint by associating a name with
an array of values.
|
EndpointResponse |
withChannelType(ChannelType channelType)
The channel type.
|
EndpointResponse |
withChannelType(String channelType)
The channel type.
|
EndpointResponse |
withCohortId(String cohortId)
A number from 0-99 that represents the cohort the endpoint is assigned
to.
|
EndpointResponse |
withCreationDate(String creationDate)
The date and time when the endpoint was created, shown in ISO 8601
format.
|
EndpointResponse |
withDemographic(EndpointDemographic demographic)
The endpoint demographic attributes.
|
EndpointResponse |
withEffectiveDate(String effectiveDate)
The date and time when the endpoint was last updated, shown in ISO 8601
format.
|
EndpointResponse |
withEndpointStatus(String endpointStatus)
Unused.
|
EndpointResponse |
withId(String id)
The unique ID that you assigned to the endpoint.
|
EndpointResponse |
withLocation(EndpointLocation location)
The endpoint location attributes.
|
EndpointResponse |
withMetrics(Map<String,Double> metrics)
Custom metrics that your app reports to Amazon Pinpoint.
|
EndpointResponse |
withOptOut(String optOut)
Indicates whether a user has opted out of receiving messages with one of
the following values: ALL - User has opted out of all messages.
|
EndpointResponse |
withRequestId(String requestId)
The unique ID for the most recent request to update the endpoint.
|
EndpointResponse |
withUser(EndpointUser user)
Custom user-specific attributes that your app reports to Amazon Pinpoint.
|
public String getAddress()
public void setAddress(String address)
address
- The address of the endpoint as provided by your push
provider. For example, the DeviceToken or RegistrationId.public EndpointResponse withAddress(String address)
Returns a reference to this object so that method calls can be chained together.
address
- The address of the endpoint as provided by your push
provider. For example, the DeviceToken or RegistrationId.public String getApplicationId()
public void setApplicationId(String applicationId)
applicationId
- The ID of the application that is associated with
the endpoint.public EndpointResponse withApplicationId(String applicationId)
Returns a reference to this object so that method calls can be chained together.
applicationId
- The ID of the application that is associated with
the endpoint.public Map<String,List<String>> getAttributes()
public void setAttributes(Map<String,List<String>> attributes)
attributes
- Custom attributes that describe the endpoint by
associating a name with an array of values. For example, an
attribute named "interests" might have the following values:
["science", "politics", "travel"]. You can use these
attributes as selection criteria when you create segments. The
Amazon Pinpoint console can't display attribute names that
include the following characters: hash/pound sign (#), colon
(:), question mark (?), backslash (\), and forward slash (/).
For this reason, you should avoid using these characters in
the names of custom attributes.public EndpointResponse withAttributes(Map<String,List<String>> attributes)
Returns a reference to this object so that method calls can be chained together.
attributes
- Custom attributes that describe the endpoint by
associating a name with an array of values. For example, an
attribute named "interests" might have the following values:
["science", "politics", "travel"]. You can use these
attributes as selection criteria when you create segments. The
Amazon Pinpoint console can't display attribute names that
include the following characters: hash/pound sign (#), colon
(:), question mark (?), backslash (\), and forward slash (/).
For this reason, you should avoid using these characters in
the names of custom attributes.public EndpointResponse addAttributesEntry(String key, List<String> value)
The method adds a new key-value pair into Attributes parameter, and returns a reference to this object so that method calls can be chained together.
key
- The key of the entry to be added into Attributes.value
- The corresponding value of the entry to be added into
Attributes.public EndpointResponse clearAttributesEntries()
Returns a reference to this object so that method calls can be chained together.
public String getChannelType()
Constraints:
Allowed Values: GCM, APNS, APNS_SANDBOX, APNS_VOIP,
APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM
ChannelType
public void setChannelType(String channelType)
Constraints:
Allowed Values: GCM, APNS, APNS_SANDBOX, APNS_VOIP,
APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM
channelType
- The channel type. Valid values: GCM | APNS |
APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS |
EMAIL | BAIDUChannelType
public EndpointResponse withChannelType(String channelType)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: GCM, APNS, APNS_SANDBOX, APNS_VOIP,
APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM
channelType
- The channel type. Valid values: GCM | APNS |
APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS |
EMAIL | BAIDUChannelType
public void setChannelType(ChannelType channelType)
Constraints:
Allowed Values: GCM, APNS, APNS_SANDBOX, APNS_VOIP,
APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM
channelType
- The channel type. Valid values: GCM | APNS |
APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS |
EMAIL | BAIDUChannelType
public EndpointResponse withChannelType(ChannelType channelType)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: GCM, APNS, APNS_SANDBOX, APNS_VOIP,
APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM
channelType
- The channel type. Valid values: GCM | APNS |
APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS |
EMAIL | BAIDUChannelType
public String getCohortId()
public void setCohortId(String cohortId)
cohortId
- A number from 0-99 that represents the cohort the
endpoint is assigned to. Endpoints are grouped into cohorts
randomly, and each cohort contains approximately 1 percent of
the endpoints for an app. Amazon Pinpoint assigns cohorts to
the holdout or treatment allocations for a campaign.public EndpointResponse withCohortId(String cohortId)
Returns a reference to this object so that method calls can be chained together.
cohortId
- A number from 0-99 that represents the cohort the
endpoint is assigned to. Endpoints are grouped into cohorts
randomly, and each cohort contains approximately 1 percent of
the endpoints for an app. Amazon Pinpoint assigns cohorts to
the holdout or treatment allocations for a campaign.public String getCreationDate()
public void setCreationDate(String creationDate)
creationDate
- The date and time when the endpoint was created,
shown in ISO 8601 format.public EndpointResponse withCreationDate(String creationDate)
Returns a reference to this object so that method calls can be chained together.
creationDate
- The date and time when the endpoint was created,
shown in ISO 8601 format.public EndpointDemographic getDemographic()
public void setDemographic(EndpointDemographic demographic)
demographic
- The endpoint demographic attributes.public EndpointResponse withDemographic(EndpointDemographic demographic)
Returns a reference to this object so that method calls can be chained together.
demographic
- The endpoint demographic attributes.public String getEffectiveDate()
public void setEffectiveDate(String effectiveDate)
effectiveDate
- The date and time when the endpoint was last
updated, shown in ISO 8601 format.public EndpointResponse withEffectiveDate(String effectiveDate)
Returns a reference to this object so that method calls can be chained together.
effectiveDate
- The date and time when the endpoint was last
updated, shown in ISO 8601 format.public String getEndpointStatus()
public void setEndpointStatus(String endpointStatus)
endpointStatus
- Unused.public EndpointResponse withEndpointStatus(String endpointStatus)
Returns a reference to this object so that method calls can be chained together.
endpointStatus
- Unused.public String getId()
public void setId(String id)
id
- The unique ID that you assigned to the endpoint. The ID should
be a globally unique identifier (GUID) to ensure that it
doesn't conflict with other endpoint IDs associated with the
application.public EndpointResponse withId(String id)
Returns a reference to this object so that method calls can be chained together.
id
- The unique ID that you assigned to the endpoint. The ID should
be a globally unique identifier (GUID) to ensure that it
doesn't conflict with other endpoint IDs associated with the
application.public EndpointLocation getLocation()
public void setLocation(EndpointLocation location)
location
- The endpoint location attributes.public EndpointResponse withLocation(EndpointLocation location)
Returns a reference to this object so that method calls can be chained together.
location
- The endpoint location attributes.public Map<String,Double> getMetrics()
public void setMetrics(Map<String,Double> metrics)
metrics
- Custom metrics that your app reports to Amazon Pinpoint.public EndpointResponse withMetrics(Map<String,Double> metrics)
Returns a reference to this object so that method calls can be chained together.
metrics
- Custom metrics that your app reports to Amazon Pinpoint.public EndpointResponse addMetricsEntry(String key, Double value)
The method adds a new key-value pair into Metrics parameter, and returns a reference to this object so that method calls can be chained together.
key
- The key of the entry to be added into Metrics.value
- The corresponding value of the entry to be added into
Metrics.public EndpointResponse clearMetricsEntries()
Returns a reference to this object so that method calls can be chained together.
public String getOptOut()
public void setOptOut(String optOut)
optOut
- Indicates whether a user has opted out of receiving
messages with one of the following values: ALL - User has
opted out of all messages. NONE - Users has not opted out and
receives all messages.public EndpointResponse withOptOut(String optOut)
Returns a reference to this object so that method calls can be chained together.
optOut
- Indicates whether a user has opted out of receiving
messages with one of the following values: ALL - User has
opted out of all messages. NONE - Users has not opted out and
receives all messages.public String getRequestId()
public void setRequestId(String requestId)
requestId
- The unique ID for the most recent request to update the
endpoint.public EndpointResponse withRequestId(String requestId)
Returns a reference to this object so that method calls can be chained together.
requestId
- The unique ID for the most recent request to update the
endpoint.public EndpointUser getUser()
public void setUser(EndpointUser user)
user
- Custom user-specific attributes that your app reports to
Amazon Pinpoint.public EndpointResponse withUser(EndpointUser user)
Returns a reference to this object so that method calls can be chained together.
user
- Custom user-specific attributes that your app reports to
Amazon Pinpoint.public String toString()
toString
in class Object
Object.toString()
Copyright © 2019. All rights reserved.