Class SnapshotInfo.Builder
- All Implemented Interfaces:
CopyableBuilder<SnapshotInfo.Builder,,SnapshotInfo> MutableBuilder<SnapshotInfo.Builder,,SnapshotInfo> ObjectBuilder<SnapshotInfo>
- Enclosing class:
SnapshotInfo
SnapshotInfo.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()Builds aSnapshotInfo.copy()Create a new builderCopyableBuilderthat is a copy of this one.final SnapshotInfo.BuilderdataStreams(String value, String... values) The list of data streams included in the snapshot.final SnapshotInfo.BuilderdataStreams(List<String> list) The list of data streams included in the snapshot.final SnapshotInfo.BuilderThe total time taken to complete the snapshot.final SnapshotInfo.BuilderThe total time taken to complete the snapshot.final SnapshotInfo.BuilderdurationInMillis(Long value) The total time taken to complete the snapshot in milliseconds.final SnapshotInfo.BuilderThe time when the snapshot completed.final SnapshotInfo.BuilderendTimeInMillis(Long value) The time when the snapshot completed in milliseconds.final SnapshotInfo.BuilderThe list of shard failures that occurred during the snapshot.final SnapshotInfo.Builderfailures(List<SnapshotShardFailure> list) The list of shard failures that occurred during the snapshot.final SnapshotInfo.Builderfailures(SnapshotShardFailure value, SnapshotShardFailure... values) The list of shard failures that occurred during the snapshot.final SnapshotInfo.BuilderincludeGlobalState(Boolean value) Whether the snapshot includes the cluster state.final SnapshotInfo.BuilderThe list of indexes included in the snapshot.final SnapshotInfo.BuilderThe list of indexes included in the snapshot.final SnapshotInfo.BuilderThe custom metadata attached to the snapshot.final SnapshotInfo.BuilderThe custom metadata attached to the snapshot.final SnapshotInfo.BuilderpinnedTimestamp(Long value) The timestamp when the snapshot was pinned.final SnapshotInfo.BuilderThe reason for the snapshot creation.final SnapshotInfo.BuilderWhether the snapshot uses remote store index shallow copy.final SnapshotInfo.BuilderThe statistics about the shards included in the snapshot.final SnapshotInfo.Buildershards(ShardStatistics value) The statistics about the shards included in the snapshot.final SnapshotInfo.BuilderThe name of the snapshot.final SnapshotInfo.BuilderThe time when the snapshot started.final SnapshotInfo.BuilderstartTimeInMillis(Long value) The time when the snapshot started in milliseconds.final SnapshotInfo.BuilderThe current state of the snapshot.final SnapshotInfo.BuilderThe unique identifier for the snapshot.final SnapshotInfo.BuilderThe version of OpenSearch when the snapshot was created.final SnapshotInfo.BuilderThe internal version number of OpenSearch when the snapshot was created.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<SnapshotInfo.Builder,SnapshotInfo> - Returns:
- a new builder instance.
-
dataStreams
The list of data streams included in the snapshot.API name:
data_streamsAdds all elements of
listtodataStreams. -
dataStreams
The list of data streams included in the snapshot.API name:
data_streamsAdds one or more values to
dataStreams. -
duration
The total time taken to complete the snapshot.API name:
duration -
duration
The total time taken to complete the snapshot.API name:
duration -
durationInMillis
The total time taken to complete the snapshot in milliseconds.API name:
duration_in_millis -
endTime
The time when the snapshot completed.API name:
end_time -
endTimeInMillis
The time when the snapshot completed in milliseconds.API name:
end_time_in_millis -
failures
The list of shard failures that occurred during the snapshot.API name:
failuresAdds all elements of
listtofailures. -
failures
@Nonnull public final SnapshotInfo.Builder failures(SnapshotShardFailure value, SnapshotShardFailure... values) The list of shard failures that occurred during the snapshot.API name:
failuresAdds one or more values to
failures. -
failures
@Nonnull public final SnapshotInfo.Builder failures(Function<SnapshotShardFailure.Builder, ObjectBuilder<SnapshotShardFailure>> fn) The list of shard failures that occurred during the snapshot.API name:
failuresAdds a value to
failuresusing a builder lambda. -
includeGlobalState
Whether the snapshot includes the cluster state.API name:
include_global_state -
indices
The list of indexes included in the snapshot.API name:
indicesAdds all elements of
listtoindices. -
indices
The list of indexes included in the snapshot.API name:
indicesAdds one or more values to
indices. -
metadata
The custom metadata attached to the snapshot.API name:
metadataAdds all elements of
maptometadata. -
metadata
The custom metadata attached to the snapshot.API name:
metadataAdds an entry to
metadata. -
pinnedTimestamp
The timestamp when the snapshot was pinned.API name:
pinned_timestamp -
reason
The reason for the snapshot creation.API name:
reason -
remoteStoreIndexShallowCopy
Whether the snapshot uses remote store index shallow copy.API name:
remote_store_index_shallow_copy -
shards
The statistics about the shards included in the snapshot.API name:
shards -
shards
@Nonnull public final SnapshotInfo.Builder shards(Function<ShardStatistics.Builder, ObjectBuilder<ShardStatistics>> fn) The statistics about the shards included in the snapshot.API name:
shards -
snapshot
The name of the snapshot.API name:
snapshot -
startTime
The time when the snapshot started.API name:
start_time -
startTimeInMillis
The time when the snapshot started in milliseconds.API name:
start_time_in_millis -
state
The current state of the snapshot.API name:
state -
uuid
The unique identifier for the snapshot.API name:
uuid -
version
The version of OpenSearch when the snapshot was created.API name:
version -
versionId
The internal version number of OpenSearch when the snapshot was created.API name:
version_id -
build
Builds aSnapshotInfo.- Specified by:
buildin interfaceObjectBuilder<SnapshotInfo>- Throws:
NullPointerException- if some of the required fields are null.
-