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

An endpoint update request.

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)`
`EndpointRequest`	`addMetricsEntry(String key, Double value)`
`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 for messages that you send to this endpoint.
`Map<String,List<String>>`	`getAttributes()` Custom attributes that describe the endpoint by associating a name with an array of values.
`String`	`getChannelType()` The channel type.
`EndpointDemographic`	`getDemographic()` Demographic attributes for the endpoint.
`String`	`getEffectiveDate()` The date and time when the endpoint was updated, shown in ISO 8601 format.
`String`	`getEndpointStatus()` Unused.
`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()` The unique ID for the most recent request to update the endpoint.
`EndpointUser`	`getUser()` Custom user-specific attributes that your app reports to Amazon Pinpoint.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAddress(String address)` The destination for messages that you send to this endpoint.
`void`	`setAttributes(Map<String,List<String>> attributes)` Custom attributes that describe the endpoint by associating a name with an array of values.
`void`	`setChannelType(ChannelType channelType)` The channel type.
`void`	`setChannelType(String channelType)` The channel type.
`void`	`setDemographic(EndpointDemographic demographic)` Demographic attributes for the endpoint.
`void`	`setEffectiveDate(String effectiveDate)` The date and time when the endpoint was updated, shown in ISO 8601 format.
`void`	`setEndpointStatus(String endpointStatus)` Unused.
`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)` The unique ID for the most recent request to update the endpoint.
`void`	`setUser(EndpointUser user)` Custom user-specific attributes that your app reports to Amazon Pinpoint.
`String`	`toString()` Returns a string representation of this object.
`EndpointRequest`	`withAddress(String address)` The destination for messages that you send to this endpoint.
`EndpointRequest`	`withAttributes(Map<String,List<String>> attributes)` Custom attributes that describe the endpoint by associating a name with an array of values.
`EndpointRequest`	`withChannelType(ChannelType channelType)` The channel type.
`EndpointRequest`	`withChannelType(String channelType)` The channel type.
`EndpointRequest`	`withDemographic(EndpointDemographic demographic)` Demographic attributes for the endpoint.
`EndpointRequest`	`withEffectiveDate(String effectiveDate)` The date and time when the endpoint was updated, shown in ISO 8601 format.
`EndpointRequest`	`withEndpointStatus(String endpointStatus)` Unused.
`EndpointRequest`	`withLocation(EndpointLocation location)` The endpoint location attributes.
`EndpointRequest`	`withMetrics(Map<String,Double> metrics)` Custom metrics that your app reports to Amazon Pinpoint.
`EndpointRequest`	`withOptOut(String optOut)` Indicates whether a user has opted out of receiving messages with one of the following values: ALL - User has opted out of all messages.
`EndpointRequest`	`withRequestId(String requestId)` The unique ID for the most recent request to update the endpoint.
`EndpointRequest`	`withUser(EndpointUser user)` Custom user-specific attributes that your app reports to Amazon Pinpoint.

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

- Constructor Detail
  - EndpointRequest
```
public EndpointRequest()
```
- Method Detail
  - setAddress
```
public void setAddress(String address)
```
    The destination for messages that you send to this endpoint. The address varies by channel. For mobile push channels, use the token provided by the push notification service, such as the APNs device token or the 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 for messages that you send to this endpoint. The address varies by channel. For mobile push channels, use the token provided by the push notification service, such as the APNs device token or the 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 for messages that you send to this endpoint. The address varies by channel. For mobile push channels, use the token provided by the push notification service, such as the APNs device token or the 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 for messages that you send to this endpoint. The address varies by channel. For mobile push channels, use the token provided by the push notification service, such as the APNs device token or the 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 for messages that you send to this endpoint. The address varies by channel. For mobile push channels, use the token provided by the push notification service, such as the APNs device token or the 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 for messages that you send to this endpoint. The address varies by channel. For mobile push channels, use the token provided by the push notification service, such as the APNs device token or the 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()
```
    Custom attributes that describe the endpoint by associating a name with an array of values. For example, an attribute named "interests" might have the values ["science", "politics", "travel"]. You can use these attributes as selection criteria when you create a segment of users to engage with a messaging campaign. The following characters are not recommended in attribute names: # : ? \ /. The Amazon Pinpoint console does not display attributes that include these characters in the name. This limitation does not apply to attribute values.
    
    Returns:
    
    Custom attributes that describe the endpoint by associating a name with an array of values. For example, an attribute named "interests" might have the values ["science", "politics", "travel"]. You can use these attributes as selection criteria when you create a segment of users to engage with a messaging campaign. The following characters are not recommended in attribute names: # : ? \ /. The Amazon Pinpoint console does not display attributes that include these characters in the name. This limitation does not apply to attribute values.
  - setAttributes
```
public void setAttributes(Map<String,List<String>> attributes)
```
    Custom attributes that describe the endpoint by associating a name with an array of values. For example, an attribute named "interests" might have the values ["science", "politics", "travel"]. You can use these attributes as selection criteria when you create a segment of users to engage with a messaging campaign. The following characters are not recommended in attribute names: # : ? \ /. The Amazon Pinpoint console does not display attributes that include these characters in the name. This limitation does not apply to attribute values.
    
    Parameters:
    
    attributes - Custom attributes that describe the endpoint by associating a name with an array of values. For example, an attribute named "interests" might have the values ["science", "politics", "travel"]. You can use these attributes as selection criteria when you create a segment of users to engage with a messaging campaign. The following characters are not recommended in attribute names: # : ? \ /. The Amazon Pinpoint console does not display attributes that include these characters in the name. This limitation does not apply to attribute values.
  - withAttributes
```
public EndpointRequest withAttributes(Map<String,List<String>> attributes)
```
    Custom attributes that describe the endpoint by associating a name with an array of values. For example, an attribute named "interests" might have the values ["science", "politics", "travel"]. You can use these attributes as selection criteria when you create a segment of users to engage with a messaging campaign. The following characters are not recommended in attribute names: # : ? \ /. The Amazon Pinpoint console does not display attributes that include these characters in the name. This limitation does not apply to attribute values.
    
    Parameters:
    
    attributes - Custom attributes that describe the endpoint by associating a name with an array of values. For example, an attribute named "interests" might have the values ["science", "politics", "travel"]. You can use these attributes as selection criteria when you create a segment of users to engage with a messaging campaign. The following characters are not recommended in attribute names: # : ? \ /. The Amazon Pinpoint console does not display attributes that include these characters in the name. This limitation does not 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)
```
  - 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 type. Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU
    
    Parameters:
    
    channelType - The channel type. Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU
    
    See Also:
    
    ChannelType
  - getChannelType
```
public String getChannelType()
```
    The channel type. Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU
    
    Returns:
    
    The channel type. Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU
    
    See Also:
    
    ChannelType
  - withChannelType
```
public EndpointRequest withChannelType(String channelType)
```
    The channel type. Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU
    
    Parameters:
    
    channelType - The channel type. Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU
    
    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 type. Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU
    
    Parameters:
    
    channelType - The channel type. Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU
    
    See Also:
    
    ChannelType
  - withChannelType
```
public EndpointRequest withChannelType(ChannelType channelType)
```
    The channel type. Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU
    
    Parameters:
    
    channelType - The channel type. Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ChannelType
  - setDemographic
```
public void setDemographic(EndpointDemographic demographic)
```
    Demographic attributes for the endpoint.
    
    Parameters:
    
    demographic - Demographic attributes for the endpoint.
  - getDemographic
```
public EndpointDemographic getDemographic()
```
    Demographic attributes for the endpoint.
    
    Returns:
    
    Demographic attributes for the endpoint.
  - withDemographic
```
public EndpointRequest withDemographic(EndpointDemographic demographic)
```
    Demographic attributes for the endpoint.
    
    Parameters:
    
    demographic - Demographic attributes for the endpoint.
    
    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 updated, shown in ISO 8601 format.
    
    Parameters:
    
    effectiveDate - The date and time when the endpoint was updated, shown in ISO 8601 format.
  - getEffectiveDate
```
public String getEffectiveDate()
```
    The date and time when the endpoint was updated, shown in ISO 8601 format.
    
    Returns:
    
    The date and time when the endpoint was updated, shown in ISO 8601 format.
  - withEffectiveDate
```
public EndpointRequest withEffectiveDate(String effectiveDate)
```
    The date and time when the endpoint was updated, shown in ISO 8601 format.
    
    Parameters:
    
    effectiveDate - The date and time when the endpoint was updated, shown 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)
```
    Unused.
    
    Parameters:
    
    endpointStatus - Unused.
  - getEndpointStatus
```
public String getEndpointStatus()
```
    Unused.
    
    Returns:
    
    Unused.
  - withEndpointStatus
```
public EndpointRequest withEndpointStatus(String endpointStatus)
```
    Unused.
    
    Parameters:
    
    endpointStatus - Unused.
    
    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 EndpointRequest 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 EndpointRequest 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 EndpointRequest addMetricsEntry(String key,
                                       Double value)
```
  - 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)
```
    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 EndpointRequest 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)
```
    The unique ID for the most recent request to update the endpoint.
    
    Parameters:
    
    requestId - The unique ID for the most recent request to update the endpoint.
  - getRequestId
```
public String getRequestId()
```
    The unique ID for the most recent request to update the endpoint.
    
    Returns:
    
    The unique ID for the most recent request to update the endpoint.
  - withRequestId
```
public EndpointRequest withRequestId(String requestId)
```
    The unique ID for the most recent request to update the endpoint.
    
    Parameters:
    
    requestId - The unique ID for the most recent request to update the endpoint.
    
    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 EndpointRequest 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 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.

Did this page help you?

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