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)	duration
final SnapshotsRecord.Builder	duration(Function<Time.Builder,ObjectBuilder<Time>> fn)	duration
final SnapshotsRecord.Builder	endEpoch(Long value)	end time in seconds since 1970-01-01 00:00:00
final SnapshotsRecord.Builder	endTime(String value)	end time in HH:MM:SS
final SnapshotsRecord.Builder	failedShards(String value)	number of failed shards
final SnapshotsRecord.Builder	id(String value)	unique snapshot
final SnapshotsRecord.Builder	indices(String value)	number of indices
final SnapshotsRecord.Builder	reason(String value)	reason for failures
final SnapshotsRecord.Builder	repository(String value)	repository name
protected SnapshotsRecord.Builder	self()
final SnapshotsRecord.Builder	startEpoch(Long value)	start time in seconds since 1970-01-01 00:00:00
final SnapshotsRecord.Builder	startTime(ScheduleTimeOfDay value)	start time in HH:MM:SS
final SnapshotsRecord.Builder	startTime(Function<ScheduleTimeOfDay.Builder,ObjectBuilder<ScheduleTimeOfDay>> fn)	start time in HH:MM:SS
final SnapshotsRecord.Builder	status(String value)	snapshot name
final SnapshotsRecord.Builder	successfulShards(String value)	number of successful shards
final SnapshotsRecord.Builder	totalShards(String value)	number of total shards

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)

unique snapshot

API name: id

repository

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

repository name

API name: repository

status

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

snapshot name

API name: status

startEpoch

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

start time in seconds since 1970-01-01 00:00:00

API name: start_epoch

startTime

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

start time in HH:MM:SS

API name: start_time

startTime

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

start time in HH:MM:SS

API name: start_time

endEpoch

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

end time in seconds since 1970-01-01 00:00:00

API name: end_epoch

endTime

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

end time in HH:MM:SS

API name: end_time

duration

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

duration

API name: duration

duration

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

duration

API name: duration

indices

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

number of indices

API name: indices

successfulShards

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

number of successful shards

API name: successful_shards

failedShards

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

number of failed shards

API name: failed_shards

totalShards

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

number of total shards

API name: total_shards

reason

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

reason for 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.