Class RegisterAppInstanceUserEndpointRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.chimesdkidentity.model.ChimeSdkIdentityRequest
software.amazon.awssdk.services.chimesdkidentity.model.RegisterAppInstanceUserEndpointRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<RegisterAppInstanceUserEndpointRequest.Builder,RegisterAppInstanceUserEndpointRequest>
@Generated("software.amazon.awssdk:codegen") public final class RegisterAppInstanceUserEndpointRequest extends ChimeSdkIdentityRequest implements ToCopyableBuilder<RegisterAppInstanceUserEndpointRequest.Builder,RegisterAppInstanceUserEndpointRequest>

  • Method Details

    • appInstanceUserArn

      public final String appInstanceUserArn()

      The ARN of the AppInstanceUser.

      Returns:
      The ARN of the AppInstanceUser.

    • name

      public final String name()

      The name of the AppInstanceUserEndpoint.

      Returns:
      The name of the AppInstanceUserEndpoint.

    • type

      public final AppInstanceUserEndpointType type()

      The type of the AppInstanceUserEndpoint. Supported types:

      • APNS: The mobile notification service for an Apple device.

      • APNS_SANDBOX: The sandbox environment of the mobile notification service for an Apple device.

      • GCM: The mobile notification service for an Android device.

      Populate the ResourceArn value of each type as PinpointAppArn.

      If the service returns an enum value that is not available in the current SDK version, type will return AppInstanceUserEndpointType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      The type of the AppInstanceUserEndpoint. Supported types:

      • APNS: The mobile notification service for an Apple device.

      • APNS_SANDBOX: The sandbox environment of the mobile notification service for an Apple device.

      • GCM: The mobile notification service for an Android device.

      Populate the ResourceArn value of each type as PinpointAppArn.

      See Also:

    • typeAsString

      public final String typeAsString()

      The type of the AppInstanceUserEndpoint. Supported types:

      • APNS: The mobile notification service for an Apple device.

      • APNS_SANDBOX: The sandbox environment of the mobile notification service for an Apple device.

      • GCM: The mobile notification service for an Android device.

      Populate the ResourceArn value of each type as PinpointAppArn.

      If the service returns an enum value that is not available in the current SDK version, type will return AppInstanceUserEndpointType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      The type of the AppInstanceUserEndpoint. Supported types:

      • APNS: The mobile notification service for an Apple device.

      • APNS_SANDBOX: The sandbox environment of the mobile notification service for an Apple device.

      • GCM: The mobile notification service for an Android device.

      Populate the ResourceArn value of each type as PinpointAppArn.

      See Also:

    • resourceArn

      public final String resourceArn()

      The ARN of the resource to which the endpoint belongs.

      Returns:
      The ARN of the resource to which the endpoint belongs.

    • endpointAttributes

      public final EndpointAttributes endpointAttributes()

      The attributes of an Endpoint.

      Returns:
      The attributes of an Endpoint.

    • clientRequestToken

      public final String clientRequestToken()

      The unique ID assigned to the request. Use different tokens to register other endpoints.

      Returns:
      The unique ID assigned to the request. Use different tokens to register other endpoints.

    • allowMessages

      public final AllowMessages allowMessages()

      Boolean that controls whether the AppInstanceUserEndpoint is opted in to receive messages. ALL indicates the endpoint receives all messages. NONE indicates the endpoint receives no messages.

      If the service returns an enum value that is not available in the current SDK version, allowMessages will return AllowMessages.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from allowMessagesAsString().

      Returns:
      Boolean that controls whether the AppInstanceUserEndpoint is opted in to receive messages. ALL indicates the endpoint receives all messages. NONE indicates the endpoint receives no messages.
      See Also:

    • allowMessagesAsString

      public final String allowMessagesAsString()

      Boolean that controls whether the AppInstanceUserEndpoint is opted in to receive messages. ALL indicates the endpoint receives all messages. NONE indicates the endpoint receives no messages.

      If the service returns an enum value that is not available in the current SDK version, allowMessages will return AllowMessages.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from allowMessagesAsString().

      Returns:
      Boolean that controls whether the AppInstanceUserEndpoint is opted in to receive messages. ALL indicates the endpoint receives all messages. NONE indicates the endpoint receives no messages.
      See Also:

    • toBuilder

      public RegisterAppInstanceUserEndpointRequest.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<RegisterAppInstanceUserEndpointRequest.Builder,RegisterAppInstanceUserEndpointRequest>
      Specified by:
      toBuilder in class ChimeSdkIdentityRequest
      Returns:
      a builder for type T

    • builder

      public static RegisterAppInstanceUserEndpointRequest.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.