Package co.elastic.clients.elasticsearch.ml

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

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GetCategoriesRequest	build()	Builds a GetCategoriesRequest.
final GetCategoriesRequest.Builder	categoryId(String value)	Identifier for the category, which is unique in the job.
final GetCategoriesRequest.Builder	from(Integer value)	Skips the specified number of categories.
final GetCategoriesRequest.Builder	jobId(String value)	Required - Identifier for the anomaly detection job.
final GetCategoriesRequest.Builder	page(Page value)	API name: page
final GetCategoriesRequest.Builder	page(Function<Page.Builder,ObjectBuilder<Page>> fn)	API name: page
final GetCategoriesRequest.Builder	partitionFieldValue(String value)	Only return categories for the specified partition.
protected GetCategoriesRequest.Builder	self()
final GetCategoriesRequest.Builder	size(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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

categoryId

public final GetCategoriesRequest.Builder categoryId(@Nullable
 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 final GetCategoriesRequest.Builder from(@Nullable
 Integer value)

Skips the specified number of categories.

API name: from

jobId

public final GetCategoriesRequest.Builder jobId(String value)

Required - Identifier for the anomaly detection job.

API name: job_id

page

public final GetCategoriesRequest.Builder page(@Nullable
 Page value)

API name: page

page

public final GetCategoriesRequest.Builder page(Function<Page.Builder,ObjectBuilder<Page>> fn)

API name: page

partitionFieldValue

public final GetCategoriesRequest.Builder partitionFieldValue(@Nullable
 String value)

Only return categories for the specified partition.

API name: partition_field_value

size

public final GetCategoriesRequest.Builder size(@Nullable
 Integer value)

Specifies the maximum number of categories to obtain.

API name: size

self

protected GetCategoriesRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<GetCategoriesRequest.Builder>

build

public GetCategoriesRequest build()

Builds a GetCategoriesRequest.

Specified by:

build in interface ObjectBuilder<GetCategoriesRequest>

Throws:

NullPointerException - if some of the required fields are null.