Package org.opensearch.client.opensearch.cat.snapshots

Class SnapshotsRecord.Builder

java.lang.Object

org.opensearch.client.opensearch.cat.snapshots.SnapshotsRecord.Builder

All Implemented Interfaces:

ObjectBuilder<SnapshotsRecord>

Enclosing class:

SnapshotsRecord

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

Builder for SnapshotsRecord.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.client.util.ObjectBuilder

ObjectBuilder.Constant<V>

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SnapshotsRecord	build()	Builds a SnapshotsRecord.
SnapshotsRecord.Builder	duration(jakarta.json.JsonValue value)	duration API name: duration
SnapshotsRecord.Builder	endEpoch(jakarta.json.JsonValue value)	end time in seconds since 1970-01-01 00:00:00 API name: end_epoch
SnapshotsRecord.Builder	endTime(java.lang.String value)	end time in HH:MM:SS API name: end_time
SnapshotsRecord.Builder	failedShards(java.lang.String value)	number of failed shards API name: failed_shards
SnapshotsRecord.Builder	id(java.lang.String value)	unique snapshot API name: id
SnapshotsRecord.Builder	indices(java.lang.String value)	number of indices API name: indices
SnapshotsRecord.Builder	reason(java.lang.String value)	reason for failures API name: reason
SnapshotsRecord.Builder	repository(java.lang.String value)	repository name API name: repository
SnapshotsRecord.Builder	startEpoch(jakarta.json.JsonValue value)	start time in seconds since 1970-01-01 00:00:00 API name: start_epoch
SnapshotsRecord.Builder	startTime(java.lang.String value)	start time in HH:MM:SS API name: start_time
SnapshotsRecord.Builder	status(java.lang.String value)	snapshot name API name: status
SnapshotsRecord.Builder	successfulShards(java.lang.String value)	number of successful shards API name: successful_shards
SnapshotsRecord.Builder	totalShards(java.lang.String value)	number of total shards API name: total_shards

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

id

public SnapshotsRecord.Builder id(@Nullable java.lang.String value)

unique snapshot API name: id

repository

public SnapshotsRecord.Builder repository(@Nullable java.lang.String value)

repository name API name: repository

status

public SnapshotsRecord.Builder status(@Nullable java.lang.String value)

snapshot name API name: status

startEpoch

public SnapshotsRecord.Builder startEpoch(@Nullable jakarta.json.JsonValue value)

start time in seconds since 1970-01-01 00:00:00 API name: start_epoch

startTime

public SnapshotsRecord.Builder startTime(@Nullable java.lang.String value)

start time in HH:MM:SS API name: start_time

endEpoch

public SnapshotsRecord.Builder endEpoch(@Nullable jakarta.json.JsonValue value)

end time in seconds since 1970-01-01 00:00:00 API name: end_epoch

endTime

public SnapshotsRecord.Builder endTime(@Nullable java.lang.String value)

end time in HH:MM:SS API name: end_time

duration

public SnapshotsRecord.Builder duration(@Nullable jakarta.json.JsonValue value)

duration API name: duration

indices

public SnapshotsRecord.Builder indices(@Nullable java.lang.String value)

number of indices API name: indices

successfulShards

public SnapshotsRecord.Builder successfulShards(@Nullable java.lang.String value)

number of successful shards API name: successful_shards

failedShards

public SnapshotsRecord.Builder failedShards(@Nullable java.lang.String value)

number of failed shards API name: failed_shards

totalShards

public SnapshotsRecord.Builder totalShards(@Nullable java.lang.String value)

number of total shards API name: total_shards

reason

public SnapshotsRecord.Builder reason(@Nullable java.lang.String value)

reason for failures API name: reason

build

public SnapshotsRecord build()

Builds a SnapshotsRecord.

Specified by:

build in interface ObjectBuilder<SnapshotsRecord>

Throws:

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