com.amazonaws.services.sqs.model.DeleteMessageBatchRequest 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 DeleteMessageBatchRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The URL of the Amazon SQS queue from which messages are deleted.
*
*
* Queue URLs and names are case-sensitive.
*
*/
private String queueUrl;
/**
*
* Lists the receipt handles for the messages to be deleted.
*
*/
private com.amazonaws.internal.SdkInternalList entries;
/**
* Default constructor for DeleteMessageBatchRequest object. Callers should use the setter or fluent setter
* (with...) methods to initialize the object after creating it.
*/
public DeleteMessageBatchRequest() {
}
/**
* Constructs a new DeleteMessageBatchRequest 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 from which messages are deleted.
*
* Queue URLs and names are case-sensitive.
*/
public DeleteMessageBatchRequest(String queueUrl) {
setQueueUrl(queueUrl);
}
/**
* Constructs a new DeleteMessageBatchRequest 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 from which messages are deleted.
*
* Queue URLs and names are case-sensitive.
* @param entries
* Lists the receipt handles for the messages to be deleted.
*/
public DeleteMessageBatchRequest(String queueUrl, java.util.List entries) {
setQueueUrl(queueUrl);
setEntries(entries);
}
/**
*
* The URL of the Amazon SQS queue from which messages are deleted.
*
*
* Queue URLs and names are case-sensitive.
*
*
* @param queueUrl
* The URL of the Amazon SQS queue from which messages are deleted.
*
* Queue URLs and names are case-sensitive.
*/
public void setQueueUrl(String queueUrl) {
this.queueUrl = queueUrl;
}
/**
*
* The URL of the Amazon SQS queue from which messages are deleted.
*
*
* Queue URLs and names are case-sensitive.
*
*
* @return The URL of the Amazon SQS queue from which messages are deleted.
*
* Queue URLs and names are case-sensitive.
*/
public String getQueueUrl() {
return this.queueUrl;
}
/**
*
* The URL of the Amazon SQS queue from which messages are deleted.
*
*
* Queue URLs and names are case-sensitive.
*
*
* @param queueUrl
* The URL of the Amazon SQS queue from which messages are deleted.
*
* Queue URLs and names are case-sensitive.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DeleteMessageBatchRequest withQueueUrl(String queueUrl) {
setQueueUrl(queueUrl);
return this;
}
/**
*
* Lists the receipt handles for the messages to be deleted.
*
*
* @return Lists the receipt handles for the messages to be deleted.
*/
public java.util.List getEntries() {
if (entries == null) {
entries = new com.amazonaws.internal.SdkInternalList();
}
return entries;
}
/**
*
* Lists the receipt handles for the messages to be deleted.
*
*
* @param entries
* Lists the receipt handles for the messages to be deleted.
*/
public void setEntries(java.util.Collection entries) {
if (entries == null) {
this.entries = null;
return;
}
this.entries = new com.amazonaws.internal.SdkInternalList(entries);
}
/**
*
* Lists the receipt handles for the messages to be deleted.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setEntries(java.util.Collection)} or {@link #withEntries(java.util.Collection)} if you want to override
* the existing values.
*
*
* @param entries
* Lists the receipt handles for the messages to be deleted.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DeleteMessageBatchRequest withEntries(DeleteMessageBatchRequestEntry... entries) {
if (this.entries == null) {
setEntries(new com.amazonaws.internal.SdkInternalList(entries.length));
}
for (DeleteMessageBatchRequestEntry ele : entries) {
this.entries.add(ele);
}
return this;
}
/**
*
* Lists the receipt handles for the messages to be deleted.
*
*
* @param entries
* Lists the receipt handles for the messages to be deleted.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DeleteMessageBatchRequest withEntries(java.util.Collection entries) {
setEntries(entries);
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 (getEntries() != null)
sb.append("Entries: ").append(getEntries());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DeleteMessageBatchRequest == false)
return false;
DeleteMessageBatchRequest other = (DeleteMessageBatchRequest) obj;
if (other.getQueueUrl() == null ^ this.getQueueUrl() == null)
return false;
if (other.getQueueUrl() != null && other.getQueueUrl().equals(this.getQueueUrl()) == false)
return false;
if (other.getEntries() == null ^ this.getEntries() == null)
return false;
if (other.getEntries() != null && other.getEntries().equals(this.getEntries()) == 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 + ((getEntries() == null) ? 0 : getEntries().hashCode());
return hashCode;
}
@Override
public DeleteMessageBatchRequest clone() {
return (DeleteMessageBatchRequest) super.clone();
}
}