@maxim_mazurok/gapi.client.dataflow-v1b3 0.0.20231210 → 0.0.20240107

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 (2) hide show
  1. package/index.d.ts +68 -2
  2. package/package.json +1 -1
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: 20231210
12
+ // Revision: 20240107
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -70,6 +70,12 @@ declare namespace gapi.client {
70
70
  /** The maximum number of workers to cap scaling at. */
71
71
  maxNumWorkers?: number;
72
72
  }
73
+ interface Base2Exponent {
74
+ /** Must be greater than 0. */
75
+ numberOfBuckets?: number;
76
+ /** Must be between -3 and 3. This forces the growth factor of the bucket boundaries to be between `2^(1/8)` and `256`. */
77
+ scale?: number;
78
+ }
73
79
  interface BigQueryIODetails {
74
80
  /** Dataset accessed in the connection. */
75
81
  dataset?: string;
@@ -88,6 +94,12 @@ declare namespace gapi.client {
88
94
  /** TableId accessed in the connection. */
89
95
  tableId?: string;
90
96
  }
97
+ interface BucketOptions {
98
+ /** Bucket boundaries grow exponentially. */
99
+ exponential?: Base2Exponent;
100
+ /** Bucket boundaries grow linearly. */
101
+ linear?: Linear;
102
+ }
91
103
  interface ComponentSource {
92
104
  /** Dataflow service generated name for this source. */
93
105
  name?: string;
@@ -240,6 +252,16 @@ declare namespace gapi.client {
240
252
  /** VM instance name the data disks mounted to, for example "myproject-1014-104817-4c2-harness-0". */
241
253
  vmInstance?: string;
242
254
  }
255
+ interface DataflowHistogramValue {
256
+ /** Optional. The number of values in each bucket of the histogram, as described in `bucket_options`. `bucket_counts` should contain N values, where N is the number of buckets specified in `bucket_options`. If `bucket_counts` has fewer than N values, the remaining values are assumed to be 0. */
257
+ bucketCounts?: string[];
258
+ /** Describes the bucket boundaries used in the histogram. */
259
+ bucketOptions?: BucketOptions;
260
+ /** Number of values recorded in this histogram. */
261
+ count?: string;
262
+ /** Statistics on the values recorded in the histogram that fall out of the bucket boundaries. */
263
+ outlierStats?: OutlierStats;
264
+ }
243
265
  interface DataSamplingConfig {
244
266
  /** 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. */
245
267
  behaviors?: string[];
@@ -356,11 +378,13 @@ declare namespace gapi.client {
356
378
  serviceOptions?: string[];
357
379
  /** Output only. The shuffle mode used for the job. */
358
380
  shuffleMode?: string;
381
+ /** 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. */
382
+ streamingMode?: string;
359
383
  /** 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} */
360
384
  tempStoragePrefix?: string;
361
385
  /** A description of the process that generated the request. */
362
386
  userAgent?: {[P in string]: any};
363
- /** Output only. Whether the job uses the new streaming engine billing model based on resource usage. */
387
+ /** Output only. Whether the job uses the Streaming Engine resource-based billing model. */
364
388
  useStreamingEngineResourceBasedBilling?: boolean;
365
389
  /** A structure describing which components and their versions of the service are required in order to run the job. */
366
390
  version?: {[P in string]: any};
@@ -743,6 +767,14 @@ declare namespace gapi.client {
743
767
  /** A list of the leased WorkItems. */
744
768
  workItems?: WorkItem[];
745
769
  }
770
+ interface Linear {
771
+ /** Must be greater than 0. */
772
+ numberOfBuckets?: number;
773
+ /** Lower bound of the first bucket. */
774
+ start?: number;
775
+ /** Distance between bucket boundaries. Must be greater than 0. */
776
+ width?: number;
777
+ }
746
778
  interface ListJobMessagesResponse {
747
779
  /** Autoscaling events in ascending timestamp order. */
748
780
  autoscalingEvents?: AutoscalingEvent[];
@@ -823,6 +855,16 @@ declare namespace gapi.client {
823
855
  /** Timestamp associated with the metric value. Optional when workers are reporting work progress; it will be filled in responses from the metrics API. */
824
856
  updateTime?: string;
825
857
  }
858
+ interface MetricValue {
859
+ /** Base name for this metric. */
860
+ metric?: string;
861
+ /** Optional. Set of metric labels for this metric. */
862
+ metricLabels?: {[P in string]: string};
863
+ /** Histogram value of this metric. */
864
+ valueHistogram?: DataflowHistogramValue;
865
+ /** Integer value of this metric. */
866
+ valueInt64?: string;
867
+ }
826
868
  interface MountedDataDisk {
827
869
  /** The name of the data disk. This name is local to the Google Cloud Platform project and uniquely identifies the disk within that project, for example "myproject-1014-104817-4c2-harness-0-disk-1". */
828
870
  dataDisk?: string;
@@ -837,6 +879,16 @@ declare namespace gapi.client {
837
879
  /** Name of the counter. */
838
880
  name?: string;
839
881
  }
882
+ interface OutlierStats {
883
+ /** Number of values that are larger than the upper bound of the largest bucket. */
884
+ overflowCount?: string;
885
+ /** Mean of values in the overflow bucket. */
886
+ overflowMean?: number;
887
+ /** Number of values that are smaller than the lower bound of the smallest bucket. */
888
+ underflowCount?: string;
889
+ /** Mean of values in the undeflow bucket. */
890
+ underflowMean?: number;
891
+ }
840
892
  interface Package {
841
893
  /** The resource to read the package from. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket} bucket.storage.googleapis.com/ */
842
894
  location?: string;
@@ -929,6 +981,18 @@ declare namespace gapi.client {
929
981
  /** The value combining function to invoke. */
930
982
  valueCombiningFn?: {[P in string]: any};
931
983
  }
984
+ interface PerStepNamespaceMetrics {
985
+ /** The namespace of these metrics on the worker. */
986
+ metricsNamespace?: string;
987
+ /** Optional. Metrics that are recorded for this namespace and unfused step. */
988
+ metricValues?: MetricValue[];
989
+ /** The original system name of the unfused step that these metrics are reported from. */
990
+ originalStep?: string;
991
+ }
992
+ interface PerWorkerMetrics {
993
+ /** Optional. Metrics for a particular unfused step and namespace. */
994
+ perStepNamespaceMetrics?: PerStepNamespaceMetrics[];
995
+ }
932
996
  interface PipelineDescription {
933
997
  /** Pipeline level display data. */
934
998
  displayData?: DisplayData[];
@@ -1620,6 +1684,8 @@ declare namespace gapi.client {
1620
1684
  dataSamplingReport?: DataSamplingReport;
1621
1685
  /** Labels are used to group WorkerMessages. For example, a worker_message about a particular container might have the labels: { "JOB_ID": "2015-04-22", "WORKER_ID": "wordcount-vm-2015…" "CONTAINER_TYPE": "worker", "CONTAINER_ID": "ac1234def"} Label tags typically correspond to Label enum values. However, for ease of development other strings can be used as tags. LABEL_UNSPECIFIED should not be used here. */
1622
1686
  labels?: {[P in string]: string};
1687
+ /** System defined metrics for this worker. */
1688
+ perWorkerMetrics?: PerWorkerMetrics;
1623
1689
  /** Contains per-user worker telemetry used in streaming autoscaling. */
1624
1690
  streamingScalingReport?: StreamingScalingReport;
1625
1691
  /** The timestamp of the worker_message. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.dataflow-v1b3",
3
- "version": "0.0.20231210",
3
+ "version": "0.0.20240107",
4
4
  "description": "TypeScript typings for Dataflow API v1b3",
5
5
  "repository": {
6
6
  "type": "git",