com.amazonaws.services.resourceexplorer2.model.SearchRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-resourceexplorer2 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.resourceexplorer2.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 SearchRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The maximum 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 appropriate to the operation. If additional items exist beyond those included
* in the current response, 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.
*
*
*
* An API operation can 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 of the previous call's NextToken response to indicate where the output should continue from.
* The pagination tokens expire after 24 hours.
*
*/
private String nextToken;
/**
*
* A string that includes keywords and filters that specify the resources that you want to include in the results.
*
*
* For the complete syntax supported by the QueryString parameter, see Search query
* syntax reference for Resource Explorer.
*
*
* The search is completely case insensitive. You can specify an empty string to return all results up to the limit
* of 1,000 total results.
*
*
*
* The operation can return only the first 1,000 results. If the resource you want is not included, then use a
* different value for QueryString to refine the results.
*
*
*/
private String queryString;
/**
*
* Specifies the Amazon
* resource name (ARN) of the view to use for the query. If you don't specify a value for this parameter, then
* the operation automatically uses the default view for the Amazon Web Services Region in which you called this
* operation. If the Region either doesn't have a default view or if you don't have permission to use the default
* view, then the operation fails with a 401 Unauthorized exception.
*
*/
private String viewArn;
/**
*
* The maximum 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 appropriate to the operation. If additional items exist beyond those included
* in the current response, 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.
*
*
*
* An API operation can 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 maximum 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 appropriate to the operation. If additional items exist beyond
* those included in the current response, 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.
*
* An API operation can 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 maximum 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 appropriate to the operation. If additional items exist beyond those included
* in the current response, 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.
*
*
*
* An API operation can 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 maximum 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 appropriate to the operation. If additional items exist beyond
* those included in the current response, 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.
*
* An API operation can 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 maximum 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 appropriate to the operation. If additional items exist beyond those included
* in the current response, 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.
*
*
*
* An API operation can 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 maximum 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 appropriate to the operation. If additional items exist beyond
* those included in the current response, 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.
*
* An API operation can 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 SearchRequest 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 of the previous call's NextToken response to indicate where the output should continue from.
* The pagination tokens expire after 24 hours.
*
*
* @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 of the previous call's NextToken response to indicate where the output
* should continue from. The pagination tokens expire after 24 hours.
*/
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 of the previous call's NextToken response to indicate where the output should continue from.
* The pagination tokens expire after 24 hours.
*
*
* @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 of the previous call's NextToken response to indicate where the
* output should continue from. The pagination tokens expire after 24 hours.
*/
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 of the previous call's NextToken response to indicate where the output should continue from.
* The pagination tokens expire after 24 hours.
*
*
* @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 of the previous call's NextToken response to indicate where the output
* should continue from. The pagination tokens expire after 24 hours.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SearchRequest withNextToken(String nextToken) {
setNextToken(nextToken);
return this;
}
/**
*
* A string that includes keywords and filters that specify the resources that you want to include in the results.
*
*
* For the complete syntax supported by the QueryString parameter, see Search query
* syntax reference for Resource Explorer.
*
*
* The search is completely case insensitive. You can specify an empty string to return all results up to the limit
* of 1,000 total results.
*
*
*
* The operation can return only the first 1,000 results. If the resource you want is not included, then use a
* different value for QueryString to refine the results.
*
*
*
* @param queryString
* A string that includes keywords and filters that specify the resources that you want to include in the
* results.
*
* For the complete syntax supported by the QueryString parameter, see Search query syntax reference for Resource Explorer.
*
*
* The search is completely case insensitive. You can specify an empty string to return all results up to the
* limit of 1,000 total results.
*
*
*
* The operation can return only the first 1,000 results. If the resource you want is not included, then use
* a different value for QueryString to refine the results.
*
*/
public void setQueryString(String queryString) {
this.queryString = queryString;
}
/**
*
* A string that includes keywords and filters that specify the resources that you want to include in the results.
*
*
* For the complete syntax supported by the QueryString parameter, see Search query
* syntax reference for Resource Explorer.
*
*
* The search is completely case insensitive. You can specify an empty string to return all results up to the limit
* of 1,000 total results.
*
*
*
* The operation can return only the first 1,000 results. If the resource you want is not included, then use a
* different value for QueryString to refine the results.
*
*
*
* @return A string that includes keywords and filters that specify the resources that you want to include in the
* results.
*
* For the complete syntax supported by the QueryString parameter, see Search query syntax reference for Resource Explorer.
*
*
* The search is completely case insensitive. You can specify an empty string to return all results up to
* the limit of 1,000 total results.
*
*
*
* The operation can return only the first 1,000 results. If the resource you want is not included, then use
* a different value for QueryString to refine the results.
*
*/
public String getQueryString() {
return this.queryString;
}
/**
*
* A string that includes keywords and filters that specify the resources that you want to include in the results.
*
*
* For the complete syntax supported by the QueryString parameter, see Search query
* syntax reference for Resource Explorer.
*
*
* The search is completely case insensitive. You can specify an empty string to return all results up to the limit
* of 1,000 total results.
*
*
*
* The operation can return only the first 1,000 results. If the resource you want is not included, then use a
* different value for QueryString to refine the results.
*
*
*
* @param queryString
* A string that includes keywords and filters that specify the resources that you want to include in the
* results.
*
* For the complete syntax supported by the QueryString parameter, see Search query syntax reference for Resource Explorer.
*
*
* The search is completely case insensitive. You can specify an empty string to return all results up to the
* limit of 1,000 total results.
*
*
*
* The operation can return only the first 1,000 results. If the resource you want is not included, then use
* a different value for QueryString to refine the results.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SearchRequest withQueryString(String queryString) {
setQueryString(queryString);
return this;
}
/**
*
* Specifies the Amazon
* resource name (ARN) of the view to use for the query. If you don't specify a value for this parameter, then
* the operation automatically uses the default view for the Amazon Web Services Region in which you called this
* operation. If the Region either doesn't have a default view or if you don't have permission to use the default
* view, then the operation fails with a 401 Unauthorized exception.
*
*
* @param viewArn
* Specifies the Amazon
* resource name (ARN) of the view to use for the query. If you don't specify a value for this parameter,
* then the operation automatically uses the default view for the Amazon Web Services Region in which you
* called this operation. If the Region either doesn't have a default view or if you don't have permission to
* use the default view, then the operation fails with a 401 Unauthorized exception.
*/
public void setViewArn(String viewArn) {
this.viewArn = viewArn;
}
/**
*
* Specifies the Amazon
* resource name (ARN) of the view to use for the query. If you don't specify a value for this parameter, then
* the operation automatically uses the default view for the Amazon Web Services Region in which you called this
* operation. If the Region either doesn't have a default view or if you don't have permission to use the default
* view, then the operation fails with a 401 Unauthorized exception.
*
*
* @return Specifies the Amazon
* resource name (ARN) of the view to use for the query. If you don't specify a value for this
* parameter, then the operation automatically uses the default view for the Amazon Web Services Region in
* which you called this operation. If the Region either doesn't have a default view or if you don't have
* permission to use the default view, then the operation fails with a 401 Unauthorized
* exception.
*/
public String getViewArn() {
return this.viewArn;
}
/**
*
* Specifies the Amazon
* resource name (ARN) of the view to use for the query. If you don't specify a value for this parameter, then
* the operation automatically uses the default view for the Amazon Web Services Region in which you called this
* operation. If the Region either doesn't have a default view or if you don't have permission to use the default
* view, then the operation fails with a 401 Unauthorized exception.
*
*
* @param viewArn
* Specifies the Amazon
* resource name (ARN) of the view to use for the query. If you don't specify a value for this parameter,
* then the operation automatically uses the default view for the Amazon Web Services Region in which you
* called this operation. If the Region either doesn't have a default view or if you don't have permission to
* use the default view, then the operation fails with a 401 Unauthorized exception.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SearchRequest withViewArn(String viewArn) {
setViewArn(viewArn);
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 (getMaxResults() != null)
sb.append("MaxResults: ").append(getMaxResults()).append(",");
if (getNextToken() != null)
sb.append("NextToken: ").append(getNextToken()).append(",");
if (getQueryString() != null)
sb.append("QueryString: ").append("***Sensitive Data Redacted***").append(",");
if (getViewArn() != null)
sb.append("ViewArn: ").append(getViewArn());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof SearchRequest == false)
return false;
SearchRequest other = (SearchRequest) obj;
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;
if (other.getQueryString() == null ^ this.getQueryString() == null)
return false;
if (other.getQueryString() != null && other.getQueryString().equals(this.getQueryString()) == false)
return false;
if (other.getViewArn() == null ^ this.getViewArn() == null)
return false;
if (other.getViewArn() != null && other.getViewArn().equals(this.getViewArn()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
hashCode = prime * hashCode + ((getQueryString() == null) ? 0 : getQueryString().hashCode());
hashCode = prime * hashCode + ((getViewArn() == null) ? 0 : getViewArn().hashCode());
return hashCode;
}
@Override
public SearchRequest clone() {
return (SearchRequest) super.clone();
}
}