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:
-
Nested Class Summary
Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final JsonpDeserializer<GetCategoriesRequest>
Json deserializer forGetCategoriesRequest
static final Endpoint<GetCategoriesRequest,
GetCategoriesResponse, ErrorResponse> Endpoint "ml.get_categories
". -
Method Summary
Modifier and TypeMethodDescriptionfinal String
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
final Page
page()
Configures pagination.final String
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
final Integer
size()
Specifies the maximum number of categories to obtain.Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
-
Field Details
-
_DESERIALIZER
Json deserializer forGetCategoriesRequest
-
_ENDPOINT
Endpoint "ml.get_categories
".
-
-
Method Details
-
of
public static GetCategoriesRequest of(Function<GetCategoriesRequest.Builder, ObjectBuilder<GetCategoriesRequest>> fn) -
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
Skips the specified number of categories.API name:
from
-
jobId
Required - Identifier for the anomaly detection job.API name:
job_id
-
page
Configures pagination. This parameter has thefrom
andsize
properties.API name:
page
-
partitionFieldValue
Only return categories for the specified partition.API name:
partition_field_value
-
size
Specifies the maximum number of categories to obtain.API name:
size
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
setupGetCategoriesRequestDeserializer
protected static void setupGetCategoriesRequestDeserializer(ObjectDeserializer<GetCategoriesRequest.Builder> op)
-