Package co.elastic.clients.elasticsearch.ml

Class UpdateFilterRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.ml.UpdateFilterRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class UpdateFilterRequest
extends RequestBase
implements JsonpSerializable

Updates the description of a filter, adds items, or removes items from the list.

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UpdateFilterRequest.Builder	Builder for UpdateFilterRequest.

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<UpdateFilterRequest>	_DESERIALIZER	Json deserializer for UpdateFilterRequest
static final Endpoint<UpdateFilterRequest,UpdateFilterResponse,ErrorResponse>	_ENDPOINT	Endpoint "ml.update_filter".

Method Summary

Modifier and Type	Method	Description
final List<String>	addItems()	The items to add to the filter.
final String	description()	A description for the filter.
final String	filterId()	Required - A string that uniquely identifies a filter.
static UpdateFilterRequest	of(Function<UpdateFilterRequest.Builder,ObjectBuilder<UpdateFilterRequest>> fn)
final List<String>	removeItems()	The items to remove from the filter.
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	setupUpdateFilterRequestDeserializer(ObjectDeserializer<UpdateFilterRequest.Builder> op)

Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

_DESERIALIZER

public static final JsonpDeserializer<UpdateFilterRequest> _DESERIALIZER

Json deserializer for UpdateFilterRequest

_ENDPOINT

public static final Endpoint<UpdateFilterRequest,UpdateFilterResponse,ErrorResponse> _ENDPOINT

Endpoint "ml.update_filter".

Method Details

of

public static UpdateFilterRequest of(Function<UpdateFilterRequest.Builder,ObjectBuilder<UpdateFilterRequest>> fn)

addItems

public final List<String> addItems()

The items to add to the filter.

API name: add_items

description

@Nullable
public final String description()

A description for the filter.

API name: description

filterId

public final String filterId()

Required - A string that uniquely identifies a filter.

API name: filter_id

removeItems

public final List<String> removeItems()

The items to remove from the filter.

API name: remove_items

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

setupUpdateFilterRequestDeserializer

protected static void setupUpdateFilterRequestDeserializer(ObjectDeserializer<UpdateFilterRequest.Builder> op)