Google Cloud Spanner v1 API - Class ListSessionsRequest (4.5.0)

public sealed class ListSessionsRequest : IMessage<ListSessionsRequest>, IEquatable<ListSessionsRequest>, IDeepCloneable<ListSessionsRequest>, IBufferMessage, IMessage, IPageRequest

Reference documentation and code samples for the Google Cloud Spanner v1 API class ListSessionsRequest.

The request for [ListSessions][google.spanner.v1.Spanner.ListSessions].

Inheritance

object > ListSessionsRequest

Namespace

Google.Cloud.Spanner.V1

Assembly

Google.Cloud.Spanner.V1.dll

Constructors

ListSessionsRequest()

public ListSessionsRequest()

ListSessionsRequest(ListSessionsRequest)

public ListSessionsRequest(ListSessionsRequest other)
Parameter
NameDescription
otherListSessionsRequest

Properties

Database

public string Database { get; set; }

Required. The database in which to list sessions.

Property Value
TypeDescription
string

DatabaseAsDatabaseName

public DatabaseName DatabaseAsDatabaseName { get; set; }

Google.Cloud.Spanner.Common.V1.DatabaseName-typed view over the Database resource name property.

Property Value
TypeDescription
Google.Cloud.Spanner.Common.V1.DatabaseName

Filter

public string Filter { get; set; }

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".
Property Value
TypeDescription
string

PageSize

public int PageSize { get; set; }

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

Property Value
TypeDescription
int

PageToken

public string PageToken { get; set; }

If non-empty, page_token should contain a [next_page_token][google.spanner.v1.ListSessionsResponse.next_page_token] from a previous [ListSessionsResponse][google.spanner.v1.ListSessionsResponse].

Property Value
TypeDescription
string