java.lang.Object
- org.elasticsearch.transport.TransportMessage
- - org.elasticsearch.transport.TransportRequest
  - - org.elasticsearch.action.ActionRequest
    - - org.elasticsearch.client.ml.GetBucketsRequest

All Implemented Interfaces:

Streamable, Writeable, ToXContent, ToXContentObject, TaskAwareRequest
```
public class GetBucketsRequest
extends ActionRequest
implements ToXContentObject
```
A request to retrieve buckets of a given job

Nested Class Summary
- Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportRequest
  TransportRequest.Empty
- Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent
  ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params
- Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
  Writeable.Reader<V extends java.lang.Object>, Writeable.Writer<V extends java.lang.Object>

Field Summary

Fields
Modifier and Type	Field	Description
`static ParseField`	`ANOMALY_SCORE`
`static ParseField`	`DESCENDING`
`static ParseField`	`END`
`static ParseField`	`EXCLUDE_INTERIM`
`static ParseField`	`EXPAND`
`static ObjectParser<GetBucketsRequest,java.lang.Void>`	`PARSER`
`static ParseField`	`SORT`
`static ParseField`	`START`

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent
EMPTY_PARAMS

Constructor Summary

Constructors
Constructor Description

GetBucketsRequest(java.lang.String jobId)
Constructs a request to retrieve buckets of a given job

Method Summary

Modifier and Type	Method	Description
`boolean`	`equals(java.lang.Object obj)`
`java.lang.Double`	`getAnomalyScore()`
`java.lang.Boolean`	`getDescending()`
`java.lang.String`	`getEnd()`
`java.lang.Boolean`	`getExcludeInterim()`
`java.lang.String`	`getJobId()`
`PageParams`	`getPageParams()`
`java.lang.String`	`getSort()`
`java.lang.String`	`getStart()`
`java.lang.String`	`getTimestamp()`
`int`	`hashCode()`
`boolean`	`isExpand()`
`void`	`setAnomalyScore(java.lang.Double anomalyScore)`	Sets the value of "anomaly_score".
`void`	`setDescending(boolean descending)`	Sets the value of "desc".
`void`	`setEnd(java.lang.String end)`	Sets the value of "end" which is a timestamp.
`void`	`setExcludeInterim(java.lang.Boolean excludeInterim)`	Sets the value of "exclude_interim".
`void`	`setExpand(java.lang.Boolean expand)`	Sets the value of "expand".
`void`	`setPageParams(PageParams pageParams)`	Sets the paging parameters
`void`	`setSort(java.lang.String sort)`	Sets the value of "sort".
`void`	`setStart(java.lang.String start)`	Sets the value of "start" which is a timestamp.
`void`	`setTimestamp(java.lang.String timestamp)`	Sets the timestamp of a specific bucket to be retrieved.
`XContentBuilder`	`toXContent(XContentBuilder builder, ToXContent.Params params)`
`ActionRequestValidationException`	`validate()`

Methods inherited from class org.elasticsearch.action.ActionRequest
getShouldStoreResult, readFrom, writeTo

Methods inherited from class org.elasticsearch.transport.TransportRequest
getParentTask, setParentTask

Methods inherited from class org.elasticsearch.transport.TransportMessage
remoteAddress, remoteAddress

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

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest
createTask, getDescription, setParentTask

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject
isFragment

- Field Detail
  - EXPAND
```
public static final ParseField EXPAND
```
  - EXCLUDE_INTERIM
```
public static final ParseField EXCLUDE_INTERIM
```
  - START
```
public static final ParseField START
```
  - END
```
public static final ParseField END
```
  - ANOMALY_SCORE
```
public static final ParseField ANOMALY_SCORE
```
  - SORT
```
public static final ParseField SORT
```
  - DESCENDING
```
public static final ParseField DESCENDING
```
  - PARSER
```
public static final ObjectParser<GetBucketsRequest,java.lang.Void> PARSER
```
- Constructor Detail
  - GetBucketsRequest
```
public GetBucketsRequest(java.lang.String jobId)
```
    Constructs a request to retrieve buckets of a given job
    
    Parameters:
    
    jobId - id of the job to retrieve buckets of
- Method Detail
  - getJobId
```
public java.lang.String getJobId()
```
  - setTimestamp
```
public void setTimestamp(java.lang.String timestamp)
```
    Sets the timestamp of a specific bucket to be retrieved.
    
    Parameters:
    
    timestamp - String representation of a timestamp; may be an epoch seconds, epoch millis or an ISO string
  - getTimestamp
```
public java.lang.String getTimestamp()
```
  - isExpand
```
public boolean isExpand()
```
  - setExpand
```
public void setExpand(java.lang.Boolean expand)
```
    Sets the value of "expand". When true, buckets will be expanded to include their records.
    
    Parameters:
    
    expand - value of "expand" to be set
  - getExcludeInterim
```
public java.lang.Boolean getExcludeInterim()
```
  - setExcludeInterim
```
public void setExcludeInterim(java.lang.Boolean excludeInterim)
```
    Sets the value of "exclude_interim". When true, interim buckets will be filtered out.
    
    Parameters:
    
    excludeInterim - value of "exclude_interim" to be set
  - getStart
```
public java.lang.String getStart()
```
  - setStart
```
public void setStart(java.lang.String start)
```
    Sets the value of "start" which is a timestamp. Only buckets whose timestamp is on or after the "start" value will be returned.
    
    Parameters:
    
    start - String representation of a timestamp; may be an epoch seconds, epoch millis or an ISO string
  - getEnd
```
public java.lang.String getEnd()
```
  - setEnd
```
public void setEnd(java.lang.String end)
```
    Sets the value of "end" which is a timestamp. Only buckets whose timestamp is before the "end" value will be returned.
    
    Parameters:
    
    end - String representation of a timestamp; may be an epoch seconds, epoch millis or an ISO string
  - getPageParams
```
public PageParams getPageParams()
```
  - setPageParams
```
public void setPageParams(PageParams pageParams)
```
    Sets the paging parameters
    
    Parameters:
    
    pageParams - the paging parameters
  - getAnomalyScore
```
public java.lang.Double getAnomalyScore()
```
  - setAnomalyScore
```
public void setAnomalyScore(java.lang.Double anomalyScore)
```
    Sets the value of "anomaly_score". Only buckets with "anomaly_score" equal or greater will be returned.
    
    Parameters:
    
    anomalyScore - value of "anomaly_score".
  - getSort
```
public java.lang.String getSort()
```
  - setSort
```
public void setSort(java.lang.String sort)
```
    Sets the value of "sort". Specifies the bucket field to sort on.
    
    Parameters:
    
    sort - value of "sort".
  - getDescending
```
public java.lang.Boolean getDescending()
```
  - setDescending
```
public void setDescending(boolean descending)
```
    Sets the value of "desc". Specifies the sorting order.
    
    Parameters:
    
    descending - value of "desc"
  - validate
```
public ActionRequestValidationException validate()
```
    Specified by:
    
    validate in class ActionRequest
  - toXContent
```
public XContentBuilder toXContent(XContentBuilder builder,
                                  ToXContent.Params params)
                           throws java.io.IOException
```
    Specified by:
    
    toXContent in interface ToXContent
    
    Throws:
    
    java.io.IOException
  - 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

Class GetBucketsRequest

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportRequest

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Field Summary

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

Constructor Summary

Method Summary

Methods inherited from class org.elasticsearch.action.ActionRequest

Methods inherited from class org.elasticsearch.transport.TransportRequest

Methods inherited from class org.elasticsearch.transport.TransportMessage

Methods inherited from class java.lang.Object

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject

Field Detail

EXPAND

EXCLUDE_INTERIM

START

END

ANOMALY_SCORE

SORT

DESCENDING

PARSER

Constructor Detail

GetBucketsRequest

Method Detail

getJobId

setTimestamp

getTimestamp

isExpand

setExpand

getExcludeInterim

setExcludeInterim

getStart

setStart

getEnd

setEnd

getPageParams

setPageParams

getAnomalyScore

setAnomalyScore

getSort

setSort

getDescending

setDescending

validate

toXContent

hashCode

equals