PublicEndpoint (AWS SDK for Android - Amazon Pinpoint 2.9.2 API)

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

All Implemented Interfaces:

Serializable
```
public class PublicEndpoint
extends Object
implements Serializable
```
Public endpoint attributes.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

PublicEndpoint()

Constructors
Constructor and Description
`PublicEndpoint()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PublicEndpoint`	`addAttributesEntry(String key, List<String> value)` Custom attributes that your app reports to Amazon Pinpoint.
`PublicEndpoint`	`addMetricsEntry(String key, Double value)` Custom metrics that your app reports to Amazon Pinpoint.
`PublicEndpoint`	`clearAttributesEntries()` Removes all the entries added into Attributes.
`PublicEndpoint`	`clearMetricsEntries()` Removes all the entries added into Metrics.
`boolean`	`equals(Object obj)`
`String`	`getAddress()` The unique identifier for the recipient.
`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 date and time when the endpoint was last updated, in ISO 8601 format.
`String`	`getEndpointStatus()` The status of 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()` A unique identifier that is generated each time the endpoint is updated.
`EndpointUser`	`getUser()` Custom user-specific attributes that your app reports to Amazon Pinpoint.
`int`	`hashCode()`
`void`	`setAddress(String address)` The unique identifier for the recipient.
`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 date and time when the endpoint was last updated, in ISO 8601 format.
`void`	`setEndpointStatus(String endpointStatus)` The status of 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)` A unique identifier that is generated each time the endpoint is updated.
`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.
`PublicEndpoint`	`withAddress(String address)` The unique identifier for the recipient.
`PublicEndpoint`	`withAttributes(Map<String,List<String>> attributes)` Custom attributes that your app reports to Amazon Pinpoint.
`PublicEndpoint`	`withChannelType(ChannelType channelType)` The channel type.
`PublicEndpoint`	`withChannelType(String channelType)` The channel type.
`PublicEndpoint`	`withDemographic(EndpointDemographic demographic)` The endpoint demographic attributes.
`PublicEndpoint`	`withEffectiveDate(String effectiveDate)` The date and time when the endpoint was last updated, in ISO 8601 format.
`PublicEndpoint`	`withEndpointStatus(String endpointStatus)` The status of the endpoint.
`PublicEndpoint`	`withLocation(EndpointLocation location)` The endpoint location attributes.
`PublicEndpoint`	`withMetrics(Map<String,Double> metrics)` Custom metrics that your app reports to Amazon Pinpoint.
`PublicEndpoint`	`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.
`PublicEndpoint`	`withRequestId(String requestId)` A unique identifier that is generated each time the endpoint is updated.
`PublicEndpoint`	`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
  - PublicEndpoint
```
public PublicEndpoint()
```
- Method Detail
  - getAddress
```
public String getAddress()
```
    The unique identifier for the recipient. For example, an address could be a device token, email address, or mobile phone number.
    
    Returns:
    
    The unique identifier for the recipient. For example, an address could be a device token, email address, or mobile phone number.
  - setAddress
```
public void setAddress(String address)
```
    The unique identifier for the recipient. For example, an address could be a device token, email address, or mobile phone number.
    
    Parameters:
    
    address - The unique identifier for the recipient. For example, an address could be a device token, email address, or mobile phone number.
  - withAddress
```
public PublicEndpoint withAddress(String address)
```
    The unique identifier for the recipient. For example, an address could be a device token, email address, or mobile phone number.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    address - The unique identifier for the recipient. For example, an address could be a device token, email address, or mobile phone number.
    
    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 PublicEndpoint 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 PublicEndpoint 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 PublicEndpoint 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: GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM
    
    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: GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM
    
    Parameters:
    
    channelType - The channel type. Valid values: APNS, GCM
    
    See Also:
    
    ChannelType
  - withChannelType
```
public PublicEndpoint 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: GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM
    
    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: GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM
    
    Parameters:
    
    channelType - The channel type. Valid values: APNS, GCM
    
    See Also:
    
    ChannelType
  - withChannelType
```
public PublicEndpoint 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: GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM
    
    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 PublicEndpoint 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 date and time when the endpoint was last updated, in ISO 8601 format.
    
    Returns:
    
    The date and time when the endpoint was last updated, in ISO 8601 format.
  - setEffectiveDate
```
public void setEffectiveDate(String effectiveDate)
```
    The date and time when the endpoint was last updated, in ISO 8601 format.
    
    Parameters:
    
    effectiveDate - The date and time when the endpoint was last updated, in ISO 8601 format.
  - withEffectiveDate
```
public PublicEndpoint withEffectiveDate(String effectiveDate)
```
    The date and time when the endpoint was last updated, 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 last updated, in ISO 8601 format.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getEndpointStatus
```
public String getEndpointStatus()
```
    The status of the endpoint. If the update fails, the value is INACTIVE. If the endpoint is updated successfully, the value is ACTIVE.
    
    Returns:
    
    The status of the endpoint. If the update fails, the value is INACTIVE. If the endpoint is updated successfully, the value is ACTIVE.
  - setEndpointStatus
```
public void setEndpointStatus(String endpointStatus)
```
    The status of the endpoint. If the update fails, the value is INACTIVE. If the endpoint is updated successfully, the value is ACTIVE.
    
    Parameters:
    
    endpointStatus - The status of the endpoint. If the update fails, the value is INACTIVE. If the endpoint is updated successfully, the value is ACTIVE.
  - withEndpointStatus
```
public PublicEndpoint withEndpointStatus(String endpointStatus)
```
    The status of the endpoint. If the update fails, the value is INACTIVE. If the endpoint is updated successfully, the value is ACTIVE.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    endpointStatus - The status of the endpoint. If the update fails, the value is INACTIVE. If the endpoint is updated successfully, the value is ACTIVE.
    
    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 PublicEndpoint 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 PublicEndpoint 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 PublicEndpoint 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 PublicEndpoint 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 PublicEndpoint 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()
```
    A unique identifier that is generated each time the endpoint is updated.
    
    Returns:
    
    A unique identifier that is generated each time the endpoint is updated.
  - setRequestId
```
public void setRequestId(String requestId)
```
    A unique identifier that is generated each time the endpoint is updated.
    
    Parameters:
    
    requestId - A unique identifier that is generated each time the endpoint is updated.
  - withRequestId
```
public PublicEndpoint withRequestId(String requestId)
```
    A unique identifier that is generated each time the endpoint is updated.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    requestId - A unique identifier that is generated each time the endpoint is updated.
    
    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 PublicEndpoint 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 PublicEndpoint

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PublicEndpoint

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