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

Class SnapshotsRecord.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

All Implemented Interfaces:

ObjectBuilder<SnapshotsRecord>

Enclosing class:

SnapshotsRecord

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

Builder for SnapshotsRecord.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SnapshotsRecord	build()	Builds a SnapshotsRecord.
SnapshotsRecord.Builder	duration(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	duration
SnapshotsRecord.Builder	duration(Time value)	duration
SnapshotsRecord.Builder	endEpoch(java.lang.String value)	end time in seconds since 1970-01-01 00:00:00
SnapshotsRecord.Builder	endTime(java.lang.String value)	end time in HH:MM:SS
SnapshotsRecord.Builder	failedShards(java.lang.String value)	number of failed shards
SnapshotsRecord.Builder	id(java.lang.String value)	unique snapshot
SnapshotsRecord.Builder	indices(java.lang.String value)	number of indices
SnapshotsRecord.Builder	reason(java.lang.String value)	reason for failures
SnapshotsRecord.Builder	repository(java.lang.String value)	repository name
SnapshotsRecord.Builder	startEpoch(java.lang.String value)	start time in seconds since 1970-01-01 00:00:00
SnapshotsRecord.Builder	startTime(java.lang.String value)	start time in HH:MM:SS
SnapshotsRecord.Builder	status(java.lang.String value)	snapshot name
SnapshotsRecord.Builder	successfulShards(java.lang.String value)	number of successful shards
SnapshotsRecord.Builder	totalShards(java.lang.String value)	number of total shards

Methods inherited from class org.opensearch.client.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

Constructor Detail

Builder

public Builder()

Method Detail

id

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

unique snapshot

API name: id

repository

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

repository name

API name: repository

status

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

snapshot name

API name: status

startEpoch

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

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

API name: start_epoch

startTime

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

start time in HH:MM:SS

API name: start_time

endEpoch

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

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

API name: end_epoch

endTime

public final SnapshotsRecord.Builder endTime(@Nullable
                                             java.lang.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(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)

duration

API name: duration

indices

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

number of indices

API name: indices

successfulShards

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

number of successful shards

API name: successful_shards

failedShards

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

number of failed shards

API name: failed_shards

totalShards

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

number of total shards

API name: total_shards

reason

public final 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.