Package co.elastic.clients.elasticsearch.ml

Class CloseJobRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

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

co.elastic.clients.elasticsearch.ml.CloseJobRequest.Builder

All Implemented Interfaces:

WithJson<CloseJobRequest.Builder>, ObjectBuilder<CloseJobRequest>

Enclosing class:

CloseJobRequest

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

Builder for CloseJobRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final CloseJobRequest.Builder	allowNoJobs(Boolean value)	Deprecated. 7.10.0 Use allow_no_match instead.
final CloseJobRequest.Builder	allowNoMatch(Boolean value)	Refer to the description for the allow_no_match query parameter.
CloseJobRequest	build()	Builds a CloseJobRequest.
final CloseJobRequest.Builder	force(Boolean value)	Refer to the descriptiion for the force query parameter.
final CloseJobRequest.Builder	jobId(String value)	Required - Identifier for the anomaly detection job.
protected CloseJobRequest.Builder	self()
final CloseJobRequest.Builder	timeout(Time value)	Refer to the description for the timeout query parameter.
final CloseJobRequest.Builder	timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Refer to the description for the timeout query parameter.

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 CloseJobRequest.Builder allowNoJobs(@Nullable
 Boolean value)

Deprecated.

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

public final CloseJobRequest.Builder allowNoMatch(@Nullable
 Boolean value)

Refer to the description for the allow_no_match query parameter.

API name: allow_no_match

force

public final CloseJobRequest.Builder force(@Nullable
 Boolean value)

Refer to the descriptiion for the force query parameter.

API name: force

jobId

public final CloseJobRequest.Builder jobId(String value)

Required - Identifier for the anomaly detection job. It can be a job identifier, a group name, or a wildcard expression. You can close 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 close all jobs by using _all or by specifying * as the job identifier.

API name: job_id

timeout

public final CloseJobRequest.Builder timeout(@Nullable
 Time value)

Refer to the description for the timeout query parameter.

API name: timeout

timeout

public final CloseJobRequest.Builder timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

Refer to the description for the timeout query parameter.

API name: timeout

self

protected CloseJobRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<CloseJobRequest.Builder>

build

public CloseJobRequest build()

Builds a CloseJobRequest.

Specified by:

build in interface ObjectBuilder<CloseJobRequest>

Throws:

NullPointerException - if some of the required fields are null.