@maxim_mazurok/gapi.client.dataflow-v1b3 0.1.20260302 → 0.2.20260527

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/index.d.ts +462 -193
  2. package/package.json +1 -1
  3. package/readme.md +12 -0
package/index.d.ts CHANGED
@@ -9,7 +9,7 @@
9
9
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
10
10
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
11
11
  // Generated from: https://dataflow.googleapis.com/$discovery/rest?version=v1b3
12
- // Revision: 20260302
12
+ // Revision: 20260527
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -56,7 +56,12 @@ declare namespace gapi.client {
56
56
  /** A message describing why the system decided to adjust the current number of workers, why it failed, or why the system decided to not make any changes to the number of workers. */
57
57
  description?: StructuredMessage;
58
58
  /** The type of autoscaling event to report. */
59
- eventType?: string;
59
+ eventType?:
60
+ | 'TYPE_UNKNOWN'
61
+ | 'TARGET_NUM_WORKERS_CHANGED'
62
+ | 'CURRENT_NUM_WORKERS_CHANGED'
63
+ | 'ACTUATION_FAILURE'
64
+ | 'NO_CHANGE';
60
65
  /** The target number of workers the worker pool wants to resize to use. */
61
66
  targetNumWorkers?: string;
62
67
  /** The time this event was emitted to indicate a new target or current num_workers value. */
@@ -66,7 +71,10 @@ declare namespace gapi.client {
66
71
  }
67
72
  interface AutoscalingSettings {
68
73
  /** The algorithm to use for autoscaling. */
69
- algorithm?: string;
74
+ algorithm?:
75
+ | 'AUTOSCALING_ALGORITHM_UNKNOWN'
76
+ | 'AUTOSCALING_ALGORITHM_NONE'
77
+ | 'AUTOSCALING_ALGORITHM_BASIC';
70
78
  /** The maximum number of workers to cap scaling at. */
71
79
  maxNumWorkers?: number;
72
80
  }
@@ -170,11 +178,29 @@ declare namespace gapi.client {
170
178
  /** Human-readable description of the counter semantics. */
171
179
  description?: string;
172
180
  /** Counter aggregation kind. */
173
- kind?: string;
181
+ kind?:
182
+ | 'INVALID'
183
+ | 'SUM'
184
+ | 'MAX'
185
+ | 'MIN'
186
+ | 'MEAN'
187
+ | 'OR'
188
+ | 'AND'
189
+ | 'SET'
190
+ | 'DISTRIBUTION'
191
+ | 'LATEST_VALUE';
174
192
  /** A string referring to the unit type. */
175
193
  otherUnits?: string;
176
194
  /** System defined Units, see above enum. */
177
- standardUnits?: string;
195
+ standardUnits?:
196
+ | 'BYTES'
197
+ | 'BYTES_PER_SEC'
198
+ | 'MILLISECONDS'
199
+ | 'MICROSECONDS'
200
+ | 'NANOSECONDS'
201
+ | 'TIMESTAMP_MSEC'
202
+ | 'TIMESTAMP_USEC'
203
+ | 'TIMESTAMP_NSEC';
178
204
  }
179
205
  interface CounterStructuredName {
180
206
  /** Name of the optimized step being executed by the workers. */
@@ -186,7 +212,7 @@ declare namespace gapi.client {
186
212
  /** Counter name. Not necessarily globally-unique, but unique within the context of the other fields. Required. */
187
213
  name?: string;
188
214
  /** One of the standard Origins defined above. */
189
- origin?: string;
215
+ origin?: 'SYSTEM' | 'USER';
190
216
  /** The step name requesting an operation, such as GBK. I.e. the ParDo causing a read/write from shuffle to occur, or a read from side inputs. */
191
217
  originalRequestingStepName?: string;
192
218
  /** System generated name of the original step in the user's graph, before optimization. */
@@ -194,7 +220,7 @@ declare namespace gapi.client {
194
220
  /** A string containing a more specific namespace of the counter's origin. */
195
221
  originNamespace?: string;
196
222
  /** Portion of this counter, either key or value. */
197
- portion?: string;
223
+ portion?: 'ALL' | 'KEY' | 'VALUE';
198
224
  /** ID of a particular worker. */
199
225
  workerId?: string;
200
226
  }
@@ -286,7 +312,11 @@ declare namespace gapi.client {
286
312
  }
287
313
  interface DataSamplingConfig {
288
314
  /** List of given sampling behaviors to enable. For example, specifying behaviors = [ALWAYS_ON] samples in-flight elements but does not sample exceptions. Can be used to specify multiple behaviors like, behaviors = [ALWAYS_ON, EXCEPTIONS] for specifying periodic sampling and exception sampling. If DISABLED is in the list, then sampling will be disabled and ignore the other given behaviors. Ordering does not matter. */
289
- behaviors?: string[];
315
+ behaviors?:
316
+ | 'DATA_SAMPLING_BEHAVIOR_UNSPECIFIED'
317
+ | 'DISABLED'
318
+ | 'ALWAYS_ON'
319
+ | 'EXCEPTIONS'[];
290
320
  }
291
321
  interface DataSamplingReport {
292
322
  /** Optional. Delta of bytes written to file from previous report. */
@@ -319,7 +349,11 @@ declare namespace gapi.client {
319
349
  interface DeleteSnapshotResponse {}
320
350
  interface DerivedSource {
321
351
  /** What source to base the produced source on (if any). */
322
- derivationMode?: string;
352
+ derivationMode?:
353
+ | 'SOURCE_DERIVATION_MODE_UNKNOWN'
354
+ | 'SOURCE_DERIVATION_MODE_INDEPENDENT'
355
+ | 'SOURCE_DERIVATION_MODE_CHILD_OF_CURRENT'
356
+ | 'SOURCE_DERIVATION_MODE_SIBLING_OF_CURRENT';
323
357
  /** Specification of the source. */
324
358
  source?: Source;
325
359
  }
@@ -387,7 +421,10 @@ declare namespace gapi.client {
387
421
  /** 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. */
388
422
  experiments?: string[];
389
423
  /** Optional. Which Flexible Resource Scheduling mode to run in. */
390
- flexResourceSchedulingGoal?: string;
424
+ flexResourceSchedulingGoal?:
425
+ | 'FLEXRS_UNSPECIFIED'
426
+ | 'FLEXRS_SPEED_OPTIMIZED'
427
+ | 'FLEXRS_COST_OPTIMIZED';
391
428
  /** Experimental settings. */
392
429
  internalExperiments?: {[P in string]: any};
393
430
  /** 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. */
@@ -399,9 +436,12 @@ declare namespace gapi.client {
399
436
  /** Optional. 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). */
400
437
  serviceOptions?: string[];
401
438
  /** Output only. The shuffle mode used for the job. */
402
- shuffleMode?: string;
439
+ shuffleMode?: 'SHUFFLE_MODE_UNSPECIFIED' | 'VM_BASED' | 'SERVICE_BASED';
403
440
  /** Optional. Specifies the Streaming Engine message processing guarantees. Reduces cost and latency but might result in duplicate messages committed to storage. Designed to run simple mapping streaming ETL jobs at the lowest cost. For example, Change Data Capture (CDC) to BigQuery is a canonical use case. For more information, see [Set the pipeline streaming mode](https://cloud.google.com/dataflow/docs/guides/streaming-modes). */
404
- streamingMode?: string;
441
+ streamingMode?:
442
+ | 'STREAMING_MODE_UNSPECIFIED'
443
+ | 'STREAMING_MODE_EXACTLY_ONCE'
444
+ | 'STREAMING_MODE_AT_LEAST_ONCE';
405
445
  /** 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} */
406
446
  tempStoragePrefix?: string;
407
447
  /** Optional. True when any worker pool that uses public IPs is present. */
@@ -425,7 +465,22 @@ declare namespace gapi.client {
425
465
  /** The name of the execution stage. */
426
466
  executionStageName?: string;
427
467
  /** Executions stage states allow the same set of values as JobState. */
428
- executionStageState?: string;
468
+ executionStageState?:
469
+ | 'JOB_STATE_UNKNOWN'
470
+ | 'JOB_STATE_STOPPED'
471
+ | 'JOB_STATE_RUNNING'
472
+ | 'JOB_STATE_DONE'
473
+ | 'JOB_STATE_FAILED'
474
+ | 'JOB_STATE_CANCELLED'
475
+ | 'JOB_STATE_UPDATED'
476
+ | 'JOB_STATE_DRAINING'
477
+ | 'JOB_STATE_DRAINED'
478
+ | 'JOB_STATE_PENDING'
479
+ | 'JOB_STATE_CANCELLING'
480
+ | 'JOB_STATE_QUEUED'
481
+ | 'JOB_STATE_RESOURCE_CLEANING_UP'
482
+ | 'JOB_STATE_PAUSING'
483
+ | 'JOB_STATE_PAUSED';
429
484
  }
430
485
  interface ExecutionStageSummary {
431
486
  /** Collections produced and consumed by component transforms of this stage. */
@@ -437,7 +492,16 @@ declare namespace gapi.client {
437
492
  /** Input sources for this stage. */
438
493
  inputSource?: StageSource[];
439
494
  /** Type of transform this stage is executing. */
440
- kind?: string;
495
+ kind?:
496
+ | 'UNKNOWN_KIND'
497
+ | 'PAR_DO_KIND'
498
+ | 'GROUP_BY_KEY_KIND'
499
+ | 'FLATTEN_KIND'
500
+ | 'READ_KIND'
501
+ | 'WRITE_KIND'
502
+ | 'CONSTANT_KIND'
503
+ | 'SINGLETON_KIND'
504
+ | 'SHUFFLE_KIND';
441
505
  /** Dataflow service generated name for this stage. */
442
506
  name?: string;
443
507
  /** Output sources for this stage. */
@@ -465,7 +529,10 @@ declare namespace gapi.client {
465
529
  /** Additional user labels to be specified for the job. Keys and values must follow the restrictions specified in the [labeling restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions) page. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1kg", "count": "3" }. */
466
530
  additionalUserLabels?: {[P in string]: string};
467
531
  /** The algorithm to use for autoscaling */
468
- autoscalingAlgorithm?: string;
532
+ autoscalingAlgorithm?:
533
+ | 'AUTOSCALING_ALGORITHM_UNKNOWN'
534
+ | 'AUTOSCALING_ALGORITHM_NONE'
535
+ | 'AUTOSCALING_ALGORITHM_BASIC';
469
536
  /** Worker disk size, in gigabytes. */
470
537
  diskSizeGb?: number;
471
538
  /** If true, when processing time is spent almost entirely on garbage collection (GC), saves a heap dump before ending the thread or process. If false, ends the thread or process without saving a heap dump. Does not save a heap dump when the Java Virtual Machine (JVM) has an out of memory error during processing. The location of the heap file is either echoed back to the user, or the user is given the opportunity to download the heap file. */
@@ -475,12 +542,18 @@ declare namespace gapi.client {
475
542
  /** Whether to enable Streaming Engine for the job. */
476
543
  enableStreamingEngine?: boolean;
477
544
  /** Set FlexRS goal for the job. https://cloud.google.com/dataflow/docs/guides/flexrs */
478
- flexrsGoal?: string;
545
+ flexrsGoal?:
546
+ | 'FLEXRS_UNSPECIFIED'
547
+ | 'FLEXRS_SPEED_OPTIMIZED'
548
+ | 'FLEXRS_COST_OPTIMIZED';
479
549
  /** Configuration for VM IPs. */
480
- ipConfiguration?: string;
550
+ ipConfiguration?:
551
+ | 'WORKER_IP_UNSPECIFIED'
552
+ | 'WORKER_IP_PUBLIC'
553
+ | 'WORKER_IP_PRIVATE';
481
554
  /** Name for the Cloud KMS key for the job. Key format is: projects//locations//keyRings//cryptoKeys/ */
482
555
  kmsKeyName?: string;
483
- /** The machine type to use for launching the job. The default is n1-standard-1. */
556
+ /** The machine type to use for launching the job. If not set, Dataflow will select a default machine type. */
484
557
  launcherMachineType?: string;
485
558
  /** The machine type to use for the job. Defaults to the value from the template if not specified. */
486
559
  machineType?: string;
@@ -499,7 +572,10 @@ declare namespace gapi.client {
499
572
  /** The Cloud Storage path for staging local files. Must be a valid Cloud Storage URL, beginning with `gs://`. */
500
573
  stagingLocation?: string;
501
574
  /** Optional. Specifies the Streaming Engine message processing guarantees. Reduces cost and latency but might result in duplicate messages committed to storage. Designed to run simple mapping streaming ETL jobs at the lowest cost. For example, Change Data Capture (CDC) to BigQuery is a canonical use case. For more information, see [Set the pipeline streaming mode](https://cloud.google.com/dataflow/docs/guides/streaming-modes). */
502
- streamingMode?: string;
575
+ streamingMode?:
576
+ | 'STREAMING_MODE_UNSPECIFIED'
577
+ | 'STREAMING_MODE_EXACTLY_ONCE'
578
+ | 'STREAMING_MODE_AT_LEAST_ONCE';
503
579
  /** Subnetwork to which VMs will be assigned, if desired. You can specify a subnetwork using either a complete URL or an abbreviated path. Expected to be of the form "https://www.googleapis.com/compute/v1/projects/HOST_PROJECT_ID/regions/REGION/subnetworks/SUBNETWORK" or "regions/REGION/subnetworks/SUBNETWORK". If the subnetwork is located in a Shared VPC network, you must use the complete URL. */
504
580
  subnetwork?: string;
505
581
  /** The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with `gs://`. */
@@ -541,7 +617,7 @@ declare namespace gapi.client {
541
617
  /** The status of the get template request. Any problems with the request will be indicated in the error_details. */
542
618
  status?: Status;
543
619
  /** Template Type. */
544
- templateType?: string;
620
+ templateType?: 'UNKNOWN' | 'LEGACY' | 'FLEX';
545
621
  }
546
622
  interface GetWorkerStacktracesRequest {
547
623
  /** The end time for the stacktrace query. The returned stacktraces will be a recent stack trace at or shortly before this time. */
@@ -633,7 +709,22 @@ declare namespace gapi.client {
633
709
  /** The timestamp when the job was initially created. Immutable and set by the Cloud Dataflow service. */
634
710
  createTime?: string;
635
711
  /** The current state of the job. Jobs are created in the `JOB_STATE_STOPPED` state unless otherwise specified. A job in the `JOB_STATE_RUNNING` state may asynchronously enter a terminal state. After a job has reached a terminal state, no further state updates may be made. This field might be mutated by the Dataflow service; callers cannot mutate it. */
636
- currentState?: string;
712
+ currentState?:
713
+ | 'JOB_STATE_UNKNOWN'
714
+ | 'JOB_STATE_STOPPED'
715
+ | 'JOB_STATE_RUNNING'
716
+ | 'JOB_STATE_DONE'
717
+ | 'JOB_STATE_FAILED'
718
+ | 'JOB_STATE_CANCELLED'
719
+ | 'JOB_STATE_UPDATED'
720
+ | 'JOB_STATE_DRAINING'
721
+ | 'JOB_STATE_DRAINED'
722
+ | 'JOB_STATE_PENDING'
723
+ | 'JOB_STATE_CANCELLING'
724
+ | 'JOB_STATE_QUEUED'
725
+ | 'JOB_STATE_RESOURCE_CLEANING_UP'
726
+ | 'JOB_STATE_PAUSING'
727
+ | 'JOB_STATE_PAUSED';
637
728
  /** The timestamp associated with the current state. */
638
729
  currentStateTime?: string;
639
730
  /** Optional. The environment for the job. */
@@ -661,7 +752,22 @@ declare namespace gapi.client {
661
752
  /** If this job is an update of an existing job, this field is the job ID of the job it replaced. When sending a `CreateJobRequest`, you can update a job by specifying it here. The job named here is stopped, and its intermediate state is transferred to this job. */
662
753
  replaceJobId?: string;
663
754
  /** The job's requested state. Applies to `UpdateJob` requests. Set `requested_state` with `UpdateJob` requests to switch between the states `JOB_STATE_STOPPED` and `JOB_STATE_RUNNING`. You can also use `UpdateJob` requests to change a job's state from `JOB_STATE_RUNNING` to `JOB_STATE_CANCELLED`, `JOB_STATE_DONE`, or `JOB_STATE_DRAINED`. These states irrevocably terminate the job if it hasn't already reached a terminal state. This field has no effect on `CreateJob` requests. */
664
- requestedState?: string;
755
+ requestedState?:
756
+ | 'JOB_STATE_UNKNOWN'
757
+ | 'JOB_STATE_STOPPED'
758
+ | 'JOB_STATE_RUNNING'
759
+ | 'JOB_STATE_DONE'
760
+ | 'JOB_STATE_FAILED'
761
+ | 'JOB_STATE_CANCELLED'
762
+ | 'JOB_STATE_UPDATED'
763
+ | 'JOB_STATE_DRAINING'
764
+ | 'JOB_STATE_DRAINED'
765
+ | 'JOB_STATE_PENDING'
766
+ | 'JOB_STATE_CANCELLING'
767
+ | 'JOB_STATE_QUEUED'
768
+ | 'JOB_STATE_RESOURCE_CLEANING_UP'
769
+ | 'JOB_STATE_PAUSING'
770
+ | 'JOB_STATE_PAUSED';
665
771
  /** This field may ONLY be modified at runtime using the projects.jobs.update method to adjust job behavior. This field has no effect when specified at job creation. */
666
772
  runtimeUpdatableParams?: RuntimeUpdatableParams;
667
773
  /** Output only. Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests. */
@@ -683,7 +789,7 @@ declare namespace gapi.client {
683
789
  /** Optional. The map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job. */
684
790
  transformNameMapping?: {[P in string]: string};
685
791
  /** Optional. The type of Dataflow job. */
686
- type?: string;
792
+ type?: 'JOB_TYPE_UNKNOWN' | 'JOB_TYPE_BATCH' | 'JOB_TYPE_STREAMING';
687
793
  }
688
794
  interface JobExecutionDetails {
689
795
  /** If present, this response does not contain all requested tasks. To obtain the next page of results, repeat the request with page_token set to this value. */
@@ -703,7 +809,13 @@ declare namespace gapi.client {
703
809
  /** Deprecated. */
704
810
  id?: string;
705
811
  /** Importance level of the message. */
706
- messageImportance?: string;
812
+ messageImportance?:
813
+ | 'JOB_MESSAGE_IMPORTANCE_UNKNOWN'
814
+ | 'JOB_MESSAGE_DEBUG'
815
+ | 'JOB_MESSAGE_DETAILED'
816
+ | 'JOB_MESSAGE_BASIC'
817
+ | 'JOB_MESSAGE_WARNING'
818
+ | 'JOB_MESSAGE_ERROR';
707
819
  /** The text of the message. */
708
820
  messageText?: string;
709
821
  /** The timestamp of the message. */
@@ -935,7 +1047,17 @@ declare namespace gapi.client {
935
1047
  }
936
1048
  interface NameAndKind {
937
1049
  /** Counter aggregation kind. */
938
- kind?: string;
1050
+ kind?:
1051
+ | 'INVALID'
1052
+ | 'SUM'
1053
+ | 'MAX'
1054
+ | 'MIN'
1055
+ | 'MEAN'
1056
+ | 'OR'
1057
+ | 'AND'
1058
+ | 'SET'
1059
+ | 'DISTRIBUTION'
1060
+ | 'LATEST_VALUE';
939
1061
  /** Name of the counter. */
940
1062
  name?: string;
941
1063
  }
@@ -954,6 +1076,8 @@ declare namespace gapi.client {
954
1076
  location?: string;
955
1077
  /** The name of the package. */
956
1078
  name?: string;
1079
+ /** Optional. The hex-encoded SHA256 checksum of the package. If the checksum is provided, the worker will verify the checksum of the package before using it. If the checksum does not match, the worker will fail to start. */
1080
+ sha256?: string;
957
1081
  }
958
1082
  interface ParallelInstruction {
959
1083
  /** Additional information for Flatten instructions. */
@@ -1001,7 +1125,30 @@ declare namespace gapi.client {
1001
1125
  /** Required. The name of the parameter. */
1002
1126
  name?: string;
1003
1127
  /** Optional. The type of the parameter. Used for selecting input picker. */
1004
- paramType?: string;
1128
+ paramType?:
1129
+ | 'DEFAULT'
1130
+ | 'TEXT'
1131
+ | 'GCS_READ_BUCKET'
1132
+ | 'GCS_WRITE_BUCKET'
1133
+ | 'GCS_READ_FILE'
1134
+ | 'GCS_WRITE_FILE'
1135
+ | 'GCS_READ_FOLDER'
1136
+ | 'GCS_WRITE_FOLDER'
1137
+ | 'PUBSUB_TOPIC'
1138
+ | 'PUBSUB_SUBSCRIPTION'
1139
+ | 'BIGQUERY_TABLE'
1140
+ | 'JAVASCRIPT_UDF_FILE'
1141
+ | 'SERVICE_ACCOUNT'
1142
+ | 'MACHINE_TYPE'
1143
+ | 'KMS_KEY_NAME'
1144
+ | 'WORKER_REGION'
1145
+ | 'WORKER_ZONE'
1146
+ | 'BOOLEAN'
1147
+ | 'ENUM'
1148
+ | 'NUMBER'
1149
+ | 'KAFKA_TOPIC'
1150
+ | 'KAFKA_READ_TOPIC'
1151
+ | 'KAFKA_WRITE_TOPIC';
1005
1152
  /** Optional. Specifies the name of the parent parameter. Used in conjunction with 'parent_trigger_values' to make this parameter conditional (will only be rendered conditionally). Should be mappable to a ParameterMetadata.name field. */
1006
1153
  parentName?: string;
1007
1154
  /** Optional. The value(s) of the 'parent_name' parameter which will trigger this parameter to be shown. If left empty, ANY non-empty value in parent_name will trigger this parameter to be shown. Only considered when this parameter is conditional (when 'parent_name' has been provided). */
@@ -1178,7 +1325,10 @@ declare namespace gapi.client {
1178
1325
  /** Optional. Whether to enable Streaming Engine for the job. */
1179
1326
  enableStreamingEngine?: boolean;
1180
1327
  /** Optional. Configuration for VM IPs. */
1181
- ipConfiguration?: string;
1328
+ ipConfiguration?:
1329
+ | 'WORKER_IP_UNSPECIFIED'
1330
+ | 'WORKER_IP_PUBLIC'
1331
+ | 'WORKER_IP_PRIVATE';
1182
1332
  /** Optional. Name for the Cloud KMS key for the job. Key format is: projects//locations//keyRings//cryptoKeys/ */
1183
1333
  kmsKeyName?: string;
1184
1334
  /** Optional. The machine type to use for the job. Defaults to the value from the template if not specified. */
@@ -1192,7 +1342,10 @@ declare namespace gapi.client {
1192
1342
  /** Optional. The email address of the service account to run the job as. */
1193
1343
  serviceAccountEmail?: string;
1194
1344
  /** Optional. Specifies the Streaming Engine message processing guarantees. Reduces cost and latency but might result in duplicate messages committed to storage. Designed to run simple mapping streaming ETL jobs at the lowest cost. For example, Change Data Capture (CDC) to BigQuery is a canonical use case. For more information, see [Set the pipeline streaming mode](https://cloud.google.com/dataflow/docs/guides/streaming-modes). */
1195
- streamingMode?: string;
1345
+ streamingMode?:
1346
+ | 'STREAMING_MODE_UNSPECIFIED'
1347
+ | 'STREAMING_MODE_EXACTLY_ONCE'
1348
+ | 'STREAMING_MODE_AT_LEAST_ONCE';
1196
1349
  /** Optional. Subnetwork to which VMs will be assigned, if desired. You can specify a subnetwork using either a complete URL or an abbreviated path. Expected to be of the form "https://www.googleapis.com/compute/v1/projects/HOST_PROJECT_ID/regions/REGION/subnetworks/SUBNETWORK" or "regions/REGION/subnetworks/SUBNETWORK". If the subnetwork is located in a Shared VPC network, you must use the complete URL. */
1197
1350
  subnetwork?: string;
1198
1351
  /** Required. The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with `gs://`. */
@@ -1211,10 +1364,12 @@ declare namespace gapi.client {
1211
1364
  sdkInfo?: SDKInfo;
1212
1365
  }
1213
1366
  interface RuntimeUpdatableParams {
1214
- /** Optional. Deprecated: Use `autoscaling_tier` instead. The backlog threshold duration in seconds for autoscaling. Value must be non-negative. */
1367
+ /** Optional. Deprecated: Use `latency_tier` instead. The backlog threshold duration in seconds for autoscaling. Value must be non-negative. */
1215
1368
  acceptableBacklogDuration?: string;
1216
- /** Optional. The backlog threshold tier for autoscaling. Value must be one of "low-latency", "medium-latency", or "high-latency". */
1369
+ /** Optional. Deprecated: Use `latency_tier` instead. The backlog threshold tier for autoscaling. Value must be one of "low-latency", "medium-latency", or "high-latency". */
1217
1370
  autoscalingTier?: string;
1371
+ /** Optional. The backlog threshold tier for autoscaling. Value must be one of "low-latency", "medium-latency", or "high-latency". */
1372
+ latencyTier?: string;
1218
1373
  /** The maximum number of workers to cap autoscaling at. This field is currently only supported for Streaming Engine jobs. */
1219
1374
  maxNumWorkers?: number;
1220
1375
  /** The minimum number of workers to scale down to. This field is currently only supported for Streaming Engine jobs. */
@@ -1230,9 +1385,9 @@ declare namespace gapi.client {
1230
1385
  }
1231
1386
  interface SdkBug {
1232
1387
  /** Output only. How severe the SDK bug is. */
1233
- severity?: string;
1388
+ severity?: 'SEVERITY_UNSPECIFIED' | 'NOTICE' | 'WARNING' | 'SEVERE';
1234
1389
  /** Output only. Describes the impact of this SDK bug. */
1235
- type?: string;
1390
+ type?: 'TYPE_UNSPECIFIED' | 'GENERAL' | 'PERFORMANCE' | 'DATALOSS';
1236
1391
  /** Output only. Link to more information on the bug. */
1237
1392
  uri?: string;
1238
1393
  }
@@ -1248,7 +1403,7 @@ declare namespace gapi.client {
1248
1403
  }
1249
1404
  interface SDKInfo {
1250
1405
  /** Required. The SDK Language. */
1251
- language?: string;
1406
+ language?: 'UNKNOWN' | 'JAVA' | 'PYTHON' | 'GO' | 'YAML';
1252
1407
  /** Optional. The SDK version. */
1253
1408
  version?: string;
1254
1409
  }
@@ -1256,7 +1411,12 @@ declare namespace gapi.client {
1256
1411
  /** Output only. Known bugs found in this SDK version. */
1257
1412
  bugs?: SdkBug[];
1258
1413
  /** The support status for this SDK version. */
1259
- sdkSupportStatus?: string;
1414
+ sdkSupportStatus?:
1415
+ | 'UNKNOWN'
1416
+ | 'SUPPORTED'
1417
+ | 'STALE'
1418
+ | 'DEPRECATED'
1419
+ | 'UNSUPPORTED';
1260
1420
  /** The version of the SDK used to run the job. */
1261
1421
  version?: string;
1262
1422
  /** A readable string describing the version of the SDK. */
@@ -1268,7 +1428,12 @@ declare namespace gapi.client {
1268
1428
  /** The encoded debug information. */
1269
1429
  data?: string;
1270
1430
  /** Format for the data field above (id=5). */
1271
- dataFormat?: string;
1431
+ dataFormat?:
1432
+ | 'DATA_FORMAT_UNSPECIFIED'
1433
+ | 'RAW'
1434
+ | 'JSON'
1435
+ | 'ZLIB'
1436
+ | 'BROTLI';
1272
1437
  /** The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the job specified by job_id. */
1273
1438
  location?: string;
1274
1439
  /** The worker id, i.e., VM hostname. */
@@ -1347,7 +1512,13 @@ declare namespace gapi.client {
1347
1512
  /** The job this snapshot was created from. */
1348
1513
  sourceJobId?: string;
1349
1514
  /** State of the snapshot. */
1350
- state?: string;
1515
+ state?:
1516
+ | 'UNKNOWN_SNAPSHOT_STATE'
1517
+ | 'PENDING'
1518
+ | 'RUNNING'
1519
+ | 'READY'
1520
+ | 'FAILED'
1521
+ | 'DELETED';
1351
1522
  /** The time after which this snapshot will be automatically deleted. */
1352
1523
  ttl?: string;
1353
1524
  }
@@ -1363,7 +1534,7 @@ declare namespace gapi.client {
1363
1534
  }
1364
1535
  interface Source {
1365
1536
  /** While splitting, sources may specify the produced bundles as differences against another source, in order to save backend-side memory and allow bigger jobs. For details, see SourceSplitRequest. To support this use case, the full set of parameters of the source is logically obtained by taking the latest explicitly specified value of each parameter in the order: base_specs (later items win), spec (overrides anything in base_specs). */
1366
- baseSpecs?: Array<{[P in string]: any}>;
1537
+ baseSpecs?: {[P in string]: any}[];
1367
1538
  /** The codec to use to decode data read from the source. */
1368
1539
  codec?: {[P in string]: any};
1369
1540
  /** Setting this value to true hints to the framework that the source doesn't need splitting, and using SourceSplitRequest on it would yield SOURCE_SPLIT_OUTCOME_USE_CURRENT. E.g. a file splitter may set this to true when splitting a single file into a set of byte ranges of appropriate size, and set this to false when splitting a filepattern into individual files. However, for efficiency, a file splitter may decide to produce file subranges directly from the filepattern to avoid a splitting round-trip. See SourceSplitRequest for an overview of the splitting process. This field is meaningful only in the Source objects populated by the user (e.g. when filling in a DerivedSource). Source objects supplied by the framework to the user don't have this field populated. */
@@ -1435,13 +1606,20 @@ declare namespace gapi.client {
1435
1606
  /** If outcome is SPLITTING_HAPPENED, then this is a list of bundles into which the source was split. Otherwise this field is ignored. This list can be empty, which means the source represents an empty input. */
1436
1607
  bundles?: DerivedSource[];
1437
1608
  /** Indicates whether splitting happened and produced a list of bundles. If this is USE_CURRENT_SOURCE_AS_IS, the current source should be processed "as is" without splitting. "bundles" is ignored in this case. If this is SPLITTING_HAPPENED, then "bundles" contains a list of bundles into which the source was split. */
1438
- outcome?: string;
1609
+ outcome?:
1610
+ | 'SOURCE_SPLIT_OUTCOME_UNKNOWN'
1611
+ | 'SOURCE_SPLIT_OUTCOME_USE_CURRENT'
1612
+ | 'SOURCE_SPLIT_OUTCOME_SPLITTING_HAPPENED';
1439
1613
  /** DEPRECATED in favor of bundles. */
1440
1614
  shards?: SourceSplitShard[];
1441
1615
  }
1442
1616
  interface SourceSplitShard {
1443
1617
  /** DEPRECATED */
1444
- derivationMode?: string;
1618
+ derivationMode?:
1619
+ | 'SOURCE_DERIVATION_MODE_UNKNOWN'
1620
+ | 'SOURCE_DERIVATION_MODE_INDEPENDENT'
1621
+ | 'SOURCE_DERIVATION_MODE_CHILD_OF_CURRENT'
1622
+ | 'SOURCE_DERIVATION_MODE_SIBLING_OF_CURRENT';
1445
1623
  /** DEPRECATED */
1446
1624
  source?: Source;
1447
1625
  }
@@ -1499,7 +1677,13 @@ declare namespace gapi.client {
1499
1677
  /** Start time of this stage. */
1500
1678
  startTime?: string;
1501
1679
  /** State of this stage. */
1502
- state?: string;
1680
+ state?:
1681
+ | 'EXECUTION_STATE_UNKNOWN'
1682
+ | 'EXECUTION_STATE_NOT_STARTED'
1683
+ | 'EXECUTION_STATE_RUNNING'
1684
+ | 'EXECUTION_STATE_SUCCEEDED'
1685
+ | 'EXECUTION_STATE_FAILED'
1686
+ | 'EXECUTION_STATE_CANCELLED';
1503
1687
  /** Straggler summary for this stage. */
1504
1688
  stragglerSummary?: StragglerSummary;
1505
1689
  }
@@ -1513,7 +1697,7 @@ declare namespace gapi.client {
1513
1697
  /** The status code, which should be an enum value of google.rpc.Code. */
1514
1698
  code?: number;
1515
1699
  /** A list of messages that carry the error details. There is a common set of message types for APIs to use. */
1516
- details?: Array<{[P in string]: any}>;
1700
+ details?: {[P in string]: any}[];
1517
1701
  /** 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. */
1518
1702
  message?: string;
1519
1703
  }
@@ -1579,7 +1763,10 @@ declare namespace gapi.client {
1579
1763
  /** Describes the set of data disks this task should apply to. */
1580
1764
  dataDisks?: MountedDataDisk[];
1581
1765
  /** A type of streaming computation task. */
1582
- taskType?: string;
1766
+ taskType?:
1767
+ | 'STREAMING_COMPUTATION_TASK_UNKNOWN'
1768
+ | 'STREAMING_COMPUTATION_TASK_STOP'
1769
+ | 'STREAMING_COMPUTATION_TASK_START';
1583
1770
  }
1584
1771
  interface StreamingConfigTask {
1585
1772
  /** Chunk size for commit streams from the harness to windmill. */
@@ -1778,7 +1965,16 @@ declare namespace gapi.client {
1778
1965
  /** User names for all collection inputs to this transform. */
1779
1966
  inputCollectionName?: string[];
1780
1967
  /** Type of transform. */
1781
- kind?: string;
1968
+ kind?:
1969
+ | 'UNKNOWN_KIND'
1970
+ | 'PAR_DO_KIND'
1971
+ | 'GROUP_BY_KEY_KIND'
1972
+ | 'FLATTEN_KIND'
1973
+ | 'READ_KIND'
1974
+ | 'WRITE_KIND'
1975
+ | 'CONSTANT_KIND'
1976
+ | 'SINGLETON_KIND'
1977
+ | 'SHUFFLE_KIND';
1782
1978
  /** User provided name for this transform instance. */
1783
1979
  name?: string;
1784
1980
  /** User names for all collection outputs to this transform. */
@@ -1794,7 +1990,7 @@ declare namespace gapi.client {
1794
1990
  /** Message describing any unusual health reports. */
1795
1991
  msg?: string;
1796
1992
  /** The pods running on the worker. See: http://kubernetes.io/v1.1/docs/api-reference/v1/definitions.html#_v1_pod This field is used by the worker to send the status of the indvidual containers running on each worker. */
1797
- pods?: Array<{[P in string]: any}>;
1993
+ pods?: {[P in string]: any}[];
1798
1994
  /** The interval at which the worker is sending health reports. The default value of 0 should be interpreted as the field is not being explicitly set by the worker. */
1799
1995
  reportInterval?: string;
1800
1996
  /** Code to describe a specific reason, if known, that a VM has reported broken state. */
@@ -1814,7 +2010,15 @@ declare namespace gapi.client {
1814
2010
  /** The start time of this container. All events will report this so that events can be grouped together across container/VM restarts. */
1815
2011
  containerStartTime?: string;
1816
2012
  /** The event being reported. */
1817
- event?: string;
2013
+ event?:
2014
+ | 'UNKNOWN_EVENT'
2015
+ | 'OS_START'
2016
+ | 'CONTAINER_START'
2017
+ | 'NETWORK_UP'
2018
+ | 'STAGING_FILES_DOWNLOAD_START'
2019
+ | 'STAGING_FILES_DOWNLOAD_FINISH'
2020
+ | 'SDK_INSTALL_START'
2021
+ | 'SDK_INSTALL_FINISH';
1818
2022
  /** Other stats that can accompany an event. E.g. { "downloaded_bytes" : "123456" } */
1819
2023
  metadata?: {[P in string]: string};
1820
2024
  }
@@ -1866,7 +2070,11 @@ declare namespace gapi.client {
1866
2070
  /** Data disks that are used by a VM in this workflow. */
1867
2071
  dataDisks?: Disk[];
1868
2072
  /** The default package set to install. This allows the service to select a default set of packages which are useful to worker harnesses written in a particular language. */
1869
- defaultPackageSet?: string;
2073
+ defaultPackageSet?:
2074
+ | 'DEFAULT_PACKAGE_SET_UNKNOWN'
2075
+ | 'DEFAULT_PACKAGE_SET_NONE'
2076
+ | 'DEFAULT_PACKAGE_SET_JAVA'
2077
+ | 'DEFAULT_PACKAGE_SET_PYTHON';
1870
2078
  /** Optional. IOPS provisioned for the root disk for VMs. */
1871
2079
  diskProvisionedIops?: string;
1872
2080
  /** Optional. Throughput provisioned for the root disk for VMs. */
@@ -1878,7 +2086,10 @@ declare namespace gapi.client {
1878
2086
  /** Type of root disk for VMs. If empty or unspecified, the service will attempt to choose a reasonable default. */
1879
2087
  diskType?: string;
1880
2088
  /** Configuration for VM IPs. */
1881
- ipConfiguration?: string;
2089
+ ipConfiguration?:
2090
+ | 'WORKER_IP_UNSPECIFIED'
2091
+ | 'WORKER_IP_PUBLIC'
2092
+ | 'WORKER_IP_PRIVATE';
1882
2093
  /** The kind of the worker pool; currently only `harness` and `shuffle` are supported. */
1883
2094
  kind?: string;
1884
2095
  /** Machine type (e.g. "n1-standard-1"). If empty or unspecified, the service will attempt to choose a reasonable default. */
@@ -1904,7 +2115,11 @@ declare namespace gapi.client {
1904
2115
  /** Settings passed through to Google Compute Engine workers when using the standard Dataflow task runner. Users should ignore this field. */
1905
2116
  taskrunnerSettings?: TaskRunnerSettings;
1906
2117
  /** Sets the policy for determining when to turndown worker pool. Allowed values are: `TEARDOWN_ALWAYS`, `TEARDOWN_ON_SUCCESS`, and `TEARDOWN_NEVER`. `TEARDOWN_ALWAYS` means workers are always torn down regardless of whether the job succeeds. `TEARDOWN_ON_SUCCESS` means workers are torn down if the job succeeds. `TEARDOWN_NEVER` means the workers are never torn down. If the workers are not torn down by the service, they will continue to run and use Google Compute Engine VM resources in the user's project until they are explicitly terminated by the user. Because of this, Google recommends using the `TEARDOWN_ALWAYS` policy except for small, manually supervised test jobs. If unknown or unspecified, the service will attempt to choose a reasonable default. */
1907
- teardownPolicy?: string;
2118
+ teardownPolicy?:
2119
+ | 'TEARDOWN_POLICY_UNKNOWN'
2120
+ | 'TEARDOWN_ALWAYS'
2121
+ | 'TEARDOWN_ON_SUCCESS'
2122
+ | 'TEARDOWN_NEVER';
1908
2123
  /** Required. Docker container image that executes the Cloud Dataflow worker harness, residing in Google Container Registry. Deprecated for the Fn API path. Use sdk_harness_container_images instead. */
1909
2124
  workerHarnessContainerImage?: string;
1910
2125
  /** Zone to run the worker pools in. If empty or unspecified, the service will attempt to choose a reasonable default. */
@@ -1981,7 +2196,13 @@ declare namespace gapi.client {
1981
2196
  /** Start time of this work item attempt. */
1982
2197
  startTime?: string;
1983
2198
  /** State of this work item. */
1984
- state?: string;
2199
+ state?:
2200
+ | 'EXECUTION_STATE_UNKNOWN'
2201
+ | 'EXECUTION_STATE_NOT_STARTED'
2202
+ | 'EXECUTION_STATE_RUNNING'
2203
+ | 'EXECUTION_STATE_SUCCEEDED'
2204
+ | 'EXECUTION_STATE_FAILED'
2205
+ | 'EXECUTION_STATE_CANCELLED';
1985
2206
  /** Information about straggler detections for this work item. */
1986
2207
  stragglerInfo?: StragglerInfo;
1987
2208
  /** Name of this work item. */
@@ -2049,11 +2270,11 @@ declare namespace gapi.client {
2049
2270
  /** Get encoded debug configuration for component. Not cacheable. */
2050
2271
  getConfig(request: {
2051
2272
  /** V1 error format. */
2052
- '$.xgafv'?: string;
2273
+ '$.xgafv'?: '1' | '2';
2053
2274
  /** OAuth access token. */
2054
2275
  access_token?: string;
2055
2276
  /** Data format for response. */
2056
- alt?: string;
2277
+ alt?: 'json' | 'media' | 'proto';
2057
2278
  /** JSONP */
2058
2279
  callback?: string;
2059
2280
  /** Selector specifying which fields to include in a partial response. */
@@ -2080,11 +2301,11 @@ declare namespace gapi.client {
2080
2301
  getConfig(
2081
2302
  request: {
2082
2303
  /** V1 error format. */
2083
- '$.xgafv'?: string;
2304
+ '$.xgafv'?: '1' | '2';
2084
2305
  /** OAuth access token. */
2085
2306
  access_token?: string;
2086
2307
  /** Data format for response. */
2087
- alt?: string;
2308
+ alt?: 'json' | 'media' | 'proto';
2088
2309
  /** JSONP */
2089
2310
  callback?: string;
2090
2311
  /** Selector specifying which fields to include in a partial response. */
@@ -2111,11 +2332,11 @@ declare namespace gapi.client {
2111
2332
  /** Send encoded debug capture data for component. */
2112
2333
  sendCapture(request: {
2113
2334
  /** V1 error format. */
2114
- '$.xgafv'?: string;
2335
+ '$.xgafv'?: '1' | '2';
2115
2336
  /** OAuth access token. */
2116
2337
  access_token?: string;
2117
2338
  /** Data format for response. */
2118
- alt?: string;
2339
+ alt?: 'json' | 'media' | 'proto';
2119
2340
  /** JSONP */
2120
2341
  callback?: string;
2121
2342
  /** Selector specifying which fields to include in a partial response. */
@@ -2142,11 +2363,11 @@ declare namespace gapi.client {
2142
2363
  sendCapture(
2143
2364
  request: {
2144
2365
  /** V1 error format. */
2145
- '$.xgafv'?: string;
2366
+ '$.xgafv'?: '1' | '2';
2146
2367
  /** OAuth access token. */
2147
2368
  access_token?: string;
2148
2369
  /** Data format for response. */
2149
- alt?: string;
2370
+ alt?: 'json' | 'media' | 'proto';
2150
2371
  /** JSONP */
2151
2372
  callback?: string;
2152
2373
  /** Selector specifying which fields to include in a partial response. */
@@ -2175,11 +2396,11 @@ declare namespace gapi.client {
2175
2396
  /** Request the job status. To request the status of a job, we recommend using `projects.locations.jobs.messages.list` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.messages.list` is not recommended, as you can only request the status of jobs that are running in `us-central1`. */
2176
2397
  list(request?: {
2177
2398
  /** V1 error format. */
2178
- '$.xgafv'?: string;
2399
+ '$.xgafv'?: '1' | '2';
2179
2400
  /** OAuth access token. */
2180
2401
  access_token?: string;
2181
2402
  /** Data format for response. */
2182
- alt?: string;
2403
+ alt?: 'json' | 'media' | 'proto';
2183
2404
  /** JSONP */
2184
2405
  callback?: string;
2185
2406
  /** Return only messages with timestamps < end_time. The default is now (i.e. return up to the latest messages available). */
@@ -2193,7 +2414,13 @@ declare namespace gapi.client {
2193
2414
  /** The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the job specified by job_id. */
2194
2415
  location?: string;
2195
2416
  /** Filter to only get messages with importance >= level */
2196
- minimumImportance?: string;
2417
+ minimumImportance?:
2418
+ | 'JOB_MESSAGE_IMPORTANCE_UNKNOWN'
2419
+ | 'JOB_MESSAGE_DEBUG'
2420
+ | 'JOB_MESSAGE_DETAILED'
2421
+ | 'JOB_MESSAGE_BASIC'
2422
+ | 'JOB_MESSAGE_WARNING'
2423
+ | 'JOB_MESSAGE_ERROR';
2197
2424
  /** OAuth 2.0 token for the current user. */
2198
2425
  oauth_token?: string;
2199
2426
  /** If specified, determines the maximum number of messages to return. If unspecified, the service may choose an appropriate default, or may return an arbitrarily large number of results. */
@@ -2218,11 +2445,11 @@ declare namespace gapi.client {
2218
2445
  /** Leases a dataflow WorkItem to run. */
2219
2446
  lease(request: {
2220
2447
  /** V1 error format. */
2221
- '$.xgafv'?: string;
2448
+ '$.xgafv'?: '1' | '2';
2222
2449
  /** OAuth access token. */
2223
2450
  access_token?: string;
2224
2451
  /** Data format for response. */
2225
- alt?: string;
2452
+ alt?: 'json' | 'media' | 'proto';
2226
2453
  /** JSONP */
2227
2454
  callback?: string;
2228
2455
  /** Selector specifying which fields to include in a partial response. */
@@ -2249,11 +2476,11 @@ declare namespace gapi.client {
2249
2476
  lease(
2250
2477
  request: {
2251
2478
  /** V1 error format. */
2252
- '$.xgafv'?: string;
2479
+ '$.xgafv'?: '1' | '2';
2253
2480
  /** OAuth access token. */
2254
2481
  access_token?: string;
2255
2482
  /** Data format for response. */
2256
- alt?: string;
2483
+ alt?: 'json' | 'media' | 'proto';
2257
2484
  /** JSONP */
2258
2485
  callback?: string;
2259
2486
  /** Selector specifying which fields to include in a partial response. */
@@ -2280,11 +2507,11 @@ declare namespace gapi.client {
2280
2507
  /** Reports the status of dataflow WorkItems leased by a worker. */
2281
2508
  reportStatus(request: {
2282
2509
  /** V1 error format. */
2283
- '$.xgafv'?: string;
2510
+ '$.xgafv'?: '1' | '2';
2284
2511
  /** OAuth access token. */
2285
2512
  access_token?: string;
2286
2513
  /** Data format for response. */
2287
- alt?: string;
2514
+ alt?: 'json' | 'media' | 'proto';
2288
2515
  /** JSONP */
2289
2516
  callback?: string;
2290
2517
  /** Selector specifying which fields to include in a partial response. */
@@ -2311,11 +2538,11 @@ declare namespace gapi.client {
2311
2538
  reportStatus(
2312
2539
  request: {
2313
2540
  /** V1 error format. */
2314
- '$.xgafv'?: string;
2541
+ '$.xgafv'?: '1' | '2';
2315
2542
  /** OAuth access token. */
2316
2543
  access_token?: string;
2317
2544
  /** Data format for response. */
2318
- alt?: string;
2545
+ alt?: 'json' | 'media' | 'proto';
2319
2546
  /** JSONP */
2320
2547
  callback?: string;
2321
2548
  /** Selector specifying which fields to include in a partial response. */
@@ -2344,17 +2571,17 @@ declare namespace gapi.client {
2344
2571
  /** List the jobs of a project across all regions. **Note:** This method doesn't support filtering the list of jobs by name. */
2345
2572
  aggregated(request?: {
2346
2573
  /** V1 error format. */
2347
- '$.xgafv'?: string;
2574
+ '$.xgafv'?: '1' | '2';
2348
2575
  /** OAuth access token. */
2349
2576
  access_token?: string;
2350
2577
  /** Data format for response. */
2351
- alt?: string;
2578
+ alt?: 'json' | 'media' | 'proto';
2352
2579
  /** JSONP */
2353
2580
  callback?: string;
2354
2581
  /** Selector specifying which fields to include in a partial response. */
2355
2582
  fields?: string;
2356
2583
  /** The kind of filter to use. */
2357
- filter?: string;
2584
+ filter?: 'UNKNOWN' | 'ALL' | 'TERMINATED' | 'ACTIVE';
2358
2585
  /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
2359
2586
  key?: string;
2360
2587
  /** The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job. */
@@ -2378,16 +2605,20 @@ declare namespace gapi.client {
2378
2605
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2379
2606
  uploadType?: string;
2380
2607
  /** Deprecated. ListJobs always returns summaries now. Use GetJob for other JobViews. */
2381
- view?: string;
2608
+ view?:
2609
+ | 'JOB_VIEW_UNKNOWN'
2610
+ | 'JOB_VIEW_SUMMARY'
2611
+ | 'JOB_VIEW_ALL'
2612
+ | 'JOB_VIEW_DESCRIPTION';
2382
2613
  }): Request<ListJobsResponse>;
2383
2614
  /** Creates a Dataflow job. To create a job, we recommend using `projects.locations.jobs.create` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.create` is not recommended, as your job will always start in `us-central1`. Do not enter confidential information when you supply string values using the API. */
2384
2615
  create(request: {
2385
2616
  /** V1 error format. */
2386
- '$.xgafv'?: string;
2617
+ '$.xgafv'?: '1' | '2';
2387
2618
  /** OAuth access token. */
2388
2619
  access_token?: string;
2389
2620
  /** Data format for response. */
2390
- alt?: string;
2621
+ alt?: 'json' | 'media' | 'proto';
2391
2622
  /** JSONP */
2392
2623
  callback?: string;
2393
2624
  /** Selector specifying which fields to include in a partial response. */
@@ -2411,18 +2642,22 @@ declare namespace gapi.client {
2411
2642
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2412
2643
  uploadType?: string;
2413
2644
  /** The level of information requested in response. */
2414
- view?: string;
2645
+ view?:
2646
+ | 'JOB_VIEW_UNKNOWN'
2647
+ | 'JOB_VIEW_SUMMARY'
2648
+ | 'JOB_VIEW_ALL'
2649
+ | 'JOB_VIEW_DESCRIPTION';
2415
2650
  /** Request body */
2416
2651
  resource: Job;
2417
2652
  }): Request<Job>;
2418
2653
  create(
2419
2654
  request: {
2420
2655
  /** V1 error format. */
2421
- '$.xgafv'?: string;
2656
+ '$.xgafv'?: '1' | '2';
2422
2657
  /** OAuth access token. */
2423
2658
  access_token?: string;
2424
2659
  /** Data format for response. */
2425
- alt?: string;
2660
+ alt?: 'json' | 'media' | 'proto';
2426
2661
  /** JSONP */
2427
2662
  callback?: string;
2428
2663
  /** Selector specifying which fields to include in a partial response. */
@@ -2446,18 +2681,22 @@ declare namespace gapi.client {
2446
2681
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2447
2682
  uploadType?: string;
2448
2683
  /** The level of information requested in response. */
2449
- view?: string;
2684
+ view?:
2685
+ | 'JOB_VIEW_UNKNOWN'
2686
+ | 'JOB_VIEW_SUMMARY'
2687
+ | 'JOB_VIEW_ALL'
2688
+ | 'JOB_VIEW_DESCRIPTION';
2450
2689
  },
2451
2690
  body: Job,
2452
2691
  ): Request<Job>;
2453
2692
  /** Gets the state of the specified Cloud Dataflow job. To get the state of a job, we recommend using `projects.locations.jobs.get` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.get` is not recommended, as you can only get the state of jobs that are running in `us-central1`. */
2454
2693
  get(request?: {
2455
2694
  /** V1 error format. */
2456
- '$.xgafv'?: string;
2695
+ '$.xgafv'?: '1' | '2';
2457
2696
  /** OAuth access token. */
2458
2697
  access_token?: string;
2459
2698
  /** Data format for response. */
2460
- alt?: string;
2699
+ alt?: 'json' | 'media' | 'proto';
2461
2700
  /** JSONP */
2462
2701
  callback?: string;
2463
2702
  /** Selector specifying which fields to include in a partial response. */
@@ -2481,16 +2720,20 @@ declare namespace gapi.client {
2481
2720
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2482
2721
  uploadType?: string;
2483
2722
  /** The level of information requested in response. */
2484
- view?: string;
2723
+ view?:
2724
+ | 'JOB_VIEW_UNKNOWN'
2725
+ | 'JOB_VIEW_SUMMARY'
2726
+ | 'JOB_VIEW_ALL'
2727
+ | 'JOB_VIEW_DESCRIPTION';
2485
2728
  }): Request<Job>;
2486
2729
  /** Request the job status. To request the status of a job, we recommend using `projects.locations.jobs.getMetrics` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.getMetrics` is not recommended, as you can only request the status of jobs that are running in `us-central1`. */
2487
2730
  getMetrics(request?: {
2488
2731
  /** V1 error format. */
2489
- '$.xgafv'?: string;
2732
+ '$.xgafv'?: '1' | '2';
2490
2733
  /** OAuth access token. */
2491
2734
  access_token?: string;
2492
2735
  /** Data format for response. */
2493
- alt?: string;
2736
+ alt?: 'json' | 'media' | 'proto';
2494
2737
  /** JSONP */
2495
2738
  callback?: string;
2496
2739
  /** Selector specifying which fields to include in a partial response. */
@@ -2519,17 +2762,17 @@ declare namespace gapi.client {
2519
2762
  /** List the jobs of a project. To list the jobs of a project in a region, we recommend using `projects.locations.jobs.list` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). To list the all jobs across all regions, use `projects.jobs.aggregated`. Using `projects.jobs.list` is not recommended, because you can only get the list of jobs that are running in `us-central1`. `projects.locations.jobs.list` and `projects.jobs.list` support filtering the list of jobs by name. Filtering by name isn't supported by `projects.jobs.aggregated`. */
2520
2763
  list(request?: {
2521
2764
  /** V1 error format. */
2522
- '$.xgafv'?: string;
2765
+ '$.xgafv'?: '1' | '2';
2523
2766
  /** OAuth access token. */
2524
2767
  access_token?: string;
2525
2768
  /** Data format for response. */
2526
- alt?: string;
2769
+ alt?: 'json' | 'media' | 'proto';
2527
2770
  /** JSONP */
2528
2771
  callback?: string;
2529
2772
  /** Selector specifying which fields to include in a partial response. */
2530
2773
  fields?: string;
2531
2774
  /** The kind of filter to use. */
2532
- filter?: string;
2775
+ filter?: 'UNKNOWN' | 'ALL' | 'TERMINATED' | 'ACTIVE';
2533
2776
  /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
2534
2777
  key?: string;
2535
2778
  /** The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job. */
@@ -2553,16 +2796,20 @@ declare namespace gapi.client {
2553
2796
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2554
2797
  uploadType?: string;
2555
2798
  /** Deprecated. ListJobs always returns summaries now. Use GetJob for other JobViews. */
2556
- view?: string;
2799
+ view?:
2800
+ | 'JOB_VIEW_UNKNOWN'
2801
+ | 'JOB_VIEW_SUMMARY'
2802
+ | 'JOB_VIEW_ALL'
2803
+ | 'JOB_VIEW_DESCRIPTION';
2557
2804
  }): Request<ListJobsResponse>;
2558
2805
  /** Snapshot the state of a streaming job. */
2559
2806
  snapshot(request: {
2560
2807
  /** V1 error format. */
2561
- '$.xgafv'?: string;
2808
+ '$.xgafv'?: '1' | '2';
2562
2809
  /** OAuth access token. */
2563
2810
  access_token?: string;
2564
2811
  /** Data format for response. */
2565
- alt?: string;
2812
+ alt?: 'json' | 'media' | 'proto';
2566
2813
  /** JSONP */
2567
2814
  callback?: string;
2568
2815
  /** Selector specifying which fields to include in a partial response. */
@@ -2589,11 +2836,11 @@ declare namespace gapi.client {
2589
2836
  snapshot(
2590
2837
  request: {
2591
2838
  /** V1 error format. */
2592
- '$.xgafv'?: string;
2839
+ '$.xgafv'?: '1' | '2';
2593
2840
  /** OAuth access token. */
2594
2841
  access_token?: string;
2595
2842
  /** Data format for response. */
2596
- alt?: string;
2843
+ alt?: 'json' | 'media' | 'proto';
2597
2844
  /** JSONP */
2598
2845
  callback?: string;
2599
2846
  /** Selector specifying which fields to include in a partial response. */
@@ -2620,11 +2867,11 @@ declare namespace gapi.client {
2620
2867
  /** Updates the state of an existing Cloud Dataflow job. To update the state of an existing job, we recommend using `projects.locations.jobs.update` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.update` is not recommended, as you can only update the state of jobs that are running in `us-central1`. */
2621
2868
  update(request: {
2622
2869
  /** V1 error format. */
2623
- '$.xgafv'?: string;
2870
+ '$.xgafv'?: '1' | '2';
2624
2871
  /** OAuth access token. */
2625
2872
  access_token?: string;
2626
2873
  /** Data format for response. */
2627
- alt?: string;
2874
+ alt?: 'json' | 'media' | 'proto';
2628
2875
  /** JSONP */
2629
2876
  callback?: string;
2630
2877
  /** Selector specifying which fields to include in a partial response. */
@@ -2655,11 +2902,11 @@ declare namespace gapi.client {
2655
2902
  update(
2656
2903
  request: {
2657
2904
  /** V1 error format. */
2658
- '$.xgafv'?: string;
2905
+ '$.xgafv'?: '1' | '2';
2659
2906
  /** OAuth access token. */
2660
2907
  access_token?: string;
2661
2908
  /** Data format for response. */
2662
- alt?: string;
2909
+ alt?: 'json' | 'media' | 'proto';
2663
2910
  /** JSONP */
2664
2911
  callback?: string;
2665
2912
  /** Selector specifying which fields to include in a partial response. */
@@ -2695,11 +2942,11 @@ declare namespace gapi.client {
2695
2942
  /** Launch a job with a FlexTemplate. */
2696
2943
  launch(request: {
2697
2944
  /** V1 error format. */
2698
- '$.xgafv'?: string;
2945
+ '$.xgafv'?: '1' | '2';
2699
2946
  /** OAuth access token. */
2700
2947
  access_token?: string;
2701
2948
  /** Data format for response. */
2702
- alt?: string;
2949
+ alt?: 'json' | 'media' | 'proto';
2703
2950
  /** JSONP */
2704
2951
  callback?: string;
2705
2952
  /** Selector specifying which fields to include in a partial response. */
@@ -2726,11 +2973,11 @@ declare namespace gapi.client {
2726
2973
  launch(
2727
2974
  request: {
2728
2975
  /** V1 error format. */
2729
- '$.xgafv'?: string;
2976
+ '$.xgafv'?: '1' | '2';
2730
2977
  /** OAuth access token. */
2731
2978
  access_token?: string;
2732
2979
  /** Data format for response. */
2733
- alt?: string;
2980
+ alt?: 'json' | 'media' | 'proto';
2734
2981
  /** JSONP */
2735
2982
  callback?: string;
2736
2983
  /** Selector specifying which fields to include in a partial response. */
@@ -2759,11 +3006,11 @@ declare namespace gapi.client {
2759
3006
  /** Get encoded debug configuration for component. Not cacheable. */
2760
3007
  getConfig(request: {
2761
3008
  /** V1 error format. */
2762
- '$.xgafv'?: string;
3009
+ '$.xgafv'?: '1' | '2';
2763
3010
  /** OAuth access token. */
2764
3011
  access_token?: string;
2765
3012
  /** Data format for response. */
2766
- alt?: string;
3013
+ alt?: 'json' | 'media' | 'proto';
2767
3014
  /** JSONP */
2768
3015
  callback?: string;
2769
3016
  /** Selector specifying which fields to include in a partial response. */
@@ -2792,11 +3039,11 @@ declare namespace gapi.client {
2792
3039
  getConfig(
2793
3040
  request: {
2794
3041
  /** V1 error format. */
2795
- '$.xgafv'?: string;
3042
+ '$.xgafv'?: '1' | '2';
2796
3043
  /** OAuth access token. */
2797
3044
  access_token?: string;
2798
3045
  /** Data format for response. */
2799
- alt?: string;
3046
+ alt?: 'json' | 'media' | 'proto';
2800
3047
  /** JSONP */
2801
3048
  callback?: string;
2802
3049
  /** Selector specifying which fields to include in a partial response. */
@@ -2825,11 +3072,11 @@ declare namespace gapi.client {
2825
3072
  /** Get worker stacktraces from debug capture. */
2826
3073
  getWorkerStacktraces(request: {
2827
3074
  /** V1 error format. */
2828
- '$.xgafv'?: string;
3075
+ '$.xgafv'?: '1' | '2';
2829
3076
  /** OAuth access token. */
2830
3077
  access_token?: string;
2831
3078
  /** Data format for response. */
2832
- alt?: string;
3079
+ alt?: 'json' | 'media' | 'proto';
2833
3080
  /** JSONP */
2834
3081
  callback?: string;
2835
3082
  /** Selector specifying which fields to include in a partial response. */
@@ -2858,11 +3105,11 @@ declare namespace gapi.client {
2858
3105
  getWorkerStacktraces(
2859
3106
  request: {
2860
3107
  /** V1 error format. */
2861
- '$.xgafv'?: string;
3108
+ '$.xgafv'?: '1' | '2';
2862
3109
  /** OAuth access token. */
2863
3110
  access_token?: string;
2864
3111
  /** Data format for response. */
2865
- alt?: string;
3112
+ alt?: 'json' | 'media' | 'proto';
2866
3113
  /** JSONP */
2867
3114
  callback?: string;
2868
3115
  /** Selector specifying which fields to include in a partial response. */
@@ -2891,11 +3138,11 @@ declare namespace gapi.client {
2891
3138
  /** Send encoded debug capture data for component. */
2892
3139
  sendCapture(request: {
2893
3140
  /** V1 error format. */
2894
- '$.xgafv'?: string;
3141
+ '$.xgafv'?: '1' | '2';
2895
3142
  /** OAuth access token. */
2896
3143
  access_token?: string;
2897
3144
  /** Data format for response. */
2898
- alt?: string;
3145
+ alt?: 'json' | 'media' | 'proto';
2899
3146
  /** JSONP */
2900
3147
  callback?: string;
2901
3148
  /** Selector specifying which fields to include in a partial response. */
@@ -2924,11 +3171,11 @@ declare namespace gapi.client {
2924
3171
  sendCapture(
2925
3172
  request: {
2926
3173
  /** V1 error format. */
2927
- '$.xgafv'?: string;
3174
+ '$.xgafv'?: '1' | '2';
2928
3175
  /** OAuth access token. */
2929
3176
  access_token?: string;
2930
3177
  /** Data format for response. */
2931
- alt?: string;
3178
+ alt?: 'json' | 'media' | 'proto';
2932
3179
  /** JSONP */
2933
3180
  callback?: string;
2934
3181
  /** Selector specifying which fields to include in a partial response. */
@@ -2959,11 +3206,11 @@ declare namespace gapi.client {
2959
3206
  /** Request the job status. To request the status of a job, we recommend using `projects.locations.jobs.messages.list` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.messages.list` is not recommended, as you can only request the status of jobs that are running in `us-central1`. */
2960
3207
  list(request?: {
2961
3208
  /** V1 error format. */
2962
- '$.xgafv'?: string;
3209
+ '$.xgafv'?: '1' | '2';
2963
3210
  /** OAuth access token. */
2964
3211
  access_token?: string;
2965
3212
  /** Data format for response. */
2966
- alt?: string;
3213
+ alt?: 'json' | 'media' | 'proto';
2967
3214
  /** JSONP */
2968
3215
  callback?: string;
2969
3216
  /** Return only messages with timestamps < end_time. The default is now (i.e. return up to the latest messages available). */
@@ -2977,7 +3224,13 @@ declare namespace gapi.client {
2977
3224
  /** The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the job specified by job_id. */
2978
3225
  location: string;
2979
3226
  /** Filter to only get messages with importance >= level */
2980
- minimumImportance?: string;
3227
+ minimumImportance?:
3228
+ | 'JOB_MESSAGE_IMPORTANCE_UNKNOWN'
3229
+ | 'JOB_MESSAGE_DEBUG'
3230
+ | 'JOB_MESSAGE_DETAILED'
3231
+ | 'JOB_MESSAGE_BASIC'
3232
+ | 'JOB_MESSAGE_WARNING'
3233
+ | 'JOB_MESSAGE_ERROR';
2981
3234
  /** OAuth 2.0 token for the current user. */
2982
3235
  oauth_token?: string;
2983
3236
  /** If specified, determines the maximum number of messages to return. If unspecified, the service may choose an appropriate default, or may return an arbitrarily large number of results. */
@@ -3002,11 +3255,11 @@ declare namespace gapi.client {
3002
3255
  /** Lists snapshots. */
3003
3256
  list(request?: {
3004
3257
  /** V1 error format. */
3005
- '$.xgafv'?: string;
3258
+ '$.xgafv'?: '1' | '2';
3006
3259
  /** OAuth access token. */
3007
3260
  access_token?: string;
3008
3261
  /** Data format for response. */
3009
- alt?: string;
3262
+ alt?: 'json' | 'media' | 'proto';
3010
3263
  /** JSONP */
3011
3264
  callback?: string;
3012
3265
  /** Selector specifying which fields to include in a partial response. */
@@ -3035,11 +3288,11 @@ declare namespace gapi.client {
3035
3288
  /** Request detailed information about the execution status of a stage of the job. EXPERIMENTAL. This API is subject to change or removal without notice. */
3036
3289
  getExecutionDetails(request?: {
3037
3290
  /** V1 error format. */
3038
- '$.xgafv'?: string;
3291
+ '$.xgafv'?: '1' | '2';
3039
3292
  /** OAuth access token. */
3040
3293
  access_token?: string;
3041
3294
  /** Data format for response. */
3042
- alt?: string;
3295
+ alt?: 'json' | 'media' | 'proto';
3043
3296
  /** JSONP */
3044
3297
  callback?: string;
3045
3298
  /** Upper time bound of work items to include, by start time. */
@@ -3078,11 +3331,11 @@ declare namespace gapi.client {
3078
3331
  /** Leases a dataflow WorkItem to run. */
3079
3332
  lease(request: {
3080
3333
  /** V1 error format. */
3081
- '$.xgafv'?: string;
3334
+ '$.xgafv'?: '1' | '2';
3082
3335
  /** OAuth access token. */
3083
3336
  access_token?: string;
3084
3337
  /** Data format for response. */
3085
- alt?: string;
3338
+ alt?: 'json' | 'media' | 'proto';
3086
3339
  /** JSONP */
3087
3340
  callback?: string;
3088
3341
  /** Selector specifying which fields to include in a partial response. */
@@ -3111,11 +3364,11 @@ declare namespace gapi.client {
3111
3364
  lease(
3112
3365
  request: {
3113
3366
  /** V1 error format. */
3114
- '$.xgafv'?: string;
3367
+ '$.xgafv'?: '1' | '2';
3115
3368
  /** OAuth access token. */
3116
3369
  access_token?: string;
3117
3370
  /** Data format for response. */
3118
- alt?: string;
3371
+ alt?: 'json' | 'media' | 'proto';
3119
3372
  /** JSONP */
3120
3373
  callback?: string;
3121
3374
  /** Selector specifying which fields to include in a partial response. */
@@ -3144,11 +3397,11 @@ declare namespace gapi.client {
3144
3397
  /** Reports the status of dataflow WorkItems leased by a worker. */
3145
3398
  reportStatus(request: {
3146
3399
  /** V1 error format. */
3147
- '$.xgafv'?: string;
3400
+ '$.xgafv'?: '1' | '2';
3148
3401
  /** OAuth access token. */
3149
3402
  access_token?: string;
3150
3403
  /** Data format for response. */
3151
- alt?: string;
3404
+ alt?: 'json' | 'media' | 'proto';
3152
3405
  /** JSONP */
3153
3406
  callback?: string;
3154
3407
  /** Selector specifying which fields to include in a partial response. */
@@ -3177,11 +3430,11 @@ declare namespace gapi.client {
3177
3430
  reportStatus(
3178
3431
  request: {
3179
3432
  /** V1 error format. */
3180
- '$.xgafv'?: string;
3433
+ '$.xgafv'?: '1' | '2';
3181
3434
  /** OAuth access token. */
3182
3435
  access_token?: string;
3183
3436
  /** Data format for response. */
3184
- alt?: string;
3437
+ alt?: 'json' | 'media' | 'proto';
3185
3438
  /** JSONP */
3186
3439
  callback?: string;
3187
3440
  /** Selector specifying which fields to include in a partial response. */
@@ -3212,11 +3465,11 @@ declare namespace gapi.client {
3212
3465
  /** Creates a Dataflow job. To create a job, we recommend using `projects.locations.jobs.create` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.create` is not recommended, as your job will always start in `us-central1`. Do not enter confidential information when you supply string values using the API. */
3213
3466
  create(request: {
3214
3467
  /** V1 error format. */
3215
- '$.xgafv'?: string;
3468
+ '$.xgafv'?: '1' | '2';
3216
3469
  /** OAuth access token. */
3217
3470
  access_token?: string;
3218
3471
  /** Data format for response. */
3219
- alt?: string;
3472
+ alt?: 'json' | 'media' | 'proto';
3220
3473
  /** JSONP */
3221
3474
  callback?: string;
3222
3475
  /** Selector specifying which fields to include in a partial response. */
@@ -3240,18 +3493,22 @@ declare namespace gapi.client {
3240
3493
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3241
3494
  uploadType?: string;
3242
3495
  /** The level of information requested in response. */
3243
- view?: string;
3496
+ view?:
3497
+ | 'JOB_VIEW_UNKNOWN'
3498
+ | 'JOB_VIEW_SUMMARY'
3499
+ | 'JOB_VIEW_ALL'
3500
+ | 'JOB_VIEW_DESCRIPTION';
3244
3501
  /** Request body */
3245
3502
  resource: Job;
3246
3503
  }): Request<Job>;
3247
3504
  create(
3248
3505
  request: {
3249
3506
  /** V1 error format. */
3250
- '$.xgafv'?: string;
3507
+ '$.xgafv'?: '1' | '2';
3251
3508
  /** OAuth access token. */
3252
3509
  access_token?: string;
3253
3510
  /** Data format for response. */
3254
- alt?: string;
3511
+ alt?: 'json' | 'media' | 'proto';
3255
3512
  /** JSONP */
3256
3513
  callback?: string;
3257
3514
  /** Selector specifying which fields to include in a partial response. */
@@ -3275,18 +3532,22 @@ declare namespace gapi.client {
3275
3532
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3276
3533
  uploadType?: string;
3277
3534
  /** The level of information requested in response. */
3278
- view?: string;
3535
+ view?:
3536
+ | 'JOB_VIEW_UNKNOWN'
3537
+ | 'JOB_VIEW_SUMMARY'
3538
+ | 'JOB_VIEW_ALL'
3539
+ | 'JOB_VIEW_DESCRIPTION';
3279
3540
  },
3280
3541
  body: Job,
3281
3542
  ): Request<Job>;
3282
3543
  /** Gets the state of the specified Cloud Dataflow job. To get the state of a job, we recommend using `projects.locations.jobs.get` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.get` is not recommended, as you can only get the state of jobs that are running in `us-central1`. */
3283
3544
  get(request?: {
3284
3545
  /** V1 error format. */
3285
- '$.xgafv'?: string;
3546
+ '$.xgafv'?: '1' | '2';
3286
3547
  /** OAuth access token. */
3287
3548
  access_token?: string;
3288
3549
  /** Data format for response. */
3289
- alt?: string;
3550
+ alt?: 'json' | 'media' | 'proto';
3290
3551
  /** JSONP */
3291
3552
  callback?: string;
3292
3553
  /** Selector specifying which fields to include in a partial response. */
@@ -3310,16 +3571,20 @@ declare namespace gapi.client {
3310
3571
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3311
3572
  uploadType?: string;
3312
3573
  /** The level of information requested in response. */
3313
- view?: string;
3574
+ view?:
3575
+ | 'JOB_VIEW_UNKNOWN'
3576
+ | 'JOB_VIEW_SUMMARY'
3577
+ | 'JOB_VIEW_ALL'
3578
+ | 'JOB_VIEW_DESCRIPTION';
3314
3579
  }): Request<Job>;
3315
3580
  /** Request detailed information about the execution status of the job. EXPERIMENTAL. This API is subject to change or removal without notice. */
3316
3581
  getExecutionDetails(request?: {
3317
3582
  /** V1 error format. */
3318
- '$.xgafv'?: string;
3583
+ '$.xgafv'?: '1' | '2';
3319
3584
  /** OAuth access token. */
3320
3585
  access_token?: string;
3321
3586
  /** Data format for response. */
3322
- alt?: string;
3587
+ alt?: 'json' | 'media' | 'proto';
3323
3588
  /** JSONP */
3324
3589
  callback?: string;
3325
3590
  /** Selector specifying which fields to include in a partial response. */
@@ -3350,11 +3615,11 @@ declare namespace gapi.client {
3350
3615
  /** Request the job status. To request the status of a job, we recommend using `projects.locations.jobs.getMetrics` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.getMetrics` is not recommended, as you can only request the status of jobs that are running in `us-central1`. */
3351
3616
  getMetrics(request?: {
3352
3617
  /** V1 error format. */
3353
- '$.xgafv'?: string;
3618
+ '$.xgafv'?: '1' | '2';
3354
3619
  /** OAuth access token. */
3355
3620
  access_token?: string;
3356
3621
  /** Data format for response. */
3357
- alt?: string;
3622
+ alt?: 'json' | 'media' | 'proto';
3358
3623
  /** JSONP */
3359
3624
  callback?: string;
3360
3625
  /** Selector specifying which fields to include in a partial response. */
@@ -3383,17 +3648,17 @@ declare namespace gapi.client {
3383
3648
  /** List the jobs of a project. To list the jobs of a project in a region, we recommend using `projects.locations.jobs.list` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). To list the all jobs across all regions, use `projects.jobs.aggregated`. Using `projects.jobs.list` is not recommended, because you can only get the list of jobs that are running in `us-central1`. `projects.locations.jobs.list` and `projects.jobs.list` support filtering the list of jobs by name. Filtering by name isn't supported by `projects.jobs.aggregated`. */
3384
3649
  list(request?: {
3385
3650
  /** V1 error format. */
3386
- '$.xgafv'?: string;
3651
+ '$.xgafv'?: '1' | '2';
3387
3652
  /** OAuth access token. */
3388
3653
  access_token?: string;
3389
3654
  /** Data format for response. */
3390
- alt?: string;
3655
+ alt?: 'json' | 'media' | 'proto';
3391
3656
  /** JSONP */
3392
3657
  callback?: string;
3393
3658
  /** Selector specifying which fields to include in a partial response. */
3394
3659
  fields?: string;
3395
3660
  /** The kind of filter to use. */
3396
- filter?: string;
3661
+ filter?: 'UNKNOWN' | 'ALL' | 'TERMINATED' | 'ACTIVE';
3397
3662
  /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
3398
3663
  key?: string;
3399
3664
  /** The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job. */
@@ -3417,16 +3682,20 @@ declare namespace gapi.client {
3417
3682
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3418
3683
  uploadType?: string;
3419
3684
  /** Deprecated. ListJobs always returns summaries now. Use GetJob for other JobViews. */
3420
- view?: string;
3685
+ view?:
3686
+ | 'JOB_VIEW_UNKNOWN'
3687
+ | 'JOB_VIEW_SUMMARY'
3688
+ | 'JOB_VIEW_ALL'
3689
+ | 'JOB_VIEW_DESCRIPTION';
3421
3690
  }): Request<ListJobsResponse>;
3422
3691
  /** Snapshot the state of a streaming job. */
3423
3692
  snapshot(request: {
3424
3693
  /** V1 error format. */
3425
- '$.xgafv'?: string;
3694
+ '$.xgafv'?: '1' | '2';
3426
3695
  /** OAuth access token. */
3427
3696
  access_token?: string;
3428
3697
  /** Data format for response. */
3429
- alt?: string;
3698
+ alt?: 'json' | 'media' | 'proto';
3430
3699
  /** JSONP */
3431
3700
  callback?: string;
3432
3701
  /** Selector specifying which fields to include in a partial response. */
@@ -3455,11 +3724,11 @@ declare namespace gapi.client {
3455
3724
  snapshot(
3456
3725
  request: {
3457
3726
  /** V1 error format. */
3458
- '$.xgafv'?: string;
3727
+ '$.xgafv'?: '1' | '2';
3459
3728
  /** OAuth access token. */
3460
3729
  access_token?: string;
3461
3730
  /** Data format for response. */
3462
- alt?: string;
3731
+ alt?: 'json' | 'media' | 'proto';
3463
3732
  /** JSONP */
3464
3733
  callback?: string;
3465
3734
  /** Selector specifying which fields to include in a partial response. */
@@ -3488,11 +3757,11 @@ declare namespace gapi.client {
3488
3757
  /** Updates the state of an existing Cloud Dataflow job. To update the state of an existing job, we recommend using `projects.locations.jobs.update` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.update` is not recommended, as you can only update the state of jobs that are running in `us-central1`. */
3489
3758
  update(request: {
3490
3759
  /** V1 error format. */
3491
- '$.xgafv'?: string;
3760
+ '$.xgafv'?: '1' | '2';
3492
3761
  /** OAuth access token. */
3493
3762
  access_token?: string;
3494
3763
  /** Data format for response. */
3495
- alt?: string;
3764
+ alt?: 'json' | 'media' | 'proto';
3496
3765
  /** JSONP */
3497
3766
  callback?: string;
3498
3767
  /** Selector specifying which fields to include in a partial response. */
@@ -3523,11 +3792,11 @@ declare namespace gapi.client {
3523
3792
  update(
3524
3793
  request: {
3525
3794
  /** V1 error format. */
3526
- '$.xgafv'?: string;
3795
+ '$.xgafv'?: '1' | '2';
3527
3796
  /** OAuth access token. */
3528
3797
  access_token?: string;
3529
3798
  /** Data format for response. */
3530
- alt?: string;
3799
+ alt?: 'json' | 'media' | 'proto';
3531
3800
  /** JSONP */
3532
3801
  callback?: string;
3533
3802
  /** Selector specifying which fields to include in a partial response. */
@@ -3565,11 +3834,11 @@ declare namespace gapi.client {
3565
3834
  /** Deletes a snapshot. */
3566
3835
  delete(request?: {
3567
3836
  /** V1 error format. */
3568
- '$.xgafv'?: string;
3837
+ '$.xgafv'?: '1' | '2';
3569
3838
  /** OAuth access token. */
3570
3839
  access_token?: string;
3571
3840
  /** Data format for response. */
3572
- alt?: string;
3841
+ alt?: 'json' | 'media' | 'proto';
3573
3842
  /** JSONP */
3574
3843
  callback?: string;
3575
3844
  /** Selector specifying which fields to include in a partial response. */
@@ -3596,11 +3865,11 @@ declare namespace gapi.client {
3596
3865
  /** Gets information about a snapshot. */
3597
3866
  get(request?: {
3598
3867
  /** V1 error format. */
3599
- '$.xgafv'?: string;
3868
+ '$.xgafv'?: '1' | '2';
3600
3869
  /** OAuth access token. */
3601
3870
  access_token?: string;
3602
3871
  /** Data format for response. */
3603
- alt?: string;
3872
+ alt?: 'json' | 'media' | 'proto';
3604
3873
  /** JSONP */
3605
3874
  callback?: string;
3606
3875
  /** Selector specifying which fields to include in a partial response. */
@@ -3627,11 +3896,11 @@ declare namespace gapi.client {
3627
3896
  /** Lists snapshots. */
3628
3897
  list(request?: {
3629
3898
  /** V1 error format. */
3630
- '$.xgafv'?: string;
3899
+ '$.xgafv'?: '1' | '2';
3631
3900
  /** OAuth access token. */
3632
3901
  access_token?: string;
3633
3902
  /** Data format for response. */
3634
- alt?: string;
3903
+ alt?: 'json' | 'media' | 'proto';
3635
3904
  /** JSONP */
3636
3905
  callback?: string;
3637
3906
  /** Selector specifying which fields to include in a partial response. */
@@ -3660,11 +3929,11 @@ declare namespace gapi.client {
3660
3929
  /** Creates a Cloud Dataflow job from a template. Do not enter confidential information when you supply string values using the API. To create a job, we recommend using `projects.locations.templates.create` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.templates.create` is not recommended, because your job will always start in `us-central1`. */
3661
3930
  create(request: {
3662
3931
  /** V1 error format. */
3663
- '$.xgafv'?: string;
3932
+ '$.xgafv'?: '1' | '2';
3664
3933
  /** OAuth access token. */
3665
3934
  access_token?: string;
3666
3935
  /** Data format for response. */
3667
- alt?: string;
3936
+ alt?: 'json' | 'media' | 'proto';
3668
3937
  /** JSONP */
3669
3938
  callback?: string;
3670
3939
  /** Selector specifying which fields to include in a partial response. */
@@ -3691,11 +3960,11 @@ declare namespace gapi.client {
3691
3960
  create(
3692
3961
  request: {
3693
3962
  /** V1 error format. */
3694
- '$.xgafv'?: string;
3963
+ '$.xgafv'?: '1' | '2';
3695
3964
  /** OAuth access token. */
3696
3965
  access_token?: string;
3697
3966
  /** Data format for response. */
3698
- alt?: string;
3967
+ alt?: 'json' | 'media' | 'proto';
3699
3968
  /** JSONP */
3700
3969
  callback?: string;
3701
3970
  /** Selector specifying which fields to include in a partial response. */
@@ -3722,11 +3991,11 @@ declare namespace gapi.client {
3722
3991
  /** Get the template associated with a template. To get the template, we recommend using `projects.locations.templates.get` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.templates.get` is not recommended, because only templates that are running in `us-central1` are retrieved. */
3723
3992
  get(request?: {
3724
3993
  /** V1 error format. */
3725
- '$.xgafv'?: string;
3994
+ '$.xgafv'?: '1' | '2';
3726
3995
  /** OAuth access token. */
3727
3996
  access_token?: string;
3728
3997
  /** Data format for response. */
3729
- alt?: string;
3998
+ alt?: 'json' | 'media' | 'proto';
3730
3999
  /** JSONP */
3731
4000
  callback?: string;
3732
4001
  /** Selector specifying which fields to include in a partial response. */
@@ -3750,16 +4019,16 @@ declare namespace gapi.client {
3750
4019
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3751
4020
  uploadType?: string;
3752
4021
  /** The view to retrieve. Defaults to METADATA_ONLY. */
3753
- view?: string;
4022
+ view?: 'METADATA_ONLY';
3754
4023
  }): Request<GetTemplateResponse>;
3755
4024
  /** Launches a template. To launch a template, we recommend using `projects.locations.templates.launch` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.templates.launch` is not recommended, because jobs launched from the template will always start in `us-central1`. */
3756
4025
  launch(request: {
3757
4026
  /** V1 error format. */
3758
- '$.xgafv'?: string;
4027
+ '$.xgafv'?: '1' | '2';
3759
4028
  /** OAuth access token. */
3760
4029
  access_token?: string;
3761
4030
  /** Data format for response. */
3762
- alt?: string;
4031
+ alt?: 'json' | 'media' | 'proto';
3763
4032
  /** JSONP */
3764
4033
  callback?: string;
3765
4034
  /** Path to the dynamic template specification file on Cloud Storage. The file must be a JSON serialized `DynamicTemplateFileSpec` object. */
@@ -3794,11 +4063,11 @@ declare namespace gapi.client {
3794
4063
  launch(
3795
4064
  request: {
3796
4065
  /** V1 error format. */
3797
- '$.xgafv'?: string;
4066
+ '$.xgafv'?: '1' | '2';
3798
4067
  /** OAuth access token. */
3799
4068
  access_token?: string;
3800
4069
  /** Data format for response. */
3801
- alt?: string;
4070
+ alt?: 'json' | 'media' | 'proto';
3802
4071
  /** JSONP */
3803
4072
  callback?: string;
3804
4073
  /** Path to the dynamic template specification file on Cloud Storage. The file must be a JSON serialized `DynamicTemplateFileSpec` object. */
@@ -3835,11 +4104,11 @@ declare namespace gapi.client {
3835
4104
  /** Send a worker_message to the service. */
3836
4105
  workerMessages(request: {
3837
4106
  /** V1 error format. */
3838
- '$.xgafv'?: string;
4107
+ '$.xgafv'?: '1' | '2';
3839
4108
  /** OAuth access token. */
3840
4109
  access_token?: string;
3841
4110
  /** Data format for response. */
3842
- alt?: string;
4111
+ alt?: 'json' | 'media' | 'proto';
3843
4112
  /** JSONP */
3844
4113
  callback?: string;
3845
4114
  /** Selector specifying which fields to include in a partial response. */
@@ -3866,11 +4135,11 @@ declare namespace gapi.client {
3866
4135
  workerMessages(
3867
4136
  request: {
3868
4137
  /** V1 error format. */
3869
- '$.xgafv'?: string;
4138
+ '$.xgafv'?: '1' | '2';
3870
4139
  /** OAuth access token. */
3871
4140
  access_token?: string;
3872
4141
  /** Data format for response. */
3873
- alt?: string;
4142
+ alt?: 'json' | 'media' | 'proto';
3874
4143
  /** JSONP */
3875
4144
  callback?: string;
3876
4145
  /** Selector specifying which fields to include in a partial response. */
@@ -3903,11 +4172,11 @@ declare namespace gapi.client {
3903
4172
  /** Gets information about a snapshot. */
3904
4173
  get(request?: {
3905
4174
  /** V1 error format. */
3906
- '$.xgafv'?: string;
4175
+ '$.xgafv'?: '1' | '2';
3907
4176
  /** OAuth access token. */
3908
4177
  access_token?: string;
3909
4178
  /** Data format for response. */
3910
- alt?: string;
4179
+ alt?: 'json' | 'media' | 'proto';
3911
4180
  /** JSONP */
3912
4181
  callback?: string;
3913
4182
  /** Selector specifying which fields to include in a partial response. */
@@ -3934,11 +4203,11 @@ declare namespace gapi.client {
3934
4203
  /** Lists snapshots. */
3935
4204
  list(request?: {
3936
4205
  /** V1 error format. */
3937
- '$.xgafv'?: string;
4206
+ '$.xgafv'?: '1' | '2';
3938
4207
  /** OAuth access token. */
3939
4208
  access_token?: string;
3940
4209
  /** Data format for response. */
3941
- alt?: string;
4210
+ alt?: 'json' | 'media' | 'proto';
3942
4211
  /** JSONP */
3943
4212
  callback?: string;
3944
4213
  /** Selector specifying which fields to include in a partial response. */
@@ -3967,11 +4236,11 @@ declare namespace gapi.client {
3967
4236
  /** Creates a Cloud Dataflow job from a template. Do not enter confidential information when you supply string values using the API. To create a job, we recommend using `projects.locations.templates.create` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.templates.create` is not recommended, because your job will always start in `us-central1`. */
3968
4237
  create(request: {
3969
4238
  /** V1 error format. */
3970
- '$.xgafv'?: string;
4239
+ '$.xgafv'?: '1' | '2';
3971
4240
  /** OAuth access token. */
3972
4241
  access_token?: string;
3973
4242
  /** Data format for response. */
3974
- alt?: string;
4243
+ alt?: 'json' | 'media' | 'proto';
3975
4244
  /** JSONP */
3976
4245
  callback?: string;
3977
4246
  /** Selector specifying which fields to include in a partial response. */
@@ -3996,11 +4265,11 @@ declare namespace gapi.client {
3996
4265
  create(
3997
4266
  request: {
3998
4267
  /** V1 error format. */
3999
- '$.xgafv'?: string;
4268
+ '$.xgafv'?: '1' | '2';
4000
4269
  /** OAuth access token. */
4001
4270
  access_token?: string;
4002
4271
  /** Data format for response. */
4003
- alt?: string;
4272
+ alt?: 'json' | 'media' | 'proto';
4004
4273
  /** JSONP */
4005
4274
  callback?: string;
4006
4275
  /** Selector specifying which fields to include in a partial response. */
@@ -4025,11 +4294,11 @@ declare namespace gapi.client {
4025
4294
  /** Get the template associated with a template. To get the template, we recommend using `projects.locations.templates.get` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.templates.get` is not recommended, because only templates that are running in `us-central1` are retrieved. */
4026
4295
  get(request?: {
4027
4296
  /** V1 error format. */
4028
- '$.xgafv'?: string;
4297
+ '$.xgafv'?: '1' | '2';
4029
4298
  /** OAuth access token. */
4030
4299
  access_token?: string;
4031
4300
  /** Data format for response. */
4032
- alt?: string;
4301
+ alt?: 'json' | 'media' | 'proto';
4033
4302
  /** JSONP */
4034
4303
  callback?: string;
4035
4304
  /** Selector specifying which fields to include in a partial response. */
@@ -4053,16 +4322,16 @@ declare namespace gapi.client {
4053
4322
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
4054
4323
  uploadType?: string;
4055
4324
  /** The view to retrieve. Defaults to METADATA_ONLY. */
4056
- view?: string;
4325
+ view?: 'METADATA_ONLY';
4057
4326
  }): Request<GetTemplateResponse>;
4058
4327
  /** Launches a template. To launch a template, we recommend using `projects.locations.templates.launch` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.templates.launch` is not recommended, because jobs launched from the template will always start in `us-central1`. */
4059
4328
  launch(request: {
4060
4329
  /** V1 error format. */
4061
- '$.xgafv'?: string;
4330
+ '$.xgafv'?: '1' | '2';
4062
4331
  /** OAuth access token. */
4063
4332
  access_token?: string;
4064
4333
  /** Data format for response. */
4065
- alt?: string;
4334
+ alt?: 'json' | 'media' | 'proto';
4066
4335
  /** JSONP */
4067
4336
  callback?: string;
4068
4337
  /** Path to the dynamic template specification file on Cloud Storage. The file must be a JSON serialized `DynamicTemplateFileSpec` object. */
@@ -4097,11 +4366,11 @@ declare namespace gapi.client {
4097
4366
  launch(
4098
4367
  request: {
4099
4368
  /** V1 error format. */
4100
- '$.xgafv'?: string;
4369
+ '$.xgafv'?: '1' | '2';
4101
4370
  /** OAuth access token. */
4102
4371
  access_token?: string;
4103
4372
  /** Data format for response. */
4104
- alt?: string;
4373
+ alt?: 'json' | 'media' | 'proto';
4105
4374
  /** JSONP */
4106
4375
  callback?: string;
4107
4376
  /** Path to the dynamic template specification file on Cloud Storage. The file must be a JSON serialized `DynamicTemplateFileSpec` object. */
@@ -4138,11 +4407,11 @@ declare namespace gapi.client {
4138
4407
  /** Deletes a snapshot. */
4139
4408
  deleteSnapshots(request?: {
4140
4409
  /** V1 error format. */
4141
- '$.xgafv'?: string;
4410
+ '$.xgafv'?: '1' | '2';
4142
4411
  /** OAuth access token. */
4143
4412
  access_token?: string;
4144
4413
  /** Data format for response. */
4145
- alt?: string;
4414
+ alt?: 'json' | 'media' | 'proto';
4146
4415
  /** JSONP */
4147
4416
  callback?: string;
4148
4417
  /** Selector specifying which fields to include in a partial response. */
@@ -4169,11 +4438,11 @@ declare namespace gapi.client {
4169
4438
  /** Send a worker_message to the service. */
4170
4439
  workerMessages(request: {
4171
4440
  /** V1 error format. */
4172
- '$.xgafv'?: string;
4441
+ '$.xgafv'?: '1' | '2';
4173
4442
  /** OAuth access token. */
4174
4443
  access_token?: string;
4175
4444
  /** Data format for response. */
4176
- alt?: string;
4445
+ alt?: 'json' | 'media' | 'proto';
4177
4446
  /** JSONP */
4178
4447
  callback?: string;
4179
4448
  /** Selector specifying which fields to include in a partial response. */
@@ -4198,11 +4467,11 @@ declare namespace gapi.client {
4198
4467
  workerMessages(
4199
4468
  request: {
4200
4469
  /** V1 error format. */
4201
- '$.xgafv'?: string;
4470
+ '$.xgafv'?: '1' | '2';
4202
4471
  /** OAuth access token. */
4203
4472
  access_token?: string;
4204
4473
  /** Data format for response. */
4205
- alt?: string;
4474
+ alt?: 'json' | 'media' | 'proto';
4206
4475
  /** JSONP */
4207
4476
  callback?: string;
4208
4477
  /** Selector specifying which fields to include in a partial response. */