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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of meilisearch-rest-client Show documentation

Reactive meilisearch rest client powered by reactor-netty-http.

There is a newer version: 1.12.0.0

Show newest version

/*
 * 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.model.TaskInfo;
import io.swagger.v3.oas.annotations.Operation;
import jakarta.annotation.Nullable;

/**
 * Distinct attribute
 * 
 * The distinct attribute is a field whose value will always be unique in the returned documents.
 * 
WARNING
 *  * Updating distinct attributes will re-index all documents in the index, which can take some time.
 * We recommend updating your index settings first and then adding documents as this reduces RAM consumption.
 * 
 * 
 * To learn more about the distinct attribute, refer to our dedicated guide.
 *
 * @author hon_him
 * @since 2024-01-03
 */

public interface DistinctAttributeSettings {

    /**
     * Get the distinct attribute of an index.
     *
     * @return current index distinct attributes
     */
    @Nullable
    @Operation(method = "GET", tags = "/indexes/{index_uid}/settings/distinct-attribute")
    String get();

    /**
     * Update the displayed attributes of an index.
     *
     * @param distinctAttribute the new distinct attribute
     * @return update task
     */
    @Operation(method = "PUT", tags = "/indexes/{index_uid}/settings/distinct-attribute")
    TaskInfo update(String distinctAttribute);

    /**
     * Reset the displayed attributes of the index to the default value.
     *
     * @return reset task
     */
    @Operation(method = "DELETE", tags = "/indexes/{index_uid}/settings/distinct-attribute")
    TaskInfo reset();

}