Cloud Spanner V1 Client - Class BatchCreateSessionsRequest (1.76.0)

Version 1.76.0

• 1.79.0 (latest)
• 1.78.0
• 1.77.0
• 1.76.1
• 1.68.0
• 1.67.0
• 1.66.0
• 1.65.0
• 1.64.0
• 1.63.2
• 1.62.1
• 1.61.0
• 1.60.0
• 1.59.0
• 1.58.4
• 1.57.0
• 1.56.0
• 1.55.0
• 1.54.2

Reference documentation and code samples for the Cloud Spanner V1 Client class BatchCreateSessionsRequest.

The request for BatchCreateSessions.

Generated from protobuf message google.spanner.v1.BatchCreateSessionsRequest

Namespace

Google \ Cloud \ Spanner \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ database	string Required. The database in which the new sessions are created.
↳ session_template	Google\Cloud\Spanner\V1\Session Parameters to be applied to each created session.
↳ session_count	int Required. The number of sessions to be created in this batch call. The API may return fewer than the requested number of sessions. If a specific number of sessions are desired, the client can make additional calls to BatchCreateSessions (adjusting session_count as necessary).

getDatabase

Required. The database in which the new sessions are created.

Returns
Type	Description
string

setDatabase

Required. The database in which the new sessions are created.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getSessionTemplate

Parameters to be applied to each created session.

Returns
Type	Description
Google\Cloud\Spanner\V1\Session|null

hasSessionTemplate

clearSessionTemplate

setSessionTemplate

Parameters to be applied to each created session.

Parameter
Name	Description
var	Google\Cloud\Spanner\V1\Session

Returns
Type	Description
$this

getSessionCount

Required. The number of sessions to be created in this batch call.

The API may return fewer than the requested number of sessions. If a specific number of sessions are desired, the client can make additional calls to BatchCreateSessions (adjusting session_count as necessary).

Returns
Type	Description
int

setSessionCount

Required. The number of sessions to be created in this batch call.

The API may return fewer than the requested number of sessions. If a specific number of sessions are desired, the client can make additional calls to BatchCreateSessions (adjusting session_count as necessary).

Parameter
Name	Description
var	int

Returns
Type	Description
$this

static::build

Parameters
Name	Description
database	string Required. The database in which the new sessions are created. Please see Google\Cloud\Spanner\V1\SpannerClient::databaseName() for help formatting this field.
sessionCount	int Required. The number of sessions to be created in this batch call. The API may return fewer than the requested number of sessions. If a specific number of sessions are desired, the client can make additional calls to BatchCreateSessions (adjusting session_count as necessary).

Returns
Type	Description
Google\Cloud\Spanner\V1\BatchCreateSessionsRequest