Class DumpMessagesRequest.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, DumpMessagesRequestOrBuilder, Cloneable
    Enclosing class:
    DumpMessagesRequest

    public static final class DumpMessagesRequest.Builder
    extends com.google.protobuf.GeneratedMessageV3.Builder<DumpMessagesRequest.Builder>
    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
    • Method Detail

      • 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<DumpMessagesRequest.Builder>
      • clear

        public DumpMessagesRequest.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<DumpMessagesRequest.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<DumpMessagesRequest.Builder>
      • getDefaultInstanceForType

        public DumpMessagesRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
      • build

        public DumpMessagesRequest build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder
      • buildPartial

        public DumpMessagesRequest buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder
      • clone

        public DumpMessagesRequest.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<DumpMessagesRequest.Builder>
      • setField

        public DumpMessagesRequest.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<DumpMessagesRequest.Builder>
      • clearField

        public DumpMessagesRequest.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<DumpMessagesRequest.Builder>
      • clearOneof

        public DumpMessagesRequest.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<DumpMessagesRequest.Builder>
      • setRepeatedField

        public DumpMessagesRequest.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<DumpMessagesRequest.Builder>
      • addRepeatedField

        public DumpMessagesRequest.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<DumpMessagesRequest.Builder>
      • mergeFrom

        public DumpMessagesRequest.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<DumpMessagesRequest.Builder>
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<DumpMessagesRequest.Builder>
      • mergeFrom

        public DumpMessagesRequest.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<DumpMessagesRequest.Builder>
        Throws:
        IOException
      • 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.
      • setPchannel

        public DumpMessagesRequest.Builder setPchannel​(String value)
         Physical channel name to dump from (required)
         
        string pchannel = 1;
        Parameters:
        value - The pchannel to set.
        Returns:
        This builder for chaining.
      • clearPchannel

        public DumpMessagesRequest.Builder clearPchannel()
         Physical channel name to dump from (required)
         
        string pchannel = 1;
        Returns:
        This builder for chaining.
      • setPchannelBytes

        public DumpMessagesRequest.Builder setPchannelBytes​(com.google.protobuf.ByteString value)
         Physical channel name to dump from (required)
         
        string pchannel = 1;
        Parameters:
        value - The bytes for pchannel to set.
        Returns:
        This builder for chaining.
      • 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.
      • setStartMessageId

        public DumpMessagesRequest.Builder setStartMessageId​(MessageID value)
         Start position in WAL (required) - typically from salvage_checkpoint.message_id
         
        .milvus.proto.common.MessageID start_message_id = 2;
      • setStartMessageId

        public DumpMessagesRequest.Builder setStartMessageId​(MessageID.Builder builderForValue)
         Start position in WAL (required) - typically from salvage_checkpoint.message_id
         
        .milvus.proto.common.MessageID start_message_id = 2;
      • mergeStartMessageId

        public DumpMessagesRequest.Builder mergeStartMessageId​(MessageID value)
         Start position in WAL (required) - typically from salvage_checkpoint.message_id
         
        .milvus.proto.common.MessageID start_message_id = 2;
      • clearStartMessageId

        public DumpMessagesRequest.Builder clearStartMessageId()
         Start position in WAL (required) - typically from salvage_checkpoint.message_id
         
        .milvus.proto.common.MessageID start_message_id = 2;
      • getStartMessageIdBuilder

        public MessageID.Builder getStartMessageIdBuilder()
         Start position in WAL (required) - typically from salvage_checkpoint.message_id
         
        .milvus.proto.common.MessageID start_message_id = 2;
      • 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.
      • setStartTimetick

        public DumpMessagesRequest.Builder setStartTimetick​(long value)
         Start timetick filter (optional) - only dump messages with timetick >= start_timetick, typically from salvage_checkpoint.time_tick
         
        uint64 start_timetick = 3;
        Parameters:
        value - The startTimetick to set.
        Returns:
        This builder for chaining.
      • clearStartTimetick

        public DumpMessagesRequest.Builder clearStartTimetick()
         Start timetick filter (optional) - only dump messages with timetick >= start_timetick, typically from salvage_checkpoint.time_tick
         
        uint64 start_timetick = 3;
        Returns:
        This builder for chaining.
      • 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.
      • setEndTimetick

        public DumpMessagesRequest.Builder setEndTimetick​(long value)
         End timetick filter (optional) - only dump messages with timetick <= end_timetick, 0 means no limit (stream until cancelled)
         
        uint64 end_timetick = 4;
        Parameters:
        value - The endTimetick to set.
        Returns:
        This builder for chaining.
      • clearEndTimetick

        public DumpMessagesRequest.Builder clearEndTimetick()
         End timetick filter (optional) - only dump messages with timetick <= end_timetick, 0 means no limit (stream until cancelled)
         
        uint64 end_timetick = 4;
        Returns:
        This builder for chaining.
      • 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.
      • setIncludeStartMessage

        public DumpMessagesRequest.Builder setIncludeStartMessage​(boolean value)
         If true, dump starts from start_message_id inclusively; otherwise starts after it.
         
        bool include_start_message = 5;
        Parameters:
        value - The includeStartMessage to set.
        Returns:
        This builder for chaining.
      • clearIncludeStartMessage

        public DumpMessagesRequest.Builder clearIncludeStartMessage()
         If true, dump starts from start_message_id inclusively; otherwise starts after it.
         
        bool include_start_message = 5;
        Returns:
        This builder for chaining.
      • setUnknownFields

        public final DumpMessagesRequest.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<DumpMessagesRequest.Builder>
      • mergeUnknownFields

        public final DumpMessagesRequest.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<DumpMessagesRequest.Builder>