Package co.elastic.clients.elasticsearch.ml

Class GetBucketsRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<GetBucketsRequest.Builder>

co.elastic.clients.elasticsearch.ml.GetBucketsRequest.Builder

All Implemented Interfaces:

WithJson<GetBucketsRequest.Builder>, ObjectBuilder<GetBucketsRequest>

Enclosing class:

GetBucketsRequest

public static class GetBucketsRequest.Builder
extends WithJsonObjectBuilderBase<GetBucketsRequest.Builder>
implements ObjectBuilder<GetBucketsRequest>

Builder for GetBucketsRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GetBucketsRequest.Builder	anomalyScore(java.lang.Double value)	Refer to the description for the anomaly_score query parameter.
GetBucketsRequest	build()	Builds a GetBucketsRequest.
GetBucketsRequest.Builder	desc(java.lang.Boolean value)	Refer to the description for the desc query parameter.
GetBucketsRequest.Builder	end(java.lang.String value)	Refer to the description for the end query parameter.
GetBucketsRequest.Builder	excludeInterim(java.lang.Boolean value)	Refer to the description for the exclude_interim query parameter.
GetBucketsRequest.Builder	expand(java.lang.Boolean value)	Refer to the description for the expand query parameter.
GetBucketsRequest.Builder	from(java.lang.Integer value)	Skips the specified number of buckets.
GetBucketsRequest.Builder	jobId(java.lang.String value)	Required - Identifier for the anomaly detection job.
GetBucketsRequest.Builder	page(Page value)	API name: page
GetBucketsRequest.Builder	page(java.util.function.Function<Page.Builder,ObjectBuilder<Page>> fn)	API name: page
protected GetBucketsRequest.Builder	self()
GetBucketsRequest.Builder	size(java.lang.Integer value)	Specifies the maximum number of buckets to obtain.
GetBucketsRequest.Builder	sort(java.lang.String value)	Refer to the desription for the sort query parameter.
GetBucketsRequest.Builder	start(java.lang.String value)	Refer to the description for the start query parameter.
GetBucketsRequest.Builder	timestamp(java.lang.String value)	The timestamp of a single bucket result.

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

anomalyScore

public final GetBucketsRequest.Builder anomalyScore(@Nullable
java.lang.Double value)

Refer to the description for the anomaly_score query parameter.

API name: anomaly_score

desc

public final GetBucketsRequest.Builder desc(@Nullable
java.lang.Boolean value)

Refer to the description for the desc query parameter.

API name: desc

end

public final GetBucketsRequest.Builder end(@Nullable
java.lang.String value)

Refer to the description for the end query parameter.

API name: end

excludeInterim

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

Refer to the description for the exclude_interim query parameter.

API name: exclude_interim

expand

public final GetBucketsRequest.Builder expand(@Nullable
java.lang.Boolean value)

Refer to the description for the expand query parameter.

API name: expand

from

public final GetBucketsRequest.Builder from(@Nullable
java.lang.Integer value)

Skips the specified number of buckets.

API name: from

jobId

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

Required - Identifier for the anomaly detection job.

API name: job_id

page

public final GetBucketsRequest.Builder page(@Nullable
Page value)

API name: page

page

public final GetBucketsRequest.Builder page(java.util.function.Function<Page.Builder,ObjectBuilder<Page>> fn)

API name: page

size

public final GetBucketsRequest.Builder size(@Nullable
java.lang.Integer value)

Specifies the maximum number of buckets to obtain.

API name: size

sort

public final GetBucketsRequest.Builder sort(@Nullable
java.lang.String value)

Refer to the desription for the sort query parameter.

API name: sort

start

public final GetBucketsRequest.Builder start(@Nullable
java.lang.String value)

Refer to the description for the start query parameter.

API name: start

timestamp

public final GetBucketsRequest.Builder timestamp(@Nullable
java.lang.String value)

The timestamp of a single bucket result. If you do not specify this parameter, the API returns information about all buckets.

API name: timestamp

self

protected GetBucketsRequest.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<GetBucketsRequest.Builder>

build

public GetBucketsRequest build()

Builds a GetBucketsRequest.

Specified by:

build in interface ObjectBuilder<GetBucketsRequest>

Throws:

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