Class ProjectsResource.RegionsResource.ClustersResource.ListRequest

Lists all regions/{region}/clusters in a project alphabetically.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<ListClustersResponse>
DataprocBaseServiceRequest<ListClustersResponse>
ProjectsResource.RegionsResource.ClustersResource.ListRequest
Implements
Inherited Members
Namespace: Google.Apis.Dataproc.v1
Assembly: Google.Apis.Dataproc.v1.dll
Syntax
public class ProjectsResource.RegionsResource.ClustersResource.ListRequest : DataprocBaseServiceRequest<ListClustersResponse>, IClientServiceRequest<ListClustersResponse>, IClientServiceRequest

Constructors

ListRequest(IClientService, string, string)

Constructs a new List request.

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

Properties

Filter

Optional. A filter constraining the clusters to list. Filters are case-sensitive and have the following syntax:field = value AND field = value ...where field is one of status.state, clusterName, or labels.[KEY], and [KEY] is a label key. value can be * to match all values. status.state can be one of the following: ACTIVE, INACTIVE, CREATING, RUNNING, ERROR, DELETING, UPDATING, STOPPING, or STOPPED. ACTIVE contains the CREATING, UPDATING, and RUNNING states. INACTIVE contains the DELETING, ERROR, STOPPING, and STOPPED states. clusterName is the name of the cluster provided at creation time. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.Example filter:status.state = ACTIVE AND clusterName = mycluster AND labels.env = staging AND labels.starred = *

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

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides

PageSize

Optional. The maximum number of clusters to return in each response. The service may return fewer than this value. If unspecified, the default value is 200. The maximum value is 1000.

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

PageToken

Optional. A page token received from a previous ListClusters call. Provide this token to retrieve the subsequent page.

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

ProjectId

Required. The ID of the Google Cloud Platform project that the cluster belongs to.

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

Region

Required. The Dataproc region in which to handle the request.

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

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides

Methods

InitParameters()

Initializes List parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements