PutFilterRequest (java-client 7.16.3 API)

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.

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()`	API name: `description`
`java.lang.String`	`filterId()`	Required - The ID of the filter to create
`java.util.List<java.lang.String>`	`items()`	API name: `items`
`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 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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()
  
  API name: description
- filterId
  
  public final java.lang.String filterId()
  
  Required - The ID of the filter to create
  API name: filter_id
- items
  
  public final java.util.List<java.lang.String> items()
  
  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)