/* * Copyright 2010-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.sqs.model; import java.io.Serializable; import com.amazonaws.AmazonWebServiceRequest; /** *

* Adds a permission to a queue for a specific principal. This allows for sharing access to the queue. *

* When you create a queue, you have full control access rights for the queue. * Only you (as owner of the queue) can grant or deny permissions to the queue. * For more information about these permissions, see Shared Queues in the Amazon SQS Developer Guide. *

* *

* AddPermission writes an Amazon SQS-generated policy. If you want * to write your own policy, use SetQueueAttributes to upload your * policy. For more information about writing your own policy, see Using The Access Policy Language in the Amazon SQS Developer * Guide. *

* *

* Some API actions take lists of parameters. These lists are specified using * the param.n notation. Values of n are integers * starting from 1. For example, a parameter list with two elements looks like * this: *

* *

* &Attribute.1=this *

* &Attribute.2=that *

*/ public class AddPermissionRequest extends AmazonWebServiceRequest implements Serializable { /** *

* The URL of the Amazon SQS queue to take action on. *

* Queue URLs are case-sensitive. *

*/ private String queueUrl; /** *

* The unique identification of the permission you're setting (e.g., * AliceSendMessage). Constraints: Maximum 80 characters; * alphanumeric characters, hyphens (-), and underscores (_) are allowed. *

*/ private String label; /** *

* The AWS account number of the principal who will be given permission. The principal must have an * AWS account, but does not need to be signed up for Amazon SQS. For * information about locating the AWS account identification, see Your AWS Identifiers in the Amazon SQS Developer Guide. *

*/ private java.util.List aWSAccountIds = new java.util.ArrayList(); /** *

* The action the client wants to allow for the specified principal. The * following are valid values: * * | SendMessage | ReceiveMessage | DeleteMessage | ChangeMessageVisibility | GetQueueAttributes | GetQueueUrl * . For more information about these actions, see Understanding Permissions in the Amazon SQS Developer Guide. *

* Specifying SendMessage, DeleteMessage, or * ChangeMessageVisibility for the ActionName.n * also grants permissions for the corresponding batch versions of those * actions: SendMessageBatch, DeleteMessageBatch, * and ChangeMessageVisibilityBatch. *

*/ private java.util.List actions = new java.util.ArrayList(); /** * Default constructor for AddPermissionRequest object. Callers should use * the setter or fluent setter (with...) methods to initialize any * additional object members. */ public AddPermissionRequest() { } /** * Constructs a new AddPermissionRequest object. Callers should use the * setter or fluent setter (with...) methods to initialize any additional * object members. * * @param queueUrl

* The URL of the Amazon SQS queue to take action on. *

* Queue URLs are case-sensitive. *

* @param label

* The unique identification of the permission you're setting * (e.g., AliceSendMessage). Constraints: Maximum 80 * characters; alphanumeric characters, hyphens (-), and * underscores (_) are allowed. *

* @param aWSAccountIds

* The AWS account number of the principal who will be given permission. The principal * must have an AWS account, but does not need to be signed up * for Amazon SQS. For information about locating the AWS account * identification, see Your AWS Identifiers in the Amazon SQS Developer * Guide. *

* @param actions

* The action the client wants to allow for the specified * principal. The following are valid values: * * | SendMessage | ReceiveMessage | DeleteMessage | ChangeMessageVisibility | GetQueueAttributes | GetQueueUrl * . For more information about these actions, see Understanding Permissions in the Amazon SQS Developer * Guide. *

* Specifying SendMessage, * DeleteMessage, or * ChangeMessageVisibility for the * ActionName.n also grants permissions for the * corresponding batch versions of those actions: * SendMessageBatch, DeleteMessageBatch * , and ChangeMessageVisibilityBatch. *

*/ public AddPermissionRequest(String queueUrl, String label, java.util.List aWSAccountIds, java.util.List actions) { setQueueUrl(queueUrl); setLabel(label); setAWSAccountIds(aWSAccountIds); setActions(actions); } /** *

* The URL of the Amazon SQS queue to take action on. *

* Queue URLs are case-sensitive. *

* * @return

* The URL of the Amazon SQS queue to take action on. *

* Queue URLs are case-sensitive. *

*/ public String getQueueUrl() { return queueUrl; } /** *

* The URL of the Amazon SQS queue to take action on. *

* Queue URLs are case-sensitive. *

* * @param queueUrl

* The URL of the Amazon SQS queue to take action on. *

* Queue URLs are case-sensitive. *

*/ public void setQueueUrl(String queueUrl) { this.queueUrl = queueUrl; } /** *

* The URL of the Amazon SQS queue to take action on. *

* Queue URLs are case-sensitive. *

* Returns a reference to this object so that method calls can be chained * together. * * @param queueUrl

* The URL of the Amazon SQS queue to take action on. *

* Queue URLs are case-sensitive. *

* @return A reference to this updated object so that method calls can be * chained together. */ public AddPermissionRequest withQueueUrl(String queueUrl) { this.queueUrl = queueUrl; return this; } /** *

* * @return

* The unique identification of the permission you're setting (e.g., * AliceSendMessage). Constraints: Maximum 80 * characters; alphanumeric characters, hyphens (-), and underscores * (_) are allowed. *

*/ public String getLabel() { return label; } /** *

* * @param label

*/ public void setLabel(String label) { this.label = label; } /** *

* Returns a reference to this object so that method calls can be chained * together. * * @param label

* @return A reference to this updated object so that method calls can be * chained together. */ public AddPermissionRequest withLabel(String label) { this.label = label; return this; } /** *

* * @return

* The AWS account number of the principal who will be given permission. The principal must * have an AWS account, but does not need to be signed up for Amazon * SQS. For information about locating the AWS account * identification, see Your AWS Identifiers in the Amazon SQS Developer * Guide. *

*/ public java.util.List getAWSAccountIds() { return aWSAccountIds; } /** *

* * @param aWSAccountIds

*/ public void setAWSAccountIds(java.util.Collection aWSAccountIds) { if (aWSAccountIds == null) { this.aWSAccountIds = null; return; } this.aWSAccountIds = new java.util.ArrayList(aWSAccountIds); } /** *

* Returns a reference to this object so that method calls can be chained * together. * * @param aWSAccountIds

* @return A reference to this updated object so that method calls can be * chained together. */ public AddPermissionRequest withAWSAccountIds(String... aWSAccountIds) { if (getAWSAccountIds() == null) { this.aWSAccountIds = new java.util.ArrayList(aWSAccountIds.length); } for (String value : aWSAccountIds) { this.aWSAccountIds.add(value); } return this; } /** *

* Returns a reference to this object so that method calls can be chained * together. * * @param aWSAccountIds

* @return A reference to this updated object so that method calls can be * chained together. */ public AddPermissionRequest withAWSAccountIds(java.util.Collection aWSAccountIds) { setAWSAccountIds(aWSAccountIds); return this; } /** *

* * @return

* The action the client wants to allow for the specified principal. * The following are valid values: * * | SendMessage | ReceiveMessage | DeleteMessage | ChangeMessageVisibility | GetQueueAttributes | GetQueueUrl * . For more information about these actions, see Understanding Permissions in the Amazon SQS Developer * Guide. *

* Specifying SendMessage, DeleteMessage, * or ChangeMessageVisibility for the * ActionName.n also grants permissions for the * corresponding batch versions of those actions: * SendMessageBatch, DeleteMessageBatch, * and ChangeMessageVisibilityBatch. *

*/ public java.util.List getActions() { return actions; } /** *

* * @param actions

*/ public void setActions(java.util.Collection actions) { if (actions == null) { this.actions = null; return; } this.actions = new java.util.ArrayList(actions); } /** *

* Returns a reference to this object so that method calls can be chained * together. * * @param actions

* @return A reference to this updated object so that method calls can be * chained together. */ public AddPermissionRequest withActions(String... actions) { if (getActions() == null) { this.actions = new java.util.ArrayList(actions.length); } for (String value : actions) { this.actions.add(value); } return this; } /** *

* Returns a reference to this object so that method calls can be chained * together. * * @param actions

* @return A reference to this updated object so that method calls can be * chained together. */ public AddPermissionRequest withActions(java.util.Collection actions) { setActions(actions); return this; } /** * Returns a string representation of this object; useful for testing and * debugging. * * @return A string representation of this object. * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getQueueUrl() != null) sb.append("QueueUrl: " + getQueueUrl() + ","); if (getLabel() != null) sb.append("Label: " + getLabel() + ","); if (getAWSAccountIds() != null) sb.append("AWSAccountIds: " + getAWSAccountIds() + ","); if (getActions() != null) sb.append("Actions: " + getActions()); sb.append("}"); return sb.toString(); } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getQueueUrl() == null) ? 0 : getQueueUrl().hashCode()); hashCode = prime * hashCode + ((getLabel() == null) ? 0 : getLabel().hashCode()); hashCode = prime * hashCode + ((getAWSAccountIds() == null) ? 0 : getAWSAccountIds().hashCode()); hashCode = prime * hashCode + ((getActions() == null) ? 0 : getActions().hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof AddPermissionRequest == false) return false; AddPermissionRequest other = (AddPermissionRequest) obj; if (other.getQueueUrl() == null ^ this.getQueueUrl() == null) return false; if (other.getQueueUrl() != null && other.getQueueUrl().equals(this.getQueueUrl()) == false) return false; if (other.getLabel() == null ^ this.getLabel() == null) return false; if (other.getLabel() != null && other.getLabel().equals(this.getLabel()) == false) return false; if (other.getAWSAccountIds() == null ^ this.getAWSAccountIds() == null) return false; if (other.getAWSAccountIds() != null && other.getAWSAccountIds().equals(this.getAWSAccountIds()) == false) return false; if (other.getActions() == null ^ this.getActions() == null) return false; if (other.getActions() != null && other.getActions().equals(this.getActions()) == false) return false; return true; } }