Package co.elastic.clients.elasticsearch.cat

Class MlJobsRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.cat.CatRequestBase

co.elastic.clients.elasticsearch.cat.MlJobsRequest

All Implemented Interfaces:

ElasticsearchCatRequest, ElasticsearchCommonRequest

public final class MlJobsRequest
extends CatRequestBase

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MlJobsRequest.Builder	Builder for MlJobsRequest.

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch.cat.CatRequestBase

CatRequestBase.AbstractBuilder<BuilderT extends CatRequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static Endpoint<MlJobsRequest,MlJobsResponse,ElasticsearchError>	ENDPOINT	Endpoint "cat.ml_jobs".

Constructor Summary

Constructors

Constructor	Description
MlJobsRequest(MlJobsRequest.Builder builder)
MlJobsRequest(java.util.function.Function<MlJobsRequest.Builder,MlJobsRequest.Builder> fn)

Method Summary

Modifier and Type	Method	Description
java.lang.Boolean	allowNoJobs()	Whether to ignore if a wildcard expression matches no jobs.
Bytes	bytes()	The unit in which to display byte values
java.lang.String	jobId()	The ID of the jobs stats 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<MlJobsRequest,MlJobsResponse,ElasticsearchError> ENDPOINT

Endpoint "cat.ml_jobs".

Constructor Details

MlJobsRequest

public MlJobsRequest(MlJobsRequest.Builder builder)

MlJobsRequest

public MlJobsRequest(java.util.function.Function<MlJobsRequest.Builder,MlJobsRequest.Builder> fn)

Method Details

jobId

@Nullable
public java.lang.String jobId()

The ID of the jobs stats to fetch

API name: job_id

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

bytes

@Nullable
public Bytes bytes()

The unit in which to display byte values

API name: bytes