public sealed class ListClustersRequest : IPageRequest, IMessage<ListClustersRequest>, IEquatable<ListClustersRequest>, IDeepCloneable<ListClustersRequest>, IBufferMessage, IMessageReference documentation and code samples for the Google Cloud Dataproc v1 API class ListClustersRequest.
A request to list the clusters in a project.
Implements
IPageRequest, IMessageListClustersRequest, IEquatableListClustersRequest, IDeepCloneableListClustersRequest, IBufferMessage, IMessageNamespace
Google.Cloud.Dataproc.V1Assembly
Google.Cloud.Dataproc.V1.dll
Constructors
ListClustersRequest()
public ListClustersRequest()ListClustersRequest(ListClustersRequest)
public ListClustersRequest(ListClustersRequest other)| Parameter | |
|---|---|
| Name | Description |
other |
ListClustersRequest |
Properties
Filter
public string Filter { get; set; }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, or UPDATING. ACTIVE
contains the CREATING, UPDATING, and RUNNING states. INACTIVE
contains the DELETING and ERROR 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 = *
| Property Value | |
|---|---|
| Type | Description |
string |
|
PageSize
public int PageSize { get; set; }Optional. The standard List page size.
| Property Value | |
|---|---|
| Type | Description |
int |
|
PageToken
public string PageToken { get; set; }Optional. The standard List page token.
| Property Value | |
|---|---|
| Type | Description |
string |
|
ProjectId
public string ProjectId { get; set; }Required. The ID of the Google Cloud Platform project that the cluster belongs to.
| Property Value | |
|---|---|
| Type | Description |
string |
|
Region
public string Region { get; set; }Required. The Dataproc region in which to handle the request.
| Property Value | |
|---|---|
| Type | Description |
string |
|