-
Notifications
You must be signed in to change notification settings - Fork 19
/
outputs.py
2685 lines (2370 loc) · 112 KB
/
outputs.py
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
# coding=utf-8
# *** WARNING: this file was generated by the Pulumi SDK Generator. ***
# *** Do not edit by hand unless you're certain you know what you are doing! ***
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from ... import _utilities
from . import outputs
__all__ = [
'AutoscalingSettingsResponse',
'BigQueryIODetailsResponse',
'BigTableIODetailsResponse',
'ComponentSourceResponse',
'ComponentTransformResponse',
'DatastoreIODetailsResponse',
'DebugOptionsResponse',
'DiskResponse',
'DisplayDataResponse',
'EnvironmentResponse',
'ExecutionStageStateResponse',
'ExecutionStageSummaryResponse',
'FileIODetailsResponse',
'JobMetadataResponse',
'PackageResponse',
'ParameterMetadataResponse',
'PipelineDescriptionResponse',
'PubSubIODetailsResponse',
'RuntimeMetadataResponse',
'SDKInfoResponse',
'SdkHarnessContainerImageResponse',
'SdkVersionResponse',
'SpannerIODetailsResponse',
'StageSourceResponse',
'StatusResponse',
'StepResponse',
'TaskRunnerSettingsResponse',
'TemplateMetadataResponse',
'TransformSummaryResponse',
'WorkerPoolResponse',
'WorkerSettingsResponse',
]
@pulumi.output_type
class AutoscalingSettingsResponse(dict):
"""
Settings for WorkerPool autoscaling.
"""
@staticmethod
def __key_warning(key: str):
suggest = None
if key == "maxNumWorkers":
suggest = "max_num_workers"
if suggest:
pulumi.log.warn(f"Key '{key}' not found in AutoscalingSettingsResponse. Access the value via the '{suggest}' property getter instead.")
def __getitem__(self, key: str) -> Any:
AutoscalingSettingsResponse.__key_warning(key)
return super().__getitem__(key)
def get(self, key: str, default = None) -> Any:
AutoscalingSettingsResponse.__key_warning(key)
return super().get(key, default)
def __init__(__self__, *,
algorithm: str,
max_num_workers: int):
"""
Settings for WorkerPool autoscaling.
:param str algorithm: The algorithm to use for autoscaling.
:param int max_num_workers: The maximum number of workers to cap scaling at.
"""
pulumi.set(__self__, "algorithm", algorithm)
pulumi.set(__self__, "max_num_workers", max_num_workers)
@property
@pulumi.getter
def algorithm(self) -> str:
"""
The algorithm to use for autoscaling.
"""
return pulumi.get(self, "algorithm")
@property
@pulumi.getter(name="maxNumWorkers")
def max_num_workers(self) -> int:
"""
The maximum number of workers to cap scaling at.
"""
return pulumi.get(self, "max_num_workers")
@pulumi.output_type
class BigQueryIODetailsResponse(dict):
"""
Metadata for a BigQuery connector used by the job.
"""
def __init__(__self__, *,
dataset: str,
project: str,
query: str,
table: str):
"""
Metadata for a BigQuery connector used by the job.
:param str dataset: Dataset accessed in the connection.
:param str project: Project accessed in the connection.
:param str query: Query used to access data in the connection.
:param str table: Table accessed in the connection.
"""
pulumi.set(__self__, "dataset", dataset)
pulumi.set(__self__, "project", project)
pulumi.set(__self__, "query", query)
pulumi.set(__self__, "table", table)
@property
@pulumi.getter
def dataset(self) -> str:
"""
Dataset accessed in the connection.
"""
return pulumi.get(self, "dataset")
@property
@pulumi.getter
def project(self) -> str:
"""
Project accessed in the connection.
"""
return pulumi.get(self, "project")
@property
@pulumi.getter
def query(self) -> str:
"""
Query used to access data in the connection.
"""
return pulumi.get(self, "query")
@property
@pulumi.getter
def table(self) -> str:
"""
Table accessed in the connection.
"""
return pulumi.get(self, "table")
@pulumi.output_type
class BigTableIODetailsResponse(dict):
"""
Metadata for a Cloud BigTable connector used by the job.
"""
@staticmethod
def __key_warning(key: str):
suggest = None
if key == "instanceId":
suggest = "instance_id"
elif key == "tableId":
suggest = "table_id"
if suggest:
pulumi.log.warn(f"Key '{key}' not found in BigTableIODetailsResponse. Access the value via the '{suggest}' property getter instead.")
def __getitem__(self, key: str) -> Any:
BigTableIODetailsResponse.__key_warning(key)
return super().__getitem__(key)
def get(self, key: str, default = None) -> Any:
BigTableIODetailsResponse.__key_warning(key)
return super().get(key, default)
def __init__(__self__, *,
instance_id: str,
project: str,
table_id: str):
"""
Metadata for a Cloud BigTable connector used by the job.
:param str instance_id: InstanceId accessed in the connection.
:param str project: ProjectId accessed in the connection.
:param str table_id: TableId accessed in the connection.
"""
pulumi.set(__self__, "instance_id", instance_id)
pulumi.set(__self__, "project", project)
pulumi.set(__self__, "table_id", table_id)
@property
@pulumi.getter(name="instanceId")
def instance_id(self) -> str:
"""
InstanceId accessed in the connection.
"""
return pulumi.get(self, "instance_id")
@property
@pulumi.getter
def project(self) -> str:
"""
ProjectId accessed in the connection.
"""
return pulumi.get(self, "project")
@property
@pulumi.getter(name="tableId")
def table_id(self) -> str:
"""
TableId accessed in the connection.
"""
return pulumi.get(self, "table_id")
@pulumi.output_type
class ComponentSourceResponse(dict):
"""
Description of an interstitial value between transforms in an execution stage.
"""
@staticmethod
def __key_warning(key: str):
suggest = None
if key == "originalTransformOrCollection":
suggest = "original_transform_or_collection"
elif key == "userName":
suggest = "user_name"
if suggest:
pulumi.log.warn(f"Key '{key}' not found in ComponentSourceResponse. Access the value via the '{suggest}' property getter instead.")
def __getitem__(self, key: str) -> Any:
ComponentSourceResponse.__key_warning(key)
return super().__getitem__(key)
def get(self, key: str, default = None) -> Any:
ComponentSourceResponse.__key_warning(key)
return super().get(key, default)
def __init__(__self__, *,
name: str,
original_transform_or_collection: str,
user_name: str):
"""
Description of an interstitial value between transforms in an execution stage.
:param str name: Dataflow service generated name for this source.
:param str original_transform_or_collection: User name for the original user transform or collection with which this source is most closely associated.
:param str user_name: Human-readable name for this transform; may be user or system generated.
"""
pulumi.set(__self__, "name", name)
pulumi.set(__self__, "original_transform_or_collection", original_transform_or_collection)
pulumi.set(__self__, "user_name", user_name)
@property
@pulumi.getter
def name(self) -> str:
"""
Dataflow service generated name for this source.
"""
return pulumi.get(self, "name")
@property
@pulumi.getter(name="originalTransformOrCollection")
def original_transform_or_collection(self) -> str:
"""
User name for the original user transform or collection with which this source is most closely associated.
"""
return pulumi.get(self, "original_transform_or_collection")
@property
@pulumi.getter(name="userName")
def user_name(self) -> str:
"""
Human-readable name for this transform; may be user or system generated.
"""
return pulumi.get(self, "user_name")
@pulumi.output_type
class ComponentTransformResponse(dict):
"""
Description of a transform executed as part of an execution stage.
"""
@staticmethod
def __key_warning(key: str):
suggest = None
if key == "originalTransform":
suggest = "original_transform"
elif key == "userName":
suggest = "user_name"
if suggest:
pulumi.log.warn(f"Key '{key}' not found in ComponentTransformResponse. Access the value via the '{suggest}' property getter instead.")
def __getitem__(self, key: str) -> Any:
ComponentTransformResponse.__key_warning(key)
return super().__getitem__(key)
def get(self, key: str, default = None) -> Any:
ComponentTransformResponse.__key_warning(key)
return super().get(key, default)
def __init__(__self__, *,
name: str,
original_transform: str,
user_name: str):
"""
Description of a transform executed as part of an execution stage.
:param str name: Dataflow service generated name for this source.
:param str original_transform: User name for the original user transform with which this transform is most closely associated.
:param str user_name: Human-readable name for this transform; may be user or system generated.
"""
pulumi.set(__self__, "name", name)
pulumi.set(__self__, "original_transform", original_transform)
pulumi.set(__self__, "user_name", user_name)
@property
@pulumi.getter
def name(self) -> str:
"""
Dataflow service generated name for this source.
"""
return pulumi.get(self, "name")
@property
@pulumi.getter(name="originalTransform")
def original_transform(self) -> str:
"""
User name for the original user transform with which this transform is most closely associated.
"""
return pulumi.get(self, "original_transform")
@property
@pulumi.getter(name="userName")
def user_name(self) -> str:
"""
Human-readable name for this transform; may be user or system generated.
"""
return pulumi.get(self, "user_name")
@pulumi.output_type
class DatastoreIODetailsResponse(dict):
"""
Metadata for a Datastore connector used by the job.
"""
def __init__(__self__, *,
namespace: str,
project: str):
"""
Metadata for a Datastore connector used by the job.
:param str namespace: Namespace used in the connection.
:param str project: ProjectId accessed in the connection.
"""
pulumi.set(__self__, "namespace", namespace)
pulumi.set(__self__, "project", project)
@property
@pulumi.getter
def namespace(self) -> str:
"""
Namespace used in the connection.
"""
return pulumi.get(self, "namespace")
@property
@pulumi.getter
def project(self) -> str:
"""
ProjectId accessed in the connection.
"""
return pulumi.get(self, "project")
@pulumi.output_type
class DebugOptionsResponse(dict):
"""
Describes any options that have an effect on the debugging of pipelines.
"""
@staticmethod
def __key_warning(key: str):
suggest = None
if key == "enableHotKeyLogging":
suggest = "enable_hot_key_logging"
if suggest:
pulumi.log.warn(f"Key '{key}' not found in DebugOptionsResponse. Access the value via the '{suggest}' property getter instead.")
def __getitem__(self, key: str) -> Any:
DebugOptionsResponse.__key_warning(key)
return super().__getitem__(key)
def get(self, key: str, default = None) -> Any:
DebugOptionsResponse.__key_warning(key)
return super().get(key, default)
def __init__(__self__, *,
enable_hot_key_logging: bool):
"""
Describes any options that have an effect on the debugging of pipelines.
:param bool enable_hot_key_logging: When true, enables the logging of the literal hot key to the user's Cloud Logging.
"""
pulumi.set(__self__, "enable_hot_key_logging", enable_hot_key_logging)
@property
@pulumi.getter(name="enableHotKeyLogging")
def enable_hot_key_logging(self) -> bool:
"""
When true, enables the logging of the literal hot key to the user's Cloud Logging.
"""
return pulumi.get(self, "enable_hot_key_logging")
@pulumi.output_type
class DiskResponse(dict):
"""
Describes the data disk used by a workflow job.
"""
@staticmethod
def __key_warning(key: str):
suggest = None
if key == "diskType":
suggest = "disk_type"
elif key == "mountPoint":
suggest = "mount_point"
elif key == "sizeGb":
suggest = "size_gb"
if suggest:
pulumi.log.warn(f"Key '{key}' not found in DiskResponse. Access the value via the '{suggest}' property getter instead.")
def __getitem__(self, key: str) -> Any:
DiskResponse.__key_warning(key)
return super().__getitem__(key)
def get(self, key: str, default = None) -> Any:
DiskResponse.__key_warning(key)
return super().get(key, default)
def __init__(__self__, *,
disk_type: str,
mount_point: str,
size_gb: int):
"""
Describes the data disk used by a workflow job.
:param str disk_type: Disk storage type, as defined by Google Compute Engine. This must be a disk type appropriate to the project and zone in which the workers will run. If unknown or unspecified, the service will attempt to choose a reasonable default. For example, the standard persistent disk type is a resource name typically ending in "pd-standard". If SSD persistent disks are available, the resource name typically ends with "pd-ssd". The actual valid values are defined the Google Compute Engine API, not by the Cloud Dataflow API; consult the Google Compute Engine documentation for more information about determining the set of available disk types for a particular project and zone. Google Compute Engine Disk types are local to a particular project in a particular zone, and so the resource name will typically look something like this: compute.googleapis.com/projects/project-id/zones/zone/diskTypes/pd-standard
:param str mount_point: Directory in a VM where disk is mounted.
:param int size_gb: Size of disk in GB. If zero or unspecified, the service will attempt to choose a reasonable default.
"""
pulumi.set(__self__, "disk_type", disk_type)
pulumi.set(__self__, "mount_point", mount_point)
pulumi.set(__self__, "size_gb", size_gb)
@property
@pulumi.getter(name="diskType")
def disk_type(self) -> str:
"""
Disk storage type, as defined by Google Compute Engine. This must be a disk type appropriate to the project and zone in which the workers will run. If unknown or unspecified, the service will attempt to choose a reasonable default. For example, the standard persistent disk type is a resource name typically ending in "pd-standard". If SSD persistent disks are available, the resource name typically ends with "pd-ssd". The actual valid values are defined the Google Compute Engine API, not by the Cloud Dataflow API; consult the Google Compute Engine documentation for more information about determining the set of available disk types for a particular project and zone. Google Compute Engine Disk types are local to a particular project in a particular zone, and so the resource name will typically look something like this: compute.googleapis.com/projects/project-id/zones/zone/diskTypes/pd-standard
"""
return pulumi.get(self, "disk_type")
@property
@pulumi.getter(name="mountPoint")
def mount_point(self) -> str:
"""
Directory in a VM where disk is mounted.
"""
return pulumi.get(self, "mount_point")
@property
@pulumi.getter(name="sizeGb")
def size_gb(self) -> int:
"""
Size of disk in GB. If zero or unspecified, the service will attempt to choose a reasonable default.
"""
return pulumi.get(self, "size_gb")
@pulumi.output_type
class DisplayDataResponse(dict):
"""
Data provided with a pipeline or transform to provide descriptive info.
"""
@staticmethod
def __key_warning(key: str):
suggest = None
if key == "boolValue":
suggest = "bool_value"
elif key == "durationValue":
suggest = "duration_value"
elif key == "floatValue":
suggest = "float_value"
elif key == "int64Value":
suggest = "int64_value"
elif key == "javaClassValue":
suggest = "java_class_value"
elif key == "shortStrValue":
suggest = "short_str_value"
elif key == "strValue":
suggest = "str_value"
elif key == "timestampValue":
suggest = "timestamp_value"
if suggest:
pulumi.log.warn(f"Key '{key}' not found in DisplayDataResponse. Access the value via the '{suggest}' property getter instead.")
def __getitem__(self, key: str) -> Any:
DisplayDataResponse.__key_warning(key)
return super().__getitem__(key)
def get(self, key: str, default = None) -> Any:
DisplayDataResponse.__key_warning(key)
return super().get(key, default)
def __init__(__self__, *,
bool_value: bool,
duration_value: str,
float_value: float,
int64_value: str,
java_class_value: str,
key: str,
label: str,
namespace: str,
short_str_value: str,
str_value: str,
timestamp_value: str,
url: str):
"""
Data provided with a pipeline or transform to provide descriptive info.
:param bool bool_value: Contains value if the data is of a boolean type.
:param str duration_value: Contains value if the data is of duration type.
:param float float_value: Contains value if the data is of float type.
:param str int64_value: Contains value if the data is of int64 type.
:param str java_class_value: Contains value if the data is of java class type.
:param str key: The key identifying the display data. This is intended to be used as a label for the display data when viewed in a dax monitoring system.
:param str label: An optional label to display in a dax UI for the element.
:param str namespace: The namespace for the key. This is usually a class name or programming language namespace (i.e. python module) which defines the display data. This allows a dax monitoring system to specially handle the data and perform custom rendering.
:param str short_str_value: A possible additional shorter value to display. For example a java_class_name_value of com.mypackage.MyDoFn will be stored with MyDoFn as the short_str_value and com.mypackage.MyDoFn as the java_class_name value. short_str_value can be displayed and java_class_name_value will be displayed as a tooltip.
:param str str_value: Contains value if the data is of string type.
:param str timestamp_value: Contains value if the data is of timestamp type.
:param str url: An optional full URL.
"""
pulumi.set(__self__, "bool_value", bool_value)
pulumi.set(__self__, "duration_value", duration_value)
pulumi.set(__self__, "float_value", float_value)
pulumi.set(__self__, "int64_value", int64_value)
pulumi.set(__self__, "java_class_value", java_class_value)
pulumi.set(__self__, "key", key)
pulumi.set(__self__, "label", label)
pulumi.set(__self__, "namespace", namespace)
pulumi.set(__self__, "short_str_value", short_str_value)
pulumi.set(__self__, "str_value", str_value)
pulumi.set(__self__, "timestamp_value", timestamp_value)
pulumi.set(__self__, "url", url)
@property
@pulumi.getter(name="boolValue")
def bool_value(self) -> bool:
"""
Contains value if the data is of a boolean type.
"""
return pulumi.get(self, "bool_value")
@property
@pulumi.getter(name="durationValue")
def duration_value(self) -> str:
"""
Contains value if the data is of duration type.
"""
return pulumi.get(self, "duration_value")
@property
@pulumi.getter(name="floatValue")
def float_value(self) -> float:
"""
Contains value if the data is of float type.
"""
return pulumi.get(self, "float_value")
@property
@pulumi.getter(name="int64Value")
def int64_value(self) -> str:
"""
Contains value if the data is of int64 type.
"""
return pulumi.get(self, "int64_value")
@property
@pulumi.getter(name="javaClassValue")
def java_class_value(self) -> str:
"""
Contains value if the data is of java class type.
"""
return pulumi.get(self, "java_class_value")
@property
@pulumi.getter
def key(self) -> str:
"""
The key identifying the display data. This is intended to be used as a label for the display data when viewed in a dax monitoring system.
"""
return pulumi.get(self, "key")
@property
@pulumi.getter
def label(self) -> str:
"""
An optional label to display in a dax UI for the element.
"""
return pulumi.get(self, "label")
@property
@pulumi.getter
def namespace(self) -> str:
"""
The namespace for the key. This is usually a class name or programming language namespace (i.e. python module) which defines the display data. This allows a dax monitoring system to specially handle the data and perform custom rendering.
"""
return pulumi.get(self, "namespace")
@property
@pulumi.getter(name="shortStrValue")
def short_str_value(self) -> str:
"""
A possible additional shorter value to display. For example a java_class_name_value of com.mypackage.MyDoFn will be stored with MyDoFn as the short_str_value and com.mypackage.MyDoFn as the java_class_name value. short_str_value can be displayed and java_class_name_value will be displayed as a tooltip.
"""
return pulumi.get(self, "short_str_value")
@property
@pulumi.getter(name="strValue")
def str_value(self) -> str:
"""
Contains value if the data is of string type.
"""
return pulumi.get(self, "str_value")
@property
@pulumi.getter(name="timestampValue")
def timestamp_value(self) -> str:
"""
Contains value if the data is of timestamp type.
"""
return pulumi.get(self, "timestamp_value")
@property
@pulumi.getter
def url(self) -> str:
"""
An optional full URL.
"""
return pulumi.get(self, "url")
@pulumi.output_type
class EnvironmentResponse(dict):
"""
Describes the environment in which a Dataflow Job runs.
"""
@staticmethod
def __key_warning(key: str):
suggest = None
if key == "clusterManagerApiService":
suggest = "cluster_manager_api_service"
elif key == "debugOptions":
suggest = "debug_options"
elif key == "flexResourceSchedulingGoal":
suggest = "flex_resource_scheduling_goal"
elif key == "internalExperiments":
suggest = "internal_experiments"
elif key == "sdkPipelineOptions":
suggest = "sdk_pipeline_options"
elif key == "serviceAccountEmail":
suggest = "service_account_email"
elif key == "serviceKmsKeyName":
suggest = "service_kms_key_name"
elif key == "serviceOptions":
suggest = "service_options"
elif key == "shuffleMode":
suggest = "shuffle_mode"
elif key == "tempStoragePrefix":
suggest = "temp_storage_prefix"
elif key == "userAgent":
suggest = "user_agent"
elif key == "workerPools":
suggest = "worker_pools"
elif key == "workerRegion":
suggest = "worker_region"
elif key == "workerZone":
suggest = "worker_zone"
if suggest:
pulumi.log.warn(f"Key '{key}' not found in EnvironmentResponse. Access the value via the '{suggest}' property getter instead.")
def __getitem__(self, key: str) -> Any:
EnvironmentResponse.__key_warning(key)
return super().__getitem__(key)
def get(self, key: str, default = None) -> Any:
EnvironmentResponse.__key_warning(key)
return super().get(key, default)
def __init__(__self__, *,
cluster_manager_api_service: str,
dataset: str,
debug_options: 'outputs.DebugOptionsResponse',
experiments: Sequence[str],
flex_resource_scheduling_goal: str,
internal_experiments: Mapping[str, str],
sdk_pipeline_options: Mapping[str, str],
service_account_email: str,
service_kms_key_name: str,
service_options: Sequence[str],
shuffle_mode: str,
temp_storage_prefix: str,
user_agent: Mapping[str, str],
version: Mapping[str, str],
worker_pools: Sequence['outputs.WorkerPoolResponse'],
worker_region: str,
worker_zone: str):
"""
Describes the environment in which a Dataflow Job runs.
:param str cluster_manager_api_service: The type of cluster manager API to use. If unknown or unspecified, the service will attempt to choose a reasonable default. This should be in the form of the API service name, e.g. "compute.googleapis.com".
:param str dataset: The dataset for the current project where various workflow related tables are stored. The supported resource type is: Google BigQuery: bigquery.googleapis.com/{dataset}
:param 'DebugOptionsResponse' debug_options: Any debugging options to be supplied to the job.
:param Sequence[str] experiments: The list of experiments to enable. This field should be used for SDK related experiments and not for service related experiments. The proper field for service related experiments is service_options. For more details see the rationale at go/user-specified-service-options.
:param str flex_resource_scheduling_goal: Which Flexible Resource Scheduling mode to run in.
:param Mapping[str, str] internal_experiments: Experimental settings.
:param Mapping[str, str] sdk_pipeline_options: The Cloud Dataflow SDK pipeline options specified by the user. These options are passed through the service and are used to recreate the SDK pipeline options on the worker in a language agnostic and platform independent way.
:param str service_account_email: Identity to run virtual machines as. Defaults to the default account.
:param str service_kms_key_name: If set, contains the Cloud KMS key identifier used to encrypt data at rest, AKA a Customer Managed Encryption Key (CMEK). Format: projects/PROJECT_ID/locations/LOCATION/keyRings/KEY_RING/cryptoKeys/KEY
:param Sequence[str] service_options: The list of service options to enable. This field should be used for service related experiments only. These experiments, when graduating to GA, should be replaced by dedicated fields or become default (i.e. always on). For more details see the rationale at go/user-specified-service-options.
:param str shuffle_mode: The shuffle mode used for the job.
:param str temp_storage_prefix: The prefix of the resources the system should use for temporary storage. The system will append the suffix "/temp-{JOBNAME} to this resource prefix, where {JOBNAME} is the value of the job_name field. The resulting bucket and object prefix is used as the prefix of the resources used to store temporary data needed during the job execution. NOTE: This will override the value in taskrunner_settings. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}
:param Mapping[str, str] user_agent: A description of the process that generated the request.
:param Mapping[str, str] version: A structure describing which components and their versions of the service are required in order to run the job.
:param Sequence['WorkerPoolResponse'] worker_pools: The worker pools. At least one "harness" worker pool must be specified in order for the job to have workers.
:param str worker_region: The Compute Engine region (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. "us-west1". Mutually exclusive with worker_zone. If neither worker_region nor worker_zone is specified, default to the control plane's region.
:param str worker_zone: The Compute Engine zone (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. "us-west1-a". Mutually exclusive with worker_region. If neither worker_region nor worker_zone is specified, a zone in the control plane's region is chosen based on available capacity.
"""
pulumi.set(__self__, "cluster_manager_api_service", cluster_manager_api_service)
pulumi.set(__self__, "dataset", dataset)
pulumi.set(__self__, "debug_options", debug_options)
pulumi.set(__self__, "experiments", experiments)
pulumi.set(__self__, "flex_resource_scheduling_goal", flex_resource_scheduling_goal)
pulumi.set(__self__, "internal_experiments", internal_experiments)
pulumi.set(__self__, "sdk_pipeline_options", sdk_pipeline_options)
pulumi.set(__self__, "service_account_email", service_account_email)
pulumi.set(__self__, "service_kms_key_name", service_kms_key_name)
pulumi.set(__self__, "service_options", service_options)
pulumi.set(__self__, "shuffle_mode", shuffle_mode)
pulumi.set(__self__, "temp_storage_prefix", temp_storage_prefix)
pulumi.set(__self__, "user_agent", user_agent)
pulumi.set(__self__, "version", version)
pulumi.set(__self__, "worker_pools", worker_pools)
pulumi.set(__self__, "worker_region", worker_region)
pulumi.set(__self__, "worker_zone", worker_zone)
@property
@pulumi.getter(name="clusterManagerApiService")
def cluster_manager_api_service(self) -> str:
"""
The type of cluster manager API to use. If unknown or unspecified, the service will attempt to choose a reasonable default. This should be in the form of the API service name, e.g. "compute.googleapis.com".
"""
return pulumi.get(self, "cluster_manager_api_service")
@property
@pulumi.getter
def dataset(self) -> str:
"""
The dataset for the current project where various workflow related tables are stored. The supported resource type is: Google BigQuery: bigquery.googleapis.com/{dataset}
"""
return pulumi.get(self, "dataset")
@property
@pulumi.getter(name="debugOptions")
def debug_options(self) -> 'outputs.DebugOptionsResponse':
"""
Any debugging options to be supplied to the job.
"""
return pulumi.get(self, "debug_options")
@property
@pulumi.getter
def experiments(self) -> Sequence[str]:
"""
The list of experiments to enable. This field should be used for SDK related experiments and not for service related experiments. The proper field for service related experiments is service_options. For more details see the rationale at go/user-specified-service-options.
"""
return pulumi.get(self, "experiments")
@property
@pulumi.getter(name="flexResourceSchedulingGoal")
def flex_resource_scheduling_goal(self) -> str:
"""
Which Flexible Resource Scheduling mode to run in.
"""
return pulumi.get(self, "flex_resource_scheduling_goal")
@property
@pulumi.getter(name="internalExperiments")
def internal_experiments(self) -> Mapping[str, str]:
"""
Experimental settings.
"""
return pulumi.get(self, "internal_experiments")
@property
@pulumi.getter(name="sdkPipelineOptions")
def sdk_pipeline_options(self) -> Mapping[str, str]:
"""
The Cloud Dataflow SDK pipeline options specified by the user. These options are passed through the service and are used to recreate the SDK pipeline options on the worker in a language agnostic and platform independent way.
"""
return pulumi.get(self, "sdk_pipeline_options")
@property
@pulumi.getter(name="serviceAccountEmail")
def service_account_email(self) -> str:
"""
Identity to run virtual machines as. Defaults to the default account.
"""
return pulumi.get(self, "service_account_email")
@property
@pulumi.getter(name="serviceKmsKeyName")
def service_kms_key_name(self) -> str:
"""
If set, contains the Cloud KMS key identifier used to encrypt data at rest, AKA a Customer Managed Encryption Key (CMEK). Format: projects/PROJECT_ID/locations/LOCATION/keyRings/KEY_RING/cryptoKeys/KEY
"""
return pulumi.get(self, "service_kms_key_name")
@property
@pulumi.getter(name="serviceOptions")
def service_options(self) -> Sequence[str]:
"""
The list of service options to enable. This field should be used for service related experiments only. These experiments, when graduating to GA, should be replaced by dedicated fields or become default (i.e. always on). For more details see the rationale at go/user-specified-service-options.
"""
return pulumi.get(self, "service_options")
@property
@pulumi.getter(name="shuffleMode")
def shuffle_mode(self) -> str:
"""
The shuffle mode used for the job.
"""
return pulumi.get(self, "shuffle_mode")
@property
@pulumi.getter(name="tempStoragePrefix")
def temp_storage_prefix(self) -> str:
"""
The prefix of the resources the system should use for temporary storage. The system will append the suffix "/temp-{JOBNAME} to this resource prefix, where {JOBNAME} is the value of the job_name field. The resulting bucket and object prefix is used as the prefix of the resources used to store temporary data needed during the job execution. NOTE: This will override the value in taskrunner_settings. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}
"""
return pulumi.get(self, "temp_storage_prefix")
@property
@pulumi.getter(name="userAgent")
def user_agent(self) -> Mapping[str, str]:
"""
A description of the process that generated the request.
"""
return pulumi.get(self, "user_agent")
@property
@pulumi.getter
def version(self) -> Mapping[str, str]:
"""
A structure describing which components and their versions of the service are required in order to run the job.
"""
return pulumi.get(self, "version")
@property
@pulumi.getter(name="workerPools")
def worker_pools(self) -> Sequence['outputs.WorkerPoolResponse']:
"""
The worker pools. At least one "harness" worker pool must be specified in order for the job to have workers.
"""
return pulumi.get(self, "worker_pools")
@property
@pulumi.getter(name="workerRegion")
def worker_region(self) -> str:
"""
The Compute Engine region (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. "us-west1". Mutually exclusive with worker_zone. If neither worker_region nor worker_zone is specified, default to the control plane's region.
"""
return pulumi.get(self, "worker_region")
@property
@pulumi.getter(name="workerZone")
def worker_zone(self) -> str:
"""
The Compute Engine zone (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. "us-west1-a". Mutually exclusive with worker_region. If neither worker_region nor worker_zone is specified, a zone in the control plane's region is chosen based on available capacity.
"""
return pulumi.get(self, "worker_zone")
@pulumi.output_type
class ExecutionStageStateResponse(dict):
"""
A message describing the state of a particular execution stage.
"""
@staticmethod
def __key_warning(key: str):
suggest = None
if key == "currentStateTime":
suggest = "current_state_time"
elif key == "executionStageName":
suggest = "execution_stage_name"
elif key == "executionStageState":
suggest = "execution_stage_state"
if suggest:
pulumi.log.warn(f"Key '{key}' not found in ExecutionStageStateResponse. Access the value via the '{suggest}' property getter instead.")
def __getitem__(self, key: str) -> Any:
ExecutionStageStateResponse.__key_warning(key)
return super().__getitem__(key)
def get(self, key: str, default = None) -> Any:
ExecutionStageStateResponse.__key_warning(key)
return super().get(key, default)
def __init__(__self__, *,
current_state_time: str,
execution_stage_name: str,
execution_stage_state: str):
"""
A message describing the state of a particular execution stage.
:param str current_state_time: The time at which the stage transitioned to this state.
:param str execution_stage_name: The name of the execution stage.
:param str execution_stage_state: Executions stage states allow the same set of values as JobState.
"""
pulumi.set(__self__, "current_state_time", current_state_time)
pulumi.set(__self__, "execution_stage_name", execution_stage_name)
pulumi.set(__self__, "execution_stage_state", execution_stage_state)
@property
@pulumi.getter(name="currentStateTime")
def current_state_time(self) -> str:
"""
The time at which the stage transitioned to this state.
"""
return pulumi.get(self, "current_state_time")
@property
@pulumi.getter(name="executionStageName")
def execution_stage_name(self) -> str:
"""
The name of the execution stage.
"""
return pulumi.get(self, "execution_stage_name")
@property
@pulumi.getter(name="executionStageState")
def execution_stage_state(self) -> str:
"""
Executions stage states allow the same set of values as JobState.
"""
return pulumi.get(self, "execution_stage_state")
@pulumi.output_type
class ExecutionStageSummaryResponse(dict):
"""
Description of the composing transforms, names/ids, and input/outputs of a stage of execution. Some composing transforms and sources may have been generated by the Dataflow service during execution planning.
"""
@staticmethod
def __key_warning(key: str):
suggest = None
if key == "componentSource":
suggest = "component_source"
elif key == "componentTransform":
suggest = "component_transform"
elif key == "inputSource":
suggest = "input_source"
elif key == "outputSource":
suggest = "output_source"
elif key == "prerequisiteStage":
suggest = "prerequisite_stage"
if suggest:
pulumi.log.warn(f"Key '{key}' not found in ExecutionStageSummaryResponse. Access the value via the '{suggest}' property getter instead.")
def __getitem__(self, key: str) -> Any:
ExecutionStageSummaryResponse.__key_warning(key)
return super().__getitem__(key)
def get(self, key: str, default = None) -> Any:
ExecutionStageSummaryResponse.__key_warning(key)
return super().get(key, default)
def __init__(__self__, *,
component_source: Sequence['outputs.ComponentSourceResponse'],
component_transform: Sequence['outputs.ComponentTransformResponse'],
input_source: Sequence['outputs.StageSourceResponse'],
kind: str,
name: str,
output_source: Sequence['outputs.StageSourceResponse'],
prerequisite_stage: Sequence[str]):
"""
Description of the composing transforms, names/ids, and input/outputs of a stage of execution. Some composing transforms and sources may have been generated by the Dataflow service during execution planning.
:param Sequence['ComponentSourceResponse'] component_source: Collections produced and consumed by component transforms of this stage.
:param Sequence['ComponentTransformResponse'] component_transform: Transforms that comprise this execution stage.
:param Sequence['StageSourceResponse'] input_source: Input sources for this stage.
:param str kind: Type of transform this stage is executing.