RequestOptions

Common request options for various APIs.

JSON representation
{"priority":enum (Priority),"requestTag":string,"transactionTag":string}
Fields
priority

enum (Priority)

Priority for the request.

requestTag

string

A per-request tag which can be applied to queries or reads, used for statistics collection. BothrequestTag andtransactionTag can be specified for a read or query that belongs to a transaction. This field is ignored for requests where it's not applicable (for example,CommitRequest). Legal characters forrequestTag values are all printable characters (ASCII 32 - 126) and the length of a requestTag is limited to 50 characters. Values that exceed this limit are truncated. Any leading underscore (_) characters are removed from the string.

transactionTag

string

A tag used for statistics collection about this transaction. BothrequestTag andtransactionTag can be specified for a read or query that belongs to a transaction. To enable tagging on a transaction,transactionTag must be set to the same value for all requests belonging to the same transaction, includingsessions.beginTransaction. If this request doesn't belong to any transaction,transactionTag is ignored. Legal characters fortransactionTag values are all printable characters (ASCII 32 - 126) and the length of atransactionTag is limited to 50 characters. Values that exceed this limit are truncated. Any leading underscore (_) characters are removed from the string.

Priority

The relative priority for requests. Note that priority isn't applicable forsessions.beginTransaction.

The priority acts as a hint to the Cloud Spanner scheduler and doesn't guarantee priority or order of execution. For example:

  • Some parts of a write operation always execute atPRIORITY_HIGH, regardless of the specified priority. This can cause you to see an increase in high priority workload even when executing a low priority request. This can also potentially cause a priority inversion where a lower priority request is fulfilled ahead of a higher priority request.
  • If a transaction contains multiple operations with different priorities, Cloud Spanner doesn't guarantee to process the higher priority operations first. There might be other constraints to satisfy, such as the order of operations.
Enums
PRIORITY_UNSPECIFIEDPRIORITY_UNSPECIFIED is equivalent toPRIORITY_HIGH.
PRIORITY_LOWThis specifies that the request is low priority.
PRIORITY_MEDIUMThis specifies that the request is medium priority.
PRIORITY_HIGHThis specifies that the request is high priority.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-12-12 UTC.