Package co.elastic.clients.elasticsearch.ml

Class CloseJobRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.ml.CloseJobRequest
All Implemented Interfaces:
ElasticsearchCommonRequest
public final class CloseJobRequest
extends RequestBase

  • Nested Class Summary

    Nested Classes
    Modifier and Type Class Description
    static class  CloseJobRequest.Builder
    Builder for CloseJobRequest.

    Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase

    RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

  • Field Summary

    Fields
    Modifier and Type Field Description
    static Endpoint<CloseJobRequest,​CloseJobResponse,​ElasticsearchError> ENDPOINT
    Endpoint "ml.close_job".

  • Constructor Summary

    Constructors
    Constructor Description
    CloseJobRequest​(CloseJobRequest.Builder builder)  
    CloseJobRequest​(java.util.function.Function<CloseJobRequest.Builder,​CloseJobRequest.Builder> fn)  

  • Method Summary

    Modifier and Type Method Description
    java.lang.Boolean allowNoJobs()
    Whether to ignore if a wildcard expression matches no jobs.
    java.lang.Boolean allowNoMatch()
    Specifies what to do when the request: contains wildcard expressions and there are no jobs that match; contains the _all string or no identifiers and there are no matches; or contains wildcard expressions and there are only partial matches.
    java.lang.Boolean force()
    Use to close a failed job, or to forcefully close a job which has not responded to its initial close request; the request returns without performing the associated actions such as flushing buffers and persisting the model snapshots.
    java.lang.String jobId()
    Required - Identifier for the anomaly detection job.
    java.lang.String timeout()
    Controls the time to wait until a job has closed.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

  • Constructor Details

  • Method Details

    • jobId

      public java.lang.String jobId()
      Required - Identifier for the anomaly detection job. It can be a job identifier, a group name, or a wildcard expression. You can close multiple anomaly detection jobs in a single API request by using a group name, a comma-separated list of jobs, or a wildcard expression. You can close all jobs by using _all or by specifying * as the job identifier.

      API name: job_id

    • allowNoMatch

      @Nullable public java.lang.Boolean allowNoMatch()
      Specifies what to do when the request: contains wildcard expressions and there are no jobs that match; contains the _all string or no identifiers and there are no matches; or contains wildcard expressions and there are only partial matches. By default, it returns an empty jobs array when there are no matches and the subset of results when there are partial matches. If false, the request returns a 404 status code when there are no matches or only partial matches.

      API name: allow_no_match

    • allowNoJobs

      @Nullable public java.lang.Boolean allowNoJobs()
      Whether to ignore if a wildcard expression matches no jobs. (This includes _all string or when no jobs have been specified)

      API name: allow_no_jobs

    • force

      @Nullable public java.lang.Boolean force()
      Use to close a failed job, or to forcefully close a job which has not responded to its initial close request; the request returns without performing the associated actions such as flushing buffers and persisting the model snapshots. If you want the job to be in a consistent state after the close job API returns, do not set to true. This parameter should be used only in situations where the job has already failed or where you are not interested in results the job might have recently produced or might produce in the future.

      API name: force

    • timeout

      @Nullable public java.lang.String timeout()
      Controls the time to wait until a job has closed.

      API name: timeout