Class AppInstanceUserEndpoint
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal AllowMessages
Boolean that controls whether theAppInstanceUserEndpoint
is opted in to receive messages.final String
Boolean that controls whether theAppInstanceUserEndpoint
is opted in to receive messages.final String
The ARN of theAppInstanceUser
.builder()
final Instant
The time at which anAppInstanceUserEndpoint
was created.final EndpointAttributes
The attributes of anEndpoint
.final String
The unique identifier of theAppInstanceUserEndpoint
.final EndpointState
A read-only field that represents the state of anAppInstanceUserEndpoint
.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()
final Instant
The time at which anAppInstanceUserEndpoint
was last updated.final String
name()
The name of theAppInstanceUserEndpoint
.final String
The ARN of the resource to which the endpoint belongs.static Class
<? extends AppInstanceUserEndpoint.Builder> 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.type()
The type of theAppInstanceUserEndpoint
.final String
The type of theAppInstanceUserEndpoint
.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
appInstanceUserArn
The ARN of the
AppInstanceUser
.- Returns:
- The ARN of the
AppInstanceUser
.
-
endpointId
The unique identifier of the
AppInstanceUserEndpoint
.- Returns:
- The unique identifier of the
AppInstanceUserEndpoint
.
-
name
The name of the
AppInstanceUserEndpoint
.- Returns:
- The name of the
AppInstanceUserEndpoint
.
-
type
The type of the
AppInstanceUserEndpoint
.If the service returns an enum value that is not available in the current SDK version,
type
will returnAppInstanceUserEndpointType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of the
AppInstanceUserEndpoint
. - See Also:
-
typeAsString
The type of the
AppInstanceUserEndpoint
.If the service returns an enum value that is not available in the current SDK version,
type
will returnAppInstanceUserEndpointType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of the
AppInstanceUserEndpoint
. - See Also:
-
resourceArn
The ARN of the resource to which the endpoint belongs.
- Returns:
- The ARN of the resource to which the endpoint belongs.
-
endpointAttributes
The attributes of an
Endpoint
.- Returns:
- The attributes of an
Endpoint
.
-
createdTimestamp
The time at which an
AppInstanceUserEndpoint
was created.- Returns:
- The time at which an
AppInstanceUserEndpoint
was created.
-
lastUpdatedTimestamp
The time at which an
AppInstanceUserEndpoint
was last updated.- Returns:
- The time at which an
AppInstanceUserEndpoint
was last updated.
-
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 returnAllowMessages.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromallowMessagesAsString()
.- 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:
-
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 returnAllowMessages.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromallowMessagesAsString()
.- 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:
-
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. WhenINACTIVE
, the corresponding reason will be conveyed throughEndpointStatusReason
. -
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.
- Returns:
- 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. WhenINACTIVE
, the corresponding reason will be conveyed throughEndpointStatusReason
. -
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.
-
-
-
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<AppInstanceUserEndpoint.Builder,
AppInstanceUserEndpoint> - 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
-