software.amazon.awssdk.services.pinpoint.model

Class EndpointResponse

java.lang.Object

software.amazon.awssdk.services.pinpoint.model.EndpointResponse

All Implemented Interfaces:

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

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

Provides information about 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	EndpointResponse.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.
String	applicationId() The unique identifier for the application that's associated with 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 EndpointResponse.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.
String	cohortId() A number from 0-99 that represents the cohort that the endpoint is assigned to.
String	creationDate() The date and time, in ISO 8601 format, when the endpoint was created.
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 messages or push notifications are sent to the endpoint.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAttributes() For responses, this returns true if the service returned a value for the Attributes property.
int	hashCode()
boolean	hasMetrics() For responses, this returns true if the service returned a value for the Metrics property.
String	id() The unique identifier that you assigned to the endpoint.
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 EndpointResponse.Builder>	serializableBuilderClass()
EndpointResponse.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 final String address()

The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For example, the address for a push-notification channel is typically the token provided by a push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. The address for the SMS channel is a phone number in E.164 format, such as +12065550100. The address for the email channel is an email address.

Returns:

The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For example, the address for a push-notification channel is typically the token provided by a push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. The address for the SMS channel is a phone number in E.164 format, such as +12065550100. The address for the email channel is an email address.

applicationId

public final String applicationId()

The unique identifier for the application that's associated with the endpoint.

Returns:

The unique identifier for the application that's associated with the endpoint.

hasAttributes

public final boolean hasAttributes()

For responses, this returns true if the service returned a value for the Attributes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

attributes

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

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAttributes() method.

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.

channelType

public final 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 final 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

cohortId

public final String cohortId()

A number from 0-99 that represents the cohort that the endpoint is assigned to. Endpoints are grouped into cohorts randomly, and each cohort contains approximately 1 percent of the endpoints for an application. Amazon Pinpoint assigns cohorts to the holdout or treatment allocations for campaigns.

Returns:

A number from 0-99 that represents the cohort that the endpoint is assigned to. Endpoints are grouped into cohorts randomly, and each cohort contains approximately 1 percent of the endpoints for an application. Amazon Pinpoint assigns cohorts to the holdout or treatment allocations for campaigns.

creationDate

public final String creationDate()

The date and time, in ISO 8601 format, when the endpoint was created.

Returns:

The date and time, in ISO 8601 format, when the endpoint was created.

demographic

public final 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 final 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 final String endpointStatus()

Specifies whether messages or push notifications are sent to the endpoint. Possible 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 messages or push notifications are sent to the endpoint. Possible 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.

id

public final String id()

The unique identifier that you assigned to the endpoint. The identifier should be a globally unique identifier (GUID) to ensure that it doesn't conflict with other endpoint identifiers that are associated with the application.

Returns:

The unique identifier that you assigned to the endpoint. The identifier should be a globally unique identifier (GUID) to ensure that it doesn't conflict with other endpoint identifiers that are associated with the application.

location

public final EndpointLocation location()

The geographic information for the endpoint.

Returns:

The geographic information for the endpoint.

hasMetrics

public final boolean hasMetrics()

For responses, this returns true if the service returned a value for the Metrics property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

metrics

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasMetrics() method.

Returns:

One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.

optOut

public final 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 final 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 final 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 EndpointResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<EndpointResponse.Builder,EndpointResponse>

builder

public static EndpointResponse.Builder builder()

serializableBuilderClass

public static Class<? extends EndpointResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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 final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo