Class GetOverallBucketsRequest
- All Implemented Interfaces:
JsonpSerializable
The overall_score
is calculated by combining the scores of all
the buckets within the overall bucket span. First, the maximum
anomaly_score
per anomaly detection job in the overall bucket is
calculated. Then the top_n
of those scores are averaged to
result in the overall_score
. This means that you can fine-tune
the overall_score
so that it is more or less sensitive to the
number of jobs that detect an anomaly at the same time. For example, if you
set top_n
to 1
, the overall_score
is
the maximum bucket score in the overall bucket. Alternatively, if you set
top_n
to the number of jobs, the overall_score
is
high only when all jobs detect anomalies in that overall bucket. If you set
the bucket_span
parameter (to a value greater than its default),
the overall_score
is the maximum overall_score
of
the overall buckets that have a span equal to the jobs' largest bucket span.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final JsonpDeserializer<GetOverallBucketsRequest>
Json deserializer forGetOverallBucketsRequest
Endpoint "ml.get_overall_buckets
". -
Method Summary
Modifier and TypeMethodDescriptionfinal Boolean
Refer to the description for theallow_no_match
query parameter.final Time
Refer to the description for thebucket_span
query parameter.final DateTime
end()
Refer to the description for theend
query parameter.final Boolean
Refer to the description for theexclude_interim
query parameter.final String
jobId()
Required - Identifier for the anomaly detection job.static GetOverallBucketsRequest
final String
Refer to the description for theoverall_score
query parameter.void
serialize
(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) Serialize this object to JSON.protected void
serializeInternal
(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) protected static void
final DateTime
start()
Refer to the description for thestart
query parameter.final Integer
topN()
Refer to the description for thetop_n
query parameter.Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
-
Field Details
-
_DESERIALIZER
Json deserializer forGetOverallBucketsRequest
-
_ENDPOINT
public static final Endpoint<GetOverallBucketsRequest,GetOverallBucketsResponse, _ENDPOINTErrorResponse> Endpoint "ml.get_overall_buckets
".
-
-
Method Details
-
of
public static GetOverallBucketsRequest of(Function<GetOverallBucketsRequest.Builder, ObjectBuilder<GetOverallBucketsRequest>> fn) -
allowNoMatch
Refer to the description for theallow_no_match
query parameter.API name:
allow_no_match
-
bucketSpan
Refer to the description for thebucket_span
query parameter.API name:
bucket_span
-
end
Refer to the description for theend
query parameter.API name:
end
-
excludeInterim
Refer to the description for theexclude_interim
query parameter.API name:
exclude_interim
-
jobId
Required - Identifier for the anomaly detection job. It can be a job identifier, a group name, a comma-separated list of jobs or groups, or a wildcard expression.You can summarize the bucket results for all anomaly detection jobs by using
_all
or by specifying*
as the<job_id>
.API name:
job_id
-
overallScore
Refer to the description for theoverall_score
query parameter.API name:
overall_score
-
start
Refer to the description for thestart
query parameter.API name:
start
-
topN
Refer to the description for thetop_n
query parameter.API name:
top_n
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
setupGetOverallBucketsRequestDeserializer
protected static void setupGetOverallBucketsRequestDeserializer(ObjectDeserializer<GetOverallBucketsRequest.Builder> op)
-