1
- // Copyright 2020 Google LLC
1
+ // Copyright 2021 Google LLC
2
2
//
3
3
// Licensed under the Apache License, Version 2.0 (the "License");
4
4
// you may not use this file except in compliance with the License.
@@ -63,6 +63,8 @@ service ClusterController {
63
63
// Updates a cluster in a project. The returned
64
64
// [Operation.metadata][google.longrunning.Operation.metadata] will be
65
65
// [ClusterOperationMetadata](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#clusteroperationmetadata).
66
+ // The cluster must be in a [`RUNNING`][google.cloud.dataproc.v1.ClusterStatus.State] state or an error
67
+ // is returned.
66
68
rpc UpdateCluster (UpdateClusterRequest ) returns (google .longrunning .Operation ) {
67
69
option (google.api.http ) = {
68
70
patch : "/v1/projects/{project_id}/regions/{region}/clusters/{cluster_name}"
@@ -151,7 +153,7 @@ service ClusterController {
151
153
}
152
154
153
155
// Describes the identifying information, config, and status of
154
- // a cluster of Compute Engine instances.
156
+ // a Dataproc cluster
155
157
message Cluster {
156
158
// Required. The Google Cloud Platform project ID that the cluster belongs to.
157
159
string project_id = 1 [(google.api.field_behavior ) = REQUIRED ];
@@ -199,10 +201,10 @@ message ClusterConfig {
199
201
// ASIA, or EU) for your cluster's staging bucket according to the
200
202
// Compute Engine zone where your cluster is deployed, and then create
201
203
// and manage this project-level, per-location bucket (see
202
- // [Dataproc staging
203
- // bucket ](https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/staging-bucket)).
204
- // **This field requires a Cloud Storage bucket name, not a URI to a Cloud
205
- // Storage bucket.**
204
+ // [Dataproc staging and temp
205
+ // buckets ](https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/staging-bucket)).
206
+ // **This field requires a Cloud Storage bucket name, not a `gs://...` URI to
207
+ // a Cloud Storage bucket.**
206
208
string config_bucket = 1 [(google.api.field_behavior ) = OPTIONAL ];
207
209
208
210
// Optional. A Cloud Storage bucket used to store ephemeral cluster and jobs data,
@@ -213,28 +215,30 @@ message ClusterConfig {
213
215
// Compute Engine zone where your cluster is deployed, and then create
214
216
// and manage this project-level, per-location bucket. The default bucket has
215
217
// a TTL of 90 days, but you can use any TTL (or none) if you specify a
216
- // bucket.
217
- // **This field requires a Cloud Storage bucket name, not a URI to a Cloud
218
- // Storage bucket.**
218
+ // bucket (see
219
+ // [Dataproc staging and temp
220
+ // buckets](https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/staging-bucket)).
221
+ // **This field requires a Cloud Storage bucket name, not a `gs://...` URI to
222
+ // a Cloud Storage bucket.**
219
223
string temp_bucket = 2 [(google.api.field_behavior ) = OPTIONAL ];
220
224
221
225
// Optional. The shared Compute Engine config settings for
222
226
// all instances in a cluster.
223
227
GceClusterConfig gce_cluster_config = 8 [(google.api.field_behavior ) = OPTIONAL ];
224
228
225
229
// Optional. The Compute Engine config settings for
226
- // the master instance in a cluster .
230
+ // the cluster's master instance.
227
231
InstanceGroupConfig master_config = 9 [(google.api.field_behavior ) = OPTIONAL ];
228
232
229
233
// Optional. The Compute Engine config settings for
230
- // worker instances in a cluster .
234
+ // the cluster's worker instances .
231
235
InstanceGroupConfig worker_config = 10 [(google.api.field_behavior ) = OPTIONAL ];
232
236
233
237
// Optional. The Compute Engine config settings for
234
- // additional worker instances in a cluster.
238
+ // a cluster's secondary worker instances
235
239
InstanceGroupConfig secondary_worker_config = 12 [(google.api.field_behavior ) = OPTIONAL ];
236
240
237
- // Optional. The config settings for software inside the cluster.
241
+ // Optional. The config settings for cluster software .
238
242
SoftwareConfig software_config = 13 [(google.api.field_behavior ) = OPTIONAL ];
239
243
240
244
// Optional. Commands to execute on each node after config is
@@ -453,6 +457,10 @@ message GceClusterConfig {
453
457
// Optional. Shielded Instance Config for clusters using [Compute Engine Shielded
454
458
// VMs](https://cloud.google.com/security/shielded-cloud/shielded-vm).
455
459
ShieldedInstanceConfig shielded_instance_config = 14 [(google.api.field_behavior ) = OPTIONAL ];
460
+
461
+ // Optional. Confidential Instance Config for clusters using [Confidential
462
+ // VMs](https://cloud.google.com/compute/confidential-vm/docs).
463
+ ConfidentialInstanceConfig confidential_instance_config = 15 [(google.api.field_behavior ) = OPTIONAL ];
456
464
}
457
465
458
466
// Node Group Affinity for clusters using sole-tenant node groups.
@@ -483,6 +491,13 @@ message ShieldedInstanceConfig {
483
491
bool enable_integrity_monitoring = 3 [(google.api.field_behavior ) = OPTIONAL ];
484
492
}
485
493
494
+ // Confidential Instance Config for clusters using [Confidential
495
+ // VMs](https://cloud.google.com/compute/confidential-vm/docs)
496
+ message ConfidentialInstanceConfig {
497
+ // Optional. Defines whether the instance should have confidential compute enabled.
498
+ bool enable_confidential_compute = 1 [(google.api.field_behavior ) = OPTIONAL ];
499
+ }
500
+
486
501
// The config settings for Compute Engine resources in
487
502
// an instance group, such as a master or worker group.
488
503
message InstanceGroupConfig {
@@ -674,6 +689,10 @@ message ClusterStatus {
674
689
// The cluster encountered an error. It is not ready for use.
675
690
ERROR = 3 ;
676
691
692
+ // The cluster has encountered an error while being updated. Jobs can
693
+ // be submitted to the cluster, but the cluster cannot be updated.
694
+ ERROR_DUE_TO_UPDATE = 9 ;
695
+
677
696
// The cluster is being deleted. It cannot be used.
678
697
DELETING = 4 ;
679
698
@@ -918,7 +937,7 @@ message CreateClusterRequest {
918
937
// Required. The cluster to create.
919
938
Cluster cluster = 2 [(google.api.field_behavior ) = REQUIRED ];
920
939
921
- // Optional. A unique id used to identify the request. If the server receives two
940
+ // Optional. A unique ID used to identify the request. If the server receives two
922
941
// [CreateClusterRequest](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.CreateClusterRequest)s
923
942
// with the same id, then the second request will be ignored and the
924
943
// first [google.longrunning.Operation][google.longrunning.Operation] created and stored in the backend
@@ -927,9 +946,12 @@ message CreateClusterRequest {
927
946
// It is recommended to always set this value to a
928
947
// [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier).
929
948
//
930
- // The id must contain only letters (a-z, A-Z), numbers (0-9),
949
+ // The ID must contain only letters (a-z, A-Z), numbers (0-9),
931
950
// underscores (_), and hyphens (-). The maximum length is 40 characters.
932
951
string request_id = 4 [(google.api.field_behavior ) = OPTIONAL ];
952
+
953
+ // Optional. Failure action when primary worker creation fails.
954
+ FailureAction action_on_failed_primary_workers = 5 [(google.api.field_behavior ) = OPTIONAL ];
933
955
}
934
956
935
957
// A request to update a cluster.
@@ -1011,7 +1033,7 @@ message UpdateClusterRequest {
1011
1033
// </table>
1012
1034
google.protobuf.FieldMask update_mask = 4 [(google.api.field_behavior ) = REQUIRED ];
1013
1035
1014
- // Optional. A unique id used to identify the request. If the server
1036
+ // Optional. A unique ID used to identify the request. If the server
1015
1037
// receives two
1016
1038
// [UpdateClusterRequest](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.UpdateClusterRequest)s
1017
1039
// with the same id, then the second request will be ignored and the
@@ -1021,7 +1043,7 @@ message UpdateClusterRequest {
1021
1043
// It is recommended to always set this value to a
1022
1044
// [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier).
1023
1045
//
1024
- // The id must contain only letters (a-z, A-Z), numbers (0-9),
1046
+ // The ID must contain only letters (a-z, A-Z), numbers (0-9),
1025
1047
// underscores (_), and hyphens (-). The maximum length is 40 characters.
1026
1048
string request_id = 7 [(google.api.field_behavior ) = OPTIONAL ];
1027
1049
}
@@ -1042,7 +1064,7 @@ message StopClusterRequest {
1042
1064
// (with error NOT_FOUND) if a cluster with the specified UUID does not exist.
1043
1065
string cluster_uuid = 4 [(google.api.field_behavior ) = OPTIONAL ];
1044
1066
1045
- // Optional. A unique id used to identify the request. If the server
1067
+ // Optional. A unique ID used to identify the request. If the server
1046
1068
// receives two
1047
1069
// [StopClusterRequest](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.StopClusterRequest)s
1048
1070
// with the same id, then the second request will be ignored and the
@@ -1052,7 +1074,7 @@ message StopClusterRequest {
1052
1074
// Recommendation: Set this value to a
1053
1075
// [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier).
1054
1076
//
1055
- // The id must contain only letters (a-z, A-Z), numbers (0-9),
1077
+ // The ID must contain only letters (a-z, A-Z), numbers (0-9),
1056
1078
// underscores (_), and hyphens (-). The maximum length is 40 characters.
1057
1079
string request_id = 5 [(google.api.field_behavior ) = OPTIONAL ];
1058
1080
}
@@ -1073,7 +1095,7 @@ message StartClusterRequest {
1073
1095
// (with error NOT_FOUND) if a cluster with the specified UUID does not exist.
1074
1096
string cluster_uuid = 4 [(google.api.field_behavior ) = OPTIONAL ];
1075
1097
1076
- // Optional. A unique id used to identify the request. If the server
1098
+ // Optional. A unique ID used to identify the request. If the server
1077
1099
// receives two
1078
1100
// [StartClusterRequest](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.StartClusterRequest)s
1079
1101
// with the same id, then the second request will be ignored and the
@@ -1083,7 +1105,7 @@ message StartClusterRequest {
1083
1105
// Recommendation: Set this value to a
1084
1106
// [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier).
1085
1107
//
1086
- // The id must contain only letters (a-z, A-Z), numbers (0-9),
1108
+ // The ID must contain only letters (a-z, A-Z), numbers (0-9),
1087
1109
// underscores (_), and hyphens (-). The maximum length is 40 characters.
1088
1110
string request_id = 5 [(google.api.field_behavior ) = OPTIONAL ];
1089
1111
}
@@ -1104,7 +1126,7 @@ message DeleteClusterRequest {
1104
1126
// (with error NOT_FOUND) if cluster with specified UUID does not exist.
1105
1127
string cluster_uuid = 4 [(google.api.field_behavior ) = OPTIONAL ];
1106
1128
1107
- // Optional. A unique id used to identify the request. If the server
1129
+ // Optional. A unique ID used to identify the request. If the server
1108
1130
// receives two
1109
1131
// [DeleteClusterRequest](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.DeleteClusterRequest)s
1110
1132
// with the same id, then the second request will be ignored and the
@@ -1114,7 +1136,7 @@ message DeleteClusterRequest {
1114
1136
// It is recommended to always set this value to a
1115
1137
// [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier).
1116
1138
//
1117
- // The id must contain only letters (a-z, A-Z), numbers (0-9),
1139
+ // The ID must contain only letters (a-z, A-Z), numbers (0-9),
1118
1140
// underscores (_), and hyphens (-). The maximum length is 40 characters.
1119
1141
string request_id = 5 [(google.api.field_behavior ) = OPTIONAL ];
1120
1142
}
0 commit comments