Package co.elastic.clients.elasticsearch.ml

Class GetOverallBucketsRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<GetOverallBucketsRequest.Builder>

co.elastic.clients.elasticsearch.ml.GetOverallBucketsRequest.Builder

All Implemented Interfaces:

WithJson<GetOverallBucketsRequest.Builder>, ObjectBuilder<GetOverallBucketsRequest>

Enclosing class:

GetOverallBucketsRequest

public static class GetOverallBucketsRequest.Builder
extends RequestBase.AbstractBuilder<GetOverallBucketsRequest.Builder>
implements ObjectBuilder<GetOverallBucketsRequest>

Builder for GetOverallBucketsRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GetOverallBucketsRequest.Builder	allowNoMatch(java.lang.Boolean value)	Refer to the description for the allow_no_match query parameter.
GetOverallBucketsRequest.Builder	bucketSpan(Time value)	Refer to the description for the bucket_span query parameter.
GetOverallBucketsRequest.Builder	bucketSpan(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	Refer to the description for the bucket_span query parameter.
GetOverallBucketsRequest	build()	Builds a GetOverallBucketsRequest.
GetOverallBucketsRequest.Builder	end(DateTime value)	Refer to the description for the end query parameter.
GetOverallBucketsRequest.Builder	excludeInterim(java.lang.Boolean value)	Refer to the description for the exclude_interim query parameter.
GetOverallBucketsRequest.Builder	jobId(java.lang.String value)	Required - Identifier for the anomaly detection job.
GetOverallBucketsRequest.Builder	overallScore(java.lang.String value)	Refer to the description for the overall_score query parameter.
protected GetOverallBucketsRequest.Builder	self()
GetOverallBucketsRequest.Builder	start(DateTime value)	Refer to the description for the start query parameter.
GetOverallBucketsRequest.Builder	topN(java.lang.Integer value)	Refer to the description for the top_n query parameter.

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

allowNoMatch

public final GetOverallBucketsRequest.Builder allowNoMatch(@Nullable
java.lang.Boolean value)

Refer to the description for the allow_no_match query parameter.

API name: allow_no_match

bucketSpan

public final GetOverallBucketsRequest.Builder bucketSpan(@Nullable
Time value)

Refer to the description for the bucket_span query parameter.

API name: bucket_span

bucketSpan

public final GetOverallBucketsRequest.Builder bucketSpan(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)

Refer to the description for the bucket_span query parameter.

API name: bucket_span

end

public final GetOverallBucketsRequest.Builder end(@Nullable
DateTime value)

Refer to the description for the end query parameter.

API name: end

excludeInterim

public final GetOverallBucketsRequest.Builder excludeInterim(@Nullable
java.lang.Boolean value)

Refer to the description for the exclude_interim query parameter.

API name: exclude_interim

jobId

public final GetOverallBucketsRequest.Builder jobId(java.lang.String value)

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

public final GetOverallBucketsRequest.Builder overallScore(@Nullable
java.lang.String value)

Refer to the description for the overall_score query parameter.

API name: overall_score

start

public final GetOverallBucketsRequest.Builder start(@Nullable
DateTime value)

Refer to the description for the start query parameter.

API name: start

topN

public final GetOverallBucketsRequest.Builder topN(@Nullable
java.lang.Integer value)

Refer to the description for the top_n query parameter.

API name: top_n

self

protected GetOverallBucketsRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<GetOverallBucketsRequest.Builder>

build

public GetOverallBucketsRequest build()

Builds a GetOverallBucketsRequest.

Specified by:

build in interface ObjectBuilder<GetOverallBucketsRequest>

Throws:

java.lang.NullPointerException - if some of the required fields are null.