Package co.elastic.clients.elasticsearch.ml

Class GetCategoriesRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.ml.GetCategoriesRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class GetCategoriesRequest
extends RequestBase
implements JsonpSerializable

Retrieves anomaly detection job results for one or more categories.

See Also:

API specification

Nested Class Summary

Nested Classes

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

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<GetCategoriesRequest>	_DESERIALIZER	Json deserializer for GetCategoriesRequest
static Endpoint<GetCategoriesRequest,GetCategoriesResponse,ErrorResponse>	_ENDPOINT	Endpoint "ml.get_categories".

Method Summary

Modifier and Type	Method	Description
java.lang.String	categoryId()	Identifier for the category, which is unique in the job.
java.lang.Integer	from()	Skips the specified number of categories.
java.lang.String	jobId()	Required - Identifier for the anomaly detection job.
static GetCategoriesRequest	of(java.util.function.Function<GetCategoriesRequest.Builder,ObjectBuilder<GetCategoriesRequest>> fn)
Page	page()	API name: page
java.lang.String	partitionFieldValue()	Only return categories for the specified partition.
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	setupGetCategoriesRequestDeserializer(ObjectDeserializer<GetCategoriesRequest.Builder> op)
java.lang.Integer	size()	Specifies the maximum number of categories to obtain.

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<GetCategoriesRequest> _DESERIALIZER

Json deserializer for GetCategoriesRequest

_ENDPOINT

public static final Endpoint<GetCategoriesRequest,GetCategoriesResponse,ErrorResponse> _ENDPOINT

Endpoint "ml.get_categories".

Method Details

of

public static GetCategoriesRequest of(java.util.function.Function<GetCategoriesRequest.Builder,ObjectBuilder<GetCategoriesRequest>> fn)

categoryId

@Nullable
public final java.lang.String categoryId()

Identifier for the category, which is unique in the job. If you specify neither the category ID nor the partition_field_value, the API returns information about all categories. If you specify only the partition_field_value, it returns information about all categories for the specified partition.

API name: category_id

from

@Nullable
public final java.lang.Integer from()

Skips the specified number of categories.

API name: from

jobId

public final java.lang.String jobId()

Required - Identifier for the anomaly detection job.

API name: job_id

page

@Nullable
public final Page page()

API name: page

partitionFieldValue

@Nullable
public final java.lang.String partitionFieldValue()

Only return categories for the specified partition.

API name: partition_field_value

size

@Nullable
public final java.lang.Integer size()

Specifies the maximum number of categories to obtain.

API name: size

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)

setupGetCategoriesRequestDeserializer

protected static void setupGetCategoriesRequestDeserializer(ObjectDeserializer<GetCategoriesRequest.Builder> op)