Package io.milvus.grpc
Interface DescribeCollectionResponseOrBuilder
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
DescribeCollectionResponse,DescribeCollectionResponse.Builder
public interface DescribeCollectionResponseOrBuilder
extends com.google.protobuf.MessageOrBuilder
-
Method Summary
Modifier and TypeMethodDescriptiongetAliases(int index) The aliases of this collectioncom.google.protobuf.ByteStringgetAliasesBytes(int index) The aliases of this collectionintThe aliases of this collectionThe aliases of this collectionlongThe collection idThe collection namecom.google.protobuf.ByteStringThe collection nameThe consistency level that the collection used, modification is not supported now.intThe consistency level that the collection used, modification is not supported now.longHybrid timestamp in milvuslongThe utc timestamp calculated by created_timestamplonggetDbId()int64 db_id = 16;string db_name = 14;com.google.protobuf.ByteStringstring db_name = 14;longint64 num_partitions = 15;getPhysicalChannelNames(int index) System design related, users should not perceivecom.google.protobuf.ByteStringgetPhysicalChannelNamesBytes(int index) System design related, users should not perceiveintSystem design related, users should not perceiveSystem design related, users should not perceivegetProperties(int index) repeated .milvus.proto.common.KeyValuePair properties = 13;intrepeated .milvus.proto.common.KeyValuePair properties = 13;repeated .milvus.proto.common.KeyValuePair properties = 13;getPropertiesOrBuilder(int index) repeated .milvus.proto.common.KeyValuePair properties = 13;List<? extends KeyValuePairOrBuilder> repeated .milvus.proto.common.KeyValuePair properties = 13;longuint64 request_time = 17;The schema param when you created collection.The schema param when you created collection.intThe shards number you set.getStartPositions(int index) The message ID/posititon when collection is createdintThe message ID/posititon when collection is createdThe message ID/posititon when collection is createdgetStartPositionsOrBuilder(int index) The message ID/posititon when collection is createdList<? extends KeyDataPairOrBuilder> The message ID/posititon when collection is createdContain error_code and reasonContain error_code and reasonlonguint64 update_timestamp = 18;getVirtualChannelNames(int index) System design related, users should not perceivecom.google.protobuf.ByteStringgetVirtualChannelNamesBytes(int index) System design related, users should not perceiveintSystem design related, users should not perceiveSystem design related, users should not perceivebooleanThe schema param when you created collection.booleanContain error_code and reasonMethods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitializedMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
hasStatus
boolean hasStatus()Contain error_code and reason
.milvus.proto.common.Status status = 1;- Returns:
- Whether the status field is set.
-
getStatus
Status getStatus()Contain error_code and reason
.milvus.proto.common.Status status = 1;- Returns:
- The status.
-
getStatusOrBuilder
StatusOrBuilder getStatusOrBuilder()Contain error_code and reason
.milvus.proto.common.Status status = 1; -
hasSchema
boolean hasSchema()The schema param when you created collection.
.milvus.proto.schema.CollectionSchema schema = 2;- Returns:
- Whether the schema field is set.
-
getSchema
CollectionSchema getSchema()The schema param when you created collection.
.milvus.proto.schema.CollectionSchema schema = 2;- Returns:
- The schema.
-
getSchemaOrBuilder
CollectionSchemaOrBuilder getSchemaOrBuilder()The schema param when you created collection.
.milvus.proto.schema.CollectionSchema schema = 2; -
getCollectionID
long getCollectionID()The collection id
int64 collectionID = 3;- Returns:
- The collectionID.
-
getVirtualChannelNamesList
System design related, users should not perceive
repeated string virtual_channel_names = 4;- Returns:
- A list containing the virtualChannelNames.
-
getVirtualChannelNamesCount
int getVirtualChannelNamesCount()System design related, users should not perceive
repeated string virtual_channel_names = 4;- Returns:
- The count of virtualChannelNames.
-
getVirtualChannelNames
System design related, users should not perceive
repeated string virtual_channel_names = 4;- Parameters:
index- The index of the element to return.- Returns:
- The virtualChannelNames at the given index.
-
getVirtualChannelNamesBytes
com.google.protobuf.ByteString getVirtualChannelNamesBytes(int index) System design related, users should not perceive
repeated string virtual_channel_names = 4;- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the virtualChannelNames at the given index.
-
getPhysicalChannelNamesList
System design related, users should not perceive
repeated string physical_channel_names = 5;- Returns:
- A list containing the physicalChannelNames.
-
getPhysicalChannelNamesCount
int getPhysicalChannelNamesCount()System design related, users should not perceive
repeated string physical_channel_names = 5;- Returns:
- The count of physicalChannelNames.
-
getPhysicalChannelNames
System design related, users should not perceive
repeated string physical_channel_names = 5;- Parameters:
index- The index of the element to return.- Returns:
- The physicalChannelNames at the given index.
-
getPhysicalChannelNamesBytes
com.google.protobuf.ByteString getPhysicalChannelNamesBytes(int index) System design related, users should not perceive
repeated string physical_channel_names = 5;- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the physicalChannelNames at the given index.
-
getCreatedTimestamp
long getCreatedTimestamp()Hybrid timestamp in milvus
uint64 created_timestamp = 6;- Returns:
- The createdTimestamp.
-
getCreatedUtcTimestamp
long getCreatedUtcTimestamp()The utc timestamp calculated by created_timestamp
uint64 created_utc_timestamp = 7;- Returns:
- The createdUtcTimestamp.
-
getShardsNum
int getShardsNum()The shards number you set.
int32 shards_num = 8;- Returns:
- The shardsNum.
-
getAliasesList
The aliases of this collection
repeated string aliases = 9;- Returns:
- A list containing the aliases.
-
getAliasesCount
int getAliasesCount()The aliases of this collection
repeated string aliases = 9;- Returns:
- The count of aliases.
-
getAliases
The aliases of this collection
repeated string aliases = 9;- Parameters:
index- The index of the element to return.- Returns:
- The aliases at the given index.
-
getAliasesBytes
com.google.protobuf.ByteString getAliasesBytes(int index) The aliases of this collection
repeated string aliases = 9;- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the aliases at the given index.
-
getStartPositionsList
List<KeyDataPair> getStartPositionsList()The message ID/posititon when collection is created
repeated .milvus.proto.common.KeyDataPair start_positions = 10; -
getStartPositions
The message ID/posititon when collection is created
repeated .milvus.proto.common.KeyDataPair start_positions = 10; -
getStartPositionsCount
int getStartPositionsCount()The message ID/posititon when collection is created
repeated .milvus.proto.common.KeyDataPair start_positions = 10; -
getStartPositionsOrBuilderList
List<? extends KeyDataPairOrBuilder> getStartPositionsOrBuilderList()The message ID/posititon when collection is created
repeated .milvus.proto.common.KeyDataPair start_positions = 10; -
getStartPositionsOrBuilder
The message ID/posititon when collection is created
repeated .milvus.proto.common.KeyDataPair start_positions = 10; -
getConsistencyLevelValue
int getConsistencyLevelValue()The consistency level that the collection used, modification is not supported now.
.milvus.proto.common.ConsistencyLevel consistency_level = 11;- Returns:
- The enum numeric value on the wire for consistencyLevel.
-
getConsistencyLevel
ConsistencyLevel getConsistencyLevel()The consistency level that the collection used, modification is not supported now.
.milvus.proto.common.ConsistencyLevel consistency_level = 11;- Returns:
- The consistencyLevel.
-
getCollectionName
String getCollectionName()The collection name
string collection_name = 12;- Returns:
- The collectionName.
-
getCollectionNameBytes
com.google.protobuf.ByteString getCollectionNameBytes()The collection name
string collection_name = 12;- Returns:
- The bytes for collectionName.
-
getPropertiesList
List<KeyValuePair> getPropertiesList()repeated .milvus.proto.common.KeyValuePair properties = 13; -
getProperties
repeated .milvus.proto.common.KeyValuePair properties = 13; -
getPropertiesCount
int getPropertiesCount()repeated .milvus.proto.common.KeyValuePair properties = 13; -
getPropertiesOrBuilderList
List<? extends KeyValuePairOrBuilder> getPropertiesOrBuilderList()repeated .milvus.proto.common.KeyValuePair properties = 13; -
getPropertiesOrBuilder
repeated .milvus.proto.common.KeyValuePair properties = 13; -
getDbName
String getDbName()string db_name = 14;- Returns:
- The dbName.
-
getDbNameBytes
com.google.protobuf.ByteString getDbNameBytes()string db_name = 14;- Returns:
- The bytes for dbName.
-
getNumPartitions
long getNumPartitions()int64 num_partitions = 15;- Returns:
- The numPartitions.
-
getDbId
long getDbId()int64 db_id = 16;- Returns:
- The dbId.
-
getRequestTime
long getRequestTime()uint64 request_time = 17;- Returns:
- The requestTime.
-
getUpdateTimestamp
long getUpdateTimestamp()uint64 update_timestamp = 18;- Returns:
- The updateTimestamp.
-