software.amazon.awssdk.services.sns.model

Class SetTopicAttributesRequest

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.SetTopicAttributesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<SetTopicAttributesRequest.Builder,SetTopicAttributesRequest>

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

Input for SetTopicAttributes action.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SetTopicAttributesRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	attributeName() A map of attributes with their corresponding values.
String	attributeValue() The new value for the attribute.
static SetTopicAttributesRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends SetTopicAttributesRequest.Builder>	serializableBuilderClass()
SetTopicAttributesRequest.Builder	toBuilder()
String	topicArn() The ARN of the topic to modify.
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

topicArn

public String topicArn()

The ARN of the topic to modify.

Returns:

The ARN of the topic to modify.

attributeName

public String attributeName()

A map of attributes with their corresponding values.

The following lists the names, descriptions, and values of the special request parameters that the SetTopicAttributes action uses:

• DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.

• DisplayName – The display name to use for a topic with SMS subscriptions.

• Policy – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.

The following attribute applies only to server-side-encryption:

• KmsMasterKeyId - The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the AWS Key Management Service API Reference.

Returns:

A map of attributes with their corresponding values.

The following lists the names, descriptions, and values of the special request parameters that the SetTopicAttributes action uses:

• DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.

• DisplayName – The display name to use for a topic with SMS subscriptions.

• Policy – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.

The following attribute applies only to server-side-encryption:

• KmsMasterKeyId - The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the AWS Key Management Service API Reference.

attributeValue

public String attributeValue()

The new value for the attribute.

Returns:

The new value for the attribute.

toBuilder

public SetTopicAttributesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SetTopicAttributesRequest.Builder,SetTopicAttributesRequest>

Specified by:

toBuilder in class SnsRequest

builder

public static SetTopicAttributesRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo