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 typemilvus.proto.schema.FieldSchema- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classFieldSchema.Builder@brief Field schema-
Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
-
-
Field Summary
Fields Modifier and Type Field Description static intAUTOID_FIELD_NUMBERstatic intDATA_TYPE_FIELD_NUMBERstatic intDEFAULT_VALUE_FIELD_NUMBERstatic intDESCRIPTION_FIELD_NUMBERstatic intELEMENT_TYPE_FIELD_NUMBERstatic intFIELDID_FIELD_NUMBERstatic intINDEX_PARAMS_FIELD_NUMBERstatic intIS_DYNAMIC_FIELD_NUMBERstatic intIS_PARTITION_KEY_FIELD_NUMBERstatic intIS_PRIMARY_KEY_FIELD_NUMBERstatic intNAME_FIELD_NUMBERstatic intSTATE_FIELD_NUMBERstatic intTYPE_PARAMS_FIELD_NUMBER
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(Object obj)booleangetAutoID()bool autoID = 8;DataTypegetDataType().milvus.proto.schema.DataType data_type = 5;intgetDataTypeValue().milvus.proto.schema.DataType data_type = 5;static FieldSchemagetDefaultInstance()FieldSchemagetDefaultInstanceForType()ValueFieldgetDefaultValue()default_value only support scalars except array and json for nowValueFieldOrBuildergetDefaultValueOrBuilder()default_value only support scalars except array and json for nowStringgetDescription()string description = 4;com.google.protobuf.ByteStringgetDescriptionBytes()string description = 4;static com.google.protobuf.Descriptors.DescriptorgetDescriptor()DataTypegetElementType()state is `Created`.intgetElementTypeValue()state is `Created`.longgetFieldID()int64 fieldID = 1;KeyValuePairgetIndexParams(int index)repeated .milvus.proto.common.KeyValuePair index_params = 7;intgetIndexParamsCount()repeated .milvus.proto.common.KeyValuePair index_params = 7;List<KeyValuePair>getIndexParamsList()repeated .milvus.proto.common.KeyValuePair index_params = 7;KeyValuePairOrBuildergetIndexParamsOrBuilder(int index)repeated .milvus.proto.common.KeyValuePair index_params = 7;List<? extends KeyValuePairOrBuilder>getIndexParamsOrBuilderList()repeated .milvus.proto.common.KeyValuePair index_params = 7;booleangetIsDynamic()mark whether this field is the dynamic fieldbooleangetIsPartitionKey()enable logic partitionsbooleangetIsPrimaryKey()bool is_primary_key = 3;StringgetName()string name = 2;com.google.protobuf.ByteStringgetNameBytes()string name = 2;com.google.protobuf.Parser<FieldSchema>getParserForType()intgetSerializedSize()FieldStategetState()To keep compatible with older version, the defaultintgetStateValue()To keep compatible with older version, the defaultKeyValuePairgetTypeParams(int index)repeated .milvus.proto.common.KeyValuePair type_params = 6;intgetTypeParamsCount()repeated .milvus.proto.common.KeyValuePair type_params = 6;List<KeyValuePair>getTypeParamsList()repeated .milvus.proto.common.KeyValuePair type_params = 6;KeyValuePairOrBuildergetTypeParamsOrBuilder(int index)repeated .milvus.proto.common.KeyValuePair type_params = 6;List<? extends KeyValuePairOrBuilder>getTypeParamsOrBuilderList()repeated .milvus.proto.common.KeyValuePair type_params = 6;com.google.protobuf.UnknownFieldSetgetUnknownFields()booleanhasDefaultValue()default_value only support scalars except array and json for nowinthashCode()protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()booleanisInitialized()static FieldSchema.BuildernewBuilder()static FieldSchema.BuildernewBuilder(FieldSchema prototype)FieldSchema.BuildernewBuilderForType()protected FieldSchema.BuildernewBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)protected ObjectnewInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)static FieldSchemaparseDelimitedFrom(InputStream input)static FieldSchemaparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static FieldSchemaparseFrom(byte[] data)static FieldSchemaparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static FieldSchemaparseFrom(com.google.protobuf.ByteString data)static FieldSchemaparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static FieldSchemaparseFrom(com.google.protobuf.CodedInputStream input)static FieldSchemaparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static FieldSchemaparseFrom(InputStream input)static FieldSchemaparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static FieldSchemaparseFrom(ByteBuffer data)static FieldSchemaparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static com.google.protobuf.Parser<FieldSchema>parser()FieldSchema.BuildertoBuilder()voidwriteTo(com.google.protobuf.CodedOutputStream output)-
Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
-
Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
Field Detail
-
FIELDID_FIELD_NUMBER
public static final int FIELDID_FIELD_NUMBER
- See Also:
- Constant Field Values
-
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
- See Also:
- Constant Field Values
-
IS_PRIMARY_KEY_FIELD_NUMBER
public static final int IS_PRIMARY_KEY_FIELD_NUMBER
- See Also:
- Constant Field Values
-
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
- See Also:
- Constant Field Values
-
DATA_TYPE_FIELD_NUMBER
public static final int DATA_TYPE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
TYPE_PARAMS_FIELD_NUMBER
public static final int TYPE_PARAMS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
INDEX_PARAMS_FIELD_NUMBER
public static final int INDEX_PARAMS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
AUTOID_FIELD_NUMBER
public static final int AUTOID_FIELD_NUMBER
- See Also:
- Constant Field Values
-
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
ELEMENT_TYPE_FIELD_NUMBER
public static final int ELEMENT_TYPE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
DEFAULT_VALUE_FIELD_NUMBER
public static final int DEFAULT_VALUE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
IS_DYNAMIC_FIELD_NUMBER
public static final int IS_DYNAMIC_FIELD_NUMBER
- See Also:
- Constant Field Values
-
IS_PARTITION_KEY_FIELD_NUMBER
public static final int IS_PARTITION_KEY_FIELD_NUMBER
- See Also:
- Constant Field Values
-
-
Method Detail
-
newInstance
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
- Overrides:
newInstancein classcom.google.protobuf.GeneratedMessageV3
-
getUnknownFields
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
- Specified by:
getUnknownFieldsin interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3
-
getFieldID
public long getFieldID()
int64 fieldID = 1;- Specified by:
getFieldIDin interfaceFieldSchemaOrBuilder- Returns:
- The fieldID.
-
getName
public String getName()
string name = 2;- Specified by:
getNamein interfaceFieldSchemaOrBuilder- Returns:
- The name.
-
getNameBytes
public com.google.protobuf.ByteString getNameBytes()
string name = 2;- Specified by:
getNameBytesin interfaceFieldSchemaOrBuilder- Returns:
- The bytes for name.
-
getIsPrimaryKey
public boolean getIsPrimaryKey()
bool is_primary_key = 3;- Specified by:
getIsPrimaryKeyin interfaceFieldSchemaOrBuilder- Returns:
- The isPrimaryKey.
-
getDescription
public String getDescription()
string description = 4;- Specified by:
getDescriptionin interfaceFieldSchemaOrBuilder- Returns:
- The description.
-
getDescriptionBytes
public com.google.protobuf.ByteString getDescriptionBytes()
string description = 4;- Specified by:
getDescriptionBytesin interfaceFieldSchemaOrBuilder- Returns:
- The bytes for description.
-
getDataTypeValue
public int getDataTypeValue()
.milvus.proto.schema.DataType data_type = 5;- Specified by:
getDataTypeValuein interfaceFieldSchemaOrBuilder- Returns:
- The enum numeric value on the wire for dataType.
-
getDataType
public DataType getDataType()
.milvus.proto.schema.DataType data_type = 5;- Specified by:
getDataTypein interfaceFieldSchemaOrBuilder- Returns:
- The dataType.
-
getTypeParamsList
public List<KeyValuePair> getTypeParamsList()
repeated .milvus.proto.common.KeyValuePair type_params = 6;- Specified by:
getTypeParamsListin interfaceFieldSchemaOrBuilder
-
getTypeParamsOrBuilderList
public List<? extends KeyValuePairOrBuilder> getTypeParamsOrBuilderList()
repeated .milvus.proto.common.KeyValuePair type_params = 6;- Specified by:
getTypeParamsOrBuilderListin interfaceFieldSchemaOrBuilder
-
getTypeParamsCount
public int getTypeParamsCount()
repeated .milvus.proto.common.KeyValuePair type_params = 6;- Specified by:
getTypeParamsCountin interfaceFieldSchemaOrBuilder
-
getTypeParams
public KeyValuePair getTypeParams(int index)
repeated .milvus.proto.common.KeyValuePair type_params = 6;- Specified by:
getTypeParamsin interfaceFieldSchemaOrBuilder
-
getTypeParamsOrBuilder
public KeyValuePairOrBuilder getTypeParamsOrBuilder(int index)
repeated .milvus.proto.common.KeyValuePair type_params = 6;- Specified by:
getTypeParamsOrBuilderin interfaceFieldSchemaOrBuilder
-
getIndexParamsList
public List<KeyValuePair> getIndexParamsList()
repeated .milvus.proto.common.KeyValuePair index_params = 7;- Specified by:
getIndexParamsListin interfaceFieldSchemaOrBuilder
-
getIndexParamsOrBuilderList
public List<? extends KeyValuePairOrBuilder> getIndexParamsOrBuilderList()
repeated .milvus.proto.common.KeyValuePair index_params = 7;- Specified by:
getIndexParamsOrBuilderListin interfaceFieldSchemaOrBuilder
-
getIndexParamsCount
public int getIndexParamsCount()
repeated .milvus.proto.common.KeyValuePair index_params = 7;- Specified by:
getIndexParamsCountin interfaceFieldSchemaOrBuilder
-
getIndexParams
public KeyValuePair getIndexParams(int index)
repeated .milvus.proto.common.KeyValuePair index_params = 7;- Specified by:
getIndexParamsin interfaceFieldSchemaOrBuilder
-
getIndexParamsOrBuilder
public KeyValuePairOrBuilder getIndexParamsOrBuilder(int index)
repeated .milvus.proto.common.KeyValuePair index_params = 7;- Specified by:
getIndexParamsOrBuilderin interfaceFieldSchemaOrBuilder
-
getAutoID
public boolean getAutoID()
bool autoID = 8;- Specified by:
getAutoIDin interfaceFieldSchemaOrBuilder- Returns:
- The autoID.
-
getStateValue
public int getStateValue()
To keep compatible with older version, the default
.milvus.proto.schema.FieldState state = 9;- Specified by:
getStateValuein interfaceFieldSchemaOrBuilder- 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:
getStatein interfaceFieldSchemaOrBuilder- Returns:
- The state.
-
getElementTypeValue
public int getElementTypeValue()
state is `Created`.
.milvus.proto.schema.DataType element_type = 10;- Specified by:
getElementTypeValuein interfaceFieldSchemaOrBuilder- 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:
getElementTypein interfaceFieldSchemaOrBuilder- 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:
hasDefaultValuein interfaceFieldSchemaOrBuilder- 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:
getDefaultValuein interfaceFieldSchemaOrBuilder- 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:
getDefaultValueOrBuilderin interfaceFieldSchemaOrBuilder
-
getIsDynamic
public boolean getIsDynamic()
mark whether this field is the dynamic field
bool is_dynamic = 12;- Specified by:
getIsDynamicin interfaceFieldSchemaOrBuilder- Returns:
- The isDynamic.
-
getIsPartitionKey
public boolean getIsPartitionKey()
enable logic partitions
bool is_partition_key = 13;- Specified by:
getIsPartitionKeyin interfaceFieldSchemaOrBuilder- Returns:
- The isPartitionKey.
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3
-
writeTo
public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessageV3- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()
- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessageV3
-
equals
public boolean equals(Object obj)
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()
- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.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:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
public static FieldSchema.Builder newBuilder()
-
newBuilder
public static FieldSchema.Builder newBuilder(FieldSchema prototype)
-
toBuilder
public FieldSchema.Builder toBuilder()
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected FieldSchema.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
- Specified by:
newBuilderForTypein classcom.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:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
public FieldSchema getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
-