com.amazonaws.services.sqs.model.ListQueuesRequest 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 ListQueuesRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* A string to use for filtering the list results. Only those queues whose name begins with the specified string are
* returned.
*
*
* Queue URLs and names are case-sensitive.
*
*/
private String queueNamePrefix;
/**
*
* Pagination token to request the next set of results.
*
*/
private String nextToken;
/**
*
* Maximum number of results to include in the response. Value range is 1 to 1000. You must set
* MaxResults to receive a value for NextToken in the response.
*
*/
private Integer maxResults;
/**
* Default constructor for ListQueuesRequest object. Callers should use the setter or fluent setter (with...)
* methods to initialize the object after creating it.
*/
public ListQueuesRequest() {
}
/**
* Constructs a new ListQueuesRequest object. Callers should use the setter or fluent setter (with...) methods to
* initialize any additional object members.
*
* @param queueNamePrefix
* A string to use for filtering the list results. Only those queues whose name begins with the specified
* string are returned.
*
* Queue URLs and names are case-sensitive.
*/
public ListQueuesRequest(String queueNamePrefix) {
setQueueNamePrefix(queueNamePrefix);
}
/**
*
* A string to use for filtering the list results. Only those queues whose name begins with the specified string are
* returned.
*
*
* Queue URLs and names are case-sensitive.
*
*
* @param queueNamePrefix
* A string to use for filtering the list results. Only those queues whose name begins with the specified
* string are returned.
*
* Queue URLs and names are case-sensitive.
*/
public void setQueueNamePrefix(String queueNamePrefix) {
this.queueNamePrefix = queueNamePrefix;
}
/**
*
* A string to use for filtering the list results. Only those queues whose name begins with the specified string are
* returned.
*
*
* Queue URLs and names are case-sensitive.
*
*
* @return A string to use for filtering the list results. Only those queues whose name begins with the specified
* string are returned.
*
* Queue URLs and names are case-sensitive.
*/
public String getQueueNamePrefix() {
return this.queueNamePrefix;
}
/**
*
* A string to use for filtering the list results. Only those queues whose name begins with the specified string are
* returned.
*
*
* Queue URLs and names are case-sensitive.
*
*
* @param queueNamePrefix
* A string to use for filtering the list results. Only those queues whose name begins with the specified
* string are returned.
*
* Queue URLs and names are case-sensitive.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListQueuesRequest withQueueNamePrefix(String queueNamePrefix) {
setQueueNamePrefix(queueNamePrefix);
return this;
}
/**
*
* Pagination token to request the next set of results.
*
*
* @param nextToken
* Pagination token to request the next set of results.
*/
public void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
*
* Pagination token to request the next set of results.
*
*
* @return Pagination token to request the next set of results.
*/
public String getNextToken() {
return this.nextToken;
}
/**
*
* Pagination token to request the next set of results.
*
*
* @param nextToken
* Pagination token to request the next set of results.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListQueuesRequest withNextToken(String nextToken) {
setNextToken(nextToken);
return this;
}
/**
*
* Maximum number of results to include in the response. Value range is 1 to 1000. You must set
* MaxResults to receive a value for NextToken in the response.
*
*
* @param maxResults
* Maximum number of results to include in the response. Value range is 1 to 1000. You must set
* MaxResults to receive a value for NextToken in the response.
*/
public void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
/**
*
* Maximum number of results to include in the response. Value range is 1 to 1000. You must set
* MaxResults to receive a value for NextToken in the response.
*
*
* @return Maximum number of results to include in the response. Value range is 1 to 1000. You must set
* MaxResults to receive a value for NextToken in the response.
*/
public Integer getMaxResults() {
return this.maxResults;
}
/**
*
* Maximum number of results to include in the response. Value range is 1 to 1000. You must set
* MaxResults to receive a value for NextToken in the response.
*
*
* @param maxResults
* Maximum number of results to include in the response. Value range is 1 to 1000. You must set
* MaxResults to receive a value for NextToken in the response.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListQueuesRequest withMaxResults(Integer maxResults) {
setMaxResults(maxResults);
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 (getQueueNamePrefix() != null)
sb.append("QueueNamePrefix: ").append(getQueueNamePrefix()).append(",");
if (getNextToken() != null)
sb.append("NextToken: ").append(getNextToken()).append(",");
if (getMaxResults() != null)
sb.append("MaxResults: ").append(getMaxResults());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ListQueuesRequest == false)
return false;
ListQueuesRequest other = (ListQueuesRequest) obj;
if (other.getQueueNamePrefix() == null ^ this.getQueueNamePrefix() == null)
return false;
if (other.getQueueNamePrefix() != null && other.getQueueNamePrefix().equals(this.getQueueNamePrefix()) == false)
return false;
if (other.getNextToken() == null ^ this.getNextToken() == null)
return false;
if (other.getNextToken() != null && other.getNextToken().equals(this.getNextToken()) == false)
return false;
if (other.getMaxResults() == null ^ this.getMaxResults() == null)
return false;
if (other.getMaxResults() != null && other.getMaxResults().equals(this.getMaxResults()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getQueueNamePrefix() == null) ? 0 : getQueueNamePrefix().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
return hashCode;
}
@Override
public ListQueuesRequest clone() {
return (ListQueuesRequest) super.clone();
}
}