Package io.milvus.grpc

Class DescribeCollectionRequest.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<DescribeCollectionRequest.Builder>

com.google.protobuf.GeneratedMessageV3.Builder<DescribeCollectionRequest.Builder>

io.milvus.grpc.DescribeCollectionRequest.Builder

All Implemented Interfaces:

com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, DescribeCollectionRequestOrBuilder, Cloneable

Enclosing class:

DescribeCollectionRequest

public static final class DescribeCollectionRequest.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<DescribeCollectionRequest.Builder>
implements DescribeCollectionRequestOrBuilder

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

Protobuf type milvus.proto.milvus.DescribeCollectionRequest

Method Summary

Modifier and Type	Method	Description
DescribeCollectionRequest.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
DescribeCollectionRequest	build()
DescribeCollectionRequest	buildPartial()
DescribeCollectionRequest.Builder	clear()
DescribeCollectionRequest.Builder	clearBase()	Not useful for now
DescribeCollectionRequest.Builder	clearCollectionID()	The collection ID you want to describe
DescribeCollectionRequest.Builder	clearCollectionName()	The collection name you want to describe, you can pass collection_name or collectionID
DescribeCollectionRequest.Builder	clearDbName()	string db_name = 2;
DescribeCollectionRequest.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
DescribeCollectionRequest.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
DescribeCollectionRequest.Builder	clearTimeStamp()	If time_stamp is not zero, will describe collection success when time_stamp >= created collection timestamp, otherwise will throw error.
DescribeCollectionRequest.Builder	clone()
MsgBase	getBase()	Not useful for now
MsgBase.Builder	getBaseBuilder()	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;
DescribeCollectionRequest	getDefaultInstanceForType()
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
long	getTimeStamp()	If time_stamp is not zero, will describe collection success when time_stamp >= created collection timestamp, otherwise will throw error.
boolean	hasBase()	Not useful for now
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
DescribeCollectionRequest.Builder	mergeBase(MsgBase value)	Not useful for now
DescribeCollectionRequest.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
DescribeCollectionRequest.Builder	mergeFrom(com.google.protobuf.Message other)
DescribeCollectionRequest.Builder	mergeFrom(DescribeCollectionRequest other)
final DescribeCollectionRequest.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
DescribeCollectionRequest.Builder	setBase(MsgBase value)	Not useful for now
DescribeCollectionRequest.Builder	setBase(MsgBase.Builder builderForValue)	Not useful for now
DescribeCollectionRequest.Builder	setCollectionID(long value)	The collection ID you want to describe
DescribeCollectionRequest.Builder	setCollectionName(String value)	The collection name you want to describe, you can pass collection_name or collectionID
DescribeCollectionRequest.Builder	setCollectionNameBytes(com.google.protobuf.ByteString value)	The collection name you want to describe, you can pass collection_name or collectionID
DescribeCollectionRequest.Builder	setDbName(String value)	string db_name = 2;
DescribeCollectionRequest.Builder	setDbNameBytes(com.google.protobuf.ByteString value)	string db_name = 2;
DescribeCollectionRequest.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
DescribeCollectionRequest.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
DescribeCollectionRequest.Builder	setTimeStamp(long value)	If time_stamp is not zero, will describe collection success when time_stamp >= created collection timestamp, otherwise will throw error.
final DescribeCollectionRequest.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Method Details

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.Builder<DescribeCollectionRequest.Builder>

clear

public DescribeCollectionRequest.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<DescribeCollectionRequest.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<DescribeCollectionRequest.Builder>

getDefaultInstanceForType

public DescribeCollectionRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public DescribeCollectionRequest build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public DescribeCollectionRequest buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public DescribeCollectionRequest.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<DescribeCollectionRequest.Builder>

setField

public DescribeCollectionRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
 Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<DescribeCollectionRequest.Builder>

clearField

public DescribeCollectionRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<DescribeCollectionRequest.Builder>

clearOneof

public DescribeCollectionRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<DescribeCollectionRequest.Builder>

setRepeatedField

public DescribeCollectionRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
 int index,
 Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<DescribeCollectionRequest.Builder>

addRepeatedField

public DescribeCollectionRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
 Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<DescribeCollectionRequest.Builder>

mergeFrom

public DescribeCollectionRequest.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<DescribeCollectionRequest.Builder>

mergeFrom

public DescribeCollectionRequest.Builder mergeFrom(DescribeCollectionRequest other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<DescribeCollectionRequest.Builder>

mergeFrom

public DescribeCollectionRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<DescribeCollectionRequest.Builder>

Throws:

IOException

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.

setBase

public DescribeCollectionRequest.Builder setBase(MsgBase value)

 Not useful for now
 

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

setBase

public DescribeCollectionRequest.Builder setBase(MsgBase.Builder builderForValue)

 Not useful for now
 

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

mergeBase

public DescribeCollectionRequest.Builder mergeBase(MsgBase value)

 Not useful for now
 

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

clearBase

public DescribeCollectionRequest.Builder clearBase()

 Not useful for now
 

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

getBaseBuilder

public MsgBase.Builder getBaseBuilder()

 Not useful for now
 

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

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.

setDbName

public DescribeCollectionRequest.Builder setDbName(String value)

string db_name = 2;

Parameters:

value - The dbName to set.

Returns:

This builder for chaining.

clearDbName

public DescribeCollectionRequest.Builder clearDbName()

string db_name = 2;

Returns:

This builder for chaining.

setDbNameBytes

public DescribeCollectionRequest.Builder setDbNameBytes(com.google.protobuf.ByteString value)

string db_name = 2;

Parameters:

value - The bytes for dbName to set.

Returns:

This builder for chaining.

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.

setCollectionName

public DescribeCollectionRequest.Builder setCollectionName(String value)

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

string collection_name = 3;

Parameters:

value - The collectionName to set.

Returns:

This builder for chaining.

clearCollectionName

public DescribeCollectionRequest.Builder clearCollectionName()

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

string collection_name = 3;

Returns:

This builder for chaining.

setCollectionNameBytes

public DescribeCollectionRequest.Builder setCollectionNameBytes(com.google.protobuf.ByteString value)

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

string collection_name = 3;

Parameters:

value - The bytes for collectionName to set.

Returns:

This builder for chaining.

getCollectionID

public long getCollectionID()

 The collection ID you want to describe
 

int64 collectionID = 4;

Specified by:

getCollectionID in interface DescribeCollectionRequestOrBuilder

Returns:

The collectionID.

setCollectionID

public DescribeCollectionRequest.Builder setCollectionID(long value)

 The collection ID you want to describe
 

int64 collectionID = 4;

Parameters:

value - The collectionID to set.

Returns:

This builder for chaining.

clearCollectionID

public DescribeCollectionRequest.Builder clearCollectionID()

 The collection ID you want to describe
 

int64 collectionID = 4;

Returns:

This builder for chaining.

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.

setTimeStamp

public DescribeCollectionRequest.Builder setTimeStamp(long value)

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

uint64 time_stamp = 5;

Parameters:

value - The timeStamp to set.

Returns:

This builder for chaining.

clearTimeStamp

public DescribeCollectionRequest.Builder clearTimeStamp()

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

uint64 time_stamp = 5;

Returns:

This builder for chaining.

setUnknownFields

public final DescribeCollectionRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<DescribeCollectionRequest.Builder>

mergeUnknownFields

public final DescribeCollectionRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<DescribeCollectionRequest.Builder>