GetJobsRequest (java-client 7.15.1 API)

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.ml.GetJobsRequest

All Implemented Interfaces:: ElasticsearchCommonRequest

public final class GetJobsRequest
extends RequestBase

Nested Class Summary

Nested Classes

Modifier and Type Class Description

static class GetJobsRequest.Builder
Builder for GetJobsRequest.

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<GetJobsRequest,GetJobsResponse,ElasticsearchError> ENDPOINT
Endpoint "ml.get_jobs".

Constructor Summary

Constructors
Constructor	Description
`GetJobsRequest(GetJobsRequest.Builder builder)`
`GetJobsRequest(java.util.function.Function<GetJobsRequest.Builder,GetJobsRequest.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()`	Whether to ignore if a wildcard expression matches no jobs.
`java.lang.Boolean`	`excludeGenerated()`	Omits fields that are illegal to set on job PUT
`java.util.List<java.lang.String>`	`jobId()`	The ID of the jobs to fetch

Methods inherited from class java.lang.Object

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

Field Details
- ENDPOINT
  
  public static final Endpoint<GetJobsRequest,GetJobsResponse,ElasticsearchError> ENDPOINT
  
  Endpoint "ml.get_jobs".
Constructor Details
- GetJobsRequest
  
  public GetJobsRequest(GetJobsRequest.Builder builder)
- GetJobsRequest
  
  public GetJobsRequest(java.util.function.Function<GetJobsRequest.Builder,GetJobsRequest.Builder> fn)
Method Details
- jobId
  
  @Nullable public java.util.List<java.lang.String> jobId()
  
  The ID of the jobs to fetch
  API name: job_id
- allowNoMatch
  
  @Nullable public java.lang.Boolean allowNoMatch()
  
  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_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
- excludeGenerated
  
  @Nullable public java.lang.Boolean excludeGenerated()
  
  Omits fields that are illegal to set on job PUT
  API name: exclude_generated