com.amazonaws.services.sqs.model.AddPermissionRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-sqs 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.sqs.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class AddPermissionRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The URL of the Amazon SQS queue to which permissions are added.
*
*
* Queue URLs and names are case-sensitive.
*
*/
private String queueUrl;
/**
*
* The unique identification of the permission you're setting (for example, AliceSendMessage). Maximum
* 80 characters. Allowed characters include alphanumeric characters, hyphens (-), and underscores (
* _).
*
*/
private String label;
/**
*
* The Amazon Web Services account numbers of the principals who are to receive
* permission. For information about locating the Amazon Web Services account identification, see Your Amazon Web Services Identifiers in the Amazon SQS Developer Guide.
*
*/
private com.amazonaws.internal.SdkInternalList aWSAccountIds;
/**
*
* The action the client wants to allow for the specified principal. Valid values: the name of any action or
* *.
*
*
* For more information about these actions, see Overview of Managing Access Permissions to Your Amazon Simple Queue Service Resource in the Amazon SQS
* Developer Guide.
*
*
* Specifying SendMessage, DeleteMessage, or ChangeMessageVisibility for
* ActionName.n also grants permissions for the corresponding batch versions of those actions:
* SendMessageBatch, DeleteMessageBatch, and ChangeMessageVisibilityBatch.
*
*/
private com.amazonaws.internal.SdkInternalList actions;
/**
* Default constructor for AddPermissionRequest object. Callers should use the setter or fluent setter (with...)
* methods to initialize the object after creating it.
*/
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 which permissions are added.
*
* Queue URLs and names are case-sensitive.
* @param label
* The unique identification of the permission you're setting (for example, AliceSendMessage).
* Maximum 80 characters. Allowed characters include alphanumeric characters, hyphens (-), and
* underscores (_).
* @param aWSAccountIds
* The Amazon Web Services account numbers of the principals who are to receive
* permission. For information about locating the Amazon Web Services account identification, see Your Amazon Web Services Identifiers in the Amazon SQS Developer Guide.
* @param actions
* The action the client wants to allow for the specified principal. Valid values: the name of any action or
* *.
*
*
* For more information about these actions, see Overview of Managing Access Permissions to Your Amazon Simple Queue Service Resource in the Amazon
* SQS Developer Guide.
*
*
* Specifying SendMessage, DeleteMessage, or ChangeMessageVisibility
* for 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 which permissions are added.
*
*
* Queue URLs and names are case-sensitive.
*
*
* @param queueUrl
* The URL of the Amazon SQS queue to which permissions are added.
*
* Queue URLs and names are case-sensitive.
*/
public void setQueueUrl(String queueUrl) {
this.queueUrl = queueUrl;
}
/**
*
* The URL of the Amazon SQS queue to which permissions are added.
*
*
* Queue URLs and names are case-sensitive.
*
*
* @return The URL of the Amazon SQS queue to which permissions are added.
*
* Queue URLs and names are case-sensitive.
*/
public String getQueueUrl() {
return this.queueUrl;
}
/**
*
* The URL of the Amazon SQS queue to which permissions are added.
*
*
* Queue URLs and names are case-sensitive.
*
*
* @param queueUrl
* The URL of the Amazon SQS queue to which permissions are added.
*
* Queue URLs and names are case-sensitive.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AddPermissionRequest withQueueUrl(String queueUrl) {
setQueueUrl(queueUrl);
return this;
}
/**
*
* The unique identification of the permission you're setting (for example, AliceSendMessage). Maximum
* 80 characters. Allowed characters include alphanumeric characters, hyphens (-), and underscores (
* _).
*
*
* @param label
* The unique identification of the permission you're setting (for example, AliceSendMessage).
* Maximum 80 characters. Allowed characters include alphanumeric characters, hyphens (-), and
* underscores (_).
*/
public void setLabel(String label) {
this.label = label;
}
/**
*
* The unique identification of the permission you're setting (for example, AliceSendMessage). Maximum
* 80 characters. Allowed characters include alphanumeric characters, hyphens (-), and underscores (
* _).
*
*
* @return The unique identification of the permission you're setting (for example, AliceSendMessage).
* Maximum 80 characters. Allowed characters include alphanumeric characters, hyphens (-), and
* underscores (_).
*/
public String getLabel() {
return this.label;
}
/**
*
* The unique identification of the permission you're setting (for example, AliceSendMessage). Maximum
* 80 characters. Allowed characters include alphanumeric characters, hyphens (-), and underscores (
* _).
*
*
* @param label
* The unique identification of the permission you're setting (for example, AliceSendMessage).
* Maximum 80 characters. Allowed characters include alphanumeric characters, hyphens (-), and
* underscores (_).
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AddPermissionRequest withLabel(String label) {
setLabel(label);
return this;
}
/**
*
* The Amazon Web Services account numbers of the principals who are to receive
* permission. For information about locating the Amazon Web Services account identification, see Your Amazon Web Services Identifiers in the Amazon SQS Developer Guide.
*
*
* @return The Amazon Web Services account numbers of the principals who are to receive
* permission. For information about locating the Amazon Web Services account identification, see Your Amazon Web Services Identifiers in the Amazon SQS Developer Guide.
*/
public java.util.List getAWSAccountIds() {
if (aWSAccountIds == null) {
aWSAccountIds = new com.amazonaws.internal.SdkInternalList();
}
return aWSAccountIds;
}
/**
*
* The Amazon Web Services account numbers of the principals who are to receive
* permission. For information about locating the Amazon Web Services account identification, see Your Amazon Web Services Identifiers in the Amazon SQS Developer Guide.
*
*
* @param aWSAccountIds
* The Amazon Web Services account numbers of the principals who are to receive
* permission. For information about locating the Amazon Web Services account identification, see Your Amazon Web Services Identifiers in the Amazon SQS Developer Guide.
*/
public void setAWSAccountIds(java.util.Collection aWSAccountIds) {
if (aWSAccountIds == null) {
this.aWSAccountIds = null;
return;
}
this.aWSAccountIds = new com.amazonaws.internal.SdkInternalList(aWSAccountIds);
}
/**
*
* The Amazon Web Services account numbers of the principals who are to receive
* permission. For information about locating the Amazon Web Services account identification, see Your Amazon Web Services Identifiers in the Amazon SQS Developer Guide.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setAWSAccountIds(java.util.Collection)} or {@link #withAWSAccountIds(java.util.Collection)} if you want
* to override the existing values.
*
*
* @param aWSAccountIds
* The Amazon Web Services account numbers of the principals who are to receive
* permission. For information about locating the Amazon Web Services account identification, see Your Amazon Web Services Identifiers in the Amazon SQS Developer Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AddPermissionRequest withAWSAccountIds(String... aWSAccountIds) {
if (this.aWSAccountIds == null) {
setAWSAccountIds(new com.amazonaws.internal.SdkInternalList(aWSAccountIds.length));
}
for (String ele : aWSAccountIds) {
this.aWSAccountIds.add(ele);
}
return this;
}
/**
*
* The Amazon Web Services account numbers of the principals who are to receive
* permission. For information about locating the Amazon Web Services account identification, see Your Amazon Web Services Identifiers in the Amazon SQS Developer Guide.
*
*
* @param aWSAccountIds
* The Amazon Web Services account numbers of the principals who are to receive
* permission. For information about locating the Amazon Web Services account identification, see Your Amazon Web Services Identifiers in the Amazon SQS Developer Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AddPermissionRequest withAWSAccountIds(java.util.Collection aWSAccountIds) {
setAWSAccountIds(aWSAccountIds);
return this;
}
/**
*
* The action the client wants to allow for the specified principal. Valid values: the name of any action or
* *.
*
*
* For more information about these actions, see Overview of Managing Access Permissions to Your Amazon Simple Queue Service Resource in the Amazon SQS
* Developer Guide.
*
*
* Specifying SendMessage, DeleteMessage, or ChangeMessageVisibility for
* ActionName.n also grants permissions for the corresponding batch versions of those actions:
* SendMessageBatch, DeleteMessageBatch, and ChangeMessageVisibilityBatch.
*
*
* @return The action the client wants to allow for the specified principal. Valid values: the name of any action or
* *.
*
* For more information about these actions, see Overview of Managing Access Permissions to Your Amazon Simple Queue Service Resource in the
* Amazon SQS Developer Guide.
*
*
* Specifying SendMessage, DeleteMessage, or ChangeMessageVisibility
* for ActionName.n also grants permissions for the corresponding batch versions of those
* actions: SendMessageBatch, DeleteMessageBatch, and
* ChangeMessageVisibilityBatch.
*/
public java.util.List getActions() {
if (actions == null) {
actions = new com.amazonaws.internal.SdkInternalList();
}
return actions;
}
/**
*
* The action the client wants to allow for the specified principal. Valid values: the name of any action or
* *.
*
*
* For more information about these actions, see Overview of Managing Access Permissions to Your Amazon Simple Queue Service Resource in the Amazon SQS
* Developer Guide.
*
*
* Specifying SendMessage, DeleteMessage, or ChangeMessageVisibility for
* ActionName.n also grants permissions for the corresponding batch versions of those actions:
* SendMessageBatch, DeleteMessageBatch, and ChangeMessageVisibilityBatch.
*
*
* @param actions
* The action the client wants to allow for the specified principal. Valid values: the name of any action or
* *.
*
* For more information about these actions, see Overview of Managing Access Permissions to Your Amazon Simple Queue Service Resource in the Amazon
* SQS Developer Guide.
*
*
* Specifying SendMessage, DeleteMessage, or ChangeMessageVisibility
* for ActionName.n also grants permissions for the corresponding batch versions of those
* actions: SendMessageBatch, DeleteMessageBatch, and
* ChangeMessageVisibilityBatch.
*/
public void setActions(java.util.Collection actions) {
if (actions == null) {
this.actions = null;
return;
}
this.actions = new com.amazonaws.internal.SdkInternalList(actions);
}
/**
*
* The action the client wants to allow for the specified principal. Valid values: the name of any action or
* *.
*
*
* For more information about these actions, see Overview of Managing Access Permissions to Your Amazon Simple Queue Service Resource in the Amazon SQS
* Developer Guide.
*
*
* Specifying SendMessage, DeleteMessage, or ChangeMessageVisibility for
* ActionName.n also grants permissions for the corresponding batch versions of those actions:
* SendMessageBatch, DeleteMessageBatch, and ChangeMessageVisibilityBatch.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setActions(java.util.Collection)} or {@link #withActions(java.util.Collection)} if you want to override
* the existing values.
*
*
* @param actions
* The action the client wants to allow for the specified principal. Valid values: the name of any action or
* *.
*
* For more information about these actions, see Overview of Managing Access Permissions to Your Amazon Simple Queue Service Resource in the Amazon
* SQS Developer Guide.
*
*
* Specifying SendMessage, DeleteMessage, or ChangeMessageVisibility
* for ActionName.n also grants permissions for the corresponding batch versions of those
* actions: SendMessageBatch, DeleteMessageBatch, and
* ChangeMessageVisibilityBatch.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AddPermissionRequest withActions(String... actions) {
if (this.actions == null) {
setActions(new com.amazonaws.internal.SdkInternalList(actions.length));
}
for (String ele : actions) {
this.actions.add(ele);
}
return this;
}
/**
*
* The action the client wants to allow for the specified principal. Valid values: the name of any action or
* *.
*
*
* For more information about these actions, see Overview of Managing Access Permissions to Your Amazon Simple Queue Service Resource in the Amazon SQS
* Developer Guide.
*
*
* Specifying SendMessage, DeleteMessage, or ChangeMessageVisibility for
* ActionName.n also grants permissions for the corresponding batch versions of those actions:
* SendMessageBatch, DeleteMessageBatch, and ChangeMessageVisibilityBatch.
*
*
* @param actions
* The action the client wants to allow for the specified principal. Valid values: the name of any action or
* *.
*
* For more information about these actions, see Overview of Managing Access Permissions to Your Amazon Simple Queue Service Resource in the Amazon
* SQS Developer Guide.
*
*
* Specifying SendMessage, DeleteMessage, or ChangeMessageVisibility
* for ActionName.n also grants permissions for the corresponding batch versions of those
* actions: SendMessageBatch, DeleteMessageBatch, and
* ChangeMessageVisibilityBatch.
* @return Returns a reference to this 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. 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 (getQueueUrl() != null)
sb.append("QueueUrl: ").append(getQueueUrl()).append(",");
if (getLabel() != null)
sb.append("Label: ").append(getLabel()).append(",");
if (getAWSAccountIds() != null)
sb.append("AWSAccountIds: ").append(getAWSAccountIds()).append(",");
if (getActions() != null)
sb.append("Actions: ").append(getActions());
sb.append("}");
return sb.toString();
}
@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;
}
@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 AddPermissionRequest clone() {
return (AddPermissionRequest) super.clone();
}
}