@Generated(value="software.amazon.awssdk:codegen") public final class GetSubscriptionAttributesResponse extends SnsResponse implements ToCopyableBuilder<GetSubscriptionAttributesResponse.Builder,GetSubscriptionAttributesResponse>
Response for GetSubscriptionAttributes action.
Modifier and Type | Class and Description |
---|---|
static interface |
GetSubscriptionAttributesResponse.Builder |
Modifier and Type | Method and Description |
---|---|
Map<String,String> |
attributes()
A map of the subscription's attributes.
|
static GetSubscriptionAttributesResponse.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkResponse . |
boolean |
hasAttributes()
Returns true if the Attributes property was specified by the sender (it may be empty), or false if the sender did
not specify the value (it will be empty).
|
int |
hashCode() |
List<SdkField<?>> |
sdkFields() |
static Class<? extends GetSubscriptionAttributesResponse.Builder> |
serializableBuilderClass() |
GetSubscriptionAttributesResponse.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
responseMetadata
sdkHttpResponse
copy
public final boolean hasAttributes()
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.
Owner
– The AWS 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.
You can use hasAttributes()
to see if a value was sent in this field.
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.
Owner
– The AWS 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.
public GetSubscriptionAttributesResponse.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<GetSubscriptionAttributesResponse.Builder,GetSubscriptionAttributesResponse>
toBuilder
in class AwsResponse
public static GetSubscriptionAttributesResponse.Builder builder()
public static Class<? extends GetSubscriptionAttributesResponse.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)
SdkPojo
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.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkResponse
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.getValueForField
in class SdkResponse
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.