Package co.elastic.clients.elasticsearch.ml

Class GetModelSnapshotUpgradeStatsRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.ml.GetModelSnapshotUpgradeStatsRequest

public class GetModelSnapshotUpgradeStatsRequest
extends RequestBase

Retrieves usage information for anomaly detection job model snapshot upgrades.

See Also:

API specification

Nested Class Summary

Nested Classes

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

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<GetModelSnapshotUpgradeStatsRequest,GetModelSnapshotUpgradeStatsResponse,ErrorResponse>	_ENDPOINT	Endpoint "ml.get_model_snapshot_upgrade_stats".

Method Summary

Modifier and Type	Method	Description
java.lang.Boolean	allowNoMatch()	Specifies what to do when the request: Contains wildcard expressions and there are no jobs that match. Contains the _all string or no identifiers and there are no matches. Contains wildcard expressions and there are only partial matches.
java.lang.String	jobId()	Required - Identifier for the anomaly detection job.
static GetModelSnapshotUpgradeStatsRequest	of(java.util.function.Function<GetModelSnapshotUpgradeStatsRequest.Builder,ObjectBuilder<GetModelSnapshotUpgradeStatsRequest>> fn)
java.lang.String	snapshotId()	Required - A numerical character string that uniquely identifies the model snapshot.

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<GetModelSnapshotUpgradeStatsRequest,GetModelSnapshotUpgradeStatsResponse,ErrorResponse> _ENDPOINT

Endpoint "ml.get_model_snapshot_upgrade_stats".

Method Details

of

public static GetModelSnapshotUpgradeStatsRequest of(java.util.function.Function<GetModelSnapshotUpgradeStatsRequest.Builder,ObjectBuilder<GetModelSnapshotUpgradeStatsRequest>> fn)

allowNoMatch

@Nullable
public final java.lang.Boolean allowNoMatch()

Specifies what to do when the request:

• Contains wildcard expressions and there are no jobs that match.
• Contains the _all string or no identifiers and there are no matches.
• 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_match

jobId

public final java.lang.String jobId()

Required - Identifier for the anomaly detection job.

API name: job_id

snapshotId

public final java.lang.String snapshotId()

Required - A numerical character string that uniquely identifies the model snapshot. You can get information for multiple snapshots by using a comma-separated list or a wildcard expression. You can get all snapshots by using _all, by specifying * as the snapshot ID, or by omitting the snapshot ID.

API name: snapshot_id