@maxim_mazurok/gapi.client.datapipelines-v1 0.0.20220730

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 (6) hide show
  1. package/index.d.ts +702 -0
  2. package/package.json +20 -0
  3. package/readme.md +68 -0
  4. package/tests.ts +281 -0
  5. package/tsconfig.json +18 -0
  6. package/tslint.json +6 -0
package/index.d.ts ADDED
@@ -0,0 +1,702 @@
1
+ /* Type definitions for non-npm package Data pipelines API v1 0.0 */
2
+ // Project: https://cloud.google.com/dataflow/docs/guides/data-pipelines
3
+ // Definitions by: Maxim Mazurok <https://github.com/Maxim-Mazurok>
4
+ // Nick Amoscato <https://github.com/namoscato>
5
+ // Declan Vong <https://github.com/declanvong>
6
+ // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
7
+ // TypeScript Version: 2.8
8
+
9
+ // IMPORTANT
10
+ // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
11
+ // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
12
+ // Generated from: https://datapipelines.googleapis.com/$discovery/rest?version=v1
13
+ // Revision: 20220730
14
+
15
+ /// <reference types="gapi.client" />
16
+
17
+ declare namespace gapi.client {
18
+ /** Load Data pipelines API v1 */
19
+ function load(urlOrObject: "https://datapipelines.googleapis.com/$discovery/rest?version=v1"): Promise<void>;
20
+ /** @deprecated Please load APIs with discovery documents. */
21
+ function load(name: "datapipelines", version: "v1"): Promise<void>;
22
+ /** @deprecated Please load APIs with discovery documents. */
23
+ function load(name: "datapipelines", version: "v1", callback: () => any): void;
24
+
25
+ namespace datapipelines {
26
+ interface GoogleCloudDatapipelinesV1DataflowJobDetails {
27
+ /** Output only. The current number of workers used to run the jobs. Only set to a value if the job is still running. */
28
+ currentWorkers?: number;
29
+ /**
30
+ * Cached version of all the metrics of interest for the job. This value gets stored here when the job is terminated. As long as the job is running, this field is populated from the
31
+ * Dataflow API.
32
+ */
33
+ resourceInfo?: { [P in string]: number };
34
+ /** Output only. The SDK version used to run the job. */
35
+ sdkVersion?: GoogleCloudDatapipelinesV1SdkVersion;
36
+ }
37
+ interface GoogleCloudDatapipelinesV1FlexTemplateRuntimeEnvironment {
38
+ /** Additional experiment flags for the job. */
39
+ additionalExperiments?: string[];
40
+ /**
41
+ * Additional user labels to be specified for the job. Keys and values must follow the restrictions specified in the [labeling
42
+ * restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions). An object containing a list of key/value pairs. Example: `{ "name": "wrench", "mass": "1kg",
43
+ * "count": "3" }`.
44
+ */
45
+ additionalUserLabels?: { [P in string]: string };
46
+ /** Whether to enable Streaming Engine for the job. */
47
+ enableStreamingEngine?: boolean;
48
+ /** Set FlexRS goal for the job. https://cloud.google.com/dataflow/docs/guides/flexrs */
49
+ flexrsGoal?: string;
50
+ /** Configuration for VM IPs. */
51
+ ipConfiguration?: string;
52
+ /** Name for the Cloud KMS key for the job. Key format is: projects//locations//keyRings//cryptoKeys/ */
53
+ kmsKeyName?: string;
54
+ /** The machine type to use for the job. Defaults to the value from the template if not specified. */
55
+ machineType?: string;
56
+ /** The maximum number of Compute Engine instances to be made available to your pipeline during execution, from 1 to 1000. */
57
+ maxWorkers?: number;
58
+ /** Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default". */
59
+ network?: string;
60
+ /** The initial number of Compute Engine instances for the job. */
61
+ numWorkers?: number;
62
+ /** The email address of the service account to run the job as. */
63
+ serviceAccountEmail?: string;
64
+ /**
65
+ * 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
66
+ * "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
67
+ * Shared VPC network, you must use the complete URL.
68
+ */
69
+ subnetwork?: string;
70
+ /** The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with `gs://`. */
71
+ tempLocation?: string;
72
+ /**
73
+ * The Compute Engine region (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. "us-west1". Mutually exclusive with
74
+ * worker_zone. If neither worker_region nor worker_zone is specified, defaults to the control plane region.
75
+ */
76
+ workerRegion?: string;
77
+ /**
78
+ * The Compute Engine zone (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. "us-west1-a". Mutually exclusive with
79
+ * worker_region. If neither worker_region nor worker_zone is specified, a zone in the control plane region is chosen based on available capacity. If both `worker_zone` and `zone` are
80
+ * set, `worker_zone` takes precedence.
81
+ */
82
+ workerZone?: string;
83
+ /**
84
+ * The Compute Engine [availability zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones) for launching worker instances to run your pipeline. In the future,
85
+ * worker_zone will take precedence.
86
+ */
87
+ zone?: string;
88
+ }
89
+ interface GoogleCloudDatapipelinesV1Job {
90
+ /** Output only. The time of job creation. */
91
+ createTime?: string;
92
+ /** All the details that are specific to a Dataflow job. */
93
+ dataflowJobDetails?: GoogleCloudDatapipelinesV1DataflowJobDetails;
94
+ /** Output only. The time of job termination. This is absent if the job is still running. */
95
+ endTime?: string;
96
+ /** Output only. The internal ID for the job. */
97
+ id?: string;
98
+ /** Required. The fully qualified resource name for the job. */
99
+ name?: string;
100
+ /** The current state of the job. */
101
+ state?: string;
102
+ /** Status capturing any error code or message related to job creation or execution. */
103
+ status?: GoogleRpcStatus;
104
+ }
105
+ interface GoogleCloudDatapipelinesV1LaunchFlexTemplateParameter {
106
+ /** Cloud Storage path to a file with a JSON-serialized ContainerSpec as content. */
107
+ containerSpecGcsPath?: string;
108
+ /** The runtime environment for the Flex Template job. */
109
+ environment?: GoogleCloudDatapipelinesV1FlexTemplateRuntimeEnvironment;
110
+ /** Required. The job name to use for the created job. For an update job request, the job name should be the same as the existing running job. */
111
+ jobName?: string;
112
+ /** Launch options for this Flex Template job. This is a common set of options across languages and templates. This should not be used to pass job parameters. */
113
+ launchOptions?: { [P in string]: string };
114
+ /** The parameters for the Flex Template. Example: `{"num_workers":"5"}` */
115
+ parameters?: { [P in string]: string };
116
+ /** Use this to pass transform name mappings for streaming update jobs. Example: `{"oldTransformName":"newTransformName",...}` */
117
+ transformNameMappings?: { [P in string]: string };
118
+ /** Set this to true if you are sending a request to update a running streaming job. When set, the job name should be the same as the running job. */
119
+ update?: boolean;
120
+ }
121
+ interface GoogleCloudDatapipelinesV1LaunchFlexTemplateRequest {
122
+ /** Required. Parameter to launch a job from a Flex Template. */
123
+ launchParameter?: GoogleCloudDatapipelinesV1LaunchFlexTemplateParameter;
124
+ /** Required. The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to which to direct the request. For example, `us-central1`, `us-west1`. */
125
+ location?: string;
126
+ /** Required. The ID of the Cloud Platform project that the job belongs to. */
127
+ projectId?: string;
128
+ /** If true, the request is validated but not actually executed. Defaults to false. */
129
+ validateOnly?: boolean;
130
+ }
131
+ interface GoogleCloudDatapipelinesV1LaunchTemplateParameters {
132
+ /** The runtime environment for the job. */
133
+ environment?: GoogleCloudDatapipelinesV1RuntimeEnvironment;
134
+ /** Required. The job name to use for the created job. */
135
+ jobName?: string;
136
+ /** The runtime parameters to pass to the job. */
137
+ parameters?: { [P in string]: string };
138
+ /** Map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job. Only applicable when updating a pipeline. */
139
+ transformNameMapping?: { [P in string]: string };
140
+ /** If set, replace the existing pipeline with the name specified by jobName with this pipeline, preserving state. */
141
+ update?: boolean;
142
+ }
143
+ interface GoogleCloudDatapipelinesV1LaunchTemplateRequest {
144
+ /** A Cloud Storage path to the template from which to create the job. Must be a valid Cloud Storage URL, beginning with 'gs://'. */
145
+ gcsPath?: string;
146
+ /** The parameters of the template to launch. This should be part of the body of the POST request. */
147
+ launchParameters?: GoogleCloudDatapipelinesV1LaunchTemplateParameters;
148
+ /** The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to which to direct the request. */
149
+ location?: string;
150
+ /** Required. The ID of the Cloud Platform project that the job belongs to. */
151
+ projectId?: string;
152
+ /** If true, the request is validated but not actually executed. Defaults to false. */
153
+ validateOnly?: boolean;
154
+ }
155
+ interface GoogleCloudDatapipelinesV1ListJobsResponse {
156
+ /** Results that were accessible to the caller. Results are always in descending order of job creation date. */
157
+ jobs?: GoogleCloudDatapipelinesV1Job[];
158
+ /** A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
159
+ nextPageToken?: string;
160
+ }
161
+ interface GoogleCloudDatapipelinesV1ListPipelinesResponse {
162
+ /** A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
163
+ nextPageToken?: string;
164
+ /** Results that matched the filter criteria and were accessible to the caller. Results are always in descending order of pipeline creation date. */
165
+ pipelines?: GoogleCloudDatapipelinesV1Pipeline[];
166
+ }
167
+ interface GoogleCloudDatapipelinesV1Pipeline {
168
+ /** Output only. Immutable. The timestamp when the pipeline was initially created. Set by the Data Pipelines service. */
169
+ createTime?: string;
170
+ /** Required. The display name of the pipeline. It can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), and underscores (_). */
171
+ displayName?: string;
172
+ /** Output only. Number of jobs. */
173
+ jobCount?: number;
174
+ /** Output only. Immutable. The timestamp when the pipeline was last modified. Set by the Data Pipelines service. */
175
+ lastUpdateTime?: string;
176
+ /**
177
+ * The pipeline name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-),
178
+ * colons (:), and periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects). *
179
+ * `LOCATION_ID` is the canonical ID for the pipeline's location. The list of available locations can be obtained by calling `google.cloud.location.Locations.ListLocations`. Note that
180
+ * the Data Pipelines service is not available in all regions. It depends on Cloud Scheduler, an App Engine application, so it's only available in [App Engine
181
+ * regions](https://cloud.google.com/about/locations#region). * `PIPELINE_ID` is the ID of the pipeline. Must be unique for the selected project and location.
182
+ */
183
+ name?: string;
184
+ /** Immutable. The sources of the pipeline (for example, Dataplex). The keys and values are set by the corresponding sources during pipeline creation. */
185
+ pipelineSources?: { [P in string]: string };
186
+ /**
187
+ * Internal scheduling information for a pipeline. If this information is provided, periodic jobs will be created per the schedule. If not, users are responsible for creating jobs
188
+ * externally.
189
+ */
190
+ scheduleInfo?: GoogleCloudDatapipelinesV1ScheduleSpec;
191
+ /** 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. */
192
+ schedulerServiceAccountEmail?: string;
193
+ /**
194
+ * 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
195
+ * stopping, paused, or resuming. State cannot be changed through UpdatePipeline requests.
196
+ */
197
+ state?: string;
198
+ /** Required. The type of the pipeline. This field affects the scheduling of the pipeline and the type of metrics to show for the pipeline. */
199
+ type?: string;
200
+ /** Workload information for creating new jobs. */
201
+ workload?: GoogleCloudDatapipelinesV1Workload;
202
+ }
203
+ // tslint:disable-next-line:no-empty-interface
204
+ interface GoogleCloudDatapipelinesV1RunPipelineRequest {
205
+ }
206
+ interface GoogleCloudDatapipelinesV1RunPipelineResponse {
207
+ /** Job that was created as part of RunPipeline operation. */
208
+ job?: GoogleCloudDatapipelinesV1Job;
209
+ }
210
+ interface GoogleCloudDatapipelinesV1RuntimeEnvironment {
211
+ /** Additional experiment flags for the job. */
212
+ additionalExperiments?: string[];
213
+ /**
214
+ * Additional user labels to be specified for the job. Keys and values should follow the restrictions specified in the [labeling
215
+ * restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions) page. An object containing a list of key/value pairs. Example: { "name": "wrench", "mass":
216
+ * "1kg", "count": "3" }.
217
+ */
218
+ additionalUserLabels?: { [P in string]: string };
219
+ /** Whether to bypass the safety checks for the job's temporary directory. Use with caution. */
220
+ bypassTempDirValidation?: boolean;
221
+ /** Whether to enable Streaming Engine for the job. */
222
+ enableStreamingEngine?: boolean;
223
+ /** Configuration for VM IPs. */
224
+ ipConfiguration?: string;
225
+ /** Name for the Cloud KMS key for the job. The key format is: projects//locations//keyRings//cryptoKeys/ */
226
+ kmsKeyName?: string;
227
+ /** The machine type to use for the job. Defaults to the value from the template if not specified. */
228
+ machineType?: string;
229
+ /** The maximum number of Compute Engine instances to be made available to your pipeline during execution, from 1 to 1000. */
230
+ maxWorkers?: number;
231
+ /** Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default". */
232
+ network?: string;
233
+ /** The initial number of Compute Engine instances for the job. */
234
+ numWorkers?: number;
235
+ /** The email address of the service account to run the job as. */
236
+ serviceAccountEmail?: string;
237
+ /**
238
+ * 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
239
+ * "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
240
+ * Shared VPC network, you must use the complete URL.
241
+ */
242
+ subnetwork?: string;
243
+ /** The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with `gs://`. */
244
+ tempLocation?: string;
245
+ /**
246
+ * The Compute Engine region (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. "us-west1". Mutually exclusive with
247
+ * worker_zone. If neither worker_region nor worker_zone is specified, default to the control plane's region.
248
+ */
249
+ workerRegion?: string;
250
+ /**
251
+ * The Compute Engine zone (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. "us-west1-a". Mutually exclusive with
252
+ * worker_region. If neither worker_region nor worker_zone is specified, a zone in the control plane's region is chosen based on available capacity. If both `worker_zone` and `zone`
253
+ * are set, `worker_zone` takes precedence.
254
+ */
255
+ workerZone?: string;
256
+ /**
257
+ * The Compute Engine [availability zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones) for launching worker instances to run your pipeline. In the future,
258
+ * worker_zone will take precedence.
259
+ */
260
+ zone?: string;
261
+ }
262
+ interface GoogleCloudDatapipelinesV1ScheduleSpec {
263
+ /** Output only. When the next Scheduler job is going to run. */
264
+ nextJobTime?: string;
265
+ /** Unix-cron format of the schedule. This information is retrieved from the linked Cloud Scheduler. */
266
+ schedule?: string;
267
+ /** Timezone ID. This matches the timezone IDs used by the Cloud Scheduler API. If empty, UTC time is assumed. */
268
+ timeZone?: string;
269
+ }
270
+ interface GoogleCloudDatapipelinesV1SdkVersion {
271
+ /** The support status for this SDK version. */
272
+ sdkSupportStatus?: string;
273
+ /** The version of the SDK used to run the job. */
274
+ version?: string;
275
+ /** A readable string describing the version of the SDK. */
276
+ versionDisplayName?: string;
277
+ }
278
+ // tslint:disable-next-line:no-empty-interface
279
+ interface GoogleCloudDatapipelinesV1StopPipelineRequest {
280
+ }
281
+ interface GoogleCloudDatapipelinesV1Workload {
282
+ /** Template information and additional parameters needed to launch a Dataflow job using the flex launch API. */
283
+ dataflowFlexTemplateRequest?: GoogleCloudDatapipelinesV1LaunchFlexTemplateRequest;
284
+ /** Template information and additional parameters needed to launch a Dataflow job using the standard launch API. */
285
+ dataflowLaunchTemplateRequest?: GoogleCloudDatapipelinesV1LaunchTemplateRequest;
286
+ }
287
+ // tslint:disable-next-line:no-empty-interface
288
+ interface GoogleProtobufEmpty {
289
+ }
290
+ interface GoogleRpcStatus {
291
+ /** The status code, which should be an enum value of google.rpc.Code. */
292
+ code?: number;
293
+ /** A list of messages that carry the error details. There is a common set of message types for APIs to use. */
294
+ details?: Array<{ [P in string]: any }>;
295
+ /**
296
+ * 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
297
+ * client.
298
+ */
299
+ message?: string;
300
+ }
301
+ interface JobsResource {
302
+ /** Lists jobs for a given pipeline. Throws a "FORBIDDEN" error if the caller doesn't have permission to access it. */
303
+ list(request?: {
304
+ /** V1 error format. */
305
+ "$.xgafv"?: string;
306
+ /** OAuth access token. */
307
+ access_token?: string;
308
+ /** Data format for response. */
309
+ alt?: string;
310
+ /** JSONP */
311
+ callback?: string;
312
+ /** Selector specifying which fields to include in a partial response. */
313
+ fields?: string;
314
+ /** 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. */
315
+ key?: string;
316
+ /** OAuth 2.0 token for the current user. */
317
+ oauth_token?: string;
318
+ /**
319
+ * The maximum number of entities to return. The service may return fewer than this value, even if there are additional pages. If unspecified, the max limit will be determined by
320
+ * the backend implementation.
321
+ */
322
+ pageSize?: number;
323
+ /**
324
+ * A page token, received from a previous `ListJobs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListJobs` must match the
325
+ * call that provided the page token.
326
+ */
327
+ pageToken?: string;
328
+ /** Required. The pipeline name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_ID`. */
329
+ parent: string;
330
+ /** Returns response with indentations and line breaks. */
331
+ prettyPrint?: boolean;
332
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
333
+ quotaUser?: string;
334
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
335
+ upload_protocol?: string;
336
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
337
+ uploadType?: string;
338
+ }): Request<GoogleCloudDatapipelinesV1ListJobsResponse>;
339
+ }
340
+ interface PipelinesResource {
341
+ /**
342
+ * 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
343
+ * periodically. If the internal scheduler is not configured, you can use RunPipeline to run jobs.
344
+ */
345
+ create(request: {
346
+ /** V1 error format. */
347
+ "$.xgafv"?: string;
348
+ /** OAuth access token. */
349
+ access_token?: string;
350
+ /** Data format for response. */
351
+ alt?: string;
352
+ /** JSONP */
353
+ callback?: string;
354
+ /** Selector specifying which fields to include in a partial response. */
355
+ fields?: string;
356
+ /** 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. */
357
+ key?: string;
358
+ /** OAuth 2.0 token for the current user. */
359
+ oauth_token?: string;
360
+ /** Required. The location name. For example: `projects/PROJECT_ID/locations/LOCATION_ID`. */
361
+ parent: string;
362
+ /** Returns response with indentations and line breaks. */
363
+ prettyPrint?: boolean;
364
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
365
+ quotaUser?: string;
366
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
367
+ upload_protocol?: string;
368
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
369
+ uploadType?: string;
370
+ /** Request body */
371
+ resource: GoogleCloudDatapipelinesV1Pipeline;
372
+ }): Request<GoogleCloudDatapipelinesV1Pipeline>;
373
+ create(request: {
374
+ /** V1 error format. */
375
+ "$.xgafv"?: string;
376
+ /** OAuth access token. */
377
+ access_token?: string;
378
+ /** Data format for response. */
379
+ alt?: string;
380
+ /** JSONP */
381
+ callback?: string;
382
+ /** Selector specifying which fields to include in a partial response. */
383
+ fields?: string;
384
+ /** 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. */
385
+ key?: string;
386
+ /** OAuth 2.0 token for the current user. */
387
+ oauth_token?: string;
388
+ /** Required. The location name. For example: `projects/PROJECT_ID/locations/LOCATION_ID`. */
389
+ parent: string;
390
+ /** Returns response with indentations and line breaks. */
391
+ prettyPrint?: boolean;
392
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
393
+ quotaUser?: string;
394
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
395
+ upload_protocol?: string;
396
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
397
+ uploadType?: string;
398
+ },
399
+ body: GoogleCloudDatapipelinesV1Pipeline): Request<GoogleCloudDatapipelinesV1Pipeline>;
400
+ /** Deletes a pipeline. If a scheduler job is attached to the pipeline, it will be deleted. */
401
+ delete(request?: {
402
+ /** V1 error format. */
403
+ "$.xgafv"?: string;
404
+ /** OAuth access token. */
405
+ access_token?: string;
406
+ /** Data format for response. */
407
+ alt?: string;
408
+ /** JSONP */
409
+ callback?: string;
410
+ /** Selector specifying which fields to include in a partial response. */
411
+ fields?: string;
412
+ /** 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. */
413
+ key?: string;
414
+ /** Required. The pipeline name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_ID`. */
415
+ name: string;
416
+ /** OAuth 2.0 token for the current user. */
417
+ oauth_token?: string;
418
+ /** Returns response with indentations and line breaks. */
419
+ prettyPrint?: boolean;
420
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
421
+ quotaUser?: string;
422
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
423
+ upload_protocol?: string;
424
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
425
+ uploadType?: string;
426
+ }): Request<{}>;
427
+ /** 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. */
428
+ get(request?: {
429
+ /** V1 error format. */
430
+ "$.xgafv"?: string;
431
+ /** OAuth access token. */
432
+ access_token?: string;
433
+ /** Data format for response. */
434
+ alt?: string;
435
+ /** JSONP */
436
+ callback?: string;
437
+ /** Selector specifying which fields to include in a partial response. */
438
+ fields?: string;
439
+ /** 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. */
440
+ key?: string;
441
+ /** Required. The pipeline name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_ID`. */
442
+ name: string;
443
+ /** OAuth 2.0 token for the current user. */
444
+ oauth_token?: string;
445
+ /** Returns response with indentations and line breaks. */
446
+ prettyPrint?: boolean;
447
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
448
+ quotaUser?: string;
449
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
450
+ upload_protocol?: string;
451
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
452
+ uploadType?: string;
453
+ }): Request<GoogleCloudDatapipelinesV1Pipeline>;
454
+ /**
455
+ * 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
456
+ * the UpdatePipeline request until you receive a successful response.
457
+ */
458
+ patch(request: {
459
+ /** V1 error format. */
460
+ "$.xgafv"?: string;
461
+ /** OAuth access token. */
462
+ access_token?: string;
463
+ /** Data format for response. */
464
+ alt?: string;
465
+ /** JSONP */
466
+ callback?: string;
467
+ /** Selector specifying which fields to include in a partial response. */
468
+ fields?: string;
469
+ /** 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. */
470
+ key?: string;
471
+ /**
472
+ * The pipeline name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-),
473
+ * colons (:), and periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects). *
474
+ * `LOCATION_ID` is the canonical ID for the pipeline's location. The list of available locations can be obtained by calling `google.cloud.location.Locations.ListLocations`. Note
475
+ * that the Data Pipelines service is not available in all regions. It depends on Cloud Scheduler, an App Engine application, so it's only available in [App Engine
476
+ * regions](https://cloud.google.com/about/locations#region). * `PIPELINE_ID` is the ID of the pipeline. Must be unique for the selected project and location.
477
+ */
478
+ name: string;
479
+ /** OAuth 2.0 token for the current user. */
480
+ oauth_token?: string;
481
+ /** Returns response with indentations and line breaks. */
482
+ prettyPrint?: boolean;
483
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
484
+ quotaUser?: string;
485
+ /** The list of fields to be updated. */
486
+ updateMask?: string;
487
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
488
+ upload_protocol?: string;
489
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
490
+ uploadType?: string;
491
+ /** Request body */
492
+ resource: GoogleCloudDatapipelinesV1Pipeline;
493
+ }): Request<GoogleCloudDatapipelinesV1Pipeline>;
494
+ patch(request: {
495
+ /** V1 error format. */
496
+ "$.xgafv"?: string;
497
+ /** OAuth access token. */
498
+ access_token?: string;
499
+ /** Data format for response. */
500
+ alt?: string;
501
+ /** JSONP */
502
+ callback?: string;
503
+ /** Selector specifying which fields to include in a partial response. */
504
+ fields?: string;
505
+ /** 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. */
506
+ key?: string;
507
+ /**
508
+ * The pipeline name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-),
509
+ * colons (:), and periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects). *
510
+ * `LOCATION_ID` is the canonical ID for the pipeline's location. The list of available locations can be obtained by calling `google.cloud.location.Locations.ListLocations`. Note
511
+ * that the Data Pipelines service is not available in all regions. It depends on Cloud Scheduler, an App Engine application, so it's only available in [App Engine
512
+ * regions](https://cloud.google.com/about/locations#region). * `PIPELINE_ID` is the ID of the pipeline. Must be unique for the selected project and location.
513
+ */
514
+ name: string;
515
+ /** OAuth 2.0 token for the current user. */
516
+ oauth_token?: string;
517
+ /** Returns response with indentations and line breaks. */
518
+ prettyPrint?: boolean;
519
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
520
+ quotaUser?: string;
521
+ /** The list of fields to be updated. */
522
+ updateMask?: string;
523
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
524
+ upload_protocol?: string;
525
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
526
+ uploadType?: string;
527
+ },
528
+ body: GoogleCloudDatapipelinesV1Pipeline): Request<GoogleCloudDatapipelinesV1Pipeline>;
529
+ /**
530
+ * 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
531
+ * 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
532
+ * the pipeline.
533
+ */
534
+ run(request: {
535
+ /** V1 error format. */
536
+ "$.xgafv"?: string;
537
+ /** OAuth access token. */
538
+ access_token?: string;
539
+ /** Data format for response. */
540
+ alt?: string;
541
+ /** JSONP */
542
+ callback?: string;
543
+ /** Selector specifying which fields to include in a partial response. */
544
+ fields?: string;
545
+ /** 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. */
546
+ key?: string;
547
+ /** Required. The pipeline name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_ID`. */
548
+ name: string;
549
+ /** OAuth 2.0 token for the current user. */
550
+ oauth_token?: string;
551
+ /** Returns response with indentations and line breaks. */
552
+ prettyPrint?: boolean;
553
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
554
+ quotaUser?: string;
555
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
556
+ upload_protocol?: string;
557
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
558
+ uploadType?: string;
559
+ /** Request body */
560
+ resource: GoogleCloudDatapipelinesV1RunPipelineRequest;
561
+ }): Request<GoogleCloudDatapipelinesV1RunPipelineResponse>;
562
+ run(request: {
563
+ /** V1 error format. */
564
+ "$.xgafv"?: string;
565
+ /** OAuth access token. */
566
+ access_token?: string;
567
+ /** Data format for response. */
568
+ alt?: string;
569
+ /** JSONP */
570
+ callback?: string;
571
+ /** Selector specifying which fields to include in a partial response. */
572
+ fields?: string;
573
+ /** 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. */
574
+ key?: string;
575
+ /** Required. The pipeline name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_ID`. */
576
+ name: string;
577
+ /** OAuth 2.0 token for the current user. */
578
+ oauth_token?: string;
579
+ /** Returns response with indentations and line breaks. */
580
+ prettyPrint?: boolean;
581
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
582
+ quotaUser?: string;
583
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
584
+ upload_protocol?: string;
585
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
586
+ uploadType?: string;
587
+ },
588
+ body: GoogleCloudDatapipelinesV1RunPipelineRequest): Request<GoogleCloudDatapipelinesV1RunPipelineResponse>;
589
+ /**
590
+ * 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
591
+ * retained.
592
+ */
593
+ stop(request: {
594
+ /** V1 error format. */
595
+ "$.xgafv"?: string;
596
+ /** OAuth access token. */
597
+ access_token?: string;
598
+ /** Data format for response. */
599
+ alt?: string;
600
+ /** JSONP */
601
+ callback?: string;
602
+ /** Selector specifying which fields to include in a partial response. */
603
+ fields?: string;
604
+ /** 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. */
605
+ key?: string;
606
+ /** Required. The pipeline name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_ID`. */
607
+ name: string;
608
+ /** OAuth 2.0 token for the current user. */
609
+ oauth_token?: string;
610
+ /** Returns response with indentations and line breaks. */
611
+ prettyPrint?: boolean;
612
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
613
+ quotaUser?: string;
614
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
615
+ upload_protocol?: string;
616
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
617
+ uploadType?: string;
618
+ /** Request body */
619
+ resource: GoogleCloudDatapipelinesV1StopPipelineRequest;
620
+ }): Request<GoogleCloudDatapipelinesV1Pipeline>;
621
+ stop(request: {
622
+ /** V1 error format. */
623
+ "$.xgafv"?: string;
624
+ /** OAuth access token. */
625
+ access_token?: string;
626
+ /** Data format for response. */
627
+ alt?: string;
628
+ /** JSONP */
629
+ callback?: string;
630
+ /** Selector specifying which fields to include in a partial response. */
631
+ fields?: string;
632
+ /** 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. */
633
+ key?: string;
634
+ /** Required. The pipeline name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_ID`. */
635
+ name: string;
636
+ /** OAuth 2.0 token for the current user. */
637
+ oauth_token?: string;
638
+ /** Returns response with indentations and line breaks. */
639
+ prettyPrint?: boolean;
640
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
641
+ quotaUser?: string;
642
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
643
+ upload_protocol?: string;
644
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
645
+ uploadType?: string;
646
+ },
647
+ body: GoogleCloudDatapipelinesV1StopPipelineRequest): Request<GoogleCloudDatapipelinesV1Pipeline>;
648
+ jobs: JobsResource;
649
+ }
650
+ interface LocationsResource {
651
+ /** Lists pipelines. Returns a "FORBIDDEN" error if the caller doesn't have permission to access it. */
652
+ listPipelines(request?: {
653
+ /** V1 error format. */
654
+ "$.xgafv"?: string;
655
+ /** OAuth access token. */
656
+ access_token?: string;
657
+ /** Data format for response. */
658
+ alt?: string;
659
+ /** JSONP */
660
+ callback?: string;
661
+ /** Selector specifying which fields to include in a partial response. */
662
+ fields?: string;
663
+ /**
664
+ * An expression for filtering the results of the request. If unspecified, all pipelines will be returned. Multiple filters can be applied and must be comma separated. Fields
665
+ * eligible for filtering are: + `type`: The type of the pipeline (streaming or batch). Allowed values are `ALL`, `BATCH`, and `STREAMING`. + `status`: The activity status of the
666
+ * pipeline. Allowed values are `ALL`, `ACTIVE`, `ARCHIVED`, and `PAUSED`. For example, to limit results to active batch processing pipelines: type:BATCH,status:ACTIVE
667
+ */
668
+ filter?: string;
669
+ /** 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. */
670
+ key?: string;
671
+ /** OAuth 2.0 token for the current user. */
672
+ oauth_token?: string;
673
+ /**
674
+ * The maximum number of entities to return. The service may return fewer than this value, even if there are additional pages. If unspecified, the max limit is yet to be determined
675
+ * by the backend implementation.
676
+ */
677
+ pageSize?: number;
678
+ /**
679
+ * A page token, received from a previous `ListPipelines` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPipelines` must
680
+ * match the call that provided the page token.
681
+ */
682
+ pageToken?: string;
683
+ /** Required. The location name. For example: `projects/PROJECT_ID/locations/LOCATION_ID`. */
684
+ parent: string;
685
+ /** Returns response with indentations and line breaks. */
686
+ prettyPrint?: boolean;
687
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
688
+ quotaUser?: string;
689
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
690
+ upload_protocol?: string;
691
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
692
+ uploadType?: string;
693
+ }): Request<GoogleCloudDatapipelinesV1ListPipelinesResponse>;
694
+ pipelines: PipelinesResource;
695
+ }
696
+ interface ProjectsResource {
697
+ locations: LocationsResource;
698
+ }
699
+
700
+ const projects: ProjectsResource;
701
+ }
702
+ }
package/package.json ADDED
@@ -0,0 +1,20 @@
1
+ {
2
+ "name": "@maxim_mazurok/gapi.client.datapipelines-v1",
3
+ "version": "0.0.20220730",
4
+ "description": "TypeScript typings for Data pipelines API v1",
5
+ "license": "MIT",
6
+ "author": {
7
+ "email": "maxim@mazurok.com",
8
+ "name": "Maxim Mazurok",
9
+ "url": "https://maxim.mazurok.com"
10
+ },
11
+ "repository": {
12
+ "type": "git",
13
+ "url": "https://github.com/Maxim-Mazurok/google-api-typings-generator.git"
14
+ },
15
+ "types": "index.d.ts",
16
+ "dependencies": {
17
+ "@types/gapi.client": "*",
18
+ "@types/gapi.client.discovery": "*"
19
+ }
20
+ }
package/readme.md ADDED
@@ -0,0 +1,68 @@
1
+ # TypeScript typings for Data pipelines API v1
2
+
3
+ Data Pipelines provides an interface for creating, updating, and managing recurring Data Analytics jobs.
4
+ For detailed description please check [documentation](https://cloud.google.com/dataflow/docs/guides/data-pipelines).
5
+
6
+ ## Installing
7
+
8
+ Install typings for Data pipelines API:
9
+
10
+ ```
11
+ npm install @types/gapi.client.datapipelines-v1 --save-dev
12
+ ```
13
+
14
+ ## Usage
15
+
16
+ You need to initialize Google API client in your code:
17
+
18
+ ```typescript
19
+ gapi.load('client', () => {
20
+ // now we can use gapi.client
21
+ // ...
22
+ });
23
+ ```
24
+
25
+ Then load api client wrapper:
26
+
27
+ ```typescript
28
+ gapi.client.load('https://datapipelines.googleapis.com/$discovery/rest?version=v1', () => {
29
+ // now we can use:
30
+ // gapi.client.datapipelines
31
+ });
32
+ ```
33
+
34
+ ```typescript
35
+ // Deprecated, use discovery document URL, see https://github.com/google/google-api-javascript-client/blob/master/docs/reference.md#----gapiclientloadname----version----callback--
36
+ gapi.client.load('datapipelines', 'v1', () => {
37
+ // now we can use:
38
+ // gapi.client.datapipelines
39
+ });
40
+ ```
41
+
42
+ Don't forget to authenticate your client before sending any request to resources:
43
+
44
+ ```typescript
45
+ // declare client_id registered in Google Developers Console
46
+ var client_id = '',
47
+ scope = [
48
+ // See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account.
49
+ 'https://www.googleapis.com/auth/cloud-platform',
50
+ ],
51
+ immediate = true;
52
+ // ...
53
+
54
+ gapi.auth.authorize(
55
+ { client_id: client_id, scope: scope, immediate: immediate },
56
+ authResult => {
57
+ if (authResult && !authResult.error) {
58
+ /* handle successful authorization */
59
+ } else {
60
+ /* handle authorization error */
61
+ }
62
+ });
63
+ ```
64
+
65
+ After that you can use Data pipelines API resources: <!-- TODO: make this work for multiple namespaces -->
66
+
67
+ ```typescript
68
+ ```
package/tests.ts ADDED
@@ -0,0 +1,281 @@
1
+ /* This is stub file for gapi.client.datapipelines-v1 definition tests */
2
+ // IMPORTANT
3
+ // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
4
+ // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
5
+
6
+ // Revision: 20220730
7
+
8
+ gapi.load('client', async () => {
9
+ /** now we can use gapi.client */
10
+
11
+ await gapi.client.load('https://datapipelines.googleapis.com/$discovery/rest?version=v1');
12
+ /** now we can use gapi.client.datapipelines */
13
+
14
+ /** don't forget to authenticate your client before sending any request to resources: */
15
+ /** declare client_id registered in Google Developers Console */
16
+ const client_id = '<<PUT YOUR CLIENT ID HERE>>';
17
+ const scope = [
18
+ /** See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account. */
19
+ 'https://www.googleapis.com/auth/cloud-platform',
20
+ ];
21
+ const immediate = false;
22
+ gapi.auth.authorize({ client_id, scope, immediate }, authResult => {
23
+ if (authResult && !authResult.error) {
24
+ /** handle successful authorization */
25
+ run();
26
+ } else {
27
+ /** handle authorization error */
28
+ }
29
+ });
30
+
31
+ async function run() {
32
+ /** Lists pipelines. Returns a "FORBIDDEN" error if the caller doesn't have permission to access it. */
33
+ await gapi.client.datapipelines.projects.locations.listPipelines({
34
+ filter: "Test string",
35
+ pageSize: 42,
36
+ pageToken: "Test string",
37
+ parent: "Test string",
38
+ });
39
+ /**
40
+ * 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.
41
+ * If the internal scheduler is not configured, you can use RunPipeline to run jobs.
42
+ */
43
+ await gapi.client.datapipelines.projects.locations.pipelines.create({
44
+ parent: "Test string",
45
+ }, {
46
+ createTime: "Test string",
47
+ displayName: "Test string",
48
+ jobCount: 42,
49
+ lastUpdateTime: "Test string",
50
+ name: "Test string",
51
+ pipelineSources: {
52
+ A: "Test string"
53
+ },
54
+ scheduleInfo: {
55
+ nextJobTime: "Test string",
56
+ schedule: "Test string",
57
+ timeZone: "Test string",
58
+ },
59
+ schedulerServiceAccountEmail: "Test string",
60
+ state: "Test string",
61
+ type: "Test string",
62
+ workload: {
63
+ dataflowFlexTemplateRequest: {
64
+ launchParameter: {
65
+ containerSpecGcsPath: "Test string",
66
+ environment: {
67
+ additionalExperiments: [
68
+ "Test string"
69
+ ],
70
+ additionalUserLabels: {
71
+ A: "Test string"
72
+ },
73
+ enableStreamingEngine: true,
74
+ flexrsGoal: "Test string",
75
+ ipConfiguration: "Test string",
76
+ kmsKeyName: "Test string",
77
+ machineType: "Test string",
78
+ maxWorkers: 42,
79
+ network: "Test string",
80
+ numWorkers: 42,
81
+ serviceAccountEmail: "Test string",
82
+ subnetwork: "Test string",
83
+ tempLocation: "Test string",
84
+ workerRegion: "Test string",
85
+ workerZone: "Test string",
86
+ zone: "Test string",
87
+ },
88
+ jobName: "Test string",
89
+ launchOptions: {
90
+ A: "Test string"
91
+ },
92
+ parameters: {
93
+ A: "Test string"
94
+ },
95
+ transformNameMappings: {
96
+ A: "Test string"
97
+ },
98
+ update: true,
99
+ },
100
+ location: "Test string",
101
+ projectId: "Test string",
102
+ validateOnly: true,
103
+ },
104
+ dataflowLaunchTemplateRequest: {
105
+ gcsPath: "Test string",
106
+ launchParameters: {
107
+ environment: {
108
+ additionalExperiments: [
109
+ "Test string"
110
+ ],
111
+ additionalUserLabels: {
112
+ A: "Test string"
113
+ },
114
+ bypassTempDirValidation: true,
115
+ enableStreamingEngine: true,
116
+ ipConfiguration: "Test string",
117
+ kmsKeyName: "Test string",
118
+ machineType: "Test string",
119
+ maxWorkers: 42,
120
+ network: "Test string",
121
+ numWorkers: 42,
122
+ serviceAccountEmail: "Test string",
123
+ subnetwork: "Test string",
124
+ tempLocation: "Test string",
125
+ workerRegion: "Test string",
126
+ workerZone: "Test string",
127
+ zone: "Test string",
128
+ },
129
+ jobName: "Test string",
130
+ parameters: {
131
+ A: "Test string"
132
+ },
133
+ transformNameMapping: {
134
+ A: "Test string"
135
+ },
136
+ update: true,
137
+ },
138
+ location: "Test string",
139
+ projectId: "Test string",
140
+ validateOnly: true,
141
+ },
142
+ },
143
+ });
144
+ /** Deletes a pipeline. If a scheduler job is attached to the pipeline, it will be deleted. */
145
+ await gapi.client.datapipelines.projects.locations.pipelines.delete({
146
+ name: "Test string",
147
+ });
148
+ /** 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. */
149
+ await gapi.client.datapipelines.projects.locations.pipelines.get({
150
+ name: "Test string",
151
+ });
152
+ /**
153
+ * 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
154
+ * UpdatePipeline request until you receive a successful response.
155
+ */
156
+ await gapi.client.datapipelines.projects.locations.pipelines.patch({
157
+ name: "Test string",
158
+ updateMask: "Test string",
159
+ }, {
160
+ createTime: "Test string",
161
+ displayName: "Test string",
162
+ jobCount: 42,
163
+ lastUpdateTime: "Test string",
164
+ name: "Test string",
165
+ pipelineSources: {
166
+ A: "Test string"
167
+ },
168
+ scheduleInfo: {
169
+ nextJobTime: "Test string",
170
+ schedule: "Test string",
171
+ timeZone: "Test string",
172
+ },
173
+ schedulerServiceAccountEmail: "Test string",
174
+ state: "Test string",
175
+ type: "Test string",
176
+ workload: {
177
+ dataflowFlexTemplateRequest: {
178
+ launchParameter: {
179
+ containerSpecGcsPath: "Test string",
180
+ environment: {
181
+ additionalExperiments: [
182
+ "Test string"
183
+ ],
184
+ additionalUserLabels: {
185
+ A: "Test string"
186
+ },
187
+ enableStreamingEngine: true,
188
+ flexrsGoal: "Test string",
189
+ ipConfiguration: "Test string",
190
+ kmsKeyName: "Test string",
191
+ machineType: "Test string",
192
+ maxWorkers: 42,
193
+ network: "Test string",
194
+ numWorkers: 42,
195
+ serviceAccountEmail: "Test string",
196
+ subnetwork: "Test string",
197
+ tempLocation: "Test string",
198
+ workerRegion: "Test string",
199
+ workerZone: "Test string",
200
+ zone: "Test string",
201
+ },
202
+ jobName: "Test string",
203
+ launchOptions: {
204
+ A: "Test string"
205
+ },
206
+ parameters: {
207
+ A: "Test string"
208
+ },
209
+ transformNameMappings: {
210
+ A: "Test string"
211
+ },
212
+ update: true,
213
+ },
214
+ location: "Test string",
215
+ projectId: "Test string",
216
+ validateOnly: true,
217
+ },
218
+ dataflowLaunchTemplateRequest: {
219
+ gcsPath: "Test string",
220
+ launchParameters: {
221
+ environment: {
222
+ additionalExperiments: [
223
+ "Test string"
224
+ ],
225
+ additionalUserLabels: {
226
+ A: "Test string"
227
+ },
228
+ bypassTempDirValidation: true,
229
+ enableStreamingEngine: true,
230
+ ipConfiguration: "Test string",
231
+ kmsKeyName: "Test string",
232
+ machineType: "Test string",
233
+ maxWorkers: 42,
234
+ network: "Test string",
235
+ numWorkers: 42,
236
+ serviceAccountEmail: "Test string",
237
+ subnetwork: "Test string",
238
+ tempLocation: "Test string",
239
+ workerRegion: "Test string",
240
+ workerZone: "Test string",
241
+ zone: "Test string",
242
+ },
243
+ jobName: "Test string",
244
+ parameters: {
245
+ A: "Test string"
246
+ },
247
+ transformNameMapping: {
248
+ A: "Test string"
249
+ },
250
+ update: true,
251
+ },
252
+ location: "Test string",
253
+ projectId: "Test string",
254
+ validateOnly: true,
255
+ },
256
+ },
257
+ });
258
+ /**
259
+ * 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
260
+ * 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.
261
+ */
262
+ await gapi.client.datapipelines.projects.locations.pipelines.run({
263
+ name: "Test string",
264
+ }, {
265
+ });
266
+ /**
267
+ * 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
268
+ * retained.
269
+ */
270
+ await gapi.client.datapipelines.projects.locations.pipelines.stop({
271
+ name: "Test string",
272
+ }, {
273
+ });
274
+ /** Lists jobs for a given pipeline. Throws a "FORBIDDEN" error if the caller doesn't have permission to access it. */
275
+ await gapi.client.datapipelines.projects.locations.pipelines.jobs.list({
276
+ pageSize: 42,
277
+ pageToken: "Test string",
278
+ parent: "Test string",
279
+ });
280
+ }
281
+ });
package/tsconfig.json ADDED
@@ -0,0 +1,18 @@
1
+ {
2
+ "compilerOptions": {
3
+ "module": "commonjs",
4
+ "lib": ["es6", "dom"],
5
+ "noImplicitAny": true,
6
+ "noImplicitThis": true,
7
+ "strictNullChecks": true,
8
+ "baseUrl": "../",
9
+ "typeRoots": [
10
+ "../"
11
+ ],
12
+ "types": [],
13
+ "noEmit": true,
14
+ "forceConsistentCasingInFileNames": true,
15
+ "strictFunctionTypes": true
16
+ },
17
+ "files": ["index.d.ts", "tests.ts"]
18
+ }
package/tslint.json ADDED
@@ -0,0 +1,6 @@
1
+ {
2
+ "extends": "dtslint/dtslint.json",
3
+ "rules": {
4
+ "no-redundant-jsdoc": false
5
+ }
6
+ }