Package io.milvus.grpc

Class FieldSchema

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.milvus.grpc.FieldSchema
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, FieldSchemaOrBuilder, Serializable
public final class FieldSchema extends com.google.protobuf.GeneratedMessageV3 implements FieldSchemaOrBuilder

 @brief Field schema
Protobuf type milvus.proto.schema.FieldSchema
See Also:

  • Field Details

    • FIELDID_FIELD_NUMBER

      public static final int FIELDID_FIELD_NUMBER
      See Also:

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • IS_PRIMARY_KEY_FIELD_NUMBER

      public static final int IS_PRIMARY_KEY_FIELD_NUMBER
      See Also:

    • DESCRIPTION_FIELD_NUMBER

      public static final int DESCRIPTION_FIELD_NUMBER
      See Also:

    • DATA_TYPE_FIELD_NUMBER

      public static final int DATA_TYPE_FIELD_NUMBER
      See Also:

    • TYPE_PARAMS_FIELD_NUMBER

      public static final int TYPE_PARAMS_FIELD_NUMBER
      See Also:

    • INDEX_PARAMS_FIELD_NUMBER

      public static final int INDEX_PARAMS_FIELD_NUMBER
      See Also:

    • AUTOID_FIELD_NUMBER

      public static final int AUTOID_FIELD_NUMBER
      See Also:

    • STATE_FIELD_NUMBER

      public static final int STATE_FIELD_NUMBER
      See Also:

    • ELEMENT_TYPE_FIELD_NUMBER

      public static final int ELEMENT_TYPE_FIELD_NUMBER
      See Also:

    • DEFAULT_VALUE_FIELD_NUMBER

      public static final int DEFAULT_VALUE_FIELD_NUMBER
      See Also:

    • IS_DYNAMIC_FIELD_NUMBER

      public static final int IS_DYNAMIC_FIELD_NUMBER
      See Also:

    • IS_PARTITION_KEY_FIELD_NUMBER

      public static final int IS_PARTITION_KEY_FIELD_NUMBER
      See Also:

    • IS_CLUSTERING_KEY_FIELD_NUMBER

      public static final int IS_CLUSTERING_KEY_FIELD_NUMBER
      See Also:

    • NULLABLE_FIELD_NUMBER

      public static final int NULLABLE_FIELD_NUMBER
      See Also:

    • IS_FUNCTION_OUTPUT_FIELD_NUMBER

      public static final int IS_FUNCTION_OUTPUT_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • getFieldID

      public long getFieldID()
      int64 fieldID = 1;
      Specified by:
      getFieldID in interface FieldSchemaOrBuilder
      Returns:
      The fieldID.

    • getName

      public String getName()
      string name = 2;
      Specified by:
      getName in interface FieldSchemaOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
      string name = 2;
      Specified by:
      getNameBytes in interface FieldSchemaOrBuilder
      Returns:
      The bytes for name.

    • getIsPrimaryKey

      public boolean getIsPrimaryKey()
      bool is_primary_key = 3;
      Specified by:
      getIsPrimaryKey in interface FieldSchemaOrBuilder
      Returns:
      The isPrimaryKey.

    • getDescription

      public String getDescription()
      string description = 4;
      Specified by:
      getDescription in interface FieldSchemaOrBuilder
      Returns:
      The description.

    • getDescriptionBytes

      public com.google.protobuf.ByteString getDescriptionBytes()
      string description = 4;
      Specified by:
      getDescriptionBytes in interface FieldSchemaOrBuilder
      Returns:
      The bytes for description.

    • getDataTypeValue

      public int getDataTypeValue()
      .milvus.proto.schema.DataType data_type = 5;
      Specified by:
      getDataTypeValue in interface FieldSchemaOrBuilder
      Returns:
      The enum numeric value on the wire for dataType.

    • getDataType

      public DataType getDataType()
      .milvus.proto.schema.DataType data_type = 5;
      Specified by:
      getDataType in interface FieldSchemaOrBuilder
      Returns:
      The dataType.

    • getTypeParamsList

      public List<KeyValuePair> getTypeParamsList()
      repeated .milvus.proto.common.KeyValuePair type_params = 6;
      Specified by:
      getTypeParamsList in interface FieldSchemaOrBuilder

    • getTypeParamsOrBuilderList

      public List<? extends KeyValuePairOrBuilder> getTypeParamsOrBuilderList()
      repeated .milvus.proto.common.KeyValuePair type_params = 6;
      Specified by:
      getTypeParamsOrBuilderList in interface FieldSchemaOrBuilder

    • getTypeParamsCount

      public int getTypeParamsCount()
      repeated .milvus.proto.common.KeyValuePair type_params = 6;
      Specified by:
      getTypeParamsCount in interface FieldSchemaOrBuilder

    • getTypeParams

      public KeyValuePair getTypeParams(int index)
      repeated .milvus.proto.common.KeyValuePair type_params = 6;
      Specified by:
      getTypeParams in interface FieldSchemaOrBuilder

    • getTypeParamsOrBuilder

      public KeyValuePairOrBuilder getTypeParamsOrBuilder(int index)
      repeated .milvus.proto.common.KeyValuePair type_params = 6;
      Specified by:
      getTypeParamsOrBuilder in interface FieldSchemaOrBuilder

    • getIndexParamsList

      public List<KeyValuePair> getIndexParamsList()
      repeated .milvus.proto.common.KeyValuePair index_params = 7;
      Specified by:
      getIndexParamsList in interface FieldSchemaOrBuilder

    • getIndexParamsOrBuilderList

      public List<? extends KeyValuePairOrBuilder> getIndexParamsOrBuilderList()
      repeated .milvus.proto.common.KeyValuePair index_params = 7;
      Specified by:
      getIndexParamsOrBuilderList in interface FieldSchemaOrBuilder

    • getIndexParamsCount

      public int getIndexParamsCount()
      repeated .milvus.proto.common.KeyValuePair index_params = 7;
      Specified by:
      getIndexParamsCount in interface FieldSchemaOrBuilder

    • getIndexParams

      public KeyValuePair getIndexParams(int index)
      repeated .milvus.proto.common.KeyValuePair index_params = 7;
      Specified by:
      getIndexParams in interface FieldSchemaOrBuilder

    • getIndexParamsOrBuilder

      public KeyValuePairOrBuilder getIndexParamsOrBuilder(int index)
      repeated .milvus.proto.common.KeyValuePair index_params = 7;
      Specified by:
      getIndexParamsOrBuilder in interface FieldSchemaOrBuilder

    • getAutoID

      public boolean getAutoID()
      bool autoID = 8;
      Specified by:
      getAutoID in interface FieldSchemaOrBuilder
      Returns:
      The autoID.

    • getStateValue

      public int getStateValue()
       To keep compatible with older version, the default
      .milvus.proto.schema.FieldState state = 9;
      Specified by:
      getStateValue in interface FieldSchemaOrBuilder
      Returns:
      The enum numeric value on the wire for state.

    • getState

      public FieldState getState()
       To keep compatible with older version, the default
      .milvus.proto.schema.FieldState state = 9;
      Specified by:
      getState in interface FieldSchemaOrBuilder
      Returns:
      The state.

    • getElementTypeValue

      public int getElementTypeValue()
       state is `Created`.
      .milvus.proto.schema.DataType element_type = 10;
      Specified by:
      getElementTypeValue in interface FieldSchemaOrBuilder
      Returns:
      The enum numeric value on the wire for elementType.

    • getElementType

      public DataType getElementType()
       state is `Created`.
      .milvus.proto.schema.DataType element_type = 10;
      Specified by:
      getElementType in interface FieldSchemaOrBuilder
      Returns:
      The elementType.

    • hasDefaultValue

      public boolean hasDefaultValue()
       default_value only support scalars except array and json for now
      .milvus.proto.schema.ValueField default_value = 11;
      Specified by:
      hasDefaultValue in interface FieldSchemaOrBuilder
      Returns:
      Whether the defaultValue field is set.

    • getDefaultValue

      public ValueField getDefaultValue()
       default_value only support scalars except array and json for now
      .milvus.proto.schema.ValueField default_value = 11;
      Specified by:
      getDefaultValue in interface FieldSchemaOrBuilder
      Returns:
      The defaultValue.

    • getDefaultValueOrBuilder

      public ValueFieldOrBuilder getDefaultValueOrBuilder()
       default_value only support scalars except array and json for now
      .milvus.proto.schema.ValueField default_value = 11;
      Specified by:
      getDefaultValueOrBuilder in interface FieldSchemaOrBuilder

    • getIsDynamic

      public boolean getIsDynamic()
       mark whether this field is the dynamic field
      bool is_dynamic = 12;
      Specified by:
      getIsDynamic in interface FieldSchemaOrBuilder
      Returns:
      The isDynamic.

    • getIsPartitionKey

      public boolean getIsPartitionKey()
       enable logic partitions
      bool is_partition_key = 13;
      Specified by:
      getIsPartitionKey in interface FieldSchemaOrBuilder
      Returns:
      The isPartitionKey.

    • getIsClusteringKey

      public boolean getIsClusteringKey()
      bool is_clustering_key = 14;
      Specified by:
      getIsClusteringKey in interface FieldSchemaOrBuilder
      Returns:
      The isClusteringKey.

    • getNullable

      public boolean getNullable()
       enable set null as field value
      bool nullable = 15;
      Specified by:
      getNullable in interface FieldSchemaOrBuilder
      Returns:
      The nullable.

    • getIsFunctionOutput

      public boolean getIsFunctionOutput()
      bool is_function_output = 16;
      Specified by:
      getIsFunctionOutput in interface FieldSchemaOrBuilder
      Returns:
      The isFunctionOutput.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static FieldSchema parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static FieldSchema parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static FieldSchema parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static FieldSchema parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static FieldSchema parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static FieldSchema parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static FieldSchema parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static FieldSchema parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static FieldSchema parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static FieldSchema parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static FieldSchema parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static FieldSchema parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public FieldSchema.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static FieldSchema.Builder newBuilder()

    • newBuilder

      public static FieldSchema.Builder newBuilder(FieldSchema prototype)

    • toBuilder

      public FieldSchema.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected FieldSchema.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static FieldSchema getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<FieldSchema> parser()

    • getParserForType

      public com.google.protobuf.Parser<FieldSchema> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public FieldSchema getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder