public class EndpointResponse
extends java.lang.Object
implements java.io.Serializable
Constructor and Description |
---|
EndpointResponse() |
Modifier and Type | Method and Description |
---|---|
EndpointResponse |
addAttributesEntry(java.lang.String key,
java.util.List<java.lang.String> value)
Custom attributes that describe the endpoint by associating a name with
an array of values.
|
EndpointResponse |
addMetricsEntry(java.lang.String key,
java.lang.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(java.lang.Object obj) |
java.lang.String |
getAddress()
The address of the endpoint as provided by your push provider.
|
java.lang.String |
getApplicationId()
The ID of the application that is associated with the endpoint.
|
java.util.Map<java.lang.String,java.util.List<java.lang.String>> |
getAttributes()
Custom attributes that describe the endpoint by associating a name with
an array of values.
|
java.lang.String |
getChannelType()
The channel type.
|
java.lang.String |
getCohortId()
A number from 0-99 that represents the cohort the endpoint is assigned
to.
|
java.lang.String |
getCreationDate()
The date and time when the endpoint was created, shown in ISO 8601
format.
|
EndpointDemographic |
getDemographic()
The endpoint demographic attributes.
|
java.lang.String |
getEffectiveDate()
The date and time when the endpoint was last updated, shown in ISO 8601
format.
|
java.lang.String |
getEndpointStatus()
Unused.
|
java.lang.String |
getId()
The unique ID that you assigned to the endpoint.
|
EndpointLocation |
getLocation()
The endpoint location attributes.
|
java.util.Map<java.lang.String,java.lang.Double> |
getMetrics()
Custom metrics that your app reports to Amazon Pinpoint.
|
java.lang.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.
|
java.lang.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(java.lang.String address)
The address of the endpoint as provided by your push provider.
|
void |
setApplicationId(java.lang.String applicationId)
The ID of the application that is associated with the endpoint.
|
void |
setAttributes(java.util.Map<java.lang.String,java.util.List<java.lang.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(java.lang.String channelType)
The channel type.
|
void |
setCohortId(java.lang.String cohortId)
A number from 0-99 that represents the cohort the endpoint is assigned
to.
|
void |
setCreationDate(java.lang.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(java.lang.String effectiveDate)
The date and time when the endpoint was last updated, shown in ISO 8601
format.
|
void |
setEndpointStatus(java.lang.String endpointStatus)
Unused.
|
void |
setId(java.lang.String id)
The unique ID that you assigned to the endpoint.
|
void |
setLocation(EndpointLocation location)
The endpoint location attributes.
|
void |
setMetrics(java.util.Map<java.lang.String,java.lang.Double> metrics)
Custom metrics that your app reports to Amazon Pinpoint.
|
void |
setOptOut(java.lang.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(java.lang.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.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
EndpointResponse |
withAddress(java.lang.String address)
The address of the endpoint as provided by your push provider.
|
EndpointResponse |
withApplicationId(java.lang.String applicationId)
The ID of the application that is associated with the endpoint.
|
EndpointResponse |
withAttributes(java.util.Map<java.lang.String,java.util.List<java.lang.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(java.lang.String channelType)
The channel type.
|
EndpointResponse |
withCohortId(java.lang.String cohortId)
A number from 0-99 that represents the cohort the endpoint is assigned
to.
|
EndpointResponse |
withCreationDate(java.lang.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(java.lang.String effectiveDate)
The date and time when the endpoint was last updated, shown in ISO 8601
format.
|
EndpointResponse |
withEndpointStatus(java.lang.String endpointStatus)
Unused.
|
EndpointResponse |
withId(java.lang.String id)
The unique ID that you assigned to the endpoint.
|
EndpointResponse |
withLocation(EndpointLocation location)
The endpoint location attributes.
|
EndpointResponse |
withMetrics(java.util.Map<java.lang.String,java.lang.Double> metrics)
Custom metrics that your app reports to Amazon Pinpoint.
|
EndpointResponse |
withOptOut(java.lang.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(java.lang.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 java.lang.String getAddress()
public void setAddress(java.lang.String address)
address
- The address of the endpoint as provided by your push
provider. For example, the DeviceToken or RegistrationId.public EndpointResponse withAddress(java.lang.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 java.lang.String getApplicationId()
public void setApplicationId(java.lang.String applicationId)
applicationId
- The ID of the application that is associated with
the endpoint.public EndpointResponse withApplicationId(java.lang.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 java.util.Map<java.lang.String,java.util.List<java.lang.String>> getAttributes()
public void setAttributes(java.util.Map<java.lang.String,java.util.List<java.lang.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(java.util.Map<java.lang.String,java.util.List<java.lang.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(java.lang.String key, java.util.List<java.lang.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 java.lang.String getChannelType()
Constraints:
Allowed Values: GCM, APNS, APNS_SANDBOX, APNS_VOIP,
APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM
ChannelType
public void setChannelType(java.lang.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(java.lang.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 java.lang.String getCohortId()
public void setCohortId(java.lang.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(java.lang.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 java.lang.String getCreationDate()
public void setCreationDate(java.lang.String creationDate)
creationDate
- The date and time when the endpoint was created,
shown in ISO 8601 format.public EndpointResponse withCreationDate(java.lang.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 java.lang.String getEffectiveDate()
public void setEffectiveDate(java.lang.String effectiveDate)
effectiveDate
- The date and time when the endpoint was last
updated, shown in ISO 8601 format.public EndpointResponse withEffectiveDate(java.lang.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 java.lang.String getEndpointStatus()
public void setEndpointStatus(java.lang.String endpointStatus)
endpointStatus
- Unused.public EndpointResponse withEndpointStatus(java.lang.String endpointStatus)
Returns a reference to this object so that method calls can be chained together.
endpointStatus
- Unused.public java.lang.String getId()
public void setId(java.lang.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(java.lang.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 java.util.Map<java.lang.String,java.lang.Double> getMetrics()
public void setMetrics(java.util.Map<java.lang.String,java.lang.Double> metrics)
metrics
- Custom metrics that your app reports to Amazon Pinpoint.public EndpointResponse withMetrics(java.util.Map<java.lang.String,java.lang.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(java.lang.String key, java.lang.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 java.lang.String getOptOut()
public void setOptOut(java.lang.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(java.lang.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 java.lang.String getRequestId()
public void setRequestId(java.lang.String requestId)
requestId
- The unique ID for the most recent request to update the
endpoint.public EndpointResponse withRequestId(java.lang.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 java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
Copyright © 2018 Amazon Web Services, Inc. All Rights Reserved.