- 2.0.1-RC1 (latest)
- 2.0.0-RC1
- 1.106.0
- 1.105.1
- 1.104.1
- 1.103.0
- 1.102.0
- 1.101.0
- 1.100.0
- 1.98.0
- 1.97.0
- 1.96.0
- 1.95.0
- 1.94.0
- 1.93.1
- 1.92.1
- 1.91.0
- 1.90.0
- 1.89.0
- 1.88.0
- 1.87.0
- 1.86.0
- 1.85.0
- 1.84.0
- 1.83.0
- 1.82.0
- 1.81.0
- 1.80.0
- 1.79.0
- 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 ListSessionsRequest.
The request for ListSessions.
Generated from protobuf message google.spanner.v1.ListSessionsRequest
Namespace
Google \ Cloud \ Spanner \ V1Methods
__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, |
↳ filter |
string
An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * * |
getDatabase
Required. The database in which to list sessions.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDatabase
Required. The database in which to list sessions.
| 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.
| 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.
| 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.
| Returns | |
|---|---|
| Type | Description |
string |
|
setPageToken
If non-empty, page_token should contain a
next_page_token
from a previous
ListSessionsResponse.
| 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.keywhere 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".
| 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.keywhere 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".
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
static::build
| Parameter | |
|---|---|
| Name | Description |
database |
string
Required. The database in which to list sessions. Please see SpannerClient::databaseName() for help formatting this field. |
| Returns | |
|---|---|
| Type | Description |
ListSessionsRequest |
|