Package org.opensearch.client.opensearch.snapshot

Class CreateSnapshotRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.snapshot.CreateSnapshotRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class CreateSnapshotRequest
extends RequestBase
implements JsonpSerializable

Creates a snapshot in a repository.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CreateSnapshotRequest.Builder	Builder for CreateSnapshotRequest.

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static JsonpDeserializer<CreateSnapshotRequest>	_DESERIALIZER	Json deserializer for CreateSnapshotRequest
static Endpoint<CreateSnapshotRequest,CreateSnapshotResponse,ErrorResponse>	_ENDPOINT	Endpoint "snapshot.create".

Method Summary

Modifier and Type	Method	Description
Time	clusterManagerTimeout()	Period to wait for a connection to the cluster-manager node.
java.util.List<java.lang.String>	featureStates()	Feature states to include in the snapshot.
java.lang.Boolean	ignoreUnavailable()	If true, the request ignores data streams and indices in indices that are missing or closed.
java.lang.Boolean	includeGlobalState()	If true, the current cluster state is included in the snapshot.
java.util.List<java.lang.String>	indices()	Data streams and indices to include in the snapshot.
Time	masterTimeout()	Deprecated.
java.util.Map<java.lang.String,JsonData>	metadata()	Optional metadata for the snapshot.
static CreateSnapshotRequest	of(java.util.function.Function<CreateSnapshotRequest.Builder,ObjectBuilder<CreateSnapshotRequest>> fn)
java.lang.Boolean	partial()	If true, allows restoring a partial snapshot of indices with unavailable shards.
java.lang.String	repository()	Required - Repository for the snapshot.
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupCreateSnapshotRequestDeserializer(ObjectDeserializer<CreateSnapshotRequest.Builder> op)
java.lang.String	snapshot()	Required - Name of the snapshot.
java.lang.Boolean	waitForCompletion()	If true, the request returns a response when the snapshot is complete.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

_DESERIALIZER

public static final JsonpDeserializer<CreateSnapshotRequest> _DESERIALIZER

Json deserializer for CreateSnapshotRequest

_ENDPOINT

public static final Endpoint<CreateSnapshotRequest,CreateSnapshotResponse,ErrorResponse> _ENDPOINT

Endpoint "snapshot.create".

Method Detail

of

public static CreateSnapshotRequest of(java.util.function.Function<CreateSnapshotRequest.Builder,ObjectBuilder<CreateSnapshotRequest>> fn)

featureStates

public final java.util.List<java.lang.String> 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. If include_global_state is true, all current feature states are included by default. If include_global_state is false, no feature states are included by default.

API name: feature_states

ignoreUnavailable

@Nullable
public final java.lang.Boolean ignoreUnavailable()

If true, the request ignores data streams and indices in indices that are missing or closed. If false, the request returns an error for any data stream or index that is missing or closed.

API name: ignore_unavailable

includeGlobalState

@Nullable
public final java.lang.Boolean includeGlobalState()

If true, 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 via feature_states).

API name: include_global_state

indices

public final java.util.List<java.lang.String> 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

masterTimeout

@Deprecated
@Nullable
public final Time masterTimeout()

Deprecated.

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

clusterManagerTimeout

@Nullable
public final Time clusterManagerTimeout()

Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error.

API name: cluster_manager_timeout

metadata

public final java.util.Map<java.lang.String,JsonData> 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

partial

@Nullable
public final java.lang.Boolean partial()

If true, 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. If false, 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

public final java.lang.String repository()

Required - Repository for the snapshot.

API name: repository

snapshot

public final java.lang.String snapshot()

Required - Name of the snapshot. Must be unique in the repository.

API name: snapshot

waitForCompletion

@Nullable
public final java.lang.Boolean waitForCompletion()

If true, the request returns a response when the snapshot is complete. If false, the request returns a response when the snapshot initializes.

API name: wait_for_completion

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
                      JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
                                 JsonpMapper mapper)

setupCreateSnapshotRequestDeserializer

protected static void setupCreateSnapshotRequestDeserializer(ObjectDeserializer<CreateSnapshotRequest.Builder> op)