clusters.proto 45 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082
  1. // Copyright 2020 Google LLC
  2. //
  3. // Licensed under the Apache License, Version 2.0 (the "License");
  4. // you may not use this file except in compliance with the License.
  5. // You may obtain a copy of the License at
  6. //
  7. // http://www.apache.org/licenses/LICENSE-2.0
  8. //
  9. // Unless required by applicable law or agreed to in writing, software
  10. // distributed under the License is distributed on an "AS IS" BASIS,
  11. // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12. // See the License for the specific language governing permissions and
  13. // limitations under the License.
  14. syntax = "proto3";
  15. package google.cloud.dataproc.v1beta2;
  16. import "google/api/annotations.proto";
  17. import "google/api/client.proto";
  18. import "google/api/field_behavior.proto";
  19. import "google/api/resource.proto";
  20. import "google/cloud/dataproc/v1beta2/shared.proto";
  21. import "google/longrunning/operations.proto";
  22. import "google/protobuf/duration.proto";
  23. import "google/protobuf/field_mask.proto";
  24. import "google/protobuf/timestamp.proto";
  25. option go_package = "google.golang.org/genproto/googleapis/cloud/dataproc/v1beta2;dataproc";
  26. option java_multiple_files = true;
  27. option java_outer_classname = "ClustersProto";
  28. option java_package = "com.google.cloud.dataproc.v1beta2";
  29. option (google.api.resource_definition) = {
  30. type: "container.googleapis.com/Cluster"
  31. pattern: "projects/{project}/locations/{location}/clusters/{cluster}"
  32. };
  33. option (google.api.resource_definition) = {
  34. type: "metastore.googleapis.com/Service"
  35. pattern: "projects/{project}/locations/{location}/services/{service}"
  36. };
  37. // The ClusterControllerService provides methods to manage clusters
  38. // of Compute Engine instances.
  39. service ClusterController {
  40. option (google.api.default_host) = "dataproc.googleapis.com";
  41. option (google.api.oauth_scopes) =
  42. "https://www.googleapis.com/auth/cloud-platform";
  43. // Creates a cluster in a project. The returned
  44. // [Operation.metadata][google.longrunning.Operation.metadata] will be
  45. // [ClusterOperationMetadata](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1beta2#clusteroperationmetadata).
  46. rpc CreateCluster(CreateClusterRequest)
  47. returns (google.longrunning.Operation) {
  48. option (google.api.http) = {
  49. post: "/v1beta2/projects/{project_id}/regions/{region}/clusters"
  50. body: "cluster"
  51. };
  52. option (google.api.method_signature) = "project_id, region, cluster";
  53. option (google.longrunning.operation_info) = {
  54. response_type: "Cluster"
  55. metadata_type: "google.cloud.dataproc.v1beta2.ClusterOperationMetadata"
  56. };
  57. }
  58. // Updates a cluster in a project. The returned
  59. // [Operation.metadata][google.longrunning.Operation.metadata] will be
  60. // [ClusterOperationMetadata](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1beta2#clusteroperationmetadata).
  61. rpc UpdateCluster(UpdateClusterRequest)
  62. returns (google.longrunning.Operation) {
  63. option (google.api.http) = {
  64. patch: "/v1beta2/projects/{project_id}/regions/{region}/clusters/{cluster_name}"
  65. body: "cluster"
  66. };
  67. option (google.api.method_signature) =
  68. "project_id, region, cluster_name, cluster, update_mask";
  69. option (google.longrunning.operation_info) = {
  70. response_type: "Cluster"
  71. metadata_type: "google.cloud.dataproc.v1beta2.ClusterOperationMetadata"
  72. };
  73. }
  74. // Deletes a cluster in a project. The returned
  75. // [Operation.metadata][google.longrunning.Operation.metadata] will be
  76. // [ClusterOperationMetadata](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1beta2#clusteroperationmetadata).
  77. rpc DeleteCluster(DeleteClusterRequest)
  78. returns (google.longrunning.Operation) {
  79. option (google.api.http) = {
  80. delete: "/v1beta2/projects/{project_id}/regions/{region}/clusters/{cluster_name}"
  81. };
  82. option (google.api.method_signature) = "project_id, region, cluster_name";
  83. option (google.longrunning.operation_info) = {
  84. response_type: "google.protobuf.Empty"
  85. metadata_type: "google.cloud.dataproc.v1beta2.ClusterOperationMetadata"
  86. };
  87. }
  88. // Gets the resource representation for a cluster in a project.
  89. rpc GetCluster(GetClusterRequest) returns (Cluster) {
  90. option (google.api.http) = {
  91. get: "/v1beta2/projects/{project_id}/regions/{region}/clusters/{cluster_name}"
  92. };
  93. option (google.api.method_signature) = "project_id, region, cluster_name";
  94. }
  95. // Lists all regions/{region}/clusters in a project alphabetically.
  96. rpc ListClusters(ListClustersRequest) returns (ListClustersResponse) {
  97. option (google.api.http) = {
  98. get: "/v1beta2/projects/{project_id}/regions/{region}/clusters"
  99. };
  100. option (google.api.method_signature) = "project_id, region";
  101. option (google.api.method_signature) = "project_id, region, filter";
  102. }
  103. // Gets cluster diagnostic information. The returned
  104. // [Operation.metadata][google.longrunning.Operation.metadata] will be
  105. // [ClusterOperationMetadata](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1beta2#clusteroperationmetadata).
  106. // After the operation completes,
  107. // [Operation.response][google.longrunning.Operation.response]
  108. // contains
  109. // [Empty][google.protobuf.Empty].
  110. rpc DiagnoseCluster(DiagnoseClusterRequest)
  111. returns (google.longrunning.Operation) {
  112. option (google.api.http) = {
  113. post: "/v1beta2/projects/{project_id}/regions/{region}/clusters/{cluster_name}:diagnose"
  114. body: "*"
  115. };
  116. option (google.api.method_signature) = "project_id, region, cluster_name";
  117. option (google.longrunning.operation_info) = {
  118. response_type: "google.protobuf.Empty"
  119. metadata_type: "google.cloud.dataproc.v1beta2.ClusterOperationMetadata"
  120. };
  121. }
  122. }
  123. // Describes the identifying information, config, and status of
  124. // a cluster of Compute Engine instances.
  125. message Cluster {
  126. // Required. The Google Cloud Platform project ID that the cluster belongs to.
  127. string project_id = 1 [(google.api.field_behavior) = REQUIRED];
  128. // Required. The cluster name. Cluster names within a project must be
  129. // unique. Names of deleted clusters can be reused.
  130. string cluster_name = 2 [(google.api.field_behavior) = REQUIRED];
  131. // Required. The cluster config. Note that Dataproc may set
  132. // default values, and values may change when clusters are updated.
  133. ClusterConfig config = 3 [(google.api.field_behavior) = REQUIRED];
  134. // Optional. The labels to associate with this cluster.
  135. // Label **keys** must contain 1 to 63 characters, and must conform to
  136. // [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt).
  137. // Label **values** may be empty, but, if present, must contain 1 to 63
  138. // characters, and must conform to [RFC
  139. // 1035](https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be
  140. // associated with a cluster.
  141. map<string, string> labels = 8 [(google.api.field_behavior) = OPTIONAL];
  142. // Output only. Cluster status.
  143. ClusterStatus status = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
  144. // Output only. The previous cluster status.
  145. repeated ClusterStatus status_history = 7
  146. [(google.api.field_behavior) = OUTPUT_ONLY];
  147. // Output only. A cluster UUID (Unique Universal Identifier). Dataproc
  148. // generates this value when it creates the cluster.
  149. string cluster_uuid = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
  150. // Output only. Contains cluster daemon metrics such as HDFS and YARN stats.
  151. //
  152. // **Beta Feature**: This report is available for testing purposes only. It
  153. // may be changed before final release.
  154. ClusterMetrics metrics = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
  155. }
  156. // The cluster config.
  157. message ClusterConfig {
  158. // Optional. A Cloud Storage bucket used to stage job
  159. // dependencies, config files, and job driver console output.
  160. // If you do not specify a staging bucket, Cloud
  161. // Dataproc will determine a Cloud Storage location (US,
  162. // ASIA, or EU) for your cluster's staging bucket according to the
  163. // Compute Engine zone where your cluster is deployed, and then create
  164. // and manage this project-level, per-location bucket (see
  165. // [Dataproc staging
  166. // bucket](https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/staging-bucket)).
  167. string config_bucket = 1 [(google.api.field_behavior) = OPTIONAL];
  168. // Optional. A Cloud Storage bucket used to store ephemeral cluster and jobs
  169. // data, such as Spark and MapReduce history files. If you do not specify a
  170. // temp bucket, Dataproc will determine a Cloud Storage location (US, ASIA, or
  171. // EU) for your cluster's temp bucket according to the Compute Engine zone
  172. // where your cluster is deployed, and then create and manage this
  173. // project-level, per-location bucket. The default bucket has a TTL of 90
  174. // days, but you can use any TTL (or none) if you specify a bucket.
  175. string temp_bucket = 2 [(google.api.field_behavior) = OPTIONAL];
  176. // Optional. The shared Compute Engine config settings for
  177. // all instances in a cluster.
  178. GceClusterConfig gce_cluster_config = 8
  179. [(google.api.field_behavior) = OPTIONAL];
  180. // Optional. The Compute Engine config settings for
  181. // the master instance in a cluster.
  182. InstanceGroupConfig master_config = 9
  183. [(google.api.field_behavior) = OPTIONAL];
  184. // Optional. The Compute Engine config settings for
  185. // worker instances in a cluster.
  186. InstanceGroupConfig worker_config = 10
  187. [(google.api.field_behavior) = OPTIONAL];
  188. // Optional. The Compute Engine config settings for
  189. // additional worker instances in a cluster.
  190. InstanceGroupConfig secondary_worker_config = 12
  191. [(google.api.field_behavior) = OPTIONAL];
  192. // Optional. The config settings for software inside the cluster.
  193. SoftwareConfig software_config = 13 [(google.api.field_behavior) = OPTIONAL];
  194. // Optional. The config setting for auto delete cluster schedule.
  195. LifecycleConfig lifecycle_config = 14
  196. [(google.api.field_behavior) = OPTIONAL];
  197. // Optional. Commands to execute on each node after config is
  198. // completed. By default, executables are run on master and all worker nodes.
  199. // You can test a node's <code>role</code> metadata to run an executable on
  200. // a master or worker node, as shown below using `curl` (you can also use
  201. // `wget`):
  202. //
  203. // ROLE=$(curl -H Metadata-Flavor:Google
  204. // http://metadata/computeMetadata/v1beta2/instance/attributes/dataproc-role)
  205. // if [[ "${ROLE}" == 'Master' ]]; then
  206. // ... master specific actions ...
  207. // else
  208. // ... worker specific actions ...
  209. // fi
  210. repeated NodeInitializationAction initialization_actions = 11
  211. [(google.api.field_behavior) = OPTIONAL];
  212. // Optional. Encryption settings for the cluster.
  213. EncryptionConfig encryption_config = 15
  214. [(google.api.field_behavior) = OPTIONAL];
  215. // Optional. Autoscaling config for the policy associated with the cluster.
  216. // Cluster does not autoscale if this field is unset.
  217. AutoscalingConfig autoscaling_config = 16
  218. [(google.api.field_behavior) = OPTIONAL];
  219. // Optional. Port/endpoint configuration for this cluster
  220. EndpointConfig endpoint_config = 17 [(google.api.field_behavior) = OPTIONAL];
  221. // Optional. Security related configuration.
  222. SecurityConfig security_config = 18 [(google.api.field_behavior) = OPTIONAL];
  223. // Optional. The Kubernetes Engine config for Dataproc clusters deployed to
  224. // Kubernetes. Setting this is considered mutually exclusive with Compute
  225. // Engine-based options such as `gce_cluster_config`, `master_config`,
  226. // `worker_config`, `secondary_worker_config`, and `autoscaling_config`.
  227. GkeClusterConfig gke_cluster_config = 19
  228. [(google.api.field_behavior) = OPTIONAL];
  229. }
  230. // The GKE config for this cluster.
  231. message GkeClusterConfig {
  232. // A full, namespace-isolated deployment target for an existing GKE cluster.
  233. message NamespacedGkeDeploymentTarget {
  234. // Optional. The target GKE cluster to deploy to.
  235. // Format: 'projects/{project}/locations/{location}/clusters/{cluster_id}'
  236. string target_gke_cluster = 1 [
  237. (google.api.field_behavior) = OPTIONAL,
  238. (google.api.resource_reference) = {
  239. type: "container.googleapis.com/Cluster"
  240. }
  241. ];
  242. // Optional. A namespace within the GKE cluster to deploy into.
  243. string cluster_namespace = 2 [(google.api.field_behavior) = OPTIONAL];
  244. }
  245. // Optional. A target for the deployment.
  246. NamespacedGkeDeploymentTarget namespaced_gke_deployment_target = 1
  247. [(google.api.field_behavior) = OPTIONAL];
  248. }
  249. // Endpoint config for this cluster
  250. message EndpointConfig {
  251. // Output only. The map of port descriptions to URLs. Will only be populated
  252. // if enable_http_port_access is true.
  253. map<string, string> http_ports = 1
  254. [(google.api.field_behavior) = OUTPUT_ONLY];
  255. // Optional. If true, enable http access to specific ports on the cluster
  256. // from external sources. Defaults to false.
  257. bool enable_http_port_access = 2 [(google.api.field_behavior) = OPTIONAL];
  258. }
  259. // Autoscaling Policy config associated with the cluster.
  260. message AutoscalingConfig {
  261. // Optional. The autoscaling policy used by the cluster.
  262. //
  263. // Only resource names including projectid and location (region) are valid.
  264. // Examples:
  265. //
  266. // * `https://www.googleapis.com/compute/v1/projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]`
  267. // * `projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]`
  268. //
  269. // Note that the policy must be in the same project and Dataproc region.
  270. string policy_uri = 1 [(google.api.field_behavior) = OPTIONAL];
  271. }
  272. // Encryption settings for the cluster.
  273. message EncryptionConfig {
  274. // Optional. The Cloud KMS key name to use for PD disk encryption for all
  275. // instances in the cluster.
  276. string gce_pd_kms_key_name = 1 [(google.api.field_behavior) = OPTIONAL];
  277. }
  278. // Common config settings for resources of Compute Engine cluster
  279. // instances, applicable to all instances in the cluster.
  280. message GceClusterConfig {
  281. // Optional. The zone where the Compute Engine cluster will be located.
  282. // On a create request, it is required in the "global" region. If omitted
  283. // in a non-global Dataproc region, the service will pick a zone in the
  284. // corresponding Compute Engine region. On a get request, zone will always be
  285. // present.
  286. //
  287. // A full URL, partial URI, or short name are valid. Examples:
  288. //
  289. // * `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]`
  290. // * `projects/[project_id]/zones/[zone]`
  291. // * `us-central1-f`
  292. string zone_uri = 1 [(google.api.field_behavior) = OPTIONAL];
  293. // Optional. The Compute Engine network to be used for machine
  294. // communications. Cannot be specified with subnetwork_uri. If neither
  295. // `network_uri` nor `subnetwork_uri` is specified, the "default" network of
  296. // the project is used, if it exists. Cannot be a "Custom Subnet Network" (see
  297. // [Using Subnetworks](https://cloud.google.com/compute/docs/subnetworks) for
  298. // more information).
  299. //
  300. // A full URL, partial URI, or short name are valid. Examples:
  301. //
  302. // * `https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default`
  303. // * `projects/[project_id]/regions/global/default`
  304. // * `default`
  305. string network_uri = 2 [(google.api.field_behavior) = OPTIONAL];
  306. // Optional. The Compute Engine subnetwork to be used for machine
  307. // communications. Cannot be specified with network_uri.
  308. //
  309. // A full URL, partial URI, or short name are valid. Examples:
  310. //
  311. // * `https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/subnetworks/sub0`
  312. // * `projects/[project_id]/regions/us-east1/subnetworks/sub0`
  313. // * `sub0`
  314. string subnetwork_uri = 6 [(google.api.field_behavior) = OPTIONAL];
  315. // Optional. If true, all instances in the cluster will only have internal IP
  316. // addresses. By default, clusters are not restricted to internal IP
  317. // addresses, and will have ephemeral external IP addresses assigned to each
  318. // instance. This `internal_ip_only` restriction can only be enabled for
  319. // subnetwork enabled networks, and all off-cluster dependencies must be
  320. // configured to be accessible without external IP addresses.
  321. bool internal_ip_only = 7 [(google.api.field_behavior) = OPTIONAL];
  322. // Optional. The [Dataproc service
  323. // account](https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/service-accounts#service_accounts_in_dataproc)
  324. // (also see [VM Data Plane
  325. // identity](https://cloud.google.com/dataproc/docs/concepts/iam/dataproc-principals#vm_service_account_data_plane_identity))
  326. // used by Dataproc cluster VM instances to access Google Cloud Platform
  327. // services.
  328. //
  329. // If not specified, the
  330. // [Compute Engine default service
  331. // account](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account)
  332. // is used.
  333. string service_account = 8 [(google.api.field_behavior) = OPTIONAL];
  334. // Optional. The URIs of service account scopes to be included in
  335. // Compute Engine instances. The following base set of scopes is always
  336. // included:
  337. //
  338. // * https://www.googleapis.com/auth/cloud.useraccounts.readonly
  339. // * https://www.googleapis.com/auth/devstorage.read_write
  340. // * https://www.googleapis.com/auth/logging.write
  341. //
  342. // If no scopes are specified, the following defaults are also provided:
  343. //
  344. // * https://www.googleapis.com/auth/bigquery
  345. // * https://www.googleapis.com/auth/bigtable.admin.table
  346. // * https://www.googleapis.com/auth/bigtable.data
  347. // * https://www.googleapis.com/auth/devstorage.full_control
  348. repeated string service_account_scopes = 3
  349. [(google.api.field_behavior) = OPTIONAL];
  350. // The Compute Engine tags to add to all instances (see [Tagging
  351. // instances](https://cloud.google.com/compute/docs/label-or-tag-resources#tags)).
  352. repeated string tags = 4;
  353. // The Compute Engine metadata entries to add to all instances (see
  354. // [Project and instance
  355. // metadata](https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).
  356. map<string, string> metadata = 5;
  357. // Optional. Reservation Affinity for consuming Zonal reservation.
  358. ReservationAffinity reservation_affinity = 11
  359. [(google.api.field_behavior) = OPTIONAL];
  360. }
  361. // The config settings for Compute Engine resources in
  362. // an instance group, such as a master or worker group.
  363. message InstanceGroupConfig {
  364. // Controls the use of
  365. // [preemptible instances]
  366. // (https://cloud.google.com/compute/docs/instances/preemptible)
  367. // within the group.
  368. enum Preemptibility {
  369. // Preemptibility is unspecified, the system will choose the
  370. // appropriate setting for each instance group.
  371. PREEMPTIBILITY_UNSPECIFIED = 0;
  372. // Instances are non-preemptible.
  373. //
  374. // This option is allowed for all instance groups and is the only valid
  375. // value for Master and Worker instance groups.
  376. NON_PREEMPTIBLE = 1;
  377. // Instances are preemptible.
  378. //
  379. // This option is allowed only for secondary worker groups.
  380. PREEMPTIBLE = 2;
  381. }
  382. // Optional. The number of VM instances in the instance group.
  383. // For master instance groups, must be set to 1.
  384. int32 num_instances = 1 [(google.api.field_behavior) = OPTIONAL];
  385. // Output only. The list of instance names. Dataproc derives the names
  386. // from `cluster_name`, `num_instances`, and the instance group.
  387. repeated string instance_names = 2
  388. [(google.api.field_behavior) = OUTPUT_ONLY];
  389. // Optional. The Compute Engine image resource used for cluster instances.
  390. //
  391. // The URI can represent an image or image family.
  392. //
  393. // Image examples:
  394. //
  395. // * `https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]`
  396. // * `projects/[project_id]/global/images/[image-id]`
  397. // * `image-id`
  398. //
  399. // Image family examples. Dataproc will use the most recent
  400. // image from the family:
  401. //
  402. // * `https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]`
  403. // * `projects/[project_id]/global/images/family/[custom-image-family-name]`
  404. //
  405. // If the URI is unspecified, it will be inferred from
  406. // `SoftwareConfig.image_version` or the system default.
  407. string image_uri = 3 [(google.api.field_behavior) = OPTIONAL];
  408. // Optional. The Compute Engine machine type used for cluster instances.
  409. //
  410. // A full URL, partial URI, or short name are valid. Examples:
  411. //
  412. // * `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2`
  413. // * `projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2`
  414. // * `n1-standard-2`
  415. //
  416. // **Auto Zone Exception**: If you are using the Dataproc
  417. // [Auto Zone
  418. // Placement](https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement)
  419. // feature, you must use the short name of the machine type
  420. // resource, for example, `n1-standard-2`.
  421. string machine_type_uri = 4 [(google.api.field_behavior) = OPTIONAL];
  422. // Optional. Disk option config settings.
  423. DiskConfig disk_config = 5 [(google.api.field_behavior) = OPTIONAL];
  424. // Output only. Specifies that this instance group contains preemptible
  425. // instances.
  426. bool is_preemptible = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
  427. // Optional. Specifies the preemptibility of the instance group.
  428. //
  429. // The default value for master and worker groups is
  430. // `NON_PREEMPTIBLE`. This default cannot be changed.
  431. //
  432. // The default value for secondary instances is
  433. // `PREEMPTIBLE`.
  434. Preemptibility preemptibility = 10 [(google.api.field_behavior) = OPTIONAL];
  435. // Output only. The config for Compute Engine Instance Group
  436. // Manager that manages this group.
  437. // This is only used for preemptible instance groups.
  438. ManagedGroupConfig managed_group_config = 7
  439. [(google.api.field_behavior) = OUTPUT_ONLY];
  440. // Optional. The Compute Engine accelerator configuration for these
  441. // instances.
  442. repeated AcceleratorConfig accelerators = 8
  443. [(google.api.field_behavior) = OPTIONAL];
  444. // Specifies the minimum cpu platform for the Instance Group.
  445. // See [Dataproc -> Minimum CPU
  446. // Platform](https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).
  447. string min_cpu_platform = 9;
  448. }
  449. // Specifies the resources used to actively manage an instance group.
  450. message ManagedGroupConfig {
  451. // Output only. The name of the Instance Template used for the Managed
  452. // Instance Group.
  453. string instance_template_name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
  454. // Output only. The name of the Instance Group Manager for this group.
  455. string instance_group_manager_name = 2
  456. [(google.api.field_behavior) = OUTPUT_ONLY];
  457. }
  458. // Specifies the type and number of accelerator cards attached to the instances
  459. // of an instance group (see [GPUs on Compute
  460. // Engine](https://cloud.google.com/compute/docs/gpus/)).
  461. message AcceleratorConfig {
  462. // Full URL, partial URI, or short name of the accelerator type resource to
  463. // expose to this instance. See
  464. // [Compute Engine
  465. // AcceleratorTypes](https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes)
  466. //
  467. // Examples
  468. // * `https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80`
  469. // * `projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80`
  470. // * `nvidia-tesla-k80`
  471. //
  472. // **Auto Zone Exception**: If you are using the Dataproc
  473. // [Auto Zone
  474. // Placement](https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement)
  475. // feature, you must use the short name of the accelerator type
  476. // resource, for example, `nvidia-tesla-k80`.
  477. string accelerator_type_uri = 1;
  478. // The number of the accelerator cards of this type exposed to this instance.
  479. int32 accelerator_count = 2;
  480. }
  481. // Specifies the config of disk options for a group of VM instances.
  482. message DiskConfig {
  483. // Optional. Type of the boot disk (default is "pd-standard").
  484. // Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or
  485. // "pd-standard" (Persistent Disk Hard Disk Drive).
  486. string boot_disk_type = 3 [(google.api.field_behavior) = OPTIONAL];
  487. // Optional. Size in GB of the boot disk (default is 500GB).
  488. int32 boot_disk_size_gb = 1 [(google.api.field_behavior) = OPTIONAL];
  489. // Number of attached SSDs, from 0 to 4 (default is 0).
  490. // If SSDs are not attached, the boot disk is used to store runtime logs and
  491. // [HDFS](https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data.
  492. // If one or more SSDs are attached, this runtime bulk
  493. // data is spread across them, and the boot disk contains only basic
  494. // config and installed binaries.
  495. int32 num_local_ssds = 2;
  496. }
  497. // Specifies the cluster auto-delete schedule configuration.
  498. message LifecycleConfig {
  499. // Optional. The duration to keep the cluster alive while idling (when no jobs
  500. // are running). Passing this threshold will cause the cluster to be
  501. // deleted. Minimum value is 10 minutes; maximum value is 14 days (see JSON
  502. // representation of
  503. // [Duration](https://developers.google.com/protocol-buffers/docs/proto3#json).
  504. google.protobuf.Duration idle_delete_ttl = 1
  505. [(google.api.field_behavior) = OPTIONAL];
  506. // Either the exact time the cluster should be deleted at or
  507. // the cluster maximum age.
  508. oneof ttl {
  509. // Optional. The time when cluster will be auto-deleted. (see JSON
  510. // representation of
  511. // [Timestamp](https://developers.google.com/protocol-buffers/docs/proto3#json)).
  512. google.protobuf.Timestamp auto_delete_time = 2
  513. [(google.api.field_behavior) = OPTIONAL];
  514. // Optional. The lifetime duration of cluster. The cluster will be
  515. // auto-deleted at the end of this period. Minimum value is 10 minutes;
  516. // maximum value is 14 days (see JSON representation of
  517. // [Duration](https://developers.google.com/protocol-buffers/docs/proto3#json)).
  518. google.protobuf.Duration auto_delete_ttl = 3
  519. [(google.api.field_behavior) = OPTIONAL];
  520. }
  521. // Output only. The time when cluster became idle (most recent job finished)
  522. // and became eligible for deletion due to idleness (see JSON representation
  523. // of
  524. // [Timestamp](https://developers.google.com/protocol-buffers/docs/proto3#json)).
  525. google.protobuf.Timestamp idle_start_time = 4
  526. [(google.api.field_behavior) = OUTPUT_ONLY];
  527. }
  528. // Security related configuration, including encryption, Kerberos, etc.
  529. message SecurityConfig {
  530. // Kerberos related configuration.
  531. KerberosConfig kerberos_config = 1;
  532. }
  533. // Specifies Kerberos related configuration.
  534. message KerberosConfig {
  535. // Optional. Flag to indicate whether to Kerberize the cluster (default:
  536. // false). Set this field to true to enable Kerberos on a cluster.
  537. bool enable_kerberos = 1 [(google.api.field_behavior) = OPTIONAL];
  538. // Required. The Cloud Storage URI of a KMS encrypted file containing the root
  539. // principal password.
  540. string root_principal_password_uri = 2
  541. [(google.api.field_behavior) = REQUIRED];
  542. // Required. The uri of the KMS key used to encrypt various sensitive
  543. // files.
  544. string kms_key_uri = 3 [(google.api.field_behavior) = REQUIRED];
  545. // Optional. The Cloud Storage URI of the keystore file used for SSL
  546. // encryption. If not provided, Dataproc will provide a self-signed
  547. // certificate.
  548. string keystore_uri = 4 [(google.api.field_behavior) = OPTIONAL];
  549. // Optional. The Cloud Storage URI of the truststore file used for SSL
  550. // encryption. If not provided, Dataproc will provide a self-signed
  551. // certificate.
  552. string truststore_uri = 5 [(google.api.field_behavior) = OPTIONAL];
  553. // Optional. The Cloud Storage URI of a KMS encrypted file containing the
  554. // password to the user provided keystore. For the self-signed certificate,
  555. // this password is generated by Dataproc.
  556. string keystore_password_uri = 6 [(google.api.field_behavior) = OPTIONAL];
  557. // Optional. The Cloud Storage URI of a KMS encrypted file containing the
  558. // password to the user provided key. For the self-signed certificate, this
  559. // password is generated by Dataproc.
  560. string key_password_uri = 7 [(google.api.field_behavior) = OPTIONAL];
  561. // Optional. The Cloud Storage URI of a KMS encrypted file containing the
  562. // password to the user provided truststore. For the self-signed certificate,
  563. // this password is generated by Dataproc.
  564. string truststore_password_uri = 8 [(google.api.field_behavior) = OPTIONAL];
  565. // Optional. The remote realm the Dataproc on-cluster KDC will trust, should
  566. // the user enable cross realm trust.
  567. string cross_realm_trust_realm = 9 [(google.api.field_behavior) = OPTIONAL];
  568. // Optional. The KDC (IP or hostname) for the remote trusted realm in a cross
  569. // realm trust relationship.
  570. string cross_realm_trust_kdc = 10 [(google.api.field_behavior) = OPTIONAL];
  571. // Optional. The admin server (IP or hostname) for the remote trusted realm in
  572. // a cross realm trust relationship.
  573. string cross_realm_trust_admin_server = 11
  574. [(google.api.field_behavior) = OPTIONAL];
  575. // Optional. The Cloud Storage URI of a KMS encrypted file containing the
  576. // shared password between the on-cluster Kerberos realm and the remote
  577. // trusted realm, in a cross realm trust relationship.
  578. string cross_realm_trust_shared_password_uri = 12
  579. [(google.api.field_behavior) = OPTIONAL];
  580. // Optional. The Cloud Storage URI of a KMS encrypted file containing the
  581. // master key of the KDC database.
  582. string kdc_db_key_uri = 13 [(google.api.field_behavior) = OPTIONAL];
  583. // Optional. The lifetime of the ticket granting ticket, in hours.
  584. // If not specified, or user specifies 0, then default value 10
  585. // will be used.
  586. int32 tgt_lifetime_hours = 14 [(google.api.field_behavior) = OPTIONAL];
  587. // Optional. The name of the on-cluster Kerberos realm.
  588. // If not specified, the uppercased domain of hostnames will be the realm.
  589. string realm = 15 [(google.api.field_behavior) = OPTIONAL];
  590. }
  591. // Specifies an executable to run on a fully configured node and a
  592. // timeout period for executable completion.
  593. message NodeInitializationAction {
  594. // Required. Cloud Storage URI of executable file.
  595. string executable_file = 1 [(google.api.field_behavior) = REQUIRED];
  596. // Optional. Amount of time executable has to complete. Default is
  597. // 10 minutes (see JSON representation of
  598. // [Duration](https://developers.google.com/protocol-buffers/docs/proto3#json)).
  599. //
  600. // Cluster creation fails with an explanatory error message (the
  601. // name of the executable that caused the error and the exceeded timeout
  602. // period) if the executable is not completed at end of the timeout period.
  603. google.protobuf.Duration execution_timeout = 2
  604. [(google.api.field_behavior) = OPTIONAL];
  605. }
  606. // The status of a cluster and its instances.
  607. message ClusterStatus {
  608. // The cluster state.
  609. enum State {
  610. // The cluster state is unknown.
  611. UNKNOWN = 0;
  612. // The cluster is being created and set up. It is not ready for use.
  613. CREATING = 1;
  614. // The cluster is currently running and healthy. It is ready for use.
  615. RUNNING = 2;
  616. // The cluster encountered an error. It is not ready for use.
  617. ERROR = 3;
  618. // The cluster is being deleted. It cannot be used.
  619. DELETING = 4;
  620. // The cluster is being updated. It continues to accept and process jobs.
  621. UPDATING = 5;
  622. // The cluster is being stopped. It cannot be used.
  623. STOPPING = 6;
  624. // The cluster is currently stopped. It is not ready for use.
  625. STOPPED = 7;
  626. // The cluster is being started. It is not ready for use.
  627. STARTING = 8;
  628. }
  629. // The cluster substate.
  630. enum Substate {
  631. // The cluster substate is unknown.
  632. UNSPECIFIED = 0;
  633. // The cluster is known to be in an unhealthy state
  634. // (for example, critical daemons are not running or HDFS capacity is
  635. // exhausted).
  636. //
  637. // Applies to RUNNING state.
  638. UNHEALTHY = 1;
  639. // The agent-reported status is out of date (may occur if
  640. // Dataproc loses communication with Agent).
  641. //
  642. // Applies to RUNNING state.
  643. STALE_STATUS = 2;
  644. }
  645. // Output only. The cluster's state.
  646. State state = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
  647. // Output only. Optional details of cluster's state.
  648. string detail = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
  649. // Output only. Time when this state was entered (see JSON representation of
  650. // [Timestamp](https://developers.google.com/protocol-buffers/docs/proto3#json)).
  651. google.protobuf.Timestamp state_start_time = 3
  652. [(google.api.field_behavior) = OUTPUT_ONLY];
  653. // Output only. Additional state information that includes
  654. // status reported by the agent.
  655. Substate substate = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
  656. }
  657. // Specifies the selection and config of software inside the cluster.
  658. message SoftwareConfig {
  659. // Optional. The version of software inside the cluster. It must be one of the
  660. // supported [Dataproc
  661. // Versions](https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc-versions#supported_dataproc_versions),
  662. // such as "1.2" (including a subminor version, such as "1.2.29"), or the
  663. // ["preview"
  664. // version](https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc-versions#other_versions).
  665. // If unspecified, it defaults to the latest Debian version.
  666. string image_version = 1 [(google.api.field_behavior) = OPTIONAL];
  667. // Optional. The properties to set on daemon config files.
  668. //
  669. // Property keys are specified in `prefix:property` format, for example
  670. // `core:hadoop.tmp.dir`. The following are supported prefixes
  671. // and their mappings:
  672. //
  673. // * capacity-scheduler: `capacity-scheduler.xml`
  674. // * core: `core-site.xml`
  675. // * distcp: `distcp-default.xml`
  676. // * hdfs: `hdfs-site.xml`
  677. // * hive: `hive-site.xml`
  678. // * mapred: `mapred-site.xml`
  679. // * pig: `pig.properties`
  680. // * spark: `spark-defaults.conf`
  681. // * yarn: `yarn-site.xml`
  682. //
  683. // For more information, see [Cluster
  684. // properties](https://cloud.google.com/dataproc/docs/concepts/cluster-properties).
  685. map<string, string> properties = 2 [(google.api.field_behavior) = OPTIONAL];
  686. // The set of optional components to activate on the cluster.
  687. repeated Component optional_components = 3;
  688. }
  689. // Contains cluster daemon metrics, such as HDFS and YARN stats.
  690. //
  691. // **Beta Feature**: This report is available for testing purposes only. It may
  692. // be changed before final release.
  693. message ClusterMetrics {
  694. // The HDFS metrics.
  695. map<string, int64> hdfs_metrics = 1;
  696. // The YARN metrics.
  697. map<string, int64> yarn_metrics = 2;
  698. }
  699. // A request to create a cluster.
  700. message CreateClusterRequest {
  701. // Required. The ID of the Google Cloud Platform project that the cluster
  702. // belongs to.
  703. string project_id = 1 [(google.api.field_behavior) = REQUIRED];
  704. // Required. The Dataproc region in which to handle the request.
  705. string region = 3 [(google.api.field_behavior) = REQUIRED];
  706. // Required. The cluster to create.
  707. Cluster cluster = 2 [(google.api.field_behavior) = REQUIRED];
  708. // Optional. A unique id used to identify the request. If the server
  709. // receives two
  710. // [CreateClusterRequest][google.cloud.dataproc.v1beta2.CreateClusterRequest]
  711. // requests with the same id, then the second request will be ignored and the
  712. // first [google.longrunning.Operation][google.longrunning.Operation] created
  713. // and stored in the backend is returned.
  714. //
  715. // It is recommended to always set this value to a
  716. // [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier).
  717. //
  718. // The id must contain only letters (a-z, A-Z), numbers (0-9),
  719. // underscores (_), and hyphens (-). The maximum length is 40 characters.
  720. string request_id = 4 [(google.api.field_behavior) = OPTIONAL];
  721. }
  722. // A request to update a cluster.
  723. message UpdateClusterRequest {
  724. // Required. The ID of the Google Cloud Platform project the
  725. // cluster belongs to.
  726. string project_id = 1 [(google.api.field_behavior) = REQUIRED];
  727. // Required. The Dataproc region in which to handle the request.
  728. string region = 5 [(google.api.field_behavior) = REQUIRED];
  729. // Required. The cluster name.
  730. string cluster_name = 2 [(google.api.field_behavior) = REQUIRED];
  731. // Required. The changes to the cluster.
  732. Cluster cluster = 3 [(google.api.field_behavior) = REQUIRED];
  733. // Optional. Timeout for graceful YARN decomissioning. Graceful
  734. // decommissioning allows removing nodes from the cluster without
  735. // interrupting jobs in progress. Timeout specifies how long to wait for jobs
  736. // in progress to finish before forcefully removing nodes (and potentially
  737. // interrupting jobs). Default timeout is 0 (for forceful decommission), and
  738. // the maximum allowed timeout is 1 day (see JSON representation of
  739. // [Duration](https://developers.google.com/protocol-buffers/docs/proto3#json)).
  740. //
  741. // Only supported on Dataproc image versions 1.2 and higher.
  742. google.protobuf.Duration graceful_decommission_timeout = 6
  743. [(google.api.field_behavior) = OPTIONAL];
  744. // Required. Specifies the path, relative to `Cluster`, of
  745. // the field to update. For example, to change the number of workers
  746. // in a cluster to 5, the `update_mask` parameter would be
  747. // specified as `config.worker_config.num_instances`,
  748. // and the `PATCH` request body would specify the new value, as follows:
  749. //
  750. // {
  751. // "config":{
  752. // "workerConfig":{
  753. // "numInstances":"5"
  754. // }
  755. // }
  756. // }
  757. //
  758. // Similarly, to change the number of preemptible workers in a cluster to 5,
  759. // the `update_mask` parameter would be
  760. // `config.secondary_worker_config.num_instances`, and the `PATCH` request
  761. // body would be set as follows:
  762. //
  763. // {
  764. // "config":{
  765. // "secondaryWorkerConfig":{
  766. // "numInstances":"5"
  767. // }
  768. // }
  769. // }
  770. // <strong>Note:</strong> currently only the following fields can be updated:
  771. //
  772. // <table>
  773. // <tr>
  774. // <td><strong>Mask</strong></td><td><strong>Purpose</strong></td>
  775. // </tr>
  776. // <tr>
  777. // <td>labels</td><td>Updates labels</td>
  778. // </tr>
  779. // <tr>
  780. // <td>config.worker_config.num_instances</td><td>Resize primary worker
  781. // group</td>
  782. // </tr>
  783. // <tr>
  784. // <td>config.secondary_worker_config.num_instances</td><td>Resize secondary
  785. // worker group</td>
  786. // </tr>
  787. // <tr>
  788. // <td>config.lifecycle_config.auto_delete_ttl</td><td>Reset MAX TTL
  789. // duration</td>
  790. // </tr>
  791. // <tr>
  792. // <td>config.lifecycle_config.auto_delete_time</td><td>Update MAX TTL
  793. // deletion timestamp</td>
  794. // </tr>
  795. // <tr>
  796. // <td>config.lifecycle_config.idle_delete_ttl</td><td>Update Idle TTL
  797. // duration</td>
  798. // </tr>
  799. // <tr>
  800. // <td>config.autoscaling_config.policy_uri</td><td>Use, stop using, or change
  801. // autoscaling policies</td>
  802. // </tr>
  803. // </table>
  804. google.protobuf.FieldMask update_mask = 4
  805. [(google.api.field_behavior) = REQUIRED];
  806. // Optional. A unique id used to identify the request. If the server
  807. // receives two
  808. // [UpdateClusterRequest][google.cloud.dataproc.v1beta2.UpdateClusterRequest]
  809. // requests with the same id, then the second request will be ignored and the
  810. // first [google.longrunning.Operation][google.longrunning.Operation] created
  811. // and stored in the backend is returned.
  812. //
  813. // It is recommended to always set this value to a
  814. // [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier).
  815. //
  816. // The id must contain only letters (a-z, A-Z), numbers (0-9),
  817. // underscores (_), and hyphens (-). The maximum length is 40 characters.
  818. string request_id = 7 [(google.api.field_behavior) = OPTIONAL];
  819. }
  820. // A request to delete a cluster.
  821. message DeleteClusterRequest {
  822. // Required. The ID of the Google Cloud Platform project that the cluster
  823. // belongs to.
  824. string project_id = 1 [(google.api.field_behavior) = REQUIRED];
  825. // Required. The Dataproc region in which to handle the request.
  826. string region = 3 [(google.api.field_behavior) = REQUIRED];
  827. // Required. The cluster name.
  828. string cluster_name = 2 [(google.api.field_behavior) = REQUIRED];
  829. // Optional. Specifying the `cluster_uuid` means the RPC should fail
  830. // (with error NOT_FOUND) if cluster with specified UUID does not exist.
  831. string cluster_uuid = 4 [(google.api.field_behavior) = OPTIONAL];
  832. // Optional. A unique id used to identify the request. If the server
  833. // receives two
  834. // [DeleteClusterRequest][google.cloud.dataproc.v1beta2.DeleteClusterRequest]
  835. // requests with the same id, then the second request will be ignored and the
  836. // first [google.longrunning.Operation][google.longrunning.Operation] created
  837. // and stored in the backend is returned.
  838. //
  839. // It is recommended to always set this value to a
  840. // [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier).
  841. //
  842. // The id must contain only letters (a-z, A-Z), numbers (0-9),
  843. // underscores (_), and hyphens (-). The maximum length is 40 characters.
  844. string request_id = 5 [(google.api.field_behavior) = OPTIONAL];
  845. }
  846. // Request to get the resource representation for a cluster in a project.
  847. message GetClusterRequest {
  848. // Required. The ID of the Google Cloud Platform project that the cluster
  849. // belongs to.
  850. string project_id = 1 [(google.api.field_behavior) = REQUIRED];
  851. // Required. The Dataproc region in which to handle the request.
  852. string region = 3 [(google.api.field_behavior) = REQUIRED];
  853. // Required. The cluster name.
  854. string cluster_name = 2 [(google.api.field_behavior) = REQUIRED];
  855. }
  856. // A request to list the clusters in a project.
  857. message ListClustersRequest {
  858. // Required. The ID of the Google Cloud Platform project that the cluster
  859. // belongs to.
  860. string project_id = 1 [(google.api.field_behavior) = REQUIRED];
  861. // Required. The Dataproc region in which to handle the request.
  862. string region = 4 [(google.api.field_behavior) = REQUIRED];
  863. // Optional. A filter constraining the clusters to list. Filters are
  864. // case-sensitive and have the following syntax:
  865. //
  866. // field = value [AND [field = value]] ...
  867. //
  868. // where **field** is one of `status.state`, `clusterName`, or `labels.[KEY]`,
  869. // and `[KEY]` is a label key. **value** can be `*` to match all values.
  870. // `status.state` can be one of the following: `ACTIVE`, `INACTIVE`,
  871. // `CREATING`, `RUNNING`, `ERROR`, `DELETING`, or `UPDATING`. `ACTIVE`
  872. // contains the `CREATING`, `UPDATING`, and `RUNNING` states. `INACTIVE`
  873. // contains the `DELETING` and `ERROR` states.
  874. // `clusterName` is the name of the cluster provided at creation time.
  875. // Only the logical `AND` operator is supported; space-separated items are
  876. // treated as having an implicit `AND` operator.
  877. //
  878. // Example filter:
  879. //
  880. // status.state = ACTIVE AND clusterName = mycluster
  881. // AND labels.env = staging AND labels.starred = *
  882. string filter = 5 [(google.api.field_behavior) = OPTIONAL];
  883. // Optional. The standard List page size.
  884. int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL];
  885. // Optional. The standard List page token.
  886. string page_token = 3 [(google.api.field_behavior) = OPTIONAL];
  887. }
  888. // The list of all clusters in a project.
  889. message ListClustersResponse {
  890. // Output only. The clusters in the project.
  891. repeated Cluster clusters = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
  892. // Output only. This token is included in the response if there are more
  893. // results to fetch. To fetch additional results, provide this value as the
  894. // `page_token` in a subsequent <code>ListClustersRequest</code>.
  895. string next_page_token = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
  896. }
  897. // A request to collect cluster diagnostic information.
  898. message DiagnoseClusterRequest {
  899. // Required. The ID of the Google Cloud Platform project that the cluster
  900. // belongs to.
  901. string project_id = 1 [(google.api.field_behavior) = REQUIRED];
  902. // Required. The Dataproc region in which to handle the request.
  903. string region = 3 [(google.api.field_behavior) = REQUIRED];
  904. // Required. The cluster name.
  905. string cluster_name = 2 [(google.api.field_behavior) = REQUIRED];
  906. }
  907. // The location of diagnostic output.
  908. message DiagnoseClusterResults {
  909. // Output only. The Cloud Storage URI of the diagnostic output.
  910. // The output report is a plain text file with a summary of collected
  911. // diagnostics.
  912. string output_uri = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
  913. }
  914. // Reservation Affinity for consuming Zonal reservation.
  915. message ReservationAffinity {
  916. // Indicates whether to consume capacity from an reservation or not.
  917. enum Type {
  918. TYPE_UNSPECIFIED = 0;
  919. // Do not consume from any allocated capacity.
  920. NO_RESERVATION = 1;
  921. // Consume any reservation available.
  922. ANY_RESERVATION = 2;
  923. // Must consume from a specific reservation. Must specify key value fields
  924. // for specifying the reservations.
  925. SPECIFIC_RESERVATION = 3;
  926. }
  927. // Optional. Type of reservation to consume
  928. Type consume_reservation_type = 1 [(google.api.field_behavior) = OPTIONAL];
  929. // Optional. Corresponds to the label key of reservation resource.
  930. string key = 2 [(google.api.field_behavior) = OPTIONAL];
  931. // Optional. Corresponds to the label values of reservation resource.
  932. repeated string values = 3 [(google.api.field_behavior) = OPTIONAL];
  933. }