Package io.milvus.grpc

Class DescribeCollectionRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

io.milvus.grpc.DescribeCollectionRequest

All Implemented Interfaces:

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

public final class DescribeCollectionRequest
extends com.google.protobuf.GeneratedMessageV3
implements DescribeCollectionRequestOrBuilder

 Get collection meta datas like: schema, collectionID, shards number ...
 

Protobuf type milvus.proto.milvus.DescribeCollectionRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DescribeCollectionRequest.Builder	Get collection meta datas like: schema, collectionID, shards number ...

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	COLLECTIONID_FIELD_NUMBER
static int	DB_NAME_FIELD_NUMBER
static int	TIME_STAMP_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
long	getCollectionID()	The collection ID you want to describe
String	getCollectionName()	The collection name you want to describe, you can pass collection_name or collectionID
com.google.protobuf.ByteString	getCollectionNameBytes()	The collection name you want to describe, you can pass collection_name or collectionID
String	getDbName()	string db_name = 2;
com.google.protobuf.ByteString	getDbNameBytes()	string db_name = 2;
static DescribeCollectionRequest	getDefaultInstance()
DescribeCollectionRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Parser<DescribeCollectionRequest>	getParserForType()
int	getSerializedSize()
long	getTimeStamp()	If time_stamp is not zero, will describe collection success when time_stamp >= created collection timestamp, otherwise will throw error.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
boolean	hasBase()	Not useful for now
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static DescribeCollectionRequest.Builder	newBuilder()
static DescribeCollectionRequest.Builder	newBuilder(DescribeCollectionRequest prototype)
DescribeCollectionRequest.Builder	newBuilderForType()
protected DescribeCollectionRequest.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static DescribeCollectionRequest	parseDelimitedFrom(InputStream input)
static DescribeCollectionRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DescribeCollectionRequest	parseFrom(byte[] data)
static DescribeCollectionRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DescribeCollectionRequest	parseFrom(com.google.protobuf.ByteString data)
static DescribeCollectionRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DescribeCollectionRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static DescribeCollectionRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DescribeCollectionRequest	parseFrom(InputStream input)
static DescribeCollectionRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DescribeCollectionRequest	parseFrom(ByteBuffer data)
static DescribeCollectionRequest	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<DescribeCollectionRequest>	parser()
DescribeCollectionRequest.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

COLLECTIONID_FIELD_NUMBER

public static final int COLLECTIONID_FIELD_NUMBER

See Also:

Constant Field Values

TIME_STAMP_FIELD_NUMBER

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

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 DescribeCollectionRequestOrBuilder

Returns:

The base.

getBaseOrBuilder

public MsgBaseOrBuilder getBaseOrBuilder()

 Not useful for now
 

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

Specified by:

getBaseOrBuilder in interface DescribeCollectionRequestOrBuilder

getDbName

public String getDbName()

string db_name = 2;

Specified by:

getDbName in interface DescribeCollectionRequestOrBuilder

Returns:

The dbName.

getDbNameBytes

public com.google.protobuf.ByteString getDbNameBytes()

string db_name = 2;

Specified by:

getDbNameBytes in interface DescribeCollectionRequestOrBuilder

Returns:

The bytes for dbName.

getCollectionName

public String getCollectionName()

 The collection name you want to describe, you can pass collection_name or collectionID
 

string collection_name = 3;

Specified by:

getCollectionName in interface DescribeCollectionRequestOrBuilder

Returns:

The collectionName.

getCollectionNameBytes

public com.google.protobuf.ByteString getCollectionNameBytes()

 The collection name you want to describe, you can pass collection_name or collectionID
 

string collection_name = 3;

Specified by:

getCollectionNameBytes in interface DescribeCollectionRequestOrBuilder

Returns:

The bytes for collectionName.

getCollectionID

public long getCollectionID()

 The collection ID you want to describe
 

int64 collectionID = 4;

Specified by:

getCollectionID in interface DescribeCollectionRequestOrBuilder

Returns:

The collectionID.

getTimeStamp

public long getTimeStamp()

 If time_stamp is not zero, will describe collection success when time_stamp >= created collection timestamp, otherwise will throw error.
 

uint64 time_stamp = 5;

Specified by:

getTimeStamp in interface DescribeCollectionRequestOrBuilder

Returns:

The timeStamp.

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DescribeCollectionRequest parseFrom(InputStream input)
                                           throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static DescribeCollectionRequest parseDelimitedFrom(InputStream input)
                                                    throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public DescribeCollectionRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static DescribeCollectionRequest.Builder newBuilder()

newBuilder

public static DescribeCollectionRequest.Builder newBuilder(DescribeCollectionRequest prototype)

toBuilder

public DescribeCollectionRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static DescribeCollectionRequest getDefaultInstance()

parser

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

getParserForType

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

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder