Package co.elastic.clients.elasticsearch.ml

Class GetJobsRequest.Builder

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<GetJobsRequest.Builder>
co.elastic.clients.elasticsearch.ml.GetJobsRequest.Builder
All Implemented Interfaces:
WithJson<GetJobsRequest.Builder>, ObjectBuilder<GetJobsRequest>
Enclosing class:
GetJobsRequest
public static class GetJobsRequest.Builder
extends RequestBase.AbstractBuilder<GetJobsRequest.Builder>
implements ObjectBuilder<GetJobsRequest>
Builder for GetJobsRequest.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • allowNoMatch

      public final GetJobsRequest.Builder allowNoMatch​(@Nullable java.lang.Boolean value)
      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

      public final GetJobsRequest.Builder excludeGenerated​(@Nullable java.lang.Boolean value)
      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 GetJobsRequest.Builder jobId​(java.util.List<java.lang.String> list)
      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

      Adds all elements of list to jobId.

    • jobId

      public final GetJobsRequest.Builder jobId​(java.lang.String value, java.lang.String... values)
      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

      Adds one or more values to jobId.

    • self

      protected GetJobsRequest.Builder self()
      Specified by:
      self in class RequestBase.AbstractBuilder<GetJobsRequest.Builder>

    • build

      public GetJobsRequest build()
      Builds a GetJobsRequest.
      Specified by:
      build in interface ObjectBuilder<GetJobsRequest>
      Throws:
      java.lang.NullPointerException - if some of the required fields are null.