PublicEndpoint (AWS Java SDK :: Services :: Amazon Pinpoint 2.9.26 API)

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

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, such as a device token, email address, or mobile phone number.
`Map<String,List<String>>`	`attributes()` One or more custom attributes that describe the endpoint by associating a name with an array of values.
`static PublicEndpoint.Builder`	`builder()`
`ChannelType`	`channelType()` The channel that's used when sending messages or push notifications to the endpoint.
`String`	`channelTypeAsString()` The channel that's used when sending messages or push notifications to the endpoint.
`EndpointDemographic`	`demographic()` The demographic information for the endpoint, such as the time zone and platform.
`String`	`effectiveDate()` The date and time, in ISO 8601 format, when the endpoint was last updated.
`String`	`endpointStatus()` Specifies whether to send messages or push notifications to the endpoint.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`EndpointLocation`	`location()` The geographic information for the endpoint.
`Map<String,Double>`	`metrics()` One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.
`String`	`optOut()` Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you.
`String`	`requestId()` A unique identifier that's generated each time the endpoint is updated.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends PublicEndpoint.Builder>`	`serializableBuilderClass()`
`PublicEndpoint.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`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
clone, finalize, 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, 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.
  - attributes
```
public 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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    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.
  - channelType
```
public ChannelType channelType()
```
    The channel that's used when sending messages or push notifications to the endpoint.
    
    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 that's used when sending messages or push notifications to the endpoint.
    
    See Also:
    
    ChannelType
  - channelTypeAsString
```
public String channelTypeAsString()
```
    The channel that's used when sending messages or push notifications to the endpoint.
    
    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 that's used when sending messages or push notifications to the endpoint.
    
    See Also:
    
    ChannelType
  - demographic
```
public EndpointDemographic demographic()
```
    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.
  - effectiveDate
```
public String effectiveDate()
```
    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.
  - endpointStatus
```
public 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.
    
    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.
  - location
```
public EndpointLocation location()
```
    The geographic information for the endpoint.
    
    Returns:
    
    The geographic information for the endpoint.
  - metrics
```
public Map<String,Double> metrics()
```
    One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.
  - optOut
```
public 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.
    
    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.
  - requestId
```
public String requestId()
```
    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.
  - user
```
public EndpointUser user()
```
    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.
  - toBuilder
```
public PublicEndpoint.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<PublicEndpoint.Builder,PublicEndpoint>
  - 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
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

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

equalsBySdkFields

toString

getValueForField

sdkFields