software.amazon.awssdk.services.sns.model

Class CreatePlatformEndpointRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.sns.model.SnsRequest

software.amazon.awssdk.services.sns.model.CreatePlatformEndpointRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreatePlatformEndpointRequest.Builder,CreatePlatformEndpointRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreatePlatformEndpointRequest
extends SnsRequest
implements ToCopyableBuilder<CreatePlatformEndpointRequest.Builder,CreatePlatformEndpointRequest>

Input for CreatePlatformEndpoint action.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreatePlatformEndpointRequest.Builder

Method Summary

Modifier and Type	Method and Description
Map<String,String>	attributes() For a list of attributes, see SetEndpointAttributes.
static CreatePlatformEndpointRequest.Builder	builder()
String	customUserData() Arbitrary user data to associate with the endpoint.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
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()
String	platformApplicationArn() PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint.
List<SdkField<?>>	sdkFields()
static Class<? extends CreatePlatformEndpointRequest.Builder>	serializableBuilderClass()
CreatePlatformEndpointRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	token() Unique identifier created by the notification service for an app on a device.
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

platformApplicationArn

public final String platformApplicationArn()

PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint.

Returns:

PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint.

token

public final String token()

Unique identifier created by the notification service for an app on a device. The specific name for Token will vary, depending on which notification service is being used. For example, when using APNS as the notification service, you need the device token. Alternatively, when using GCM (Firebase Cloud Messaging) or ADM, the device token equivalent is called the registration ID.

Returns:

Unique identifier created by the notification service for an app on a device. The specific name for Token will vary, depending on which notification service is being used. For example, when using APNS as the notification service, you need the device token. Alternatively, when using GCM (Firebase Cloud Messaging) or ADM, the device token equivalent is called the registration ID.

customUserData

public final String customUserData()

Arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.

Returns:

Arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.

hasAttributes

public final 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 final Map<String,String> attributes()

For a list of attributes, see SetEndpointAttributes.

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:

For a list of attributes, see SetEndpointAttributes.

toBuilder

public CreatePlatformEndpointRequest.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<CreatePlatformEndpointRequest.Builder,CreatePlatformEndpointRequest>

Specified by:

toBuilder in class SnsRequest

Returns:

a builder for type T

builder

public static CreatePlatformEndpointRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

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