Cloud Spanner V1 Client - Class ListSessionsRequest (1.54.2)

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

The request for ListSessions .

Generated from protobuf message google.spanner.v1.ListSessionsRequest

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ database
string

Required. The database in which to list sessions.

↳ page_size
int

Number of sessions to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.

↳ page_token
string

If non-empty, page_token should contain a next_page_token from a previous ListSessionsResponse .

↳ filter
string

An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * labels.key where key is the name of a label Some examples of using filters are: * labels.env:* --> The session has the label "env". * labels.env:dev --> The session has the label "env" and the value of the label contains the string "dev".

getDatabase

Required. The database in which to list sessions.

Generated from protobuf field string database = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

Returns
Type
Description
string

setDatabase

Required. The database in which to list sessions.

Generated from protobuf field string database = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getPageSize

Number of sessions to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.

Generated from protobuf field int32 page_size = 2;

Returns
Type
Description
int

setPageSize

Number of sessions to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.

Generated from protobuf field int32 page_size = 2;

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getPageToken

If non-empty, page_token should contain a next_page_token from a previous ListSessionsResponse .

Generated from protobuf field string page_token = 3;

Returns
Type
Description
string

setPageToken

If non-empty, page_token should contain a next_page_token from a previous ListSessionsResponse .

Generated from protobuf field string page_token = 3;

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getFilter

An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are:

  • labels.key where key is the name of a label Some examples of using filters are:
  • labels.env:* --> The session has the label "env".
  • labels.env:dev --> The session has the label "env" and the value of the label contains the string "dev".

Generated from protobuf field string filter = 4;

Returns
Type
Description
string

setFilter

An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are:

  • labels.key where key is the name of a label Some examples of using filters are:
  • labels.env:* --> The session has the label "env".
  • labels.env:dev --> The session has the label "env" and the value of the label contains the string "dev".

Generated from protobuf field string filter = 4;

Parameter
Name
Description
var
string
Returns
Type
Description
$this
Design a Mobile Site
View Site in Mobile | Classic
Share by: