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.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject, org.elasticsearch.tasks.TaskAwareRequest
public class UpdateFilterRequest
extends org.elasticsearch.action.ActionRequest
implements org.elasticsearch.common.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.common.xcontent.ToXContent

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

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

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

  • Field Summary

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

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

    EMPTY_PARAMS

  • Constructor Summary

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

  • Method Summary

    Modifier and Type Method Description
    boolean equals​(java.lang.Object obj)  
    java.util.SortedSet<java.lang.String> getAddItems()  
    java.lang.String getDescription()  
    java.lang.String getFilterId()  
    java.util.SortedSet<java.lang.String> getRemoveItems()  
    int hashCode()  
    void setAddItems​(java.util.Collection<java.lang.String> addItems)
    The collection of items to add to the filter
    void setDescription​(java.lang.String description)
    The new description of the filter
    void setRemoveItems​(java.util.Collection<java.lang.String> removeItems)
    The collection of items to remove from the filter
    java.lang.String toString()  
    org.elasticsearch.common.xcontent.XContentBuilder toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.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

    remoteAddress, remoteAddress

    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.common.xcontent.ToXContentObject

    isFragment

  • Field Details

    • ADD_ITEMS

      public static final org.elasticsearch.common.ParseField ADD_ITEMS

    • REMOVE_ITEMS

      public static final org.elasticsearch.common.ParseField REMOVE_ITEMS

    • PARSER

      public static final org.elasticsearch.common.xcontent.ConstructingObjectParser<UpdateFilterRequest,​java.lang.Void> PARSER

  • Constructor Details

    • UpdateFilterRequest

      public UpdateFilterRequest​(java.lang.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 java.lang.String getFilterId()

    • getDescription

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

    • setDescription

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

    • getAddItems

      public java.util.SortedSet<java.lang.String> getAddItems()

    • setAddItems

      public void setAddItems​(java.util.Collection<java.lang.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 java.util.SortedSet<java.lang.String> getRemoveItems()

    • setRemoveItems

      public void setRemoveItems​(java.util.Collection<java.lang.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 java.io.IOException
      Specified by:
      toXContent in interface org.elasticsearch.common.xcontent.ToXContent
      Throws:
      java.io.IOException

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class java.lang.Object

    • equals

      public boolean equals​(java.lang.Object obj)
      Overrides:
      equals in class java.lang.Object

    • toString

      public final java.lang.String toString()
      Overrides:
      toString in class java.lang.Object

    • validate

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