EndpointRequest (AWS SDK for Android

java.lang.Object
- com.amazonaws.services.pinpoint.model.EndpointRequest

All Implemented Interfaces:

java.io.Serializable
```
public class EndpointRequest
extends java.lang.Object
implements java.io.Serializable
```
An endpoint update request.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

EndpointRequest()

Constructors
Constructor and Description
`EndpointRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`EndpointRequest`	`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.
`EndpointRequest`	`addMetricsEntry(java.lang.String key, java.lang.Double value)` Custom metrics that your app reports to Amazon Pinpoint.
`EndpointRequest`	`clearAttributesEntries()` Removes all the entries added into Attributes.
`EndpointRequest`	`clearMetricsEntries()` Removes all the entries added into Metrics.
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getAddress()` The destination for messages that you send to this 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.
`EndpointDemographic`	`getDemographic()` Demographic attributes for the endpoint.
`java.lang.String`	`getEffectiveDate()` The date and time when the endpoint was updated, shown in ISO 8601 format.
`java.lang.String`	`getEndpointStatus()` Unused.
`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 destination for messages that you send to this 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`	`setDemographic(EndpointDemographic demographic)` Demographic attributes for the endpoint.
`void`	`setEffectiveDate(java.lang.String effectiveDate)` The date and time when the endpoint was updated, shown in ISO 8601 format.
`void`	`setEndpointStatus(java.lang.String endpointStatus)` Unused.
`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.
`EndpointRequest`	`withAddress(java.lang.String address)` The destination for messages that you send to this endpoint.
`EndpointRequest`	`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.
`EndpointRequest`	`withChannelType(ChannelType channelType)` The channel type.
`EndpointRequest`	`withChannelType(java.lang.String channelType)` The channel type.
`EndpointRequest`	`withDemographic(EndpointDemographic demographic)` Demographic attributes for the endpoint.
`EndpointRequest`	`withEffectiveDate(java.lang.String effectiveDate)` The date and time when the endpoint was updated, shown in ISO 8601 format.
`EndpointRequest`	`withEndpointStatus(java.lang.String endpointStatus)` Unused.
`EndpointRequest`	`withLocation(EndpointLocation location)` The endpoint location attributes.
`EndpointRequest`	`withMetrics(java.util.Map<java.lang.String,java.lang.Double> metrics)` Custom metrics that your app reports to Amazon Pinpoint.
`EndpointRequest`	`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.
`EndpointRequest`	`withRequestId(java.lang.String requestId)` The unique ID for the most recent request to update the endpoint.
`EndpointRequest`	`withUser(EndpointUser user)` Custom user-specific attributes that your app reports to Amazon Pinpoint.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - EndpointRequest
```
public EndpointRequest()
```
- Method Detail
  - getAddress
```
public java.lang.String getAddress()
```
    The destination for messages that you send to this endpoint. The address varies by channel. For mobile push channels, use the token provided by the push notification service, such as the APNs device token or the 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:
    
    The destination for messages that you send to this endpoint. The address varies by channel. For mobile push channels, use the token provided by the push notification service, such as the APNs device token or the 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.
  - setAddress
```
public void setAddress(java.lang.String address)
```
    The destination for messages that you send to this endpoint. The address varies by channel. For mobile push channels, use the token provided by the push notification service, such as the APNs device token or the 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 for messages that you send to this endpoint. The address varies by channel. For mobile push channels, use the token provided by the push notification service, such as the APNs device token or the 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.
  - withAddress
```
public EndpointRequest withAddress(java.lang.String address)
```
    The destination for messages that you send to this endpoint. The address varies by channel. For mobile push channels, use the token provided by the push notification service, such as the APNs device token or the 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 a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    address - The destination for messages that you send to this endpoint. The address varies by channel. For mobile push channels, use the token provided by the push notification service, such as the APNs device token or the 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:
    
    A reference to this updated object so that method calls can be chained together.
  - getAttributes
```
public 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. For example, an attribute named "interests" might have the values ["science", "politics", "travel"]. You can use these attributes as selection criteria when you create a segment of users to engage with a messaging campaign. The following characters are not recommended in attribute names: # : ? \ /. The Amazon Pinpoint console does not display attributes that include these characters in the name. This limitation does not apply to attribute values.
    
    Returns:
    
    Custom attributes that describe the endpoint by associating a name with an array of values. For example, an attribute named "interests" might have the values ["science", "politics", "travel"]. You can use these attributes as selection criteria when you create a segment of users to engage with a messaging campaign. The following characters are not recommended in attribute names: # : ? \ /. The Amazon Pinpoint console does not display attributes that include these characters in the name. This limitation does not apply to attribute values.
  - setAttributes
```
public 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. For example, an attribute named "interests" might have the values ["science", "politics", "travel"]. You can use these attributes as selection criteria when you create a segment of users to engage with a messaging campaign. The following characters are not recommended in attribute names: # : ? \ /. The Amazon Pinpoint console does not display attributes that include these characters in the name. This limitation does not apply to attribute values.
    
    Parameters:
    
    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 values ["science", "politics", "travel"]. You can use these attributes as selection criteria when you create a segment of users to engage with a messaging campaign. The following characters are not recommended in attribute names: # : ? \ /. The Amazon Pinpoint console does not display attributes that include these characters in the name. This limitation does not apply to attribute values.
  - withAttributes
```
public EndpointRequest 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. For example, an attribute named "interests" might have the values ["science", "politics", "travel"]. You can use these attributes as selection criteria when you create a segment of users to engage with a messaging campaign. The following characters are not recommended in attribute names: # : ? \ /. The Amazon Pinpoint console does not display attributes that include these characters in the name. This limitation does not apply to attribute values.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    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 values ["science", "politics", "travel"]. You can use these attributes as selection criteria when you create a segment of users to engage with a messaging campaign. The following characters are not recommended in attribute names: # : ? \ /. The Amazon Pinpoint console does not display attributes that include these characters in the name. This limitation does not apply to attribute values.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - addAttributesEntry
```
public EndpointRequest 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. For example, an attribute named "interests" might have the values ["science", "politics", "travel"]. You can use these attributes as selection criteria when you create a segment of users to engage with a messaging campaign. The following characters are not recommended in attribute names: # : ? \ /. The Amazon Pinpoint console does not display attributes that include these characters in the name. This limitation does not apply to attribute values.
    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.
    
    Parameters:
    
    key - The key of the entry to be added into Attributes.
    
    value - The corresponding value of the entry to be added into Attributes.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - clearAttributesEntries
```
public EndpointRequest clearAttributesEntries()
```
    Removes all the entries added into Attributes.
    Returns a reference to this object so that method calls can be chained together.
  - getChannelType
```
public java.lang.String getChannelType()
```
    The channel type. Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU
    Constraints:
    Allowed Values: GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM
    
    Returns:
    
    The channel type. Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU
    
    See Also:
    
    ChannelType
  - setChannelType
```
public void setChannelType(java.lang.String channelType)
```
    The channel type. Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU
    Constraints:
    Allowed Values: GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM
    
    Parameters:
    
    channelType - The channel type. Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU
    
    See Also:
    
    ChannelType
  - withChannelType
```
public EndpointRequest withChannelType(java.lang.String channelType)
```
    The channel type. Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU
    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
    
    Parameters:
    
    channelType - The channel type. Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    ChannelType
  - setChannelType
```
public void setChannelType(ChannelType channelType)
```
    The channel type. Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU
    Constraints:
    Allowed Values: GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM
    
    Parameters:
    
    channelType - The channel type. Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU
    
    See Also:
    
    ChannelType
  - withChannelType
```
public EndpointRequest withChannelType(ChannelType channelType)
```
    The channel type. Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU
    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
    
    Parameters:
    
    channelType - The channel type. Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    ChannelType
  - getDemographic
```
public EndpointDemographic getDemographic()
```
    Demographic attributes for the endpoint.
    
    Returns:
    
    Demographic attributes for the endpoint.
  - setDemographic
```
public void setDemographic(EndpointDemographic demographic)
```
    Demographic attributes for the endpoint.
    
    Parameters:
    
    demographic - Demographic attributes for the endpoint.
  - withDemographic
```
public EndpointRequest withDemographic(EndpointDemographic demographic)
```
    Demographic attributes for the endpoint.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    demographic - Demographic attributes for the endpoint.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getEffectiveDate
```
public java.lang.String getEffectiveDate()
```
    The date and time when the endpoint was updated, shown in ISO 8601 format.
    
    Returns:
    
    The date and time when the endpoint was updated, shown in ISO 8601 format.
  - setEffectiveDate
```
public void setEffectiveDate(java.lang.String effectiveDate)
```
    The date and time when the endpoint was updated, shown in ISO 8601 format.
    
    Parameters:
    
    effectiveDate - The date and time when the endpoint was updated, shown in ISO 8601 format.
  - withEffectiveDate
```
public EndpointRequest withEffectiveDate(java.lang.String effectiveDate)
```
    The date and time when the endpoint was updated, shown in ISO 8601 format.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    effectiveDate - The date and time when the endpoint was updated, shown in ISO 8601 format.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getEndpointStatus
```
public java.lang.String getEndpointStatus()
```
    Unused.
    
    Returns:
    
    Unused.
  - setEndpointStatus
```
public void setEndpointStatus(java.lang.String endpointStatus)
```
    Unused.
    
    Parameters:
    
    endpointStatus - Unused.
  - withEndpointStatus
```
public EndpointRequest withEndpointStatus(java.lang.String endpointStatus)
```
    Unused.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    endpointStatus - Unused.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getLocation
```
public EndpointLocation getLocation()
```
    The endpoint location attributes.
    
    Returns:
    
    The endpoint location attributes.
  - setLocation
```
public void setLocation(EndpointLocation location)
```
    The endpoint location attributes.
    
    Parameters:
    
    location - The endpoint location attributes.
  - withLocation
```
public EndpointRequest withLocation(EndpointLocation location)
```
    The endpoint location attributes.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    location - The endpoint location attributes.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getMetrics
```
public java.util.Map<java.lang.String,java.lang.Double> getMetrics()
```
    Custom metrics that your app reports to Amazon Pinpoint.
    
    Returns:
    
    Custom metrics that your app reports to Amazon Pinpoint.
  - setMetrics
```
public void setMetrics(java.util.Map<java.lang.String,java.lang.Double> metrics)
```
    Custom metrics that your app reports to Amazon Pinpoint.
    
    Parameters:
    
    metrics - Custom metrics that your app reports to Amazon Pinpoint.
  - withMetrics
```
public EndpointRequest withMetrics(java.util.Map<java.lang.String,java.lang.Double> metrics)
```
    Custom metrics that your app reports to Amazon Pinpoint.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    metrics - Custom metrics that your app reports to Amazon Pinpoint.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - addMetricsEntry
```
public EndpointRequest addMetricsEntry(java.lang.String key,
                                       java.lang.Double value)
```
    Custom metrics that your app reports to Amazon Pinpoint.
    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.
    
    Parameters:
    
    key - The key of the entry to be added into Metrics.
    
    value - The corresponding value of the entry to be added into Metrics.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - clearMetricsEntries
```
public EndpointRequest clearMetricsEntries()
```
    Removes all the entries added into Metrics.
    Returns a reference to this object so that method calls can be chained together.
  - getOptOut
```
public 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. NONE - Users has not opted out and receives all messages.
    
    Returns:
    
    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.
  - setOptOut
```
public 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. NONE - Users has not opted out and receives all messages.
    
    Parameters:
    
    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.
  - withOptOut
```
public EndpointRequest 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. NONE - Users has not opted out and receives all messages.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    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.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getRequestId
```
public java.lang.String getRequestId()
```
    The unique ID for the most recent request to update the endpoint.
    
    Returns:
    
    The unique ID for the most recent request to update the endpoint.
  - setRequestId
```
public void setRequestId(java.lang.String requestId)
```
    The unique ID for the most recent request to update the endpoint.
    
    Parameters:
    
    requestId - The unique ID for the most recent request to update the endpoint.
  - withRequestId
```
public EndpointRequest withRequestId(java.lang.String requestId)
```
    The unique ID for the most recent request to update the endpoint.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    requestId - The unique ID for the most recent request to update the endpoint.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getUser
```
public EndpointUser getUser()
```
    Custom user-specific attributes that your app reports to Amazon Pinpoint.
    
    Returns:
    
    Custom user-specific attributes that your app reports to Amazon Pinpoint.
  - setUser
```
public void setUser(EndpointUser user)
```
    Custom user-specific attributes that your app reports to Amazon Pinpoint.
    
    Parameters:
    
    user - Custom user-specific attributes that your app reports to Amazon Pinpoint.
  - withUser
```
public EndpointRequest withUser(EndpointUser user)
```
    Custom user-specific attributes that your app reports to Amazon Pinpoint.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    user - Custom user-specific attributes that your app reports to Amazon Pinpoint.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class EndpointRequest

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EndpointRequest

Method Detail

getAddress

setAddress

withAddress

getAttributes

setAttributes

withAttributes

addAttributesEntry

clearAttributesEntries

getChannelType

setChannelType

withChannelType

setChannelType

withChannelType

getDemographic

setDemographic

withDemographic

getEffectiveDate

setEffectiveDate

withEffectiveDate

getEndpointStatus

setEndpointStatus

withEndpointStatus

getLocation

setLocation

withLocation

getMetrics

setMetrics

withMetrics

addMetricsEntry

clearMetricsEntries

getOptOut

setOptOut

withOptOut

getRequestId

setRequestId

withRequestId

getUser

setUser

withUser

toString

hashCode

equals