Package software.amazon.awssdk.services.chimesdkidentity.model

Class RegisterAppInstanceUserEndpointRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.chimesdkidentity.model.ChimeSdkIdentityRequest

software.amazon.awssdk.services.chimesdkidentity.model.RegisterAppInstanceUserEndpointRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<RegisterAppInstanceUserEndpointRequest.Builder,RegisterAppInstanceUserEndpointRequest>

@Generated("software.amazon.awssdk:codegen")
public final class RegisterAppInstanceUserEndpointRequest
extends ChimeSdkIdentityRequest
implements ToCopyableBuilder<RegisterAppInstanceUserEndpointRequest.Builder,RegisterAppInstanceUserEndpointRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RegisterAppInstanceUserEndpointRequest.Builder

Method Summary

Modifier and Type	Method	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 RegisterAppInstanceUserEndpointRequest.Builder	builder()
String	clientRequestToken()	The unique ID assigned to the request.
EndpointAttributes	endpointAttributes()	The attributes of an Endpoint.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	name()	The name of the AppInstanceUserEndpoint.
String	resourceArn()	The ARN of the resource to which the endpoint belongs.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends RegisterAppInstanceUserEndpointRequest.Builder>	serializableBuilderClass()
RegisterAppInstanceUserEndpointRequest.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 software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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.

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. Supported types:

• APNS: The mobile notification service for an Apple device.

• APNS_SANDBOX: The sandbox environment of the mobile notification service for an Apple device.

• GCM: The mobile notification service for an Android device.

Populate the ResourceArn value of each type as PinpointAppArn.

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. Supported types:

• APNS: The mobile notification service for an Apple device.

• APNS_SANDBOX: The sandbox environment of the mobile notification service for an Apple device.

• GCM: The mobile notification service for an Android device.

Populate the ResourceArn value of each type as PinpointAppArn.

See Also:

AppInstanceUserEndpointType

typeAsString

public final String typeAsString()

The type of the AppInstanceUserEndpoint. Supported types:

• APNS: The mobile notification service for an Apple device.

• APNS_SANDBOX: The sandbox environment of the mobile notification service for an Apple device.

• GCM: The mobile notification service for an Android device.

Populate the ResourceArn value of each type as PinpointAppArn.

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. Supported types:

• APNS: The mobile notification service for an Apple device.

• APNS_SANDBOX: The sandbox environment of the mobile notification service for an Apple device.

• GCM: The mobile notification service for an Android device.

Populate the ResourceArn value of each type as PinpointAppArn.

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.

clientRequestToken

public final String clientRequestToken()

The unique ID assigned to the request. Use different tokens to register other endpoints.

Returns:

The unique ID assigned to the request. Use different tokens to register other endpoints.

allowMessages

public final AllowMessages allowMessages()

Boolean that controls whether the AppInstanceUserEndpoint is opted in to receive messages. ALL indicates the endpoint receives all messages. NONE indicates the endpoint receives 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 receives all messages. NONE indicates the endpoint receives 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 receives all messages. NONE indicates the endpoint receives 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 receives all messages. NONE indicates the endpoint receives no messages.

See Also:

AllowMessages

toBuilder

public RegisterAppInstanceUserEndpointRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RegisterAppInstanceUserEndpointRequest.Builder,RegisterAppInstanceUserEndpointRequest>

Specified by:

toBuilder in class ChimeSdkIdentityRequest

builder

public static RegisterAppInstanceUserEndpointRequest.Builder builder()

serializableBuilderClass

public static Class<? extends RegisterAppInstanceUserEndpointRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo