Package co.elastic.clients.elasticsearch.ml

Class GetBucketsRequest.Builder

java.lang.Object

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

All Implemented Interfaces:

ObjectBuilder<GetBucketsRequest>

Enclosing class:

GetBucketsRequest

public static class GetBucketsRequest.Builder
extends java.lang.Object
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)	API name: anomaly_score
GetBucketsRequest	build()	Builds a GetBucketsRequest.
GetBucketsRequest.Builder	desc(java.lang.Boolean value)	API name: desc
GetBucketsRequest.Builder	end(java.lang.String value)	API name: end
GetBucketsRequest.Builder	excludeInterim(java.lang.Boolean value)	API name: exclude_interim
GetBucketsRequest.Builder	expand(java.lang.Boolean value)	API name: expand
GetBucketsRequest.Builder	from(java.lang.Integer value)	skips a number of buckets
GetBucketsRequest.Builder	jobId(java.lang.String value)	Required - ID of the job to get bucket results from
GetBucketsRequest.Builder	page(Page value)	API name: page
GetBucketsRequest.Builder	page(java.util.function.Function<Page.Builder,ObjectBuilder<Page>> fn)	API name: page
GetBucketsRequest.Builder	size(java.lang.Integer value)	specifies a max number of buckets to get
GetBucketsRequest.Builder	sort(java.lang.String value)	API name: sort
GetBucketsRequest.Builder	start(java.lang.String value)	API name: start
GetBucketsRequest.Builder	timestamp(java.lang.String value)	The timestamp of the desired single bucket result

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

jobId

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

Required - ID of the job to get bucket results from

API name: job_id

timestamp

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

The timestamp of the desired single bucket result

API name: timestamp

from

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

skips a number of buckets

API name: from

size

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

specifies a max number of buckets to get

API name: size

anomalyScore

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

API name: anomaly_score

desc

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

API name: desc

excludeInterim

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

API name: exclude_interim

expand

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

API name: expand

page

public GetBucketsRequest.Builder page(@Nullable
Page value)

API name: page

page

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

API name: page

sort

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

API name: sort

start

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

API name: start

end

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

API name: end

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.