Class ListClustersRequest (4.4.0)
Version 4.4.0keyboard_arrow_down
public final class ListClustersRequest extends GeneratedMessageV3 implements ListClustersRequestOrBuilder
A request to list the clusters in a project.
Protobuf type google.cloud.dataproc.v1.ListClustersRequest
Static Fields
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
Field Value
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
PROJECT_ID_FIELD_NUMBER
public static final int PROJECT_ID_FIELD_NUMBER
Field Value
REGION_FIELD_NUMBER
public static final int REGION_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static ListClustersRequest getDefaultInstance ()
Returns
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
Returns
newBuilder()
public static ListClustersRequest . Builder newBuilder ()
Returns
newBuilder(ListClustersRequest prototype)
public static ListClustersRequest . Builder newBuilder ( ListClustersRequest prototype )
Parameter
Returns
public static ListClustersRequest parseDelimitedFrom ( InputStream input )
Parameter
Returns
Exceptions
public static ListClustersRequest parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static ListClustersRequest parseFrom ( byte [] data )
Parameter
Name Description
data byte []
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ListClustersRequest parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static ListClustersRequest parseFrom ( ByteString data )
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListClustersRequest parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static ListClustersRequest parseFrom ( CodedInputStream input )
Parameter
Returns
Exceptions
public static ListClustersRequest parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static ListClustersRequest parseFrom ( InputStream input )
Parameter
Returns
Exceptions
public static ListClustersRequest parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static ListClustersRequest parseFrom ( ByteBuffer data )
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ListClustersRequest parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parser()
public static Parser<ListClustersRequest> parser ()
Returns
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Returns
Overrides
getDefaultInstanceForType()
public ListClustersRequest getDefaultInstanceForType ()
Returns
getFilter()
public 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
Type Description
String The filter.
getFilterBytes()
public 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
getPageSize()
Optional. The standard List page size.
int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
int The pageSize.
getPageToken()
public String getPageToken ()
Optional. The standard List page token.
string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
String The pageToken.
getPageTokenBytes()
public ByteString getPageTokenBytes ()
Optional. The standard List page token.
string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
ByteString The bytes for pageToken.
getParserForType()
public Parser<ListClustersRequest> getParserForType ()
Returns
Overrides
getProjectId()
public 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
Type Description
String The projectId.
getProjectIdBytes()
public 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
Type Description
ByteString The bytes for projectId.
getRegion()
public String getRegion ()
Required. The Dataproc region in which to handle the request.
string region = 4 [(.google.api.field_behavior) = REQUIRED];
Returns
Type Description
String The region.
getRegionBytes()
public ByteString getRegionBytes ()
Required. The Dataproc region in which to handle the request.
string region = 4 [(.google.api.field_behavior) = REQUIRED];
Returns
getSerializedSize()
public int getSerializedSize ()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields ()
Returns
Overrides
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Returns
Overrides
isInitialized()
public final boolean isInitialized ()
Returns
Overrides
newBuilderForType()
public ListClustersRequest . Builder newBuilderForType ()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ListClustersRequest . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Parameter
Returns
Overrides
toBuilder()
public ListClustersRequest . Builder toBuilder ()
Returns
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Parameter
Overrides
Exceptions
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-28 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-28 UTC."],[],[]]
