EndpointBatchItem (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.pinpoint.model.EndpointBatchItem

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<EndpointBatchItem.Builder,EndpointBatchItem>

@Generated(value="software.amazon.awssdk:codegen")
public final class EndpointBatchItem
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<EndpointBatchItem.Builder,EndpointBatchItem>

Endpoint update request

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface EndpointBatchItem.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`EndpointBatchItem.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`address()` The destination for messages that you send to this endpoint.
`Map<String,List<String>>`	`attributes()` Custom attributes that describe the endpoint by associating a name with an array of values.
`static EndpointBatchItem.Builder`	`builder()`
`ChannelType`	`channelType()` The channel type.
`String`	`channelTypeAsString()` The channel type.
`EndpointDemographic`	`demographic()` The endpoint demographic attributes.
`String`	`effectiveDate()` The last time the endpoint was updated.
`String`	`endpointStatus()` Unused.
`boolean`	`equals(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`id()` The unique Id for the Endpoint in the batch.
`EndpointLocation`	`location()` The endpoint location attributes.
`Map<String,Double>`	`metrics()` Custom metrics that your app reports to Amazon Pinpoint.
`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.
`String`	`requestId()` The unique ID for the most recent request to update the endpoint.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends EndpointBatchItem.Builder>`	`serializableBuilderClass()`
`EndpointBatchItem.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`
`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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - address
```
public 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.
    
    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.
  - attributes
```
public 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.
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    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.
  - channelType
```
public ChannelType channelType()
```
    The channel type. Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU
    If the service returns an enum value that is not available in the current SDK version, channelType will return ChannelType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from channelTypeAsString().
    
    Returns:
    
    The channel type. Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU
    
    See Also:
    
    ChannelType
  - channelTypeAsString
```
public String channelTypeAsString()
```
    The channel type. Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU
    If the service returns an enum value that is not available in the current SDK version, channelType will return ChannelType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from channelTypeAsString().
    
    Returns:
    
    The channel type. Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU
    
    See Also:
    
    ChannelType
  - demographic
```
public EndpointDemographic demographic()
```
    The endpoint demographic attributes.
    
    Returns:
    
    The endpoint demographic attributes.
  - effectiveDate
```
public String effectiveDate()
```
    The last time the endpoint was updated. Provided in ISO 8601 format.
    
    Returns:
    
    The last time the endpoint was updated. Provided in ISO 8601 format.
  - endpointStatus
```
public String endpointStatus()
```
    Unused.
    
    Returns:
    
    Unused.
  - id
```
public String id()
```
    The unique Id for the Endpoint in the batch.
    
    Returns:
    
    The unique Id for the Endpoint in the batch.
  - location
```
public EndpointLocation location()
```
    The endpoint location attributes.
    
    Returns:
    
    The endpoint location attributes.
  - metrics
```
public Map<String,Double> metrics()
```
    Custom metrics that your app reports to Amazon Pinpoint.
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    Custom metrics that your app reports to Amazon Pinpoint.
  - optOut
```
public String optOut()
```
    Indicates whether a user has opted out of receiving messages with one of the following values: ALL - User has opted out of all messages. NONE - Users has not opted out and receives all messages.
    
    Returns:
    
    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.
  - requestId
```
public String requestId()
```
    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.
  - user
```
public EndpointUser user()
```
    Custom user-specific attributes that your app reports to Amazon Pinpoint.
    
    Returns:
    
    Custom user-specific attributes that your app reports to Amazon Pinpoint.
  - toBuilder
```
public EndpointBatchItem.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<EndpointBatchItem.Builder,EndpointBatchItem>
    
    Returns:
    
    a builder for type T
  - builder
```
public static EndpointBatchItem.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends EndpointBatchItem.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

Class EndpointBatchItem

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

address

attributes

channelType

channelTypeAsString

demographic

effectiveDate

endpointStatus

id

location

metrics

optOut

requestId

user

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields