Package co.elastic.clients.elasticsearch.cat.snapshots

Class SnapshotsRecord.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<SnapshotsRecord.Builder>

co.elastic.clients.elasticsearch.cat.snapshots.SnapshotsRecord.Builder

All Implemented Interfaces:

WithJson<SnapshotsRecord.Builder>, ObjectBuilder<SnapshotsRecord>

Enclosing class:

SnapshotsRecord

public static class SnapshotsRecord.Builder
extends WithJsonObjectBuilderBase<SnapshotsRecord.Builder>
implements ObjectBuilder<SnapshotsRecord>

Builder for SnapshotsRecord.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SnapshotsRecord	build()	Builds a SnapshotsRecord.
final SnapshotsRecord.Builder	duration(Time value)	The time it took the snapshot process to complete, in time units.
final SnapshotsRecord.Builder	duration(Function<Time.Builder,ObjectBuilder<Time>> fn)	The time it took the snapshot process to complete, in time units.
final SnapshotsRecord.Builder	endEpoch(Long value)	The Unix epoch time (seconds since 1970-01-01 00:00:00) at which the snapshot process ended.
final SnapshotsRecord.Builder	endTime(String value)	The time (HH:MM:SS) at which the snapshot process ended.
final SnapshotsRecord.Builder	failedShards(String value)	The number of failed shards in the snapshot.
final SnapshotsRecord.Builder	id(String value)	The unique identifier for the snapshot.
final SnapshotsRecord.Builder	indices(String value)	The number of indices in the snapshot.
final SnapshotsRecord.Builder	reason(String value)	The reason for any snapshot failures.
final SnapshotsRecord.Builder	repository(String value)	The repository name.
protected SnapshotsRecord.Builder	self()
final SnapshotsRecord.Builder	startEpoch(Long value)	The Unix epoch time (seconds since 1970-01-01 00:00:00) at which the snapshot process started.
final SnapshotsRecord.Builder	startTime(ScheduleTimeOfDay value)	The time (HH:MM:SS) at which the snapshot process started.
final SnapshotsRecord.Builder	startTime(Function<ScheduleTimeOfDay.Builder,ObjectBuilder<ScheduleTimeOfDay>> fn)	The time (HH:MM:SS) at which the snapshot process started.
final SnapshotsRecord.Builder	status(String value)	The state of the snapshot process.
final SnapshotsRecord.Builder	successfulShards(String value)	The number of successful shards in the snapshot.
final SnapshotsRecord.Builder	totalShards(String value)	The total number of shards in the snapshot.

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

id

public final SnapshotsRecord.Builder id(@Nullable
 String value)

The unique identifier for the snapshot.

API name: id

repository

public final SnapshotsRecord.Builder repository(@Nullable
 String value)

The repository name.

API name: repository

status

public final SnapshotsRecord.Builder status(@Nullable
 String value)

The state of the snapshot process. Returned values include: FAILED: The snapshot process failed. INCOMPATIBLE: The snapshot process is incompatible with the current cluster version. IN_PROGRESS: The snapshot process started but has not completed. PARTIAL: The snapshot process completed with a partial success. SUCCESS: The snapshot process completed with a full success.

API name: status

startEpoch

public final SnapshotsRecord.Builder startEpoch(@Nullable
 Long value)

The Unix epoch time (seconds since 1970-01-01 00:00:00) at which the snapshot process started.

API name: start_epoch

startTime

public final SnapshotsRecord.Builder startTime(@Nullable
 ScheduleTimeOfDay value)

The time (HH:MM:SS) at which the snapshot process started.

API name: start_time

startTime

public final SnapshotsRecord.Builder startTime(Function<ScheduleTimeOfDay.Builder,ObjectBuilder<ScheduleTimeOfDay>> fn)

The time (HH:MM:SS) at which the snapshot process started.

API name: start_time

endEpoch

public final SnapshotsRecord.Builder endEpoch(@Nullable
 Long value)

The Unix epoch time (seconds since 1970-01-01 00:00:00) at which the snapshot process ended.

API name: end_epoch

endTime

public final SnapshotsRecord.Builder endTime(@Nullable
 String value)

The time (HH:MM:SS) at which the snapshot process ended.

API name: end_time

duration

public final SnapshotsRecord.Builder duration(@Nullable
 Time value)

The time it took the snapshot process to complete, in time units.

API name: duration

duration

public final SnapshotsRecord.Builder duration(Function<Time.Builder,ObjectBuilder<Time>> fn)

The time it took the snapshot process to complete, in time units.

API name: duration

indices

public final SnapshotsRecord.Builder indices(@Nullable
 String value)

The number of indices in the snapshot.

API name: indices

successfulShards

public final SnapshotsRecord.Builder successfulShards(@Nullable
 String value)

The number of successful shards in the snapshot.

API name: successful_shards

failedShards

public final SnapshotsRecord.Builder failedShards(@Nullable
 String value)

The number of failed shards in the snapshot.

API name: failed_shards

totalShards

public final SnapshotsRecord.Builder totalShards(@Nullable
 String value)

The total number of shards in the snapshot.

API name: total_shards

reason

public final SnapshotsRecord.Builder reason(@Nullable
 String value)

The reason for any snapshot failures.

API name: reason

self

protected SnapshotsRecord.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<SnapshotsRecord.Builder>

build

public SnapshotsRecord build()

Builds a SnapshotsRecord.

Specified by:

build in interface ObjectBuilder<SnapshotsRecord>

Throws:

NullPointerException - if some of the required fields are null.