Package software.amazon.awssdk.services.sns.model

Class SetEndpointAttributesRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.sns.model.SnsRequest

software.amazon.awssdk.services.sns.model.SetEndpointAttributesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<SetEndpointAttributesRequest.Builder,SetEndpointAttributesRequest>

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

Input for SetEndpointAttributes action.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SetEndpointAttributesRequest.Builder

Method Summary

Modifier and Type	Method	Description
Map<String,String>	attributes()	A map of the endpoint attributes.
static SetEndpointAttributesRequest.Builder	builder()
String	endpointArn()	EndpointArn used for SetEndpointAttributes action.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAttributes()	For responses, this returns true if the service returned a value for the Attributes property.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends SetEndpointAttributesRequest.Builder>	serializableBuilderClass()
SetEndpointAttributesRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

endpointArn

public final String endpointArn()

EndpointArn used for SetEndpointAttributes action.

Returns:

EndpointArn used for SetEndpointAttributes action.

hasAttributes

public final boolean hasAttributes()

For responses, this returns true if the service returned a value for the Attributes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

attributes

public final Map<String,String> 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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAttributes() method.

Returns:

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.

toBuilder

public SetEndpointAttributesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SetEndpointAttributesRequest.Builder,SetEndpointAttributesRequest>

Specified by:

toBuilder in class SnsRequest

builder

public static SetEndpointAttributesRequest.Builder builder()

serializableBuilderClass

public static Class<? extends SetEndpointAttributesRequest.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