Class SnapshotsRecord.Builder
java.lang.Object
org.opensearch.client.util.ObjectBuilderBase
org.opensearch.client.opensearch.cat.snapshots.SnapshotsRecord.Builder
- All Implemented Interfaces:
CopyableBuilder<SnapshotsRecord.Builder,,SnapshotsRecord> MutableBuilder<SnapshotsRecord.Builder,,SnapshotsRecord> ObjectBuilder<SnapshotsRecord>
- Enclosing class:
SnapshotsRecord
public static class SnapshotsRecord.Builder
extends ObjectBuilderBase
implements CopyableBuilder<SnapshotsRecord.Builder,SnapshotsRecord>
Builder for
SnapshotsRecord.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()Builds aSnapshotsRecord.copy()Create a new builderCopyableBuilderthat is a copy of this one.final SnapshotsRecord.BuilderAPI name:durationfinal SnapshotsRecord.BuilderAPI name:durationfinal SnapshotsRecord.BuilderAPI name:end_epochfinal SnapshotsRecord.BuilderAPI name:end_timefinal SnapshotsRecord.BuilderfailedShards(String value) The number of failed shards in the snapshot.final SnapshotsRecord.BuilderThe unique identifier for the snapshot.final SnapshotsRecord.BuilderThe number of indexes in the snapshot.final SnapshotsRecord.BuilderThe reason for any snapshot failures.final SnapshotsRecord.Builderrepository(String value) The repository name.final SnapshotsRecord.BuilderstartEpoch(Long value) API name:start_epochfinal SnapshotsRecord.BuilderAPI name:start_timefinal SnapshotsRecord.BuilderThe state of the snapshot process.final SnapshotsRecord.BuildersuccessfulShards(String value) The number of successful shards in the snapshot.final SnapshotsRecord.BuildertotalShards(String value) The total number of shards in the snapshot.Methods inherited from class org.opensearch.client.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAllMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.opensearch.client.util.MutableBuilder
applyMutation
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
copy
Description copied from interface:CopyableBuilderCreate a new builderCopyableBuilderthat is a copy of this one.- Specified by:
copyin interfaceCopyableBuilder<SnapshotsRecord.Builder,SnapshotsRecord> - Returns:
- a new builder instance.
-
duration
API name:duration -
duration
@Nonnull public final SnapshotsRecord.Builder duration(Function<Time.Builder, ObjectBuilder<Time>> fn) API name:duration -
endEpoch
API name:end_epoch -
endTime
API name:end_time -
failedShards
The number of failed shards in the snapshot.API name:
failed_shards -
id
The unique identifier for the snapshot.API name:
id -
indices
The number of indexes in the snapshot.API name:
indices -
reason
The reason for any snapshot failures.API name:
reason -
repository
The repository name.API name:
repository -
startEpoch
API name:start_epoch -
startTime
API name:start_time -
status
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 -
successfulShards
The number of successful shards in the snapshot.API name:
successful_shards -
totalShards
The total number of shards in the snapshot.API name:
total_shards -
build
Builds aSnapshotsRecord.- Specified by:
buildin interfaceObjectBuilder<SnapshotsRecord>- Throws:
NullPointerException- if some of the required fields are null.
-