com.amazonaws.services.sns.model.GetSubscriptionAttributesResult.java Source code

Java tutorial

Introduction

Here is the source code for com.amazonaws.services.sns.model.GetSubscriptionAttributesResult.java

Source

/*
 * Copyright 2014-2019 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;

/**
 * <p>
 * Response for GetSubscriptionAttributes action.
 * </p>
 * 
 * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/GetSubscriptionAttributes" target="_top">AWS API
 *      Documentation</a>
 */
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class GetSubscriptionAttributesResult extends
        com.amazonaws.AmazonWebServiceResult<com.amazonaws.ResponseMetadata> implements Serializable, Cloneable {

    /**
     * <p>
     * A map of the subscription's attributes. Attributes in this map include the following:
     * </p>
     * <ul>
     * <li>
     * <p>
     * <code>ConfirmationWasAuthenticated</code>  <code>true</code> if the subscription confirmation request was
     * authenticated.
     * </p>
     * </li>
     * <li>
     * <p>
     * <code>DeliveryPolicy</code>  The JSON serialization of the subscription's delivery policy.
     * </p>
     * </li>
     * <li>
     * <p>
     * <code>EffectiveDeliveryPolicy</code>  The JSON serialization of the effective delivery policy that takes into
     * account the topic delivery policy and account system defaults.
     * </p>
     * </li>
     * <li>
     * <p>
     * <code>FilterPolicy</code>  The filter policy JSON that is assigned to the subscription.
     * </p>
     * </li>
     * <li>
     * <p>
     * <code>Owner</code>  The AWS account ID of the subscription's owner.
     * </p>
     * </li>
     * <li>
     * <p>
     * <code>PendingConfirmation</code>  <code>true</code> if the subscription hasn't been confirmed. To confirm a
     * pending subscription, call the <code>ConfirmSubscription</code> action with a confirmation token.
     * </p>
     * </li>
     * <li>
     * <p>
     * <code>RawMessageDelivery</code>  <code>true</code> 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.
     * </p>
     * </li>
     * <li>
     * <p>
     * <code>RedrivePolicy</code>  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.
     * </p>
     * </li>
     * <li>
     * <p>
     * <code>SubscriptionArn</code>  The subscription's ARN.
     * </p>
     * </li>
     * <li>
     * <p>
     * <code>TopicArn</code>  The topic ARN that the subscription is associated with.
     * </p>
     * </li>
     * </ul>
     */
    private com.amazonaws.internal.SdkInternalMap<String, String> attributes;

    /**
     * <p>
     * A map of the subscription's attributes. Attributes in this map include the following:
     * </p>
     * <ul>
     * <li>
     * <p>
     * <code>ConfirmationWasAuthenticated</code>  <code>true</code> if the subscription confirmation request was
     * authenticated.
     * </p>
     * </li>
     * <li>
     * <p>
     * <code>DeliveryPolicy</code>  The JSON serialization of the subscription's delivery policy.
     * </p>
     * </li>
     * <li>
     * <p>
     * <code>EffectiveDeliveryPolicy</code>  The JSON serialization of the effective delivery policy that takes into
     * account the topic delivery policy and account system defaults.
     * </p>
     * </li>
     * <li>
     * <p>
     * <code>FilterPolicy</code>  The filter policy JSON that is assigned to the subscription.
     * </p>
     * </li>
     * <li>
     * <p>
     * <code>Owner</code>  The AWS account ID of the subscription's owner.
     * </p>
     * </li>
     * <li>
     * <p>
     * <code>PendingConfirmation</code>  <code>true</code> if the subscription hasn't been confirmed. To confirm a
     * pending subscription, call the <code>ConfirmSubscription</code> action with a confirmation token.
     * </p>
     * </li>
     * <li>
     * <p>
     * <code>RawMessageDelivery</code>  <code>true</code> 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.
     * </p>
     * </li>
     * <li>
     * <p>
     * <code>RedrivePolicy</code>  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.
     * </p>
     * </li>
     * <li>
     * <p>
     * <code>SubscriptionArn</code>  The subscription's ARN.
     * </p>
     * </li>
     * <li>
     * <p>
     * <code>TopicArn</code>  The topic ARN that the subscription is associated with.
     * </p>
     * </li>
     * </ul>
     * 
     * @return A map of the subscription's attributes. Attributes in this map include the following:</p>
     *         <ul>
     *         <li>
     *         <p>
     *         <code>ConfirmationWasAuthenticated</code>  <code>true</code> if the subscription confirmation request
     *         was authenticated.
     *         </p>
     *         </li>
     *         <li>
     *         <p>
     *         <code>DeliveryPolicy</code>  The JSON serialization of the subscription's delivery policy.
     *         </p>
     *         </li>
     *         <li>
     *         <p>
     *         <code>EffectiveDeliveryPolicy</code>  The JSON serialization of the effective delivery policy that takes
     *         into account the topic delivery policy and account system defaults.
     *         </p>
     *         </li>
     *         <li>
     *         <p>
     *         <code>FilterPolicy</code>  The filter policy JSON that is assigned to the subscription.
     *         </p>
     *         </li>
     *         <li>
     *         <p>
     *         <code>Owner</code>  The AWS account ID of the subscription's owner.
     *         </p>
     *         </li>
     *         <li>
     *         <p>
     *         <code>PendingConfirmation</code>  <code>true</code> if the subscription hasn't been confirmed. To
     *         confirm a pending subscription, call the <code>ConfirmSubscription</code> action with a confirmation
     *         token.
     *         </p>
     *         </li>
     *         <li>
     *         <p>
     *         <code>RawMessageDelivery</code>  <code>true</code> 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.
     *         </p>
     *         </li>
     *         <li>
     *         <p>
     *         <code>RedrivePolicy</code>  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.
     *         </p>
     *         </li>
     *         <li>
     *         <p>
     *         <code>SubscriptionArn</code>  The subscription's ARN.
     *         </p>
     *         </li>
     *         <li>
     *         <p>
     *         <code>TopicArn</code>  The topic ARN that the subscription is associated with.
     *         </p>
     *         </li>
     */

    public java.util.Map<String, String> getAttributes() {
        if (attributes == null) {
            attributes = new com.amazonaws.internal.SdkInternalMap<String, String>();
        }
        return attributes;
    }

    /**
     * <p>
     * A map of the subscription's attributes. Attributes in this map include the following:
     * </p>
     * <ul>
     * <li>
     * <p>
     * <code>ConfirmationWasAuthenticated</code>  <code>true</code> if the subscription confirmation request was
     * authenticated.
     * </p>
     * </li>
     * <li>
     * <p>
     * <code>DeliveryPolicy</code>  The JSON serialization of the subscription's delivery policy.
     * </p>
     * </li>
     * <li>
     * <p>
     * <code>EffectiveDeliveryPolicy</code>  The JSON serialization of the effective delivery policy that takes into
     * account the topic delivery policy and account system defaults.
     * </p>
     * </li>
     * <li>
     * <p>
     * <code>FilterPolicy</code>  The filter policy JSON that is assigned to the subscription.
     * </p>
     * </li>
     * <li>
     * <p>
     * <code>Owner</code>  The AWS account ID of the subscription's owner.
     * </p>
     * </li>
     * <li>
     * <p>
     * <code>PendingConfirmation</code>  <code>true</code> if the subscription hasn't been confirmed. To confirm a
     * pending subscription, call the <code>ConfirmSubscription</code> action with a confirmation token.
     * </p>
     * </li>
     * <li>
     * <p>
     * <code>RawMessageDelivery</code>  <code>true</code> 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.
     * </p>
     * </li>
     * <li>
     * <p>
     * <code>RedrivePolicy</code>  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.
     * </p>
     * </li>
     * <li>
     * <p>
     * <code>SubscriptionArn</code>  The subscription's ARN.
     * </p>
     * </li>
     * <li>
     * <p>
     * <code>TopicArn</code>  The topic ARN that the subscription is associated with.
     * </p>
     * </li>
     * </ul>
     * 
     * @param attributes
     *        A map of the subscription's attributes. Attributes in this map include the following:</p>
     *        <ul>
     *        <li>
     *        <p>
     *        <code>ConfirmationWasAuthenticated</code>  <code>true</code> if the subscription confirmation request was
     *        authenticated.
     *        </p>
     *        </li>
     *        <li>
     *        <p>
     *        <code>DeliveryPolicy</code>  The JSON serialization of the subscription's delivery policy.
     *        </p>
     *        </li>
     *        <li>
     *        <p>
     *        <code>EffectiveDeliveryPolicy</code>  The JSON serialization of the effective delivery policy that takes
     *        into account the topic delivery policy and account system defaults.
     *        </p>
     *        </li>
     *        <li>
     *        <p>
     *        <code>FilterPolicy</code>  The filter policy JSON that is assigned to the subscription.
     *        </p>
     *        </li>
     *        <li>
     *        <p>
     *        <code>Owner</code>  The AWS account ID of the subscription's owner.
     *        </p>
     *        </li>
     *        <li>
     *        <p>
     *        <code>PendingConfirmation</code>  <code>true</code> if the subscription hasn't been confirmed. To confirm
     *        a pending subscription, call the <code>ConfirmSubscription</code> action with a confirmation token.
     *        </p>
     *        </li>
     *        <li>
     *        <p>
     *        <code>RawMessageDelivery</code>  <code>true</code> 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.
     *        </p>
     *        </li>
     *        <li>
     *        <p>
     *        <code>RedrivePolicy</code>  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.
     *        </p>
     *        </li>
     *        <li>
     *        <p>
     *        <code>SubscriptionArn</code>  The subscription's ARN.
     *        </p>
     *        </li>
     *        <li>
     *        <p>
     *        <code>TopicArn</code>  The topic ARN that the subscription is associated with.
     *        </p>
     *        </li>
     */

    public void setAttributes(java.util.Map<String, String> attributes) {
        this.attributes = attributes == null ? null
                : new com.amazonaws.internal.SdkInternalMap<String, String>(attributes);
    }

    /**
     * <p>
     * A map of the subscription's attributes. Attributes in this map include the following:
     * </p>
     * <ul>
     * <li>
     * <p>
     * <code>ConfirmationWasAuthenticated</code>  <code>true</code> if the subscription confirmation request was
     * authenticated.
     * </p>
     * </li>
     * <li>
     * <p>
     * <code>DeliveryPolicy</code>  The JSON serialization of the subscription's delivery policy.
     * </p>
     * </li>
     * <li>
     * <p>
     * <code>EffectiveDeliveryPolicy</code>  The JSON serialization of the effective delivery policy that takes into
     * account the topic delivery policy and account system defaults.
     * </p>
     * </li>
     * <li>
     * <p>
     * <code>FilterPolicy</code>  The filter policy JSON that is assigned to the subscription.
     * </p>
     * </li>
     * <li>
     * <p>
     * <code>Owner</code>  The AWS account ID of the subscription's owner.
     * </p>
     * </li>
     * <li>
     * <p>
     * <code>PendingConfirmation</code>  <code>true</code> if the subscription hasn't been confirmed. To confirm a
     * pending subscription, call the <code>ConfirmSubscription</code> action with a confirmation token.
     * </p>
     * </li>
     * <li>
     * <p>
     * <code>RawMessageDelivery</code>  <code>true</code> 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.
     * </p>
     * </li>
     * <li>
     * <p>
     * <code>RedrivePolicy</code>  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.
     * </p>
     * </li>
     * <li>
     * <p>
     * <code>SubscriptionArn</code>  The subscription's ARN.
     * </p>
     * </li>
     * <li>
     * <p>
     * <code>TopicArn</code>  The topic ARN that the subscription is associated with.
     * </p>
     * </li>
     * </ul>
     * 
     * @param attributes
     *        A map of the subscription's attributes. Attributes in this map include the following:</p>
     *        <ul>
     *        <li>
     *        <p>
     *        <code>ConfirmationWasAuthenticated</code>  <code>true</code> if the subscription confirmation request was
     *        authenticated.
     *        </p>
     *        </li>
     *        <li>
     *        <p>
     *        <code>DeliveryPolicy</code>  The JSON serialization of the subscription's delivery policy.
     *        </p>
     *        </li>
     *        <li>
     *        <p>
     *        <code>EffectiveDeliveryPolicy</code>  The JSON serialization of the effective delivery policy that takes
     *        into account the topic delivery policy and account system defaults.
     *        </p>
     *        </li>
     *        <li>
     *        <p>
     *        <code>FilterPolicy</code>  The filter policy JSON that is assigned to the subscription.
     *        </p>
     *        </li>
     *        <li>
     *        <p>
     *        <code>Owner</code>  The AWS account ID of the subscription's owner.
     *        </p>
     *        </li>
     *        <li>
     *        <p>
     *        <code>PendingConfirmation</code>  <code>true</code> if the subscription hasn't been confirmed. To confirm
     *        a pending subscription, call the <code>ConfirmSubscription</code> action with a confirmation token.
     *        </p>
     *        </li>
     *        <li>
     *        <p>
     *        <code>RawMessageDelivery</code>  <code>true</code> 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.
     *        </p>
     *        </li>
     *        <li>
     *        <p>
     *        <code>RedrivePolicy</code>  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.
     *        </p>
     *        </li>
     *        <li>
     *        <p>
     *        <code>SubscriptionArn</code>  The subscription's ARN.
     *        </p>
     *        </li>
     *        <li>
     *        <p>
     *        <code>TopicArn</code>  The topic ARN that the subscription is associated with.
     *        </p>
     *        </li>
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public GetSubscriptionAttributesResult withAttributes(java.util.Map<String, String> attributes) {
        setAttributes(attributes);
        return this;
    }

    public GetSubscriptionAttributesResult addAttributesEntry(String key, String value) {
        if (null == this.attributes) {
            this.attributes = new com.amazonaws.internal.SdkInternalMap<String, String>();
        }
        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);
        }
    }

}