software.amazon.awssdk.services.sns.model.GetTopicAttributesResponse Maven / Gradle / Ivy
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.sns.model;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.traits.MapTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructMap;
import software.amazon.awssdk.core.util.SdkAutoConstructMap;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Response for GetTopicAttributes action.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class GetTopicAttributesResponse extends SnsResponse implements
ToCopyableBuilder {
private static final SdkField> ATTRIBUTES_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("Attributes")
.getter(getter(GetTopicAttributesResponse::attributes))
.setter(setter(Builder::attributes))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Attributes").build(),
MapTrait.builder()
.keyLocationName("key")
.valueLocationName("value")
.valueFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("value").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ATTRIBUTES_FIELD));
private static final Map> SDK_NAME_TO_FIELD = memberNameToFieldInitializer();
private final Map attributes;
private GetTopicAttributesResponse(BuilderImpl builder) {
super(builder);
this.attributes = builder.attributes;
}
/**
* 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 {@code 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.
*/
public final boolean hasAttributes() {
return attributes != null && !(attributes instanceof SdkAutoConstructMap);
}
/**
*
* A map of the topic's attributes. Attributes in this map include the following:
*
*
* -
*
* DeliveryPolicy – The JSON serialization of the topic's delivery policy.
*
*
* -
*
* DisplayName – The human-readable name used in the From field for notifications to
* email and email-json endpoints.
*
*
* -
*
* EffectiveDeliveryPolicy – The JSON serialization of the effective delivery policy, taking system
* defaults into account.
*
*
* -
*
* Owner – The Amazon Web Services account ID of the topic's owner.
*
*
* -
*
* Policy – The JSON serialization of the topic's access control policy.
*
*
* -
*
* SignatureVersion – The signature version corresponds to the hashing algorithm used while creating
* the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by
* Amazon SNS.
*
*
* -
*
* By default, SignatureVersion is set to 1. The signature is a Base64-encoded
* SHA1withRSA signature.
*
*
* -
*
* When you set SignatureVersion to 2. Amazon SNS uses a Base64-encoded SHA256withRSA
* signature.
*
*
*
* If the API response does not include the SignatureVersion attribute, it means that the
* SignatureVersion for the topic has value 1.
*
*
*
*
* -
*
* SubscriptionsConfirmed – The number of confirmed subscriptions for the topic.
*
*
* -
*
* SubscriptionsDeleted – The number of deleted subscriptions for the topic.
*
*
* -
*
* SubscriptionsPending – The number of subscriptions pending confirmation for the topic.
*
*
* -
*
* TopicArn – The topic's ARN.
*
*
* -
*
* TracingConfig – Tracing mode of an Amazon SNS topic. By default TracingConfig is set to
* PassThrough, and the topic passes through the tracing header it receives from an Amazon SNS
* publisher to its subscriptions. If set to Active, Amazon SNS will vend X-Ray segment data to topic
* owner account if the sampled flag in the tracing header is true. This is only supported on standard topics.
*
*
*
*
* The following attribute applies only to server-side-encryption:
*
*
* -
*
* KmsMasterKeyId - The ID of an Amazon Web Services 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 Key Management Service API Reference.
*
*
*
*
* The following attributes apply only to FIFO topics:
*
*
* -
*
* ArchivePolicy – The policy that sets the retention period for messages stored in the message archive
* of an Amazon SNS FIFO topic.
*
*
* -
*
* BeginningArchiveTime – The earliest starting point at which a message in the topic’s archive can be
* replayed from. This point in time is based on the configured message retention period set by the topic’s message
* archiving policy.
*
*
* -
*
* ContentBasedDeduplication – Enables content-based deduplication for FIFO topics.
*
*
* -
*
* By default, ContentBasedDeduplication is set to false. If you create a FIFO topic and
* this attribute is false, you must specify a value for the MessageDeduplicationId
* parameter for the Publish action.
*
*
* -
*
* When you set ContentBasedDeduplication to true, Amazon SNS uses a SHA-256 hash to
* generate the MessageDeduplicationId using the body of the message (but not the attributes of the
* message).
*
*
* (Optional) To override the generated value, you can specify a value for the MessageDeduplicationId
* parameter for the Publish action.
*
*
*
*
* -
*
* FifoTopic – When this is set to true, a FIFO topic is created.
*
*
*
*
* 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 {@link #hasAttributes} method.
*
*
* @return A map of the topic's attributes. Attributes in this map include the following:
*
* -
*
* DeliveryPolicy – The JSON serialization of the topic's delivery policy.
*
*
* -
*
* DisplayName – The human-readable name used in the From field for notifications
* to email and email-json endpoints.
*
*
* -
*
* EffectiveDeliveryPolicy – The JSON serialization of the effective delivery policy, taking
* system defaults into account.
*
*
* -
*
* Owner – The Amazon Web Services account ID of the topic's owner.
*
*
* -
*
* Policy – The JSON serialization of the topic's access control policy.
*
*
* -
*
* SignatureVersion – The signature version corresponds to the hashing algorithm used while
* creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation
* messages sent by Amazon SNS.
*
*
* -
*
* By default, SignatureVersion is set to 1. The signature is a Base64-encoded
* SHA1withRSA signature.
*
*
* -
*
* When you set SignatureVersion to 2. Amazon SNS uses a Base64-encoded
* SHA256withRSA signature.
*
*
*
* If the API response does not include the SignatureVersion attribute, it means that the
* SignatureVersion for the topic has value 1.
*
*
*
*
* -
*
* SubscriptionsConfirmed – The number of confirmed subscriptions for the topic.
*
*
* -
*
* SubscriptionsDeleted – The number of deleted subscriptions for the topic.
*
*
* -
*
* SubscriptionsPending – The number of subscriptions pending confirmation for the topic.
*
*
* -
*
* TopicArn – The topic's ARN.
*
*
* -
*
* TracingConfig – Tracing mode of an Amazon SNS topic. By default TracingConfig
* is set to PassThrough, and the topic passes through the tracing header it receives from an
* Amazon SNS publisher to its subscriptions. If set to Active, Amazon SNS will vend X-Ray
* segment data to topic owner account if the sampled flag in the tracing header is true. This is only
* supported on standard topics.
*
*
*
*
* The following attribute applies only to server-side-encryption:
*
*
* -
*
* KmsMasterKeyId - The ID of an Amazon Web Services 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 Key Management Service API Reference.
*
*
*
*
* The following attributes apply only to FIFO topics:
*
*
* -
*
* ArchivePolicy – The policy that sets the retention period for messages stored in the message
* archive of an Amazon SNS FIFO topic.
*
*
* -
*
* BeginningArchiveTime – The earliest starting point at which a message in the topic’s archive
* can be replayed from. This point in time is based on the configured message retention period set by the
* topic’s message archiving policy.
*
*
* -
*
* ContentBasedDeduplication – Enables content-based deduplication for FIFO topics.
*
*
* -
*
* By default, ContentBasedDeduplication is set to false. If you create a FIFO
* topic and this attribute is false, you must specify a value for the
* MessageDeduplicationId parameter for the Publish action.
*
*
* -
*
* When you set ContentBasedDeduplication to true, Amazon SNS uses a SHA-256 hash
* to generate the MessageDeduplicationId using the body of the message (but not the attributes
* of the message).
*
*
* (Optional) To override the generated value, you can specify a value for the
* MessageDeduplicationId parameter for the Publish action.
*
*
*
*
* -
*
* FifoTopic – When this is set to true, a FIFO topic is created.
*
*
*/
public final Map attributes() {
return attributes;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(hasAttributes() ? attributes() : null);
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof GetTopicAttributesResponse)) {
return false;
}
GetTopicAttributesResponse other = (GetTopicAttributesResponse) obj;
return hasAttributes() == other.hasAttributes() && Objects.equals(attributes(), other.attributes());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("GetTopicAttributesResponse").add("Attributes", hasAttributes() ? attributes() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Attributes":
return Optional.ofNullable(clazz.cast(attributes()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Map> memberNameToFieldInitializer() {
Map> map = new HashMap<>();
map.put("Attributes", ATTRIBUTES_FIELD);
return Collections.unmodifiableMap(map);
}
private static Function getter(Function g) {
return obj -> g.apply((GetTopicAttributesResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SnsResponse.Builder, SdkPojo, CopyableBuilder {
/**
*
* A map of the topic's attributes. Attributes in this map include the following:
*
*
* -
*
* DeliveryPolicy – The JSON serialization of the topic's delivery policy.
*
*
* -
*
* DisplayName – The human-readable name used in the From field for notifications to
* email and email-json endpoints.
*
*
* -
*
* EffectiveDeliveryPolicy – The JSON serialization of the effective delivery policy, taking system
* defaults into account.
*
*
* -
*
* Owner – The Amazon Web Services account ID of the topic's owner.
*
*
* -
*
* Policy – The JSON serialization of the topic's access control policy.
*
*
* -
*
* SignatureVersion – The signature version corresponds to the hashing algorithm used while
* creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages
* sent by Amazon SNS.
*
*
* -
*
* By default, SignatureVersion is set to 1. The signature is a Base64-encoded
* SHA1withRSA signature.
*
*
* -
*
* When you set SignatureVersion to 2. Amazon SNS uses a Base64-encoded SHA256withRSA
* signature.
*
*
*
* If the API response does not include the SignatureVersion attribute, it means that the
* SignatureVersion for the topic has value 1.
*
*
*
*
* -
*
* SubscriptionsConfirmed – The number of confirmed subscriptions for the topic.
*
*
* -
*
* SubscriptionsDeleted – The number of deleted subscriptions for the topic.
*
*
* -
*
* SubscriptionsPending – The number of subscriptions pending confirmation for the topic.
*
*
* -
*
* TopicArn – The topic's ARN.
*
*
* -
*
* TracingConfig – Tracing mode of an Amazon SNS topic. By default TracingConfig is
* set to PassThrough, and the topic passes through the tracing header it receives from an Amazon
* SNS publisher to its subscriptions. If set to Active, Amazon SNS will vend X-Ray segment data to
* topic owner account if the sampled flag in the tracing header is true. This is only supported on standard
* topics.
*
*
*
*
* The following attribute applies only to server-side-encryption:
*
*
* -
*
* KmsMasterKeyId - The ID of an Amazon Web Services 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 Key Management Service API Reference.
*
*
*
*
* The following attributes apply only to FIFO topics:
*
*
* -
*
* ArchivePolicy – The policy that sets the retention period for messages stored in the message
* archive of an Amazon SNS FIFO topic.
*
*
* -
*
* BeginningArchiveTime – The earliest starting point at which a message in the topic’s archive can
* be replayed from. This point in time is based on the configured message retention period set by the topic’s
* message archiving policy.
*
*
* -
*
* ContentBasedDeduplication – Enables content-based deduplication for FIFO topics.
*
*
* -
*
* By default, ContentBasedDeduplication is set to false. If you create a FIFO topic
* and this attribute is false, you must specify a value for the
* MessageDeduplicationId parameter for the Publish action.
*
*
* -
*
* When you set ContentBasedDeduplication to true, Amazon SNS uses a SHA-256 hash to
* generate the MessageDeduplicationId using the body of the message (but not the attributes of the
* message).
*
*
* (Optional) To override the generated value, you can specify a value for the
* MessageDeduplicationId parameter for the Publish action.
*
*
*
*
* -
*
* FifoTopic – When this is set to true, a FIFO topic is created.
*
*
*
*
* @param attributes
* A map of the topic's attributes. Attributes in this map include the following:
*
* -
*
* DeliveryPolicy – The JSON serialization of the topic's delivery policy.
*
*
* -
*
* DisplayName – The human-readable name used in the From field for
* notifications to email and email-json endpoints.
*
*
* -
*
* EffectiveDeliveryPolicy – The JSON serialization of the effective delivery policy, taking
* system defaults into account.
*
*
* -
*
* Owner – The Amazon Web Services account ID of the topic's owner.
*
*
* -
*
* Policy – The JSON serialization of the topic's access control policy.
*
*
* -
*
* SignatureVersion – The signature version corresponds to the hashing algorithm used while
* creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation
* messages sent by Amazon SNS.
*
*
* -
*
* By default, SignatureVersion is set to 1. The signature is a Base64-encoded
* SHA1withRSA signature.
*
*
* -
*
* When you set SignatureVersion to 2. Amazon SNS uses a Base64-encoded
* SHA256withRSA signature.
*
*
*
* If the API response does not include the SignatureVersion attribute, it means that the
* SignatureVersion for the topic has value 1.
*
*
*
*
* -
*
* SubscriptionsConfirmed – The number of confirmed subscriptions for the topic.
*
*
* -
*
* SubscriptionsDeleted – The number of deleted subscriptions for the topic.
*
*
* -
*
* SubscriptionsPending – The number of subscriptions pending confirmation for the topic.
*
*
* -
*
* TopicArn – The topic's ARN.
*
*
* -
*
* TracingConfig – Tracing mode of an Amazon SNS topic. By default
* TracingConfig is set to PassThrough, and the topic passes through the
* tracing header it receives from an Amazon SNS publisher to its subscriptions. If set to
* Active, Amazon SNS will vend X-Ray segment data to topic owner account if the sampled
* flag in the tracing header is true. This is only supported on standard topics.
*
*
*
*
* The following attribute applies only to server-side-encryption:
*
*
* -
*
* KmsMasterKeyId - The ID of an Amazon Web Services 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 Key Management Service API Reference.
*
*
*
*
* The following attributes apply only to FIFO topics:
*
*
* -
*
* ArchivePolicy – The policy that sets the retention period for messages stored in the
* message archive of an Amazon SNS FIFO topic.
*
*
* -
*
* BeginningArchiveTime – The earliest starting point at which a message in the topic’s
* archive can be replayed from. This point in time is based on the configured message retention period
* set by the topic’s message archiving policy.
*
*
* -
*
* ContentBasedDeduplication – Enables content-based deduplication for FIFO topics.
*
*
* -
*
* By default, ContentBasedDeduplication is set to false. If you create a FIFO
* topic and this attribute is false, you must specify a value for the
* MessageDeduplicationId parameter for the Publish action.
*
*
* -
*
* When you set ContentBasedDeduplication to true, Amazon SNS uses a SHA-256
* hash to generate the MessageDeduplicationId using the body of the message (but not the
* attributes of the message).
*
*
* (Optional) To override the generated value, you can specify a value for the
* MessageDeduplicationId parameter for the Publish action.
*
*
*
*
* -
*
* FifoTopic – When this is set to true, a FIFO topic is created.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder attributes(Map attributes);
}
static final class BuilderImpl extends SnsResponse.BuilderImpl implements Builder {
private Map attributes = DefaultSdkAutoConstructMap.getInstance();
private BuilderImpl() {
}
private BuilderImpl(GetTopicAttributesResponse model) {
super(model);
attributes(model.attributes);
}
public final Map getAttributes() {
if (attributes instanceof SdkAutoConstructMap) {
return null;
}
return attributes;
}
public final void setAttributes(Map attributes) {
this.attributes = TopicAttributesMapCopier.copy(attributes);
}
@Override
public final Builder attributes(Map attributes) {
this.attributes = TopicAttributesMapCopier.copy(attributes);
return this;
}
@Override
public GetTopicAttributesResponse build() {
return new GetTopicAttributesResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}