Package co.elastic.clients.elasticsearch.ml

Class GetCategoriesRequest.Builder

java.lang.Object

co.elastic.clients.elasticsearch.ml.GetCategoriesRequest.Builder

All Implemented Interfaces:

ObjectBuilder<GetCategoriesRequest>

Enclosing class:

GetCategoriesRequest

public static class GetCategoriesRequest.Builder
extends java.lang.Object
implements ObjectBuilder<GetCategoriesRequest>

Builder for GetCategoriesRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GetCategoriesRequest	build()	Builds a GetCategoriesRequest.
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 a 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.
GetCategoriesRequest.Builder	size(java.lang.Integer value)	specifies a max number of categories to get

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

jobId

public GetCategoriesRequest.Builder jobId(java.lang.String value)

Required - Identifier for the anomaly detection job.

API name: job_id

categoryId

public GetCategoriesRequest.Builder categoryId(@Nullable
java.lang.String value)

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

public GetCategoriesRequest.Builder from(@Nullable
java.lang.Integer value)

skips a number of categories

API name: from

size

public GetCategoriesRequest.Builder size(@Nullable
java.lang.Integer value)

specifies a max number of categories to get

API name: size

partitionFieldValue

public GetCategoriesRequest.Builder partitionFieldValue(@Nullable
java.lang.String value)

Only return categories for the specified partition.

API name: partition_field_value

page

public GetCategoriesRequest.Builder page(@Nullable
Page value)

API name: page

page

public GetCategoriesRequest.Builder page(java.util.function.Function<Page.Builder,ObjectBuilder<Page>> fn)

API name: page

build

public GetCategoriesRequest build()

Builds a GetCategoriesRequest.

Specified by:

build in interface ObjectBuilder<GetCategoriesRequest>

Throws:

java.lang.NullPointerException - if some of the required fields are null.