Package 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("software.amazon.awssdk:codegen") public final class CreatePlatformEndpointRequest extends SnsRequest implements ToCopyableBuilder<CreatePlatformEndpointRequest.Builder,CreatePlatformEndpointRequest>

Input for CreatePlatformEndpoint action.

  • Method Details

    • 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()
      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,String> attributes()

      For a list of attributes, see SetEndpointAttributes .

      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:
      For a list of attributes, see SetEndpointAttributes .

    • toBuilder

      public CreatePlatformEndpointRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreatePlatformEndpointRequest.Builder,CreatePlatformEndpointRequest>
      Specified by:
      toBuilder in class SnsRequest

    • 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)
      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)
      Overrides:
      getValueForField in class SdkRequest

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo