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

Get anomaly detection job results for 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 final JsonpDeserializer<GetCategoriesRequest>	_DESERIALIZER	Json deserializer for GetCategoriesRequest
static final Endpoint<GetCategoriesRequest,GetCategoriesResponse,ErrorResponse>	_ENDPOINT	Endpoint "ml.get_categories".

Method Summary

Modifier and Type	Method	Description
final String	categoryId()	Identifier for the category, which is unique in the job.
final Integer	from()	Skips the specified number of categories.
final String	jobId()	Required - Identifier for the anomaly detection job.
static GetCategoriesRequest	of(Function<GetCategoriesRequest.Builder,ObjectBuilder<GetCategoriesRequest>> fn)
final Page	page()	Configures pagination.
final 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)
final Integer	size()	Specifies the maximum number of categories to obtain.

Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, 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(Function<GetCategoriesRequest.Builder,ObjectBuilder<GetCategoriesRequest>> fn)

categoryId

@Nullable
public final 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 Integer from()

Skips the specified number of categories.

API name: from

jobId

public final String jobId()

Required - Identifier for the anomaly detection job.

API name: job_id

page

@Nullable
public final Page page()

Configures pagination. This parameter has the from and size properties.

API name: page

partitionFieldValue

@Nullable
public final String partitionFieldValue()

Only return categories for the specified partition.

API name: partition_field_value

size

@Nullable
public final 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)