@Generated(value="software.amazon.awssdk:codegen") public final class GetTopicAttributesResponse extends SnsResponse implements ToCopyableBuilder<GetTopicAttributesResponse.Builder,GetTopicAttributesResponse>
Response for GetTopicAttributes action.
Modifier and Type | Class and Description |
---|---|
static interface |
GetTopicAttributesResponse.Builder |
Modifier and Type | Method and Description |
---|---|
Map<String,String> |
attributes()
A map of the topic's attributes.
|
static GetTopicAttributesResponse.Builder |
builder() |
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 GetTopicAttributesResponse.Builder> |
serializableBuilderClass() |
GetTopicAttributesResponse.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
responseMetadata
sdkHttpResponse
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public final boolean hasAttributes()
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 Map<String,String> 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:
FifoTopic
– When this is set to true
, a FIFO topic is created.
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.
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.
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:
FifoTopic
– When this is set to true
, a FIFO topic is created.
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.
public GetTopicAttributesResponse.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<GetTopicAttributesResponse.Builder,GetTopicAttributesResponse>
toBuilder
in class AwsResponse
public static GetTopicAttributesResponse.Builder builder()
public static Class<? extends GetTopicAttributesResponse.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsResponse
public final boolean equals(Object obj)
equals
in class AwsResponse
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField
in class SdkResponse
Copyright © 2023. All rights reserved.