EndpointRequest (AWS SDK for Android - Amazon Pinpoint 2.4.2 API)

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

All Implemented Interfaces:: Serializable

public class EndpointRequest
extends Object
implements Serializable

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(String key, List<String> value)` Custom attributes that your app reports to Amazon Pinpoint.
`EndpointRequest`	`addMetricsEntry(String key, 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(Object obj)`
`String`	`getAddress()` The address or token of the endpoint.
`Map<String,List<String>>`	`getAttributes()` Custom attributes that your app reports to Amazon Pinpoint.
`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.
`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 receives 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.
`void`	`setAttributes(Map<String,List<String>> attributes)` Custom attributes that your app reports to Amazon Pinpoint.
`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`	`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 receives 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.
`EndpointRequest`	`withAddress(String address)` The address or token of the endpoint.
`EndpointRequest`	`withAttributes(Map<String,List<String>> attributes)` Custom attributes that your app reports to Amazon Pinpoint.
`EndpointRequest`	`withChannelType(ChannelType channelType)` The channel type.
`EndpointRequest`	`withChannelType(String channelType)` The channel type.
`EndpointRequest`	`withDemographic(EndpointDemographic demographic)` The endpoint demographic attributes.
`EndpointRequest`	`withEffectiveDate(String effectiveDate)` The last time the endpoint was updated.
`EndpointRequest`	`withEndpointStatus(String endpointStatus)` The endpoint status.
`EndpointRequest`	`withLocation(EndpointLocation location)` The endpoint location attributes.
`EndpointRequest`	`withMetrics(Map<String,Double> metrics)` Custom metrics that your app reports to Amazon Pinpoint.
`EndpointRequest`	`withOptOut(String optOut)` Indicates whether a user has opted out of receiving messages with one of the following values: ALL â€“ User receives all messages.
`EndpointRequest`	`withRequestId(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
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - EndpointRequest
```
public EndpointRequest()
```
- Method Detail
  - getAddress
```
public String getAddress()
```
    The address or token of the endpoint.
    
    Returns:
    
    The address or token of the endpoint.
  - setAddress
```
public void setAddress(String address)
```
    The address or token of the endpoint.
    
    Parameters:
    
    address - The address or token of the endpoint.
  - withAddress
```
public EndpointRequest withAddress(String address)
```
    The address or token of the endpoint.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    address - The address or token of the endpoint.
    
    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 your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create a segment.
    
    Returns:
    
    Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create a segment.
  - setAttributes
```
public void setAttributes(Map<String,List<String>> attributes)
```
    Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create a segment.
    
    Parameters:
    
    attributes - Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create a segment.
  - withAttributes
```
public EndpointRequest withAttributes(Map<String,List<String>> attributes)
```
    Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create a segment.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    attributes - Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create a segment.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - addAttributesEntry
```
public EndpointRequest addAttributesEntry(String key,
                                          List<String> value)
```
    Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create a segment.
    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 String getChannelType()
```
    The channel type. Valid values: APNS, GCM
    Constraints:
    Allowed Values: APNS, GCM
    
    Returns:
    
    The channel type. Valid values: APNS, GCM
    
    See Also:
    
    ChannelType
  - setChannelType
```
public void setChannelType(String channelType)
```
    The channel type. Valid values: APNS, GCM
    Constraints:
    Allowed Values: APNS, GCM
    
    Parameters:
    
    channelType - The channel type. Valid values: APNS, GCM
    
    See Also:
    
    ChannelType
  - withChannelType
```
public EndpointRequest withChannelType(String channelType)
```
    The channel type. Valid values: APNS, GCM
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: APNS, GCM
    
    Parameters:
    
    channelType - The channel type. Valid values: APNS, GCM
    
    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: APNS, GCM
    Constraints:
    Allowed Values: APNS, GCM
    
    Parameters:
    
    channelType - The channel type. Valid values: APNS, GCM
    
    See Also:
    
    ChannelType
  - withChannelType
```
public EndpointRequest withChannelType(ChannelType channelType)
```
    The channel type. Valid values: APNS, GCM
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: APNS, GCM
    
    Parameters:
    
    channelType - The channel type. Valid values: APNS, GCM
    
    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 EndpointRequest 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 EndpointRequest 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 EndpointRequest 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.
  - 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 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 EndpointRequest 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 EndpointRequest 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 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 String getOptOut()
```
    Indicates whether a user has opted out of receiving messages with one of the following values: ALL â€“ User receives all messages. NONE â€“ User receives no messages.
    
    Returns:
    
    Indicates whether a user has opted out of receiving messages with one of the following values: ALL â€“ User receives all messages. NONE â€“ User receives no 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 receives all messages. NONE â€“ User receives no messages.
    
    Parameters:
    
    optOut - Indicates whether a user has opted out of receiving messages with one of the following values: ALL â€“ User receives all messages. NONE â€“ User receives no messages.
  - withOptOut
```
public EndpointRequest withOptOut(String optOut)
```
    Indicates whether a user has opted out of receiving messages with one of the following values: ALL â€“ User receives all messages. NONE â€“ User receives no 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 receives all messages. NONE â€“ User receives no 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 EndpointRequest 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 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 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 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