Package org.elasticsearch.client.ml
Class GetOverallBucketsRequest
java.lang.Object
org.elasticsearch.client.ml.GetOverallBucketsRequest
- All Implemented Interfaces:
Validatable
,org.elasticsearch.common.xcontent.ToXContent
,org.elasticsearch.common.xcontent.ToXContentObject
public class GetOverallBucketsRequest
extends Object
implements Validatable, org.elasticsearch.common.xcontent.ToXContentObject
A request to retrieve overall buckets of set of jobs
-
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.ConstructingObjectParser<GetOverallBucketsRequest,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
ConstructorDescriptionGetOverallBucketsRequest(String... jobIds)
Constructs a request to retrieve overall buckets for a set of jobsGetOverallBucketsRequest(List<String> jobIds)
Constructs a request to retrieve overall buckets for a set of jobs -
Method Summary
Modifier and TypeMethodDescriptionboolean
Whether to ignore if a wildcard expression matches no jobs.org.elasticsearch.core.TimeValue
getEnd()
getStart()
getTopN()
int
hashCode()
boolean
void
setAllowNoMatch(boolean allowNoMatch)
void
setBucketSpan(org.elasticsearch.core.TimeValue bucketSpan)
Sets the value of "bucket_span".void
Sets the value of "end" which is a timestamp.void
setExcludeInterim(Boolean excludeInterim)
Sets the value of "exclude_interim".void
setOverallScore(double overallScore)
Sets the value of "overall_score".void
Sets the value of "start" which is a timestamp.void
Sets the value of "top_n".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
-
TOP_N
public static final org.elasticsearch.common.xcontent.ParseField TOP_N -
BUCKET_SPAN
public static final org.elasticsearch.common.xcontent.ParseField BUCKET_SPAN -
OVERALL_SCORE
public static final org.elasticsearch.common.xcontent.ParseField OVERALL_SCORE -
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 -
ALLOW_NO_MATCH
public static final org.elasticsearch.common.xcontent.ParseField ALLOW_NO_MATCH -
PARSER
public static final org.elasticsearch.common.xcontent.ConstructingObjectParser<GetOverallBucketsRequest,Void> PARSER
-
-
Constructor Details
-
GetOverallBucketsRequest
Constructs a request to retrieve overall buckets for a set of jobs- Parameters:
jobIds
- The job identifiers. Each can be a job identifier, a group name, or a wildcard expression.
-
GetOverallBucketsRequest
Constructs a request to retrieve overall buckets for a set of jobs- Parameters:
jobIds
- The job identifiers. Each can be a job identifier, a group name, or a wildcard expression.
-
-
Method Details
-
getJobIds
-
getTopN
-
setTopN
Sets the value of "top_n".- Parameters:
topN
- The number of top job bucket scores to be used in the overall_score calculation. Defaults to 1.
-
getBucketSpan
public org.elasticsearch.core.TimeValue getBucketSpan() -
setBucketSpan
public void setBucketSpan(org.elasticsearch.core.TimeValue bucketSpan)Sets the value of "bucket_span".- Parameters:
bucketSpan
- The span of the overall buckets. Must be greater or equal to the largest job’s bucket_span. Defaults to the largest job’s bucket_span.
-
isExcludeInterim
public boolean isExcludeInterim() -
setExcludeInterim
Sets the value of "exclude_interim". Whentrue
, interim overall buckets will be filtered out. Overall buckets are interim if any of the job buckets within the overall bucket interval are interim.- Parameters:
excludeInterim
- value of "exclude_interim" to be set
-
getStart
-
setStart
Sets the value of "start" which is a timestamp. Only overall 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 overall 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
-
getOverallScore
-
setOverallScore
public void setOverallScore(double overallScore)Sets the value of "overall_score". Only buckets with "overall_score" equal or greater will be returned.- Parameters:
overallScore
- value of "anomaly_score".
-
setAllowNoMatch
public void setAllowNoMatch(boolean allowNoMatch)- Parameters:
allowNoMatch
- value of "allow_no_match".
-
getAllowNoMatch
Whether to ignore if a wildcard expression matches no jobs. If this isfalse
, then an error is returned when a wildcard (or_all
) does not match any jobs -
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
-