public interface ListClustersRequestOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getFilter()
public abstract String getFilter() 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 = *
string filter = 5 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| String | The filter. |
getFilterBytes()
public abstract ByteString getFilterBytes() 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 = *
string filter = 5 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| ByteString | The bytes for filter. |
getPageSize()
public abstract int getPageSize()Optional. The standard List page size.
int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| int | The pageSize. |
getPageToken()
public abstract String getPageToken()Optional. The standard List page token.
string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| String | The pageToken. |
getPageTokenBytes()
public abstract ByteString getPageTokenBytes()Optional. The standard List page token.
string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| ByteString | The bytes for pageToken. |
getProjectId()
public abstract String getProjectId()Required. The ID of the Google Cloud Platform project that the cluster belongs to.
string project_id = 1 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| String | The projectId. |
getProjectIdBytes()
public abstract ByteString getProjectIdBytes()Required. The ID of the Google Cloud Platform project that the cluster belongs to.
string project_id = 1 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| ByteString | The bytes for projectId. |
getRegion()
public abstract String getRegion()Required. The Dataproc region in which to handle the request.
string region = 4 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| String | The region. |
getRegionBytes()
public abstract ByteString getRegionBytes()Required. The Dataproc region in which to handle the request.
string region = 4 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| ByteString | The bytes for region. |