Package org.elasticsearch.client.ml

Class UpdateFilterRequest

java.lang.Object
org.elasticsearch.transport.TransportMessage
org.elasticsearch.transport.TransportRequest
org.elasticsearch.action.ActionRequest
org.elasticsearch.client.ml.UpdateFilterRequest
All Implemented Interfaces:
org.elasticsearch.common.io.stream.Writeable, org.elasticsearch.core.RefCounted, org.elasticsearch.tasks.TaskAwareRequest, org.elasticsearch.xcontent.ToXContent, org.elasticsearch.xcontent.ToXContentObject
public class UpdateFilterRequest extends org.elasticsearch.action.ActionRequest implements org.elasticsearch.xcontent.ToXContentObject
Updates an existing MlFilter configuration

  • Nested Class Summary

    Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportRequest

    org.elasticsearch.transport.TransportRequest.Empty

    Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

    org.elasticsearch.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.xcontent.ToXContent.MapParams, org.elasticsearch.xcontent.ToXContent.Params

    Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

    org.elasticsearch.common.io.stream.Writeable.Reader<V extends Object>, org.elasticsearch.common.io.stream.Writeable.Writer<V extends Object>

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final org.elasticsearch.xcontent.ParseField
    ADD_ITEMS
     
    static final org.elasticsearch.xcontent.ConstructingObjectParser<UpdateFilterRequest,Void>
    PARSER
     
    static final org.elasticsearch.xcontent.ParseField
    REMOVE_ITEMS
     

    Fields inherited from interface org.elasticsearch.xcontent.ToXContent

    EMPTY_PARAMS

  • Constructor Summary

    Constructors
    Constructor
    Description
    UpdateFilterRequest(String filterId)
    Construct a new request referencing a non-null, existing filter_id

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    SortedSet<String>
    getAddItems()
     
    String
    getDescription()
     
    String
    getFilterId()
     
    SortedSet<String>
    getRemoveItems()
     
    int
    hashCode()
     
    void
    setAddItems(Collection<String> addItems)
    The collection of items to add to the filter
    void
    setDescription(String description)
    The new description of the filter
    void
    setRemoveItems(Collection<String> removeItems)
    The collection of items to remove from the filter
    final String
    toString()
     
    org.elasticsearch.xcontent.XContentBuilder
    toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params)
     
    org.elasticsearch.action.ActionRequestValidationException
    validate()
     

    Methods inherited from class org.elasticsearch.action.ActionRequest

    getShouldStoreResult, writeTo

    Methods inherited from class org.elasticsearch.transport.TransportRequest

    getParentTask, setParentTask

    Methods inherited from class org.elasticsearch.transport.TransportMessage

    decRef, hasReferences, incRef, remoteAddress, remoteAddress, tryIncRef

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

    createTask, setParentTask

    Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

    isFragment

  • Field Details

    • ADD_ITEMS

      public static final org.elasticsearch.xcontent.ParseField ADD_ITEMS

    • REMOVE_ITEMS

      public static final org.elasticsearch.xcontent.ParseField REMOVE_ITEMS

    • PARSER

      public static final org.elasticsearch.xcontent.ConstructingObjectParser<UpdateFilterRequest,Void> PARSER

  • Constructor Details

    • UpdateFilterRequest

      public UpdateFilterRequest(String filterId)
      Construct a new request referencing a non-null, existing filter_id
      Parameters:
      filterId - Id referencing the filter to update

  • Method Details

    • getFilterId

      public String getFilterId()

    • getDescription

      public String getDescription()
      Specified by:
      getDescription in interface org.elasticsearch.tasks.TaskAwareRequest

    • setDescription

      public void setDescription(String description)
      The new description of the filter
      Parameters:
      description - the updated filter description

    • getAddItems

      public SortedSet<String> getAddItems()

    • setAddItems

      public void setAddItems(Collection<String> addItems)
      The collection of items to add to the filter
      Parameters:
      addItems - non-null items to add to the filter, defaults to empty array

    • getRemoveItems

      public SortedSet<String> getRemoveItems()

    • setRemoveItems

      public void setRemoveItems(Collection<String> removeItems)
      The collection of items to remove from the filter
      Parameters:
      removeItems - non-null items to remove from the filter, defaults to empty array

    • toXContent

      public org.elasticsearch.xcontent.XContentBuilder toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) throws IOException
      Specified by:
      toXContent in interface org.elasticsearch.xcontent.ToXContent
      Throws:
      IOException

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • toString

      public final String toString()
      Overrides:
      toString in class org.elasticsearch.transport.TransportRequest

    • validate

      public org.elasticsearch.action.ActionRequestValidationException validate()
      Specified by:
      validate in class org.elasticsearch.action.ActionRequest