Class ProjectsResource.InstancesResource.DatabasesResource.SessionsResource.ListRequest

Lists all sessions in a given database.

Inheritance
System.Object
ClientServiceRequest
ClientServiceRequest<ListSessionsResponse>
SpannerBaseServiceRequest<ListSessionsResponse>
ProjectsResource.InstancesResource.DatabasesResource.SessionsResource.ListRequest
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Google.Apis.Spanner.v1
Assembly: Google.Apis.Spanner.v1.dll
Syntax
public class ListRequest : SpannerBaseServiceRequest<ListSessionsResponse>, IClientServiceRequest<ListSessionsResponse>, IClientServiceRequest

Constructors

ListRequest(IClientService, String)

Constructs a new List request.

Declaration
public ListRequest(IClientService service, string database)
Parameters
Type Name Description
IClientService service
System.String database

Properties

Database

Required. The database in which to list sessions.

Declaration
[RequestParameter("database", RequestParameterType.Path)]
public virtual string Database { get; }
Property Value
Type Description
System.String

Filter

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:* --&gt; The session has the label "env".

  • labels.env:dev --&gt; The session has the label "env" and the value of the label contains the string "dev".
Declaration
[RequestParameter("filter", RequestParameterType.Query)]
public virtual string Filter { get; set; }
Property Value
Type Description
System.String

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
System.String
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Spanner.v1.Data.ListSessionsResponse>.HttpMethod

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
System.String
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Spanner.v1.Data.ListSessionsResponse>.MethodName

PageSize

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

Declaration
[RequestParameter("pageSize", RequestParameterType.Query)]
public virtual int? PageSize { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

PageToken

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

Declaration
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; set; }
Property Value
Type Description
System.String

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
System.String
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Spanner.v1.Data.ListSessionsResponse>.RestPath

Methods

InitParameters()

Initializes List parameter list.

Declaration
protected override void InitParameters()
Overrides
Google.Apis.Spanner.v1.SpannerBaseServiceRequest<Google.Apis.Spanner.v1.Data.ListSessionsResponse>.InitParameters()

Implements