Package io.milvus.grpc

Class IndexDescription

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

 Index informations
Protobuf type milvus.proto.milvus.IndexDescription
See Also:

  • Field Details

    • INDEX_NAME_FIELD_NUMBER

      public static final int INDEX_NAME_FIELD_NUMBER
      See Also:

    • INDEXID_FIELD_NUMBER

      public static final int INDEXID_FIELD_NUMBER
      See Also:

    • PARAMS_FIELD_NUMBER

      public static final int PARAMS_FIELD_NUMBER
      See Also:

    • FIELD_NAME_FIELD_NUMBER

      public static final int FIELD_NAME_FIELD_NUMBER
      See Also:

    • INDEXED_ROWS_FIELD_NUMBER

      public static final int INDEXED_ROWS_FIELD_NUMBER
      See Also:

    • TOTAL_ROWS_FIELD_NUMBER

      public static final int TOTAL_ROWS_FIELD_NUMBER
      See Also:

    • STATE_FIELD_NUMBER

      public static final int STATE_FIELD_NUMBER
      See Also:

    • INDEX_STATE_FAIL_REASON_FIELD_NUMBER

      public static final int INDEX_STATE_FAIL_REASON_FIELD_NUMBER
      See Also:

    • PENDING_INDEX_ROWS_FIELD_NUMBER

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

    • getIndexName

      public String getIndexName()
       Index name
      string index_name = 1;
      Specified by:
      getIndexName in interface IndexDescriptionOrBuilder
      Returns:
      The indexName.

    • getIndexNameBytes

      public com.google.protobuf.ByteString getIndexNameBytes()
       Index name
      string index_name = 1;
      Specified by:
      getIndexNameBytes in interface IndexDescriptionOrBuilder
      Returns:
      The bytes for indexName.

    • getIndexID

      public long getIndexID()
       Index id
      int64 indexID = 2;
      Specified by:
      getIndexID in interface IndexDescriptionOrBuilder
      Returns:
      The indexID.

    • getParamsList

      public List<KeyValuePair> getParamsList()
       Will return index_type, metric_type, params(like nlist).
      repeated .milvus.proto.common.KeyValuePair params = 3;
      Specified by:
      getParamsList in interface IndexDescriptionOrBuilder

    • getParamsOrBuilderList

      public List<? extends KeyValuePairOrBuilder> getParamsOrBuilderList()
       Will return index_type, metric_type, params(like nlist).
      repeated .milvus.proto.common.KeyValuePair params = 3;
      Specified by:
      getParamsOrBuilderList in interface IndexDescriptionOrBuilder

    • getParamsCount

      public int getParamsCount()
       Will return index_type, metric_type, params(like nlist).
      repeated .milvus.proto.common.KeyValuePair params = 3;
      Specified by:
      getParamsCount in interface IndexDescriptionOrBuilder

    • getParams

      public KeyValuePair getParams(int index)
       Will return index_type, metric_type, params(like nlist).
      repeated .milvus.proto.common.KeyValuePair params = 3;
      Specified by:
      getParams in interface IndexDescriptionOrBuilder

    • getParamsOrBuilder

      public KeyValuePairOrBuilder getParamsOrBuilder(int index)
       Will return index_type, metric_type, params(like nlist).
      repeated .milvus.proto.common.KeyValuePair params = 3;
      Specified by:
      getParamsOrBuilder in interface IndexDescriptionOrBuilder

    • getFieldName

      public String getFieldName()
       The vector field name
      string field_name = 4;
      Specified by:
      getFieldName in interface IndexDescriptionOrBuilder
      Returns:
      The fieldName.

    • getFieldNameBytes

      public com.google.protobuf.ByteString getFieldNameBytes()
       The vector field name
      string field_name = 4;
      Specified by:
      getFieldNameBytes in interface IndexDescriptionOrBuilder
      Returns:
      The bytes for fieldName.

    • getIndexedRows

      public long getIndexedRows()
       index build progress
      int64 indexed_rows = 5;
      Specified by:
      getIndexedRows in interface IndexDescriptionOrBuilder
      Returns:
      The indexedRows.

    • getTotalRows

      public long getTotalRows()
      int64 total_rows = 6;
      Specified by:
      getTotalRows in interface IndexDescriptionOrBuilder
      Returns:
      The totalRows.

    • getStateValue

      public int getStateValue()
       index state
      .milvus.proto.common.IndexState state = 7;
      Specified by:
      getStateValue in interface IndexDescriptionOrBuilder
      Returns:
      The enum numeric value on the wire for state.

    • getState

      public IndexState getState()
       index state
      .milvus.proto.common.IndexState state = 7;
      Specified by:
      getState in interface IndexDescriptionOrBuilder
      Returns:
      The state.

    • getIndexStateFailReason

      public String getIndexStateFailReason()
      string index_state_fail_reason = 8;
      Specified by:
      getIndexStateFailReason in interface IndexDescriptionOrBuilder
      Returns:
      The indexStateFailReason.

    • getIndexStateFailReasonBytes

      public com.google.protobuf.ByteString getIndexStateFailReasonBytes()
      string index_state_fail_reason = 8;
      Specified by:
      getIndexStateFailReasonBytes in interface IndexDescriptionOrBuilder
      Returns:
      The bytes for indexStateFailReason.

    • getPendingIndexRows

      public long getPendingIndexRows()
      int64 pending_index_rows = 9;
      Specified by:
      getPendingIndexRows in interface IndexDescriptionOrBuilder
      Returns:
      The pendingIndexRows.

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static IndexDescription.Builder newBuilder()

    • newBuilder

      public static IndexDescription.Builder newBuilder(IndexDescription prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static IndexDescription getDefaultInstance()

    • parser

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

    • getParserForType

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