public sealed class UpdateClusterRequest : IMessage<UpdateClusterRequest>, IEquatable<UpdateClusterRequest>, IDeepCloneable<UpdateClusterRequest>, IBufferMessage, IMessageReference documentation and code samples for the Google Cloud Dataproc v1 API class UpdateClusterRequest.
A request to update a cluster.
Implements
IMessage<UpdateClusterRequest>, IEquatable<UpdateClusterRequest>, IDeepCloneable<UpdateClusterRequest>, IBufferMessage, IMessageNamespace
Google.Cloud.Dataproc.V1Assembly
Google.Cloud.Dataproc.V1.dll
Constructors
UpdateClusterRequest()
public UpdateClusterRequest()UpdateClusterRequest(UpdateClusterRequest)
public UpdateClusterRequest(UpdateClusterRequest other)| Parameter | |
|---|---|
| Name | Description |
other | UpdateClusterRequest |
Properties
Cluster
public Cluster Cluster { get; set; }Required. The changes to the cluster.
| Property Value | |
|---|---|
| Type | Description |
Cluster | |
ClusterName
public string ClusterName { get; set; }Required. The cluster name.
| Property Value | |
|---|---|
| Type | Description |
String | |
GracefulDecommissionTimeout
public Duration GracefulDecommissionTimeout { get; set; }Optional. Timeout for graceful YARN decomissioning. 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.
| Property Value | |
|---|---|
| Type | Description |
Duration | |
ProjectId
public string ProjectId { get; set; }Required. The ID of the Google Cloud Platform project the cluster belongs to.
| Property Value | |
|---|---|
| Type | Description |
String | |
Region
public string Region { get; set; }Required. The Dataproc region in which to handle the request.
| Property Value | |
|---|---|
| Type | Description |
String | |
RequestId
public string RequestId { get; set; }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][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.
| Property Value | |
|---|---|
| Type | Description |
String | |
UpdateMask
public FieldMask UpdateMask { get; set; }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>
| Property Value | |
|---|---|
| Type | Description |
FieldMask | |