GetBucketsAggregationRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.iot.model.GetBucketsAggregationRequest

All Implemented Interfaces:: HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GetBucketsAggregationRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:: Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

GetBucketsAggregationRequest()

Constructors
Constructor and Description
`GetBucketsAggregationRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GetBucketsAggregationRequest`	`clone()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals(Object obj)`
`String`	`getAggregationField()` The aggregation field.
`BucketsAggregationType`	`getBucketsAggregationType()` The basic control of the response shape and the bucket aggregation type to perform.
`String`	`getIndexName()` The name of the index to search.
`String`	`getQueryString()` The search query string.
`String`	`getQueryVersion()` The version of the query.
`int`	`hashCode()`
`void`	`setAggregationField(String aggregationField)` The aggregation field.
`void`	`setBucketsAggregationType(BucketsAggregationType bucketsAggregationType)` The basic control of the response shape and the bucket aggregation type to perform.
`void`	`setIndexName(String indexName)` The name of the index to search.
`void`	`setQueryString(String queryString)` The search query string.
`void`	`setQueryVersion(String queryVersion)` The version of the query.
`String`	`toString()` Returns a string representation of this object.
`GetBucketsAggregationRequest`	`withAggregationField(String aggregationField)` The aggregation field.
`GetBucketsAggregationRequest`	`withBucketsAggregationType(BucketsAggregationType bucketsAggregationType)` The basic control of the response shape and the bucket aggregation type to perform.
`GetBucketsAggregationRequest`	`withIndexName(String indexName)` The name of the index to search.
`GetBucketsAggregationRequest`	`withQueryString(String queryString)` The search query string.
`GetBucketsAggregationRequest`	`withQueryVersion(String queryVersion)` The version of the query.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - GetBucketsAggregationRequest
```
public GetBucketsAggregationRequest()
```
- Method Detail
  - setIndexName
```
public void setIndexName(String indexName)
```
    The name of the index to search.
    
    Parameters:
    
    indexName - The name of the index to search.
  - getIndexName
```
public String getIndexName()
```
    The name of the index to search.
    
    Returns:
    
    The name of the index to search.
  - withIndexName
```
public GetBucketsAggregationRequest withIndexName(String indexName)
```
    The name of the index to search.
    
    Parameters:
    
    indexName - The name of the index to search.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setQueryString
```
public void setQueryString(String queryString)
```
    The search query string.
    
    Parameters:
    
    queryString - The search query string.
  - getQueryString
```
public String getQueryString()
```
    The search query string.
    
    Returns:
    
    The search query string.
  - withQueryString
```
public GetBucketsAggregationRequest withQueryString(String queryString)
```
    The search query string.
    
    Parameters:
    
    queryString - The search query string.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAggregationField
```
public void setAggregationField(String aggregationField)
```
    The aggregation field.
    
    Parameters:
    
    aggregationField - The aggregation field.
  - getAggregationField
```
public String getAggregationField()
```
    The aggregation field.
    
    Returns:
    
    The aggregation field.
  - withAggregationField
```
public GetBucketsAggregationRequest withAggregationField(String aggregationField)
```
    The aggregation field.
    
    Parameters:
    
    aggregationField - The aggregation field.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setQueryVersion
```
public void setQueryVersion(String queryVersion)
```
    The version of the query.
    
    Parameters:
    
    queryVersion - The version of the query.
  - getQueryVersion
```
public String getQueryVersion()
```
    The version of the query.
    
    Returns:
    
    The version of the query.
  - withQueryVersion
```
public GetBucketsAggregationRequest withQueryVersion(String queryVersion)
```
    The version of the query.
    
    Parameters:
    
    queryVersion - The version of the query.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBucketsAggregationType
```
public void setBucketsAggregationType(BucketsAggregationType bucketsAggregationType)
```
    The basic control of the response shape and the bucket aggregation type to perform.
    
    Parameters:
    
    bucketsAggregationType - The basic control of the response shape and the bucket aggregation type to perform.
  - getBucketsAggregationType
```
public BucketsAggregationType getBucketsAggregationType()
```
    The basic control of the response shape and the bucket aggregation type to perform.
    
    Returns:
    
    The basic control of the response shape and the bucket aggregation type to perform.
  - withBucketsAggregationType
```
public GetBucketsAggregationRequest withBucketsAggregationType(BucketsAggregationType bucketsAggregationType)
```
    The basic control of the response shape and the bucket aggregation type to perform.
    
    Parameters:
    
    bucketsAggregationType - The basic control of the response shape and the bucket aggregation type to perform.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    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.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public GetBucketsAggregationRequest clone()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    
    Object.clone()

AWS SDK for Java 1.x API Reference - 1.12.773

Class GetBucketsAggregationRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

GetBucketsAggregationRequest

Method Detail

setIndexName

getIndexName

withIndexName

setQueryString

getQueryString

withQueryString

setAggregationField

getAggregationField

withAggregationField

setQueryVersion

getQueryVersion

withQueryVersion

setBucketsAggregationType

getBucketsAggregationType

withBucketsAggregationType

toString

equals

hashCode

clone