Package org.elasticsearch.action.admin.cluster.snapshots.restore

Class RestoreSnapshotRequestBuilder

    • Constructor Detail

      • RestoreSnapshotRequestBuilder

        public RestoreSnapshotRequestBuilder​(ElasticsearchClient client,
                                     RestoreSnapshotAction action,
                                     java.lang.String repository,
                                     java.lang.String name)
        Constructs new restore snapshot request builder with specified repository and snapshot names

    • Method Detail

      • setSnapshot

        public RestoreSnapshotRequestBuilder setSnapshot​(java.lang.String snapshot)
        Sets snapshot name
        Parameters:
        snapshot - snapshot name
        Returns:
        this builder

      • setRepository

        public RestoreSnapshotRequestBuilder setRepository​(java.lang.String repository)
        Sets repository name
        Parameters:
        repository - repository name
        Returns:
        this builder

      • setIndices

        public RestoreSnapshotRequestBuilder setIndices​(java.lang.String... indices)
        Sets the list of indices that should be restored from snapshot

        The list of indices supports multi-index syntax. For example: "+test*" ,"-test42" will index all indices with prefix "test" except index "test42". Aliases are not supported. An empty list or {"_all"} will restore all open indices in the snapshot.

        Parameters:
        indices - list of indices
        Returns:
        this builder

      • setIndicesOptions

        public RestoreSnapshotRequestBuilder setIndicesOptions​(IndicesOptions indicesOptions)
        Specifies what type of requested indices to ignore and how to deal with wildcard expressions. For example indices that don't exist.
        Parameters:
        indicesOptions - the desired behaviour regarding indices to ignore and wildcard indices expressions
        Returns:
        this builder

      • setRenamePattern

        public RestoreSnapshotRequestBuilder setRenamePattern​(java.lang.String renamePattern)
        Sets rename pattern that should be applied to restored indices.

        Indices that match the rename pattern will be renamed according to setRenameReplacement(String). The rename pattern is applied according to the Matcher.appendReplacement(StringBuffer, String) The request will fail if two or more indices will be renamed into the same name.

        Parameters:
        renamePattern - rename pattern
        Returns:
        this builder

      • setRenameReplacement

        public RestoreSnapshotRequestBuilder setRenameReplacement​(java.lang.String renameReplacement)
        Sets rename replacement

        See setRenamePattern(String) for more information.

        Parameters:
        renameReplacement - rename replacement
        Returns:
        this builder

      • setSettings

        public RestoreSnapshotRequestBuilder setSettings​(Settings settings)
        Sets repository-specific restore settings.

        See repository documentation for more information.

        Parameters:
        settings - repository-specific snapshot settings
        Returns:
        this builder

      • setSettings

        public RestoreSnapshotRequestBuilder setSettings​(Settings.Builder settings)
        Sets repository-specific restore settings.

        See repository documentation for more information.

        Parameters:
        settings - repository-specific snapshot settings
        Returns:
        this builder

      • setSettings

        public RestoreSnapshotRequestBuilder setSettings​(java.lang.String source,
                                                 XContentType xContentType)
        Sets repository-specific restore settings in JSON or YAML format

        See repository documentation for more information.

        Parameters:
        source - repository-specific snapshot settings
        xContentType - the content type of the source
        Returns:
        this builder

      • setSettings

        public RestoreSnapshotRequestBuilder setSettings​(java.util.Map<java.lang.String,​java.lang.Object> source)
        Sets repository-specific restore settings

        See repository documentation for more information.

        Parameters:
        source - repository-specific snapshot settings
        Returns:
        this builder

      • setWaitForCompletion

        public RestoreSnapshotRequestBuilder setWaitForCompletion​(boolean waitForCompletion)
        If this parameter is set to true the operation will wait for completion of restore process before returning.
        Parameters:
        waitForCompletion - if true the operation will wait for completion
        Returns:
        this builder

      • setRestoreGlobalState

        public RestoreSnapshotRequestBuilder setRestoreGlobalState​(boolean restoreGlobalState)
        If set to true the restore procedure will restore global cluster state.

        The global cluster state includes persistent settings and index template definitions.

        Parameters:
        restoreGlobalState - true if global state should be restored from the snapshot
        Returns:
        this builder

      • setPartial

        public RestoreSnapshotRequestBuilder setPartial​(boolean partial)
        If set to true the restore procedure will restore partially snapshotted indices
        Parameters:
        partial - true if partially snapshotted indices should be restored
        Returns:
        this builder

      • setIncludeAliases

        public RestoreSnapshotRequestBuilder setIncludeAliases​(boolean restoreAliases)
        If set to true the restore procedure will restore aliases
        Parameters:
        restoreAliases - true if aliases should be restored from the snapshot
        Returns:
        this builder

      • setIndexSettings

        public RestoreSnapshotRequestBuilder setIndexSettings​(Settings settings)
        Sets index settings that should be added or replaced during restore
        Parameters:
        settings - index settings
        Returns:
        this builder

      • setIndexSettings

        public RestoreSnapshotRequestBuilder setIndexSettings​(Settings.Builder settings)
        Sets index settings that should be added or replaced during restore
        Parameters:
        settings - index settings
        Returns:
        this builder

      • setIndexSettings

        public RestoreSnapshotRequestBuilder setIndexSettings​(java.lang.String source,
                                                      XContentType xContentType)
        Sets index settings that should be added or replaced during restore
        Parameters:
        source - index settings
        xContentType - the content type of the source
        Returns:
        this builder

      • setIndexSettings

        public RestoreSnapshotRequestBuilder setIndexSettings​(java.util.Map<java.lang.String,​java.lang.Object> source)
        Sets index settings that should be added or replaced during restore
        Parameters:
        source - index settings
        Returns:
        this builder

      • setIgnoreIndexSettings

        public RestoreSnapshotRequestBuilder setIgnoreIndexSettings​(java.lang.String... ignoreIndexSettings)
        Sets the list of index settings and index settings groups that shouldn't be restored from snapshot

      • setIgnoreIndexSettings

        public RestoreSnapshotRequestBuilder setIgnoreIndexSettings​(java.util.List<java.lang.String> ignoreIndexSettings)
        Sets the list of index settings and index settings groups that shouldn't be restored from snapshot