io.milvus.grpc.FieldSchemaOrBuilder 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: schema.proto

package io.milvus.grpc;

public interface FieldSchemaOrBuilder extends
    // @@protoc_insertion_point(interface_extends:milvus.proto.schema.FieldSchema)
    com.google.protobuf.MessageOrBuilder {

  /**
   * int64 fieldID = 1;
   * @return The fieldID.
   */
  long getFieldID();

  /**
   * string name = 2;
   * @return The name.
   */
  java.lang.String getName();
  /**
   * string name = 2;
   * @return The bytes for name.
   */
  com.google.protobuf.ByteString
      getNameBytes();

  /**
   * bool is_primary_key = 3;
   * @return The isPrimaryKey.
   */
  boolean getIsPrimaryKey();

  /**
   * string description = 4;
   * @return The description.
   */
  java.lang.String getDescription();
  /**
   * string description = 4;
   * @return The bytes for description.
   */
  com.google.protobuf.ByteString
      getDescriptionBytes();

  /**
   * .milvus.proto.schema.DataType data_type = 5;
   * @return The enum numeric value on the wire for dataType.
   */
  int getDataTypeValue();
  /**
   * .milvus.proto.schema.DataType data_type = 5;
   * @return The dataType.
   */
  io.milvus.grpc.DataType getDataType();

  /**
   * repeated .milvus.proto.common.KeyValuePair type_params = 6;
   */
  java.util.List 
      getTypeParamsList();
  /**
   * repeated .milvus.proto.common.KeyValuePair type_params = 6;
   */
  io.milvus.grpc.KeyValuePair getTypeParams(int index);
  /**
   * repeated .milvus.proto.common.KeyValuePair type_params = 6;
   */
  int getTypeParamsCount();
  /**
   * repeated .milvus.proto.common.KeyValuePair type_params = 6;
   */
  java.util.List 
      getTypeParamsOrBuilderList();
  /**
   * repeated .milvus.proto.common.KeyValuePair type_params = 6;
   */
  io.milvus.grpc.KeyValuePairOrBuilder getTypeParamsOrBuilder(
      int index);

  /**
   * repeated .milvus.proto.common.KeyValuePair index_params = 7;
   */
  java.util.List 
      getIndexParamsList();
  /**
   * repeated .milvus.proto.common.KeyValuePair index_params = 7;
   */
  io.milvus.grpc.KeyValuePair getIndexParams(int index);
  /**
   * repeated .milvus.proto.common.KeyValuePair index_params = 7;
   */
  int getIndexParamsCount();
  /**
   * repeated .milvus.proto.common.KeyValuePair index_params = 7;
   */
  java.util.List 
      getIndexParamsOrBuilderList();
  /**
   * repeated .milvus.proto.common.KeyValuePair index_params = 7;
   */
  io.milvus.grpc.KeyValuePairOrBuilder getIndexParamsOrBuilder(
      int index);

  /**
   * bool autoID = 8;
   * @return The autoID.
   */
  boolean getAutoID();

  /**
   *    * To keep compatible with older version, the default
   * 
   *
   * .milvus.proto.schema.FieldState state = 9;
   * @return The enum numeric value on the wire for state.
   */
  int getStateValue();
  /**
   *    * To keep compatible with older version, the default
   * 
   *
   * .milvus.proto.schema.FieldState state = 9;
   * @return The state.
   */
  io.milvus.grpc.FieldState getState();

  /**
   *    * state is `Created`.
   * 
   *
   * .milvus.proto.schema.DataType element_type = 10;
   * @return The enum numeric value on the wire for elementType.
   */
  int getElementTypeValue();
  /**
   *    * state is `Created`.
   * 
   *
   * .milvus.proto.schema.DataType element_type = 10;
   * @return The elementType.
   */
  io.milvus.grpc.DataType getElementType();

  /**
   *    * default_value only support scalars except array and json for now
   * 
   *
   * .milvus.proto.schema.ValueField default_value = 11;
   * @return Whether the defaultValue field is set.
   */
  boolean hasDefaultValue();
  /**
   *    * default_value only support scalars except array and json for now
   * 
   *
   * .milvus.proto.schema.ValueField default_value = 11;
   * @return The defaultValue.
   */
  io.milvus.grpc.ValueField getDefaultValue();
  /**
   *    * default_value only support scalars except array and json for now
   * 
   *
   * .milvus.proto.schema.ValueField default_value = 11;
   */
  io.milvus.grpc.ValueFieldOrBuilder getDefaultValueOrBuilder();

  /**
   *    * mark whether this field is the dynamic field
   * 
   *
   * bool is_dynamic = 12;
   * @return The isDynamic.
   */
  boolean getIsDynamic();

  /**
   *    * enable logic partitions
   * 
   *
   * bool is_partition_key = 13;
   * @return The isPartitionKey.
   */
  boolean getIsPartitionKey();
}