Class GetCategoriesRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<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 WithJsonObjectBuilderBase<GetCategoriesRequest.Builder> implements ObjectBuilder<GetCategoriesRequest>
Builder for
GetCategoriesRequest
.-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
Modifier and Type Method Description GetCategoriesRequest
build()
Builds aGetCategoriesRequest
.GetCategoriesRequest.Builder
categoryId(java.lang.String value)
Identifier for the category, which is unique in the job.GetCategoriesRequest.Builder
from(java.lang.Integer value)
Skips the specified number of categories.GetCategoriesRequest.Builder
jobId(java.lang.String value)
Required - Identifier for the anomaly detection job.GetCategoriesRequest.Builder
page(Page value)
API name:page
GetCategoriesRequest.Builder
page(java.util.function.Function<Page.Builder,ObjectBuilder<Page>> fn)
API name:page
GetCategoriesRequest.Builder
partitionFieldValue(java.lang.String value)
Only return categories for the specified partition.protected GetCategoriesRequest.Builder
self()
GetCategoriesRequest.Builder
size(java.lang.Integer value)
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
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
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
API name:page
-
page
public final GetCategoriesRequest.Builder page(java.util.function.Function<Page.Builder,ObjectBuilder<Page>> fn)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 classWithJsonObjectBuilderBase<GetCategoriesRequest.Builder>
-
build
Builds aGetCategoriesRequest
.- Specified by:
build
in interfaceObjectBuilder<GetCategoriesRequest>
- Throws:
java.lang.NullPointerException
- if some of the required fields are null.
-