Class PlatformInboundInstruction

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

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

      • EVENT_PROCESSOR_INFO_FIELD_NUMBER

        public static final int EVENT_PROCESSOR_INFO_FIELD_NUMBER
        See Also:
        Constant Field Values
      • SUBSCRIBE_TOPOLOGY_CHANGES_FIELD_NUMBER

        public static final int SUBSCRIBE_TOPOLOGY_CHANGES_FIELD_NUMBER
        See Also:
        Constant Field Values
      • UNSUBSCRIBE_TOPOLOGY_CHANGES_FIELD_NUMBER

        public static final int UNSUBSCRIBE_TOPOLOGY_CHANGES_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
      • hasRegister

        public boolean hasRegister()
         Information about the client being connected.
         This information is used by AxonServer to monitor the topology of connected applications.
         
        .io.axoniq.axonserver.grpc.control.ClientIdentification register = 1;
        Specified by:
        hasRegister in interface PlatformInboundInstructionOrBuilder
        Returns:
        Whether the register field is set.
      • getRegister

        public ClientIdentification getRegister()
         Information about the client being connected.
         This information is used by AxonServer to monitor the topology of connected applications.
         
        .io.axoniq.axonserver.grpc.control.ClientIdentification register = 1;
        Specified by:
        getRegister in interface PlatformInboundInstructionOrBuilder
        Returns:
        The register.
      • hasEventProcessorInfo

        public boolean hasEventProcessorInfo()
         Information about Processors defined in the application.
         This information is used by Axon Server to monitor the progress of Event Processors across instances.
         
        .io.axoniq.axonserver.grpc.control.EventProcessorInfo event_processor_info = 2;
        Specified by:
        hasEventProcessorInfo in interface PlatformInboundInstructionOrBuilder
        Returns:
        Whether the eventProcessorInfo field is set.
      • getEventProcessorInfo

        public EventProcessorInfo getEventProcessorInfo()
         Information about Processors defined in the application.
         This information is used by Axon Server to monitor the progress of Event Processors across instances.
         
        .io.axoniq.axonserver.grpc.control.EventProcessorInfo event_processor_info = 2;
        Specified by:
        getEventProcessorInfo in interface PlatformInboundInstructionOrBuilder
        Returns:
        The eventProcessorInfo.
      • hasHeartbeat

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

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

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

        public boolean hasResult()
         The result of the execution of an instruction 
         
        .io.axoniq.axonserver.grpc.InstructionResult result = 6;
        Specified by:
        hasResult in interface PlatformInboundInstructionOrBuilder
        Returns:
        Whether the result field is set.
      • hasSubscribeTopologyChanges

        public boolean hasSubscribeTopologyChanges()
         Subscribe to topology changes in the AxonServer cluster.
         This allows the client to receive updates about changes in the cluster, such as handler additions or removals.
         
        .io.axoniq.axonserver.grpc.control.SubscribeTopologyChanges subscribe_topology_changes = 7;
        Specified by:
        hasSubscribeTopologyChanges in interface PlatformInboundInstructionOrBuilder
        Returns:
        Whether the subscribeTopologyChanges field is set.
      • getSubscribeTopologyChanges

        public SubscribeTopologyChanges getSubscribeTopologyChanges()
         Subscribe to topology changes in the AxonServer cluster.
         This allows the client to receive updates about changes in the cluster, such as handler additions or removals.
         
        .io.axoniq.axonserver.grpc.control.SubscribeTopologyChanges subscribe_topology_changes = 7;
        Specified by:
        getSubscribeTopologyChanges in interface PlatformInboundInstructionOrBuilder
        Returns:
        The subscribeTopologyChanges.
      • hasUnsubscribeTopologyChanges

        public boolean hasUnsubscribeTopologyChanges()
         Unsubscribe from topology changes in the AxonServer cluster. 
         
        .io.axoniq.axonserver.grpc.control.UnsubscribeTopologyChanges unsubscribe_topology_changes = 8;
        Specified by:
        hasUnsubscribeTopologyChanges in interface PlatformInboundInstructionOrBuilder
        Returns:
        Whether the unsubscribeTopologyChanges field is set.
      • getInstructionId

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

        public com.google.protobuf.ByteString getInstructionIdBytes()
         Instruction identifier. If this identifier is set, this instruction will be acknowledged via outbound stream 
         
        string instruction_id = 5;
        Specified by:
        getInstructionIdBytes in interface PlatformInboundInstructionOrBuilder
        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 PlatformInboundInstruction parseFrom​(ByteBuffer data)
                                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

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

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

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

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

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

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

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

        public com.google.protobuf.Parser<PlatformInboundInstruction> 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 PlatformInboundInstruction getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder