Package io.milvus.grpc

Class DumpMessagesRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

io.milvus.grpc.DumpMessagesRequest

All Implemented Interfaces:

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

public final class DumpMessagesRequest
extends com.google.protobuf.GeneratedMessageV3
implements DumpMessagesRequestOrBuilder

 DumpMessagesRequest is used to dump messages from a WAL range for data salvage.

 Usage: After force failover, use GetReplicateInfo to get the salvage_checkpoint,
 then call DumpMessages with the checkpoint's message_id and timetick to retrieve
 unsynchronized messages from the old primary cluster.
 

Protobuf type milvus.proto.milvus.DumpMessagesRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DumpMessagesRequest.Builder	DumpMessagesRequest is used to dump messages from a WAL range for data salvage.

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

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, 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	END_TIMETICK_FIELD_NUMBER
static int	INCLUDE_START_MESSAGE_FIELD_NUMBER
static int	PCHANNEL_FIELD_NUMBER
static int	START_MESSAGE_ID_FIELD_NUMBER
static int	START_TIMETICK_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)
static DumpMessagesRequest	getDefaultInstance()
DumpMessagesRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
long	getEndTimetick()	End timetick filter (optional) - only dump messages with timetick <= end_timetick, 0 means no limit (stream until cancelled)
boolean	getIncludeStartMessage()	If true, dump starts from start_message_id inclusively; otherwise starts after it.
com.google.protobuf.Parser<DumpMessagesRequest>	getParserForType()
String	getPchannel()	Physical channel name to dump from (required)
com.google.protobuf.ByteString	getPchannelBytes()	Physical channel name to dump from (required)
int	getSerializedSize()
MessageID	getStartMessageId()	Start position in WAL (required) - typically from salvage_checkpoint.message_id
MessageIDOrBuilder	getStartMessageIdOrBuilder()	Start position in WAL (required) - typically from salvage_checkpoint.message_id
long	getStartTimetick()	Start timetick filter (optional) - only dump messages with timetick >= start_timetick, typically from salvage_checkpoint.time_tick
int	hashCode()
boolean	hasStartMessageId()	Start position in WAL (required) - typically from salvage_checkpoint.message_id
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static DumpMessagesRequest.Builder	newBuilder()
static DumpMessagesRequest.Builder	newBuilder(DumpMessagesRequest prototype)
DumpMessagesRequest.Builder	newBuilderForType()
protected DumpMessagesRequest.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static DumpMessagesRequest	parseDelimitedFrom(InputStream input)
static DumpMessagesRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DumpMessagesRequest	parseFrom(byte[] data)
static DumpMessagesRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DumpMessagesRequest	parseFrom(com.google.protobuf.ByteString data)
static DumpMessagesRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DumpMessagesRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static DumpMessagesRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DumpMessagesRequest	parseFrom(InputStream input)
static DumpMessagesRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DumpMessagesRequest	parseFrom(ByteBuffer data)
static DumpMessagesRequest	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<DumpMessagesRequest>	parser()
DumpMessagesRequest.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, 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, getUnknownFields, hasField, hasOneof

Field Detail

PCHANNEL_FIELD_NUMBER

public static final int PCHANNEL_FIELD_NUMBER

See Also:

Constant Field Values

START_MESSAGE_ID_FIELD_NUMBER

public static final int START_MESSAGE_ID_FIELD_NUMBER

See Also:

Constant Field Values

START_TIMETICK_FIELD_NUMBER

public static final int START_TIMETICK_FIELD_NUMBER

See Also:

Constant Field Values

END_TIMETICK_FIELD_NUMBER

public static final int END_TIMETICK_FIELD_NUMBER

See Also:

Constant Field Values

INCLUDE_START_MESSAGE_FIELD_NUMBER

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

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

getPchannel

public String getPchannel()

 Physical channel name to dump from (required)
 

string pchannel = 1;

Specified by:

getPchannel in interface DumpMessagesRequestOrBuilder

Returns:

The pchannel.

getPchannelBytes

public com.google.protobuf.ByteString getPchannelBytes()

 Physical channel name to dump from (required)
 

string pchannel = 1;

Specified by:

getPchannelBytes in interface DumpMessagesRequestOrBuilder

Returns:

The bytes for pchannel.

hasStartMessageId

public boolean hasStartMessageId()

 Start position in WAL (required) - typically from salvage_checkpoint.message_id
 

.milvus.proto.common.MessageID start_message_id = 2;

Specified by:

hasStartMessageId in interface DumpMessagesRequestOrBuilder

Returns:

Whether the startMessageId field is set.

getStartMessageId

public MessageID getStartMessageId()

 Start position in WAL (required) - typically from salvage_checkpoint.message_id
 

.milvus.proto.common.MessageID start_message_id = 2;

Specified by:

getStartMessageId in interface DumpMessagesRequestOrBuilder

Returns:

The startMessageId.

getStartMessageIdOrBuilder

public MessageIDOrBuilder getStartMessageIdOrBuilder()

 Start position in WAL (required) - typically from salvage_checkpoint.message_id
 

.milvus.proto.common.MessageID start_message_id = 2;

Specified by:

getStartMessageIdOrBuilder in interface DumpMessagesRequestOrBuilder

getStartTimetick

public long getStartTimetick()

 Start timetick filter (optional) - only dump messages with timetick >= start_timetick, typically from salvage_checkpoint.time_tick
 

uint64 start_timetick = 3;

Specified by:

getStartTimetick in interface DumpMessagesRequestOrBuilder

Returns:

The startTimetick.

getEndTimetick

public long getEndTimetick()

 End timetick filter (optional) - only dump messages with timetick <= end_timetick, 0 means no limit (stream until cancelled)
 

uint64 end_timetick = 4;

Specified by:

getEndTimetick in interface DumpMessagesRequestOrBuilder

Returns:

The endTimetick.

getIncludeStartMessage

public boolean getIncludeStartMessage()

 If true, dump starts from start_message_id inclusively; otherwise starts after it.
 

bool include_start_message = 5;

Specified by:

getIncludeStartMessage in interface DumpMessagesRequestOrBuilder

Returns:

The includeStartMessage.

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DumpMessagesRequest parseFrom(InputStream input)
                                     throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static DumpMessagesRequest parseDelimitedFrom(InputStream input)
                                              throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public DumpMessagesRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static DumpMessagesRequest.Builder newBuilder()

newBuilder

public static DumpMessagesRequest.Builder newBuilder(DumpMessagesRequest prototype)

toBuilder

public DumpMessagesRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static DumpMessagesRequest getDefaultInstance()

parser

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

getParserForType

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

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder