EndpointRequest (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class EndpointRequest
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Specifies the channel type and other settings for an endpoint.

See Also:

AWS API Documentation, 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)` Add a single Attributes entry
`EndpointRequest`	`addMetricsEntry(String key, Double value)` Add a single Metrics entry
`EndpointRequest`	`clearAttributesEntries()` Removes all the entries added into Attributes.
`EndpointRequest`	`clearMetricsEntries()` Removes all the entries added into Metrics.
`EndpointRequest`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAddress()` The destination address for messages or push notifications that you send to the endpoint.
`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 to use 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 is 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()` The unique identifier for the most recent request to update the endpoint.
`EndpointUser`	`getUser()` One or more custom attributes that describe 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 destination address for messages or push notifications that you send to the endpoint.
`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(ChannelType channelType)` The channel to use when sending messages or push notifications to the endpoint.
`void`	`setChannelType(String channelType)` The channel to use 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 is 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)` The unique identifier for the most recent request to update the endpoint.
`void`	`setUser(EndpointUser user)` One or more custom attributes that describe the user who's associated with the endpoint.
`String`	`toString()` Returns a string representation of this object.
`EndpointRequest`	`withAddress(String address)` The destination address for messages or push notifications that you send to the endpoint.
`EndpointRequest`	`withAttributes(Map<String,List<String>> attributes)` One or more custom attributes that describe the endpoint by associating a name with an array of values.
`EndpointRequest`	`withChannelType(ChannelType channelType)` The channel to use when sending messages or push notifications to the endpoint.
`EndpointRequest`	`withChannelType(String channelType)` The channel to use when sending messages or push notifications to the endpoint.
`EndpointRequest`	`withDemographic(EndpointDemographic demographic)` The demographic information for the endpoint, such as the time zone and platform.
`EndpointRequest`	`withEffectiveDate(String effectiveDate)` The date and time, in ISO 8601 format, when the endpoint is updated.
`EndpointRequest`	`withEndpointStatus(String endpointStatus)` Specifies whether to send messages or push notifications to the endpoint.
`EndpointRequest`	`withLocation(EndpointLocation location)` The geographic information for the endpoint.
`EndpointRequest`	`withMetrics(Map<String,Double> metrics)` One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.
`EndpointRequest`	`withOptOut(String optOut)` Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you.
`EndpointRequest`	`withRequestId(String requestId)` The unique identifier for the most recent request to update the endpoint.
`EndpointRequest`	`withUser(EndpointUser user)` One or more custom attributes that describe the user who's associated with the endpoint.

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

- Constructor Detail
  - EndpointRequest
```
public EndpointRequest()
```
- Method Detail
  - setAddress
```
public void setAddress(String address)
```
    The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For a push-notification channel, use the token provided by the push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. For the SMS channel, use a phone number in E.164 format, such as +12065550100. For the email channel, use an email address.
    
    Parameters:
    
    address - The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For a push-notification channel, use the token provided by the push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. For the SMS channel, use a phone number in E.164 format, such as +12065550100. For the email channel, use an email address.
  - getAddress
```
public String getAddress()
```
    The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For a push-notification channel, use the token provided by the push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. For the SMS channel, use a phone number in E.164 format, such as +12065550100. For the email channel, use an email address.
    
    Returns:
    
    The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For a push-notification channel, use the token provided by the push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. For the SMS channel, use a phone number in E.164 format, such as +12065550100. For the email channel, use an email address.
  - withAddress
```
public EndpointRequest withAddress(String address)
```
    The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For a push-notification channel, use the token provided by the push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. For the SMS channel, use a phone number in E.164 format, such as +12065550100. For the email channel, use an email address.
    
    Parameters:
    
    address - The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For a push-notification channel, use the token provided by the push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. For the SMS channel, use a phone number in E.164 format, such as +12065550100. For the email channel, use an email address.
    
    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. For example, the value of a custom attribute named Interests might be: ["Science", "Music", "Travel"]. You can use these attributes as filter criteria when you create segments. Attribute names are case sensitive.
    
    An attribute name can contain up to 50 characters. An attribute value can contain up to 100 characters. When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (\), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This restriction doesn't apply to attribute values.
    
    Returns:
    
    One or more custom attributes that describe the endpoint by associating a name with an array of values. For example, the value of a custom attribute named Interests might be: ["Science", "Music", "Travel"]. You can use these attributes as filter criteria when you create segments. Attribute names are case sensitive.
    
    An attribute name can contain up to 50 characters. An attribute value can contain up to 100 characters. When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (\), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This restriction doesn't apply to attribute values.
  - 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. For example, the value of a custom attribute named Interests might be: ["Science", "Music", "Travel"]. You can use these attributes as filter criteria when you create segments. Attribute names are case sensitive.
    
    An attribute name can contain up to 50 characters. An attribute value can contain up to 100 characters. When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (\), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This restriction doesn't apply to attribute values.
    
    Parameters:
    
    attributes - One or more custom attributes that describe the endpoint by associating a name with an array of values. For example, the value of a custom attribute named Interests might be: ["Science", "Music", "Travel"]. You can use these attributes as filter criteria when you create segments. Attribute names are case sensitive.
    
    An attribute name can contain up to 50 characters. An attribute value can contain up to 100 characters. When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (\), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This restriction doesn't apply to attribute values.
  - withAttributes
```
public EndpointRequest withAttributes(Map<String,List<String>> attributes)
```
    One or more custom attributes that describe the endpoint by associating a name with an array of values. For example, the value of a custom attribute named Interests might be: ["Science", "Music", "Travel"]. You can use these attributes as filter criteria when you create segments. Attribute names are case sensitive.
    
    An attribute name can contain up to 50 characters. An attribute value can contain up to 100 characters. When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (\), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This restriction doesn't apply to attribute values.
    
    Parameters:
    
    attributes - One or more custom attributes that describe the endpoint by associating a name with an array of values. For example, the value of a custom attribute named Interests might be: ["Science", "Music", "Travel"]. You can use these attributes as filter criteria when you create segments. Attribute names are case sensitive.
    
    An attribute name can contain up to 50 characters. An attribute value can contain up to 100 characters. When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (\), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This restriction doesn't apply to attribute values.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addAttributesEntry
```
public EndpointRequest 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 EndpointRequest 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 to use when sending messages or push notifications to the endpoint.
    
    Parameters:
    
    channelType - The channel to use when sending messages or push notifications to the endpoint.
    
    See Also:
    
    ChannelType
  - getChannelType
```
public String getChannelType()
```
    The channel to use when sending messages or push notifications to the endpoint.
    
    Returns:
    
    The channel to use when sending messages or push notifications to the endpoint.
    
    See Also:
    
    ChannelType
  - withChannelType
```
public EndpointRequest withChannelType(String channelType)
```
    The channel to use when sending messages or push notifications to the endpoint.
    
    Parameters:
    
    channelType - The channel to use 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
  - setChannelType
```
public void setChannelType(ChannelType channelType)
```
    The channel to use when sending messages or push notifications to the endpoint.
    
    Parameters:
    
    channelType - The channel to use when sending messages or push notifications to the endpoint.
    
    See Also:
    
    ChannelType
  - withChannelType
```
public EndpointRequest withChannelType(ChannelType channelType)
```
    The channel to use when sending messages or push notifications to the endpoint.
    
    Parameters:
    
    channelType - The channel to use 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 EndpointRequest 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 is updated.
    
    Parameters:
    
    effectiveDate - The date and time, in ISO 8601 format, when the endpoint is updated.
  - getEffectiveDate
```
public String getEffectiveDate()
```
    The date and time, in ISO 8601 format, when the endpoint is updated.
    
    Returns:
    
    The date and time, in ISO 8601 format, when the endpoint is updated.
  - withEffectiveDate
```
public EndpointRequest withEffectiveDate(String effectiveDate)
```
    The date and time, in ISO 8601 format, when the endpoint is updated.
    
    Parameters:
    
    effectiveDate - The date and time, in ISO 8601 format, when the endpoint is 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 EndpointRequest 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 EndpointRequest 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 EndpointRequest 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 EndpointRequest addMetricsEntry(String key,
                                       Double value)
```
    Add a single Metrics entry
    
    See Also:
    
    withMetrics(java.util.Map<java.lang.String, java.lang.Double>)
  - clearMetricsEntries
```
public EndpointRequest 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 EndpointRequest 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)
```
    The unique identifier for the most recent request to update the endpoint.
    
    Parameters:
    
    requestId - The unique identifier for the most recent request to update the endpoint.
  - getRequestId
```
public String getRequestId()
```
    The unique identifier for the most recent request to update the endpoint.
    
    Returns:
    
    The unique identifier for the most recent request to update the endpoint.
  - withRequestId
```
public EndpointRequest withRequestId(String requestId)
```
    The unique identifier for the most recent request to update the endpoint.
    
    Parameters:
    
    requestId - The unique identifier for the most recent request to update the endpoint.
    
    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 attributes that describe the user who's associated with the endpoint.
    
    Parameters:
    
    user - One or more custom attributes that describe the user who's associated with the endpoint.
  - getUser
```
public EndpointUser getUser()
```
    One or more custom attributes that describe the user who's associated with the endpoint.
    
    Returns:
    
    One or more custom attributes that describe the user who's associated with the endpoint.
  - withUser
```
public EndpointRequest withUser(EndpointUser user)
```
    One or more custom attributes that describe the user who's associated with the endpoint.
    
    Parameters:
    
    user - One or more custom attributes that describe 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 EndpointRequest 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.779

Class EndpointRequest

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EndpointRequest

Method Detail

setAddress

getAddress

withAddress

getAttributes

setAttributes

withAttributes

addAttributesEntry

clearAttributesEntries

setChannelType

getChannelType

withChannelType

setChannelType

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