package io.axoniq.axonserver.grpc

Get desktop application:
View/edit binary Protocol Buffers messages

Used as request type in: admin.EventProcessorAdminService.GetEventProcessorsByComponent

• string component = 1

Message containing details of an error

Used in: InstructionAck, InstructionResult, command.CommandResponse, query.QueryResponse, query.QueryUpdate, query.QueryUpdateCompleteExceptionally

• string message = 1

  A human readable message explaining the error

• string location = 2

  A description of the location (client component, server) where the error occurred

• repeated string details = 3

  A collection of messages providing more details about root causes of the error

• string error_code = 4

  An Error Code identifying the type of error

Message used for Flow Control instruction, providing the counterpart with additional permits for sending messages

Used in: command.CommandProviderOutbound, query.QueryProviderOutbound

• string client_id = 2

  The ClientID of the component providing additional permits

• int64 permits = 3

  The number of permits to provide

Message describing instruction acknowledgement

Used as response type in: event.EventScheduler.CancelScheduledEvent, event.dcb.DcbEventScheduler.CancelScheduledEvent

Used as field type in: command.CommandProviderInbound, command.CommandProviderOutbound, control.PlatformInboundInstruction, control.PlatformOutboundInstruction, query.QueryProviderInbound, query.QueryProviderOutbound

• string instruction_id = 1

  The identifier of the instruction

• bool success = 2

  Indicator whether the instruction was acknowledged successfully

• optional ErrorMessage error = 3

  Set if instruction acknowledgement failed.

Message describing the result of the execution of an instruction

Used in: control.PlatformInboundInstruction

• string instruction_id = 1

  The identifier of the instruction

• bool success = 2

  Indicator whether the instruction was processed successfully

• optional ErrorMessage error = 3

  Cause of instruction handling failure.

The value of a MetaData entry.

Used in: ProcessingInstruction, command.Command, command.CommandResponse, event.Event, query.QueryRequest, query.QueryResponse, query.QueryUpdate

• oneof data

  The data of the MetaData entry, depending on the type of data it contains.

  • string text_value = 1

    The text value of the Meta Data entry.

  • sint64 number_value = 2

    The numeric value of the Meta Data entry.

  • bool boolean_value = 3

    The boolean value of the Meta Data entry.

  • double double_value = 4

    The floating point value of the Meta Data entry.

  • SerializedObject bytes_value = 5

    The binary value of the Meta Data entry.

• string user = 1

An instruction for routing components when routing or processing a message.

Used in: command.Command, command.CommandResponse, query.QueryRequest, query.QueryResponse

• ProcessingKey key = 1

  The type of processing message.

• optional MetaDataValue value = 2

  The value associated with the processing key.

An enumeration of possible keys for processing instructions.

Used in: ProcessingInstruction

• ROUTING_KEY = 0

  key indicating that the attached value should be used for consistent routing.

• PRIORITY = 1

  key indicating that the attached value indicates relative priority of this message.

• TIMEOUT = 2

  key indicating that the accompanied message has a finite validity. The attached value contains the number of milliseconds.

• NR_OF_RESULTS = 3

  key indicating that the requester expects at most the given number of results from this message. Use -1 for unlimited.

• SERVER_SUPPORTS_STREAMING = 7

  key indicating whether Axon Server supports streaming.

• CLIENT_SUPPORTS_STREAMING = 8

  key indicating whether Client supports streaming.

Describes a serialized object

Used in: MetaDataValue, command.Command, command.CommandResponse, event.Event, query.QueryRequest, query.QueryResponse, query.QueryUpdate, query.SubscriptionQuery

• string type = 1

  The type identifier of the serialized object.

• string revision = 2

  The revision of the serialized form of the given type.

• bytes data = 3

  The actual data representing the object in serialized form.

Defines status values for a scheduled task

• SCHEDULED = 0

  Task is scheduled for execution

• COMPLETED = 1

  Task execution completed successfully

• FAILED = 2

  Task execution failed with non transient exception

• RUNNING = 3

  Task execution is in progress

• CANCELLED = 4

  Task execution is in progress