Class 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:
    Serialized Form
    • Method Detail

      • 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
      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
        string name = 2;
        Specified by:
        getNameBytes in interface FieldSchemaOrBuilder
        Returns:
        The bytes for name.
      • 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.
      • 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.
      • 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.
      • 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​(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
      • 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