io.github.honhimw.ms.api.MSearchClient Maven / Gradle / Ivy

Go to download
/*
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.github.honhimw.ms.api;

import io.github.honhimw.ms.MSearchConfig;
import io.github.honhimw.ms.api.reactive.Logs;
import io.github.honhimw.ms.internal.MSearchClientImpl;
import io.github.honhimw.ms.model.MultiSearchRequest;
import io.github.honhimw.ms.model.SearchResponse;
import io.github.honhimw.ms.model.TaskInfo;
import io.github.honhimw.ms.model.Version;
import io.swagger.v3.oas.annotations.Operation;

import java.util.List;
import java.util.Map;
import java.util.function.Consumer;
import java.util.function.Function;

/**
 * @author hon_him
 * @since 2024-01-03
 */

public interface MSearchClient extends AutoCloseable {

    /**
     * @return Indexes operator
     */
    Indexes indexes();

    /**
     * @return Indexes operator
     */
    default  R indexes(Function operation) {
        return operation.apply(indexes());
    }

    /**
     * @return Tasks operator
     */
    Tasks tasks();

    /**
     * @return Tasks operator
     */
    default  R tasks(Function operation) {
        return operation.apply(tasks());
    }

    /**
     * @return Keys operator
     */
    Keys keys();

    /**
     * @return Keys operator
     */
    default  R keys(Function operation) {
        return operation.apply(keys());
    }

    /**
     * The /multi-search route allows you
     * to perform multiple search queries on one or more indexes by bundling them into a single HTTP request.
     * Multi-search is also known as federated search.
     * 
     * Perform a multi-search
     * 

     * Bundle multiple search queries in a single API request. Use this endpoint to search through multiple indexes at once.
     * 
WARNING
     *      * If Meilisearch encounters an error when handling any of the queries in a multi-search request, it immediately stops processing the request and returns an error message. The returned message will only address the first error encountered.
     * 
     *
     * @return multi-search result
     */
    @Operation(method = "POST", tags = "/multi-search")
    List>> multiSearch(MultiSearchRequest request);

    /**
     * The /health route allows you to verify the status and availability of a Meilisearch instance.
     * 
     * Get health of Meilisearch server.
     */
    default void healthy() {
        throw new IllegalStateException("server status not ['available']");
    }

    /**
     * The /version route allows you to check the version of a running Meilisearch instance.
     *
     * @return Meilisearch server version information.
     */
    Version version();

    /**
     * 
Dumps
     * The /dumps route allows the creation of database dumps. Dumps are .dump files that can be used to restore Meilisearch data or migrate between different versions.
     * 
     * Triggers a dump creation task. Once the process is complete, a dump is created in the dump directory. If the dump directory does not exist yet, it will be created.
     * 

     * Dump tasks take priority over all other tasks in the queue. This means that a newly created dump task will be processed as soon as the current task is finished.
     */
    TaskInfo dumps();

    /**
     * 
Snapshots
     * The /snapshot route allows you to create database snapshots. Snapshots are .snapshot files that can be used to make quick backups of Meilisearch data.
     * 
     * Learn more about snapshots.
     * 
     * Snapshot tasks take priority over other tasks in the queue.
     */
    TaskInfo snapshots();

    /**
     * @return Logs operator
     */
    Logs logs();

    /**
     * @return ExperimentalFeaturesSettings operator
     */
    ExperimentalFeaturesSettings experimentalFeatures();

    /**
     * @return ExperimentalFeaturesSettings operator
     */
    default  R experimentalFeatures(Function operation) {
        return operation.apply(experimentalFeatures());
    }

    /**
     * Create a blocking-client.
     *
     * @param config client configuration
     * @return blocking-client
     */
    static MSearchClient create(MSearchConfig config) {
        return new MSearchClientImpl(config);
    }

    /**
     * Create a blocking-client with default config.
     *
     * @param configure client configure
     * @return blocking-client
     */
    static MSearchClient create(Consumer configure) {
        MSearchConfig.Builder builder = MSearchConfig.withDefault();
        configure.accept(builder);
        MSearchConfig config = builder.build();
        return new MSearchClientImpl(config);
    }

    /**
     * Close current client.
     */
    @Override
    void close();
}