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.

  • Method Details

    • 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 Data Firehose delivery stream subscriptions:

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

        • Permission to write to the Firehose delivery stream

        • Amazon SNS listed as a trusted entity

        Specifying a valid ARN for this attribute is required for Firehose delivery stream subscriptions. For more information, see Fanout to 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 Data Firehose delivery stream subscriptions:

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

        • Permission to write to the Firehose delivery stream

        • Amazon SNS listed as a trusted entity

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

    • toBuilder

      public GetSubscriptionAttributesResponse.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<GetSubscriptionAttributesResponse.Builder,GetSubscriptionAttributesResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.