Class DeleteDataFrameAnalyticsRequest

java.lang.Object
org.elasticsearch.client.ml.DeleteDataFrameAnalyticsRequest
All Implemented Interfaces:
Validatable

public class DeleteDataFrameAnalyticsRequest
extends java.lang.Object
implements Validatable
Request to delete a data frame analytics config
  • Field Summary

    Fields inherited from interface org.elasticsearch.client.Validatable

    EMPTY
  • Constructor Summary

    Constructors
    Constructor Description
    DeleteDataFrameAnalyticsRequest​(java.lang.String id)  
  • Method Summary

    Modifier and Type Method Description
    boolean equals​(java.lang.Object o)  
    java.lang.Boolean getForce()  
    java.lang.String getId()  
    org.elasticsearch.common.unit.TimeValue getTimeout()  
    int hashCode()  
    void setForce​(java.lang.Boolean force)
    Used to forcefully delete an job that is not stopped.
    void setTimeout​(org.elasticsearch.common.unit.TimeValue timeout)
    Sets the time to wait until the job is deleted.
    java.util.Optional<ValidationException> validate()
    Perform validation.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
  • Constructor Details

    • DeleteDataFrameAnalyticsRequest

      public DeleteDataFrameAnalyticsRequest​(java.lang.String id)
  • Method Details

    • getId

      public java.lang.String getId()
    • getForce

      public java.lang.Boolean getForce()
    • setForce

      public void setForce​(java.lang.Boolean force)
      Used to forcefully delete an job that is not stopped. This method is quicker than stopping and deleting the job.
      Parameters:
      force - When true forcefully delete a non stopped job. Defaults to false
    • getTimeout

      public org.elasticsearch.common.unit.TimeValue getTimeout()
    • setTimeout

      public void setTimeout​(org.elasticsearch.common.unit.TimeValue timeout)
      Sets the time to wait until the job is deleted.
      Parameters:
      timeout - The time to wait until the job is deleted.
    • validate

      public java.util.Optional<ValidationException> validate()
      Description copied from interface: Validatable
      Perform validation. This method does not have to be overridden in the event that no validation needs to be done, or the validation was done during object construction time. A ValidationException that is not null is assumed to contain validation errors and will be thrown.
      Specified by:
      validate in interface Validatable
      Returns:
      An Optional ValidationException that contains a list of validation errors.
    • equals

      public boolean equals​(java.lang.Object o)
      Overrides:
      equals in class java.lang.Object
    • hashCode

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