Package org.elasticsearch.client.ml

Class GetBucketsRequest

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest

org.elasticsearch.client.ml.GetBucketsRequest

All Implemented Interfaces:

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>, Writeable.Writer<V>

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,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(String jobId)	Constructs a request to retrieve buckets of a given job

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
Double	getAnomalyScore()
Boolean	getDescending()
String	getEnd()
Boolean	getExcludeInterim()
String	getJobId()
PageParams	getPageParams()
String	getSort()
String	getStart()
String	getTimestamp()
int	hashCode()
boolean	isExpand()
void	setAnomalyScore(Double anomalyScore)	Sets the value of "anomaly_score".
void	setDescending(boolean descending)	Sets the value of "desc".
void	setEnd(String end)	Sets the value of "end" which is a timestamp.
void	setExcludeInterim(Boolean excludeInterim)	Sets the value of "exclude_interim".
void	setExpand(Boolean expand)	Sets the value of "expand".
void	setPageParams(PageParams pageParams)	Sets the paging parameters
void	setSort(String sort)	Sets the value of "sort".
void	setStart(String start)	Sets the value of "start" which is a timestamp.
void	setTimestamp(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, 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,Void> PARSER

Constructor Detail

GetBucketsRequest

public GetBucketsRequest(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 String getJobId()

setTimestamp

public void setTimestamp(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 String getTimestamp()

isExpand

public boolean isExpand()

setExpand

public void setExpand(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 Boolean getExcludeInterim()

setExcludeInterim

public void setExcludeInterim(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 String getStart()

setStart

public void setStart(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 String getEnd()

setEnd

public void setEnd(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 Double getAnomalyScore()

setAnomalyScore

public void setAnomalyScore(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 String getSort()

setSort

public void setSort(String sort)

Sets the value of "sort". Specifies the bucket field to sort on.

Parameters:

sort - value of "sort".

getDescending

public 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 IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object