Package io.milvus.grpc

Class DescribeIndexRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

io.milvus.grpc.DescribeIndexRequest

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, DescribeIndexRequestOrBuilder, Serializable

public final class DescribeIndexRequest
extends com.google.protobuf.GeneratedMessageV3
implements DescribeIndexRequestOrBuilder

 Get created index information.
 Current release of Milvus only supports showing latest built index.
 

Protobuf type milvus.proto.milvus.DescribeIndexRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DescribeIndexRequest.Builder	Get created index information.

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

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field	Description
static int	BASE_FIELD_NUMBER
static int	COLLECTION_NAME_FIELD_NUMBER
static int	DB_NAME_FIELD_NUMBER
static int	FIELD_NAME_FIELD_NUMBER
static int	INDEX_NAME_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
MsgBase	getBase()	Not useful for now
MsgBaseOrBuilder	getBaseOrBuilder()	Not useful for now
String	getCollectionName()	The particular collection name in Milvus
com.google.protobuf.ByteString	getCollectionNameBytes()	The particular collection name in Milvus
String	getDbName()	string db_name = 2;
com.google.protobuf.ByteString	getDbNameBytes()	string db_name = 2;
static DescribeIndexRequest	getDefaultInstance()
DescribeIndexRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getFieldName()	The vector field name in this particular collection
com.google.protobuf.ByteString	getFieldNameBytes()	The vector field name in this particular collection
String	getIndexName()	No need to set up for now @2021.06.30
com.google.protobuf.ByteString	getIndexNameBytes()	No need to set up for now @2021.06.30
com.google.protobuf.Parser<DescribeIndexRequest>	getParserForType()
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
boolean	hasBase()	Not useful for now
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static DescribeIndexRequest.Builder	newBuilder()
static DescribeIndexRequest.Builder	newBuilder(DescribeIndexRequest prototype)
DescribeIndexRequest.Builder	newBuilderForType()
protected DescribeIndexRequest.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static DescribeIndexRequest	parseDelimitedFrom(InputStream input)
static DescribeIndexRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DescribeIndexRequest	parseFrom(byte[] data)
static DescribeIndexRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DescribeIndexRequest	parseFrom(com.google.protobuf.ByteString data)
static DescribeIndexRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DescribeIndexRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static DescribeIndexRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DescribeIndexRequest	parseFrom(InputStream input)
static DescribeIndexRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DescribeIndexRequest	parseFrom(ByteBuffer data)
static DescribeIndexRequest	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<DescribeIndexRequest>	parser()
DescribeIndexRequest.Builder	toBuilder()
void	writeTo(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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Field Detail

BASE_FIELD_NUMBER

public static final int BASE_FIELD_NUMBER

See Also:

Constant Field Values

DB_NAME_FIELD_NUMBER

public static final int DB_NAME_FIELD_NUMBER

See Also:

Constant Field Values

COLLECTION_NAME_FIELD_NUMBER

public static final int COLLECTION_NAME_FIELD_NUMBER

See Also:

Constant Field Values

FIELD_NAME_FIELD_NUMBER

public static final int FIELD_NAME_FIELD_NUMBER

See Also:

Constant Field Values

INDEX_NAME_FIELD_NUMBER

public static final int INDEX_NAME_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields 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

hasBase

public boolean hasBase()

 Not useful for now
 

.milvus.proto.common.MsgBase base = 1;

Specified by:

hasBase in interface DescribeIndexRequestOrBuilder

Returns:

Whether the base field is set.

getBase

public MsgBase getBase()

 Not useful for now
 

.milvus.proto.common.MsgBase base = 1;

Specified by:

getBase in interface DescribeIndexRequestOrBuilder

Returns:

The base.

getBaseOrBuilder

public MsgBaseOrBuilder getBaseOrBuilder()

 Not useful for now
 

.milvus.proto.common.MsgBase base = 1;

Specified by:

getBaseOrBuilder in interface DescribeIndexRequestOrBuilder

getDbName

public String getDbName()

string db_name = 2;

Specified by:

getDbName in interface DescribeIndexRequestOrBuilder

Returns:

The dbName.

getDbNameBytes

public com.google.protobuf.ByteString getDbNameBytes()

string db_name = 2;

Specified by:

getDbNameBytes in interface DescribeIndexRequestOrBuilder

Returns:

The bytes for dbName.

getCollectionName

public String getCollectionName()

 The particular collection name in Milvus
 

string collection_name = 3;

Specified by:

getCollectionName in interface DescribeIndexRequestOrBuilder

Returns:

The collectionName.

getCollectionNameBytes

public com.google.protobuf.ByteString getCollectionNameBytes()

 The particular collection name in Milvus
 

string collection_name = 3;

Specified by:

getCollectionNameBytes in interface DescribeIndexRequestOrBuilder

Returns:

The bytes for collectionName.

getFieldName

public String getFieldName()

 The vector field name in this particular collection
 

string field_name = 4;

Specified by:

getFieldName in interface DescribeIndexRequestOrBuilder

Returns:

The fieldName.

getFieldNameBytes

public com.google.protobuf.ByteString getFieldNameBytes()

 The vector field name in this particular collection
 

string field_name = 4;

Specified by:

getFieldNameBytes in interface DescribeIndexRequestOrBuilder

Returns:

The bytes for fieldName.

getIndexName

public String getIndexName()

 No need to set up for now @2021.06.30
 

string index_name = 5;

Specified by:

getIndexName in interface DescribeIndexRequestOrBuilder

Returns:

The indexName.

getIndexNameBytes

public com.google.protobuf.ByteString getIndexNameBytes()

 No need to set up for now @2021.06.30
 

string index_name = 5;

Specified by:

getIndexNameBytes in interface DescribeIndexRequestOrBuilder

Returns:

The bytes for indexName.

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 DescribeIndexRequest parseFrom(ByteBuffer data)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DescribeIndexRequest parseFrom(com.google.protobuf.ByteString data)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DescribeIndexRequest parseFrom(byte[] data)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DescribeIndexRequest parseFrom(InputStream input)
                                      throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static DescribeIndexRequest parseDelimitedFrom(InputStream input)
                                               throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

public static DescribeIndexRequest parseFrom(com.google.protobuf.CodedInputStream input)
                                      throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public DescribeIndexRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static DescribeIndexRequest.Builder newBuilder()

newBuilder

public static DescribeIndexRequest.Builder newBuilder(DescribeIndexRequest prototype)

toBuilder

public DescribeIndexRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected DescribeIndexRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static DescribeIndexRequest getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<DescribeIndexRequest> 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 DescribeIndexRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder