com.google.cloud.dataproc.v1

Interface ListClustersRequestOrBuilder

All Superinterfaces:

MessageLiteOrBuilder, MessageOrBuilder

All Known Implementing Classes:

ListClustersRequest, ListClustersRequest.Builder

public interface ListClustersRequestOrBuilder
extends MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getFilter() Optional.
ByteString	getFilterBytes() Optional.
int	getPageSize() Optional.
String	getPageToken() Optional.
ByteString	getPageTokenBytes() Optional.
String	getProjectId() Required.
ByteString	getProjectIdBytes() Required.
String	getRegion() Required.
ByteString	getRegionBytes() Required.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getProjectId

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];

Returns:

The projectId.

getProjectIdBytes

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];

Returns:

The bytes for projectId.

getRegion

String getRegion()

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

string region = 4 [(.google.api.field_behavior) = REQUIRED];

Returns:

The region.

getRegionBytes

ByteString getRegionBytes()

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

string region = 4 [(.google.api.field_behavior) = REQUIRED];

Returns:

The bytes for region.

getFilter

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];

Returns:

The filter.

getFilterBytes

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];

Returns:

The bytes for filter.

getPageSize

int getPageSize()

 Optional. The standard List page size.
 

int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The pageSize.

getPageToken

String getPageToken()

 Optional. The standard List page token.
 

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The pageToken.

getPageTokenBytes

ByteString getPageTokenBytes()

 Optional. The standard List page token.
 

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The bytes for pageToken.