Class: Google::Spanner::V1::ListSessionsRequest

Inherits:

Object

• Object
• Google::Spanner::V1::ListSessionsRequest

Defined in:

lib/google/cloud/spanner/v1/doc/google/spanner/v1/spanner.rb

Overview

The request for ListSessions.

Instance Attribute Summary

• #database ⇒ String

  Required.

• #filter ⇒ String

  An expression for filtering the results of the request.

• #page_size ⇒ Integer

  Number of sessions to be returned in the response.

• #page_token ⇒ String

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

Instance Attribute Details

#database ⇒ String

Returns Required. The database in which to list sessions.

Returns:

• (String) —

  Required. The database in which to list sessions.

# File 'lib/google/cloud/spanner/v1/doc/google/spanner/v1/spanner.rb', line 84

class ListSessionsRequest; end

#filter ⇒ String

Returns 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".

Returns:

• (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".

# File 'lib/google/cloud/spanner/v1/doc/google/spanner/v1/spanner.rb', line 84

class ListSessionsRequest; end

#page_size ⇒ Integer

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

Returns:

• (Integer) —

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

# File 'lib/google/cloud/spanner/v1/doc/google/spanner/v1/spanner.rb', line 84

class ListSessionsRequest; end

#page_token ⇒ String

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

Returns:

• (String) —

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

# File 'lib/google/cloud/spanner/v1/doc/google/spanner/v1/spanner.rb', line 84

class ListSessionsRequest; end