Class RegisterAppInstanceUserEndpointRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<RegisterAppInstanceUserEndpointRequest.Builder,
RegisterAppInstanceUserEndpointRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal AllowMessages
Boolean that controls whether the AppInstanceUserEndpoint is opted in to receive messages.final String
Boolean that controls whether the AppInstanceUserEndpoint is opted in to receive messages.final String
The ARN of theAppInstanceUser
.builder()
final String
The unique ID assigned to the request.final EndpointAttributes
The attributes of anEndpoint
.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) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final String
name()
The name of theAppInstanceUserEndpoint
.final String
The ARN of the resource to which the endpoint belongs.static Class
<? extends RegisterAppInstanceUserEndpointRequest.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 class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
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
.
-
name
The name of the
AppInstanceUserEndpoint
.- Returns:
- The name of the
AppInstanceUserEndpoint
.
-
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 asPinpointAppArn
.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
. 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 asPinpointAppArn
. -
- See Also:
-
-
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 asPinpointAppArn
.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
. 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 asPinpointAppArn
. -
- 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
.
-
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
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 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 receives all messages.NONE
indicates the endpoint receives no messages. - See Also:
-
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 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 receives all messages.NONE
indicates the endpoint receives no messages. - See Also:
-
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<RegisterAppInstanceUserEndpointRequest.Builder,
RegisterAppInstanceUserEndpointRequest> - Specified by:
toBuilder
in classChimeSdkIdentityRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends RegisterAppInstanceUserEndpointRequest.Builder> serializableBuilderClass() -
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
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
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-