Package io.milvus.grpc

Class DescribeCollectionResponse

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

 DescribeCollection Response
Protobuf type milvus.proto.milvus.DescribeCollectionResponse
See Also:

  • Field Details

    • STATUS_FIELD_NUMBER

      public static final int STATUS_FIELD_NUMBER
      See Also:

    • SCHEMA_FIELD_NUMBER

      public static final int SCHEMA_FIELD_NUMBER
      See Also:

    • COLLECTIONID_FIELD_NUMBER

      public static final int COLLECTIONID_FIELD_NUMBER
      See Also:

    • VIRTUAL_CHANNEL_NAMES_FIELD_NUMBER

      public static final int VIRTUAL_CHANNEL_NAMES_FIELD_NUMBER
      See Also:

    • PHYSICAL_CHANNEL_NAMES_FIELD_NUMBER

      public static final int PHYSICAL_CHANNEL_NAMES_FIELD_NUMBER
      See Also:

    • CREATED_TIMESTAMP_FIELD_NUMBER

      public static final int CREATED_TIMESTAMP_FIELD_NUMBER
      See Also:

    • CREATED_UTC_TIMESTAMP_FIELD_NUMBER

      public static final int CREATED_UTC_TIMESTAMP_FIELD_NUMBER
      See Also:

    • SHARDS_NUM_FIELD_NUMBER

      public static final int SHARDS_NUM_FIELD_NUMBER
      See Also:

    • ALIASES_FIELD_NUMBER

      public static final int ALIASES_FIELD_NUMBER
      See Also:

    • START_POSITIONS_FIELD_NUMBER

      public static final int START_POSITIONS_FIELD_NUMBER
      See Also:

    • CONSISTENCY_LEVEL_FIELD_NUMBER

      public static final int CONSISTENCY_LEVEL_FIELD_NUMBER
      See Also:

    • COLLECTION_NAME_FIELD_NUMBER

      public static final int COLLECTION_NAME_FIELD_NUMBER
      See Also:

    • PROPERTIES_FIELD_NUMBER

      public static final int PROPERTIES_FIELD_NUMBER
      See Also:

    • DB_NAME_FIELD_NUMBER

      public static final int DB_NAME_FIELD_NUMBER
      See Also:

    • NUM_PARTITIONS_FIELD_NUMBER

      public static final int NUM_PARTITIONS_FIELD_NUMBER
      See Also:

    • DB_ID_FIELD_NUMBER

      public static final int DB_ID_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

    • hasStatus

      public boolean hasStatus()
       Contain error_code and reason
      .milvus.proto.common.Status status = 1;
      Specified by:
      hasStatus in interface DescribeCollectionResponseOrBuilder
      Returns:
      Whether the status field is set.

    • getStatus

      public Status getStatus()
       Contain error_code and reason
      .milvus.proto.common.Status status = 1;
      Specified by:
      getStatus in interface DescribeCollectionResponseOrBuilder
      Returns:
      The status.

    • getStatusOrBuilder

      public StatusOrBuilder getStatusOrBuilder()
       Contain error_code and reason
      .milvus.proto.common.Status status = 1;
      Specified by:
      getStatusOrBuilder in interface DescribeCollectionResponseOrBuilder

    • hasSchema

      public boolean hasSchema()
       The schema param when you created collection.
      .milvus.proto.schema.CollectionSchema schema = 2;
      Specified by:
      hasSchema in interface DescribeCollectionResponseOrBuilder
      Returns:
      Whether the schema field is set.

    • getSchema

      public CollectionSchema getSchema()
       The schema param when you created collection.
      .milvus.proto.schema.CollectionSchema schema = 2;
      Specified by:
      getSchema in interface DescribeCollectionResponseOrBuilder
      Returns:
      The schema.

    • getSchemaOrBuilder

      public CollectionSchemaOrBuilder getSchemaOrBuilder()
       The schema param when you created collection.
      .milvus.proto.schema.CollectionSchema schema = 2;
      Specified by:
      getSchemaOrBuilder in interface DescribeCollectionResponseOrBuilder

    • getCollectionID

      public long getCollectionID()
       The collection id
      int64 collectionID = 3;
      Specified by:
      getCollectionID in interface DescribeCollectionResponseOrBuilder
      Returns:
      The collectionID.

    • getVirtualChannelNamesList

      public com.google.protobuf.ProtocolStringList getVirtualChannelNamesList()
       System design related, users should not perceive
      repeated string virtual_channel_names = 4;
      Specified by:
      getVirtualChannelNamesList in interface DescribeCollectionResponseOrBuilder
      Returns:
      A list containing the virtualChannelNames.

    • getVirtualChannelNamesCount

      public int getVirtualChannelNamesCount()
       System design related, users should not perceive
      repeated string virtual_channel_names = 4;
      Specified by:
      getVirtualChannelNamesCount in interface DescribeCollectionResponseOrBuilder
      Returns:
      The count of virtualChannelNames.

    • getVirtualChannelNames

      public String getVirtualChannelNames(int index)
       System design related, users should not perceive
      repeated string virtual_channel_names = 4;
      Specified by:
      getVirtualChannelNames in interface DescribeCollectionResponseOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The virtualChannelNames at the given index.

    • getVirtualChannelNamesBytes

      public com.google.protobuf.ByteString getVirtualChannelNamesBytes(int index)
       System design related, users should not perceive
      repeated string virtual_channel_names = 4;
      Specified by:
      getVirtualChannelNamesBytes in interface DescribeCollectionResponseOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the virtualChannelNames at the given index.

    • getPhysicalChannelNamesList

      public com.google.protobuf.ProtocolStringList getPhysicalChannelNamesList()
       System design related, users should not perceive
      repeated string physical_channel_names = 5;
      Specified by:
      getPhysicalChannelNamesList in interface DescribeCollectionResponseOrBuilder
      Returns:
      A list containing the physicalChannelNames.

    • getPhysicalChannelNamesCount

      public int getPhysicalChannelNamesCount()
       System design related, users should not perceive
      repeated string physical_channel_names = 5;
      Specified by:
      getPhysicalChannelNamesCount in interface DescribeCollectionResponseOrBuilder
      Returns:
      The count of physicalChannelNames.

    • getPhysicalChannelNames

      public String getPhysicalChannelNames(int index)
       System design related, users should not perceive
      repeated string physical_channel_names = 5;
      Specified by:
      getPhysicalChannelNames in interface DescribeCollectionResponseOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The physicalChannelNames at the given index.

    • getPhysicalChannelNamesBytes

      public com.google.protobuf.ByteString getPhysicalChannelNamesBytes(int index)
       System design related, users should not perceive
      repeated string physical_channel_names = 5;
      Specified by:
      getPhysicalChannelNamesBytes in interface DescribeCollectionResponseOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the physicalChannelNames at the given index.

    • getCreatedTimestamp

      public long getCreatedTimestamp()
       Hybrid timestamp in milvus
      uint64 created_timestamp = 6;
      Specified by:
      getCreatedTimestamp in interface DescribeCollectionResponseOrBuilder
      Returns:
      The createdTimestamp.

    • getCreatedUtcTimestamp

      public long getCreatedUtcTimestamp()
       The utc timestamp calculated by created_timestamp
      uint64 created_utc_timestamp = 7;
      Specified by:
      getCreatedUtcTimestamp in interface DescribeCollectionResponseOrBuilder
      Returns:
      The createdUtcTimestamp.

    • getShardsNum

      public int getShardsNum()
       The shards number you set.
      int32 shards_num = 8;
      Specified by:
      getShardsNum in interface DescribeCollectionResponseOrBuilder
      Returns:
      The shardsNum.

    • getAliasesList

      public com.google.protobuf.ProtocolStringList getAliasesList()
       The aliases of this collection
      repeated string aliases = 9;
      Specified by:
      getAliasesList in interface DescribeCollectionResponseOrBuilder
      Returns:
      A list containing the aliases.

    • getAliasesCount

      public int getAliasesCount()
       The aliases of this collection
      repeated string aliases = 9;
      Specified by:
      getAliasesCount in interface DescribeCollectionResponseOrBuilder
      Returns:
      The count of aliases.

    • getAliases

      public String getAliases(int index)
       The aliases of this collection
      repeated string aliases = 9;
      Specified by:
      getAliases in interface DescribeCollectionResponseOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The aliases at the given index.

    • getAliasesBytes

      public com.google.protobuf.ByteString getAliasesBytes(int index)
       The aliases of this collection
      repeated string aliases = 9;
      Specified by:
      getAliasesBytes in interface DescribeCollectionResponseOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the aliases at the given index.

    • getStartPositionsList

      public List<KeyDataPair> getStartPositionsList()
       The message ID/posititon when collection is created
      repeated .milvus.proto.common.KeyDataPair start_positions = 10;
      Specified by:
      getStartPositionsList in interface DescribeCollectionResponseOrBuilder

    • getStartPositionsOrBuilderList

      public List<? extends KeyDataPairOrBuilder> getStartPositionsOrBuilderList()
       The message ID/posititon when collection is created
      repeated .milvus.proto.common.KeyDataPair start_positions = 10;
      Specified by:
      getStartPositionsOrBuilderList in interface DescribeCollectionResponseOrBuilder

    • getStartPositionsCount

      public int getStartPositionsCount()
       The message ID/posititon when collection is created
      repeated .milvus.proto.common.KeyDataPair start_positions = 10;
      Specified by:
      getStartPositionsCount in interface DescribeCollectionResponseOrBuilder

    • getStartPositions

      public KeyDataPair getStartPositions(int index)
       The message ID/posititon when collection is created
      repeated .milvus.proto.common.KeyDataPair start_positions = 10;
      Specified by:
      getStartPositions in interface DescribeCollectionResponseOrBuilder

    • getStartPositionsOrBuilder

      public KeyDataPairOrBuilder getStartPositionsOrBuilder(int index)
       The message ID/posititon when collection is created
      repeated .milvus.proto.common.KeyDataPair start_positions = 10;
      Specified by:
      getStartPositionsOrBuilder in interface DescribeCollectionResponseOrBuilder

    • getConsistencyLevelValue

      public int getConsistencyLevelValue()
       The consistency level that the collection used, modification is not supported now.
      .milvus.proto.common.ConsistencyLevel consistency_level = 11;
      Specified by:
      getConsistencyLevelValue in interface DescribeCollectionResponseOrBuilder
      Returns:
      The enum numeric value on the wire for consistencyLevel.

    • getConsistencyLevel

      public ConsistencyLevel getConsistencyLevel()
       The consistency level that the collection used, modification is not supported now.
      .milvus.proto.common.ConsistencyLevel consistency_level = 11;
      Specified by:
      getConsistencyLevel in interface DescribeCollectionResponseOrBuilder
      Returns:
      The consistencyLevel.

    • getCollectionName

      public String getCollectionName()
       The collection name
      string collection_name = 12;
      Specified by:
      getCollectionName in interface DescribeCollectionResponseOrBuilder
      Returns:
      The collectionName.

    • getCollectionNameBytes

      public com.google.protobuf.ByteString getCollectionNameBytes()
       The collection name
      string collection_name = 12;
      Specified by:
      getCollectionNameBytes in interface DescribeCollectionResponseOrBuilder
      Returns:
      The bytes for collectionName.

    • getPropertiesList

      public List<KeyValuePair> getPropertiesList()
      repeated .milvus.proto.common.KeyValuePair properties = 13;
      Specified by:
      getPropertiesList in interface DescribeCollectionResponseOrBuilder

    • getPropertiesOrBuilderList

      public List<? extends KeyValuePairOrBuilder> getPropertiesOrBuilderList()
      repeated .milvus.proto.common.KeyValuePair properties = 13;
      Specified by:
      getPropertiesOrBuilderList in interface DescribeCollectionResponseOrBuilder

    • getPropertiesCount

      public int getPropertiesCount()
      repeated .milvus.proto.common.KeyValuePair properties = 13;
      Specified by:
      getPropertiesCount in interface DescribeCollectionResponseOrBuilder

    • getProperties

      public KeyValuePair getProperties(int index)
      repeated .milvus.proto.common.KeyValuePair properties = 13;
      Specified by:
      getProperties in interface DescribeCollectionResponseOrBuilder

    • getPropertiesOrBuilder

      public KeyValuePairOrBuilder getPropertiesOrBuilder(int index)
      repeated .milvus.proto.common.KeyValuePair properties = 13;
      Specified by:
      getPropertiesOrBuilder in interface DescribeCollectionResponseOrBuilder

    • getDbName

      public String getDbName()
      string db_name = 14;
      Specified by:
      getDbName in interface DescribeCollectionResponseOrBuilder
      Returns:
      The dbName.

    • getDbNameBytes

      public com.google.protobuf.ByteString getDbNameBytes()
      string db_name = 14;
      Specified by:
      getDbNameBytes in interface DescribeCollectionResponseOrBuilder
      Returns:
      The bytes for dbName.

    • getNumPartitions

      public long getNumPartitions()
      int64 num_partitions = 15;
      Specified by:
      getNumPartitions in interface DescribeCollectionResponseOrBuilder
      Returns:
      The numPartitions.

    • getDbId

      public long getDbId()
      int64 db_id = 16;
      Specified by:
      getDbId in interface DescribeCollectionResponseOrBuilder
      Returns:
      The dbId.

    • 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 DescribeCollectionResponse parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static DescribeCollectionResponse.Builder newBuilder()

    • newBuilder

      public static DescribeCollectionResponse.Builder newBuilder(DescribeCollectionResponse prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static DescribeCollectionResponse getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<DescribeCollectionResponse> 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 DescribeCollectionResponse getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder