PublicEndpoint (AWS SDK for Java

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
```
Specifies the properties and attributes of an endpoint that's associated with an event.

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)` Add a single Attributes entry
`PublicEndpoint`	`addMetricsEntry(String key, Double value)` Add a single Metrics entry
`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, such as a device token, email address, or mobile phone number.
`Map<String,List<String>>`	`getAttributes()` One or more custom attributes that describe the endpoint by associating a name with an array of values.
`String`	`getChannelType()` The channel that's used when sending messages or push notifications to the endpoint.
`EndpointDemographic`	`getDemographic()` The demographic information for the endpoint, such as the time zone and platform.
`String`	`getEffectiveDate()` The date and time, in ISO 8601 format, when the endpoint was last updated.
`String`	`getEndpointStatus()` Specifies whether to send messages or push notifications to the endpoint.
`EndpointLocation`	`getLocation()` The geographic information for the endpoint.
`Map<String,Double>`	`getMetrics()` One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.
`String`	`getOptOut()` Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you.
`String`	`getRequestId()` A unique identifier that's generated each time the endpoint is updated.
`EndpointUser`	`getUser()` One or more custom user attributes that your app reports to Amazon Pinpoint for the user who's associated with the endpoint.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAddress(String address)` The unique identifier for the recipient, such as a device token, email address, or mobile phone number.
`void`	`setAttributes(Map<String,List<String>> attributes)` One or more custom attributes that describe the endpoint by associating a name with an array of values.
`void`	`setChannelType(String channelType)` The channel that's used when sending messages or push notifications to the endpoint.
`void`	`setDemographic(EndpointDemographic demographic)` The demographic information for the endpoint, such as the time zone and platform.
`void`	`setEffectiveDate(String effectiveDate)` The date and time, in ISO 8601 format, when the endpoint was last updated.
`void`	`setEndpointStatus(String endpointStatus)` Specifies whether to send messages or push notifications to the endpoint.
`void`	`setLocation(EndpointLocation location)` The geographic information for the endpoint.
`void`	`setMetrics(Map<String,Double> metrics)` One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.
`void`	`setOptOut(String optOut)` Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you.
`void`	`setRequestId(String requestId)` A unique identifier that's generated each time the endpoint is updated.
`void`	`setUser(EndpointUser user)` One or more custom user attributes that your app reports to Amazon Pinpoint for the user who's associated with the endpoint.
`String`	`toString()` Returns a string representation of this object.
`PublicEndpoint`	`withAddress(String address)` The unique identifier for the recipient, such as a device token, email address, or mobile phone number.
`PublicEndpoint`	`withAttributes(Map<String,List<String>> attributes)` One or more custom attributes that describe the endpoint by associating a name with an array of values.
`PublicEndpoint`	`withChannelType(ChannelType channelType)` The channel that's used when sending messages or push notifications to the endpoint.
`PublicEndpoint`	`withChannelType(String channelType)` The channel that's used when sending messages or push notifications to the endpoint.
`PublicEndpoint`	`withDemographic(EndpointDemographic demographic)` The demographic information for the endpoint, such as the time zone and platform.
`PublicEndpoint`	`withEffectiveDate(String effectiveDate)` The date and time, in ISO 8601 format, when the endpoint was last updated.
`PublicEndpoint`	`withEndpointStatus(String endpointStatus)` Specifies whether to send messages or push notifications to the endpoint.
`PublicEndpoint`	`withLocation(EndpointLocation location)` The geographic information for the endpoint.
`PublicEndpoint`	`withMetrics(Map<String,Double> metrics)` One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.
`PublicEndpoint`	`withOptOut(String optOut)` Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you.
`PublicEndpoint`	`withRequestId(String requestId)` A unique identifier that's generated each time the endpoint is updated.
`PublicEndpoint`	`withUser(EndpointUser user)` One or more custom user attributes that your app reports to Amazon Pinpoint for the user who's associated with the endpoint.

Methods inherited from class java.lang.Object
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, such as a device token, email address, or mobile phone number.
    
    Parameters:
    
    address - The unique identifier for the recipient, such as a device token, email address, or mobile phone number.
  - getAddress
```
public String getAddress()
```
    The unique identifier for the recipient, such as a device token, email address, or mobile phone number.
    
    Returns:
    
    The unique identifier for the recipient, such as a device token, email address, or mobile phone number.
  - withAddress
```
public PublicEndpoint withAddress(String address)
```
    The unique identifier for the recipient, such as a device token, email address, or mobile phone number.
    
    Parameters:
    
    address - The unique identifier for the recipient, such as 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()
```
    One or more custom attributes that describe the endpoint by associating a name with an array of values. You can use these attributes as filter criteria when you create segments.
    
    Returns:
    
    One or more custom attributes that describe the endpoint by associating a name with an array of values. You can use these attributes as filter criteria when you create segments.
  - setAttributes
```
public void setAttributes(Map<String,List<String>> attributes)
```
    One or more custom attributes that describe the endpoint by associating a name with an array of values. You can use these attributes as filter criteria when you create segments.
    
    Parameters:
    
    attributes - One or more custom attributes that describe the endpoint by associating a name with an array of values. You can use these attributes as filter criteria when you create segments.
  - withAttributes
```
public PublicEndpoint withAttributes(Map<String,List<String>> attributes)
```
    One or more custom attributes that describe the endpoint by associating a name with an array of values. You can use these attributes as filter criteria when you create segments.
    
    Parameters:
    
    attributes - One or more custom attributes that describe the endpoint by associating a name with an array of values. You can use these attributes as filter criteria when you create segments.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addAttributesEntry
```
public PublicEndpoint addAttributesEntry(String key,
                                         List<String> value)
```
    Add a single Attributes entry
    
    See Also:
    
    withAttributes(java.util.Map<java.lang.String, java.util.List<java.lang.String>>)
  - 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 that's used when sending messages or push notifications to the endpoint.
    
    Parameters:
    
    channelType - The channel that's used when sending messages or push notifications to the endpoint.
    
    See Also:
    
    ChannelType
  - getChannelType
```
public String getChannelType()
```
    The channel that's used when sending messages or push notifications to the endpoint.
    
    Returns:
    
    The channel that's used when sending messages or push notifications to the endpoint.
    
    See Also:
    
    ChannelType
  - withChannelType
```
public PublicEndpoint withChannelType(String channelType)
```
    The channel that's used when sending messages or push notifications to the endpoint.
    
    Parameters:
    
    channelType - The channel that's used when sending messages or push notifications to the endpoint.
    
    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 that's used when sending messages or push notifications to the endpoint.
    
    Parameters:
    
    channelType - The channel that's used when sending messages or push notifications to the endpoint.
    
    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 demographic information for the endpoint, such as the time zone and platform.
    
    Parameters:
    
    demographic - The demographic information for the endpoint, such as the time zone and platform.
  - getDemographic
```
public EndpointDemographic getDemographic()
```
    The demographic information for the endpoint, such as the time zone and platform.
    
    Returns:
    
    The demographic information for the endpoint, such as the time zone and platform.
  - withDemographic
```
public PublicEndpoint withDemographic(EndpointDemographic demographic)
```
    The demographic information for the endpoint, such as the time zone and platform.
    
    Parameters:
    
    demographic - The demographic information for the endpoint, such as the time zone and platform.
    
    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, in ISO 8601 format, when the endpoint was last updated.
    
    Parameters:
    
    effectiveDate - The date and time, in ISO 8601 format, when the endpoint was last updated.
  - getEffectiveDate
```
public String getEffectiveDate()
```
    The date and time, in ISO 8601 format, when the endpoint was last updated.
    
    Returns:
    
    The date and time, in ISO 8601 format, when the endpoint was last updated.
  - withEffectiveDate
```
public PublicEndpoint withEffectiveDate(String effectiveDate)
```
    The date and time, in ISO 8601 format, when the endpoint was last updated.
    
    Parameters:
    
    effectiveDate - The date and time, in ISO 8601 format, when the endpoint was last updated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEndpointStatus
```
public void setEndpointStatus(String endpointStatus)
```
    Specifies whether to send messages or push notifications to the endpoint. Valid values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint.
    
    Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.
    
    Parameters:
    
    endpointStatus - Specifies whether to send messages or push notifications to the endpoint. Valid values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint.
    
    Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.
  - getEndpointStatus
```
public String getEndpointStatus()
```
    Specifies whether to send messages or push notifications to the endpoint. Valid values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint.
    
    Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.
    
    Returns:
    
    Specifies whether to send messages or push notifications to the endpoint. Valid values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint.
    
    Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.
  - withEndpointStatus
```
public PublicEndpoint withEndpointStatus(String endpointStatus)
```
    Specifies whether to send messages or push notifications to the endpoint. Valid values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint.
    
    Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.
    
    Parameters:
    
    endpointStatus - Specifies whether to send messages or push notifications to the endpoint. Valid values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint.
    
    Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLocation
```
public void setLocation(EndpointLocation location)
```
    The geographic information for the endpoint.
    
    Parameters:
    
    location - The geographic information for the endpoint.
  - getLocation
```
public EndpointLocation getLocation()
```
    The geographic information for the endpoint.
    
    Returns:
    
    The geographic information for the endpoint.
  - withLocation
```
public PublicEndpoint withLocation(EndpointLocation location)
```
    The geographic information for the endpoint.
    
    Parameters:
    
    location - The geographic information for the endpoint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getMetrics
```
public Map<String,Double> getMetrics()
```
    One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.
    
    Returns:
    
    One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.
  - setMetrics
```
public void setMetrics(Map<String,Double> metrics)
```
    One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.
    
    Parameters:
    
    metrics - One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.
  - withMetrics
```
public PublicEndpoint withMetrics(Map<String,Double> metrics)
```
    One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.
    
    Parameters:
    
    metrics - One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addMetricsEntry
```
public PublicEndpoint addMetricsEntry(String key,
                                      Double value)
```
    Add a single Metrics entry
    
    See Also:
    
    withMetrics(java.util.Map<java.lang.String, java.lang.Double>)
  - 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)
```
    Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.
    
    Parameters:
    
    optOut - Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.
  - getOptOut
```
public String getOptOut()
```
    Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.
    
    Returns:
    
    Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.
  - withOptOut
```
public PublicEndpoint withOptOut(String optOut)
```
    Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.
    
    Parameters:
    
    optOut - Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.
    
    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's generated each time the endpoint is updated.
    
    Parameters:
    
    requestId - A unique identifier that's generated each time the endpoint is updated.
  - getRequestId
```
public String getRequestId()
```
    A unique identifier that's generated each time the endpoint is updated.
    
    Returns:
    
    A unique identifier that's generated each time the endpoint is updated.
  - withRequestId
```
public PublicEndpoint withRequestId(String requestId)
```
    A unique identifier that's generated each time the endpoint is updated.
    
    Parameters:
    
    requestId - A unique identifier that's 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)
```
    One or more custom user attributes that your app reports to Amazon Pinpoint for the user who's associated with the endpoint.
    
    Parameters:
    
    user - One or more custom user attributes that your app reports to Amazon Pinpoint for the user who's associated with the endpoint.
  - getUser
```
public EndpointUser getUser()
```
    One or more custom user attributes that your app reports to Amazon Pinpoint for the user who's associated with the endpoint.
    
    Returns:
    
    One or more custom user attributes that your app reports to Amazon Pinpoint for the user who's associated with the endpoint.
  - withUser
```
public PublicEndpoint withUser(EndpointUser user)
```
    One or more custom user attributes that your app reports to Amazon Pinpoint for the user who's associated with the endpoint.
    
    Parameters:
    
    user - One or more custom user attributes that your app reports to Amazon Pinpoint for the user who's associated with the endpoint.
    
    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)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.778

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