Package co.elastic.clients.elasticsearch.ml

Class GetBucketsRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.ml.GetBucketsRequest

All Implemented Interfaces:

ElasticsearchCommonRequest, JsonpSerializable

@JsonpDeserializable
public final class GetBucketsRequest
extends RequestBase
implements JsonpSerializable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GetBucketsRequest.Builder	Builder for GetBucketsRequest.

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static JsonpDeserializer<GetBucketsRequest>	_DESERIALIZER	Json deserializer for GetBucketsRequest
static Endpoint<GetBucketsRequest,GetBucketsResponse,ElasticsearchError>	ENDPOINT	Endpoint "ml.get_buckets".

Constructor Summary

Constructors

Constructor	Description
GetBucketsRequest(GetBucketsRequest.Builder builder)
GetBucketsRequest(java.util.function.Function<GetBucketsRequest.Builder,GetBucketsRequest.Builder> fn)

Method Summary

Modifier and Type	Method	Description
java.lang.Double	anomalyScore()	API name: anomaly_score
java.lang.Boolean	desc()	API name: desc
java.lang.String	end()	API name: end
java.lang.Boolean	excludeInterim()	API name: exclude_interim
java.lang.Boolean	expand()	API name: expand
java.lang.Integer	from()	skips a number of buckets
java.lang.String	jobId()	Required - ID of the job to get bucket results from
Page	page()	API name: page
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	setupGetBucketsRequestDeserializer(DelegatingDeserializer<GetBucketsRequest.Builder> op)
java.lang.Integer	size()	specifies a max number of buckets to get
java.lang.String	sort()	API name: sort
java.lang.String	start()	API name: start
java.lang.String	timestamp()	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

Field Details

_DESERIALIZER

public static final JsonpDeserializer<GetBucketsRequest> _DESERIALIZER

Json deserializer for GetBucketsRequest

ENDPOINT

public static final Endpoint<GetBucketsRequest,GetBucketsResponse,ElasticsearchError> ENDPOINT

Endpoint "ml.get_buckets".

Constructor Details

GetBucketsRequest

public GetBucketsRequest(GetBucketsRequest.Builder builder)

GetBucketsRequest

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

Method Details

jobId

public java.lang.String jobId()

Required - ID of the job to get bucket results from

API name: job_id

timestamp

@Nullable
public java.lang.String timestamp()

The timestamp of the desired single bucket result

API name: timestamp

from

@Nullable
public java.lang.Integer from()

skips a number of buckets

API name: from

size

@Nullable
public java.lang.Integer size()

specifies a max number of buckets to get

API name: size

anomalyScore

@Nullable
public java.lang.Double anomalyScore()

API name: anomaly_score

desc

@Nullable
public java.lang.Boolean desc()

API name: desc

excludeInterim

@Nullable
public java.lang.Boolean excludeInterim()

API name: exclude_interim

expand

@Nullable
public java.lang.Boolean expand()

API name: expand

page

@Nullable
public Page page()

API name: page

sort

@Nullable
public java.lang.String sort()

API name: sort

start

@Nullable
public java.lang.String start()

API name: start

end

@Nullable
public java.lang.String end()

API name: end

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
JsonpMapper mapper)

setupGetBucketsRequestDeserializer

protected static void setupGetBucketsRequestDeserializer(DelegatingDeserializer<GetBucketsRequest.Builder> op)