@maxim_mazurok/gapi.client.dataflow-v1b3 0.0.20231217 → 0.0.20240113
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.
- package/index.d.ts +76 -5
- 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:
|
|
12
|
+
// Revision: 20240113
|
|
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[];
|
|
@@ -450,6 +472,8 @@ declare namespace gapi.client {
|
|
|
450
472
|
serviceAccountEmail?: string;
|
|
451
473
|
/** The Cloud Storage path for staging local files. Must be a valid Cloud Storage URL, beginning with `gs://`. */
|
|
452
474
|
stagingLocation?: string;
|
|
475
|
+
/** 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. */
|
|
476
|
+
streamingMode?: string;
|
|
453
477
|
/** 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. */
|
|
454
478
|
subnetwork?: string;
|
|
455
479
|
/** The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with `gs://`. */
|
|
@@ -745,6 +769,14 @@ declare namespace gapi.client {
|
|
|
745
769
|
/** A list of the leased WorkItems. */
|
|
746
770
|
workItems?: WorkItem[];
|
|
747
771
|
}
|
|
772
|
+
interface Linear {
|
|
773
|
+
/** Must be greater than 0. */
|
|
774
|
+
numberOfBuckets?: number;
|
|
775
|
+
/** Lower bound of the first bucket. */
|
|
776
|
+
start?: number;
|
|
777
|
+
/** Distance between bucket boundaries. Must be greater than 0. */
|
|
778
|
+
width?: number;
|
|
779
|
+
}
|
|
748
780
|
interface ListJobMessagesResponse {
|
|
749
781
|
/** Autoscaling events in ascending timestamp order. */
|
|
750
782
|
autoscalingEvents?: AutoscalingEvent[];
|
|
@@ -825,6 +857,16 @@ declare namespace gapi.client {
|
|
|
825
857
|
/** Timestamp associated with the metric value. Optional when workers are reporting work progress; it will be filled in responses from the metrics API. */
|
|
826
858
|
updateTime?: string;
|
|
827
859
|
}
|
|
860
|
+
interface MetricValue {
|
|
861
|
+
/** Base name for this metric. */
|
|
862
|
+
metric?: string;
|
|
863
|
+
/** Optional. Set of metric labels for this metric. */
|
|
864
|
+
metricLabels?: {[P in string]: string};
|
|
865
|
+
/** Histogram value of this metric. */
|
|
866
|
+
valueHistogram?: DataflowHistogramValue;
|
|
867
|
+
/** Integer value of this metric. */
|
|
868
|
+
valueInt64?: string;
|
|
869
|
+
}
|
|
828
870
|
interface MountedDataDisk {
|
|
829
871
|
/** 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". */
|
|
830
872
|
dataDisk?: string;
|
|
@@ -839,6 +881,16 @@ declare namespace gapi.client {
|
|
|
839
881
|
/** Name of the counter. */
|
|
840
882
|
name?: string;
|
|
841
883
|
}
|
|
884
|
+
interface OutlierStats {
|
|
885
|
+
/** Number of values that are larger than the upper bound of the largest bucket. */
|
|
886
|
+
overflowCount?: string;
|
|
887
|
+
/** Mean of values in the overflow bucket. */
|
|
888
|
+
overflowMean?: number;
|
|
889
|
+
/** Number of values that are smaller than the lower bound of the smallest bucket. */
|
|
890
|
+
underflowCount?: string;
|
|
891
|
+
/** Mean of values in the undeflow bucket. */
|
|
892
|
+
underflowMean?: number;
|
|
893
|
+
}
|
|
842
894
|
interface Package {
|
|
843
895
|
/** The resource to read the package from. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket} bucket.storage.googleapis.com/ */
|
|
844
896
|
location?: string;
|
|
@@ -931,6 +983,18 @@ declare namespace gapi.client {
|
|
|
931
983
|
/** The value combining function to invoke. */
|
|
932
984
|
valueCombiningFn?: {[P in string]: any};
|
|
933
985
|
}
|
|
986
|
+
interface PerStepNamespaceMetrics {
|
|
987
|
+
/** The namespace of these metrics on the worker. */
|
|
988
|
+
metricsNamespace?: string;
|
|
989
|
+
/** Optional. Metrics that are recorded for this namespace and unfused step. */
|
|
990
|
+
metricValues?: MetricValue[];
|
|
991
|
+
/** The original system name of the unfused step that these metrics are reported from. */
|
|
992
|
+
originalStep?: string;
|
|
993
|
+
}
|
|
994
|
+
interface PerWorkerMetrics {
|
|
995
|
+
/** Optional. Metrics for a particular unfused step and namespace. */
|
|
996
|
+
perStepNamespaceMetrics?: PerStepNamespaceMetrics[];
|
|
997
|
+
}
|
|
934
998
|
interface PipelineDescription {
|
|
935
999
|
/** Pipeline level display data. */
|
|
936
1000
|
displayData?: DisplayData[];
|
|
@@ -1061,6 +1125,8 @@ declare namespace gapi.client {
|
|
|
1061
1125
|
numWorkers?: number;
|
|
1062
1126
|
/** Optional. The email address of the service account to run the job as. */
|
|
1063
1127
|
serviceAccountEmail?: string;
|
|
1128
|
+
/** 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. */
|
|
1129
|
+
streamingMode?: string;
|
|
1064
1130
|
/** 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. */
|
|
1065
1131
|
subnetwork?: string;
|
|
1066
1132
|
/** Required. The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with `gs://`. */
|
|
@@ -1440,17 +1506,20 @@ declare namespace gapi.client {
|
|
|
1440
1506
|
windmillServicePort?: string;
|
|
1441
1507
|
}
|
|
1442
1508
|
interface StreamingScalingReport {
|
|
1443
|
-
/** Current acive bundle count. */
|
|
1444
1509
|
activeBundleCount?: number;
|
|
1445
1510
|
/** Current acive thread count. */
|
|
1446
1511
|
activeThreadCount?: number;
|
|
1447
|
-
/** Maximum bundle count
|
|
1512
|
+
/** Maximum bundle count. */
|
|
1448
1513
|
maximumBundleCount?: number;
|
|
1449
|
-
/** Maximum bytes
|
|
1514
|
+
/** Maximum bytes. */
|
|
1515
|
+
maximumBytes?: string;
|
|
1450
1516
|
maximumBytesCount?: number;
|
|
1451
1517
|
/** Maximum thread count limit. */
|
|
1452
1518
|
maximumThreadCount?: number;
|
|
1453
|
-
/** Current outstanding
|
|
1519
|
+
/** Current outstanding bundle count. */
|
|
1520
|
+
outstandingBundleCount?: number;
|
|
1521
|
+
/** Current outstanding bytes. */
|
|
1522
|
+
outstandingBytes?: string;
|
|
1454
1523
|
outstandingBytesCount?: number;
|
|
1455
1524
|
}
|
|
1456
1525
|
interface StreamingSetupTask {
|
|
@@ -1622,6 +1691,8 @@ declare namespace gapi.client {
|
|
|
1622
1691
|
dataSamplingReport?: DataSamplingReport;
|
|
1623
1692
|
/** 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. */
|
|
1624
1693
|
labels?: {[P in string]: string};
|
|
1694
|
+
/** System defined metrics for this worker. */
|
|
1695
|
+
perWorkerMetrics?: PerWorkerMetrics;
|
|
1625
1696
|
/** Contains per-user worker telemetry used in streaming autoscaling. */
|
|
1626
1697
|
streamingScalingReport?: StreamingScalingReport;
|
|
1627
1698
|
/** The timestamp of the worker_message. */
|