io.milvus.param.collection.DescribeDatabaseParam 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.collection;

 import io.milvus.exception.ParamException;
 import io.milvus.param.ParamUtils;
 
 import lombok.Getter;
 import lombok.NonNull;
 import lombok.ToString;
 
 /**
  * Parameters for describeDatabase interface.
  */
 @Getter
 @ToString
 public class DescribeDatabaseParam {
     private final String databaseName;
 
     private DescribeDatabaseParam(@NonNull Builder builder) {
         this.databaseName = builder.databaseName;
     }
 
     public static Builder newBuilder() {
         return new Builder();
     }
 
     /**
      * Builder for {@link DescribeDatabaseParam} class.
      */
     public static final class Builder {
         private String databaseName;
 
         private Builder() {
         }
 
         /**
          * Sets the database name. database name can be nil.
          *
          * @param databaseName database name
          * @return Builder
          */
         public Builder withDatabaseName(String databaseName) {
             this.databaseName = databaseName;
             return this;
         }
 
         /**
          * Verifies parameters and creates a new {@link DescribeDatabaseParam} instance.
          *
          * @return {@link DescribeDatabaseParam}
          */
         public DescribeDatabaseParam build() throws ParamException {
            ParamUtils.CheckNullEmptyString(databaseName, "Database name");
 
             return new DescribeDatabaseParam(this);
         }
     }
 
 }