AppInstanceUserEndpoint (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.chimesdkidentity.model.AppInstanceUserEndpoint

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AppInstanceUserEndpoint
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

AppInstanceUserEndpoint()

Constructors
Constructor and Description
`AppInstanceUserEndpoint()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AppInstanceUserEndpoint`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAllowMessages()` Boolean that controls whether the `AppInstanceUserEndpoint` is opted in to receive messages.
`String`	`getAppInstanceUserArn()` The ARN of the `AppInstanceUser`.
`Date`	`getCreatedTimestamp()` The time at which an `AppInstanceUserEndpoint` was created.
`EndpointAttributes`	`getEndpointAttributes()` The attributes of an `Endpoint`.
`String`	`getEndpointId()` The unique identifier of the `AppInstanceUserEndpoint`.
`EndpointState`	`getEndpointState()` A read-only field that represents the state of an `AppInstanceUserEndpoint`.
`Date`	`getLastUpdatedTimestamp()` The time at which an `AppInstanceUserEndpoint` was last updated.
`String`	`getName()` The name of the `AppInstanceUserEndpoint`.
`String`	`getResourceArn()` The ARN of the resource to which the endpoint belongs.
`String`	`getType()` The type of the `AppInstanceUserEndpoint`.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAllowMessages(String allowMessages)` Boolean that controls whether the `AppInstanceUserEndpoint` is opted in to receive messages.
`void`	`setAppInstanceUserArn(String appInstanceUserArn)` The ARN of the `AppInstanceUser`.
`void`	`setCreatedTimestamp(Date createdTimestamp)` The time at which an `AppInstanceUserEndpoint` was created.
`void`	`setEndpointAttributes(EndpointAttributes endpointAttributes)` The attributes of an `Endpoint`.
`void`	`setEndpointId(String endpointId)` The unique identifier of the `AppInstanceUserEndpoint`.
`void`	`setEndpointState(EndpointState endpointState)` A read-only field that represents the state of an `AppInstanceUserEndpoint`.
`void`	`setLastUpdatedTimestamp(Date lastUpdatedTimestamp)` The time at which an `AppInstanceUserEndpoint` was last updated.
`void`	`setName(String name)` The name of the `AppInstanceUserEndpoint`.
`void`	`setResourceArn(String resourceArn)` The ARN of the resource to which the endpoint belongs.
`void`	`setType(String type)` The type of the `AppInstanceUserEndpoint`.
`String`	`toString()` Returns a string representation of this object.
`AppInstanceUserEndpoint`	`withAllowMessages(AllowMessages allowMessages)` Boolean that controls whether the `AppInstanceUserEndpoint` is opted in to receive messages.
`AppInstanceUserEndpoint`	`withAllowMessages(String allowMessages)` Boolean that controls whether the `AppInstanceUserEndpoint` is opted in to receive messages.
`AppInstanceUserEndpoint`	`withAppInstanceUserArn(String appInstanceUserArn)` The ARN of the `AppInstanceUser`.
`AppInstanceUserEndpoint`	`withCreatedTimestamp(Date createdTimestamp)` The time at which an `AppInstanceUserEndpoint` was created.
`AppInstanceUserEndpoint`	`withEndpointAttributes(EndpointAttributes endpointAttributes)` The attributes of an `Endpoint`.
`AppInstanceUserEndpoint`	`withEndpointId(String endpointId)` The unique identifier of the `AppInstanceUserEndpoint`.
`AppInstanceUserEndpoint`	`withEndpointState(EndpointState endpointState)` A read-only field that represents the state of an `AppInstanceUserEndpoint`.
`AppInstanceUserEndpoint`	`withLastUpdatedTimestamp(Date lastUpdatedTimestamp)` The time at which an `AppInstanceUserEndpoint` was last updated.
`AppInstanceUserEndpoint`	`withName(String name)` The name of the `AppInstanceUserEndpoint`.
`AppInstanceUserEndpoint`	`withResourceArn(String resourceArn)` The ARN of the resource to which the endpoint belongs.
`AppInstanceUserEndpoint`	`withType(AppInstanceUserEndpointType type)` The type of the `AppInstanceUserEndpoint`.
`AppInstanceUserEndpoint`	`withType(String type)` The type of the `AppInstanceUserEndpoint`.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - AppInstanceUserEndpoint
```
public AppInstanceUserEndpoint()
```
- Method Detail
  - setAppInstanceUserArn
```
public void setAppInstanceUserArn(String appInstanceUserArn)
```
    The ARN of the AppInstanceUser.
    
    Parameters:
    
    appInstanceUserArn - The ARN of the AppInstanceUser.
  - getAppInstanceUserArn
```
public String getAppInstanceUserArn()
```
    The ARN of the AppInstanceUser.
    
    Returns:
    
    The ARN of the AppInstanceUser.
  - withAppInstanceUserArn
```
public AppInstanceUserEndpoint withAppInstanceUserArn(String appInstanceUserArn)
```
    The ARN of the AppInstanceUser.
    
    Parameters:
    
    appInstanceUserArn - The ARN of the AppInstanceUser.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEndpointId
```
public void setEndpointId(String endpointId)
```
    The unique identifier of the AppInstanceUserEndpoint.
    
    Parameters:
    
    endpointId - The unique identifier of the AppInstanceUserEndpoint.
  - getEndpointId
```
public String getEndpointId()
```
    The unique identifier of the AppInstanceUserEndpoint.
    
    Returns:
    
    The unique identifier of the AppInstanceUserEndpoint.
  - withEndpointId
```
public AppInstanceUserEndpoint withEndpointId(String endpointId)
```
    The unique identifier of the AppInstanceUserEndpoint.
    
    Parameters:
    
    endpointId - The unique identifier of the AppInstanceUserEndpoint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    The name of the AppInstanceUserEndpoint.
    
    Parameters:
    
    name - The name of the AppInstanceUserEndpoint.
  - getName
```
public String getName()
```
    The name of the AppInstanceUserEndpoint.
    
    Returns:
    
    The name of the AppInstanceUserEndpoint.
  - withName
```
public AppInstanceUserEndpoint withName(String name)
```
    The name of the AppInstanceUserEndpoint.
    
    Parameters:
    
    name - The name of the AppInstanceUserEndpoint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setType
```
public void setType(String type)
```
    The type of the AppInstanceUserEndpoint.
    
    Parameters:
    
    type - The type of the AppInstanceUserEndpoint.
    
    See Also:
    
    AppInstanceUserEndpointType
  - getType
```
public String getType()
```
    The type of the AppInstanceUserEndpoint.
    
    Returns:
    
    The type of the AppInstanceUserEndpoint.
    
    See Also:
    
    AppInstanceUserEndpointType
  - withType
```
public AppInstanceUserEndpoint withType(String type)
```
    The type of the AppInstanceUserEndpoint.
    
    Parameters:
    
    type - The type of the AppInstanceUserEndpoint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AppInstanceUserEndpointType
  - withType
```
public AppInstanceUserEndpoint withType(AppInstanceUserEndpointType type)
```
    The type of the AppInstanceUserEndpoint.
    
    Parameters:
    
    type - The type of the AppInstanceUserEndpoint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AppInstanceUserEndpointType
  - setResourceArn
```
public void setResourceArn(String resourceArn)
```
    The ARN of the resource to which the endpoint belongs.
    
    Parameters:
    
    resourceArn - The ARN of the resource to which the endpoint belongs.
  - getResourceArn
```
public String getResourceArn()
```
    The ARN of the resource to which the endpoint belongs.
    
    Returns:
    
    The ARN of the resource to which the endpoint belongs.
  - withResourceArn
```
public AppInstanceUserEndpoint withResourceArn(String resourceArn)
```
    The ARN of the resource to which the endpoint belongs.
    
    Parameters:
    
    resourceArn - The ARN of the resource to which the endpoint belongs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEndpointAttributes
```
public void setEndpointAttributes(EndpointAttributes endpointAttributes)
```
    The attributes of an Endpoint.
    
    Parameters:
    
    endpointAttributes - The attributes of an Endpoint.
  - getEndpointAttributes
```
public EndpointAttributes getEndpointAttributes()
```
    The attributes of an Endpoint.
    
    Returns:
    
    The attributes of an Endpoint.
  - withEndpointAttributes
```
public AppInstanceUserEndpoint withEndpointAttributes(EndpointAttributes endpointAttributes)
```
    The attributes of an Endpoint.
    
    Parameters:
    
    endpointAttributes - The attributes of an Endpoint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreatedTimestamp
```
public void setCreatedTimestamp(Date createdTimestamp)
```
    The time at which an AppInstanceUserEndpoint was created.
    
    Parameters:
    
    createdTimestamp - The time at which an AppInstanceUserEndpoint was created.
  - getCreatedTimestamp
```
public Date getCreatedTimestamp()
```
    The time at which an AppInstanceUserEndpoint was created.
    
    Returns:
    
    The time at which an AppInstanceUserEndpoint was created.
  - withCreatedTimestamp
```
public AppInstanceUserEndpoint withCreatedTimestamp(Date createdTimestamp)
```
    The time at which an AppInstanceUserEndpoint was created.
    
    Parameters:
    
    createdTimestamp - The time at which an AppInstanceUserEndpoint was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastUpdatedTimestamp
```
public void setLastUpdatedTimestamp(Date lastUpdatedTimestamp)
```
    The time at which an AppInstanceUserEndpoint was last updated.
    
    Parameters:
    
    lastUpdatedTimestamp - The time at which an AppInstanceUserEndpoint was last updated.
  - getLastUpdatedTimestamp
```
public Date getLastUpdatedTimestamp()
```
    The time at which an AppInstanceUserEndpoint was last updated.
    
    Returns:
    
    The time at which an AppInstanceUserEndpoint was last updated.
  - withLastUpdatedTimestamp
```
public AppInstanceUserEndpoint withLastUpdatedTimestamp(Date lastUpdatedTimestamp)
```
    The time at which an AppInstanceUserEndpoint was last updated.
    
    Parameters:
    
    lastUpdatedTimestamp - The time at which an AppInstanceUserEndpoint was last updated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAllowMessages
```
public void setAllowMessages(String 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.
    
    Parameters:
    
    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.
    
    See Also:
    
    AllowMessages
  - getAllowMessages
```
public String getAllowMessages()
```
    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.
    
    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:
    
    AllowMessages
  - withAllowMessages
```
public AppInstanceUserEndpoint withAllowMessages(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AllowMessages
  - withAllowMessages
```
public AppInstanceUserEndpoint withAllowMessages(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AllowMessages
  - setEndpointState
```
public void setEndpointState(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.
    Parameters:
    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.
  - getEndpointState
```
public EndpointState getEndpointState()
```
    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.
  - withEndpointState
```
public AppInstanceUserEndpoint withEndpointState(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.
    Parameters:
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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 AppInstanceUserEndpoint 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.

AWS SDK for Java 1.x API Reference - 1.12.793

Class AppInstanceUserEndpoint

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AppInstanceUserEndpoint

Method Detail

setAppInstanceUserArn

getAppInstanceUserArn

withAppInstanceUserArn

setEndpointId

getEndpointId

withEndpointId

setName

getName

withName

setType

getType

withType

withType

setResourceArn

getResourceArn

withResourceArn

setEndpointAttributes

getEndpointAttributes

withEndpointAttributes

setCreatedTimestamp

getCreatedTimestamp

withCreatedTimestamp

setLastUpdatedTimestamp

getLastUpdatedTimestamp

withLastUpdatedTimestamp

setAllowMessages

getAllowMessages

withAllowMessages

withAllowMessages

setEndpointState

getEndpointState

withEndpointState

toString

equals

hashCode

clone

marshall