Package co.elastic.clients.elasticsearch.ml

Class GetJobStatsRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<GetJobStatsRequest.Builder>

co.elastic.clients.elasticsearch.ml.GetJobStatsRequest.Builder

All Implemented Interfaces:

WithJson<GetJobStatsRequest.Builder>, ObjectBuilder<GetJobStatsRequest>

Enclosing class:

GetJobStatsRequest

public static class GetJobStatsRequest.Builder
extends RequestBase.AbstractBuilder<GetJobStatsRequest.Builder>
implements ObjectBuilder<GetJobStatsRequest>

Builder for GetJobStatsRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final GetJobStatsRequest.Builder	allowNoJobs(Boolean value)	Deprecated. 7.10.0 Use allow_no_match instead.
GetJobStatsRequest	build()	Builds a GetJobStatsRequest.
final GetJobStatsRequest.Builder	jobId(String value)	Identifier for the anomaly detection job.
protected GetJobStatsRequest.Builder	self()

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

allowNoJobs

@Deprecated
public final GetJobStatsRequest.Builder allowNoJobs(@Nullable
 Boolean value)

Deprecated.

7.10.0 Use allow_no_match instead.

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_jobs

jobId

public final GetJobStatsRequest.Builder jobId(@Nullable
 String value)

Identifier for the anomaly detection job. It can be a job identifier, a group name, a comma-separated list of jobs, 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

self

protected GetJobStatsRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<GetJobStatsRequest.Builder>

build

public GetJobStatsRequest build()

Builds a GetJobStatsRequest.

Specified by:

build in interface ObjectBuilder<GetJobStatsRequest>

Throws:

NullPointerException - if some of the required fields are null.