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 \ V1Methods
__construct
Constructor.
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 (for example, 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 are 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. To enable tagging on a transaction, transaction_tag
must be set to the same value for all requests belonging to the same transaction, including BeginTransaction
. If this request doesn't belong to any transaction, transaction_tag
is 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 are removed from the string.
↳ client_context
getPriority
Priority for the request.
setPriority
Priority for the request.
$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 (for example, 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 are removed from the string.
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 (for example, 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 are removed from the string.
var
string
$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.
To enable tagging on a transaction, transaction_tag
must be set to the
same value for all requests belonging to the same transaction, including BeginTransaction
.
If this request doesn't belong to any transaction, transaction_tag
is
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 are removed from the string.
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.
To enable tagging on a transaction, transaction_tag
must be set to the
same value for all requests belonging to the same transaction, including BeginTransaction
.
If this request doesn't belong to any transaction, transaction_tag
is
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 are removed from the string.
var
string
$this
getClientContext
Optional. Optional context that may be needed for some requests.
hasClientContext
clearClientContext
setClientContext
Optional. Optional context that may be needed for some requests.
$this
