public final class ListClustersRequest extends GeneratedMessageV3 implements ListClustersRequestOrBuilder
A request to list the clusters in a project.
Protobuf type google.cloud.dataproc.v1.ListClustersRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
Static Fields
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PROJECT_ID_FIELD_NUMBER
public static final int PROJECT_ID_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
REGION_FIELD_NUMBER
public static final int REGION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static ListClustersRequest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static ListClustersRequest.Builder newBuilder()
newBuilder(ListClustersRequest prototype)
public static ListClustersRequest.Builder newBuilder(ListClustersRequest prototype)
public static ListClustersRequest parseDelimitedFrom(InputStream input)
public static ListClustersRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static ListClustersRequest parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ListClustersRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static ListClustersRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListClustersRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListClustersRequest parseFrom(CodedInputStream input)
public static ListClustersRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ListClustersRequest parseFrom(InputStream input)
public static ListClustersRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static ListClustersRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ListClustersRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<ListClustersRequest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getDefaultInstanceForType()
public ListClustersRequest getDefaultInstanceForType()
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 |
|---|
| Type | Description |
ByteString | The bytes for filter.
|
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()
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 |
|---|
| Type | Description |
ByteString | The bytes for region.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public ListClustersRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ListClustersRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public ListClustersRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
