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>

Endpoint response

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 address of the endpoint as provided by your push provider.
String	applicationId() The ID of the application that is associated with the endpoint.
Map<String,List<String>>	attributes() Custom attributes that describe the endpoint by associating a name with an array of values.
static EndpointResponse.Builder	builder()
ChannelType	channelType() The channel type.
String	channelTypeAsString() The channel type.
String	cohortId() A number from 0-99 that represents the cohort the endpoint is assigned to.
String	creationDate() The date and time when the endpoint was created, shown in ISO 8601 format.
EndpointDemographic	demographic() The endpoint demographic attributes.
String	effectiveDate() The date and time when the endpoint was last updated, shown in ISO 8601 format.
String	endpointStatus() Unused.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	id() The unique ID that you assigned to the endpoint.
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 EndpointResponse.Builder>	serializableBuilderClass()
EndpointResponse.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 address of the endpoint as provided by your push provider. For example, the DeviceToken or RegistrationId.

Returns:

The address of the endpoint as provided by your push provider. For example, the DeviceToken or RegistrationId.

applicationId

public String applicationId()

The ID of the application that is associated with the endpoint.

Returns:

The ID of the application that is associated with the endpoint.

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 following values: ["science", "politics", "travel"]. You can use these attributes as selection criteria when you create segments. The Amazon Pinpoint console can't display attribute names that include the following characters: hash/pound sign (#), colon (:), question mark (?), backslash (\), and forward slash (/). For this reason, you should avoid using these characters in the names of custom attributes.

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 following values: ["science", "politics", "travel"]. You can use these attributes as selection criteria when you create segments. The Amazon Pinpoint console can't display attribute names that include the following characters: hash/pound sign (#), colon (:), question mark (?), backslash (\), and forward slash (/). For this reason, you should avoid using these characters in the names of custom attributes.

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

cohortId

public String cohortId()

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

Returns:

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

creationDate

public String creationDate()

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

Returns:

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

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, shown in ISO 8601 format.

Returns:

The date and time when the endpoint was last updated, shown in ISO 8601 format.

endpointStatus

public String endpointStatus()

Unused.

Returns:

Unused.

id

public String id()

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

Returns:

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

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 EndpointResponse.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<EndpointResponse.Builder,EndpointResponse>

Returns:

a builder for type T

builder

public static EndpointResponse.Builder builder()

serializableBuilderClass

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