/* * 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; /** *

* Returns the count, average, sum, minimum, maximum, sum of squares, variance, * and standard deviation for the specified aggregated field. If the aggregation * field is of type String, only the count statistic is returned. *

*

* Requires permission to access the GetStatistics action. *

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

* The name of the index to search. The default value is * AWS_Things. *

*

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

* The query used to search. You can specify "*" for the query string to get * the count of all indexed things in your Amazon Web Services account. *

*

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

* The aggregation field name. *

*

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

* The version of the query used to search. *

*/ private String queryVersion; /** *

* The name of the index to search. The default value is * AWS_Things. *

*

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

* The name of the index to search. The default value is * AWS_Things. *

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

* The name of the index to search. The default value is * AWS_Things. *

*

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

* The name of the index to search. The default value is * AWS_Things. *

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

* The name of the index to search. The default value is * AWS_Things. *

*

* 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 name of the index to search. The default value is * AWS_Things. *

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

* The query used to search. You can specify "*" for the query string to get * the count of all indexed things in your Amazon Web Services account. *

*

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

* The query used to search. You can specify "*" for the query * string to get the count of all indexed things in your Amazon Web * Services account. *

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

* The query used to search. You can specify "*" for the query string to get * the count of all indexed things in your Amazon Web Services account. *

*

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

* The query used to search. You can specify "*" for the query * string to get the count of all indexed things in your Amazon * Web Services account. *

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

* The query used to search. You can specify "*" for the query string to get * the count of all indexed things in your Amazon Web Services account. *

*

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

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

* The query used to search. You can specify "*" for the query * string to get the count of all indexed things in your Amazon * Web Services account. *

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

* The aggregation field name. *

*

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

* The aggregation field name. *

*/ public String getAggregationField() { return aggregationField; } /** *

* The aggregation field name. *

*

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

* The aggregation field name. *

*/ public void setAggregationField(String aggregationField) { this.aggregationField = aggregationField; } /** *

* The aggregation field name. *

*

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

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

* The aggregation field name. *

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

* The version of the query used to search. *

* * @return

* The version of the query used to search. *

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

* The version of the query used to search. *

* * @param queryVersion

* The version of the query used to search. *

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

* The version of the query used to search. *

*

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

* The version of the query used to search. *

* @return A reference to this updated object so that method calls can be * chained together. */ public GetStatisticsRequest 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 (getAggregationField() != null) sb.append("aggregationField: " + getAggregationField() + ","); 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 + ((getAggregationField() == null) ? 0 : getAggregationField().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 GetStatisticsRequest == false) return false; GetStatisticsRequest other = (GetStatisticsRequest) 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.getAggregationField() == null ^ this.getAggregationField() == null) return false; if (other.getAggregationField() != null && other.getAggregationField().equals(this.getAggregationField()) == 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; } }