Class AppInstanceUserEndpoint

java.lang.Object
software.amazon.awssdk.services.chimesdkidentity.model.AppInstanceUserEndpoint
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<AppInstanceUserEndpoint.Builder,AppInstanceUserEndpoint>
@Generated("software.amazon.awssdk:codegen") public final class AppInstanceUserEndpoint extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AppInstanceUserEndpoint.Builder,AppInstanceUserEndpoint>

An endpoint under an Amazon Chime AppInstanceUser that receives messages for a user. For push notifications, the endpoint is a mobile device used to receive mobile push notifications for a user.

See Also:

  • Method Details

    • appInstanceUserArn

      public final String appInstanceUserArn()

      The ARN of the AppInstanceUser.

      Returns:
      The ARN of the AppInstanceUser.

    • endpointId

      public final String endpointId()

      The unique identifier of the AppInstanceUserEndpoint.

      Returns:
      The unique identifier of the AppInstanceUserEndpoint.

    • 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.

      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.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of the AppInstanceUserEndpoint.

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

    • createdTimestamp

      public final Instant createdTimestamp()

      The time at which an AppInstanceUserEndpoint was created.

      Returns:
      The time at which an AppInstanceUserEndpoint was created.

    • lastUpdatedTimestamp

      public final Instant lastUpdatedTimestamp()

      The time at which an AppInstanceUserEndpoint was last updated.

      Returns:
      The time at which an AppInstanceUserEndpoint was last updated.

    • allowMessages

      public final AllowMessages allowMessages()

      Boolean that controls whether the AppInstanceUserEndpoint is opted in to receive messages. ALL indicates the endpoint will receive all messages. NONE indicates the endpoint will receive 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 will receive all messages. NONE indicates the endpoint will receive 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 will receive all messages. NONE indicates the endpoint will receive 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 will receive all messages. NONE indicates the endpoint will receive no messages.
      See Also:

    • endpointState

      public final EndpointState endpointState()

      A read-only field that represents the state of an AppInstanceUserEndpoint. Supported values:

      • ACTIVE: The AppInstanceUserEndpoint is active and able to receive messages. When ACTIVE, the EndpointStatusReason remains empty.

      • INACTIVE: The AppInstanceUserEndpoint is inactive and can't receive message. When INACTIVE, the corresponding reason will be conveyed through EndpointStatusReason.

      • INVALID_DEVICE_TOKEN indicates that an AppInstanceUserEndpoint is INACTIVE due to invalid device token

      • INVALID_PINPOINT_ARN indicates that an AppInstanceUserEndpoint is INACTIVE due to an invalid pinpoint ARN that was input through the ResourceArn field.

      Returns:
      A read-only field that represents the state of an AppInstanceUserEndpoint. Supported values:

      • ACTIVE: The AppInstanceUserEndpoint is active and able to receive messages. When ACTIVE, the EndpointStatusReason remains empty.

      • INACTIVE: The AppInstanceUserEndpoint is inactive and can't receive message. When INACTIVE, the corresponding reason will be conveyed through EndpointStatusReason.

      • INVALID_DEVICE_TOKEN indicates that an AppInstanceUserEndpoint is INACTIVE due to invalid device token

      • INVALID_PINPOINT_ARN indicates that an AppInstanceUserEndpoint is INACTIVE due to an invalid pinpoint ARN that was input through the ResourceArn field.

    • toBuilder

      public AppInstanceUserEndpoint.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<AppInstanceUserEndpoint.Builder,AppInstanceUserEndpoint>
      Returns:
      a builder for type T

    • builder

      public static AppInstanceUserEndpoint.Builder builder()

    • serializableBuilderClass

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

    • 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.