Package org.elasticsearch.client.ml
Class GetBucketsRequest
java.lang.Object
org.elasticsearch.client.ml.GetBucketsRequest
- All Implemented Interfaces:
Validatable
,org.elasticsearch.common.xcontent.ToXContent
,org.elasticsearch.common.xcontent.ToXContentObject
public class GetBucketsRequest
extends Object
implements Validatable, org.elasticsearch.common.xcontent.ToXContentObject
A request to retrieve buckets of a given job
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent
org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.ToXContent.Params
-
Field Summary
Modifier and TypeFieldDescriptionstatic org.elasticsearch.common.xcontent.ParseField
static org.elasticsearch.common.xcontent.ParseField
static org.elasticsearch.common.xcontent.ParseField
static org.elasticsearch.common.xcontent.ParseField
static org.elasticsearch.common.xcontent.ParseField
static org.elasticsearch.common.xcontent.ObjectParser<GetBucketsRequest,Void>
static org.elasticsearch.common.xcontent.ParseField
static org.elasticsearch.common.xcontent.ParseField
Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent
EMPTY_PARAMS
Fields inherited from interface org.elasticsearch.client.Validatable
EMPTY
-
Constructor Summary
ConstructorDescriptionGetBucketsRequest(String jobId)
Constructs a request to retrieve buckets of a given job -
Method Summary
Modifier and TypeMethodDescriptionboolean
getEnd()
getJobId()
getSort()
getStart()
int
hashCode()
boolean
isExpand()
void
setAnomalyScore(Double anomalyScore)
Sets the value of "anomaly_score".void
setDescending(boolean descending)
Sets the value of "desc".void
Sets the value of "end" which is a timestamp.void
setExcludeInterim(Boolean excludeInterim)
Sets the value of "exclude_interim".void
Sets the value of "expand".void
setPageParams(PageParams pageParams)
Sets the paging parametersvoid
Sets the value of "sort".void
Sets the value of "start" which is a timestamp.void
setTimestamp(String timestamp)
Sets the timestamp of a specific bucket to be retrieved.org.elasticsearch.common.xcontent.XContentBuilder
toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject
isFragment
Methods inherited from interface org.elasticsearch.client.Validatable
validate
-
Field Details
-
EXPAND
public static final org.elasticsearch.common.xcontent.ParseField EXPAND -
EXCLUDE_INTERIM
public static final org.elasticsearch.common.xcontent.ParseField EXCLUDE_INTERIM -
START
public static final org.elasticsearch.common.xcontent.ParseField START -
END
public static final org.elasticsearch.common.xcontent.ParseField END -
ANOMALY_SCORE
public static final org.elasticsearch.common.xcontent.ParseField ANOMALY_SCORE -
SORT
public static final org.elasticsearch.common.xcontent.ParseField SORT -
DESCENDING
public static final org.elasticsearch.common.xcontent.ParseField DESCENDING -
PARSER
-
-
Constructor Details
-
GetBucketsRequest
Constructs a request to retrieve buckets of a given job- Parameters:
jobId
- id of the job to retrieve buckets of
-
-
Method Details
-
getJobId
-
setTimestamp
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
-
isExpand
public boolean isExpand() -
setExpand
Sets the value of "expand". Whentrue
, buckets will be expanded to include their records.- Parameters:
expand
- value of "expand" to be set
-
getExcludeInterim
-
setExcludeInterim
Sets the value of "exclude_interim". Whentrue
, interim buckets will be filtered out.- Parameters:
excludeInterim
- value of "exclude_interim" to be set
-
getStart
-
setStart
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
-
setEnd
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
-
setAnomalyScore
Sets the value of "anomaly_score". Only buckets with "anomaly_score" equal or greater will be returned.- Parameters:
anomalyScore
- value of "anomaly_score".
-
getSort
-
setSort
Sets the value of "sort". Specifies the bucket field to sort on.- Parameters:
sort
- value of "sort".
-
getDescending
-
setDescending
public void setDescending(boolean descending)Sets the value of "desc". Specifies the sorting order.- Parameters:
descending
- value of "desc"
-
toXContent
public org.elasticsearch.common.xcontent.XContentBuilder toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws IOException- Specified by:
toXContent
in interfaceorg.elasticsearch.common.xcontent.ToXContent
- Throws:
IOException
-
hashCode
public int hashCode() -
equals
-