Class EndpointState

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

See Also:

  • Method Details

    • status

      public final EndpointStatus status()

      Enum that indicates the Status of an AppInstanceUserEndpoint.

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

      Returns:
      Enum that indicates the Status of an AppInstanceUserEndpoint.
      See Also:

    • statusAsString

      public final String statusAsString()

      Enum that indicates the Status of an AppInstanceUserEndpoint.

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

      Returns:
      Enum that indicates the Status of an AppInstanceUserEndpoint.
      See Also:

    • statusReason

      public final EndpointStatusReason statusReason()

      The reason for the EndpointStatus.

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

      Returns:
      The reason for the EndpointStatus.
      See Also:

    • statusReasonAsString

      public final String statusReasonAsString()

      The reason for the EndpointStatus.

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

      Returns:
      The reason for the EndpointStatus.
      See Also:

    • toBuilder

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

    • builder

      public static EndpointState.Builder builder()

    • serializableBuilderClass

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