/* * Copyright 2010-2023 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.iot.model; import java.io.Serializable; import com.amazonaws.AmazonWebServiceRequest; /** *

* The query search index. *

*

* Requires permission to access the SearchIndex action. *

*/ public class SearchIndexRequest extends AmazonWebServiceRequest implements Serializable { /** *

* The search index name. *

*

* Constraints:
* Length: 1 - 128
* Pattern: [a-zA-Z0-9:_-]+
*/ private String indexName; /** *

* The search query string. For more information about the search query * syntax, see Query syntax. *

*

* Constraints:
* Length: 1 -
*/ private String queryString; /** *

* The token used to get the next set of results, or null if * there are no additional results. *

*/ private String nextToken; /** *

* The maximum number of results to return at one time. *

*

* Constraints:
* Range: 1 - 500
*/ private Integer maxResults; /** *

* The query version. *

*/ private String queryVersion; /** *

* The search index name. *

*

* Constraints:
* Length: 1 - 128
* Pattern: [a-zA-Z0-9:_-]+
* * @return

* The search index name. *

*/ public String getIndexName() { return indexName; } /** *

* The search index name. *

*

* Constraints:
* Length: 1 - 128
* Pattern: [a-zA-Z0-9:_-]+
* * @param indexName

* The search index name. *

*/ public void setIndexName(String indexName) { this.indexName = indexName; } /** *

* The search index name. *

*

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Length: 1 - 128
* Pattern: [a-zA-Z0-9:_-]+
* * @param indexName

* The search index name. *

* @return A reference to this updated object so that method calls can be * chained together. */ public SearchIndexRequest withIndexName(String indexName) { this.indexName = indexName; return this; } /** *

* The search query string. For more information about the search query * syntax, see Query syntax. *

*

* Constraints:
* Length: 1 -
* * @return

* The search query string. For more information about the search * query syntax, see Query syntax. *

*/ public String getQueryString() { return queryString; } /** *

* The search query string. For more information about the search query * syntax, see Query syntax. *

*

* Constraints:
* Length: 1 -
* * @param queryString

* The search query string. For more information about the search * query syntax, see Query syntax. *

*/ public void setQueryString(String queryString) { this.queryString = queryString; } /** *

* The search query string. For more information about the search query * syntax, see Query syntax. *

*

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Length: 1 -
* * @param queryString

* The search query string. For more information about the search * query syntax, see Query syntax. *

* @return A reference to this updated object so that method calls can be * chained together. */ public SearchIndexRequest withQueryString(String queryString) { this.queryString = queryString; return this; } /** *

* The token used to get the next set of results, or null if * there are no additional results. *

* * @return

* The token used to get the next set of results, or * null if there are no additional results. *

*/ public String getNextToken() { return nextToken; } /** *

* The token used to get the next set of results, or null if * there are no additional results. *

* * @param nextToken

* The token used to get the next set of results, or * null if there are no additional results. *

*/ public void setNextToken(String nextToken) { this.nextToken = nextToken; } /** *

* The token used to get the next set of results, or null if * there are no additional results. *

*

* Returns a reference to this object so that method calls can be chained * together. * * @param nextToken

* The token used to get the next set of results, or * null if there are no additional results. *

* @return A reference to this updated object so that method calls can be * chained together. */ public SearchIndexRequest withNextToken(String nextToken) { this.nextToken = nextToken; return this; } /** *

* The maximum number of results to return at one time. *

*

* Constraints:
* Range: 1 - 500
* * @return

* The maximum number of results to return at one time. *

*/ public Integer getMaxResults() { return maxResults; } /** *

* The maximum number of results to return at one time. *

*

* Constraints:
* Range: 1 - 500
* * @param maxResults

* The maximum number of results to return at one time. *

*/ public void setMaxResults(Integer maxResults) { this.maxResults = maxResults; } /** *

* The maximum number of results to return at one time. *

*

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Range: 1 - 500
* * @param maxResults

* The maximum number of results to return at one time. *

* @return A reference to this updated object so that method calls can be * chained together. */ public SearchIndexRequest withMaxResults(Integer maxResults) { this.maxResults = maxResults; return this; } /** *

* The query version. *

* * @return

* The query version. *

*/ public String getQueryVersion() { return queryVersion; } /** *

* The query version. *

* * @param queryVersion

* The query version. *

*/ public void setQueryVersion(String queryVersion) { this.queryVersion = queryVersion; } /** *

* The query version. *

*

* Returns a reference to this object so that method calls can be chained * together. * * @param queryVersion

* The query version. *

* @return A reference to this updated object so that method calls can be * chained together. */ public SearchIndexRequest withQueryVersion(String queryVersion) { this.queryVersion = queryVersion; return this; } /** * Returns a string representation of this object; useful for testing and * debugging. * * @return A string representation of this object. * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getIndexName() != null) sb.append("indexName: " + getIndexName() + ","); if (getQueryString() != null) sb.append("queryString: " + getQueryString() + ","); if (getNextToken() != null) sb.append("nextToken: " + getNextToken() + ","); if (getMaxResults() != null) sb.append("maxResults: " + getMaxResults() + ","); if (getQueryVersion() != null) sb.append("queryVersion: " + getQueryVersion()); sb.append("}"); return sb.toString(); } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getIndexName() == null) ? 0 : getIndexName().hashCode()); hashCode = prime * hashCode + ((getQueryString() == null) ? 0 : getQueryString().hashCode()); hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode()); hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode()); hashCode = prime * hashCode + ((getQueryVersion() == null) ? 0 : getQueryVersion().hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof SearchIndexRequest == false) return false; SearchIndexRequest other = (SearchIndexRequest) obj; if (other.getIndexName() == null ^ this.getIndexName() == null) return false; if (other.getIndexName() != null && other.getIndexName().equals(this.getIndexName()) == 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.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; if (other.getQueryVersion() == null ^ this.getQueryVersion() == null) return false; if (other.getQueryVersion() != null && other.getQueryVersion().equals(this.getQueryVersion()) == false) return false; return true; } }