Package co.elastic.clients.elasticsearch.ml

Class GetJobStatsRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.ml.GetJobStatsRequest

public class GetJobStatsRequest
extends RequestBase

Retrieves usage information for anomaly detection jobs.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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 final Endpoint<GetJobStatsRequest,GetJobStatsResponse,ErrorResponse>	_ENDPOINT	Endpoint "ml.get_job_stats".

Method Summary

Modifier and Type	Method	Description
final Boolean	allowNoJobs()	Deprecated. 7.10.0 Use allow_no_match instead.
final String	jobId()	Identifier for the anomaly detection job.
static GetJobStatsRequest	of(Function<GetJobStatsRequest.Builder,ObjectBuilder<GetJobStatsRequest>> fn)

Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase

toString

Methods inherited from class java.lang.Object

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

Field Details

_ENDPOINT

public static final Endpoint<GetJobStatsRequest,GetJobStatsResponse,ErrorResponse> _ENDPOINT

Endpoint "ml.get_job_stats".

Method Details

of

public static GetJobStatsRequest of(Function<GetJobStatsRequest.Builder,ObjectBuilder<GetJobStatsRequest>> fn)

allowNoJobs

@Deprecated
@Nullable
public final Boolean allowNoJobs()

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

@Nullable
public final String jobId()

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