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

Class GetSubscriptionAttributesResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.sns.model.SnsResponse

software.amazon.awssdk.services.sns.model.GetSubscriptionAttributesResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetSubscriptionAttributesResponse.Builder,GetSubscriptionAttributesResponse>

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

Response for GetSubscriptionAttributes action.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetSubscriptionAttributesResponse.Builder

Method Summary

Modifier and Type	Method	Description
Map<String,String>	attributes()	A map of the subscription's attributes.
static GetSubscriptionAttributesResponse.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 GetSubscriptionAttributesResponse.Builder>	serializableBuilderClass()
GetSubscriptionAttributesResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.sns.model.SnsResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

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 subscription's attributes. Attributes in this map include the following:

• ConfirmationWasAuthenticated – true if the subscription confirmation request was authenticated.

• DeliveryPolicy – The JSON serialization of the subscription's delivery policy.

• EffectiveDeliveryPolicy – The JSON serialization of the effective delivery policy that takes into account the topic delivery policy and account system defaults.

• FilterPolicy – The filter policy JSON that is assigned to the subscription. For more information, see Amazon SNS Message Filtering in the Amazon SNS Developer Guide.

• FilterPolicyScope – This attribute lets you choose the filtering scope by using one of the following string value types:

  • MessageAttributes (default) – The filter is applied on the message attributes.

  • MessageBody – The filter is applied on the message body.

• Owner – The Amazon Web Services account ID of the subscription's owner.

• PendingConfirmation – true if the subscription hasn't been confirmed. To confirm a pending subscription, call the ConfirmSubscription action with a confirmation token.

• RawMessageDelivery – true if raw message delivery is enabled for the subscription. Raw messages are free of JSON formatting and can be sent to HTTP/S and Amazon SQS endpoints.

• RedrivePolicy – When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.

• SubscriptionArn – The subscription's ARN.

• TopicArn – The topic ARN that the subscription is associated with.

The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:

• SubscriptionRoleArn – The ARN of the IAM role that has the following:

  • Permission to write to the Kinesis Data Firehose delivery stream

  • Amazon SNS listed as a trusted entity

  Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions. For more information, see Fanout to Kinesis Data Firehose delivery streams in the Amazon SNS Developer Guide.

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 subscription's attributes. Attributes in this map include the following:

• ConfirmationWasAuthenticated – true if the subscription confirmation request was authenticated.

• DeliveryPolicy – The JSON serialization of the subscription's delivery policy.

• EffectiveDeliveryPolicy – The JSON serialization of the effective delivery policy that takes into account the topic delivery policy and account system defaults.

• FilterPolicy – The filter policy JSON that is assigned to the subscription. For more information, see Amazon SNS Message Filtering in the Amazon SNS Developer Guide.

• FilterPolicyScope – This attribute lets you choose the filtering scope by using one of the following string value types:

  • MessageAttributes (default) – The filter is applied on the message attributes.

  • MessageBody – The filter is applied on the message body.

• Owner – The Amazon Web Services account ID of the subscription's owner.

• PendingConfirmation – true if the subscription hasn't been confirmed. To confirm a pending subscription, call the ConfirmSubscription action with a confirmation token.

• RawMessageDelivery – true if raw message delivery is enabled for the subscription. Raw messages are free of JSON formatting and can be sent to HTTP/S and Amazon SQS endpoints.

• RedrivePolicy – When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.

• SubscriptionArn – The subscription's ARN.

• TopicArn – The topic ARN that the subscription is associated with.

The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:

• SubscriptionRoleArn – The ARN of the IAM role that has the following:

  • Permission to write to the Kinesis Data Firehose delivery stream

  • Amazon SNS listed as a trusted entity

  Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions. For more information, see Fanout to Kinesis Data Firehose delivery streams in the Amazon SNS Developer Guide.

toBuilder

public GetSubscriptionAttributesResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetSubscriptionAttributesResponse.Builder,GetSubscriptionAttributesResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static GetSubscriptionAttributesResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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 SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo