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 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
-
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 parametersvoid
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.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
-
Field Details
-
Constructor Details
-
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 Details
-
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". Whentrue
, 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". Whentrue
, 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
-
setPageParams
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
- Specified by:
validate
in classActionRequest
-
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException- Specified by:
toXContent
in interfaceToXContent
- Throws:
java.io.IOException
-
hashCode
public int hashCode()- Overrides:
hashCode
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object obj)- Overrides:
equals
in classjava.lang.Object
-