EndpointBatchItem (AWS SDK for Android - Amazon Pinpoint 2.6.21 API)

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

All Implemented Interfaces:

Serializable
```
public class EndpointBatchItem
extends Object
implements Serializable
```
Endpoint update request

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

EndpointBatchItem()

Constructors
Constructor and Description
`EndpointBatchItem()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`EndpointBatchItem`	`addAttributesEntry(String key, List<String> value)` Custom attributes that describe the endpoint by associating a name with an array of values.
`EndpointBatchItem`	`addMetricsEntry(String key, Double value)` Custom metrics that your app reports to Amazon Pinpoint.
`EndpointBatchItem`	`clearAttributesEntries()` Removes all the entries added into Attributes.
`EndpointBatchItem`	`clearMetricsEntries()` Removes all the entries added into Metrics.
`boolean`	`equals(Object obj)`
`String`	`getAddress()` The address or token of the endpoint as provided by your push provider (e.g.
`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.
`EndpointDemographic`	`getDemographic()` The endpoint demographic attributes.
`String`	`getEffectiveDate()` The last time the endpoint was updated.
`String`	`getEndpointStatus()` The endpoint status.
`String`	`getId()` The unique Id for the Endpoint in the batch.
`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 or token of the endpoint as provided by your push provider (e.g.
`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`	`setDemographic(EndpointDemographic demographic)` The endpoint demographic attributes.
`void`	`setEffectiveDate(String effectiveDate)` The last time the endpoint was updated.
`void`	`setEndpointStatus(String endpointStatus)` The endpoint status.
`void`	`setId(String id)` The unique Id for the Endpoint in the batch.
`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.
`EndpointBatchItem`	`withAddress(String address)` The address or token of the endpoint as provided by your push provider (e.g.
`EndpointBatchItem`	`withAttributes(Map<String,List<String>> attributes)` Custom attributes that describe the endpoint by associating a name with an array of values.
`EndpointBatchItem`	`withChannelType(ChannelType channelType)` The channel type.
`EndpointBatchItem`	`withChannelType(String channelType)` The channel type.
`EndpointBatchItem`	`withDemographic(EndpointDemographic demographic)` The endpoint demographic attributes.
`EndpointBatchItem`	`withEffectiveDate(String effectiveDate)` The last time the endpoint was updated.
`EndpointBatchItem`	`withEndpointStatus(String endpointStatus)` The endpoint status.
`EndpointBatchItem`	`withId(String id)` The unique Id for the Endpoint in the batch.
`EndpointBatchItem`	`withLocation(EndpointLocation location)` The endpoint location attributes.
`EndpointBatchItem`	`withMetrics(Map<String,Double> metrics)` Custom metrics that your app reports to Amazon Pinpoint.
`EndpointBatchItem`	`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.
`EndpointBatchItem`	`withRequestId(String requestId)` The unique ID for the most recent request to update the endpoint.
`EndpointBatchItem`	`withUser(EndpointUser user)` Custom user-specific attributes that your app reports to Amazon Pinpoint.

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

- Constructor Detail
  - EndpointBatchItem
```
public EndpointBatchItem()
```
- Method Detail
  - getAddress
```
public String getAddress()
```
    The address or token of the endpoint as provided by your push provider (e.g. DeviceToken or RegistrationId).
    
    Returns:
    
    The address or token of the endpoint as provided by your push provider (e.g. DeviceToken or RegistrationId).
  - setAddress
```
public void setAddress(String address)
```
    The address or token of the endpoint as provided by your push provider (e.g. DeviceToken or RegistrationId).
    
    Parameters:
    
    address - The address or token of the endpoint as provided by your push provider (e.g. DeviceToken or RegistrationId).
  - withAddress
```
public EndpointBatchItem withAddress(String address)
```
    The address or token of the endpoint as provided by your push provider (e.g. DeviceToken or RegistrationId).
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    address - The address or token of the endpoint as provided by your push provider (e.g. DeviceToken or RegistrationId).
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getAttributes
```
public Map<String,List<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(Map<String,List<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 EndpointBatchItem withAttributes(Map<String,List<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 EndpointBatchItem addAttributesEntry(String key,
                                            List<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 EndpointBatchItem clearAttributesEntries()
```
    Removes all the entries added into Attributes.
    Returns a reference to this object so that method calls can be chained together.
  - getChannelType
```
public 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, 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(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, 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 EndpointBatchItem withChannelType(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, 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, 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 EndpointBatchItem 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, 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()
```
    The endpoint demographic attributes.
    
    Returns:
    
    The endpoint demographic attributes.
  - setDemographic
```
public void setDemographic(EndpointDemographic demographic)
```
    The endpoint demographic attributes.
    
    Parameters:
    
    demographic - The endpoint demographic attributes.
  - withDemographic
```
public EndpointBatchItem withDemographic(EndpointDemographic demographic)
```
    The endpoint demographic attributes.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    demographic - The endpoint demographic attributes.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getEffectiveDate
```
public String getEffectiveDate()
```
    The last time the endpoint was updated. Provided in ISO 8601 format.
    
    Returns:
    
    The last time the endpoint was updated. Provided in ISO 8601 format.
  - setEffectiveDate
```
public void setEffectiveDate(String effectiveDate)
```
    The last time the endpoint was updated. Provided in ISO 8601 format.
    
    Parameters:
    
    effectiveDate - The last time the endpoint was updated. Provided in ISO 8601 format.
  - withEffectiveDate
```
public EndpointBatchItem withEffectiveDate(String effectiveDate)
```
    The last time the endpoint was updated. Provided in ISO 8601 format.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    effectiveDate - The last time the endpoint was updated. Provided in ISO 8601 format.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getEndpointStatus
```
public String getEndpointStatus()
```
    The endpoint status. Can be either ACTIVE or INACTIVE. Will be set to INACTIVE if a delivery fails. Will be set to ACTIVE if the address is updated.
    
    Returns:
    
    The endpoint status. Can be either ACTIVE or INACTIVE. Will be set to INACTIVE if a delivery fails. Will be set to ACTIVE if the address is updated.
  - setEndpointStatus
```
public void setEndpointStatus(String endpointStatus)
```
    The endpoint status. Can be either ACTIVE or INACTIVE. Will be set to INACTIVE if a delivery fails. Will be set to ACTIVE if the address is updated.
    
    Parameters:
    
    endpointStatus - The endpoint status. Can be either ACTIVE or INACTIVE. Will be set to INACTIVE if a delivery fails. Will be set to ACTIVE if the address is updated.
  - withEndpointStatus
```
public EndpointBatchItem withEndpointStatus(String endpointStatus)
```
    The endpoint status. Can be either ACTIVE or INACTIVE. Will be set to INACTIVE if a delivery fails. Will be set to ACTIVE if the address is updated.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    endpointStatus - The endpoint status. Can be either ACTIVE or INACTIVE. Will be set to INACTIVE if a delivery fails. Will be set to ACTIVE if the address is updated.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getId
```
public String getId()
```
    The unique Id for the Endpoint in the batch.
    
    Returns:
    
    The unique Id for the Endpoint in the batch.
  - setId
```
public void setId(String id)
```
    The unique Id for the Endpoint in the batch.
    
    Parameters:
    
    id - The unique Id for the Endpoint in the batch.
  - withId
```
public EndpointBatchItem withId(String id)
```
    The unique Id for the Endpoint in the batch.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    id - The unique Id for the Endpoint in the batch.
    
    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 EndpointBatchItem 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 Map<String,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(Map<String,Double> metrics)
```
    Custom metrics that your app reports to Amazon Pinpoint.
    
    Parameters:
    
    metrics - Custom metrics that your app reports to Amazon Pinpoint.
  - withMetrics
```
public EndpointBatchItem withMetrics(Map<String,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 EndpointBatchItem addMetricsEntry(String key,
                                         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 EndpointBatchItem clearMetricsEntries()
```
    Removes all the entries added into Metrics.
    Returns a reference to this object so that method calls can be chained together.
  - getOptOut
```
public 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(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 EndpointBatchItem 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. 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 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(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 EndpointBatchItem withRequestId(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 EndpointBatchItem 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 String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class EndpointBatchItem

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EndpointBatchItem

Method Detail

getAddress

setAddress

withAddress

getAttributes

setAttributes

withAttributes

addAttributesEntry

clearAttributesEntries

getChannelType

setChannelType

withChannelType

setChannelType

withChannelType

getDemographic

setDemographic

withDemographic

getEffectiveDate

setEffectiveDate

withEffectiveDate

getEndpointStatus

setEndpointStatus

withEndpointStatus

getId

setId

withId

getLocation

setLocation

withLocation

getMetrics

setMetrics

withMetrics

addMetricsEntry

clearMetricsEntries

getOptOut

setOptOut

withOptOut

getRequestId

setRequestId

withRequestId

getUser

setUser

withUser

toString

hashCode

equals