UpdateFilterRequest (java-client 7.16.3 API)

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.

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 JsonpDeserializer<UpdateFilterRequest>`	`_DESERIALIZER`	Json deserializer for `UpdateFilterRequest`
`static Endpoint<UpdateFilterRequest,UpdateFilterResponse,ErrorResponse>`	`_ENDPOINT`	Endpoint "`ml.update_filter`".

Method Summary

Modifier and Type	Method	Description
`java.util.List<java.lang.String>`	`addItems()`	API name: `add_items`
`java.lang.String`	`description()`	API name: `description`
`java.lang.String`	`filterId()`	Required - The ID of the filter to update
`static UpdateFilterRequest`	`of(java.util.function.Function<UpdateFilterRequest.Builder,ObjectBuilder<UpdateFilterRequest>> fn)`
`java.util.List<java.lang.String>`	`removeItems()`	API name: `remove_items`
`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 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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(java.util.function.Function<UpdateFilterRequest.Builder,ObjectBuilder<UpdateFilterRequest>> fn)
- addItems
  
  public final java.util.List<java.lang.String> addItems()
  
  API name: add_items
- 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 update
  API name: filter_id
- removeItems
  
  public final java.util.List<java.lang.String> removeItems()
  
  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)