Method: googleapis.spanner.v1.projects.instances.databases.sessions.list

Lists all sessions in a given database.

For more information about retries and long-running operations, see Understand connectors.

Arguments

Parameters
`database`	`string` Required. The database in which to list sessions.
`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".
`pageSize`	`integer (int32 format)` Number of sessions to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
`pageToken`	`string` If non-empty, `page_token` should contain a next_page_token from a previous ListSessionsResponse.

Raised exceptions

Exceptions
`ConnectionError`	In case of a network problem (such as DNS failure or refused connection).
`HttpError`	If the response status is >= 400 (excluding 429 and 503).
`TimeoutError`	If a long-running operation takes longer to finish than the specified timeout limit.
`TypeError`	If an operation or function receives an argument of the wrong type.
`ValueError`	If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout.

Response

If successful, the response contains an instance of ListSessionsResponse.

Subworkflow snippet

Some fields might be optional or required. To identify required fields, refer to the API documentation.

YAML

- list:
    call: googleapis.spanner.v1.projects.instances.databases.sessions.list
    args:
        database: ...
        filter: ...
        pageSize: ...
        pageToken: ...
    result: listResult

JSON

[
  {
    "list": {
      "call": "googleapis.spanner.v1.projects.instances.databases.sessions.list",
      "args": {
        "database": "...",
        "filter": "...",
        "pageSize": "...",
        "pageToken": "..."
      },
      "result": "listResult"
    }
  }
]