com.amazonaws.services.sns.model.GetSubscriptionAttributesResult Maven / Gradle / Ivy
Show all versions of aws-java-sdk-sns Show documentation
/*
* Copyright 2019-2024 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 com.amazonaws.services.sns.model;
import java.io.Serializable;
import javax.annotation.Generated;
/**
*
* Response for GetSubscriptionAttributes action.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class GetSubscriptionAttributesResult extends com.amazonaws.AmazonWebServiceResult implements Serializable, Cloneable {
/**
*
* 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.
*
*
*
*/
private com.amazonaws.internal.SdkInternalMap 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.
*
*
*
*
* @return 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.
*
*
*/
public java.util.Map getAttributes() {
if (attributes == null) {
attributes = new com.amazonaws.internal.SdkInternalMap();
}
return 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.
*
*
*
*
* @param 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.
*
*
*/
public void setAttributes(java.util.Map attributes) {
this.attributes = attributes == null ? null : new com.amazonaws.internal.SdkInternalMap(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.
*
*
*
*
* @param 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetSubscriptionAttributesResult withAttributes(java.util.Map attributes) {
setAttributes(attributes);
return this;
}
/**
* Add a single Attributes entry
*
* @see GetSubscriptionAttributesResult#withAttributes
* @returns a reference to this object so that method calls can be chained together.
*/
public GetSubscriptionAttributesResult addAttributesEntry(String key, String value) {
if (null == this.attributes) {
this.attributes = new com.amazonaws.internal.SdkInternalMap();
}
if (this.attributes.containsKey(key))
throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
this.attributes.put(key, value);
return this;
}
/**
* Removes all the entries added into Attributes.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetSubscriptionAttributesResult clearAttributesEntries() {
this.attributes = null;
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getAttributes() != null)
sb.append("Attributes: ").append(getAttributes());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof GetSubscriptionAttributesResult == false)
return false;
GetSubscriptionAttributesResult other = (GetSubscriptionAttributesResult) obj;
if (other.getAttributes() == null ^ this.getAttributes() == null)
return false;
if (other.getAttributes() != null && other.getAttributes().equals(this.getAttributes()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getAttributes() == null) ? 0 : getAttributes().hashCode());
return hashCode;
}
@Override
public GetSubscriptionAttributesResult clone() {
try {
return (GetSubscriptionAttributesResult) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}