io.milvus.param.highlevel.collection.ListCollectionsParam Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of milvus-sdk-java Show documentation

Java SDK for Milvus, a distributed high-performance vector database.

There is a newer version: 2.4.8

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.milvus.param.highlevel.collection;

import io.milvus.exception.ParamException;
import io.milvus.grpc.ShowType;
import io.milvus.param.collection.ShowCollectionsParam;
import lombok.Getter;
import lombok.ToString;

/**
 * Parameters for listCollections interface.
 */
@Getter
@ToString
public class ListCollectionsParam {
    private final ShowCollectionsParam showCollectionsParam;

    private ListCollectionsParam(ShowCollectionsParam showCollectionsParam) {
        this.showCollectionsParam = showCollectionsParam;
    }

    public static Builder newBuilder() {
        return new Builder();
    }

    /**
     * Builder for {@link ListCollectionsParam} class.
     */
    public static final class Builder {
        private Builder() {
        }

        /**
         * Verifies parameters and creates a new {@link ListCollectionsParam} instance.
         *
         * @return {@link ListCollectionsParam}
         */
        public ListCollectionsParam build() throws ParamException {
            ShowCollectionsParam showCollectionsParam = ShowCollectionsParam.newBuilder()
                    .withShowType(ShowType.All)
                    .build();
            return new ListCollectionsParam(showCollectionsParam);
        }
    }
}