Show / Hide Table of Contents

Class ProjectsResource.LocationsResource.InstancesResource.ListRequest

Lists all Redis instances owned by a project in either the specified location (region) or all locations. The location should have the following format: * projects/{project_id}/locations/{location_id} If location_id is specified as - (wildcard), then all regions available to the project are queried, and the results are aggregated.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<ListInstancesResponse>
CloudRedisBaseServiceRequest<ListInstancesResponse>
ProjectsResource.LocationsResource.InstancesResource.ListRequest
Implements
IClientServiceRequest<ListInstancesResponse>
IClientServiceRequest
Inherited Members
CloudRedisBaseServiceRequest<ListInstancesResponse>.Xgafv
CloudRedisBaseServiceRequest<ListInstancesResponse>.AccessToken
CloudRedisBaseServiceRequest<ListInstancesResponse>.Alt
CloudRedisBaseServiceRequest<ListInstancesResponse>.Callback
CloudRedisBaseServiceRequest<ListInstancesResponse>.Fields
CloudRedisBaseServiceRequest<ListInstancesResponse>.Key
CloudRedisBaseServiceRequest<ListInstancesResponse>.OauthToken
CloudRedisBaseServiceRequest<ListInstancesResponse>.PrettyPrint
CloudRedisBaseServiceRequest<ListInstancesResponse>.QuotaUser
CloudRedisBaseServiceRequest<ListInstancesResponse>.UploadType
CloudRedisBaseServiceRequest<ListInstancesResponse>.UploadProtocol
ClientServiceRequest<ListInstancesResponse>.Execute()
ClientServiceRequest<ListInstancesResponse>.ExecuteAsStream()
ClientServiceRequest<ListInstancesResponse>.ExecuteAsync()
ClientServiceRequest<ListInstancesResponse>.ExecuteAsync(CancellationToken)
ClientServiceRequest<ListInstancesResponse>.ExecuteAsStreamAsync()
ClientServiceRequest<ListInstancesResponse>.ExecuteAsStreamAsync(CancellationToken)
ClientServiceRequest<ListInstancesResponse>.CreateRequest(bool?)
ClientServiceRequest<ListInstancesResponse>.GenerateRequestUri()
ClientServiceRequest<ListInstancesResponse>.GetBody()
ClientServiceRequest<ListInstancesResponse>.GetDefaultETagAction(string)
ClientServiceRequest<ListInstancesResponse>.ETagAction
ClientServiceRequest<ListInstancesResponse>.ModifyRequest
ClientServiceRequest<ListInstancesResponse>.ValidateParameters
ClientServiceRequest<ListInstancesResponse>.ApiVersion
ClientServiceRequest<ListInstancesResponse>.RequestParameters
ClientServiceRequest<ListInstancesResponse>.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.CloudRedis.v1
Assembly: Google.Apis.CloudRedis.v1.dll
Syntax
public class ProjectsResource.LocationsResource.InstancesResource.ListRequest : CloudRedisBaseServiceRequest<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

HttpMethod

Gets the HTTP method.

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

MethodName

Gets the method name.

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

PageSize

The maximum number of items to return. If not specified, a default value of 1000 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's next_page_token to determine if there are more instances left to be queried.

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

PageToken

The next_page_token value returned from a previous ListInstances request, if any.

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

Parent

Required. The resource name of the instance location using the form: projects/{project_id}/locations/{location_id} where location_id refers to a GCP region.

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
ClientServiceRequest<ListInstancesResponse>.RestPath

Methods

InitParameters()

Initializes List parameter list.

Declaration
protected override void InitParameters()
Overrides
CloudRedisBaseServiceRequest<ListInstancesResponse>.InitParameters()

Implements

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