Reference documentation and code samples for the Cloud Spanner V1 Client class RequestOptions.
Common request options for various APIs.
Generated from protobuf message google.spanner.v1.RequestOptions
Namespace
Google \ Cloud \ Spanner \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ priority
int
Priority for the request.
↳ request_tag
string
A per-request tag which can be applied to queries or reads, used for statistics collection. Both request_tag and transaction_tag can be specified for a read or query that belongs to a transaction. This field is ignored for requests where it's not applicable (e.g. CommitRequest). Legal characters for request_tag values are all printable characters (ASCII 32 - 126) and the length of a request_tag is limited to 50 characters. Values that exceed this limit are truncated. Any leading underscore (_) characters will be removed from the string.
↳ transaction_tag
string
A tag used for statistics collection about this transaction. Both request_tag and transaction_tag can be specified for a read or query that belongs to a transaction. The value of transaction_tag should be the same for all requests belonging to the same transaction. If this request doesn't belong to any transaction, transaction_tag will be ignored. Legal characters for transaction_tag values are all printable characters (ASCII 32 - 126) and the length of a transaction_tag is limited to 50 characters. Values that exceed this limit are truncated. Any leading underscore (_) characters will be removed from the string.
getPriority
Priority for the request.
Returns
Type
Description
int
setPriority
Priority for the request.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getRequestTag
A per-request tag which can be applied to queries or reads, used for
statistics collection.
Both request_tag and transaction_tag can be specified for a read or query
that belongs to a transaction.
This field is ignored for requests where it's not applicable (e.g.
CommitRequest).
Legal characters for request_tag values are all printable characters
(ASCII 32 - 126) and the length of a request_tag is limited to 50
characters. Values that exceed this limit are truncated.
Any leading underscore (_) characters will be removed from the string.
Returns
Type
Description
string
setRequestTag
A per-request tag which can be applied to queries or reads, used for
statistics collection.
Both request_tag and transaction_tag can be specified for a read or query
that belongs to a transaction.
This field is ignored for requests where it's not applicable (e.g.
CommitRequest).
Legal characters for request_tag values are all printable characters
(ASCII 32 - 126) and the length of a request_tag is limited to 50
characters. Values that exceed this limit are truncated.
Any leading underscore (_) characters will be removed from the string.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getTransactionTag
A tag used for statistics collection about this transaction.
Both request_tag and transaction_tag can be specified for a read or query
that belongs to a transaction.
The value of transaction_tag should be the same for all requests belonging
to the same transaction.
If this request doesn't belong to any transaction, transaction_tag will be
ignored.
Legal characters for transaction_tag values are all printable characters
(ASCII 32 - 126) and the length of a transaction_tag is limited to 50
characters. Values that exceed this limit are truncated.
Any leading underscore (_) characters will be removed from the string.
Returns
Type
Description
string
setTransactionTag
A tag used for statistics collection about this transaction.
Both request_tag and transaction_tag can be specified for a read or query
that belongs to a transaction.
The value of transaction_tag should be the same for all requests belonging
to the same transaction.
If this request doesn't belong to any transaction, transaction_tag will be
ignored.
Legal characters for transaction_tag values are all printable characters
(ASCII 32 - 126) and the length of a transaction_tag is limited to 50
characters. Values that exceed this limit are truncated.
Any leading underscore (_) characters will be removed from the string.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Cloud Spanner V1 Client - Class RequestOptions (1.104.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.104.0 (latest)](/php/docs/reference/cloud-spanner/latest/V1.RequestOptions)\n- [1.103.0](/php/docs/reference/cloud-spanner/1.103.0/V1.RequestOptions)\n- [1.102.0](/php/docs/reference/cloud-spanner/1.102.0/V1.RequestOptions)\n- [1.101.0](/php/docs/reference/cloud-spanner/1.101.0/V1.RequestOptions)\n- [1.100.0](/php/docs/reference/cloud-spanner/1.100.0/V1.RequestOptions)\n- [1.98.0](/php/docs/reference/cloud-spanner/1.98.0/V1.RequestOptions)\n- [1.97.0](/php/docs/reference/cloud-spanner/1.97.0/V1.RequestOptions)\n- [1.96.0](/php/docs/reference/cloud-spanner/1.96.0/V1.RequestOptions)\n- [1.95.0](/php/docs/reference/cloud-spanner/1.95.0/V1.RequestOptions)\n- [1.94.0](/php/docs/reference/cloud-spanner/1.94.0/V1.RequestOptions)\n- [1.93.1](/php/docs/reference/cloud-spanner/1.93.1/V1.RequestOptions)\n- [1.92.1](/php/docs/reference/cloud-spanner/1.92.1/V1.RequestOptions)\n- [1.91.0](/php/docs/reference/cloud-spanner/1.91.0/V1.RequestOptions)\n- [1.90.0](/php/docs/reference/cloud-spanner/1.90.0/V1.RequestOptions)\n- [1.89.0](/php/docs/reference/cloud-spanner/1.89.0/V1.RequestOptions)\n- [1.88.0](/php/docs/reference/cloud-spanner/1.88.0/V1.RequestOptions)\n- [1.87.0](/php/docs/reference/cloud-spanner/1.87.0/V1.RequestOptions)\n- [1.86.0](/php/docs/reference/cloud-spanner/1.86.0/V1.RequestOptions)\n- [1.85.0](/php/docs/reference/cloud-spanner/1.85.0/V1.RequestOptions)\n- [1.84.0](/php/docs/reference/cloud-spanner/1.84.0/V1.RequestOptions)\n- [1.83.0](/php/docs/reference/cloud-spanner/1.83.0/V1.RequestOptions)\n- [1.82.0](/php/docs/reference/cloud-spanner/1.82.0/V1.RequestOptions)\n- [1.81.0](/php/docs/reference/cloud-spanner/1.81.0/V1.RequestOptions)\n- [1.80.0](/php/docs/reference/cloud-spanner/1.80.0/V1.RequestOptions)\n- [1.79.0](/php/docs/reference/cloud-spanner/1.79.0/V1.RequestOptions)\n- [1.78.0](/php/docs/reference/cloud-spanner/1.78.0/V1.RequestOptions)\n- [1.77.0](/php/docs/reference/cloud-spanner/1.77.0/V1.RequestOptions)\n- [1.76.1](/php/docs/reference/cloud-spanner/1.76.1/V1.RequestOptions)\n- [1.68.0](/php/docs/reference/cloud-spanner/1.68.0/V1.RequestOptions)\n- [1.67.0](/php/docs/reference/cloud-spanner/1.67.0/V1.RequestOptions)\n- [1.66.0](/php/docs/reference/cloud-spanner/1.66.0/V1.RequestOptions)\n- [1.65.0](/php/docs/reference/cloud-spanner/1.65.0/V1.RequestOptions)\n- [1.64.0](/php/docs/reference/cloud-spanner/1.64.0/V1.RequestOptions)\n- [1.63.2](/php/docs/reference/cloud-spanner/1.63.2/V1.RequestOptions)\n- [1.62.1](/php/docs/reference/cloud-spanner/1.62.1/V1.RequestOptions)\n- [1.61.0](/php/docs/reference/cloud-spanner/1.61.0/V1.RequestOptions)\n- [1.60.0](/php/docs/reference/cloud-spanner/1.60.0/V1.RequestOptions)\n- [1.59.0](/php/docs/reference/cloud-spanner/1.59.0/V1.RequestOptions)\n- [1.58.4](/php/docs/reference/cloud-spanner/1.58.4/V1.RequestOptions)\n- [1.57.0](/php/docs/reference/cloud-spanner/1.57.0/V1.RequestOptions)\n- [1.56.0](/php/docs/reference/cloud-spanner/1.56.0/V1.RequestOptions)\n- [1.55.0](/php/docs/reference/cloud-spanner/1.55.0/V1.RequestOptions)\n- [1.54.2](/php/docs/reference/cloud-spanner/1.54.2/V1.RequestOptions) \nReference documentation and code samples for the Cloud Spanner V1 Client class RequestOptions.\n\nCommon request options for various APIs.\n\nGenerated from protobuf message `google.spanner.v1.RequestOptions`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Spanner \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getPriority\n\nPriority for the request.\n\n### setPriority\n\nPriority for the request.\n\n### getRequestTag\n\nA per-request tag which can be applied to queries or reads, used for\nstatistics collection.\n\nBoth request_tag and transaction_tag can be specified for a read or query\nthat belongs to a transaction.\nThis field is ignored for requests where it's not applicable (e.g.\nCommitRequest).\nLegal characters for `request_tag` values are all printable characters\n(ASCII 32 - 126) and the length of a request_tag is limited to 50\ncharacters. Values that exceed this limit are truncated.\nAny leading underscore (_) characters will be removed from the string.\n\n### setRequestTag\n\nA per-request tag which can be applied to queries or reads, used for\nstatistics collection.\n\nBoth request_tag and transaction_tag can be specified for a read or query\nthat belongs to a transaction.\nThis field is ignored for requests where it's not applicable (e.g.\nCommitRequest).\nLegal characters for `request_tag` values are all printable characters\n(ASCII 32 - 126) and the length of a request_tag is limited to 50\ncharacters. Values that exceed this limit are truncated.\nAny leading underscore (_) characters will be removed from the string.\n\n### getTransactionTag\n\nA tag used for statistics collection about this transaction.\n\nBoth request_tag and transaction_tag can be specified for a read or query\nthat belongs to a transaction.\nThe value of transaction_tag should be the same for all requests belonging\nto the same transaction.\nIf this request doesn't belong to any transaction, transaction_tag will be\nignored.\nLegal characters for `transaction_tag` values are all printable characters\n(ASCII 32 - 126) and the length of a transaction_tag is limited to 50\ncharacters. Values that exceed this limit are truncated.\nAny leading underscore (_) characters will be removed from the string.\n\n### setTransactionTag\n\nA tag used for statistics collection about this transaction.\n\nBoth request_tag and transaction_tag can be specified for a read or query\nthat belongs to a transaction.\nThe value of transaction_tag should be the same for all requests belonging\nto the same transaction.\nIf this request doesn't belong to any transaction, transaction_tag will be\nignored.\nLegal characters for `transaction_tag` values are all printable characters\n(ASCII 32 - 126) and the length of a transaction_tag is limited to 50\ncharacters. Values that exceed this limit are truncated.\nAny leading underscore (_) characters will be removed from the string."]]
