Class GetSnapshotRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<GetSnapshotRequest.Builder>
co.elastic.clients.elasticsearch.snapshot.GetSnapshotRequest.Builder
- All Implemented Interfaces:
WithJson<GetSnapshotRequest.Builder>
,ObjectBuilder<GetSnapshotRequest>
- Enclosing class:
- GetSnapshotRequest
public static class GetSnapshotRequest.Builder
extends RequestBase.AbstractBuilder<GetSnapshotRequest.Builder>
implements ObjectBuilder<GetSnapshotRequest>
Builder for
GetSnapshotRequest
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionOffset identifier to start pagination from as returned by the next field in the response body.build()
Builds aGetSnapshotRequest
.fromSortValue
(String value) Value of the current sort column at which to start retrieval.ignoreUnavailable
(Boolean value) If false, the request returns an error for any snapshots that are unavailable.includeRepository
(Boolean value) If true, returns the repository name in each snapshot.indexDetails
(Boolean value) If true, returns additional information about each index in the snapshot comprising the number of shards in the index, the total size of the index in bytes, and the maximum number of segments per shard in the index.indexNames
(Boolean value) If true, returns the name of each index in each snapshot.masterTimeout
(Time value) Period to wait for a connection to the master node.Period to wait for a connection to the master node.Numeric offset to start pagination from based on the snapshots matching this request.Sort order.repository
(String value) Required - Comma-separated list of snapshot repository names used to limit the request.protected GetSnapshotRequest.Builder
self()
Maximum number of snapshots to return.slmPolicyFilter
(String value) Filter snapshots by a comma-separated list of SLM policy names that snapshots belong to.Required - Comma-separated list of snapshot names to retrieve.Required - Comma-separated list of snapshot names to retrieve.sort
(SnapshotSort value) Allows setting a sort order for the result.If true, returns additional information about each snapshot such as the version of Elasticsearch which took the snapshot, the start and end times of the snapshot, and the number of shards snapshotted.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
-
after
Offset identifier to start pagination from as returned by the next field in the response body.API name:
after
-
fromSortValue
Value of the current sort column at which to start retrieval. Can either be a string snapshot- or repository name when sorting by snapshot or repository name, a millisecond time value or a number when sorting by index- or shard count.API name:
from_sort_value
-
includeRepository
If true, returns the repository name in each snapshot.API name:
include_repository
-
indexDetails
If true, returns additional information about each index in the snapshot comprising the number of shards in the index, the total size of the index in bytes, and the maximum number of segments per shard in the index. Defaults to false, meaning that this information is omitted.API name:
index_details
-
indexNames
If true, returns the name of each index in each snapshot.API name:
index_names
-
masterTimeout
Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.API name:
master_timeout
-
masterTimeout
public final GetSnapshotRequest.Builder masterTimeout(Function<Time.Builder, ObjectBuilder<Time>> fn) Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.API name:
master_timeout
-
offset
Numeric offset to start pagination from based on the snapshots matching this request. Using a non-zero value for this parameter is mutually exclusive with using the after parameter. Defaults to 0.API name:
offset
-
order
Sort order. Valid values are asc for ascending and desc for descending order. Defaults to asc, meaning ascending order.API name:
order
-
repository
Required - Comma-separated list of snapshot repository names used to limit the request. Wildcard (*) expressions are supported.API name:
repository
-
size
Maximum number of snapshots to return. Defaults to 0 which means return all that match the request without limit.API name:
size
-
slmPolicyFilter
Filter snapshots by a comma-separated list of SLM policy names that snapshots belong to. Also accepts wildcards (*) and combinations of wildcards followed by exclude patterns starting with -. To include snapshots not created by an SLM policy you can use the special pattern _none that will match all snapshots without an SLM policy.API name:
slm_policy_filter
-
snapshot
Required - Comma-separated list of snapshot names to retrieve. Also accepts wildcards (*).- To get information about all snapshots in a registered repository, use a wildcard (*) or _all.
- To get information about any snapshots that are currently running, use _current.
API name:
snapshot
Adds all elements of
list
tosnapshot
. -
snapshot
Required - Comma-separated list of snapshot names to retrieve. Also accepts wildcards (*).- To get information about all snapshots in a registered repository, use a wildcard (*) or _all.
- To get information about any snapshots that are currently running, use _current.
API name:
snapshot
Adds one or more values to
snapshot
. -
sort
Allows setting a sort order for the result. Defaults to start_time, i.e. sorting by snapshot start time stamp.API name:
sort
-
verbose
If true, returns additional information about each snapshot such as the version of Elasticsearch which took the snapshot, the start and end times of the snapshot, and the number of shards snapshotted.API name:
verbose
-
self
- Specified by:
self
in classRequestBase.AbstractBuilder<GetSnapshotRequest.Builder>
-
build
Builds aGetSnapshotRequest
.- Specified by:
build
in interfaceObjectBuilder<GetSnapshotRequest>
- Throws:
NullPointerException
- if some of the required fields are null.
-