com.amazonaws.services.chimesdkidentity.model

Class EndpointState

java.lang.Object

com.amazonaws.services.chimesdkidentity.model.EndpointState

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class EndpointState
extends Object
implements Serializable, Cloneable, StructuredPojo

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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
EndpointState()

Method Summary

Modifier and Type	Method and Description
EndpointState	clone()
boolean	equals(Object obj)
String	getStatus() Enum that indicates the Status of an AppInstanceUserEndpoint.
String	getStatusReason() The reason for the EndpointStatus.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setStatus(String status) Enum that indicates the Status of an AppInstanceUserEndpoint.
void	setStatusReason(String statusReason) The reason for the EndpointStatus.
String	toString() Returns a string representation of this object.
EndpointState	withStatus(EndpointStatus status) Enum that indicates the Status of an AppInstanceUserEndpoint.
EndpointState	withStatus(String status) Enum that indicates the Status of an AppInstanceUserEndpoint.
EndpointState	withStatusReason(EndpointStatusReason statusReason) The reason for the EndpointStatus.
EndpointState	withStatusReason(String statusReason) The reason for the EndpointStatus.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

EndpointState

public EndpointState()

Method Detail

setStatus

public void setStatus(String status)

Enum that indicates the Status of an AppInstanceUserEndpoint.

Parameters:

status - Enum that indicates the Status of an AppInstanceUserEndpoint.

See Also:

EndpointStatus

getStatus

public String getStatus()

Enum that indicates the Status of an AppInstanceUserEndpoint.

Returns:

Enum that indicates the Status of an AppInstanceUserEndpoint.

See Also:

EndpointStatus

withStatus

public EndpointState withStatus(String status)

Enum that indicates the Status of an AppInstanceUserEndpoint.

Parameters:

status - Enum that indicates the Status of an AppInstanceUserEndpoint.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

EndpointStatus

withStatus

public EndpointState withStatus(EndpointStatus status)

Enum that indicates the Status of an AppInstanceUserEndpoint.

Parameters:

status - Enum that indicates the Status of an AppInstanceUserEndpoint.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

EndpointStatus

setStatusReason

public void setStatusReason(String statusReason)

The reason for the EndpointStatus.

Parameters:

statusReason - The reason for the EndpointStatus.

See Also:

EndpointStatusReason

getStatusReason

public String getStatusReason()

The reason for the EndpointStatus.

Returns:

The reason for the EndpointStatus.

See Also:

EndpointStatusReason

withStatusReason

public EndpointState withStatusReason(String statusReason)

The reason for the EndpointStatus.

Parameters:

statusReason - The reason for the EndpointStatus.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

EndpointStatusReason

withStatusReason

public EndpointState withStatusReason(EndpointStatusReason statusReason)

The reason for the EndpointStatus.

Parameters:

statusReason - The reason for the EndpointStatus.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

EndpointStatusReason

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public EndpointState clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.