Reference documentation and code samples for the Cloud Datastore V1 Client class RunQueryResponse.
The response for Datastore.RunQuery.
Generated from protobuf message google.datastore.v1.RunQueryResponse
Namespace
Google \ Cloud \ Datastore \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ batch |
QueryResultBatch
A batch of query results (always present). |
↳ query |
Query
The parsed form of the |
↳ transaction |
string
The identifier of the transaction that was started as part of this RunQuery request. Set only when ReadOptions.new_transaction was set in RunQueryRequest.read_options. |
↳ explain_metrics |
ExplainMetrics
Query explain metrics. This is only present when the RunQueryRequest.explain_options is provided, and it is sent only once with the last response in the stream. |
getBatch
A batch of query results (always present).
| Returns | |
|---|---|
| Type | Description |
QueryResultBatch|null |
|
hasBatch
clearBatch
setBatch
A batch of query results (always present).
| Parameter | |
|---|---|
| Name | Description |
var |
QueryResultBatch
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getQuery
The parsed form of the GqlQuery from the request, if it was set.
| Returns | |
|---|---|
| Type | Description |
Query|null |
|
hasQuery
clearQuery
setQuery
The parsed form of the GqlQuery from the request, if it was set.
| Parameter | |
|---|---|
| Name | Description |
var |
Query
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTransaction
The identifier of the transaction that was started as part of this RunQuery request.
Set only when ReadOptions.new_transaction was set in RunQueryRequest.read_options.
| Returns | |
|---|---|
| Type | Description |
string |
|
setTransaction
The identifier of the transaction that was started as part of this RunQuery request.
Set only when ReadOptions.new_transaction was set in RunQueryRequest.read_options.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getExplainMetrics
Query explain metrics. This is only present when the RunQueryRequest.explain_options is provided, and it is sent only once with the last response in the stream.
| Returns | |
|---|---|
| Type | Description |
ExplainMetrics|null |
|
hasExplainMetrics
clearExplainMetrics
setExplainMetrics
Query explain metrics. This is only present when the RunQueryRequest.explain_options is provided, and it is sent only once with the last response in the stream.
| Parameter | |
|---|---|
| Name | Description |
var |
ExplainMetrics
|
| Returns | |
|---|---|
| Type | Description |
$this |
|