Interface SetEndpointAttributesRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<SetEndpointAttributesRequest.Builder,
,SetEndpointAttributesRequest> SdkBuilder<SetEndpointAttributesRequest.Builder,
,SetEndpointAttributesRequest> SdkPojo
,SdkRequest.Builder
,SnsRequest.Builder
- Enclosing class:
SetEndpointAttributesRequest
-
Method Summary
Modifier and TypeMethodDescriptionattributes
(Map<String, String> attributes) A map of the endpoint attributes.endpointArn
(String endpointArn) EndpointArn used forSetEndpointAttributes
action.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
Methods inherited from interface software.amazon.awssdk.services.sns.model.SnsRequest.Builder
build
-
Method Details
-
endpointArn
EndpointArn used for
SetEndpointAttributes
action.- Parameters:
endpointArn
- EndpointArn used forSetEndpointAttributes
action.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
attributes
A map of the endpoint attributes. Attributes in this map include the following:
-
CustomUserData
– arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB. -
Enabled
– flag that enables/disables delivery to the endpoint. Amazon SNS will set this to false when a notification service indicates to Amazon SNS that the endpoint is invalid. Users can set it back to true, typically after updating Token. -
Token
– device token, also referred to as a registration id, for an app and mobile device. This is returned from the notification service when an app and mobile device are registered with the notification service.
- Parameters:
attributes
- A map of the endpoint attributes. Attributes in this map include the following:-
CustomUserData
– arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB. -
Enabled
– flag that enables/disables delivery to the endpoint. Amazon SNS will set this to false when a notification service indicates to Amazon SNS that the endpoint is invalid. Users can set it back to true, typically after updating Token. -
Token
– device token, also referred to as a registration id, for an app and mobile device. This is returned from the notification service when an app and mobile device are registered with the notification service.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
overrideConfiguration
SetEndpointAttributesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
SetEndpointAttributesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-