Package co.elastic.clients.elasticsearch.ml

Class GetModelSnapshotsRequest.Builder

java.lang.Object

co.elastic.clients.elasticsearch.ml.GetModelSnapshotsRequest.Builder

All Implemented Interfaces:

ObjectBuilder<GetModelSnapshotsRequest>

Enclosing class:

GetModelSnapshotsRequest

public static class GetModelSnapshotsRequest.Builder
extends java.lang.Object
implements ObjectBuilder<GetModelSnapshotsRequest>

Builder for GetModelSnapshotsRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GetModelSnapshotsRequest	build()	Builds a GetModelSnapshotsRequest.
GetModelSnapshotsRequest.Builder	desc(java.lang.Boolean value)	If true, the results are sorted in descending order.
GetModelSnapshotsRequest.Builder	end(java.lang.String value)	API name: end
GetModelSnapshotsRequest.Builder	from(java.lang.Integer value)	Skips the specified number of snapshots.
GetModelSnapshotsRequest.Builder	jobId(java.lang.String value)	Required - Identifier for the anomaly detection job.
GetModelSnapshotsRequest.Builder	size(java.lang.Integer value)	Specifies the maximum number of snapshots to obtain.
GetModelSnapshotsRequest.Builder	snapshotId(java.lang.String value)	A numerical character string that uniquely identifies the model snapshot.
GetModelSnapshotsRequest.Builder	sort(java.lang.String value)	Specifies the sort field for the requested snapshots.
GetModelSnapshotsRequest.Builder	start(java.lang.String value)	API name: start

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

jobId

public GetModelSnapshotsRequest.Builder jobId(java.lang.String value)

Required - Identifier for the anomaly detection job.

API name: job_id

snapshotId

public GetModelSnapshotsRequest.Builder snapshotId(@Nullable
java.lang.String value)

A numerical character string that uniquely identifies the model snapshot.

API name: snapshot_id

desc

public GetModelSnapshotsRequest.Builder desc(@Nullable
java.lang.Boolean value)

If true, the results are sorted in descending order.

API name: desc

from

public GetModelSnapshotsRequest.Builder from(@Nullable
java.lang.Integer value)

Skips the specified number of snapshots.

API name: from

size

public GetModelSnapshotsRequest.Builder size(@Nullable
java.lang.Integer value)

Specifies the maximum number of snapshots to obtain.

API name: size

sort

public GetModelSnapshotsRequest.Builder sort(@Nullable
java.lang.String value)

Specifies the sort field for the requested snapshots. By default, the snapshots are sorted by their timestamp.

API name: sort

start

public GetModelSnapshotsRequest.Builder start(@Nullable
java.lang.String value)

API name: start

end

public GetModelSnapshotsRequest.Builder end(@Nullable
java.lang.String value)

API name: end

build

public GetModelSnapshotsRequest build()

Builds a GetModelSnapshotsRequest.

Specified by:

build in interface ObjectBuilder<GetModelSnapshotsRequest>

Throws:

java.lang.NullPointerException - if some of the required fields are null.