com.amazonaws.services.iot.model

Class GetStatisticsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.iot.model.GetStatisticsRequest

All Implemented Interfaces:

Serializable, Cloneable

public class GetStatisticsRequest
extends AmazonWebServiceRequest
implements Serializable

Gets statistics about things that match the specified query.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GetStatisticsRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getAggregationField() The aggregation field name.
String	getIndexName() The name of the index to search.
String	getQueryString() The query used to search.
String	getQueryVersion() The version of the query used to search.
int	hashCode()
void	setAggregationField(String aggregationField) The aggregation field name.
void	setIndexName(String indexName) The name of the index to search.
void	setQueryString(String queryString) The query used to search.
void	setQueryVersion(String queryVersion) The version of the query used to search.
String	toString() Returns a string representation of this object; useful for testing and debugging.
GetStatisticsRequest	withAggregationField(String aggregationField) The aggregation field name.
GetStatisticsRequest	withIndexName(String indexName) The name of the index to search.
GetStatisticsRequest	withQueryString(String queryString) The query used to search.
GetStatisticsRequest	withQueryVersion(String queryVersion) The version of the query used to search.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GetStatisticsRequest

public GetStatisticsRequest()

Method Detail

getIndexName

public String getIndexName()

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

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

Returns:

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

setIndexName

public void setIndexName(String indexName)

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

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

Parameters:

indexName -

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

withIndexName

public GetStatisticsRequest withIndexName(String 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:_-]+

Parameters:

indexName -

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

Returns:

A reference to this updated object so that method calls can be chained together.

getQueryString

public String getQueryString()

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

Constraints:
Length: 1 -

Returns:

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

setQueryString

public void setQueryString(String queryString)

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

Constraints:
Length: 1 -

Parameters:

queryString -

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

withQueryString

public GetStatisticsRequest withQueryString(String queryString)

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

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

Constraints:
Length: 1 -

Parameters:

queryString -

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

Returns:

A reference to this updated object so that method calls can be chained together.

getAggregationField

public String getAggregationField()

The aggregation field name. Currently not supported.

Constraints:
Length: 1 -

Returns:

The aggregation field name. Currently not supported.

setAggregationField

public void setAggregationField(String aggregationField)

The aggregation field name. Currently not supported.

Constraints:
Length: 1 -

Parameters:

aggregationField -

The aggregation field name. Currently not supported.

withAggregationField

public GetStatisticsRequest withAggregationField(String aggregationField)

The aggregation field name. Currently not supported.

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

Constraints:
Length: 1 -

Parameters:

aggregationField -

The aggregation field name. Currently not supported.

Returns:

A reference to this updated object so that method calls can be chained together.

getQueryVersion

public String getQueryVersion()

The version of the query used to search.

Returns:

The version of the query used to search.

setQueryVersion

public void setQueryVersion(String queryVersion)

The version of the query used to search.

Parameters:

queryVersion -

The version of the query used to search.

withQueryVersion

public GetStatisticsRequest withQueryVersion(String queryVersion)

The version of the query used to search.

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

Parameters:

queryVersion -

The version of the query used to search.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object