Package co.elastic.clients.elasticsearch.ml

Class PutFilterRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.ml.PutFilterRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class PutFilterRequest
extends RequestBase
implements JsonpSerializable

Instantiates a filter. A filter contains a list of strings. It can be used by one or more anomaly detection jobs. Specifically, filters are referenced in the custom_rules property of detector configuration objects.

See Also:

API specification

Nested Class Summary

Nested Classes

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

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 JsonpDeserializer<PutFilterRequest>	_DESERIALIZER	Json deserializer for PutFilterRequest
static Endpoint<PutFilterRequest,PutFilterResponse,ErrorResponse>	_ENDPOINT	Endpoint "ml.put_filter".

Method Summary

Modifier and Type	Method	Description
java.lang.String	description()	A description of the filter.
java.lang.String	filterId()	Required - A string that uniquely identifies a filter.
java.util.List<java.lang.String>	items()	The items of the filter.
static PutFilterRequest	of(java.util.function.Function<PutFilterRequest.Builder,ObjectBuilder<PutFilterRequest>> fn)
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	setupPutFilterRequestDeserializer(ObjectDeserializer<PutFilterRequest.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<PutFilterRequest> _DESERIALIZER

Json deserializer for PutFilterRequest

_ENDPOINT

public static final Endpoint<PutFilterRequest,PutFilterResponse,ErrorResponse> _ENDPOINT

Endpoint "ml.put_filter".

Method Details

of

public static PutFilterRequest of(java.util.function.Function<PutFilterRequest.Builder,ObjectBuilder<PutFilterRequest>> fn)

description

@Nullable
public final java.lang.String description()

A description of the filter.

API name: description

filterId

public final java.lang.String filterId()

Required - A string that uniquely identifies a filter.

API name: filter_id

items

public final java.util.List<java.lang.String> items()

The items of the filter. A wildcard * can be used at the beginning or the end of an item. Up to 10000 items are allowed in each filter.

API name: 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)

setupPutFilterRequestDeserializer

protected static void setupPutFilterRequestDeserializer(ObjectDeserializer<PutFilterRequest.Builder> op)