Class ProjectsResource.InstancesResource.ListRequest

Lists all instances in the given project.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<ListInstancesResponse>
SpannerBaseServiceRequest<ListInstancesResponse>
ProjectsResource.InstancesResource.ListRequest
Implements
Inherited Members
Namespace: Google.Apis.Spanner.v1
Assembly: Google.Apis.Spanner.v1.dll
Syntax
public class ProjectsResource.InstancesResource.ListRequest : SpannerBaseServiceRequest<ListInstancesResponse>, IClientServiceRequest<ListInstancesResponse>, IClientServiceRequest

Constructors

ListRequest(IClientService, string)

Constructs a new List request.

Declaration
public ListRequest(IClientService service, string parent)
Parameters
Type Name Description
IClientService service
string parent

Properties

Filter

An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * name * display_name * labels.key where key is the name of a label Some examples of using filters are: * name:* --&gt; The instance has a name. * name:Howl --&gt; The instance's name contains the string "howl". * name:HOWL --&gt; Equivalent to above. * NAME:howl --&gt; Equivalent to above. * labels.env:* --&gt; The instance has the label "env". * labels.env:dev --&gt; The instance has the label "env" and the value of the label contains the string "dev". * name:howl labels.env:dev --&gt; The instance's name contains "howl" and it has the label "env" with its value containing "dev".

Declaration
[RequestParameter("filter", RequestParameterType.Query)]
public virtual string Filter { get; set; }
Property Value
Type Description
string

HttpMethod

Gets the HTTP method.

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

InstanceDeadline

Deadline used while retrieving metadata for instances. Instances whose metadata cannot be retrieved within this deadline will be added to unreachable in ListInstancesResponse.

Declaration
[RequestParameter("instanceDeadline", RequestParameterType.Query)]
public virtual object InstanceDeadline { get; set; }
Property Value
Type Description
object

MethodName

Gets the method name.

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

PageSize

Number of instances 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
int?

PageToken

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

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

Parent

Required. The name of the project for which a list of instances is requested. Values are of the form projects/.

Declaration
[RequestParameter("parent", RequestParameterType.Path)]
public virtual string Parent { get; }
Property Value
Type Description
string

RestPath

Gets the REST path.

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

Methods

InitParameters()

Initializes List parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements