PublicEndpoint (AWS SDK for Java

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

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

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

Public endpoint attributes.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface PublicEndpoint.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`address()` The unique identifier for the recipient.
`Map<String,List<String>>`	`attributes()` Custom attributes that your app reports to Amazon Pinpoint.
`static PublicEndpoint.Builder`	`builder()`
`ChannelType`	`channelType()` The channel type.
`String`	`channelTypeAsString()` The channel type.
`EndpointDemographic`	`demographic()` The endpoint demographic attributes.
`String`	`effectiveDate()` The date and time when the endpoint was last updated, in ISO 8601 format.
`String`	`endpointStatus()` The status of the endpoint.
`boolean`	`equals(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`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()` A unique identifier that is generated each time the endpoint is updated.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends PublicEndpoint.Builder>`	`serializableBuilderClass()`
`PublicEndpoint.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 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.
  - attributes
```
public 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.
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create a segment.
  - channelType
```
public ChannelType channelType()
```
    The channel type. Valid values: APNS, GCM
    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: APNS, GCM
    
    See Also:
    
    ChannelType
  - channelTypeAsString
```
public String channelTypeAsString()
```
    The channel type. Valid values: APNS, GCM
    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: APNS, GCM
    
    See Also:
    
    ChannelType
  - demographic
```
public EndpointDemographic demographic()
```
    The endpoint demographic attributes.
    
    Returns:
    
    The endpoint demographic attributes.
  - effectiveDate
```
public String effectiveDate()
```
    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.
  - endpointStatus
```
public 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.
    
    Returns:
    
    The status of the endpoint. If the update fails, the value is INACTIVE. If the endpoint is updated successfully, the value is ACTIVE.
  - 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()
```
    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.
  - 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 PublicEndpoint.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<PublicEndpoint.Builder,PublicEndpoint>
    
    Returns:
    
    a builder for type T
  - builder
```
public static PublicEndpoint.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends PublicEndpoint.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 PublicEndpoint

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

location

metrics

optOut

requestId

user

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields