io.github.honhimw.ms.model.BatchGetDocumentsRequest 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.11.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.model;

import io.github.honhimw.ms.api.annotation.Schema;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.EqualsAndHashCode;
import lombok.NoArgsConstructor;

import java.util.ArrayList;
import java.util.List;
import java.util.Objects;

/**
 * Batch get documents request
 *
 * @author hon_him
 * @since 2024-01-02
 */

@Data
@EqualsAndHashCode(callSuper = false)
@NoArgsConstructor
@AllArgsConstructor
public class BatchGetDocumentsRequest extends FilterableAttributesRequest {

    /**
     * Number of documents to skip.
     * default 0
     */
    @Schema(description = "Number of documents to skip", defaultValue = "0")
    private Integer offset;

    /**
     * Number of documents to return.
     * default 20
     */
    @Schema(description = "Number of documents to return", defaultValue = "20")
    private Integer limit;

    /**
     * Document attributes to show (case-sensitive, comma-separated).
     */
    @Schema(description = "Document attributes to show (case-sensitive, comma-separated)")
    private List fields;

    private BatchGetDocumentsRequest(Builder builder) {
        setOffset(builder.offset);
        setLimit(builder.limit);
        setFields(builder.fields);
        setFilter(builder.filter);
    }

    /**
     * Creates and returns a new instance of the Builder class.
     *
     * @return a new instance of the Builder class
     */
    public static Builder builder() {
        return new Builder();
    }

    /**
     * Add field for fetching(only).
     *
     * @param field field name
     * @return this
     */
    public BatchGetDocumentsRequest addField(String field) {
        if (Objects.isNull(getFields())) {
            setFields(new ArrayList<>());
        }
        getFields().add(field);
        return this;
    }

    /**
     * {@code BatchGetDocumentsRequest} builder static inner class.
     */
    public static final class Builder {
        private Integer offset;
        private Integer limit;
        private List fields;
        private String filter;

        private Builder() {
        }

        /**
         * Sets the {@code offset} and returns a reference to this Builder enabling method chaining.
         *
         * @param val the {@code offset} to set
         * @return a reference to this Builder
         */
        public Builder offset(Integer val) {
            offset = val;
            return this;
        }

        /**
         * Sets the {@code limit} and returns a reference to this Builder enabling method chaining.
         *
         * @param val the {@code limit} to set
         * @return a reference to this Builder
         */
        public Builder limit(Integer val) {
            limit = val;
            return this;
        }

        /**
         * Sets the {@code fields} and returns a reference to this Builder enabling method chaining.
         *
         * @param val the {@code fields} to set
         * @return a reference to this Builder
         */
        public Builder fields(List val) {
            fields = val;
            return this;
        }

        /**
         * Sets the {@code filter} and returns a reference to this Builder enabling method chaining.
         *
         * @param val the {@code filter} to set
         * @return a reference to this Builder
         */
        public Builder filter(String val) {
            filter = val;
            return this;
        }

        /**
         * Returns a {@code BatchGetDocumentsRequest} built from the parameters previously set.
         *
         * @return a {@code BatchGetDocumentsRequest} built with parameters of this {@code BatchGetDocumentsRequest.Builder}
         */
        public BatchGetDocumentsRequest build() {
            return new BatchGetDocumentsRequest(this);
        }
    }
}