@maxim_mazurok/gapi.client.datapipelines-v1 0.1.20260302 → 0.2.20260307
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 +61 -32
- 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://datapipelines.googleapis.com/$discovery/rest?version=v1
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20260307
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -44,9 +44,15 @@ declare namespace gapi.client {
|
|
|
44
44
|
/** Whether to enable Streaming Engine for the job. */
|
|
45
45
|
enableStreamingEngine?: boolean;
|
|
46
46
|
/** Set FlexRS goal for the job. https://cloud.google.com/dataflow/docs/guides/flexrs */
|
|
47
|
-
flexrsGoal?:
|
|
47
|
+
flexrsGoal?:
|
|
48
|
+
| 'FLEXRS_UNSPECIFIED'
|
|
49
|
+
| 'FLEXRS_SPEED_OPTIMIZED'
|
|
50
|
+
| 'FLEXRS_COST_OPTIMIZED';
|
|
48
51
|
/** Configuration for VM IPs. */
|
|
49
|
-
ipConfiguration?:
|
|
52
|
+
ipConfiguration?:
|
|
53
|
+
| 'WORKER_IP_UNSPECIFIED'
|
|
54
|
+
| 'WORKER_IP_PUBLIC'
|
|
55
|
+
| 'WORKER_IP_PRIVATE';
|
|
50
56
|
/** Name for the Cloud KMS key for the job. Key format is: projects//locations//keyRings//cryptoKeys/ */
|
|
51
57
|
kmsKeyName?: string;
|
|
52
58
|
/** The machine type to use for the job. Defaults to the value from the template if not specified. */
|
|
@@ -82,7 +88,13 @@ declare namespace gapi.client {
|
|
|
82
88
|
/** Required. The fully qualified resource name for the job. */
|
|
83
89
|
name?: string;
|
|
84
90
|
/** The current state of the job. */
|
|
85
|
-
state?:
|
|
91
|
+
state?:
|
|
92
|
+
| 'STATE_UNSPECIFIED'
|
|
93
|
+
| 'STATE_PENDING'
|
|
94
|
+
| 'STATE_RUNNING'
|
|
95
|
+
| 'STATE_DONE'
|
|
96
|
+
| 'STATE_FAILED'
|
|
97
|
+
| 'STATE_CANCELLED';
|
|
86
98
|
/** Status capturing any error code or message related to job creation or execution. */
|
|
87
99
|
status?: GoogleRpcStatus;
|
|
88
100
|
}
|
|
@@ -166,9 +178,18 @@ declare namespace gapi.client {
|
|
|
166
178
|
/** Optional. A service account email to be used with the Cloud Scheduler job. If not specified, the default compute engine service account will be used. */
|
|
167
179
|
schedulerServiceAccountEmail?: string;
|
|
168
180
|
/** Required. The state of the pipeline. When the pipeline is created, the state is set to 'PIPELINE_STATE_ACTIVE' by default. State changes can be requested by setting the state to stopping, paused, or resuming. State cannot be changed through UpdatePipeline requests. */
|
|
169
|
-
state?:
|
|
181
|
+
state?:
|
|
182
|
+
| 'STATE_UNSPECIFIED'
|
|
183
|
+
| 'STATE_RESUMING'
|
|
184
|
+
| 'STATE_ACTIVE'
|
|
185
|
+
| 'STATE_STOPPING'
|
|
186
|
+
| 'STATE_ARCHIVED'
|
|
187
|
+
| 'STATE_PAUSED';
|
|
170
188
|
/** Required. The type of the pipeline. This field affects the scheduling of the pipeline and the type of metrics to show for the pipeline. */
|
|
171
|
-
type?:
|
|
189
|
+
type?:
|
|
190
|
+
| 'PIPELINE_TYPE_UNSPECIFIED'
|
|
191
|
+
| 'PIPELINE_TYPE_BATCH'
|
|
192
|
+
| 'PIPELINE_TYPE_STREAMING';
|
|
172
193
|
/** Workload information for creating new jobs. */
|
|
173
194
|
workload?: GoogleCloudDatapipelinesV1Workload;
|
|
174
195
|
}
|
|
@@ -187,7 +208,10 @@ declare namespace gapi.client {
|
|
|
187
208
|
/** Whether to enable Streaming Engine for the job. */
|
|
188
209
|
enableStreamingEngine?: boolean;
|
|
189
210
|
/** Configuration for VM IPs. */
|
|
190
|
-
ipConfiguration?:
|
|
211
|
+
ipConfiguration?:
|
|
212
|
+
| 'WORKER_IP_UNSPECIFIED'
|
|
213
|
+
| 'WORKER_IP_PUBLIC'
|
|
214
|
+
| 'WORKER_IP_PRIVATE';
|
|
191
215
|
/** Name for the Cloud KMS key for the job. The key format is: projects//locations//keyRings//cryptoKeys/ */
|
|
192
216
|
kmsKeyName?: string;
|
|
193
217
|
/** The machine type to use for the job. Defaults to the value from the template if not specified. */
|
|
@@ -221,7 +245,12 @@ declare namespace gapi.client {
|
|
|
221
245
|
}
|
|
222
246
|
interface GoogleCloudDatapipelinesV1SdkVersion {
|
|
223
247
|
/** The support status for this SDK version. */
|
|
224
|
-
sdkSupportStatus?:
|
|
248
|
+
sdkSupportStatus?:
|
|
249
|
+
| 'UNKNOWN'
|
|
250
|
+
| 'SUPPORTED'
|
|
251
|
+
| 'STALE'
|
|
252
|
+
| 'DEPRECATED'
|
|
253
|
+
| 'UNSUPPORTED';
|
|
225
254
|
/** The version of the SDK used to run the job. */
|
|
226
255
|
version?: string;
|
|
227
256
|
/** A readable string describing the version of the SDK. */
|
|
@@ -247,11 +276,11 @@ declare namespace gapi.client {
|
|
|
247
276
|
/** Lists jobs for a given pipeline. Throws a "FORBIDDEN" error if the caller doesn't have permission to access it. */
|
|
248
277
|
list(request?: {
|
|
249
278
|
/** V1 error format. */
|
|
250
|
-
'$.xgafv'?:
|
|
279
|
+
'$.xgafv'?: '1' | '2';
|
|
251
280
|
/** OAuth access token. */
|
|
252
281
|
access_token?: string;
|
|
253
282
|
/** Data format for response. */
|
|
254
|
-
alt?:
|
|
283
|
+
alt?: 'json' | 'media' | 'proto';
|
|
255
284
|
/** JSONP */
|
|
256
285
|
callback?: string;
|
|
257
286
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -280,11 +309,11 @@ declare namespace gapi.client {
|
|
|
280
309
|
/** Creates a pipeline. For a batch pipeline, you can pass scheduler information. Data Pipelines uses the scheduler information to create an internal scheduler that runs jobs periodically. If the internal scheduler is not configured, you can use RunPipeline to run jobs. */
|
|
281
310
|
create(request: {
|
|
282
311
|
/** V1 error format. */
|
|
283
|
-
'$.xgafv'?:
|
|
312
|
+
'$.xgafv'?: '1' | '2';
|
|
284
313
|
/** OAuth access token. */
|
|
285
314
|
access_token?: string;
|
|
286
315
|
/** Data format for response. */
|
|
287
|
-
alt?:
|
|
316
|
+
alt?: 'json' | 'media' | 'proto';
|
|
288
317
|
/** JSONP */
|
|
289
318
|
callback?: string;
|
|
290
319
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -309,11 +338,11 @@ declare namespace gapi.client {
|
|
|
309
338
|
create(
|
|
310
339
|
request: {
|
|
311
340
|
/** V1 error format. */
|
|
312
|
-
'$.xgafv'?:
|
|
341
|
+
'$.xgafv'?: '1' | '2';
|
|
313
342
|
/** OAuth access token. */
|
|
314
343
|
access_token?: string;
|
|
315
344
|
/** Data format for response. */
|
|
316
|
-
alt?:
|
|
345
|
+
alt?: 'json' | 'media' | 'proto';
|
|
317
346
|
/** JSONP */
|
|
318
347
|
callback?: string;
|
|
319
348
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -338,11 +367,11 @@ declare namespace gapi.client {
|
|
|
338
367
|
/** Deletes a pipeline. If a scheduler job is attached to the pipeline, it will be deleted. */
|
|
339
368
|
delete(request?: {
|
|
340
369
|
/** V1 error format. */
|
|
341
|
-
'$.xgafv'?:
|
|
370
|
+
'$.xgafv'?: '1' | '2';
|
|
342
371
|
/** OAuth access token. */
|
|
343
372
|
access_token?: string;
|
|
344
373
|
/** Data format for response. */
|
|
345
|
-
alt?:
|
|
374
|
+
alt?: 'json' | 'media' | 'proto';
|
|
346
375
|
/** JSONP */
|
|
347
376
|
callback?: string;
|
|
348
377
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -365,11 +394,11 @@ declare namespace gapi.client {
|
|
|
365
394
|
/** Looks up a single pipeline. Returns a "NOT_FOUND" error if no such pipeline exists. Returns a "FORBIDDEN" error if the caller doesn't have permission to access it. */
|
|
366
395
|
get(request?: {
|
|
367
396
|
/** V1 error format. */
|
|
368
|
-
'$.xgafv'?:
|
|
397
|
+
'$.xgafv'?: '1' | '2';
|
|
369
398
|
/** OAuth access token. */
|
|
370
399
|
access_token?: string;
|
|
371
400
|
/** Data format for response. */
|
|
372
|
-
alt?:
|
|
401
|
+
alt?: 'json' | 'media' | 'proto';
|
|
373
402
|
/** JSONP */
|
|
374
403
|
callback?: string;
|
|
375
404
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -392,11 +421,11 @@ declare namespace gapi.client {
|
|
|
392
421
|
/** Lists pipelines. Returns a "FORBIDDEN" error if the caller doesn't have permission to access it. */
|
|
393
422
|
list(request?: {
|
|
394
423
|
/** V1 error format. */
|
|
395
|
-
'$.xgafv'?:
|
|
424
|
+
'$.xgafv'?: '1' | '2';
|
|
396
425
|
/** OAuth access token. */
|
|
397
426
|
access_token?: string;
|
|
398
427
|
/** Data format for response. */
|
|
399
|
-
alt?:
|
|
428
|
+
alt?: 'json' | 'media' | 'proto';
|
|
400
429
|
/** JSONP */
|
|
401
430
|
callback?: string;
|
|
402
431
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -425,11 +454,11 @@ declare namespace gapi.client {
|
|
|
425
454
|
/** Updates a pipeline. If successful, the updated Pipeline is returned. Returns `NOT_FOUND` if the pipeline doesn't exist. If UpdatePipeline does not return successfully, you can retry the UpdatePipeline request until you receive a successful response. */
|
|
426
455
|
patch(request: {
|
|
427
456
|
/** V1 error format. */
|
|
428
|
-
'$.xgafv'?:
|
|
457
|
+
'$.xgafv'?: '1' | '2';
|
|
429
458
|
/** OAuth access token. */
|
|
430
459
|
access_token?: string;
|
|
431
460
|
/** Data format for response. */
|
|
432
|
-
alt?:
|
|
461
|
+
alt?: 'json' | 'media' | 'proto';
|
|
433
462
|
/** JSONP */
|
|
434
463
|
callback?: string;
|
|
435
464
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -456,11 +485,11 @@ declare namespace gapi.client {
|
|
|
456
485
|
patch(
|
|
457
486
|
request: {
|
|
458
487
|
/** V1 error format. */
|
|
459
|
-
'$.xgafv'?:
|
|
488
|
+
'$.xgafv'?: '1' | '2';
|
|
460
489
|
/** OAuth access token. */
|
|
461
490
|
access_token?: string;
|
|
462
491
|
/** Data format for response. */
|
|
463
|
-
alt?:
|
|
492
|
+
alt?: 'json' | 'media' | 'proto';
|
|
464
493
|
/** JSONP */
|
|
465
494
|
callback?: string;
|
|
466
495
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -487,11 +516,11 @@ declare namespace gapi.client {
|
|
|
487
516
|
/** Creates a job for the specified pipeline directly. You can use this method when the internal scheduler is not configured and you want to trigger the job directly or through an external system. Returns a "NOT_FOUND" error if the pipeline doesn't exist. Returns a "FORBIDDEN" error if the user doesn't have permission to access the pipeline or run jobs for the pipeline. */
|
|
488
517
|
run(request: {
|
|
489
518
|
/** V1 error format. */
|
|
490
|
-
'$.xgafv'?:
|
|
519
|
+
'$.xgafv'?: '1' | '2';
|
|
491
520
|
/** OAuth access token. */
|
|
492
521
|
access_token?: string;
|
|
493
522
|
/** Data format for response. */
|
|
494
|
-
alt?:
|
|
523
|
+
alt?: 'json' | 'media' | 'proto';
|
|
495
524
|
/** JSONP */
|
|
496
525
|
callback?: string;
|
|
497
526
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -516,11 +545,11 @@ declare namespace gapi.client {
|
|
|
516
545
|
run(
|
|
517
546
|
request: {
|
|
518
547
|
/** V1 error format. */
|
|
519
|
-
'$.xgafv'?:
|
|
548
|
+
'$.xgafv'?: '1' | '2';
|
|
520
549
|
/** OAuth access token. */
|
|
521
550
|
access_token?: string;
|
|
522
551
|
/** Data format for response. */
|
|
523
|
-
alt?:
|
|
552
|
+
alt?: 'json' | 'media' | 'proto';
|
|
524
553
|
/** JSONP */
|
|
525
554
|
callback?: string;
|
|
526
555
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -545,11 +574,11 @@ declare namespace gapi.client {
|
|
|
545
574
|
/** Freezes pipeline execution permanently. If there's a corresponding scheduler entry, it's deleted, and the pipeline state is changed to "ARCHIVED". However, pipeline metadata is retained. */
|
|
546
575
|
stop(request: {
|
|
547
576
|
/** V1 error format. */
|
|
548
|
-
'$.xgafv'?:
|
|
577
|
+
'$.xgafv'?: '1' | '2';
|
|
549
578
|
/** OAuth access token. */
|
|
550
579
|
access_token?: string;
|
|
551
580
|
/** Data format for response. */
|
|
552
|
-
alt?:
|
|
581
|
+
alt?: 'json' | 'media' | 'proto';
|
|
553
582
|
/** JSONP */
|
|
554
583
|
callback?: string;
|
|
555
584
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -574,11 +603,11 @@ declare namespace gapi.client {
|
|
|
574
603
|
stop(
|
|
575
604
|
request: {
|
|
576
605
|
/** V1 error format. */
|
|
577
|
-
'$.xgafv'?:
|
|
606
|
+
'$.xgafv'?: '1' | '2';
|
|
578
607
|
/** OAuth access token. */
|
|
579
608
|
access_token?: string;
|
|
580
609
|
/** Data format for response. */
|
|
581
|
-
alt?:
|
|
610
|
+
alt?: 'json' | 'media' | 'proto';
|
|
582
611
|
/** JSONP */
|
|
583
612
|
callback?: string;
|
|
584
613
|
/** Selector specifying which fields to include in a partial response. */
|