Package org.opensearch.client.opensearch.snapshot

Class CreateSnapshotRequest

    • Method Detail

      • clusterManagerTimeout

        @Nullable
public final Time clusterManagerTimeout()
        Operation timeout for connection to cluster-manager node.

        API name: cluster_manager_timeout

      • featureStates

        @Nonnull
public final java.util.List<java.lang.String> featureStates()
        Feature states to include in the snapshot. Each feature state includes one or more system indexes 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 indexes 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 indexes, such as Watches and task records (configurable with feature_states).

        API name: include_global_state

      • indices

        @Nonnull
public final java.util.List<java.lang.String> indices()
        API name: indices

      • masterTimeout

        @Deprecated
@Nullable
public final Time masterTimeout()
        Deprecated.
        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: master_timeout

      • metadata

        @Nonnull
public final java.util.Map<java.lang.String,​JsonData> metadata()
        API name: metadata

      • partial

        @Nullable
public final java.lang.Boolean partial()
        If true, allows restoring a partial snapshot of indexes 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 indexes included in the snapshot do not have all primary shards available.

        API name: partial

      • repository

        @Nonnull
public final java.lang.String repository()
        Required - Repository for the snapshot.

        API name: repository

      • snapshot

        @Nonnull
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)

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object