org.elasticsearch.client.TextStructureClient 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.textstructure.FindStructureRequest;
import org.elasticsearch.client.textstructure.FindStructureResponse;

import java.io.IOException;
import java.util.Collections;

/**
 * Text Structure API client wrapper for the {@link RestHighLevelClient}
 * 
 * See the 
 * X-Pack Text Structure APIs  for additional information.
 *
 * @deprecated The High Level Rest Client is deprecated in favor of the
 * 
 * Elasticsearch Java API Client
 */
@Deprecated
@SuppressWarnings("removal")
public final class TextStructureClient {

    private final RestHighLevelClient restHighLevelClient;

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

    /**
     * Finds the structure of a file
     * 

     * For additional info
     * see 
     *     Text Structure Find Structure documentation
     *
     * @param request The find file structure request
     * @param options  Additional request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
     * @return the response containing details of the file structure
     * @throws IOException when there is a serialization issue sending the request or receiving the response
     */
    public FindStructureResponse findStructure(FindStructureRequest request, RequestOptions options) throws IOException {
        return restHighLevelClient.performRequestAndParseEntity(
            request,
            TextStructureRequestConverters::findFileStructure,
            options,
            FindStructureResponse::fromXContent,
            Collections.emptySet()
        );
    }

    /**
     * Finds the structure of a file asynchronously and notifies the listener on completion
     * 
     * For additional info
     * see 
     *         Text Structure Find Structure documentation
     *
     * @param request The find file structure request
     * @param options  Additional request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
     * @param listener Listener to be notified upon request completion
     * @return cancellable that may be used to cancel the request
     */
    public Cancellable findStructureAsync(
        FindStructureRequest request,
        RequestOptions options,
        ActionListener listener
    ) {
        return restHighLevelClient.performRequestAsyncAndParseEntity(
            request,
            TextStructureRequestConverters::findFileStructure,
            options,
            FindStructureResponse::fromXContent,
            listener,
            Collections.emptySet()
        );
    }

}