com.amazonaws.services.iot.model

Class GetPercentilesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.iot.model.GetPercentilesRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class GetPercentilesRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Groups the aggregated values that match the query into percentile groupings. The default percentile groupings are: 1,5,25,50,75,95,99, although you can specify your own when you call GetPercentiles. This function returns a value for each percentile group specified (or the default percentile groupings). The percentile group "1" contains the aggregated field value that occurs in approximately one percent of the values that match the query. The percentile group "5" contains the aggregated field value that occurs in approximately five percent of the values that match the query, and so on. The result is an approximation, the more values that match the query, the more accurate the percentile values.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GetPercentilesRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getAggregationField() The field to aggregate.
java.lang.String	getIndexName() The name of the index to search.
java.util.List<java.lang.Double>	getPercents() The percentile groups returned.
java.lang.String	getQueryString() The query string.
java.lang.String	getQueryVersion() The query version.
int	hashCode()
void	setAggregationField(java.lang.String aggregationField) The field to aggregate.
void	setIndexName(java.lang.String indexName) The name of the index to search.
void	setPercents(java.util.Collection<java.lang.Double> percents) The percentile groups returned.
void	setQueryString(java.lang.String queryString) The query string.
void	setQueryVersion(java.lang.String queryVersion) The query version.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
GetPercentilesRequest	withAggregationField(java.lang.String aggregationField) The field to aggregate.
GetPercentilesRequest	withIndexName(java.lang.String indexName) The name of the index to search.
GetPercentilesRequest	withPercents(java.util.Collection<java.lang.Double> percents) The percentile groups returned.
GetPercentilesRequest	withPercents(java.lang.Double... percents) The percentile groups returned.
GetPercentilesRequest	withQueryString(java.lang.String queryString) The query string.
GetPercentilesRequest	withQueryVersion(java.lang.String queryVersion) The query version.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GetPercentilesRequest

public GetPercentilesRequest()

Method Detail

getIndexName

public java.lang.String getIndexName()

The name of the index to search.

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

Returns:

The name of the index to search.

setIndexName

public void setIndexName(java.lang.String indexName)

The name of the index to search.

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

Parameters:

indexName -

The name of the index to search.

withIndexName

public GetPercentilesRequest withIndexName(java.lang.String indexName)

The name of the index to search.

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.

Returns:

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

getQueryString

public java.lang.String getQueryString()

The query string.

Constraints:
Length: 1 -

Returns:

The query string.

setQueryString

public void setQueryString(java.lang.String queryString)

The query string.

Constraints:
Length: 1 -

Parameters:

queryString -

The query string.

withQueryString

public GetPercentilesRequest withQueryString(java.lang.String queryString)

The query string.

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

Constraints:
Length: 1 -

Parameters:

queryString -

The query string.

Returns:

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

getAggregationField

public java.lang.String getAggregationField()

The field to aggregate.

Constraints:
Length: 1 -

Returns:

The field to aggregate.

setAggregationField

public void setAggregationField(java.lang.String aggregationField)

The field to aggregate.

Constraints:
Length: 1 -

Parameters:

aggregationField -

The field to aggregate.

withAggregationField

public GetPercentilesRequest withAggregationField(java.lang.String aggregationField)

The field to aggregate.

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

Constraints:
Length: 1 -

Parameters:

aggregationField -

The field to aggregate.

Returns:

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

getQueryVersion

public java.lang.String getQueryVersion()

The query version.

Returns:

The query version.

setQueryVersion

public void setQueryVersion(java.lang.String queryVersion)

The query version.

Parameters:

queryVersion -

The query version.

withQueryVersion

public GetPercentilesRequest withQueryVersion(java.lang.String queryVersion)

The query version.

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

Parameters:

queryVersion -

The query version.

Returns:

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

getPercents

public java.util.List<java.lang.Double> getPercents()

The percentile groups returned.

Returns:

The percentile groups returned.

setPercents

public void setPercents(java.util.Collection<java.lang.Double> percents)

The percentile groups returned.

Parameters:

percents -

The percentile groups returned.

withPercents

public GetPercentilesRequest withPercents(java.lang.Double... percents)

The percentile groups returned.

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

Parameters:

percents -

The percentile groups returned.

Returns:

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

withPercents

public GetPercentilesRequest withPercents(java.util.Collection<java.lang.Double> percents)

The percentile groups returned.

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

Parameters:

percents -

The percentile groups returned.

Returns:

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

toString

public java.lang.String toString()

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

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object