Cloud Bigtable V2 Client - Class PrepareQueryResponse (2.9.0)

Reference documentation and code samples for the Cloud Bigtable V2 Client class PrepareQueryResponse.

Response message for Bigtable.PrepareQueryResponse

Generated from protobuf message google.bigtable.v2.PrepareQueryResponse

Namespace

Google \ Cloud \ Bigtable \ V2

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ metadata ResultSetMetadata

Structure of rows in the response stream of ExecuteQueryResponse for the returned prepared_query.

↳ prepared_query string

A serialized prepared query. Clients should treat this as an opaque blob of bytes to send in ExecuteQueryRequest.

↳ valid_until Google\Protobuf\Timestamp

The time at which the prepared query token becomes invalid. A token may become invalid early due to changes in the data being read, but it provides a guideline to refresh query plans asynchronously.

getMetadata

Structure of rows in the response stream of ExecuteQueryResponse for the returned prepared_query.

Returns
Type Description
ResultSetMetadata|null

hasMetadata

clearMetadata

setMetadata

Structure of rows in the response stream of ExecuteQueryResponse for the returned prepared_query.

Parameter
Name Description
var ResultSetMetadata
Returns
Type Description
$this

getPreparedQuery

A serialized prepared query. Clients should treat this as an opaque blob of bytes to send in ExecuteQueryRequest.

Returns
Type Description
string

setPreparedQuery

A serialized prepared query. Clients should treat this as an opaque blob of bytes to send in ExecuteQueryRequest.

Parameter
Name Description
var string
Returns
Type Description
$this

getValidUntil

The time at which the prepared query token becomes invalid.

A token may become invalid early due to changes in the data being read, but it provides a guideline to refresh query plans asynchronously.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasValidUntil

clearValidUntil

setValidUntil

The time at which the prepared query token becomes invalid.

A token may become invalid early due to changes in the data being read, but it provides a guideline to refresh query plans asynchronously.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this