Class GetCategoriesRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<GetCategoriesRequest.Builder>
co.elastic.clients.elasticsearch.ml.GetCategoriesRequest.Builder
- All Implemented Interfaces:
WithJson<GetCategoriesRequest.Builder>
,ObjectBuilder<GetCategoriesRequest>
- Enclosing class:
- GetCategoriesRequest
public static class GetCategoriesRequest.Builder
extends RequestBase.AbstractBuilder<GetCategoriesRequest.Builder>
implements ObjectBuilder<GetCategoriesRequest>
Builder for
GetCategoriesRequest
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds aGetCategoriesRequest
.categoryId
(String value) Identifier for the category, which is unique in the job.Skips the specified number of categories.Required - Identifier for the anomaly detection job.Configures pagination.Configures pagination.partitionFieldValue
(String value) Only return categories for the specified partition.protected GetCategoriesRequest.Builder
self()
Specifies the maximum number of categories to obtain.Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase
withJson
Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
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
-
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
-
self
- Specified by:
self
in classRequestBase.AbstractBuilder<GetCategoriesRequest.Builder>
-
build
Builds aGetCategoriesRequest
.- Specified by:
build
in interfaceObjectBuilder<GetCategoriesRequest>
- Throws:
NullPointerException
- if some of the required fields are null.
-