Package org.elasticsearch.client.ml

Class DeleteDatafeedRequest

java.lang.Object
org.elasticsearch.transport.TransportMessage
org.elasticsearch.transport.TransportRequest
org.elasticsearch.action.ActionRequest
org.elasticsearch.client.ml.DeleteDatafeedRequest
All Implemented Interfaces:
org.elasticsearch.common.io.stream.Writeable, org.elasticsearch.core.RefCounted, org.elasticsearch.tasks.TaskAwareRequest
public class DeleteDatafeedRequest extends org.elasticsearch.action.ActionRequest
Request to delete a Machine Learning Datafeed via its ID

  • 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.io.stream.Writeable

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

  • Constructor Summary

    Constructors
    Constructor
    Description
    DeleteDatafeedRequest(String datafeedId)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    String
    getDatafeedId()
     
    Boolean
    getForce()
     
    int
    hashCode()
     
    void
    setForce(Boolean force)
    Used to forcefully delete a started datafeed.
    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, toString

    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, getDescription, setParentTask

  • Constructor Details

    • DeleteDatafeedRequest

      public DeleteDatafeedRequest(String datafeedId)

  • Method Details

    • getDatafeedId

      public String getDatafeedId()

    • getForce

      public Boolean getForce()

    • setForce

      public void setForce(Boolean force)
      Used to forcefully delete a started datafeed. This method is quicker than stopping and deleting the datafeed.
      Parameters:
      force - When true forcefully delete a started datafeed. Defaults to false

    • validate

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

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

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