1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="dataproc_v1alpha1.html">Google Cloud Dataproc API</a> . <a href="dataproc_v1alpha1.projects.html">projects</a> . <a href="dataproc_v1alpha1.projects.regions.html">regions</a> . <a href="dataproc_v1alpha1.projects.regions.clusters.html">clusters</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#create">create(projectId, region, body, x__xgafv=None)</a></code></p>
<p class="firstline">Request to create a cluster in a project.</p>
<p class="toc_element">
<code><a href="#delete">delete(projectId, region, clusterName, x__xgafv=None)</a></code></p>
<p class="firstline">Request to delete a cluster in a project.</p>
<p class="toc_element">
<code><a href="#get">get(projectId, region, clusterName, x__xgafv=None)</a></code></p>
<p class="firstline">Request to get the resource representation for a cluster in a project.</p>
<p class="toc_element">
<code><a href="#list">list(projectId, region, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Request a list of all regions/{region}/clusters in a project.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(projectId, region, clusterName, body, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Request to update a cluster in a project.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="create">create(projectId, region, body, x__xgafv=None)</code>
<pre>Request to create a cluster in a project.
Args:
projectId: string, Required The ID of the Google Cloud Platform project that the cluster belongs to. (required)
region: string, Required The Dataproc region in which to handle the request. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Describes the identifying information, configuration, and status of a cluster of Google Compute Engine instances.
"status": { # The status of a cluster and its instances. # Output-only Cluster status.
"state": "A String", # The cluster's state.
"stateStartTime": "A String", # Time when this state was entered.
"substate": "A String", # Output-only Additional state information that includes status reported by the agent.
"detail": "A String", # Optional details of cluster's state.
},
"configuration": { # The cluster configuration. # Required The cluster configuration. It may differ from a user's initial configuration due to Cloud Dataproc setting of default values and updating clusters.
"workerDiskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Deprecated The configuration settings of worker node disk options.
"numLocalSsds": 42, # Optional Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
"bootDiskSizeGb": 42, # Optional Size in GB of the boot disk (default is 500GB).
},
"softwareConfiguration": { # Specifies the selection and configuration of software inside the cluster. # Optional The configuration settings for software inside the cluster.
"imageVersion": "A String", # Optional The version of software inside the cluster. It must match the regular expression 0-9+.0-9+. If unspecified it will default to latest version.
"properties": { # Optional The properties to set on daemon configuration files.Property keys are specified in "prefix:property" format, such as "core:fs.defaultFS". The following are supported prefixes and their mappings: core - core-site.xml hdfs - hdfs-site.xml mapred - mapred-site.xml yarn - yarn-site.xml hive - hive-site.xml pig - pig.properties spark - spark-defaults.conf
"a_key": "A String",
},
},
"workers": [ # Deprecated The list of worker node names. Dataproc derives the names from cluster_name and num_workers if not set by user (recommended practice is to let Dataproc derive the name). Derived worker node name example: hadoop-w-0.
"A String",
],
"masterConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # Optional The Google Compute Engine configuration settings for the master instance in a cluster.
"isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
"machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: "compute.googleapis.com/projects/project_id /zones/us-east1-a/machineTypes/n1-standard-2".
"instanceNames": [ # The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
"A String",
],
"imageUri": "A String", # Output-only The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfiguration.image_version. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
"accelerators": [ # Optional The Google Compute Engine accelerator configuration for these instances.
{ # Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).
"acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
"acceleratorTypeUri": "A String", # Full or partial URI of the accelerator type resource to expose to this instance. See Google Compute Engine AcceleratorTypes( /compute/docs/reference/beta/acceleratorTypes)
},
],
"numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
"diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
"numLocalSsds": 42, # Optional Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
"bootDiskSizeGb": 42, # Optional Size in GB of the boot disk (default is 500GB).
},
"managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # Output-only The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
"instanceTemplateName": "A String", # Output-only The name of Instance Template used for Managed Instance Group.
"instanceGroupManagerName": "A String", # Output-only The name of Instance Group Manager managing this group.
},
},
"gceClusterConfiguration": { # Common configuration settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster. # Optional The shared Google Compute Engine configuration settings for all instances in a cluster.
"internalIpOnly": True or False, # If true, all instances in the cluser will only have internal IP addresses. By default, clusters are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each instance. This restriction can only be enabled for subnetwork enabled networks, and all off-cluster dependencies must be configured to be accessible without external IP addresses.
"networkUri": "A String", # The Google Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a "Custom Subnet Network" (see https://cloud.google.com/compute/docs/subnetworks for more information). Example: compute.googleapis.com/projects/[project_id]/regions/global/default.
"tags": [ # The Google Compute Engine tags to add to all instances.
"A String",
],
"serviceAccount": "A String", # Optional The service account of the instances. Defaults to the default Google Compute Engine service account. Custom service accounts need permissions equivalent to the folloing IAM roles:
# roles/logging.logWriter
# roles/storage.objectAdmin(see https://cloud.google.com/compute/docs/access/service-accounts#custom_service_accounts for more information). Example: [account_id]@[project_id].iam.gserviceaccount.com
"zoneUri": "A String", # Required The zone where the Google Compute Engine cluster will be located. Example: "compute.googleapis.com/projects/project_id /zones/us-east1-a".
"subnetworkUri": "A String", # The Google Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri. Example: compute.googleapis.com/projects/[project_id]/regions/us-east1/sub0.
"serviceAccountScopes": [ # The service account scopes included in Google Compute Engine instances. Must include devstorage.full_control to enable the Google Cloud Storage connector. Example "auth.googleapis.com/compute" and "auth.googleapis.com/devstorage.full_control".
"A String",
],
"metadata": { # The Google Compute Engine metadata entries to add to all instances.
"a_key": "A String",
},
},
"masterName": "A String", # Deprecated The Master's hostname. Dataproc derives the name from cluster_name if not set by user (recommended practice is to let Dataproc derive the name). Derived master name example: hadoop-m.
"configurationBucket": "A String", # Optional A Google Cloud Storage staging bucket used for sharing generated SSH keys and configuration. If you do not specify a staging bucket, Cloud Dataproc will determine an appropriate Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Google Compute Engine zone where your cluster is deployed, then it will create and manage this project-level, per-location bucket for you.
"gceConfiguration": { # Deprecated Common configuration settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster. # Deprecated The Google Compute Engine configuration settings for cluster resources.
"machineTypeUri": "A String", # Deprecated The Google Compute Engine machine type used for cluster instances. Example: "compute.googleapis.com/projects/project_id /zones/us-east1-a/machineTypes/n1-standard-2".
"networkUri": "A String", # Deprecated The Google Compute Engine network to be used for machine communications. Inbound SSH connections are necessary to complete cluster configuration. Example "compute.googleapis.com/projects/project_id /zones/us-east1-a/default".
"zoneUri": "A String", # Deprecated The zone where the Google Compute Engine cluster will be located. Example: "compute.googleapis.com/projects/project_id /zones/us-east1-a".
"serviceAccountScopes": [ # Deprecated The service account scopes included in Google Compute Engine instances. Must include devstorage.full_control to enable the Google Cloud Storage connector. Example "auth.googleapis.com/compute" and "auth.googleapis.com/devstorage.full_control".
"A String",
],
"imageUri": "A String", # Deprecated The Google Compute Engine image resource used for cluster instances. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
},
"masterDiskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Deprecated The configuration settings of master node disk options.
"numLocalSsds": 42, # Optional Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
"bootDiskSizeGb": 42, # Optional Size in GB of the boot disk (default is 500GB).
},
"numWorkers": 42, # Deprecated The number of worker nodes in the cluster.
"initializationActions": [ # Optional Commands to execute on each node after configuration is completed. By default, executables are run on master and all worker nodes. You can test a node's <code>role</code> metadata to run an executable on a master or worker node, as shown below:
# ROLE=$(/usr/share/google/get_metadata_value attributes/role)
# if [[ "${ROLE}" == 'Master' ]]; then
# ... master specific actions ...
# else
# ... worker specific actions ...
# fi
{ # Specifies an executable to run on a fully configured node and a timeout period for executable completion.
"executionTimeout": "A String", # Optional Amount of time executable has to complete. Default is 10 minutes. Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period.
"executableFile": "A String", # Required Google Cloud Storage URI of executable file.
},
],
"secondaryWorkerConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # Optional The Google Compute Engine configuration settings for additional worker instances in a cluster.
"isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
"machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: "compute.googleapis.com/projects/project_id /zones/us-east1-a/machineTypes/n1-standard-2".
"instanceNames": [ # The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
"A String",
],
"imageUri": "A String", # Output-only The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfiguration.image_version. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
"accelerators": [ # Optional The Google Compute Engine accelerator configuration for these instances.
{ # Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).
"acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
"acceleratorTypeUri": "A String", # Full or partial URI of the accelerator type resource to expose to this instance. See Google Compute Engine AcceleratorTypes( /compute/docs/reference/beta/acceleratorTypes)
},
],
"numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
"diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
"numLocalSsds": 42, # Optional Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
"bootDiskSizeGb": 42, # Optional Size in GB of the boot disk (default is 500GB).
},
"managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # Output-only The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
"instanceTemplateName": "A String", # Output-only The name of Instance Template used for Managed Instance Group.
"instanceGroupManagerName": "A String", # Output-only The name of Instance Group Manager managing this group.
},
},
"workerConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # Optional The Google Compute Engine configuration settings for worker instances in a cluster.
"isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
"machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: "compute.googleapis.com/projects/project_id /zones/us-east1-a/machineTypes/n1-standard-2".
"instanceNames": [ # The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
"A String",
],
"imageUri": "A String", # Output-only The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfiguration.image_version. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
"accelerators": [ # Optional The Google Compute Engine accelerator configuration for these instances.
{ # Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).
"acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
"acceleratorTypeUri": "A String", # Full or partial URI of the accelerator type resource to expose to this instance. See Google Compute Engine AcceleratorTypes( /compute/docs/reference/beta/acceleratorTypes)
},
],
"numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
"diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
"numLocalSsds": 42, # Optional Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
"bootDiskSizeGb": 42, # Optional Size in GB of the boot disk (default is 500GB).
},
"managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # Output-only The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
"instanceTemplateName": "A String", # Output-only The name of Instance Template used for Managed Instance Group.
"instanceGroupManagerName": "A String", # Output-only The name of Instance Group Manager managing this group.
},
},
},
"clusterUuid": "A String", # Output-only A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.
"clusterName": "A String", # Required The cluster name. Cluster names within a project must be unique. Names from deleted clusters can be reused.
"projectId": "A String", # Required The Google Cloud Platform project ID that the cluster belongs to.
"labels": { # Optional The labels to associate with this cluster.Label keys must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 64 labels can be associated with a given cluster.
"a_key": "A String",
},
"metrics": { # Contains cluster daemon metrics, such as HDFS and YARN stats. # Contains cluster daemon metrics such as HDFS and YARN stats.
"yarnMetrics": { # The YARN metrics.
"a_key": "A String",
},
"hdfsMetrics": { # The HDFS metrics.
"a_key": "A String",
},
},
"statusHistory": [ # Output-only Previous cluster statuses.
{ # The status of a cluster and its instances.
"state": "A String", # The cluster's state.
"stateStartTime": "A String", # Time when this state was entered.
"substate": "A String", # Output-only Additional state information that includes status reported by the agent.
"detail": "A String", # Optional details of cluster's state.
},
],
"createTime": "A String", # Output-only The timestamp of cluster creation.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # An asynchronous operation in a project that runs over a given cluster. Used to track the progress of a user request that is running asynchronously. Examples include creating a cluster, updating a cluster, and deleting a cluster.
"metadata": { # Service-specific metadata associated with the operation.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"error": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). The error model is designed to be: # The error result of the operation in case of failure.
# Simple to use and understand for most users
# Flexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include:
# Partial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors.
# Workflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.
# Batch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response.
# Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message.
# Logging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
},
"done": True or False, # Indicates if the operation is done. If true, the operation is complete and the result is available. If false, the operation is still in progress.
"response": { # The operation response. If the called method returns no data on success, the response is google.protobuf.Empty. If the called method is Get,Create or Update, the response is the resource. For all other methods, the response type is a concatenation of the method name and "Response". For example, if the called method is TakeSnapshot(), the response type is TakeSnapshotResponse.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The name of the operation resource, in the format projects/project_id/operations/operation_id
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(projectId, region, clusterName, x__xgafv=None)</code>
<pre>Request to delete a cluster in a project.
Args:
projectId: string, Required The ID of the Google Cloud Platform project that the cluster belongs to. (required)
region: string, Required The Dataproc region in which to handle the request. (required)
clusterName: string, Required The cluster name. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # An asynchronous operation in a project that runs over a given cluster. Used to track the progress of a user request that is running asynchronously. Examples include creating a cluster, updating a cluster, and deleting a cluster.
"metadata": { # Service-specific metadata associated with the operation.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"error": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). The error model is designed to be: # The error result of the operation in case of failure.
# Simple to use and understand for most users
# Flexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include:
# Partial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors.
# Workflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.
# Batch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response.
# Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message.
# Logging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
},
"done": True or False, # Indicates if the operation is done. If true, the operation is complete and the result is available. If false, the operation is still in progress.
"response": { # The operation response. If the called method returns no data on success, the response is google.protobuf.Empty. If the called method is Get,Create or Update, the response is the resource. For all other methods, the response type is a concatenation of the method name and "Response". For example, if the called method is TakeSnapshot(), the response type is TakeSnapshotResponse.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The name of the operation resource, in the format projects/project_id/operations/operation_id
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(projectId, region, clusterName, x__xgafv=None)</code>
<pre>Request to get the resource representation for a cluster in a project.
Args:
projectId: string, Required The ID of the Google Cloud Platform project that the cluster belongs to. (required)
region: string, Required The Dataproc region in which to handle the request. (required)
clusterName: string, Required The cluster name. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Describes the identifying information, configuration, and status of a cluster of Google Compute Engine instances.
"status": { # The status of a cluster and its instances. # Output-only Cluster status.
"state": "A String", # The cluster's state.
"stateStartTime": "A String", # Time when this state was entered.
"substate": "A String", # Output-only Additional state information that includes status reported by the agent.
"detail": "A String", # Optional details of cluster's state.
},
"configuration": { # The cluster configuration. # Required The cluster configuration. It may differ from a user's initial configuration due to Cloud Dataproc setting of default values and updating clusters.
"workerDiskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Deprecated The configuration settings of worker node disk options.
"numLocalSsds": 42, # Optional Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
"bootDiskSizeGb": 42, # Optional Size in GB of the boot disk (default is 500GB).
},
"softwareConfiguration": { # Specifies the selection and configuration of software inside the cluster. # Optional The configuration settings for software inside the cluster.
"imageVersion": "A String", # Optional The version of software inside the cluster. It must match the regular expression 0-9+.0-9+. If unspecified it will default to latest version.
"properties": { # Optional The properties to set on daemon configuration files.Property keys are specified in "prefix:property" format, such as "core:fs.defaultFS". The following are supported prefixes and their mappings: core - core-site.xml hdfs - hdfs-site.xml mapred - mapred-site.xml yarn - yarn-site.xml hive - hive-site.xml pig - pig.properties spark - spark-defaults.conf
"a_key": "A String",
},
},
"workers": [ # Deprecated The list of worker node names. Dataproc derives the names from cluster_name and num_workers if not set by user (recommended practice is to let Dataproc derive the name). Derived worker node name example: hadoop-w-0.
"A String",
],
"masterConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # Optional The Google Compute Engine configuration settings for the master instance in a cluster.
"isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
"machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: "compute.googleapis.com/projects/project_id /zones/us-east1-a/machineTypes/n1-standard-2".
"instanceNames": [ # The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
"A String",
],
"imageUri": "A String", # Output-only The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfiguration.image_version. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
"accelerators": [ # Optional The Google Compute Engine accelerator configuration for these instances.
{ # Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).
"acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
"acceleratorTypeUri": "A String", # Full or partial URI of the accelerator type resource to expose to this instance. See Google Compute Engine AcceleratorTypes( /compute/docs/reference/beta/acceleratorTypes)
},
],
"numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
"diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
"numLocalSsds": 42, # Optional Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
"bootDiskSizeGb": 42, # Optional Size in GB of the boot disk (default is 500GB).
},
"managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # Output-only The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
"instanceTemplateName": "A String", # Output-only The name of Instance Template used for Managed Instance Group.
"instanceGroupManagerName": "A String", # Output-only The name of Instance Group Manager managing this group.
},
},
"gceClusterConfiguration": { # Common configuration settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster. # Optional The shared Google Compute Engine configuration settings for all instances in a cluster.
"internalIpOnly": True or False, # If true, all instances in the cluser will only have internal IP addresses. By default, clusters are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each instance. This restriction can only be enabled for subnetwork enabled networks, and all off-cluster dependencies must be configured to be accessible without external IP addresses.
"networkUri": "A String", # The Google Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a "Custom Subnet Network" (see https://cloud.google.com/compute/docs/subnetworks for more information). Example: compute.googleapis.com/projects/[project_id]/regions/global/default.
"tags": [ # The Google Compute Engine tags to add to all instances.
"A String",
],
"serviceAccount": "A String", # Optional The service account of the instances. Defaults to the default Google Compute Engine service account. Custom service accounts need permissions equivalent to the folloing IAM roles:
# roles/logging.logWriter
# roles/storage.objectAdmin(see https://cloud.google.com/compute/docs/access/service-accounts#custom_service_accounts for more information). Example: [account_id]@[project_id].iam.gserviceaccount.com
"zoneUri": "A String", # Required The zone where the Google Compute Engine cluster will be located. Example: "compute.googleapis.com/projects/project_id /zones/us-east1-a".
"subnetworkUri": "A String", # The Google Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri. Example: compute.googleapis.com/projects/[project_id]/regions/us-east1/sub0.
"serviceAccountScopes": [ # The service account scopes included in Google Compute Engine instances. Must include devstorage.full_control to enable the Google Cloud Storage connector. Example "auth.googleapis.com/compute" and "auth.googleapis.com/devstorage.full_control".
"A String",
],
"metadata": { # The Google Compute Engine metadata entries to add to all instances.
"a_key": "A String",
},
},
"masterName": "A String", # Deprecated The Master's hostname. Dataproc derives the name from cluster_name if not set by user (recommended practice is to let Dataproc derive the name). Derived master name example: hadoop-m.
"configurationBucket": "A String", # Optional A Google Cloud Storage staging bucket used for sharing generated SSH keys and configuration. If you do not specify a staging bucket, Cloud Dataproc will determine an appropriate Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Google Compute Engine zone where your cluster is deployed, then it will create and manage this project-level, per-location bucket for you.
"gceConfiguration": { # Deprecated Common configuration settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster. # Deprecated The Google Compute Engine configuration settings for cluster resources.
"machineTypeUri": "A String", # Deprecated The Google Compute Engine machine type used for cluster instances. Example: "compute.googleapis.com/projects/project_id /zones/us-east1-a/machineTypes/n1-standard-2".
"networkUri": "A String", # Deprecated The Google Compute Engine network to be used for machine communications. Inbound SSH connections are necessary to complete cluster configuration. Example "compute.googleapis.com/projects/project_id /zones/us-east1-a/default".
"zoneUri": "A String", # Deprecated The zone where the Google Compute Engine cluster will be located. Example: "compute.googleapis.com/projects/project_id /zones/us-east1-a".
"serviceAccountScopes": [ # Deprecated The service account scopes included in Google Compute Engine instances. Must include devstorage.full_control to enable the Google Cloud Storage connector. Example "auth.googleapis.com/compute" and "auth.googleapis.com/devstorage.full_control".
"A String",
],
"imageUri": "A String", # Deprecated The Google Compute Engine image resource used for cluster instances. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
},
"masterDiskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Deprecated The configuration settings of master node disk options.
"numLocalSsds": 42, # Optional Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
"bootDiskSizeGb": 42, # Optional Size in GB of the boot disk (default is 500GB).
},
"numWorkers": 42, # Deprecated The number of worker nodes in the cluster.
"initializationActions": [ # Optional Commands to execute on each node after configuration is completed. By default, executables are run on master and all worker nodes. You can test a node's <code>role</code> metadata to run an executable on a master or worker node, as shown below:
# ROLE=$(/usr/share/google/get_metadata_value attributes/role)
# if [[ "${ROLE}" == 'Master' ]]; then
# ... master specific actions ...
# else
# ... worker specific actions ...
# fi
{ # Specifies an executable to run on a fully configured node and a timeout period for executable completion.
"executionTimeout": "A String", # Optional Amount of time executable has to complete. Default is 10 minutes. Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period.
"executableFile": "A String", # Required Google Cloud Storage URI of executable file.
},
],
"secondaryWorkerConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # Optional The Google Compute Engine configuration settings for additional worker instances in a cluster.
"isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
"machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: "compute.googleapis.com/projects/project_id /zones/us-east1-a/machineTypes/n1-standard-2".
"instanceNames": [ # The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
"A String",
],
"imageUri": "A String", # Output-only The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfiguration.image_version. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
"accelerators": [ # Optional The Google Compute Engine accelerator configuration for these instances.
{ # Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).
"acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
"acceleratorTypeUri": "A String", # Full or partial URI of the accelerator type resource to expose to this instance. See Google Compute Engine AcceleratorTypes( /compute/docs/reference/beta/acceleratorTypes)
},
],
"numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
"diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
"numLocalSsds": 42, # Optional Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
"bootDiskSizeGb": 42, # Optional Size in GB of the boot disk (default is 500GB).
},
"managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # Output-only The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
"instanceTemplateName": "A String", # Output-only The name of Instance Template used for Managed Instance Group.
"instanceGroupManagerName": "A String", # Output-only The name of Instance Group Manager managing this group.
},
},
"workerConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # Optional The Google Compute Engine configuration settings for worker instances in a cluster.
"isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
"machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: "compute.googleapis.com/projects/project_id /zones/us-east1-a/machineTypes/n1-standard-2".
"instanceNames": [ # The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
"A String",
],
"imageUri": "A String", # Output-only The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfiguration.image_version. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
"accelerators": [ # Optional The Google Compute Engine accelerator configuration for these instances.
{ # Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).
"acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
"acceleratorTypeUri": "A String", # Full or partial URI of the accelerator type resource to expose to this instance. See Google Compute Engine AcceleratorTypes( /compute/docs/reference/beta/acceleratorTypes)
},
],
"numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
"diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
"numLocalSsds": 42, # Optional Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
"bootDiskSizeGb": 42, # Optional Size in GB of the boot disk (default is 500GB).
},
"managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # Output-only The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
"instanceTemplateName": "A String", # Output-only The name of Instance Template used for Managed Instance Group.
"instanceGroupManagerName": "A String", # Output-only The name of Instance Group Manager managing this group.
},
},
},
"clusterUuid": "A String", # Output-only A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.
"clusterName": "A String", # Required The cluster name. Cluster names within a project must be unique. Names from deleted clusters can be reused.
"projectId": "A String", # Required The Google Cloud Platform project ID that the cluster belongs to.
"labels": { # Optional The labels to associate with this cluster.Label keys must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 64 labels can be associated with a given cluster.
"a_key": "A String",
},
"metrics": { # Contains cluster daemon metrics, such as HDFS and YARN stats. # Contains cluster daemon metrics such as HDFS and YARN stats.
"yarnMetrics": { # The YARN metrics.
"a_key": "A String",
},
"hdfsMetrics": { # The HDFS metrics.
"a_key": "A String",
},
},
"statusHistory": [ # Output-only Previous cluster statuses.
{ # The status of a cluster and its instances.
"state": "A String", # The cluster's state.
"stateStartTime": "A String", # Time when this state was entered.
"substate": "A String", # Output-only Additional state information that includes status reported by the agent.
"detail": "A String", # Optional details of cluster's state.
},
],
"createTime": "A String", # Output-only The timestamp of cluster creation.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(projectId, region, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</code>
<pre>Request a list of all regions/{region}/clusters in a project.
Args:
projectId: string, Required The ID of the Google Cloud Platform project that the cluster belongs to. (required)
region: string, Required The Dataproc region in which to handle the request. (required)
pageSize: integer, The standard List page size.
filter: string, Optional A filter constraining which clusters to list. Valid filters contain label terms such as: labels.key1 = val1 AND (-labels.k2 = val2 OR labels.k3 = val3)
pageToken: string, The standard List page token.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The list of all clusters in a project.
"nextPageToken": "A String", # The standard List next-page token.
"clusters": [ # Output-only The clusters in the project.
{ # Describes the identifying information, configuration, and status of a cluster of Google Compute Engine instances.
"status": { # The status of a cluster and its instances. # Output-only Cluster status.
"state": "A String", # The cluster's state.
"stateStartTime": "A String", # Time when this state was entered.
"substate": "A String", # Output-only Additional state information that includes status reported by the agent.
"detail": "A String", # Optional details of cluster's state.
},
"configuration": { # The cluster configuration. # Required The cluster configuration. It may differ from a user's initial configuration due to Cloud Dataproc setting of default values and updating clusters.
"workerDiskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Deprecated The configuration settings of worker node disk options.
"numLocalSsds": 42, # Optional Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
"bootDiskSizeGb": 42, # Optional Size in GB of the boot disk (default is 500GB).
},
"softwareConfiguration": { # Specifies the selection and configuration of software inside the cluster. # Optional The configuration settings for software inside the cluster.
"imageVersion": "A String", # Optional The version of software inside the cluster. It must match the regular expression 0-9+.0-9+. If unspecified it will default to latest version.
"properties": { # Optional The properties to set on daemon configuration files.Property keys are specified in "prefix:property" format, such as "core:fs.defaultFS". The following are supported prefixes and their mappings: core - core-site.xml hdfs - hdfs-site.xml mapred - mapred-site.xml yarn - yarn-site.xml hive - hive-site.xml pig - pig.properties spark - spark-defaults.conf
"a_key": "A String",
},
},
"workers": [ # Deprecated The list of worker node names. Dataproc derives the names from cluster_name and num_workers if not set by user (recommended practice is to let Dataproc derive the name). Derived worker node name example: hadoop-w-0.
"A String",
],
"masterConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # Optional The Google Compute Engine configuration settings for the master instance in a cluster.
"isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
"machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: "compute.googleapis.com/projects/project_id /zones/us-east1-a/machineTypes/n1-standard-2".
"instanceNames": [ # The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
"A String",
],
"imageUri": "A String", # Output-only The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfiguration.image_version. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
"accelerators": [ # Optional The Google Compute Engine accelerator configuration for these instances.
{ # Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).
"acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
"acceleratorTypeUri": "A String", # Full or partial URI of the accelerator type resource to expose to this instance. See Google Compute Engine AcceleratorTypes( /compute/docs/reference/beta/acceleratorTypes)
},
],
"numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
"diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
"numLocalSsds": 42, # Optional Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
"bootDiskSizeGb": 42, # Optional Size in GB of the boot disk (default is 500GB).
},
"managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # Output-only The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
"instanceTemplateName": "A String", # Output-only The name of Instance Template used for Managed Instance Group.
"instanceGroupManagerName": "A String", # Output-only The name of Instance Group Manager managing this group.
},
},
"gceClusterConfiguration": { # Common configuration settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster. # Optional The shared Google Compute Engine configuration settings for all instances in a cluster.
"internalIpOnly": True or False, # If true, all instances in the cluser will only have internal IP addresses. By default, clusters are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each instance. This restriction can only be enabled for subnetwork enabled networks, and all off-cluster dependencies must be configured to be accessible without external IP addresses.
"networkUri": "A String", # The Google Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a "Custom Subnet Network" (see https://cloud.google.com/compute/docs/subnetworks for more information). Example: compute.googleapis.com/projects/[project_id]/regions/global/default.
"tags": [ # The Google Compute Engine tags to add to all instances.
"A String",
],
"serviceAccount": "A String", # Optional The service account of the instances. Defaults to the default Google Compute Engine service account. Custom service accounts need permissions equivalent to the folloing IAM roles:
# roles/logging.logWriter
# roles/storage.objectAdmin(see https://cloud.google.com/compute/docs/access/service-accounts#custom_service_accounts for more information). Example: [account_id]@[project_id].iam.gserviceaccount.com
"zoneUri": "A String", # Required The zone where the Google Compute Engine cluster will be located. Example: "compute.googleapis.com/projects/project_id /zones/us-east1-a".
"subnetworkUri": "A String", # The Google Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri. Example: compute.googleapis.com/projects/[project_id]/regions/us-east1/sub0.
"serviceAccountScopes": [ # The service account scopes included in Google Compute Engine instances. Must include devstorage.full_control to enable the Google Cloud Storage connector. Example "auth.googleapis.com/compute" and "auth.googleapis.com/devstorage.full_control".
"A String",
],
"metadata": { # The Google Compute Engine metadata entries to add to all instances.
"a_key": "A String",
},
},
"masterName": "A String", # Deprecated The Master's hostname. Dataproc derives the name from cluster_name if not set by user (recommended practice is to let Dataproc derive the name). Derived master name example: hadoop-m.
"configurationBucket": "A String", # Optional A Google Cloud Storage staging bucket used for sharing generated SSH keys and configuration. If you do not specify a staging bucket, Cloud Dataproc will determine an appropriate Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Google Compute Engine zone where your cluster is deployed, then it will create and manage this project-level, per-location bucket for you.
"gceConfiguration": { # Deprecated Common configuration settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster. # Deprecated The Google Compute Engine configuration settings for cluster resources.
"machineTypeUri": "A String", # Deprecated The Google Compute Engine machine type used for cluster instances. Example: "compute.googleapis.com/projects/project_id /zones/us-east1-a/machineTypes/n1-standard-2".
"networkUri": "A String", # Deprecated The Google Compute Engine network to be used for machine communications. Inbound SSH connections are necessary to complete cluster configuration. Example "compute.googleapis.com/projects/project_id /zones/us-east1-a/default".
"zoneUri": "A String", # Deprecated The zone where the Google Compute Engine cluster will be located. Example: "compute.googleapis.com/projects/project_id /zones/us-east1-a".
"serviceAccountScopes": [ # Deprecated The service account scopes included in Google Compute Engine instances. Must include devstorage.full_control to enable the Google Cloud Storage connector. Example "auth.googleapis.com/compute" and "auth.googleapis.com/devstorage.full_control".
"A String",
],
"imageUri": "A String", # Deprecated The Google Compute Engine image resource used for cluster instances. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
},
"masterDiskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Deprecated The configuration settings of master node disk options.
"numLocalSsds": 42, # Optional Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
"bootDiskSizeGb": 42, # Optional Size in GB of the boot disk (default is 500GB).
},
"numWorkers": 42, # Deprecated The number of worker nodes in the cluster.
"initializationActions": [ # Optional Commands to execute on each node after configuration is completed. By default, executables are run on master and all worker nodes. You can test a node's <code>role</code> metadata to run an executable on a master or worker node, as shown below:
# ROLE=$(/usr/share/google/get_metadata_value attributes/role)
# if [[ "${ROLE}" == 'Master' ]]; then
# ... master specific actions ...
# else
# ... worker specific actions ...
# fi
{ # Specifies an executable to run on a fully configured node and a timeout period for executable completion.
"executionTimeout": "A String", # Optional Amount of time executable has to complete. Default is 10 minutes. Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period.
"executableFile": "A String", # Required Google Cloud Storage URI of executable file.
},
],
"secondaryWorkerConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # Optional The Google Compute Engine configuration settings for additional worker instances in a cluster.
"isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
"machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: "compute.googleapis.com/projects/project_id /zones/us-east1-a/machineTypes/n1-standard-2".
"instanceNames": [ # The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
"A String",
],
"imageUri": "A String", # Output-only The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfiguration.image_version. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
"accelerators": [ # Optional The Google Compute Engine accelerator configuration for these instances.
{ # Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).
"acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
"acceleratorTypeUri": "A String", # Full or partial URI of the accelerator type resource to expose to this instance. See Google Compute Engine AcceleratorTypes( /compute/docs/reference/beta/acceleratorTypes)
},
],
"numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
"diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
"numLocalSsds": 42, # Optional Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
"bootDiskSizeGb": 42, # Optional Size in GB of the boot disk (default is 500GB).
},
"managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # Output-only The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
"instanceTemplateName": "A String", # Output-only The name of Instance Template used for Managed Instance Group.
"instanceGroupManagerName": "A String", # Output-only The name of Instance Group Manager managing this group.
},
},
"workerConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # Optional The Google Compute Engine configuration settings for worker instances in a cluster.
"isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
"machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: "compute.googleapis.com/projects/project_id /zones/us-east1-a/machineTypes/n1-standard-2".
"instanceNames": [ # The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
"A String",
],
"imageUri": "A String", # Output-only The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfiguration.image_version. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
"accelerators": [ # Optional The Google Compute Engine accelerator configuration for these instances.
{ # Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).
"acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
"acceleratorTypeUri": "A String", # Full or partial URI of the accelerator type resource to expose to this instance. See Google Compute Engine AcceleratorTypes( /compute/docs/reference/beta/acceleratorTypes)
},
],
"numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
"diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
"numLocalSsds": 42, # Optional Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
"bootDiskSizeGb": 42, # Optional Size in GB of the boot disk (default is 500GB).
},
"managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # Output-only The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
"instanceTemplateName": "A String", # Output-only The name of Instance Template used for Managed Instance Group.
"instanceGroupManagerName": "A String", # Output-only The name of Instance Group Manager managing this group.
},
},
},
"clusterUuid": "A String", # Output-only A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.
"clusterName": "A String", # Required The cluster name. Cluster names within a project must be unique. Names from deleted clusters can be reused.
"projectId": "A String", # Required The Google Cloud Platform project ID that the cluster belongs to.
"labels": { # Optional The labels to associate with this cluster.Label keys must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 64 labels can be associated with a given cluster.
"a_key": "A String",
},
"metrics": { # Contains cluster daemon metrics, such as HDFS and YARN stats. # Contains cluster daemon metrics such as HDFS and YARN stats.
"yarnMetrics": { # The YARN metrics.
"a_key": "A String",
},
"hdfsMetrics": { # The HDFS metrics.
"a_key": "A String",
},
},
"statusHistory": [ # Output-only Previous cluster statuses.
{ # The status of a cluster and its instances.
"state": "A String", # The cluster's state.
"stateStartTime": "A String", # Time when this state was entered.
"substate": "A String", # Output-only Additional state information that includes status reported by the agent.
"detail": "A String", # Optional details of cluster's state.
},
],
"createTime": "A String", # Output-only The timestamp of cluster creation.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(projectId, region, clusterName, body, updateMask=None, x__xgafv=None)</code>
<pre>Request to update a cluster in a project.
Args:
projectId: string, Required The ID of the Google Cloud Platform project the cluster belongs to. (required)
region: string, Required The Dataproc region in which to handle the request. (required)
clusterName: string, Required The cluster name. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Describes the identifying information, configuration, and status of a cluster of Google Compute Engine instances.
"status": { # The status of a cluster and its instances. # Output-only Cluster status.
"state": "A String", # The cluster's state.
"stateStartTime": "A String", # Time when this state was entered.
"substate": "A String", # Output-only Additional state information that includes status reported by the agent.
"detail": "A String", # Optional details of cluster's state.
},
"configuration": { # The cluster configuration. # Required The cluster configuration. It may differ from a user's initial configuration due to Cloud Dataproc setting of default values and updating clusters.
"workerDiskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Deprecated The configuration settings of worker node disk options.
"numLocalSsds": 42, # Optional Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
"bootDiskSizeGb": 42, # Optional Size in GB of the boot disk (default is 500GB).
},
"softwareConfiguration": { # Specifies the selection and configuration of software inside the cluster. # Optional The configuration settings for software inside the cluster.
"imageVersion": "A String", # Optional The version of software inside the cluster. It must match the regular expression 0-9+.0-9+. If unspecified it will default to latest version.
"properties": { # Optional The properties to set on daemon configuration files.Property keys are specified in "prefix:property" format, such as "core:fs.defaultFS". The following are supported prefixes and their mappings: core - core-site.xml hdfs - hdfs-site.xml mapred - mapred-site.xml yarn - yarn-site.xml hive - hive-site.xml pig - pig.properties spark - spark-defaults.conf
"a_key": "A String",
},
},
"workers": [ # Deprecated The list of worker node names. Dataproc derives the names from cluster_name and num_workers if not set by user (recommended practice is to let Dataproc derive the name). Derived worker node name example: hadoop-w-0.
"A String",
],
"masterConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # Optional The Google Compute Engine configuration settings for the master instance in a cluster.
"isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
"machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: "compute.googleapis.com/projects/project_id /zones/us-east1-a/machineTypes/n1-standard-2".
"instanceNames": [ # The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
"A String",
],
"imageUri": "A String", # Output-only The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfiguration.image_version. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
"accelerators": [ # Optional The Google Compute Engine accelerator configuration for these instances.
{ # Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).
"acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
"acceleratorTypeUri": "A String", # Full or partial URI of the accelerator type resource to expose to this instance. See Google Compute Engine AcceleratorTypes( /compute/docs/reference/beta/acceleratorTypes)
},
],
"numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
"diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
"numLocalSsds": 42, # Optional Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
"bootDiskSizeGb": 42, # Optional Size in GB of the boot disk (default is 500GB).
},
"managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # Output-only The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
"instanceTemplateName": "A String", # Output-only The name of Instance Template used for Managed Instance Group.
"instanceGroupManagerName": "A String", # Output-only The name of Instance Group Manager managing this group.
},
},
"gceClusterConfiguration": { # Common configuration settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster. # Optional The shared Google Compute Engine configuration settings for all instances in a cluster.
"internalIpOnly": True or False, # If true, all instances in the cluser will only have internal IP addresses. By default, clusters are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each instance. This restriction can only be enabled for subnetwork enabled networks, and all off-cluster dependencies must be configured to be accessible without external IP addresses.
"networkUri": "A String", # The Google Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a "Custom Subnet Network" (see https://cloud.google.com/compute/docs/subnetworks for more information). Example: compute.googleapis.com/projects/[project_id]/regions/global/default.
"tags": [ # The Google Compute Engine tags to add to all instances.
"A String",
],
"serviceAccount": "A String", # Optional The service account of the instances. Defaults to the default Google Compute Engine service account. Custom service accounts need permissions equivalent to the folloing IAM roles:
# roles/logging.logWriter
# roles/storage.objectAdmin(see https://cloud.google.com/compute/docs/access/service-accounts#custom_service_accounts for more information). Example: [account_id]@[project_id].iam.gserviceaccount.com
"zoneUri": "A String", # Required The zone where the Google Compute Engine cluster will be located. Example: "compute.googleapis.com/projects/project_id /zones/us-east1-a".
"subnetworkUri": "A String", # The Google Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri. Example: compute.googleapis.com/projects/[project_id]/regions/us-east1/sub0.
"serviceAccountScopes": [ # The service account scopes included in Google Compute Engine instances. Must include devstorage.full_control to enable the Google Cloud Storage connector. Example "auth.googleapis.com/compute" and "auth.googleapis.com/devstorage.full_control".
"A String",
],
"metadata": { # The Google Compute Engine metadata entries to add to all instances.
"a_key": "A String",
},
},
"masterName": "A String", # Deprecated The Master's hostname. Dataproc derives the name from cluster_name if not set by user (recommended practice is to let Dataproc derive the name). Derived master name example: hadoop-m.
"configurationBucket": "A String", # Optional A Google Cloud Storage staging bucket used for sharing generated SSH keys and configuration. If you do not specify a staging bucket, Cloud Dataproc will determine an appropriate Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Google Compute Engine zone where your cluster is deployed, then it will create and manage this project-level, per-location bucket for you.
"gceConfiguration": { # Deprecated Common configuration settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster. # Deprecated The Google Compute Engine configuration settings for cluster resources.
"machineTypeUri": "A String", # Deprecated The Google Compute Engine machine type used for cluster instances. Example: "compute.googleapis.com/projects/project_id /zones/us-east1-a/machineTypes/n1-standard-2".
"networkUri": "A String", # Deprecated The Google Compute Engine network to be used for machine communications. Inbound SSH connections are necessary to complete cluster configuration. Example "compute.googleapis.com/projects/project_id /zones/us-east1-a/default".
"zoneUri": "A String", # Deprecated The zone where the Google Compute Engine cluster will be located. Example: "compute.googleapis.com/projects/project_id /zones/us-east1-a".
"serviceAccountScopes": [ # Deprecated The service account scopes included in Google Compute Engine instances. Must include devstorage.full_control to enable the Google Cloud Storage connector. Example "auth.googleapis.com/compute" and "auth.googleapis.com/devstorage.full_control".
"A String",
],
"imageUri": "A String", # Deprecated The Google Compute Engine image resource used for cluster instances. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
},
"masterDiskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Deprecated The configuration settings of master node disk options.
"numLocalSsds": 42, # Optional Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
"bootDiskSizeGb": 42, # Optional Size in GB of the boot disk (default is 500GB).
},
"numWorkers": 42, # Deprecated The number of worker nodes in the cluster.
"initializationActions": [ # Optional Commands to execute on each node after configuration is completed. By default, executables are run on master and all worker nodes. You can test a node's <code>role</code> metadata to run an executable on a master or worker node, as shown below:
# ROLE=$(/usr/share/google/get_metadata_value attributes/role)
# if [[ "${ROLE}" == 'Master' ]]; then
# ... master specific actions ...
# else
# ... worker specific actions ...
# fi
{ # Specifies an executable to run on a fully configured node and a timeout period for executable completion.
"executionTimeout": "A String", # Optional Amount of time executable has to complete. Default is 10 minutes. Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period.
"executableFile": "A String", # Required Google Cloud Storage URI of executable file.
},
],
"secondaryWorkerConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # Optional The Google Compute Engine configuration settings for additional worker instances in a cluster.
"isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
"machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: "compute.googleapis.com/projects/project_id /zones/us-east1-a/machineTypes/n1-standard-2".
"instanceNames": [ # The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
"A String",
],
"imageUri": "A String", # Output-only The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfiguration.image_version. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
"accelerators": [ # Optional The Google Compute Engine accelerator configuration for these instances.
{ # Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).
"acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
"acceleratorTypeUri": "A String", # Full or partial URI of the accelerator type resource to expose to this instance. See Google Compute Engine AcceleratorTypes( /compute/docs/reference/beta/acceleratorTypes)
},
],
"numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
"diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
"numLocalSsds": 42, # Optional Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
"bootDiskSizeGb": 42, # Optional Size in GB of the boot disk (default is 500GB).
},
"managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # Output-only The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
"instanceTemplateName": "A String", # Output-only The name of Instance Template used for Managed Instance Group.
"instanceGroupManagerName": "A String", # Output-only The name of Instance Group Manager managing this group.
},
},
"workerConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # Optional The Google Compute Engine configuration settings for worker instances in a cluster.
"isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
"machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: "compute.googleapis.com/projects/project_id /zones/us-east1-a/machineTypes/n1-standard-2".
"instanceNames": [ # The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
"A String",
],
"imageUri": "A String", # Output-only The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfiguration.image_version. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
"accelerators": [ # Optional The Google Compute Engine accelerator configuration for these instances.
{ # Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).
"acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
"acceleratorTypeUri": "A String", # Full or partial URI of the accelerator type resource to expose to this instance. See Google Compute Engine AcceleratorTypes( /compute/docs/reference/beta/acceleratorTypes)
},
],
"numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
"diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
"numLocalSsds": 42, # Optional Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
"bootDiskSizeGb": 42, # Optional Size in GB of the boot disk (default is 500GB).
},
"managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # Output-only The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
"instanceTemplateName": "A String", # Output-only The name of Instance Template used for Managed Instance Group.
"instanceGroupManagerName": "A String", # Output-only The name of Instance Group Manager managing this group.
},
},
},
"clusterUuid": "A String", # Output-only A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.
"clusterName": "A String", # Required The cluster name. Cluster names within a project must be unique. Names from deleted clusters can be reused.
"projectId": "A String", # Required The Google Cloud Platform project ID that the cluster belongs to.
"labels": { # Optional The labels to associate with this cluster.Label keys must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 64 labels can be associated with a given cluster.
"a_key": "A String",
},
"metrics": { # Contains cluster daemon metrics, such as HDFS and YARN stats. # Contains cluster daemon metrics such as HDFS and YARN stats.
"yarnMetrics": { # The YARN metrics.
"a_key": "A String",
},
"hdfsMetrics": { # The HDFS metrics.
"a_key": "A String",
},
},
"statusHistory": [ # Output-only Previous cluster statuses.
{ # The status of a cluster and its instances.
"state": "A String", # The cluster's state.
"stateStartTime": "A String", # Time when this state was entered.
"substate": "A String", # Output-only Additional state information that includes status reported by the agent.
"detail": "A String", # Optional details of cluster's state.
},
],
"createTime": "A String", # Output-only The timestamp of cluster creation.
}
updateMask: string, Required Specifies the path, relative to <code>Cluster</code>, of the field to update. For example, to change the number of workers in a cluster to 5, the <code>update_mask</code> parameter would be specified as <code>"configuration.worker_configuration.num_instances,"</code> and the PATCH request body would specify the new value, as follows:
{
"configuration":{
"workerConfiguration":{
"numInstances":"5"
}
}
}
<strong>Note:</strong> Currently, <code>configuration.worker_configuration.num_instances</code> is the only field that can be updated.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # An asynchronous operation in a project that runs over a given cluster. Used to track the progress of a user request that is running asynchronously. Examples include creating a cluster, updating a cluster, and deleting a cluster.
"metadata": { # Service-specific metadata associated with the operation.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"error": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). The error model is designed to be: # The error result of the operation in case of failure.
# Simple to use and understand for most users
# Flexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include:
# Partial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors.
# Workflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.
# Batch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response.
# Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message.
# Logging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
},
"done": True or False, # Indicates if the operation is done. If true, the operation is complete and the result is available. If false, the operation is still in progress.
"response": { # The operation response. If the called method returns no data on success, the response is google.protobuf.Empty. If the called method is Get,Create or Update, the response is the resource. For all other methods, the response type is a concatenation of the method name and "Response". For example, if the called method is TakeSnapshot(), the response type is TakeSnapshotResponse.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The name of the operation resource, in the format projects/project_id/operations/operation_id
}</pre>
</div>
</body></html>
|
