Class GetJobsRequest


public class GetJobsRequest
extends RequestBase
Retrieves configuration information for anomaly detection jobs. You can get information for 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 get information for all anomaly detection jobs by using _all, by specifying * as the <job_id>, or by omitting the <job_id>.
See Also:
API specification
  • Field Details

  • Method Details

    • of

      public static GetJobsRequest of​(java.util.function.Function<GetJobsRequest.Builder,​ObjectBuilder<GetJobsRequest>> fn)
    • allowNoJobs

      @Deprecated @Nullable public final java.lang.Boolean allowNoJobs()
      7.10.0 Use allow_no_match instead.
      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

    • allowNoMatch

      @Nullable public final java.lang.Boolean allowNoMatch()
      Specifies what to do when the request:
      1. Contains wildcard expressions and there are no jobs that match.
      2. Contains the _all string or no identifiers and there are no matches.
      3. Contains wildcard expressions and there are only partial matches.

      The default value is true, which returns an empty jobs array when there are no matches and the subset of results when there are partial matches. If this parameter is false, the request returns a 404 status code when there are no matches or only partial matches.

      API name: allow_no_match

    • excludeGenerated

      @Nullable public final java.lang.Boolean excludeGenerated()
      Indicates if certain fields should be removed from the configuration on retrieval. This allows the configuration to be in an acceptable format to be retrieved and then added to another cluster.

      API name: exclude_generated

    • jobId

      public final java.util.List<java.lang.String> jobId()
      Identifier for the anomaly detection job. It can be a job identifier, a group name, or a wildcard expression. If you do not specify one of these options, the API returns information for all anomaly detection jobs.

      API name: job_id