Package software.amazon.awssdk.services.chimesdkidentity.model

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	EndpointState.Builder

Method Summary

Modifier and Type	Method	Description
static EndpointState.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends EndpointState.Builder>	serializableBuilderClass()
EndpointStatus	status()	Enum that indicates the Status of an AppInstanceUserEndpoint.
String	statusAsString()	Enum that indicates the Status of an AppInstanceUserEndpoint.
EndpointStatusReason	statusReason()	The reason for the EndpointStatus.
String	statusReasonAsString()	The reason for the EndpointStatus.
EndpointState.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

EndpointStatus

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:

EndpointStatus

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:

EndpointStatusReason

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:

EndpointStatusReason

toBuilder

public EndpointState.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<EndpointState.Builder,EndpointState>

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)

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)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo