Package org.opensearch.client.opensearch.snapshot

Class CreateSnapshotRequest.Builder

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • featureStates

        public final CreateSnapshotRequest.Builder featureStates​(java.util.List<java.lang.String> list)
        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

        Adds all elements of list to featureStates.

      • 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. 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

        Adds one or more values to featureStates.

      • ignoreUnavailable

        public final CreateSnapshotRequest.Builder ignoreUnavailable​(@Nullable
                                                             java.lang.Boolean value)
        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

        public final CreateSnapshotRequest.Builder includeGlobalState​(@Nullable
                                                              java.lang.Boolean value)
        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 CreateSnapshotRequest.Builder indices​(java.util.List<java.lang.String> list)
        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 to indices.

      • 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

        @Deprecated
public final CreateSnapshotRequest.Builder masterTimeout​(@Nullable
                                                         Time value)
        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

      • masterTimeout

        @Deprecated
public final CreateSnapshotRequest.Builder masterTimeout​(java.util.function.Function<Time.Builder,​ObjectBuilder<Time>> fn)
        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

        public final CreateSnapshotRequest.Builder clusterManagerTimeout​(@Nullable
                                                                 Time value)
        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

      • clusterManagerTimeout

        public final CreateSnapshotRequest.Builder clusterManagerTimeout​(java.util.function.Function<Time.Builder,​ObjectBuilder<Time>> fn)
        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 CreateSnapshotRequest.Builder metadata​(java.util.Map<java.lang.String,​JsonData> map)
        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 to metadata.

      • metadata

        public final CreateSnapshotRequest.Builder metadata​(java.lang.String key,
                                                    JsonData value)
        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

        public final CreateSnapshotRequest.Builder partial​(@Nullable
                                                   java.lang.Boolean value)
        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 CreateSnapshotRequest.Builder repository​(java.lang.String value)
        Required - Repository for the snapshot.

        API name: repository

      • snapshot

        public final CreateSnapshotRequest.Builder snapshot​(java.lang.String value)
        Required - Name of the snapshot. Must be unique in the repository.

        API name: snapshot

      • waitForCompletion

        public final CreateSnapshotRequest.Builder waitForCompletion​(@Nullable
                                                             java.lang.Boolean value)
        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