org.elasticsearch.client.FeaturesClient Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of elasticsearch-rest-high-level-client Show documentation
Elasticsearch subproject :client:rest-high-level
There is a newer version: 8.0.0-alpha2
Show newest version
/*
 * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
 * or more contributor license agreements. Licensed under the Elastic License
 * 2.0 and the Server Side Public License, v 1; you may not use this file except
 * in compliance with, at your election, the Elastic License 2.0 or the Server
 * Side Public License, v 1.
 */

package org.elasticsearch.client;

import org.elasticsearch.action.ActionListener;
import org.elasticsearch.client.feature.GetFeaturesRequest;
import org.elasticsearch.client.feature.GetFeaturesResponse;
import org.elasticsearch.client.feature.ResetFeaturesRequest;
import org.elasticsearch.client.feature.ResetFeaturesResponse;

import java.io.IOException;

import static java.util.Collections.emptySet;

/**
 * A wrapper for the {@link RestHighLevelClient} that provides methods for accessing the Snapshot API.
 * 
 * See Snapshot API on elastic.co
 *
 * @deprecated The High Level Rest Client is deprecated in favor of the
 * 
 * Elasticsearch Java API Client
 */
@Deprecated
@SuppressWarnings("removal")
public class FeaturesClient {
    private final RestHighLevelClient restHighLevelClient;

    FeaturesClient(RestHighLevelClient restHighLevelClient) {
        this.restHighLevelClient = restHighLevelClient;
    }

    /**
     * Get a list of features which can be included in a snapshot as feature states.
     * See  Get Snapshottable
     * Features API on elastic.co
     *
     * @param getFeaturesRequest the request
     * @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
     * @return the response
     * @throws IOException in case there is a problem sending the request or parsing back the response
     */
    public GetFeaturesResponse getFeatures(GetFeaturesRequest getFeaturesRequest, RequestOptions options) throws IOException {
        return restHighLevelClient.performRequestAndParseEntity(
            getFeaturesRequest,
            FeaturesRequestConverters::getFeatures,
            options,
            GetFeaturesResponse::parse,
            emptySet()
        );
    }

    /**
     * Asynchronously get a list of features which can be included in a snapshot as feature states.
     * See  Get Snapshottable
     * Features API on elastic.co
     *
     * @param getFeaturesRequest the request
     * @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
     * @param listener the listener to be notified upon request completion
     * @return cancellable that may be used to cancel the request
     */
    public Cancellable getFeaturesAsync(
        GetFeaturesRequest getFeaturesRequest,
        RequestOptions options,
        ActionListener listener
    ) {
        return restHighLevelClient.performRequestAsyncAndParseEntity(
            getFeaturesRequest,
            FeaturesRequestConverters::getFeatures,
            options,
            GetFeaturesResponse::parse,
            listener,
            emptySet()
        );
    }

    /**
     * Reset the state of Elasticsearch features, deleting system indices and performing other
     * cleanup operations.
     * See  Rest
     * Features API on elastic.co
     *
     * @param resetFeaturesRequest the request
     * @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
     * @return the response
     * @throws IOException in case there is a problem sending the request or parsing back the response
     */
    public ResetFeaturesResponse resetFeatures(ResetFeaturesRequest resetFeaturesRequest, RequestOptions options) throws IOException {
        return restHighLevelClient.performRequestAndParseEntity(
            resetFeaturesRequest,
            FeaturesRequestConverters::resetFeatures,
            options,
            ResetFeaturesResponse::parse,
            emptySet()
        );
    }

    /**
     * Asynchronously reset the state of Elasticsearch features, deleting system indices and performing other
     * cleanup operations.
     * See  Get Snapshottable
     * Features API on elastic.co
     *
     * @param resetFeaturesRequest the request
     * @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
     * @param listener the listener to be notified upon request completion
     * @return cancellable that may be used to cancel the request
     */
    public Cancellable resetFeaturesAsync(
        ResetFeaturesRequest resetFeaturesRequest,
        RequestOptions options,
        ActionListener listener
    ) {
        return restHighLevelClient.performRequestAsyncAndParseEntity(
            resetFeaturesRequest,
            FeaturesRequestConverters::resetFeatures,
            options,
            ResetFeaturesResponse::parse,
            listener,
            emptySet()
        );
    }
}