Cloud Bigtable V2 Client - Class OpenSessionRequest (2.24.0)

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

Internal usage only.

Generated from protobuf message google.bigtable.v2.OpenSessionRequest

Namespace

Google \ Cloud \ Bigtable \ V2

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ protocol_version int|string

A version indicator from the client stating its understanding of the protocol. This is to disambiguate client behavior amidst changes in semantic usage of the API, e.g. if the structure remains the same but behavior changes.

↳ flags FeatureFlags

Client settings, including a record of

↳ consecutive_failed_connection_attempts int|string

Used for serverside observability.

↳ routing_cookie string

How the request should be routed (if presented as part of a GOAWAY from a previous session). Post V1.

↳ payload string

Can be Open{Table,AuthorizedView,MaterializedView}Request, (or in post-V1, PrepareSqlQueryRequest)

getProtocolVersion

A version indicator from the client stating its understanding of the protocol. This is to disambiguate client behavior amidst changes in semantic usage of the API, e.g. if the structure remains the same but behavior changes.

Returns
Type Description
int|string

setProtocolVersion

A version indicator from the client stating its understanding of the protocol. This is to disambiguate client behavior amidst changes in semantic usage of the API, e.g. if the structure remains the same but behavior changes.

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

getFlags

Client settings, including a record of

Returns
Type Description
FeatureFlags|null

hasFlags

clearFlags

setFlags

Client settings, including a record of

Parameter
Name Description
var FeatureFlags
Returns
Type Description
$this

getConsecutiveFailedConnectionAttempts

Used for serverside observability.

Returns
Type Description
int|string

setConsecutiveFailedConnectionAttempts

Used for serverside observability.

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

getRoutingCookie

How the request should be routed (if presented as part of a GOAWAY from a previous session). Post V1.

Returns
Type Description
string

setRoutingCookie

How the request should be routed (if presented as part of a GOAWAY from a previous session). Post V1.

Parameter
Name Description
var string
Returns
Type Description
$this

getPayload

Can be Open{Table,AuthorizedView,MaterializedView}Request, (or in post-V1, PrepareSqlQueryRequest)

Returns
Type Description
string

setPayload

Can be Open{Table,AuthorizedView,MaterializedView}Request, (or in post-V1, PrepareSqlQueryRequest)

Parameter
Name Description
var string
Returns
Type Description
$this