com.amazonaws.services.resourcegroups.model.SearchResourcesRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-resourcegroups 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.resourcegroups.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 SearchResourcesRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The search query, using the same formats that are supported for resource group definition. For more information,
* see CreateGroup.
*
*/
private ResourceQuery resourceQuery;
/**
*
* The total number of results that you want included on each page of the response. If you do not include this
* parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum
* you specify, the NextToken response element is present and has a value (is not null). Include that
* value as the NextToken request parameter in the next call to the operation to get the next part of
* the results. Note that the service might return fewer results than the maximum even when there are more results
* available. You should check NextToken after every operation to ensure that you receive all of the
* results.
*
*/
private Integer maxResults;
/**
*
* The parameter for receiving additional results if you receive a NextToken response in a previous
* request. A NextToken response indicates that more output is available. Set this parameter to the
* value provided by a previous call's NextToken response to indicate where the output should continue
* from.
*
*/
private String nextToken;
/**
*
* The search query, using the same formats that are supported for resource group definition. For more information,
* see CreateGroup.
*
*
* @param resourceQuery
* The search query, using the same formats that are supported for resource group definition. For more
* information, see CreateGroup.
*/
public void setResourceQuery(ResourceQuery resourceQuery) {
this.resourceQuery = resourceQuery;
}
/**
*
* The search query, using the same formats that are supported for resource group definition. For more information,
* see CreateGroup.
*
*
* @return The search query, using the same formats that are supported for resource group definition. For more
* information, see CreateGroup.
*/
public ResourceQuery getResourceQuery() {
return this.resourceQuery;
}
/**
*
* The search query, using the same formats that are supported for resource group definition. For more information,
* see CreateGroup.
*
*
* @param resourceQuery
* The search query, using the same formats that are supported for resource group definition. For more
* information, see CreateGroup.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SearchResourcesRequest withResourceQuery(ResourceQuery resourceQuery) {
setResourceQuery(resourceQuery);
return this;
}
/**
*
* The total number of results that you want included on each page of the response. If you do not include this
* parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum
* you specify, the NextToken response element is present and has a value (is not null). Include that
* value as the NextToken request parameter in the next call to the operation to get the next part of
* the results. Note that the service might return fewer results than the maximum even when there are more results
* available. You should check NextToken after every operation to ensure that you receive all of the
* results.
*
*
* @param maxResults
* The total number of results that you want included on each page of the response. If you do not include
* this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond
* the maximum you specify, the NextToken response element is present and has a value (is not
* null). Include that value as the NextToken request parameter in the next call to the
* operation to get the next part of the results. Note that the service might return fewer results than the
* maximum even when there are more results available. You should check NextToken after every
* operation to ensure that you receive all of the results.
*/
public void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
/**
*
* The total number of results that you want included on each page of the response. If you do not include this
* parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum
* you specify, the NextToken response element is present and has a value (is not null). Include that
* value as the NextToken request parameter in the next call to the operation to get the next part of
* the results. Note that the service might return fewer results than the maximum even when there are more results
* available. You should check NextToken after every operation to ensure that you receive all of the
* results.
*
*
* @return The total number of results that you want included on each page of the response. If you do not include
* this parameter, it defaults to a value that is specific to the operation. If additional items exist
* beyond the maximum you specify, the NextToken response element is present and has a value
* (is not null). Include that value as the NextToken request parameter in the next call to the
* operation to get the next part of the results. Note that the service might return fewer results than the
* maximum even when there are more results available. You should check NextToken after every
* operation to ensure that you receive all of the results.
*/
public Integer getMaxResults() {
return this.maxResults;
}
/**
*
* The total number of results that you want included on each page of the response. If you do not include this
* parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum
* you specify, the NextToken response element is present and has a value (is not null). Include that
* value as the NextToken request parameter in the next call to the operation to get the next part of
* the results. Note that the service might return fewer results than the maximum even when there are more results
* available. You should check NextToken after every operation to ensure that you receive all of the
* results.
*
*
* @param maxResults
* The total number of results that you want included on each page of the response. If you do not include
* this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond
* the maximum you specify, the NextToken response element is present and has a value (is not
* null). Include that value as the NextToken request parameter in the next call to the
* operation to get the next part of the results. Note that the service might return fewer results than the
* maximum even when there are more results available. You should check NextToken after every
* operation to ensure that you receive all of the results.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SearchResourcesRequest withMaxResults(Integer maxResults) {
setMaxResults(maxResults);
return this;
}
/**
*
* The parameter for receiving additional results if you receive a NextToken response in a previous
* request. A NextToken response indicates that more output is available. Set this parameter to the
* value provided by a previous call's NextToken response to indicate where the output should continue
* from.
*
*
* @param nextToken
* The parameter for receiving additional results if you receive a NextToken response in a
* previous request. A NextToken response indicates that more output is available. Set this
* parameter to the value provided by a previous call's NextToken response to indicate where the
* output should continue from.
*/
public void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
*
* The parameter for receiving additional results if you receive a NextToken response in a previous
* request. A NextToken response indicates that more output is available. Set this parameter to the
* value provided by a previous call's NextToken response to indicate where the output should continue
* from.
*
*
* @return The parameter for receiving additional results if you receive a NextToken response in a
* previous request. A NextToken response indicates that more output is available. Set this
* parameter to the value provided by a previous call's NextToken response to indicate where
* the output should continue from.
*/
public String getNextToken() {
return this.nextToken;
}
/**
*
* The parameter for receiving additional results if you receive a NextToken response in a previous
* request. A NextToken response indicates that more output is available. Set this parameter to the
* value provided by a previous call's NextToken response to indicate where the output should continue
* from.
*
*
* @param nextToken
* The parameter for receiving additional results if you receive a NextToken response in a
* previous request. A NextToken response indicates that more output is available. Set this
* parameter to the value provided by a previous call's NextToken response to indicate where the
* output should continue from.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SearchResourcesRequest withNextToken(String nextToken) {
setNextToken(nextToken);
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 (getResourceQuery() != null)
sb.append("ResourceQuery: ").append(getResourceQuery()).append(",");
if (getMaxResults() != null)
sb.append("MaxResults: ").append(getMaxResults()).append(",");
if (getNextToken() != null)
sb.append("NextToken: ").append(getNextToken());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof SearchResourcesRequest == false)
return false;
SearchResourcesRequest other = (SearchResourcesRequest) obj;
if (other.getResourceQuery() == null ^ this.getResourceQuery() == null)
return false;
if (other.getResourceQuery() != null && other.getResourceQuery().equals(this.getResourceQuery()) == false)
return false;
if (other.getMaxResults() == null ^ this.getMaxResults() == null)
return false;
if (other.getMaxResults() != null && other.getMaxResults().equals(this.getMaxResults()) == false)
return false;
if (other.getNextToken() == null ^ this.getNextToken() == null)
return false;
if (other.getNextToken() != null && other.getNextToken().equals(this.getNextToken()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getResourceQuery() == null) ? 0 : getResourceQuery().hashCode());
hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
return hashCode;
}
@Override
public SearchResourcesRequest clone() {
return (SearchResourcesRequest) super.clone();
}
}