Class UpdateFilterRequest

java.lang.Object
org.elasticsearch.client.ml.UpdateFilterRequest
All Implemented Interfaces:
Validatable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject

public class UpdateFilterRequest extends Object implements Validatable, org.elasticsearch.common.xcontent.ToXContentObject
Updates an existing MlFilter configuration
  • Nested Class Summary

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

    org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.ToXContent.Params
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static org.elasticsearch.common.xcontent.ParseField
     
    static org.elasticsearch.common.xcontent.ConstructingObjectParser<UpdateFilterRequest,​Void>
     
    static org.elasticsearch.common.xcontent.ParseField
     

    Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

    EMPTY_PARAMS

    Fields inherited from interface org.elasticsearch.client.Validatable

    EMPTY
  • Constructor Summary

    Constructors
    Constructor
    Description
    Construct a new request referencing a non-null, existing filter_id
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals​(Object obj)
     
     
     
     
     
    int
     
    void
    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
     
    org.elasticsearch.common.xcontent.XContentBuilder
    toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
     

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject

    isFragment

    Methods inherited from interface org.elasticsearch.client.Validatable

    validate
  • Field Details

    • ADD_ITEMS

      public static final org.elasticsearch.common.xcontent.ParseField ADD_ITEMS
    • REMOVE_ITEMS

      public static final org.elasticsearch.common.xcontent.ParseField REMOVE_ITEMS
    • PARSER

      public static final org.elasticsearch.common.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()
    • 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.common.xcontent.XContentBuilder toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws IOException
      Specified by:
      toXContent in interface org.elasticsearch.common.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 Object