Package org.elasticsearch.client.ml

Class CloseJobRequest

java.lang.Object
org.elasticsearch.transport.TransportMessage
org.elasticsearch.transport.TransportRequest
org.elasticsearch.action.ActionRequest
org.elasticsearch.client.ml.CloseJobRequest
All Implemented Interfaces:
Writeable, ToXContent, ToXContentObject, TaskAwareRequest
public class CloseJobRequest
extends ActionRequest
implements ToXContentObject
Request to close Machine Learning Jobs

  • Field Details

  • Constructor Details

    • CloseJobRequest

      public CloseJobRequest​(java.lang.String... jobIds)
      Close the specified Jobs via their unique jobIds
      Parameters:
      jobIds - must be non-null and non-empty and each jobId must be non-null

  • Method Details

    • closeAllJobsRequest

      public static CloseJobRequest closeAllJobsRequest()
      Explicitly close all jobs
      Returns:
      a CloseJobRequest for all existing jobs

    • getJobIds

      public java.util.List<java.lang.String> getJobIds()
      All the jobIds to be closed

    • getTimeout

      public TimeValue getTimeout()

    • setTimeout

      public void setTimeout​(TimeValue timeout)
      How long to wait for the close request to complete before timing out.
      Parameters:
      timeout - Default value: 30 minutes

    • getForce

      public java.lang.Boolean getForce()

    • setForce

      public void setForce​(boolean force)
      Should the closing be forced. Use to close a failed job, or to forcefully close a job which has not responded to its initial close request.
      Parameters:
      force - When true forcefully close the job. Defaults to false

    • getAllowNoJobs

      public java.lang.Boolean getAllowNoJobs()

    • setAllowNoJobs

      public void setAllowNoJobs​(boolean allowNoJobs)
      Whether to ignore if a wildcard expression matches no jobs. This includes _all string or when no jobs have been specified
      Parameters:
      allowNoJobs - When true ignore if wildcard or _all matches no jobs. Defaults to true

    • validate

      public ActionRequestValidationException validate()
      Specified by:
      validate in class ActionRequest

    • hashCode

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

    • equals

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

    • toXContent

      public XContentBuilder toXContent​(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException
      Specified by:
      toXContent in interface ToXContent
      Throws:
      java.io.IOException

    • toString

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