Java tutorial
/* * 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 GetTopicAttributes action. * </p> * * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/GetTopicAttributes" target="_top">AWS API * Documentation</a> */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class GetTopicAttributesResult extends com.amazonaws.AmazonWebServiceResult<com.amazonaws.ResponseMetadata> implements Serializable, Cloneable { /** * <p> * A map of the topic's attributes. Attributes in this map include the following: * </p> * <ul> * <li> * <p> * <code>DeliveryPolicy</code> The JSON serialization of the topic's delivery policy. * </p> * </li> * <li> * <p> * <code>DisplayName</code> The human-readable name used in the <code>From</code> field for notifications to * <code>email</code> and <code>email-json</code> endpoints. * </p> * </li> * <li> * <p> * <code>Owner</code> The AWS account ID of the topic's owner. * </p> * </li> * <li> * <p> * <code>Policy</code> The JSON serialization of the topic's access control policy. * </p> * </li> * <li> * <p> * <code>SubscriptionsConfirmed</code> The number of confirmed subscriptions for the topic. * </p> * </li> * <li> * <p> * <code>SubscriptionsDeleted</code> The number of deleted subscriptions for the topic. * </p> * </li> * <li> * <p> * <code>SubscriptionsPending</code> The number of subscriptions pending confirmation for the topic. * </p> * </li> * <li> * <p> * <code>TopicArn</code> The topic's ARN. * </p> * </li> * <li> * <p> * <code>EffectiveDeliveryPolicy</code> Yhe JSON serialization of the effective delivery policy, taking system * defaults into account. * </p> * </li> * </ul> * <p> * The following attribute applies only to <a * href="https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html">server-side-encryption</a>: * </p> * <ul> * <li> * <p> * <code>KmsMasterKeyId</code> - The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK. * For more information, see <a * href="https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms">Key Terms</a>. For * more examples, see <a href= * "https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters" * >KeyId</a> in the <i>AWS Key Management Service API Reference</i>. * </p> * </li> * </ul> */ private com.amazonaws.internal.SdkInternalMap<String, String> attributes; /** * <p> * A map of the topic's attributes. Attributes in this map include the following: * </p> * <ul> * <li> * <p> * <code>DeliveryPolicy</code> The JSON serialization of the topic's delivery policy. * </p> * </li> * <li> * <p> * <code>DisplayName</code> The human-readable name used in the <code>From</code> field for notifications to * <code>email</code> and <code>email-json</code> endpoints. * </p> * </li> * <li> * <p> * <code>Owner</code> The AWS account ID of the topic's owner. * </p> * </li> * <li> * <p> * <code>Policy</code> The JSON serialization of the topic's access control policy. * </p> * </li> * <li> * <p> * <code>SubscriptionsConfirmed</code> The number of confirmed subscriptions for the topic. * </p> * </li> * <li> * <p> * <code>SubscriptionsDeleted</code> The number of deleted subscriptions for the topic. * </p> * </li> * <li> * <p> * <code>SubscriptionsPending</code> The number of subscriptions pending confirmation for the topic. * </p> * </li> * <li> * <p> * <code>TopicArn</code> The topic's ARN. * </p> * </li> * <li> * <p> * <code>EffectiveDeliveryPolicy</code> Yhe JSON serialization of the effective delivery policy, taking system * defaults into account. * </p> * </li> * </ul> * <p> * The following attribute applies only to <a * href="https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html">server-side-encryption</a>: * </p> * <ul> * <li> * <p> * <code>KmsMasterKeyId</code> - The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK. * For more information, see <a * href="https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms">Key Terms</a>. For * more examples, see <a href= * "https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters" * >KeyId</a> in the <i>AWS Key Management Service API Reference</i>. * </p> * </li> * </ul> * * @return A map of the topic's attributes. Attributes in this map include the following:</p> * <ul> * <li> * <p> * <code>DeliveryPolicy</code> The JSON serialization of the topic's delivery policy. * </p> * </li> * <li> * <p> * <code>DisplayName</code> The human-readable name used in the <code>From</code> field for notifications * to <code>email</code> and <code>email-json</code> endpoints. * </p> * </li> * <li> * <p> * <code>Owner</code> The AWS account ID of the topic's owner. * </p> * </li> * <li> * <p> * <code>Policy</code> The JSON serialization of the topic's access control policy. * </p> * </li> * <li> * <p> * <code>SubscriptionsConfirmed</code> The number of confirmed subscriptions for the topic. * </p> * </li> * <li> * <p> * <code>SubscriptionsDeleted</code> The number of deleted subscriptions for the topic. * </p> * </li> * <li> * <p> * <code>SubscriptionsPending</code> The number of subscriptions pending confirmation for the topic. * </p> * </li> * <li> * <p> * <code>TopicArn</code> The topic's ARN. * </p> * </li> * <li> * <p> * <code>EffectiveDeliveryPolicy</code> Yhe JSON serialization of the effective delivery policy, taking * system defaults into account. * </p> * </li> * </ul> * <p> * The following attribute applies only to <a * href="https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html" * >server-side-encryption</a>: * </p> * <ul> * <li> * <p> * <code>KmsMasterKeyId</code> - The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a * custom CMK. For more information, see <a * href="https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms">Key * Terms</a>. For more examples, see <a href= * "https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters" * >KeyId</a> in the <i>AWS Key Management Service API Reference</i>. * </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 topic's attributes. Attributes in this map include the following: * </p> * <ul> * <li> * <p> * <code>DeliveryPolicy</code> The JSON serialization of the topic's delivery policy. * </p> * </li> * <li> * <p> * <code>DisplayName</code> The human-readable name used in the <code>From</code> field for notifications to * <code>email</code> and <code>email-json</code> endpoints. * </p> * </li> * <li> * <p> * <code>Owner</code> The AWS account ID of the topic's owner. * </p> * </li> * <li> * <p> * <code>Policy</code> The JSON serialization of the topic's access control policy. * </p> * </li> * <li> * <p> * <code>SubscriptionsConfirmed</code> The number of confirmed subscriptions for the topic. * </p> * </li> * <li> * <p> * <code>SubscriptionsDeleted</code> The number of deleted subscriptions for the topic. * </p> * </li> * <li> * <p> * <code>SubscriptionsPending</code> The number of subscriptions pending confirmation for the topic. * </p> * </li> * <li> * <p> * <code>TopicArn</code> The topic's ARN. * </p> * </li> * <li> * <p> * <code>EffectiveDeliveryPolicy</code> Yhe JSON serialization of the effective delivery policy, taking system * defaults into account. * </p> * </li> * </ul> * <p> * The following attribute applies only to <a * href="https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html">server-side-encryption</a>: * </p> * <ul> * <li> * <p> * <code>KmsMasterKeyId</code> - The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK. * For more information, see <a * href="https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms">Key Terms</a>. For * more examples, see <a href= * "https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters" * >KeyId</a> in the <i>AWS Key Management Service API Reference</i>. * </p> * </li> * </ul> * * @param attributes * A map of the topic's attributes. Attributes in this map include the following:</p> * <ul> * <li> * <p> * <code>DeliveryPolicy</code> The JSON serialization of the topic's delivery policy. * </p> * </li> * <li> * <p> * <code>DisplayName</code> The human-readable name used in the <code>From</code> field for notifications * to <code>email</code> and <code>email-json</code> endpoints. * </p> * </li> * <li> * <p> * <code>Owner</code> The AWS account ID of the topic's owner. * </p> * </li> * <li> * <p> * <code>Policy</code> The JSON serialization of the topic's access control policy. * </p> * </li> * <li> * <p> * <code>SubscriptionsConfirmed</code> The number of confirmed subscriptions for the topic. * </p> * </li> * <li> * <p> * <code>SubscriptionsDeleted</code> The number of deleted subscriptions for the topic. * </p> * </li> * <li> * <p> * <code>SubscriptionsPending</code> The number of subscriptions pending confirmation for the topic. * </p> * </li> * <li> * <p> * <code>TopicArn</code> The topic's ARN. * </p> * </li> * <li> * <p> * <code>EffectiveDeliveryPolicy</code> Yhe JSON serialization of the effective delivery policy, taking * system defaults into account. * </p> * </li> * </ul> * <p> * The following attribute applies only to <a * href="https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html" * >server-side-encryption</a>: * </p> * <ul> * <li> * <p> * <code>KmsMasterKeyId</code> - The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a * custom CMK. For more information, see <a * href="https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms">Key * Terms</a>. For more examples, see <a href= * "https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters" * >KeyId</a> in the <i>AWS Key Management Service API Reference</i>. * </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 topic's attributes. Attributes in this map include the following: * </p> * <ul> * <li> * <p> * <code>DeliveryPolicy</code> The JSON serialization of the topic's delivery policy. * </p> * </li> * <li> * <p> * <code>DisplayName</code> The human-readable name used in the <code>From</code> field for notifications to * <code>email</code> and <code>email-json</code> endpoints. * </p> * </li> * <li> * <p> * <code>Owner</code> The AWS account ID of the topic's owner. * </p> * </li> * <li> * <p> * <code>Policy</code> The JSON serialization of the topic's access control policy. * </p> * </li> * <li> * <p> * <code>SubscriptionsConfirmed</code> The number of confirmed subscriptions for the topic. * </p> * </li> * <li> * <p> * <code>SubscriptionsDeleted</code> The number of deleted subscriptions for the topic. * </p> * </li> * <li> * <p> * <code>SubscriptionsPending</code> The number of subscriptions pending confirmation for the topic. * </p> * </li> * <li> * <p> * <code>TopicArn</code> The topic's ARN. * </p> * </li> * <li> * <p> * <code>EffectiveDeliveryPolicy</code> Yhe JSON serialization of the effective delivery policy, taking system * defaults into account. * </p> * </li> * </ul> * <p> * The following attribute applies only to <a * href="https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html">server-side-encryption</a>: * </p> * <ul> * <li> * <p> * <code>KmsMasterKeyId</code> - The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK. * For more information, see <a * href="https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms">Key Terms</a>. For * more examples, see <a href= * "https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters" * >KeyId</a> in the <i>AWS Key Management Service API Reference</i>. * </p> * </li> * </ul> * * @param attributes * A map of the topic's attributes. Attributes in this map include the following:</p> * <ul> * <li> * <p> * <code>DeliveryPolicy</code> The JSON serialization of the topic's delivery policy. * </p> * </li> * <li> * <p> * <code>DisplayName</code> The human-readable name used in the <code>From</code> field for notifications * to <code>email</code> and <code>email-json</code> endpoints. * </p> * </li> * <li> * <p> * <code>Owner</code> The AWS account ID of the topic's owner. * </p> * </li> * <li> * <p> * <code>Policy</code> The JSON serialization of the topic's access control policy. * </p> * </li> * <li> * <p> * <code>SubscriptionsConfirmed</code> The number of confirmed subscriptions for the topic. * </p> * </li> * <li> * <p> * <code>SubscriptionsDeleted</code> The number of deleted subscriptions for the topic. * </p> * </li> * <li> * <p> * <code>SubscriptionsPending</code> The number of subscriptions pending confirmation for the topic. * </p> * </li> * <li> * <p> * <code>TopicArn</code> The topic's ARN. * </p> * </li> * <li> * <p> * <code>EffectiveDeliveryPolicy</code> Yhe JSON serialization of the effective delivery policy, taking * system defaults into account. * </p> * </li> * </ul> * <p> * The following attribute applies only to <a * href="https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html" * >server-side-encryption</a>: * </p> * <ul> * <li> * <p> * <code>KmsMasterKeyId</code> - The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a * custom CMK. For more information, see <a * href="https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms">Key * Terms</a>. For more examples, see <a href= * "https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters" * >KeyId</a> in the <i>AWS Key Management Service API Reference</i>. * </p> * </li> * @return Returns a reference to this object so that method calls can be chained together. */ public GetTopicAttributesResult withAttributes(java.util.Map<String, String> attributes) { setAttributes(attributes); return this; } public GetTopicAttributesResult 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 GetTopicAttributesResult 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 GetTopicAttributesResult == false) return false; GetTopicAttributesResult other = (GetTopicAttributesResult) 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 GetTopicAttributesResult clone() { try { return (GetTopicAttributesResult) super.clone(); } catch (CloneNotSupportedException e) { throw new IllegalStateException( "Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e); } } }