Class CreateSnapshotRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.elasticsearch.snapshot.CreateSnapshotRequest.Builder
- All Implemented Interfaces:
ObjectBuilder<CreateSnapshotRequest>
- Enclosing class:
- CreateSnapshotRequest
public static class CreateSnapshotRequest.Builder extends ObjectBuilderBase implements ObjectBuilder<CreateSnapshotRequest>
Builder for
CreateSnapshotRequest
.-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
Modifier and Type Method Description CreateSnapshotRequest
build()
Builds aCreateSnapshotRequest
.CreateSnapshotRequest.Builder
featureStates(java.lang.String value, java.lang.String... values)
Feature states to include in the snapshot.CreateSnapshotRequest.Builder
featureStates(java.util.List<java.lang.String> list)
Feature states to include in the snapshot.CreateSnapshotRequest.Builder
ignoreUnavailable(java.lang.Boolean value)
Iftrue
, the request ignores data streams and indices inindices
that are missing or closed.CreateSnapshotRequest.Builder
includeGlobalState(java.lang.Boolean value)
Iftrue
, the current cluster state is included in the snapshot.CreateSnapshotRequest.Builder
indices(java.lang.String value, java.lang.String... values)
Data streams and indices to include in the snapshot.CreateSnapshotRequest.Builder
indices(java.util.List<java.lang.String> list)
Data streams and indices to include in the snapshot.CreateSnapshotRequest.Builder
masterTimeout(Time value)
Period to wait for a connection to the master node.CreateSnapshotRequest.Builder
masterTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)
Period to wait for a connection to the master node.CreateSnapshotRequest.Builder
metadata(java.lang.String key, JsonData value)
Optional metadata for the snapshot.CreateSnapshotRequest.Builder
metadata(java.util.Map<java.lang.String,JsonData> map)
Optional metadata for the snapshot.CreateSnapshotRequest.Builder
partial(java.lang.Boolean value)
Iftrue
, allows restoring a partial snapshot of indices with unavailable shards.CreateSnapshotRequest.Builder
repository(java.lang.String value)
Required - Repository for the snapshot.CreateSnapshotRequest.Builder
snapshot(java.lang.String value)
Required - Name of the snapshot.CreateSnapshotRequest.Builder
waitForCompletion(java.lang.Boolean value)
Iftrue
, the request returns a response when the snapshot is complete.Methods inherited from class co.elastic.clients.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 Details
-
Builder
public Builder()
-
-
Method Details
-
featureStates
Feature states to include in the snapshot. Each feature state includes one or more system indices containing related data. You can view a list of eligible features using the get features API. Ifinclude_global_state
istrue
, all current feature states are included by default. Ifinclude_global_state
isfalse
, no feature states are included by default.API name:
feature_states
Adds all elements of
list
tofeatureStates
. -
featureStates
public final CreateSnapshotRequest.Builder featureStates(java.lang.String value, java.lang.String... values)Feature states to include in the snapshot. Each feature state includes one or more system indices containing related data. You can view a list of eligible features using the get features API. Ifinclude_global_state
istrue
, all current feature states are included by default. Ifinclude_global_state
isfalse
, no feature states are included by default.API name:
feature_states
Adds one or more values to
featureStates
. -
includeGlobalState
Iftrue
, the current cluster state is included in the snapshot. The cluster state includes persistent cluster settings, composable index templates, legacy index templates, ingest pipelines, and ILM policies. It also includes data stored in system indices, such as Watches and task records (configurable viafeature_states
).API name:
include_global_state
-
indices
Data streams and indices to include in the snapshot. Supports multi-target syntax. Includes all data streams and indices by default.API name:
indices
Adds all elements of
list
toindices
. -
indices
public final CreateSnapshotRequest.Builder indices(java.lang.String value, java.lang.String... values)Data streams and indices to include in the snapshot. Supports multi-target syntax. Includes all data streams and indices by default.API name:
indices
Adds one or more values to
indices
. -
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 CreateSnapshotRequest.Builder masterTimeout(java.util.function.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
-
metadata
Optional metadata for the snapshot. May have any contents. Must be less than 1024 bytes. This map is not automatically generated by Elasticsearch.API name:
metadata
Adds all entries of
map
tometadata
. -
metadata
Optional metadata for the snapshot. May have any contents. Must be less than 1024 bytes. This map is not automatically generated by Elasticsearch.API name:
metadata
Adds an entry to
metadata
. -
partial
Iftrue
, allows restoring a partial snapshot of indices with unavailable shards. Only shards that were successfully included in the snapshot will be restored. All missing shards will be recreated as empty. Iffalse
, the entire restore operation will fail if one or more indices included in the snapshot do not have all primary shards available.API name:
partial
-
repository
Required - Repository for the snapshot.API name:
repository
-
snapshot
Required - Name of the snapshot. Must be unique in the repository.API name:
snapshot
-
waitForCompletion
Iftrue
, the request returns a response when the snapshot is complete. Iffalse
, the request returns a response when the snapshot initializes.API name:
wait_for_completion
-
build
Builds aCreateSnapshotRequest
.- Specified by:
build
in interfaceObjectBuilder<CreateSnapshotRequest>
- Throws:
java.lang.NullPointerException
- if some of the required fields are null.
-