Data Proc API, gRPC: SubclusterService.Update
Updates the specified subcluster.
gRPC request
rpc Update (UpdateSubclusterRequest) returns (operation.Operation)
UpdateSubclusterRequest
{
"clusterId": "string",
"subclusterId": "string",
"updateMask": "google.protobuf.FieldMask",
"resources": {
"resourcePresetId": "string",
"diskTypeId": "string",
"diskSize": "int64"
},
"name": "string",
"hostsCount": "int64",
"decommissionTimeout": "int64",
"autoscalingConfig": {
"maxHostsCount": "int64",
"preemptible": "bool",
"measurementDuration": "google.protobuf.Duration",
"warmupDuration": "google.protobuf.Duration",
"stabilizationDuration": "google.protobuf.Duration",
"cpuUtilizationTarget": "double",
"decommissionTimeout": "int64"
}
}
Field |
Description |
clusterId |
string Required field. ID of the cluster to update a subcluster in. To get a cluster ID, make a ClusterService.List request. |
subclusterId |
string Required field. ID of the subcluster to update. To get a subcluster ID, make a SubclusterService.List request. |
updateMask |
Field mask that specifies which attributes of the subcluster should be updated. |
resources |
New configuration of resources that should be allocated for each host in the subcluster. |
name |
string New name for the subcluster. The name must be unique within the cluster. |
hostsCount |
int64 Required field. New number of hosts in the subcluster. |
decommissionTimeout |
int64 Timeout to gracefully decommission nodes. In seconds. Default value: 0 |
autoscalingConfig |
Configuration for instance group based subclusters |
Resources
Field |
Description |
resourcePresetId |
string ID of the resource preset for computational resources available to a host (CPU, memory etc.). |
diskTypeId |
string Type of the storage environment for the host.
|
diskSize |
int64 Volume of the storage available to a host, in bytes. |
AutoscalingConfig
Field |
Description |
maxHostsCount |
int64 Upper limit for total instance subcluster count. |
preemptible |
bool Preemptible instances are stopped at least once every 24 hours, and can be stopped at any time |
measurementDuration |
Required field. Time in seconds allotted for averaging metrics. |
warmupDuration |
The warmup time of the instance in seconds. During this time, |
stabilizationDuration |
Minimum amount of time in seconds allotted for monitoring before |
cpuUtilizationTarget |
double Defines an autoscaling rule based on the average CPU utilization of the instance group. |
decommissionTimeout |
int64 Timeout to gracefully decommission nodes during downscaling. In seconds. Default value: 120 |
operation.Operation
{
"id": "string",
"description": "string",
"createdAt": "google.protobuf.Timestamp",
"createdBy": "string",
"modifiedAt": "google.protobuf.Timestamp",
"done": "bool",
"metadata": {
"clusterId": "string",
"subclusterId": "string"
},
// Includes only one of the fields `error`, `response`
"error": "google.rpc.Status",
"response": {
"id": "string",
"clusterId": "string",
"createdAt": "google.protobuf.Timestamp",
"name": "string",
"role": "Role",
"resources": {
"resourcePresetId": "string",
"diskTypeId": "string",
"diskSize": "int64"
},
"subnetId": "string",
"hostsCount": "int64",
"assignPublicIp": "bool",
"autoscalingConfig": {
"maxHostsCount": "int64",
"preemptible": "bool",
"measurementDuration": "google.protobuf.Duration",
"warmupDuration": "google.protobuf.Duration",
"stabilizationDuration": "google.protobuf.Duration",
"cpuUtilizationTarget": "double",
"decommissionTimeout": "int64"
},
"instanceGroupId": "string"
}
// end of the list of possible fields
}
An Operation resource. For more information, see Operation.
Field |
Description |
id |
string ID of the operation. |
description |
string Description of the operation. 0-256 characters long. |
createdAt |
Creation timestamp. |
createdBy |
string ID of the user or service account who initiated the operation. |
modifiedAt |
The time when the Operation resource was last modified. |
done |
bool If the value is |
metadata |
Service-specific metadata associated with the operation. |
error |
The error result of the operation in case of failure or cancellation. Includes only one of the fields The operation result. |
response |
The normal response of the operation in case of success. Includes only one of the fields The operation result. |
UpdateSubclusterMetadata
Field |
Description |
clusterId |
string ID of the cluster whose subcluster is being updated. |
subclusterId |
string ID of the subcluster that is being updated. |
Subcluster
A Data Proc subcluster. For details about the concept, see documentation.
Field |
Description |
id |
string ID of the subcluster. Generated at creation time. |
clusterId |
string ID of the Data Proc cluster that the subcluster belongs to. |
createdAt |
Creation timestamp. |
name |
string Name of the subcluster. The name is unique within the cluster. |
role |
enum Role Role that is fulfilled by hosts of the subcluster.
|
resources |
Resources allocated for each host in the subcluster. |
subnetId |
string ID of the VPC subnet used for hosts in the subcluster. |
hostsCount |
int64 Number of hosts in the subcluster. |
assignPublicIp |
bool Assign public ip addresses for all hosts in subcluter. |
autoscalingConfig |
Configuration for instance group based subclusters |
instanceGroupId |
string ID of Compute Instance Group for autoscaling subclusters |
Resources
Field |
Description |
resourcePresetId |
string ID of the resource preset for computational resources available to a host (CPU, memory etc.). |
diskTypeId |
string Type of the storage environment for the host.
|
diskSize |
int64 Volume of the storage available to a host, in bytes. |
AutoscalingConfig
Field |
Description |
maxHostsCount |
int64 Upper limit for total instance subcluster count. |
preemptible |
bool Preemptible instances are stopped at least once every 24 hours, and can be stopped at any time |
measurementDuration |
Required field. Time in seconds allotted for averaging metrics. |
warmupDuration |
The warmup time of the instance in seconds. During this time, |
stabilizationDuration |
Minimum amount of time in seconds allotted for monitoring before |
cpuUtilizationTarget |
double Defines an autoscaling rule based on the average CPU utilization of the instance group. |
decommissionTimeout |
int64 Timeout to gracefully decommission nodes during downscaling. In seconds. Default value: 120 |