Google Cloud Gemini Data Analytics V1beta Client - Class ExecutedQueryResult (0.5.0)

Reference documentation and code samples for the Google Cloud Gemini Data Analytics V1beta Client class ExecutedQueryResult.

The result of a query execution. The design is generic for all dialects.

Generated from protobuf message google.cloud.geminidataanalytics.v1beta.ExecutedQueryResult

Namespace

Google \ Cloud \ GeminiDataAnalytics \ V1beta

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ columns array<ExecutedQueryResult\Column>

The columns in the result set, in order.

↳ rows array<ExecutedQueryResult\Row>

The rows returned by the query.

↳ total_row_count int|string

The total number of rows in the full result set, if known. This may be an estimate or an exact count.

↳ partial_result bool

Set to true if the returned rows in query_result are a subset of the full result. This can happen, for example, if the query execution hits a row limit. When true, the query_result does not contain all rows. To retrieve the complete result, consider using the generated_query in QueryDataResponse and executing it in your own environment.

↳ query_execution_error string

The error message if the query execution failed.

getColumns

The columns in the result set, in order.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setColumns

The columns in the result set, in order.

Parameter
Name Description
var array<ExecutedQueryResult\Column>
Returns
Type Description
$this

getRows

The rows returned by the query.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setRows

The rows returned by the query.

Parameter
Name Description
var array<ExecutedQueryResult\Row>
Returns
Type Description
$this

getTotalRowCount

The total number of rows in the full result set, if known.

This may be an estimate or an exact count.

Returns
Type Description
int|string

setTotalRowCount

The total number of rows in the full result set, if known.

This may be an estimate or an exact count.

Parameter
Name Description
var int|string
Returns
Type Description
$this

getPartialResult

Set to true if the returned rows in query_result are a subset of the full result. This can happen, for example, if the query execution hits a row limit. When true, the query_result does not contain all rows. To retrieve the complete result, consider using the generated_query in QueryDataResponse and executing it in your own environment.

Returns
Type Description
bool

setPartialResult

Set to true if the returned rows in query_result are a subset of the full result. This can happen, for example, if the query execution hits a row limit. When true, the query_result does not contain all rows. To retrieve the complete result, consider using the generated_query in QueryDataResponse and executing it in your own environment.

Parameter
Name Description
var bool
Returns
Type Description
$this

getQueryExecutionError

The error message if the query execution failed.

Returns
Type Description
string

setQueryExecutionError

The error message if the query execution failed.

Parameter
Name Description
var string
Returns
Type Description
$this