Class EndpointState
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<EndpointState.Builder,
EndpointState>
A read-only field that represents the state of an AppInstanceUserEndpoint
. Supported values:
-
ACTIVE
: TheAppInstanceUserEndpoint
is active and able to receive messages. WhenACTIVE
, theEndpointStatusReason
remains empty. -
INACTIVE
: TheAppInstanceUserEndpoint
is inactive and can't receive message. When INACTIVE, the corresponding reason will be conveyed through EndpointStatusReason. -
INVALID_DEVICE_TOKEN
indicates that anAppInstanceUserEndpoint
isINACTIVE
due to invalid device token -
INVALID_PINPOINT_ARN
indicates that anAppInstanceUserEndpoint
isINACTIVE
due to an invalid pinpoint ARN that was input through theResourceArn
field.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic EndpointState.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
static Class
<? extends EndpointState.Builder> final EndpointStatus
status()
Enum that indicates the Status of anAppInstanceUserEndpoint
.final String
Enum that indicates the Status of anAppInstanceUserEndpoint
.final EndpointStatusReason
The reason for theEndpointStatus
.final String
The reason for theEndpointStatus
.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 returnEndpointStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- Enum that indicates the Status of an
AppInstanceUserEndpoint
. - See Also:
-
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 returnEndpointStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- Enum that indicates the Status of an
AppInstanceUserEndpoint
. - See Also:
-
statusReason
The reason for the
EndpointStatus
.If the service returns an enum value that is not available in the current SDK version,
statusReason
will returnEndpointStatusReason.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusReasonAsString()
.- Returns:
- The reason for the
EndpointStatus
. - See Also:
-
statusReasonAsString
The reason for the
EndpointStatus
.If the service returns an enum value that is not available in the current SDK version,
statusReason
will returnEndpointStatusReason.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusReasonAsString()
.- Returns:
- The reason for the
EndpointStatus
. - See Also:
-
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 interfaceToCopyableBuilder<EndpointState.Builder,
EndpointState> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-