package apache.rocketmq.v2
Get desktop application:
View/edit binary Protocol Buffers messages
service Admin
admin.proto:41rpc ChangeLogLevel (, )
admin.proto:42message
admin.proto:28ChangeLogLevelRequest.Level level = 1
message
admin.proto:39string remark = 1
For all the RPCs in MessagingService, the following error handling policies apply: If the request doesn't bear a valid authentication credential, return a response with common.status.code == `UNAUTHENTICATED`. If the authenticated user is not granted with sufficient permission to execute the requested operation, return a response with common.status.code == `PERMISSION_DENIED`. If the per-user-resource-based quota is exhausted, return a response with common.status.code == `RESOURCE_EXHAUSTED`. If any unexpected server-side errors raise, return a response with common.status.code == `INTERNAL`.
rpc AckMessage (, )
service.proto:421Acknowledges the message associated with the `receipt_handle` or `offset` in the `AckMessageRequest`, it means the message has been successfully processed. Returns `OK` if the message server remove the relevant message successfully. If the given receipt_handle is illegal or out of date, returns `INVALID_ARGUMENT`.
message
service.proto:120optional group = 1
optional topic = 2
repeated entries = 3
message
service.proto:136optional status = 1
RPC tier status, which is used to represent RPC-level errors including authentication, authorization, throttling and other general failures.
repeated entries = 2
Once a message is retrieved from consume queue on behalf of the group, it will be kept invisible to other clients of the same group for a period of time. The message is supposed to be processed within the invisible duration. If the client, which is in charge of the invisible message, is not capable of processing the message timely, it may use ChangeInvisibleDuration to lengthen invisible duration.
message
service.proto:243optional group = 1
optional topic = 2
string receipt_handle = 3
Unique receipt handle to identify message to change
optional invisible_duration = 4
New invisible duration
string message_id = 5
For message tracing
optional string lite_topic = 6
optional bool suspend = 7
If true, server will not increment the retry times for this message
message
service.proto:261optional status = 1
string receipt_handle = 2
Server may generate a new receipt handle for the message.
rpc EndTransaction (, )
service.proto:444Commits or rollback one transactional message.
message
service.proto:164optional topic = 1
string message_id = 2
string transaction_id = 3
TransactionResolution resolution = 4
TransactionSource source = 5
string trace_context = 6
message
service.proto:173optional status = 1
Forwards one message to dead letter queue if the max delivery attempts is exceeded by this message at client-side, return `OK` if success.
message
service.proto:145optional group = 1
optional topic = 2
string receipt_handle = 3
string message_id = 4
int32 delivery_attempt = 5
int32 max_delivery_attempts = 6
optional string lite_topic = 7
message
service.proto:155optional status = 1
rpc GetOffset (, )
service.proto:438Query the consumption progress of the designated queue of the consumer group to the remote.
message
service.proto:295optional group = 1
optional message_queue = 2
message
service.proto:300optional status = 1
int64 offset = 2
rpc Heartbeat (, )
service.proto:372Producer or consumer sends HeartbeatRequest to servers periodically to keep-alive. Additionally, it also reports client-side configuration, including topic subscription, load-balancing group name, etc. Returns `OK` if success. If a client specifies a language that is not yet supported by servers, returns `INVALID_ARGUMENT`
message
service.proto:157optional group = 1
ClientType client_type = 2
message
service.proto:162optional status = 1
Notify the server that the client is terminated.
message
service.proto:236optional group = 1
Consumer group, which is absent for producer.
message
service.proto:241optional status = 1
rpc PullMessage (, stream )
service.proto:430PullMessage and ReceiveMessage RPCs serve a similar purpose, which is to attempt to get messages from the server, but with different semantics.
message
service.proto:268optional group = 1
optional message_queue = 2
int64 offset = 3
int32 batch_size = 4
optional filter_expression = 5
optional long_polling_timeout = 6
message
service.proto:277oneof content
status = 1
message = 2
int64 next_offset = 3
rpc QueryAssignment (, )
service.proto:394Queries the assigned route info of a topic for current consumer, the returned assignment result is decided by server-side load balancer. If the corresponding topic doesn't exist, returns `NOT_FOUND`. If the specific endpoints is empty, returns `INVALID_ARGUMENT`.
message
service.proto:81optional topic = 1
optional group = 2
optional endpoints = 3
message
service.proto:87optional status = 1
repeated assignments = 2
rpc QueryOffset (, )
service.proto:441Query the offset of the designated queue by the query offset policy.
message
service.proto:305optional message_queue = 1
QueryOffsetPolicy query_offset_policy = 2
optional timestamp = 3
message
service.proto:311optional status = 1
int64 offset = 2
rpc QueryRoute (, )
service.proto:362Queries the route entries of the requested topic in the perspective of the given endpoints. On success, servers should return a collection of addressable message-queues. Note servers may return customized route entries based on endpoints provided. If the requested topic doesn't exist, returns `NOT_FOUND`. If the specific endpoints is empty, returns `INVALID_ARGUMENT`.
message
service.proto:49Topics are destination of messages to publish to or subscribe from. Similar to domain names, they will be addressable after resolution through the provided access point. Access points are usually the addresses of name servers, which fulfill service discovery, load-balancing and other auxiliary services. Name servers receive periodic heartbeats from affiliate brokers and erase those which failed to maintain alive status. Name servers answer queries of QueryRouteRequest, responding clients with addressable message-queues, which they may directly publish messages to or subscribe messages from. QueryRouteRequest shall include source endpoints, aka, configured access-point, which annotates tenant-id, instance-id or other vendor-specific settings. Purpose-built name servers may respond customized results based on these particular requirements.
optional topic = 1
optional endpoints = 2
message
service.proto:54optional status = 1
repeated message_queues = 2
rpc RecallMessage (, )
service.proto:470Recall a message, for delay message, should recall before delivery time, like the rollback operation of transaction message, for normal message, not supported for now.
message
service.proto:316optional topic = 1
string recall_handle = 2
Refer to SendResultEntry.
message
service.proto:322optional status = 1
string message_id = 2
rpc ReceiveMessage (, stream )
service.proto:411Receives messages from the server in batch manner, returns a set of messages if success. The received messages should be acked or redelivered after processed. If the pending concurrent receive requests exceed the quota of the given consumer group, returns `UNAVAILABLE`. If the upstream store server hangs, return `DEADLINE_EXCEEDED` in a timely manner. If the corresponding topic or consumer group doesn't exist, returns `NOT_FOUND`. If there is no new message in the specific topic, returns `OK` with an empty message set. Please note that client may suffer from false empty responses. If failed to receive message from remote, server must return only one `ReceiveMessageResponse` as the reply to the request, whose `Status` indicates the specific reason of failure, otherwise, the reply is considered successful.
message
service.proto:92optional group = 1
optional message_queue = 2
optional filter_expression = 3
int32 batch_size = 4
optional invisible_duration = 5
Required if client type is simple consumer.
bool auto_renew = 6
For message auto renew and clean
optional long_polling_timeout = 7
optional string attempt_id = 8
message
service.proto:105oneof content
status = 1
message = 2
delivery_timestamp = 3
The timestamp that brokers start to deliver status line or message.
rpc SendMessage (, )
service.proto:387Delivers messages to brokers. Clients may further: 1. Refine a message destination to message-queues which fulfills parts of FIFO semantic; 2. Flag a message as transactional, which keeps it invisible to consumers until it commits; 3. Time a message, making it invisible to consumers till specified time-point; 4. And more... Returns message-id or transaction-id with status `OK` on success. If the destination topic doesn't exist, returns `NOT_FOUND`.
message
service.proto:60repeated messages = 1
message
service.proto:73optional status = 1
repeated entries = 2
Some implementation may have partial failure issues. Client SDK developers are expected to inspect each entry for best certainty.
Sync lite subscription info, lite push consumer only
message
service.proto:327LiteSubscriptionAction action = 1
optional topic = 2
bindTopic for lite push consumer
optional group = 3
consumer group
repeated string lite_topic_set = 4
lite subscription set of lite topics
optional int64 version = 5
optional offset_option = 6
message
service.proto:339optional status = 1
rpc Telemetry (stream , stream )
service.proto:452Once a client starts, it would immediately establishes bi-lateral stream RPCs with brokers, reporting its settings as the initiative command. When servers have need of inspecting client status, they would issue telemetry commands to clients. After executing received instructions, clients shall report command execution results through client-side streams.
message
service.proto:202optional status = 1
oneof command
settings = 2
Client settings
thread_stack_trace = 3
These messages are from client. Report thread stack trace to server.
verify_message_result = 4
Report message verify result to server.
recover_orphaned_transaction_command = 5
There messages are from server. Request client to recover the orphaned transaction message.
print_thread_stack_trace_command = 6
Request client to print thread stack trace.
verify_message_command = 7
Request client to verify the consumption of the appointed message.
reconnect_endpoints_command = 8
Request client to reconnect server use the latest endpoints.
notify_unsubscribe_lite_command = 9
Request client to unsubscribe lite topic.
rpc UpdateOffset (, )
service.proto:434Update the consumption progress of the designated queue of the consumer group to the remote.
message
service.proto:285optional group = 1
optional message_queue = 2
int64 offset = 3
message
service.proto:291optional status = 1
message
service.proto:114Used in:
string message_id = 1
string receipt_handle = 2
optional string lite_topic = 3
message
service.proto:126Used in:
string message_id = 1
string receipt_handle = 2
optional status = 3
Acknowledge result may be acquired through inspecting `status.code`; In case acknowledgement failed, `status.message` is the explanation of the failure.
message
definition.proto:102Used in:
string host = 1
int32 port = 2
Used in:
ADDRESS_SCHEME_UNSPECIFIED = 0
IPv4 = 1
IPv6 = 2
DOMAIN_NAME = 3
message
definition.proto:312Used in:
optional message_queue = 1
message
definition.proto:112Used in:
string name = 1
Name of the broker
int32 id = 2
Broker index. Canonically, index = 0 implies that the broker is playing leader role while brokers with index > 0 play follower role.
optional endpoints = 3
Address of the broker, complying with the following scheme 1. dns:[//authority/]host[:port] 2. ipv4:address[:port][,address[:port],...] – IPv4 addresses 3. ipv6:address[:port][,address[:port],...] – IPv6 addresses
Used in:
TRACE = 0
DEBUG = 1
INFO = 2
WARN = 3
ERROR = 4
Used in: ,
CLIENT_TYPE_UNSPECIFIED = 0
PRODUCER = 1
PUSH_CONSUMER = 2
SIMPLE_CONSUMER = 3
PULL_CONSUMER = 4
LITE_PUSH_CONSUMER = 5
LITE_SIMPLE_CONSUMER = 6
Used in:
CODE_UNSPECIFIED = 0
OK = 20000
Generic code for success.
MULTIPLE_RESULTS = 30000
Generic code for multiple return results.
BAD_REQUEST = 40000
Generic code for bad request, indicating that required fields or headers are missing.
ILLEGAL_ACCESS_POINT = 40001
Format of access point is illegal.
ILLEGAL_TOPIC = 40002
Format of topic is illegal.
ILLEGAL_CONSUMER_GROUP = 40003
Format of consumer group is illegal.
ILLEGAL_MESSAGE_TAG = 40004
Format of message tag is illegal.
ILLEGAL_MESSAGE_KEY = 40005
Format of message key is illegal.
ILLEGAL_MESSAGE_GROUP = 40006
Format of message group is illegal.
ILLEGAL_MESSAGE_PROPERTY_KEY = 40007
Format of message property key is illegal.
INVALID_TRANSACTION_ID = 40008
Transaction id is invalid.
ILLEGAL_MESSAGE_ID = 40009
Format of message id is illegal.
ILLEGAL_FILTER_EXPRESSION = 40010
Format of filter expression is illegal.
ILLEGAL_INVISIBLE_TIME = 40011
The invisible time of request is invalid.
ILLEGAL_DELIVERY_TIME = 40012
The delivery timestamp of message is invalid.
INVALID_RECEIPT_HANDLE = 40013
Receipt handle of message is invalid.
MESSAGE_PROPERTY_CONFLICT_WITH_TYPE = 40014
Message property conflicts with its type.
UNRECOGNIZED_CLIENT_TYPE = 40015
Client type could not be recognized.
MESSAGE_CORRUPTED = 40016
Message is corrupted.
CLIENT_ID_REQUIRED = 40017
Request is rejected due to missing of x-mq-client-id header.
ILLEGAL_POLLING_TIME = 40018
Polling time is illegal.
ILLEGAL_OFFSET = 40019
Offset is illegal.
ILLEGAL_LITE_TOPIC = 40020
Format of lite topic is illegal.
INVALID_CLIENT_PROPERTIES = 40021
Client properties validation failed. This error occurs when: - The number of properties exceeds 32. - Key length exceeds 64 characters. - Key does not match the regex pattern: [a-zA-Z][a-zA-Z0-9_.-]* - Value length exceeds 256 characters. - Total serialized size exceeds 4KB.
UNAUTHORIZED = 40100
Generic code indicates that the client request lacks valid authentication credentials for the requested resource.
PAYMENT_REQUIRED = 40200
Generic code indicates that the account is suspended due to overdue of payment.
FORBIDDEN = 40300
Generic code for the case that user does not have the permission to operate.
NOT_FOUND = 40400
Generic code for resource not found.
MESSAGE_NOT_FOUND = 40401
Message not found from server.
TOPIC_NOT_FOUND = 40402
Topic resource does not exist.
CONSUMER_GROUP_NOT_FOUND = 40403
Consumer group resource does not exist.
OFFSET_NOT_FOUND = 40404
Offset not found from server.
REQUEST_TIMEOUT = 40800
Generic code representing client side timeout when connecting to, reading data from, or write data to server.
PAYLOAD_TOO_LARGE = 41300
Generic code represents that the request entity is larger than limits defined by server.
MESSAGE_BODY_TOO_LARGE = 41301
Message body size exceeds the threshold.
MESSAGE_BODY_EMPTY = 41302
Message body is empty.
PRECONDITION_FAILED = 42800
Generic code for use cases where pre-conditions are not met. For example, if a producer instance is used to publish messages without prior start() invocation, this error code will be raised.
TOO_MANY_REQUESTS = 42900
Generic code indicates that too many requests are made in short period of duration. Requests are throttled.
LITE_TOPIC_QUOTA_EXCEEDED = 42901
LiteTopic related quota exceeded
LITE_SUBSCRIPTION_QUOTA_EXCEEDED = 42902
REQUEST_HEADER_FIELDS_TOO_LARGE = 43100
Generic code for the case that the server is unwilling to process the request because its header fields are too large. The request may be resubmitted after reducing the size of the request header fields.
MESSAGE_PROPERTIES_TOO_LARGE = 43101
Message properties total size exceeds the threshold.
INTERNAL_ERROR = 50000
Generic code indicates that server/client encountered an unexpected condition that prevented it from fulfilling the request.
INTERNAL_SERVER_ERROR = 50001
Code indicates that the server encountered an unexpected condition that prevented it from fulfilling the request. This error response is a generic "catch-all" response. Usually, this indicates the server cannot find a better alternative error code to response. Sometimes, server administrators log error responses like the 500 status code with more details about the request to prevent the error from happening again in the future. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500
HA_NOT_AVAILABLE = 50002
The HA-mechanism is not working now.
NOT_IMPLEMENTED = 50100
Generic code means that the server or client does not support the functionality required to fulfill the request.
PROXY_TIMEOUT = 50400
Generic code represents that the server, which acts as a gateway or proxy, does not get an satisfied response in time from its upstream servers. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/504
MASTER_PERSISTENCE_TIMEOUT = 50401
Message persistence timeout.
SLAVE_PERSISTENCE_TIMEOUT = 50402
Slave persistence timeout.
UNSUPPORTED = 50500
Generic code for unsupported operation.
VERSION_UNSUPPORTED = 50501
Operation is not allowed in current version.
VERIFY_FIFO_MESSAGE_UNSUPPORTED = 50502
Not allowed to verify message. Chances are that you are verifying a FIFO message, as is violating FIFO semantics.
FAILED_TO_CONSUME_MESSAGE = 60000
Generic code for failed message consumption.
message
definition.proto:76Used in:
repeated next = 1
To support classic backoff strategy which is arbitrary defined by end users. Typical values are: `1s 5s 10s 30s 1m 2m 3m 4m 5m 6m 7m 8m 9m 10m 20m 30m 1h 2h`
message
definition.proto:289Used in:
string topic = 1
Original topic for this DLQ message.
string message_id = 2
Original message id for this DLQ message.
message
definition.proto:184When publishing messages to or subscribing messages from brokers, clients shall include or validate digests of message body to ensure data integrity. For message publishing, when an invalid digest were detected, brokers need respond client with BAD_REQUEST. For messages subscription, when an invalid digest were detected, consumers need to handle this case according to message type: 1) Standard messages should be negatively acknowledged instantly, causing immediate re-delivery; 2) FIFO messages require special RPC, to re-fetch previously acquired messages batch;
Used in:
DigestType type = 1
string checksum = 2
Used in:
DIGEST_TYPE_UNSPECIFIED = 0
CRC32 = 1
CRC algorithm achieves goal of detecting random data error with lowest computation overhead.
MD5 = 2
MD5 algorithm achieves good balance between collision rate and computation overhead.
SHA1 = 3
SHA-family has substantially fewer collision with fair amount of computation.
Used in:
ENCODING_UNSPECIFIED = 0
IDENTITY = 1
GZIP = 2
message
definition.proto:107Used in: , , , ,
AddressScheme scheme = 1
repeated addresses = 2
message
definition.proto:70https://en.wikipedia.org/wiki/Exponential_backoff
Used in:
optional initial = 1
optional max = 2
float multiplier = 3
message
definition.proto:56Used in: , ,
FilterType type = 1
string expression = 2
Used in:
FILTER_TYPE_UNSPECIFIED = 0
TAG = 1
SQL = 2
Used in:
LANGUAGE_UNSPECIFIED = 0
JAVA = 1
CPP = 2
DOT_NET = 3
GOLANG = 4
RUST = 5
PYTHON = 6
PHP = 7
NODE_JS = 8
RUBY = 9
OBJECTIVE_C = 10
DART = 11
KOTLIN = 12
Used in:
PARTIAL_ADD = 0
PARTIAL_REMOVE = 1
COMPLETE_ADD = 2
COMPLETE_REMOVE = 3
message
definition.proto:296Used in: , , , ,
optional topic = 1
map<string, string> user_properties = 2
User defined key-value pairs. If user_properties contain the reserved keys by RocketMQ, the send message request will be aborted with status `INVALID_ARGUMENT`. See below links for the reserved keys https://github.com/apache/rocketmq/blob/master/common/src/main/java/org/apache/rocketmq/common/message/MessageConst.java#L58
optional system_properties = 3
bytes body = 4
message
definition.proto:127Used in: , , , , , ,
optional topic = 1
int32 id = 2
Permission permission = 3
optional broker = 4
repeated MessageType accept_message_types = 5
Used in: ,
MESSAGE_TYPE_UNSPECIFIED = 0
NORMAL = 1
FIFO = 2
Sequenced message
DELAY = 3
Messages that are delivered after the specified duration.
TRANSACTION = 4
Messages that are transactional. Only committed messages are delivered to subscribers.
LITE = 5
lite topic
PRIORITY = 6
Messages that lower prioritised ones may need to wait for higher priority messages to be processed first
message
definition.proto:619Used in:
bool on = 1
Indicates that if client should export local metrics to server.
optional endpoints = 2
The endpoint that client metrics should be exported to, which is required if the switch is on.
message
service.proto:198Used in:
string lite_topic = 1
message
definition.proto:638Used in:
oneof offset_type
OffsetOption.Policy policy = 1
int64 offset = 2
int64 tail_n = 3
int64 timestamp = 4
Used in:
LAST = 0
MIN = 1
MAX = 2
Used in:
PERMISSION_UNSPECIFIED = 0
NONE = 1
READ = 2
WRITE = 3
READ_WRITE = 4
message
service.proto:175Used in:
string nonce = 1
message
definition.proto:559Used in:
repeated topics = 1
Publishing settings below here is appointed by client, thus it is unnecessary for server to push at present. List of topics to which messages will publish to.
int32 max_body_size = 2
If the message body size exceeds `max_body_size`, broker servers would reject the request. As a result, it is advisable that Producer performs client-side check validation.
bool validate_message_type = 3
When `validate_message_type` flag set `false`, no need to validate message's type with messageQueue's `accept_message_types` before publishing.
Used in:
BEGINNING = 0
Use this option if client wishes to playback all existing messages.
END = 1
Use this option if client wishes to skip all existing messages.
TIMESTAMP = 2
Use this option if time-based seek is targeted.
message
service.proto:177Used in:
string nonce = 1
message
service.proto:193Used in:
optional message = 1
string transaction_id = 2
message
definition.proto:82Used in: , , , , , , , , , , , , , , , , , ,
string resource_namespace = 1
string name = 2
Resource name identifier, which remains unique within the abstract resource namespace.
message
definition.proto:61Used in:
int32 max_attempts = 1
oneof strategy
exponential_backoff = 2
customized_backoff = 3
message
service.proto:64Used in:
optional status = 1
string message_id = 2
string transaction_id = 3
int64 offset = 4
string recall_handle = 5
Unique handle to identify message to recall, support delay message for now.
message
definition.proto:502Used in:
optional ClientType client_type = 1
Configurations for all clients.
optional access_point = 2
optional backoff_policy = 3
If publishing of messages encounters throttling or server internal errors, publishers should implement automatic retries after progressive longer back-offs for consecutive errors. When processing message fails, `backoff_policy` describes an interval after which the message should be available to consume again. For FIFO messages, the interval should be relatively small because messages of the same message group would not be readily available until the prior one depletes its lifecycle.
optional request_timeout = 4
Request timeout for RPCs excluding long-polling.
oneof pub_sub
publishing = 5
subscription = 6
optional user_agent = 7
User agent details
optional metric = 8
map<string, string> client_properties = 9
Application-defined metadata associated with this client instance. These properties are for observability, troubleshooting, auditing and management only. Constraints: - Maximum 32 key-value pairs per client instance - Key length: 1-64 characters, must match pattern [a-zA-Z][a-zA-Z0-9_.-]* - Value length: 0-256 characters - Total serialized size: <= 4KB Reserved prefix: "rocketmq." for system use. Server-side validation: - Reject with INVALID_CLIENT_PROPERTIES if constraints are violated - Treat values as untrusted client-declared metadata - Do NOT use for security decisions (authentication/authorization) Lifecycle: - Reported once during Telemetry stream establishment via TelemetryCommand.settings - Stored in server-side client runtime - Discarded when stream/channel is closed - Exposed via admin query APIs (e.g., producerConnection, consumerConnection)
message
definition.proto:466Used in: , , , , , , , , , , , , , , , , , ,
Code code = 1
string message = 2
message
definition.proto:576Used in:
optional group = 1
Subscription settings below here is appointed by client, thus it is unnecessary for server to push at present. Consumer group.
repeated subscriptions = 2
Subscription for consumer.
optional bool fifo = 3
Subscription settings below here are from server, it is essential for server to push. When FIFO flag is `true`, messages of the same message group are processed in first-in-first-out manner. Brokers will not deliver further messages of the same group until prior ones are completely acknowledged.
optional int32 receive_batch_size = 4
Message receive batch size here is essential for push consumer.
optional long_polling_timeout = 5
Long-polling timeout for `ReceiveMessageRequest`, which is essential for push consumer.
optional int32 lite_subscription_quota = 6
Only lite push consumer client-side lite subscription quota limit
optional int32 max_lite_topic_size = 7
Only lite push consumer Maximum length limit for lite topic
message
definition.proto:90Used in:
optional topic = 1
optional expression = 2
message
definition.proto:207Used in:
optional string tag = 1
Tag, which is optional.
repeated string keys = 2
Message keys
string message_id = 3
Message identifier, client-side generated, remains unique. if message_id is empty, the send message request will be aborted with status `INVALID_ARGUMENT`
optional body_digest = 4
Message body digest
Encoding body_encoding = 5
Message body encoding. Candidate options are identity, gzip, snappy etc.
MessageType message_type = 6
Message type, normal, FIFO or transactional.
optional born_timestamp = 7
Message born time-point.
string born_host = 8
Message born host. Valid options are IPv4, IPv6 or client host domain name.
optional store_timestamp = 9
Time-point at which the message is stored in the broker, which is absent for message publishing.
string store_host = 10
The broker that stores this message. It may be broker name, IP or arbitrary identifier that uniquely identify the server.
optional delivery_timestamp = 11
Time-point at which broker delivers to clients, which is optional.
optional string receipt_handle = 12
If a message is acquired by way of POP, this field holds the receipt, which is absent for message publishing. Clients use the receipt to acknowledge or negatively acknowledge the message.
int32 queue_id = 13
Message queue identifier in which a message is physically stored.
optional int64 queue_offset = 14
Message-queue offset at which a message is stored, which is absent for message publishing.
optional invisible_duration = 15
Period of time servers would remain invisible once a message is acquired.
optional int32 delivery_attempt = 16
Business code may failed to process messages for the moment. Hence, clients may request servers to deliver them again using certain back-off strategy, the attempt is 1 not 0 if message is delivered first time, and it is absent for message publishing.
optional string message_group = 17
Define the group name of message in the same topic, which is optional.
optional string trace_context = 18
Trace context for each message, which is optional.
optional orphaned_transaction_recovery_duration = 19
If a transactional message stay unresolved for more than `transaction_orphan_threshold`, it would be regarded as an orphan. Servers that manages orphan messages would pick up a capable publisher to resolve
optional dead_letter_queue = 20
Information to identify whether this message is from dead letter queue.
optional string lite_topic = 21
lite topic
optional int32 priority = 22
Priority of message, which is optional
message
service.proto:179Used in:
string nonce = 1
optional string thread_stack_trace = 2
Used in:
TRANSACTION_RESOLUTION_UNSPECIFIED = 0
COMMIT = 1
ROLLBACK = 2
Used in:
SOURCE_UNSPECIFIED = 0
SOURCE_CLIENT = 1
SOURCE_SERVER_CHECK = 2
message
definition.proto:488User Agent
Used in:
Language language = 1
SDK language
string version = 2
SDK version
string platform = 3
Platform details, including OS name, version, arch etc.
string hostname = 4
Hostname of the node
message
service.proto:184Used in:
string nonce = 1
optional message = 2
message
service.proto:189Used in:
string nonce = 1