AppInstanceUserEndpoint (AWS Java SDK :: Services :: Chime SDK Identity 2.21.10 API)

java.lang.Object
- software.amazon.awssdk.services.chimesdkidentity.model.AppInstanceUserEndpoint

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AppInstanceUserEndpoint.Builder,AppInstanceUserEndpoint>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class AppInstanceUserEndpoint
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AppInstanceUserEndpoint.Builder,AppInstanceUserEndpoint>
```
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:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface AppInstanceUserEndpoint.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`AppInstanceUserEndpoint.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AllowMessages`	`allowMessages()` Boolean that controls whether the `AppInstanceUserEndpoint` is opted in to receive messages.
`String`	`allowMessagesAsString()` Boolean that controls whether the `AppInstanceUserEndpoint` is opted in to receive messages.
`String`	`appInstanceUserArn()` The ARN of the `AppInstanceUser`.
`static AppInstanceUserEndpoint.Builder`	`builder()`
`Instant`	`createdTimestamp()` The time at which an `AppInstanceUserEndpoint` was created.
`EndpointAttributes`	`endpointAttributes()` The attributes of an `Endpoint`.
`String`	`endpointId()` The unique identifier of the `AppInstanceUserEndpoint`.
`EndpointState`	`endpointState()` A read-only field that represents the state of an `AppInstanceUserEndpoint`.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`Instant`	`lastUpdatedTimestamp()` The time at which an `AppInstanceUserEndpoint` was last updated.
`String`	`name()` The name of the `AppInstanceUserEndpoint`.
`String`	`resourceArn()` The ARN of the resource to which the endpoint belongs.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends AppInstanceUserEndpoint.Builder>`	`serializableBuilderClass()`
`AppInstanceUserEndpoint.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`AppInstanceUserEndpointType`	`type()` The type of the `AppInstanceUserEndpoint`.
`String`	`typeAsString()` The type of the `AppInstanceUserEndpoint`.

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
  - appInstanceUserArn
```
public final String appInstanceUserArn()
```
    The ARN of the AppInstanceUser.
    
    Returns:
    
    The ARN of the AppInstanceUser.
  - endpointId
```
public final String endpointId()
```
    The unique identifier of the AppInstanceUserEndpoint.
    
    Returns:
    
    The unique identifier of the AppInstanceUserEndpoint.
  - name
```
public final String name()
```
    The name of the AppInstanceUserEndpoint.
    
    Returns:
    
    The name of the AppInstanceUserEndpoint.
  - type
```
public final AppInstanceUserEndpointType type()
```
    The type of the AppInstanceUserEndpoint.
    
    If the service returns an enum value that is not available in the current SDK version, type will return AppInstanceUserEndpointType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    The type of the AppInstanceUserEndpoint.
    
    See Also:
    
    AppInstanceUserEndpointType
  - typeAsString
```
public final String typeAsString()
```
    The type of the AppInstanceUserEndpoint.
    
    If the service returns an enum value that is not available in the current SDK version, type will return AppInstanceUserEndpointType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    The type of the AppInstanceUserEndpoint.
    
    See Also:
    
    AppInstanceUserEndpointType
  - resourceArn
```
public final String resourceArn()
```
    The ARN of the resource to which the endpoint belongs.
    
    Returns:
    
    The ARN of the resource to which the endpoint belongs.
  - endpointAttributes
```
public final EndpointAttributes endpointAttributes()
```
    The attributes of an Endpoint.
    
    Returns:
    
    The attributes of an Endpoint.
  - createdTimestamp
```
public final Instant createdTimestamp()
```
    The time at which an AppInstanceUserEndpoint was created.
    
    Returns:
    
    The time at which an AppInstanceUserEndpoint was created.
  - lastUpdatedTimestamp
```
public final Instant lastUpdatedTimestamp()
```
    The time at which an AppInstanceUserEndpoint was last updated.
    
    Returns:
    
    The time at which an AppInstanceUserEndpoint was last updated.
  - allowMessages
```
public final 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.
    
    If the service returns an enum value that is not available in the current SDK version, allowMessages will return AllowMessages.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from allowMessagesAsString().
    
    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
  - allowMessagesAsString
```
public final String allowMessagesAsString()
```
    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.
    
    If the service returns an enum value that is not available in the current SDK version, allowMessages will return AllowMessages.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from allowMessagesAsString().
    
    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
  - endpointState
```
public final 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.
    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.
  - toBuilder
```
public AppInstanceUserEndpoint.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<AppInstanceUserEndpoint.Builder,AppInstanceUserEndpoint>
  - builder
```
public static AppInstanceUserEndpoint.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends AppInstanceUserEndpoint.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

Class AppInstanceUserEndpoint

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

appInstanceUserArn

endpointId

name

type

typeAsString

resourceArn

endpointAttributes

createdTimestamp

lastUpdatedTimestamp

allowMessages

allowMessagesAsString

endpointState

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields