Class PlatformOutboundInstruction

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, PlatformOutboundInstructionOrBuilder, Serializable

    @Generated
    public final class PlatformOutboundInstruction
    extends com.google.protobuf.GeneratedMessage
    implements PlatformOutboundInstructionOrBuilder
     An instruction or information from the AxonServer Platform to the Application Node 
     
    Protobuf type io.axoniq.axonserver.grpc.control.PlatformOutboundInstruction
    See Also:
    Serialized Form
    • Field Detail

      • NODE_NOTIFICATION_FIELD_NUMBER

        public static final int NODE_NOTIFICATION_FIELD_NUMBER
        See Also:
        Constant Field Values
      • REQUEST_RECONNECT_FIELD_NUMBER

        public static final int REQUEST_RECONNECT_FIELD_NUMBER
        See Also:
        Constant Field Values
      • PAUSE_EVENT_PROCESSOR_FIELD_NUMBER

        public static final int PAUSE_EVENT_PROCESSOR_FIELD_NUMBER
        See Also:
        Constant Field Values
      • START_EVENT_PROCESSOR_FIELD_NUMBER

        public static final int START_EVENT_PROCESSOR_FIELD_NUMBER
        See Also:
        Constant Field Values
      • RELEASE_SEGMENT_FIELD_NUMBER

        public static final int RELEASE_SEGMENT_FIELD_NUMBER
        See Also:
        Constant Field Values
      • REQUEST_EVENT_PROCESSOR_INFO_FIELD_NUMBER

        public static final int REQUEST_EVENT_PROCESSOR_INFO_FIELD_NUMBER
        See Also:
        Constant Field Values
      • SPLIT_EVENT_PROCESSOR_SEGMENT_FIELD_NUMBER

        public static final int SPLIT_EVENT_PROCESSOR_SEGMENT_FIELD_NUMBER
        See Also:
        Constant Field Values
      • MERGE_EVENT_PROCESSOR_SEGMENT_FIELD_NUMBER

        public static final int MERGE_EVENT_PROCESSOR_SEGMENT_FIELD_NUMBER
        See Also:
        Constant Field Values
      • TOPOLOGY_CHANGE_FIELD_NUMBER

        public static final int TOPOLOGY_CHANGE_FIELD_NUMBER
        See Also:
        Constant Field Values
      • INSTRUCTION_ID_FIELD_NUMBER

        public static final int INSTRUCTION_ID_FIELD_NUMBER
        See Also:
        Constant Field Values
    • Method Detail

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessage
      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage
      • hasNodeNotification

        public boolean hasNodeNotification()
         Information provided by AxonServer which provides information about the AxonServer node the application is connected with 
         
        .io.axoniq.axonserver.grpc.control.NodeInfo node_notification = 1;
        Specified by:
        hasNodeNotification in interface PlatformOutboundInstructionOrBuilder
        Returns:
        Whether the nodeNotification field is set.
      • getNodeNotification

        public NodeInfo getNodeNotification()
         Information provided by AxonServer which provides information about the AxonServer node the application is connected with 
         
        .io.axoniq.axonserver.grpc.control.NodeInfo node_notification = 1;
        Specified by:
        getNodeNotification in interface PlatformOutboundInstructionOrBuilder
        Returns:
        The nodeNotification.
      • hasRequestReconnect

        public boolean hasRequestReconnect()
         A request from AxonServer to the Application to migrate its connection to another node.
         Clients SHOULD honor this request by closing their current connection, and using the GetPlatformServer RPC
         to request a new destination.
         
        .io.axoniq.axonserver.grpc.control.RequestReconnect request_reconnect = 3;
        Specified by:
        hasRequestReconnect in interface PlatformOutboundInstructionOrBuilder
        Returns:
        Whether the requestReconnect field is set.
      • getRequestReconnect

        public RequestReconnect getRequestReconnect()
         A request from AxonServer to the Application to migrate its connection to another node.
         Clients SHOULD honor this request by closing their current connection, and using the GetPlatformServer RPC
         to request a new destination.
         
        .io.axoniq.axonserver.grpc.control.RequestReconnect request_reconnect = 3;
        Specified by:
        getRequestReconnect in interface PlatformOutboundInstructionOrBuilder
        Returns:
        The requestReconnect.
      • getRequestReconnectOrBuilder

        public RequestReconnectOrBuilder getRequestReconnectOrBuilder()
         A request from AxonServer to the Application to migrate its connection to another node.
         Clients SHOULD honor this request by closing their current connection, and using the GetPlatformServer RPC
         to request a new destination.
         
        .io.axoniq.axonserver.grpc.control.RequestReconnect request_reconnect = 3;
        Specified by:
        getRequestReconnectOrBuilder in interface PlatformOutboundInstructionOrBuilder
      • hasPauseEventProcessor

        public boolean hasPauseEventProcessor()
         Instruction from AxonServer to Pause a Streaming Event Processor. 
         
        .io.axoniq.axonserver.grpc.control.EventProcessorReference pause_event_processor = 4;
        Specified by:
        hasPauseEventProcessor in interface PlatformOutboundInstructionOrBuilder
        Returns:
        Whether the pauseEventProcessor field is set.
      • hasStartEventProcessor

        public boolean hasStartEventProcessor()
         Instruction from AxonServer to Start a Streaming Event Processor. 
         
        .io.axoniq.axonserver.grpc.control.EventProcessorReference start_event_processor = 5;
        Specified by:
        hasStartEventProcessor in interface PlatformOutboundInstructionOrBuilder
        Returns:
        Whether the startEventProcessor field is set.
      • hasReleaseSegment

        public boolean hasReleaseSegment()
         Instruction from AxonServer to Release a specific segment in a Streaming Event Processor 
         
        .io.axoniq.axonserver.grpc.control.EventProcessorSegmentReference release_segment = 6;
        Specified by:
        hasReleaseSegment in interface PlatformOutboundInstructionOrBuilder
        Returns:
        Whether the releaseSegment field is set.
      • hasRequestEventProcessorInfo

        public boolean hasRequestEventProcessorInfo()
         A request from AxonServer for status information of a specific Streaming Event Processor 
         
        .io.axoniq.axonserver.grpc.control.EventProcessorReference request_event_processor_info = 7;
        Specified by:
        hasRequestEventProcessorInfo in interface PlatformOutboundInstructionOrBuilder
        Returns:
        Whether the requestEventProcessorInfo field is set.
      • hasSplitEventProcessorSegment

        public boolean hasSplitEventProcessorSegment()
         Instruction to split a Segment in a Streaming Event Processor 
         
        .io.axoniq.axonserver.grpc.control.EventProcessorSegmentReference split_event_processor_segment = 8;
        Specified by:
        hasSplitEventProcessorSegment in interface PlatformOutboundInstructionOrBuilder
        Returns:
        Whether the splitEventProcessorSegment field is set.
      • hasMergeEventProcessorSegment

        public boolean hasMergeEventProcessorSegment()
         Instruction to merge two Segments in a Streaming Event Processor 
         
        .io.axoniq.axonserver.grpc.control.EventProcessorSegmentReference merge_event_processor_segment = 9;
        Specified by:
        hasMergeEventProcessorSegment in interface PlatformOutboundInstructionOrBuilder
        Returns:
        Whether the mergeEventProcessorSegment field is set.
      • hasHeartbeat

        public boolean hasHeartbeat()
         This heartbeat is used by AxonFramework in order to check if the connection is still alive
         
        .io.axoniq.axonserver.grpc.control.Heartbeat heartbeat = 10;
        Specified by:
        hasHeartbeat in interface PlatformOutboundInstructionOrBuilder
        Returns:
        Whether the heartbeat field is set.
      • getHeartbeat

        public Heartbeat getHeartbeat()
         This heartbeat is used by AxonFramework in order to check if the connection is still alive
         
        .io.axoniq.axonserver.grpc.control.Heartbeat heartbeat = 10;
        Specified by:
        getHeartbeat in interface PlatformOutboundInstructionOrBuilder
        Returns:
        The heartbeat.
      • hasAck

        public boolean hasAck()
         Acknowledgement of previously sent instruction via inbound stream 
         
        .io.axoniq.axonserver.grpc.InstructionAck ack = 11;
        Specified by:
        hasAck in interface PlatformOutboundInstructionOrBuilder
        Returns:
        Whether the ack field is set.
      • hasTopologyChange

        public boolean hasTopologyChange()
         Notification of a change in the topology of the AxonServer cluster.
         This is used to inform clients about changes in the cluster, such as handler additions or removals.
         
        .io.axoniq.axonserver.grpc.control.TopologyChange topology_change = 13;
        Specified by:
        hasTopologyChange in interface PlatformOutboundInstructionOrBuilder
        Returns:
        Whether the topologyChange field is set.
      • getTopologyChange

        public TopologyChange getTopologyChange()
         Notification of a change in the topology of the AxonServer cluster.
         This is used to inform clients about changes in the cluster, such as handler additions or removals.
         
        .io.axoniq.axonserver.grpc.control.TopologyChange topology_change = 13;
        Specified by:
        getTopologyChange in interface PlatformOutboundInstructionOrBuilder
        Returns:
        The topologyChange.
      • getInstructionId

        public String getInstructionId()
         Instruction identifier. If this identifier is set, this instruction will be acknowledged via inbound stream 
         
        string instruction_id = 12;
        Specified by:
        getInstructionId in interface PlatformOutboundInstructionOrBuilder
        Returns:
        The instructionId.
      • getInstructionIdBytes

        public com.google.protobuf.ByteString getInstructionIdBytes()
         Instruction identifier. If this identifier is set, this instruction will be acknowledged via inbound stream 
         
        string instruction_id = 12;
        Specified by:
        getInstructionIdBytes in interface PlatformOutboundInstructionOrBuilder
        Returns:
        The bytes for instructionId.
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessage
      • 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.GeneratedMessage
        Throws:
        IOException
      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessage
      • 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 PlatformOutboundInstruction parseFrom​(ByteBuffer data)
                                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static PlatformOutboundInstruction parseFrom​(ByteBuffer data,
                                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static PlatformOutboundInstruction parseFrom​(com.google.protobuf.ByteString data)
                                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static PlatformOutboundInstruction parseFrom​(com.google.protobuf.ByteString data,
                                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static PlatformOutboundInstruction parseFrom​(byte[] data)
                                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static PlatformOutboundInstruction parseFrom​(byte[] data,
                                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • newBuilderForType

        public PlatformOutboundInstruction.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite
      • toBuilder

        public PlatformOutboundInstruction.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite
      • newBuilderForType

        protected PlatformOutboundInstruction.Builder newBuilderForType​(com.google.protobuf.AbstractMessage.BuilderParent parent)
        Overrides:
        newBuilderForType in class com.google.protobuf.AbstractMessage
      • getParserForType

        public com.google.protobuf.Parser<PlatformOutboundInstruction> 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.GeneratedMessage
      • getDefaultInstanceForType

        public PlatformOutboundInstruction getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder