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
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds aSnapshotsRecord
.final SnapshotsRecord.Builder
The time it took the snapshot process to complete, in time units.final SnapshotsRecord.Builder
The time it took the snapshot process to complete, in time units.final SnapshotsRecord.Builder
The Unix epoch time (seconds since 1970-01-01 00:00:00) at which the snapshot process ended.final SnapshotsRecord.Builder
The time (HH:MM:SS) at which the snapshot process ended.final SnapshotsRecord.Builder
failedShards
(String value) The number of failed shards in the snapshot.final SnapshotsRecord.Builder
The unique identifier for the snapshot.final SnapshotsRecord.Builder
The number of indices in the snapshot.final SnapshotsRecord.Builder
The reason for any snapshot failures.final SnapshotsRecord.Builder
repository
(String value) The repository name.protected SnapshotsRecord.Builder
self()
final SnapshotsRecord.Builder
startEpoch
(Long value) The Unix epoch time (seconds since 1970-01-01 00:00:00) at which the snapshot process started.final SnapshotsRecord.Builder
startTime
(ScheduleTimeOfDay value) The time (HH:MM:SS) at which the snapshot process started.final SnapshotsRecord.Builder
The time (HH:MM:SS) at which the snapshot process started.final SnapshotsRecord.Builder
The state of the snapshot process.final SnapshotsRecord.Builder
successfulShards
(String value) The number of successful shards in the snapshot.final SnapshotsRecord.Builder
totalShards
(String value) The total number of shards in the snapshot.Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase
withJson
Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
id
The unique identifier for the snapshot.API name:
id
-
repository
The repository name.API name:
repository
-
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
-
startEpoch
The Unix epoch time (seconds since 1970-01-01 00:00:00) at which the snapshot process started.API name:
start_epoch
-
startTime
The time (HH:MM:SS) at which the snapshot process started.API name:
start_time
-
startTime
public final SnapshotsRecord.Builder startTime(Function<ScheduleTimeOfDay.Builder, ObjectBuilder<ScheduleTimeOfDay>> fn) The time (HH:MM:SS) at which the snapshot process started.API name:
start_time
-
endEpoch
The Unix epoch time (seconds since 1970-01-01 00:00:00) at which the snapshot process ended.API name:
end_epoch
-
endTime
The time (HH:MM:SS) at which the snapshot process ended.API name:
end_time
-
duration
The time it took the snapshot process to complete, in time units.API name:
duration
-
duration
The time it took the snapshot process to complete, in time units.API name:
duration
-
indices
The number of indices in the snapshot.API name:
indices
-
successfulShards
The number of successful shards in the snapshot.API name:
successful_shards
-
failedShards
The number of failed shards in the snapshot.API name:
failed_shards
-
totalShards
The total number of shards in the snapshot.API name:
total_shards
-
reason
The reason for any snapshot failures.API name:
reason
-
self
- Specified by:
self
in classWithJsonObjectBuilderBase<SnapshotsRecord.Builder>
-
build
Builds aSnapshotsRecord
.- Specified by:
build
in interfaceObjectBuilder<SnapshotsRecord>
- Throws:
NullPointerException
- if some of the required fields are null.
-