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
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 |
↳ 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 |
getPriority
Priority for the request.
Generated from protobuf field .google.spanner.v1.RequestOptions.Priority priority = 1;
| Returns | |
|---|---|
| Type | Description |
int | |
setPriority
Priority for the request.
Generated from protobuf field .google.spanner.v1.RequestOptions.Priority priority = 1;
| 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.
Generated from protobuf field string request_tag = 2;
| 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.
Generated from protobuf field string request_tag = 2;
| 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.
Generated from protobuf field string transaction_tag = 3;
| 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.
Generated from protobuf field string transaction_tag = 3;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |