/
dataflow.ts
2480 lines (2479 loc) · 122 KB
/
dataflow.ts
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
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
const completionSpec: Fig.Spec = {
name: "dataflow",
description: "Manage Google Cloud Dataflow resources",
subcommands: [
{
name: "flex-template",
description:
"A group of subcommands for working with Dataflow flex template",
subcommands: [
{
name: "build",
description:
"Builds a flex template file from the specified parameters",
options: [
{
name: "--account",
description:
"Google Cloud Platform user account to use for invocation. Overrides the default *core/account* property value for this command invocation",
args: {
name: "ACCOUNT",
description: "String",
suggestions: [],
},
},
{
name: "--billing-project",
description:
"The Google Cloud Platform project that will be charged quota for operations performed in gcloud. If you need to operate on one project, but need quota against a different project, you can use this flag to specify the billing project. If both `billing/quota_project` and `--billing-project` are specified, `--billing-project` takes precedence. Run `$ gcloud config set --help` to see more information about `billing/quota_project`",
args: {
name: "BILLING_PROJECT",
description: "String",
suggestions: [],
},
},
{
name: "--configuration",
description:
"The configuration to use for this command invocation. For more\ninformation on how to use configurations, run:\n`gcloud topic configurations`. You can also use the CLOUDSDK_ACTIVE_CONFIG_NAME environment\nvariable to set the equivalent of this flag for a terminal\nsession",
args: {
name: "CONFIGURATION",
description: "String",
suggestions: [],
},
},
{
name: "--env",
description:
'Environment variables to create for the Dockerfile. You can pass them as a comma separated list or repeat individually with --env flag. Ex: --env="A=B,C=D" or --env A=B, --env C=D.You can find the list of supported environment variables in this link. https://cloud.google.com/dataflow/docs/guides/templates/troubleshooting-flex-templates#setting_required_dockerfile_environment_variables',
args: {
name: "ENV",
description: "Dict",
suggestions: [],
},
priority: 100,
},
{
name: "--flags-file",
description:
"A YAML or JSON file that specifies a *--flag*:*value* dictionary.\nUseful for specifying complex flag values with special characters\nthat work with any command interpreter. Additionally, each\n*--flags-file* arg is replaced by its constituent flags. See\n$ gcloud topic flags-file for more information",
args: {
name: "YAML_FILE",
description: "String",
suggestions: [],
},
},
{
name: "--flatten",
description:
"Flatten _name_[] output resource slices in _KEY_ into separate records\nfor each item in each slice. Multiple keys and slices may be specified.\nThis also flattens keys for *--format* and *--filter*. For example,\n*--flatten=abc.def* flattens *abc.def[].ghi* references to\n*abc.def.ghi*. A resource record containing *abc.def[]* with N elements\nwill expand to N records in the flattened output. This flag interacts\nwith other flags that are applied in this order: *--flatten*,\n*--sort-by*, *--filter*, *--limit*",
args: {
name: "KEY",
description: "List",
suggestions: [],
},
},
{
name: "--flex-template-base-image",
description:
"Flex template base image to be used while building the container image. Allowed choices are JAVA8, JAVA11 or gcr.io path of the specific version of the base image. For JAVA8 and JAVA11 option, we use the latest base image version to build the container. You can also provide a specific version from this link https://gcr.io/dataflow-templates-base/",
args: {
name: "FLEX_TEMPLATE_BASE_IMAGE",
description: "Googlecloudsdk.calliope.arg_parsers:Parse",
suggestions: [],
},
priority: 100,
},
{
name: "--format",
description:
"Set the format for printing command output resources. The default is a\ncommand-specific human-friendly output format. The supported formats\nare: `config`, `csv`, `default`, `diff`, `disable`, `flattened`, `get`, `json`, `list`, `multi`, `none`, `object`, `table`, `text`, `value`, `yaml`. For more details run $ gcloud topic formats",
args: {
name: "FORMAT",
description: "String",
suggestions: [],
},
},
{
name: "--help",
description: "Display detailed help",
},
{
name: "--image",
description:
"Path to the any image registry location of the prebuilt flex template image",
args: {
name: "IMAGE",
description: "String",
suggestions: [],
},
},
{
name: "--image-gcr-path",
description:
"The Google Container Registry location to store the flex template image to be built",
args: {
name: "IMAGE_GCR_PATH",
description: "Googlecloudsdk.calliope.arg_parsers:Parse",
suggestions: [],
},
priority: 100,
},
{
name: "--impersonate-service-account",
description:
"For this gcloud invocation, all API requests will be made as the given service account instead of the currently selected account. This is done without needing to create, download, and activate a key for the account. In order to perform operations as the service account, your currently selected account must have an IAM role that includes the iam.serviceAccounts.getAccessToken permission for the service account. The roles/iam.serviceAccountTokenCreator role has this permission or you may create a custom role. Overrides the default *auth/impersonate_service_account* property value for this command invocation",
args: {
name: "SERVICE_ACCOUNT_EMAIL",
description: "String",
suggestions: [],
},
},
{
name: "--jar",
description:
'Local path to your dataflow pipeline jar file and all their dependent jar files required for the flex template classpath. You can pass them as a comma separated list or repeat individually with --jar flag. Ex: --jar="code.jar,dep.jar" or --jar code.jar, --jar dep.jar',
args: {
name: "JAR",
description: "List",
suggestions: [],
},
priority: 100,
},
{
name: "--log-http",
description:
"Log all HTTP server requests and responses to stderr. Overrides the default *core/log_http* property value for this command invocation",
},
{
name: "--metadata-file",
description:
"Local path to the metadata json file for the flex template",
args: {
name: "METADATA_FILE",
description: "Googlecloudsdk.calliope.arg_parsers:FileContents",
suggestions: [],
},
},
{
name: "--print-only",
description:
"Prints the container spec to stdout. Does not save in Google Cloud Storage. Overrides the default *dataflow/print_only* property value for this command invocation",
},
{
name: "--project",
description:
"The Google Cloud Platform project ID to use for this invocation. If\nomitted, then the current project is assumed; the current project can\nbe listed using `gcloud config list --format='text(core.project)'`\nand can be set using `gcloud config set project PROJECTID`.\n+\n`--project` and its fallback `core/project` property play two roles\nin the invocation. It specifies the project of the resource to\noperate on. It also specifies the project for API enablement check,\nquota, and billing. To specify a different project for quota and\nbilling, use `--billing-project` or `billing/quota_project` property",
args: {
name: "PROJECT_ID",
description: "String",
suggestions: [],
},
},
{
name: "--quiet",
description:
"Disable all interactive prompts when running gcloud commands. If input\nis required, defaults will be used, or an error will be raised.\nOverrides the default core/disable_prompts property value for this\ncommand invocation. This is equivalent to setting the environment\nvariable `CLOUDSDK_CORE_DISABLE_PROMPTS` to 1",
},
{
name: "--sdk-language",
description:
"SDK language of the flex template job. _SDK_LANGUAGE_ must be one of: *JAVA*, *PYTHON*",
args: {
name: "SDK_LANGUAGE",
description: "String",
suggestions: ["JAVA", "PYTHON"],
},
priority: 100,
},
{
name: "--trace-token",
description:
"Token used to route traces of service requests for investigation of issues. Overrides the default *core/trace_token* property value for this command invocation",
args: {
name: "TRACE_TOKEN",
description: "String",
suggestions: [],
},
},
{
name: "--user-output-enabled",
description:
"Print user intended output to the console. Overrides the default *core/user_output_enabled* property value for this command invocation. Use *--no-user-output-enabled* to disable",
},
{
name: "--verbosity",
description:
"Override the default verbosity for this command. Overrides the default *core/verbosity* property value for this command invocation. _VERBOSITY_ must be one of: *debug*, *info*, *warning*, *error*, *critical*, *none*",
args: {
name: "VERBOSITY",
description: "String",
suggestions: [
"debug",
"info",
"warning",
"error",
"critical",
"none",
],
},
},
],
args: {
name: "TEMPLATE_FILE_GCS_PATH",
description:
"The Google Cloud Storage location of the flex template file.Overrides if file already exists",
},
},
{
name: "run",
description: "Runs a job from the specified path",
options: [
{
name: "--account",
description:
"Google Cloud Platform user account to use for invocation. Overrides the default *core/account* property value for this command invocation",
args: {
name: "ACCOUNT",
description: "String",
suggestions: [],
},
},
{
name: "--additional-experiments",
description: "Additional experiments to pass to the job",
args: {
name: "ADDITIONAL_EXPERIMENTS",
description: "List",
suggestions: [],
},
},
{
name: "--additional-user-labels",
description: "Additional user labels to pass to the job",
args: {
name: "ADDITIONAL_USER_LABELS",
description: "Dict",
suggestions: [],
},
},
{
name: "--billing-project",
description:
"The Google Cloud Platform project that will be charged quota for operations performed in gcloud. If you need to operate on one project, but need quota against a different project, you can use this flag to specify the billing project. If both `billing/quota_project` and `--billing-project` are specified, `--billing-project` takes precedence. Run `$ gcloud config set --help` to see more information about `billing/quota_project`",
args: {
name: "BILLING_PROJECT",
description: "String",
suggestions: [],
},
},
{
name: "--configuration",
description:
"The configuration to use for this command invocation. For more\ninformation on how to use configurations, run:\n`gcloud topic configurations`. You can also use the CLOUDSDK_ACTIVE_CONFIG_NAME environment\nvariable to set the equivalent of this flag for a terminal\nsession",
args: {
name: "CONFIGURATION",
description: "String",
suggestions: [],
},
},
{
name: "--dataflow-kms-key",
description: "Cloud KMS key to protect the job resources",
args: {
name: "DATAFLOW_KMS_KEY",
description: "String",
suggestions: [],
},
},
{
name: "--disable-public-ips",
description:
"Cloud Dataflow workers must not use public IP addresses. Overrides the default *dataflow/disable_public_ips* property value for this command invocation",
},
{
name: "--enable-streaming-engine",
description:
"Enabling Streaming Engine for the streaming job. Overrides the default *dataflow/enable_streaming_engine* property value for this command invocation",
},
{
name: "--flags-file",
description:
"A YAML or JSON file that specifies a *--flag*:*value* dictionary.\nUseful for specifying complex flag values with special characters\nthat work with any command interpreter. Additionally, each\n*--flags-file* arg is replaced by its constituent flags. See\n$ gcloud topic flags-file for more information",
args: {
name: "YAML_FILE",
description: "String",
suggestions: [],
},
},
{
name: "--flatten",
description:
"Flatten _name_[] output resource slices in _KEY_ into separate records\nfor each item in each slice. Multiple keys and slices may be specified.\nThis also flattens keys for *--format* and *--filter*. For example,\n*--flatten=abc.def* flattens *abc.def[].ghi* references to\n*abc.def.ghi*. A resource record containing *abc.def[]* with N elements\nwill expand to N records in the flattened output. This flag interacts\nwith other flags that are applied in this order: *--flatten*,\n*--sort-by*, *--filter*, *--limit*",
args: {
name: "KEY",
description: "List",
suggestions: [],
},
},
{
name: "--format",
description:
"Set the format for printing command output resources. The default is a\ncommand-specific human-friendly output format. The supported formats\nare: `config`, `csv`, `default`, `diff`, `disable`, `flattened`, `get`, `json`, `list`, `multi`, `none`, `object`, `table`, `text`, `value`, `yaml`. For more details run $ gcloud topic formats",
args: {
name: "FORMAT",
description: "String",
suggestions: [],
},
},
{
name: "--help",
description: "Display detailed help",
},
{
name: "--impersonate-service-account",
description:
"For this gcloud invocation, all API requests will be made as the given service account instead of the currently selected account. This is done without needing to create, download, and activate a key for the account. In order to perform operations as the service account, your currently selected account must have an IAM role that includes the iam.serviceAccounts.getAccessToken permission for the service account. The roles/iam.serviceAccountTokenCreator role has this permission or you may create a custom role. Overrides the default *auth/impersonate_service_account* property value for this command invocation",
args: {
name: "SERVICE_ACCOUNT_EMAIL",
description: "String",
suggestions: [],
},
},
{
name: "--log-http",
description:
"Log all HTTP server requests and responses to stderr. Overrides the default *core/log_http* property value for this command invocation",
},
{
name: "--max-workers",
description: "Maximum number of workers to run",
args: {
name: "MAX_WORKERS",
description: "String",
suggestions: [],
},
},
{
name: "--network",
description:
"Compute Engine network for launching instances to run your pipeline",
args: {
name: "NETWORK",
description: "String",
suggestions: [],
},
},
{
name: "--num-workers",
description: "Initial number of workers to use",
args: {
name: "NUM_WORKERS",
description: "String",
suggestions: [],
},
},
{
name: "--parameters",
description: "Parameters to pass to the job",
args: {
name: "PARAMETERS",
description: "Dict",
suggestions: [],
},
},
{
name: "--project",
description:
"The Google Cloud Platform project ID to use for this invocation. If\nomitted, then the current project is assumed; the current project can\nbe listed using `gcloud config list --format='text(core.project)'`\nand can be set using `gcloud config set project PROJECTID`.\n+\n`--project` and its fallback `core/project` property play two roles\nin the invocation. It specifies the project of the resource to\noperate on. It also specifies the project for API enablement check,\nquota, and billing. To specify a different project for quota and\nbilling, use `--billing-project` or `billing/quota_project` property",
args: {
name: "PROJECT_ID",
description: "String",
suggestions: [],
},
},
{
name: "--quiet",
description:
"Disable all interactive prompts when running gcloud commands. If input\nis required, defaults will be used, or an error will be raised.\nOverrides the default core/disable_prompts property value for this\ncommand invocation. This is equivalent to setting the environment\nvariable `CLOUDSDK_CORE_DISABLE_PROMPTS` to 1",
},
{
name: "--region",
description:
"Region ID of the job's regional endpoint. Defaults to 'us-central1'",
args: {
name: "REGION_ID",
description: "String",
suggestions: [],
},
},
{
name: "--service-account-email",
description: "Service account to run the workers as",
args: {
name: "SERVICE_ACCOUNT_EMAIL",
description: "Googlecloudsdk.calliope.arg_parsers:Parse",
suggestions: [],
},
},
{
name: "--staging-location",
description:
"Google Cloud Storage location to stage temporary files. (Must be a URL beginning with 'gs://'.)",
args: {
name: "STAGING_LOCATION",
description: "Googlecloudsdk.calliope.arg_parsers:Parse",
suggestions: [],
},
},
{
name: "--subnetwork",
description:
"Compute Engine subnetwork for launching instances to run your pipeline",
args: {
name: "SUBNETWORK",
description: "String",
suggestions: [],
},
},
{
name: "--template-file-gcs-location",
description:
"Google Cloud Storage location of the flex template to run. (Must be a URL beginning with 'gs://'.)",
args: {
name: "TEMPLATE_FILE_GCS_LOCATION",
description: "Googlecloudsdk.calliope.arg_parsers:Parse",
suggestions: [],
},
priority: 100,
},
{
name: "--trace-token",
description:
"Token used to route traces of service requests for investigation of issues. Overrides the default *core/trace_token* property value for this command invocation",
args: {
name: "TRACE_TOKEN",
description: "String",
suggestions: [],
},
},
{
name: "--user-output-enabled",
description:
"Print user intended output to the console. Overrides the default *core/user_output_enabled* property value for this command invocation. Use *--no-user-output-enabled* to disable",
},
{
name: "--verbosity",
description:
"Override the default verbosity for this command. Overrides the default *core/verbosity* property value for this command invocation. _VERBOSITY_ must be one of: *debug*, *info*, *warning*, *error*, *critical*, *none*",
args: {
name: "VERBOSITY",
description: "String",
suggestions: [
"debug",
"info",
"warning",
"error",
"critical",
"none",
],
},
},
{
name: "--worker-machine-type",
description:
"Type of machine to use for workers. Defaults to server-specified",
args: {
name: "WORKER_MACHINE_TYPE",
description: "String",
suggestions: [],
},
},
{
name: "--worker-region",
description: "Region to run the workers in",
args: {
name: "WORKER_REGION",
description: "String",
suggestions: [],
},
},
{
name: "--worker-zone",
description: "Zone to run the workers in",
args: {
name: "WORKER_ZONE",
description: "String",
suggestions: [],
},
},
],
args: {
name: "JOB_NAME",
description: "Unique name to assign to the job",
},
},
],
options: [
{
name: "--account",
description:
"Google Cloud Platform user account to use for invocation. Overrides the default *core/account* property value for this command invocation",
args: {
name: "ACCOUNT",
description: "String",
suggestions: [],
},
},
{
name: "--billing-project",
description:
"The Google Cloud Platform project that will be charged quota for operations performed in gcloud. If you need to operate on one project, but need quota against a different project, you can use this flag to specify the billing project. If both `billing/quota_project` and `--billing-project` are specified, `--billing-project` takes precedence. Run `$ gcloud config set --help` to see more information about `billing/quota_project`",
args: {
name: "BILLING_PROJECT",
description: "String",
suggestions: [],
},
},
{
name: "--configuration",
description:
"The configuration to use for this command invocation. For more\ninformation on how to use configurations, run:\n`gcloud topic configurations`. You can also use the CLOUDSDK_ACTIVE_CONFIG_NAME environment\nvariable to set the equivalent of this flag for a terminal\nsession",
args: {
name: "CONFIGURATION",
description: "String",
suggestions: [],
},
},
{
name: "--flags-file",
description:
"A YAML or JSON file that specifies a *--flag*:*value* dictionary.\nUseful for specifying complex flag values with special characters\nthat work with any command interpreter. Additionally, each\n*--flags-file* arg is replaced by its constituent flags. See\n$ gcloud topic flags-file for more information",
args: {
name: "YAML_FILE",
description: "String",
suggestions: [],
},
},
{
name: "--flatten",
description:
"Flatten _name_[] output resource slices in _KEY_ into separate records\nfor each item in each slice. Multiple keys and slices may be specified.\nThis also flattens keys for *--format* and *--filter*. For example,\n*--flatten=abc.def* flattens *abc.def[].ghi* references to\n*abc.def.ghi*. A resource record containing *abc.def[]* with N elements\nwill expand to N records in the flattened output. This flag interacts\nwith other flags that are applied in this order: *--flatten*,\n*--sort-by*, *--filter*, *--limit*",
args: {
name: "KEY",
description: "List",
suggestions: [],
},
},
{
name: "--format",
description:
"Set the format for printing command output resources. The default is a\ncommand-specific human-friendly output format. The supported formats\nare: `config`, `csv`, `default`, `diff`, `disable`, `flattened`, `get`, `json`, `list`, `multi`, `none`, `object`, `table`, `text`, `value`, `yaml`. For more details run $ gcloud topic formats",
args: {
name: "FORMAT",
description: "String",
suggestions: [],
},
},
{
name: "--help",
description: "Display detailed help",
},
{
name: "--impersonate-service-account",
description:
"For this gcloud invocation, all API requests will be made as the given service account instead of the currently selected account. This is done without needing to create, download, and activate a key for the account. In order to perform operations as the service account, your currently selected account must have an IAM role that includes the iam.serviceAccounts.getAccessToken permission for the service account. The roles/iam.serviceAccountTokenCreator role has this permission or you may create a custom role. Overrides the default *auth/impersonate_service_account* property value for this command invocation",
args: {
name: "SERVICE_ACCOUNT_EMAIL",
description: "String",
suggestions: [],
},
},
{
name: "--log-http",
description:
"Log all HTTP server requests and responses to stderr. Overrides the default *core/log_http* property value for this command invocation",
},
{
name: "--project",
description:
"The Google Cloud Platform project ID to use for this invocation. If\nomitted, then the current project is assumed; the current project can\nbe listed using `gcloud config list --format='text(core.project)'`\nand can be set using `gcloud config set project PROJECTID`.\n+\n`--project` and its fallback `core/project` property play two roles\nin the invocation. It specifies the project of the resource to\noperate on. It also specifies the project for API enablement check,\nquota, and billing. To specify a different project for quota and\nbilling, use `--billing-project` or `billing/quota_project` property",
args: {
name: "PROJECT_ID",
description: "String",
suggestions: [],
},
},
{
name: "--quiet",
description:
"Disable all interactive prompts when running gcloud commands. If input\nis required, defaults will be used, or an error will be raised.\nOverrides the default core/disable_prompts property value for this\ncommand invocation. This is equivalent to setting the environment\nvariable `CLOUDSDK_CORE_DISABLE_PROMPTS` to 1",
},
{
name: "--trace-token",
description:
"Token used to route traces of service requests for investigation of issues. Overrides the default *core/trace_token* property value for this command invocation",
args: {
name: "TRACE_TOKEN",
description: "String",
suggestions: [],
},
},
{
name: "--user-output-enabled",
description:
"Print user intended output to the console. Overrides the default *core/user_output_enabled* property value for this command invocation. Use *--no-user-output-enabled* to disable",
},
{
name: "--verbosity",
description:
"Override the default verbosity for this command. Overrides the default *core/verbosity* property value for this command invocation. _VERBOSITY_ must be one of: *debug*, *info*, *warning*, *error*, *critical*, *none*",
args: {
name: "VERBOSITY",
description: "String",
suggestions: [
"debug",
"info",
"warning",
"error",
"critical",
"none",
],
},
},
],
},
{
name: "jobs",
description: "A group of subcommands for working with Dataflow jobs",
subcommands: [
{
name: "cancel",
description: "Cancels all jobs that match the command line arguments",
options: [
{
name: "--account",
description:
"Google Cloud Platform user account to use for invocation. Overrides the default *core/account* property value for this command invocation",
args: {
name: "ACCOUNT",
description: "String",
suggestions: [],
},
},
{
name: "--billing-project",
description:
"The Google Cloud Platform project that will be charged quota for operations performed in gcloud. If you need to operate on one project, but need quota against a different project, you can use this flag to specify the billing project. If both `billing/quota_project` and `--billing-project` are specified, `--billing-project` takes precedence. Run `$ gcloud config set --help` to see more information about `billing/quota_project`",
args: {
name: "BILLING_PROJECT",
description: "String",
suggestions: [],
},
},
{
name: "--configuration",
description:
"The configuration to use for this command invocation. For more\ninformation on how to use configurations, run:\n`gcloud topic configurations`. You can also use the CLOUDSDK_ACTIVE_CONFIG_NAME environment\nvariable to set the equivalent of this flag for a terminal\nsession",
args: {
name: "CONFIGURATION",
description: "String",
suggestions: [],
},
},
{
name: "--flags-file",
description:
"A YAML or JSON file that specifies a *--flag*:*value* dictionary.\nUseful for specifying complex flag values with special characters\nthat work with any command interpreter. Additionally, each\n*--flags-file* arg is replaced by its constituent flags. See\n$ gcloud topic flags-file for more information",
args: {
name: "YAML_FILE",
description: "String",
suggestions: [],
},
},
{
name: "--flatten",
description:
"Flatten _name_[] output resource slices in _KEY_ into separate records\nfor each item in each slice. Multiple keys and slices may be specified.\nThis also flattens keys for *--format* and *--filter*. For example,\n*--flatten=abc.def* flattens *abc.def[].ghi* references to\n*abc.def.ghi*. A resource record containing *abc.def[]* with N elements\nwill expand to N records in the flattened output. This flag interacts\nwith other flags that are applied in this order: *--flatten*,\n*--sort-by*, *--filter*, *--limit*",
args: {
name: "KEY",
description: "List",
suggestions: [],
},
},
{
name: "--format",
description:
"Set the format for printing command output resources. The default is a\ncommand-specific human-friendly output format. The supported formats\nare: `config`, `csv`, `default`, `diff`, `disable`, `flattened`, `get`, `json`, `list`, `multi`, `none`, `object`, `table`, `text`, `value`, `yaml`. For more details run $ gcloud topic formats",
args: {
name: "FORMAT",
description: "String",
suggestions: [],
},
},
{
name: "--help",
description: "Display detailed help",
},
{
name: "--impersonate-service-account",
description:
"For this gcloud invocation, all API requests will be made as the given service account instead of the currently selected account. This is done without needing to create, download, and activate a key for the account. In order to perform operations as the service account, your currently selected account must have an IAM role that includes the iam.serviceAccounts.getAccessToken permission for the service account. The roles/iam.serviceAccountTokenCreator role has this permission or you may create a custom role. Overrides the default *auth/impersonate_service_account* property value for this command invocation",
args: {
name: "SERVICE_ACCOUNT_EMAIL",
description: "String",
suggestions: [],
},
},
{
name: "--log-http",
description:
"Log all HTTP server requests and responses to stderr. Overrides the default *core/log_http* property value for this command invocation",
},
{
name: "--project",
description:
"The Google Cloud Platform project ID to use for this invocation. If\nomitted, then the current project is assumed; the current project can\nbe listed using `gcloud config list --format='text(core.project)'`\nand can be set using `gcloud config set project PROJECTID`.\n+\n`--project` and its fallback `core/project` property play two roles\nin the invocation. It specifies the project of the resource to\noperate on. It also specifies the project for API enablement check,\nquota, and billing. To specify a different project for quota and\nbilling, use `--billing-project` or `billing/quota_project` property",
args: {
name: "PROJECT_ID",
description: "String",
suggestions: [],
},
},
{
name: "--quiet",
description:
"Disable all interactive prompts when running gcloud commands. If input\nis required, defaults will be used, or an error will be raised.\nOverrides the default core/disable_prompts property value for this\ncommand invocation. This is equivalent to setting the environment\nvariable `CLOUDSDK_CORE_DISABLE_PROMPTS` to 1",
},
{
name: "--region",
description:
"The region ID of the jobs' regional endpoint. Defaults to 'us-central1'",
args: {
name: "REGION_ID",
description: "String",
suggestions: [],
},
},
{
name: "--trace-token",
description:
"Token used to route traces of service requests for investigation of issues. Overrides the default *core/trace_token* property value for this command invocation",
args: {
name: "TRACE_TOKEN",
description: "String",
suggestions: [],
},
},
{
name: "--user-output-enabled",
description:
"Print user intended output to the console. Overrides the default *core/user_output_enabled* property value for this command invocation. Use *--no-user-output-enabled* to disable",
},
{
name: "--verbosity",
description:
"Override the default verbosity for this command. Overrides the default *core/verbosity* property value for this command invocation. _VERBOSITY_ must be one of: *debug*, *info*, *warning*, *error*, *critical*, *none*",
args: {
name: "VERBOSITY",
description: "String",
suggestions: [
"debug",
"info",
"warning",
"error",
"critical",
"none",
],
},
},
],
args: {
name: "JOB_ID",
description: "The job IDs to operate on",
isVariadic: true,
},
},
{
name: "describe",
description: "Outputs the Job object resulting from the Get API",
options: [
{
name: "--account",
description:
"Google Cloud Platform user account to use for invocation. Overrides the default *core/account* property value for this command invocation",
args: {
name: "ACCOUNT",
description: "String",
suggestions: [],
},
},
{
name: "--billing-project",
description:
"The Google Cloud Platform project that will be charged quota for operations performed in gcloud. If you need to operate on one project, but need quota against a different project, you can use this flag to specify the billing project. If both `billing/quota_project` and `--billing-project` are specified, `--billing-project` takes precedence. Run `$ gcloud config set --help` to see more information about `billing/quota_project`",
args: {
name: "BILLING_PROJECT",
description: "String",
suggestions: [],
},
},
{
name: "--configuration",
description:
"The configuration to use for this command invocation. For more\ninformation on how to use configurations, run:\n`gcloud topic configurations`. You can also use the CLOUDSDK_ACTIVE_CONFIG_NAME environment\nvariable to set the equivalent of this flag for a terminal\nsession",
args: {
name: "CONFIGURATION",
description: "String",
suggestions: [],
},
},
{
name: "--flags-file",
description:
"A YAML or JSON file that specifies a *--flag*:*value* dictionary.\nUseful for specifying complex flag values with special characters\nthat work with any command interpreter. Additionally, each\n*--flags-file* arg is replaced by its constituent flags. See\n$ gcloud topic flags-file for more information",
args: {
name: "YAML_FILE",
description: "String",
suggestions: [],
},
},
{
name: "--flatten",
description:
"Flatten _name_[] output resource slices in _KEY_ into separate records\nfor each item in each slice. Multiple keys and slices may be specified.\nThis also flattens keys for *--format* and *--filter*. For example,\n*--flatten=abc.def* flattens *abc.def[].ghi* references to\n*abc.def.ghi*. A resource record containing *abc.def[]* with N elements\nwill expand to N records in the flattened output. This flag interacts\nwith other flags that are applied in this order: *--flatten*,\n*--sort-by*, *--filter*, *--limit*",
args: {
name: "KEY",
description: "List",
suggestions: [],
},
},
{
name: "--format",
description:
"Set the format for printing command output resources. The default is a\ncommand-specific human-friendly output format. The supported formats\nare: `config`, `csv`, `default`, `diff`, `disable`, `flattened`, `get`, `json`, `list`, `multi`, `none`, `object`, `table`, `text`, `value`, `yaml`. For more details run $ gcloud topic formats",
args: {
name: "FORMAT",
description: "String",
suggestions: [],
},
},
{
name: "--full",
description: "Retrieve the full Job rather than the summary view",
},
{
name: "--help",
description: "Display detailed help",
},
{
name: "--impersonate-service-account",
description:
"For this gcloud invocation, all API requests will be made as the given service account instead of the currently selected account. This is done without needing to create, download, and activate a key for the account. In order to perform operations as the service account, your currently selected account must have an IAM role that includes the iam.serviceAccounts.getAccessToken permission for the service account. The roles/iam.serviceAccountTokenCreator role has this permission or you may create a custom role. Overrides the default *auth/impersonate_service_account* property value for this command invocation",
args: {
name: "SERVICE_ACCOUNT_EMAIL",
description: "String",
suggestions: [],
},
},
{
name: "--log-http",
description:
"Log all HTTP server requests and responses to stderr. Overrides the default *core/log_http* property value for this command invocation",
},
{
name: "--project",
description:
"The Google Cloud Platform project ID to use for this invocation. If\nomitted, then the current project is assumed; the current project can\nbe listed using `gcloud config list --format='text(core.project)'`\nand can be set using `gcloud config set project PROJECTID`.\n+\n`--project` and its fallback `core/project` property play two roles\nin the invocation. It specifies the project of the resource to\noperate on. It also specifies the project for API enablement check,\nquota, and billing. To specify a different project for quota and\nbilling, use `--billing-project` or `billing/quota_project` property",
args: {
name: "PROJECT_ID",
description: "String",
suggestions: [],
},
},
{
name: "--quiet",
description:
"Disable all interactive prompts when running gcloud commands. If input\nis required, defaults will be used, or an error will be raised.\nOverrides the default core/disable_prompts property value for this\ncommand invocation. This is equivalent to setting the environment\nvariable `CLOUDSDK_CORE_DISABLE_PROMPTS` to 1",
},
{
name: "--region",
description:
"The region ID of the job's regional endpoint. Defaults to 'us-central1'",
args: {
name: "REGION_ID",
description: "String",
suggestions: [],
},
},
{
name: "--trace-token",
description:
"Token used to route traces of service requests for investigation of issues. Overrides the default *core/trace_token* property value for this command invocation",
args: {
name: "TRACE_TOKEN",
description: "String",
suggestions: [],
},
},
{
name: "--user-output-enabled",
description:
"Print user intended output to the console. Overrides the default *core/user_output_enabled* property value for this command invocation. Use *--no-user-output-enabled* to disable",
},
{
name: "--verbosity",
description:
"Override the default verbosity for this command. Overrides the default *core/verbosity* property value for this command invocation. _VERBOSITY_ must be one of: *debug*, *info*, *warning*, *error*, *critical*, *none*",
args: {
name: "VERBOSITY",
description: "String",
suggestions: [
"debug",
"info",
"warning",
"error",
"critical",
"none",
],
},
},
],
args: {
name: "JOB_ID",
description: "The job ID to operate on",
},
},
{
name: "drain",
description: "Drains all jobs that match the command line arguments",
options: [
{
name: "--account",
description:
"Google Cloud Platform user account to use for invocation. Overrides the default *core/account* property value for this command invocation",
args: {
name: "ACCOUNT",
description: "String",
suggestions: [],
},
},
{
name: "--billing-project",
description:
"The Google Cloud Platform project that will be charged quota for operations performed in gcloud. If you need to operate on one project, but need quota against a different project, you can use this flag to specify the billing project. If both `billing/quota_project` and `--billing-project` are specified, `--billing-project` takes precedence. Run `$ gcloud config set --help` to see more information about `billing/quota_project`",
args: {
name: "BILLING_PROJECT",
description: "String",
suggestions: [],
},
},
{
name: "--configuration",
description:
"The configuration to use for this command invocation. For more\ninformation on how to use configurations, run:\n`gcloud topic configurations`. You can also use the CLOUDSDK_ACTIVE_CONFIG_NAME environment\nvariable to set the equivalent of this flag for a terminal\nsession",
args: {
name: "CONFIGURATION",
description: "String",
suggestions: [],
},
},
{
name: "--flags-file",
description:
"A YAML or JSON file that specifies a *--flag*:*value* dictionary.\nUseful for specifying complex flag values with special characters\nthat work with any command interpreter. Additionally, each\n*--flags-file* arg is replaced by its constituent flags. See\n$ gcloud topic flags-file for more information",
args: {
name: "YAML_FILE",
description: "String",
suggestions: [],
},
},
{
name: "--flatten",
description:
"Flatten _name_[] output resource slices in _KEY_ into separate records\nfor each item in each slice. Multiple keys and slices may be specified.\nThis also flattens keys for *--format* and *--filter*. For example,\n*--flatten=abc.def* flattens *abc.def[].ghi* references to\n*abc.def.ghi*. A resource record containing *abc.def[]* with N elements\nwill expand to N records in the flattened output. This flag interacts\nwith other flags that are applied in this order: *--flatten*,\n*--sort-by*, *--filter*, *--limit*",
args: {
name: "KEY",
description: "List",
suggestions: [],
},
},