Show / Hide Table of Contents

Class InstancesResource.ListRequest

Lists instances under a given project.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<InstancesListResponse>
SQLAdminBaseServiceRequest<InstancesListResponse>
InstancesResource.ListRequest
Implements
IClientServiceRequest<InstancesListResponse>
IClientServiceRequest
Inherited Members
SQLAdminBaseServiceRequest<InstancesListResponse>.Xgafv
SQLAdminBaseServiceRequest<InstancesListResponse>.AccessToken
SQLAdminBaseServiceRequest<InstancesListResponse>.Alt
SQLAdminBaseServiceRequest<InstancesListResponse>.Callback
SQLAdminBaseServiceRequest<InstancesListResponse>.Fields
SQLAdminBaseServiceRequest<InstancesListResponse>.Key
SQLAdminBaseServiceRequest<InstancesListResponse>.OauthToken
SQLAdminBaseServiceRequest<InstancesListResponse>.PrettyPrint
SQLAdminBaseServiceRequest<InstancesListResponse>.QuotaUser
SQLAdminBaseServiceRequest<InstancesListResponse>.UploadType
SQLAdminBaseServiceRequest<InstancesListResponse>.UploadProtocol
ClientServiceRequest<InstancesListResponse>.Execute()
ClientServiceRequest<InstancesListResponse>.ExecuteAsStream()
ClientServiceRequest<InstancesListResponse>.ExecuteAsync()
ClientServiceRequest<InstancesListResponse>.ExecuteAsync(CancellationToken)
ClientServiceRequest<InstancesListResponse>.ExecuteAsStreamAsync()
ClientServiceRequest<InstancesListResponse>.ExecuteAsStreamAsync(CancellationToken)
ClientServiceRequest<InstancesListResponse>.CreateRequest(bool?)
ClientServiceRequest<InstancesListResponse>.GenerateRequestUri()
ClientServiceRequest<InstancesListResponse>.GetBody()
ClientServiceRequest<InstancesListResponse>.GetDefaultETagAction(string)
ClientServiceRequest<InstancesListResponse>.ETagAction
ClientServiceRequest<InstancesListResponse>.ModifyRequest
ClientServiceRequest<InstancesListResponse>.ValidateParameters
ClientServiceRequest<InstancesListResponse>.ApiVersion
ClientServiceRequest<InstancesListResponse>.RequestParameters
ClientServiceRequest<InstancesListResponse>.Service
ClientServiceRequest._unsuccessfulResponseHandlers
ClientServiceRequest._exceptionHandlers
ClientServiceRequest._executeInterceptors
ClientServiceRequest.AddUnsuccessfulResponseHandler(IHttpUnsuccessfulResponseHandler)
ClientServiceRequest.AddExceptionHandler(IHttpExceptionHandler)
ClientServiceRequest.AddExecuteInterceptor(IHttpExecuteInterceptor)
ClientServiceRequest.Credential
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.SQLAdmin.v1beta4
Assembly: Google.Apis.SQLAdmin.v1beta4.dll
Syntax
public class InstancesResource.ListRequest : SQLAdminBaseServiceRequest<InstancesListResponse>, IClientServiceRequest<InstancesListResponse>, IClientServiceRequest

Constructors

ListRequest(IClientService, string)

Constructs a new List request.

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

Properties

Filter

A filter expression that filters resources listed in the response. The expression is in the form of field:value. For example, 'instanceType:CLOUD_SQL_INSTANCE'. Fields can be nested as needed as per their JSON representation, such as 'settings.userLabels.auto_start:true'. Multiple filter queries are space-separated. For example. 'state:RUNNABLE instanceType:CLOUD_SQL_INSTANCE'. By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly.

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
ClientServiceRequest<InstancesListResponse>.HttpMethod

MaxResults

The maximum number of instances to return. The service may return fewer than this value. If unspecified, at most 500 instances are returned. The maximum value is 1000; values above 1000 are coerced to 1000.

Declaration
[RequestParameter("maxResults", RequestParameterType.Query)]
public virtual long? MaxResults { get; set; }
Property Value
Type Description
long?

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides
ClientServiceRequest<InstancesListResponse>.MethodName

PageToken

A previously-returned page token representing part of the larger set of results to view.

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

Project

Project ID of the project for which to list Cloud SQL instances.

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

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides
ClientServiceRequest<InstancesListResponse>.RestPath

Methods

InitParameters()

Initializes List parameter list.

Declaration
protected override void InitParameters()
Overrides
SQLAdminBaseServiceRequest<InstancesListResponse>.InitParameters()

Implements

IClientServiceRequest<TResponse>
IClientServiceRequest
In this article
Back to top Generated by DocFX