PublicEndpoint (AWS Java SDK for Amazon Pinpoint 1.11.478 API)

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

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class PublicEndpoint
extends Object
implements Serializable, Cloneable, StructuredPojo

Public endpoint attributes.

See Also:: AWS API Documentation, 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)`
`PublicEndpoint`	`addMetricsEntry(String key, Double value)`
`PublicEndpoint`	`clearAttributesEntries()` Removes all the entries added into Attributes.
`PublicEndpoint`	`clearMetricsEntries()` Removes all the entries added into Metrics.
`PublicEndpoint`	`clone()`
`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`	`marshall(ProtocolMarshaller protocolMarshaller)`
`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(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.
`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
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - PublicEndpoint
```
public PublicEndpoint()
```
- Method Detail
  - 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.
  - 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.
  - 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.
    
    Parameters:
    
    address - The unique identifier for the recipient. For example, an address could be a device token, email address, or mobile phone number.
    
    Returns:
    
    Returns a reference to this 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.
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - addAttributesEntry
```
public PublicEndpoint addAttributesEntry(String key,
                                         List<String> value)
```
  - clearAttributesEntries
```
public PublicEndpoint clearAttributesEntries()
```
    Removes all the entries added into Attributes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setChannelType
```
public void setChannelType(String channelType)
```
    The channel type. Valid values: APNS, GCM
    
    Parameters:
    
    channelType - The channel type. Valid values: APNS, GCM
    
    See Also:
    
    ChannelType
  - getChannelType
```
public String getChannelType()
```
    The channel type. Valid values: APNS, GCM
    
    Returns:
    
    The channel type. Valid values: APNS, GCM
    
    See Also:
    
    ChannelType
  - withChannelType
```
public PublicEndpoint withChannelType(String channelType)
```
    The channel type. Valid values: APNS, GCM
    
    Parameters:
    
    channelType - The channel type. Valid values: APNS, GCM
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ChannelType
  - withChannelType
```
public PublicEndpoint withChannelType(ChannelType channelType)
```
    The channel type. Valid values: APNS, GCM
    
    Parameters:
    
    channelType - The channel type. Valid values: APNS, GCM
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ChannelType
  - setDemographic
```
public void setDemographic(EndpointDemographic demographic)
```
    The endpoint demographic attributes.
    
    Parameters:
    
    demographic - The endpoint demographic attributes.
  - getDemographic
```
public EndpointDemographic getDemographic()
```
    The endpoint demographic attributes.
    
    Returns:
    
    The endpoint demographic attributes.
  - withDemographic
```
public PublicEndpoint withDemographic(EndpointDemographic demographic)
```
    The endpoint demographic attributes.
    
    Parameters:
    
    demographic - The endpoint demographic attributes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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.
  - 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.
  - withEffectiveDate
```
public PublicEndpoint withEffectiveDate(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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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.
  - 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.
  - 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.
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLocation
```
public void setLocation(EndpointLocation location)
```
    The endpoint location attributes.
    
    Parameters:
    
    location - The endpoint location attributes.
  - getLocation
```
public EndpointLocation getLocation()
```
    The endpoint location attributes.
    
    Returns:
    
    The endpoint location attributes.
  - withLocation
```
public PublicEndpoint withLocation(EndpointLocation location)
```
    The endpoint location attributes.
    
    Parameters:
    
    location - The endpoint location attributes.
    
    Returns:
    
    Returns a reference to this 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.
    
    Parameters:
    
    metrics - Custom metrics that your app reports to Amazon Pinpoint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addMetricsEntry
```
public PublicEndpoint addMetricsEntry(String key,
                                      Double value)
```
  - clearMetricsEntries
```
public PublicEndpoint clearMetricsEntries()
```
    Removes all the entries added into Metrics.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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.
  - 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.
  - 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.
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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.
  - 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.
  - withRequestId
```
public PublicEndpoint withRequestId(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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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.
  - 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.
  - withUser
```
public PublicEndpoint withUser(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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public PublicEndpoint clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class PublicEndpoint

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PublicEndpoint

Method Detail

setAddress

getAddress

withAddress

getAttributes

setAttributes

withAttributes

addAttributesEntry

clearAttributesEntries

setChannelType

getChannelType

withChannelType

withChannelType

setDemographic

getDemographic

withDemographic

setEffectiveDate

getEffectiveDate

withEffectiveDate

setEndpointStatus

getEndpointStatus

withEndpointStatus

setLocation

getLocation

withLocation

getMetrics

setMetrics

withMetrics

addMetricsEntry

clearMetricsEntries

setOptOut

getOptOut

withOptOut

setRequestId

getRequestId

withRequestId

setUser

getUser

withUser

toString

equals

hashCode

clone

marshall