public final class UpdateClusterRequest extends GeneratedMessageV3 implements UpdateClusterRequestOrBuilder
A request to update a cluster.
Protobuf type google.cloud.dataproc.v1.UpdateClusterRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
Static Fields
CLUSTER_FIELD_NUMBER
public static final int CLUSTER_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
CLUSTER_NAME_FIELD_NUMBER
public static final int CLUSTER_NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
GRACEFUL_DECOMMISSION_TIMEOUT_FIELD_NUMBER
public static final int GRACEFUL_DECOMMISSION_TIMEOUT_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 | |
REQUEST_ID_FIELD_NUMBER
public static final int REQUEST_ID_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
UPDATE_MASK_FIELD_NUMBER
public static final int UPDATE_MASK_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static UpdateClusterRequest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static UpdateClusterRequest.Builder newBuilder()
newBuilder(UpdateClusterRequest prototype)
public static UpdateClusterRequest.Builder newBuilder(UpdateClusterRequest prototype)
public static UpdateClusterRequest parseDelimitedFrom(InputStream input)
public static UpdateClusterRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static UpdateClusterRequest parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static UpdateClusterRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static UpdateClusterRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static UpdateClusterRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static UpdateClusterRequest parseFrom(CodedInputStream input)
public static UpdateClusterRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static UpdateClusterRequest parseFrom(InputStream input)
public static UpdateClusterRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static UpdateClusterRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static UpdateClusterRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<UpdateClusterRequest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getCluster()
public Cluster getCluster()
Required. The changes to the cluster.
.google.cloud.dataproc.v1.Cluster cluster = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns |
|---|
| Type | Description |
Cluster | The cluster.
|
getClusterName()
public String getClusterName()
Required. The cluster name.
string cluster_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns |
|---|
| Type | Description |
String | The clusterName.
|
getClusterNameBytes()
public ByteString getClusterNameBytes()
Required. The cluster name.
string cluster_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for clusterName.
|
getClusterOrBuilder()
public ClusterOrBuilder getClusterOrBuilder()
Required. The changes to the cluster.
.google.cloud.dataproc.v1.Cluster cluster = 3 [(.google.api.field_behavior) = REQUIRED];
getDefaultInstanceForType()
public UpdateClusterRequest getDefaultInstanceForType()
getGracefulDecommissionTimeout()
public Duration getGracefulDecommissionTimeout()
Optional. Timeout for graceful YARN decommissioning. Graceful
decommissioning allows removing nodes from the cluster without
interrupting jobs in progress. Timeout specifies how long to wait for jobs
in progress to finish before forcefully removing nodes (and potentially
interrupting jobs). Default timeout is 0 (for forceful decommission), and
the maximum allowed timeout is 1 day. (see JSON representation of
Duration).
Only supported on Dataproc image versions 1.2 and higher.
.google.protobuf.Duration graceful_decommission_timeout = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
Duration | The gracefulDecommissionTimeout.
|
getGracefulDecommissionTimeoutOrBuilder()
public DurationOrBuilder getGracefulDecommissionTimeoutOrBuilder()
Optional. Timeout for graceful YARN decommissioning. Graceful
decommissioning allows removing nodes from the cluster without
interrupting jobs in progress. Timeout specifies how long to wait for jobs
in progress to finish before forcefully removing nodes (and potentially
interrupting jobs). Default timeout is 0 (for forceful decommission), and
the maximum allowed timeout is 1 day. (see JSON representation of
Duration).
Only supported on Dataproc image versions 1.2 and higher.
.google.protobuf.Duration graceful_decommission_timeout = 6 [(.google.api.field_behavior) = OPTIONAL];
getParserForType()
public Parser<UpdateClusterRequest> getParserForType()
Overrides
getProjectId()
public String getProjectId()
Required. The ID of the Google Cloud Platform project 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 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 = 5 [(.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 = 5 [(.google.api.field_behavior) = REQUIRED];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for region.
|
getRequestId()
public String getRequestId()
Optional. A unique ID used to identify the request. If the server
receives two
UpdateClusterRequests
with the same id, then the second request will be ignored and the
first google.longrunning.Operation created
and stored in the backend is returned.
It is recommended to always set this value to a
UUID.
The ID must contain only letters (a-z, A-Z), numbers (0-9),
underscores (_), and hyphens (-). The maximum length is 40 characters.
string request_id = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
String | The requestId.
|
getRequestIdBytes()
public ByteString getRequestIdBytes()
Optional. A unique ID used to identify the request. If the server
receives two
UpdateClusterRequests
with the same id, then the second request will be ignored and the
first google.longrunning.Operation created
and stored in the backend is returned.
It is recommended to always set this value to a
UUID.
The ID must contain only letters (a-z, A-Z), numbers (0-9),
underscores (_), and hyphens (-). The maximum length is 40 characters.
string request_id = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for requestId.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
getUpdateMask()
public FieldMask getUpdateMask()
Required. Specifies the path, relative to Cluster, of
the field to update. For example, to change the number of workers
in a cluster to 5, the update_mask parameter would be
specified as config.worker_config.num_instances,
and the PATCH request body would specify the new value, as follows:
{
"config":{
"workerConfig":{
"numInstances":"5"
}
}
}
Similarly, to change the number of preemptible workers in a cluster to 5,
the update_mask parameter would be
config.secondary_worker_config.num_instances, and the PATCH request
body would be set as follows:
{
"config":{
"secondaryWorkerConfig":{
"numInstances":"5"
}
}
}
<strong>Note:</strong> Currently, only the following fields can be updated:
<table>
<tbody>
<tr>
<td><strong>Mask</strong></td>
<td><strong>Purpose</strong></td>
</tr>
<tr>
<td><strong><em>labels</em></strong></td>
<td>Update labels</td>
</tr>
<tr>
<td><strong><em>config.worker_config.num_instances</em></strong></td>
<td>Resize primary worker group</td>
</tr>
<tr>
<td><strong><em>config.secondary_worker_config.num_instances</em></strong></td>
<td>Resize secondary worker group</td>
</tr>
<tr>
<td>config.autoscaling_config.policy_uri</td><td>Use, stop using, or
change autoscaling policies</td>
</tr>
</tbody>
</table>
.google.protobuf.FieldMask update_mask = 4 [(.google.api.field_behavior) = REQUIRED];
| Returns |
|---|
| Type | Description |
FieldMask | The updateMask.
|
getUpdateMaskOrBuilder()
public FieldMaskOrBuilder getUpdateMaskOrBuilder()
Required. Specifies the path, relative to Cluster, of
the field to update. For example, to change the number of workers
in a cluster to 5, the update_mask parameter would be
specified as config.worker_config.num_instances,
and the PATCH request body would specify the new value, as follows:
{
"config":{
"workerConfig":{
"numInstances":"5"
}
}
}
Similarly, to change the number of preemptible workers in a cluster to 5,
the update_mask parameter would be
config.secondary_worker_config.num_instances, and the PATCH request
body would be set as follows:
{
"config":{
"secondaryWorkerConfig":{
"numInstances":"5"
}
}
}
<strong>Note:</strong> Currently, only the following fields can be updated:
<table>
<tbody>
<tr>
<td><strong>Mask</strong></td>
<td><strong>Purpose</strong></td>
</tr>
<tr>
<td><strong><em>labels</em></strong></td>
<td>Update labels</td>
</tr>
<tr>
<td><strong><em>config.worker_config.num_instances</em></strong></td>
<td>Resize primary worker group</td>
</tr>
<tr>
<td><strong><em>config.secondary_worker_config.num_instances</em></strong></td>
<td>Resize secondary worker group</td>
</tr>
<tr>
<td>config.autoscaling_config.policy_uri</td><td>Use, stop using, or
change autoscaling policies</td>
</tr>
</tbody>
</table>
.google.protobuf.FieldMask update_mask = 4 [(.google.api.field_behavior) = REQUIRED];
hasCluster()
public boolean hasCluster()
Required. The changes to the cluster.
.google.cloud.dataproc.v1.Cluster cluster = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns |
|---|
| Type | Description |
boolean | Whether the cluster field is set.
|
hasGracefulDecommissionTimeout()
public boolean hasGracefulDecommissionTimeout()
Optional. Timeout for graceful YARN decommissioning. Graceful
decommissioning allows removing nodes from the cluster without
interrupting jobs in progress. Timeout specifies how long to wait for jobs
in progress to finish before forcefully removing nodes (and potentially
interrupting jobs). Default timeout is 0 (for forceful decommission), and
the maximum allowed timeout is 1 day. (see JSON representation of
Duration).
Only supported on Dataproc image versions 1.2 and higher.
.google.protobuf.Duration graceful_decommission_timeout = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
boolean | Whether the gracefulDecommissionTimeout field is set.
|
hasUpdateMask()
public boolean hasUpdateMask()
Required. Specifies the path, relative to Cluster, of
the field to update. For example, to change the number of workers
in a cluster to 5, the update_mask parameter would be
specified as config.worker_config.num_instances,
and the PATCH request body would specify the new value, as follows:
{
"config":{
"workerConfig":{
"numInstances":"5"
}
}
}
Similarly, to change the number of preemptible workers in a cluster to 5,
the update_mask parameter would be
config.secondary_worker_config.num_instances, and the PATCH request
body would be set as follows:
{
"config":{
"secondaryWorkerConfig":{
"numInstances":"5"
}
}
}
<strong>Note:</strong> Currently, only the following fields can be updated:
<table>
<tbody>
<tr>
<td><strong>Mask</strong></td>
<td><strong>Purpose</strong></td>
</tr>
<tr>
<td><strong><em>labels</em></strong></td>
<td>Update labels</td>
</tr>
<tr>
<td><strong><em>config.worker_config.num_instances</em></strong></td>
<td>Resize primary worker group</td>
</tr>
<tr>
<td><strong><em>config.secondary_worker_config.num_instances</em></strong></td>
<td>Resize secondary worker group</td>
</tr>
<tr>
<td>config.autoscaling_config.policy_uri</td><td>Use, stop using, or
change autoscaling policies</td>
</tr>
</tbody>
</table>
.google.protobuf.FieldMask update_mask = 4 [(.google.api.field_behavior) = REQUIRED];
| Returns |
|---|
| Type | Description |
boolean | Whether the updateMask field is set.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public UpdateClusterRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected UpdateClusterRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public UpdateClusterRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
