software.amazon.awssdk.services.pinpoint.model

Class EndpointRequest

java.lang.Object

software.amazon.awssdk.services.pinpoint.model.EndpointRequest

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<EndpointRequest.Builder,EndpointRequest>

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

Specifies the channel type and other settings for an endpoint.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	EndpointRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	address() The destination address for messages or push notifications that you send to the endpoint.
Map<String,List<String>>	attributes() One or more custom attributes that describe the endpoint by associating a name with an array of values.
static EndpointRequest.Builder	builder()
ChannelType	channelType() The channel to use when sending messages or push notifications to the endpoint.
String	channelTypeAsString() The channel to use 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 is 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)
boolean	hasAttributes() Returns true if the Attributes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
boolean	hasMetrics() Returns true if the Metrics property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
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() The unique identifier for the most recent request to update the endpoint.
List<SdkField<?>>	sdkFields()
static Class<? extends EndpointRequest.Builder>	serializableBuilderClass()
EndpointRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
EndpointUser	user() One or more custom attributes that describe 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 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.

hasAttributes

public boolean hasAttributes()

Returns true if the Attributes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

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. 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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasAttributes() to see if a value was sent in this field.

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.

channelType

public ChannelType channelType()

The channel to use 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 to use when sending messages or push notifications to the endpoint.

See Also:

ChannelType

channelTypeAsString

public String channelTypeAsString()

The channel to use 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 to use 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 is updated.

Returns:

The date and time, in ISO 8601 format, when the endpoint is 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.

hasMetrics

public boolean hasMetrics()

Returns true if the Metrics property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

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.

You can use hasMetrics() to see if a value was sent in this field.

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()

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.

user

public EndpointUser user()

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.

toBuilder

public EndpointRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<EndpointRequest.Builder,EndpointRequest>

builder

public static EndpointRequest.Builder builder()

serializableBuilderClass

public static Class<? extends EndpointRequest.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