io.milvus.grpc.SearchRequestOrBuilder 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
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: milvus.proto

package io.milvus.grpc;

public interface SearchRequestOrBuilder extends
    // @@protoc_insertion_point(interface_extends:milvus.proto.milvus.SearchRequest)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * must
   * 
   *
   * .milvus.proto.common.MsgBase base = 1;
   * @return Whether the base field is set.
   */
  boolean hasBase();
  /**
   *    * must
   * 
   *
   * .milvus.proto.common.MsgBase base = 1;
   * @return The base.
   */
  io.milvus.grpc.MsgBase getBase();
  /**
   *    * must
   * 
   *
   * .milvus.proto.common.MsgBase base = 1;
   */
  io.milvus.grpc.MsgBaseOrBuilder getBaseOrBuilder();

  /**
   * string db_name = 2;
   * @return The dbName.
   */
  java.lang.String getDbName();
  /**
   * string db_name = 2;
   * @return The bytes for dbName.
   */
  com.google.protobuf.ByteString
      getDbNameBytes();

  /**
   *    * must
   * 
   *
   * string collection_name = 3;
   * @return The collectionName.
   */
  java.lang.String getCollectionName();
  /**
   *    * must
   * 
   *
   * string collection_name = 3;
   * @return The bytes for collectionName.
   */
  com.google.protobuf.ByteString
      getCollectionNameBytes();

  /**
   *    * must
   * 
   *
   * repeated string partition_names = 4;
   * @return A list containing the partitionNames.
   */
  java.util.List
      getPartitionNamesList();
  /**
   *    * must
   * 
   *
   * repeated string partition_names = 4;
   * @return The count of partitionNames.
   */
  int getPartitionNamesCount();
  /**
   *    * must
   * 
   *
   * repeated string partition_names = 4;
   * @param index The index of the element to return.
   * @return The partitionNames at the given index.
   */
  java.lang.String getPartitionNames(int index);
  /**
   *    * must
   * 
   *
   * repeated string partition_names = 4;
   * @param index The index of the value to return.
   * @return The bytes of the partitionNames at the given index.
   */
  com.google.protobuf.ByteString
      getPartitionNamesBytes(int index);

  /**
   *    * must
   * 
   *
   * string dsl = 5;
   * @return The dsl.
   */
  java.lang.String getDsl();
  /**
   *    * must
   * 
   *
   * string dsl = 5;
   * @return The bytes for dsl.
   */
  com.google.protobuf.ByteString
      getDslBytes();

  /**
   *    * serialized `PlaceholderGroup`
   * 
   *
   * bytes placeholder_group = 6;
   * @return The placeholderGroup.
   */
  com.google.protobuf.ByteString getPlaceholderGroup();

  /**
   *    * must
   * 
   *
   * .milvus.proto.common.DslType dsl_type = 7;
   * @return The enum numeric value on the wire for dslType.
   */
  int getDslTypeValue();
  /**
   *    * must
   * 
   *
   * .milvus.proto.common.DslType dsl_type = 7;
   * @return The dslType.
   */
  io.milvus.grpc.DslType getDslType();

  /**
   * repeated string output_fields = 8;
   * @return A list containing the outputFields.
   */
  java.util.List
      getOutputFieldsList();
  /**
   * repeated string output_fields = 8;
   * @return The count of outputFields.
   */
  int getOutputFieldsCount();
  /**
   * repeated string output_fields = 8;
   * @param index The index of the element to return.
   * @return The outputFields at the given index.
   */
  java.lang.String getOutputFields(int index);
  /**
   * repeated string output_fields = 8;
   * @param index The index of the value to return.
   * @return The bytes of the outputFields at the given index.
   */
  com.google.protobuf.ByteString
      getOutputFieldsBytes(int index);

  /**
   *    * must
   * 
   *
   * repeated .milvus.proto.common.KeyValuePair search_params = 9;
   */
  java.util.List 
      getSearchParamsList();
  /**
   *    * must
   * 
   *
   * repeated .milvus.proto.common.KeyValuePair search_params = 9;
   */
  io.milvus.grpc.KeyValuePair getSearchParams(int index);
  /**
   *    * must
   * 
   *
   * repeated .milvus.proto.common.KeyValuePair search_params = 9;
   */
  int getSearchParamsCount();
  /**
   *    * must
   * 
   *
   * repeated .milvus.proto.common.KeyValuePair search_params = 9;
   */
  java.util.List 
      getSearchParamsOrBuilderList();
  /**
   *    * must
   * 
   *
   * repeated .milvus.proto.common.KeyValuePair search_params = 9;
   */
  io.milvus.grpc.KeyValuePairOrBuilder getSearchParamsOrBuilder(
      int index);

  /**
   * uint64 travel_timestamp = 10;
   * @return The travelTimestamp.
   */
  long getTravelTimestamp();

  /**
   *    * guarantee_timestamp
   * 
   *
   * uint64 guarantee_timestamp = 11;
   * @return The guaranteeTimestamp.
   */
  long getGuaranteeTimestamp();

  /**
   * int64 nq = 12;
   * @return The nq.
   */
  long getNq();

  /**
   * bool not_return_all_meta = 13;
   * @return The notReturnAllMeta.
   */
  boolean getNotReturnAllMeta();

  /**
   * .milvus.proto.common.ConsistencyLevel consistency_level = 14;
   * @return The enum numeric value on the wire for consistencyLevel.
   */
  int getConsistencyLevelValue();
  /**
   * .milvus.proto.common.ConsistencyLevel consistency_level = 14;
   * @return The consistencyLevel.
   */
  io.milvus.grpc.ConsistencyLevel getConsistencyLevel();

  /**
   * bool use_default_consistency = 15;
   * @return The useDefaultConsistency.
   */
  boolean getUseDefaultConsistency();

  /**
   * bool search_by_primary_keys = 16;
   * @return The searchByPrimaryKeys.
   */
  boolean getSearchByPrimaryKeys();
}