@maxim_mazurok/gapi.client.dataflow-v1b3 0.3.20260729 → 0.3.20260807
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 +53 -25
- 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: 20260807
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -69,6 +69,22 @@ declare namespace gapi.client {
|
|
|
69
69
|
/** A short and friendly name for the worker pool this event refers to. */
|
|
70
70
|
workerPool?: string;
|
|
71
71
|
}
|
|
72
|
+
interface AutoscalingSchedule {
|
|
73
|
+
/** Optional. A crontab specification of when this schedule should trigger applying overrides. The overrides will be applied from the trigger time until the specified duration elapses. */
|
|
74
|
+
crontab?: string;
|
|
75
|
+
/** Optional. The duration for which the parameter overrides for this schedule will be applied when triggered by the crontab. */
|
|
76
|
+
duration?: string;
|
|
77
|
+
/** Optional. The name of the schedule. */
|
|
78
|
+
name?: string;
|
|
79
|
+
/** Optional. The parameters to use for autoscaling when this schedule is active. */
|
|
80
|
+
parameters?: Parameters;
|
|
81
|
+
/** Optional. Specifies the priority of the schedule. If two schedules overlap, the one with the higher priority will be used. The higher the value, the higher the priority of the schedule. */
|
|
82
|
+
priority?: string;
|
|
83
|
+
/** Optional. The time zone for the schedule. The value of this field must be a time zone name from the [tz database](http://en.wikipedia.org/wiki/Tz_database). The default value is UTC. */
|
|
84
|
+
timeZone?: string;
|
|
85
|
+
/** Output only. When the customer last updated the schedule. */
|
|
86
|
+
updateTime?: string;
|
|
87
|
+
}
|
|
72
88
|
interface AutoscalingSettings {
|
|
73
89
|
/** The algorithm to use for autoscaling. */
|
|
74
90
|
algorithm?:
|
|
@@ -1162,6 +1178,16 @@ declare namespace gapi.client {
|
|
|
1162
1178
|
/** Required. The value of the enum option. */
|
|
1163
1179
|
value?: string;
|
|
1164
1180
|
}
|
|
1181
|
+
interface Parameters {
|
|
1182
|
+
/** Optional. The target CPU utilization for this schedule. */
|
|
1183
|
+
cpuUtilizationTarget?: number;
|
|
1184
|
+
/** Optional. The target latency for this schedule. */
|
|
1185
|
+
latencyTarget?: string;
|
|
1186
|
+
/** Optional. The maximum number of workers for this schedule. */
|
|
1187
|
+
maxWorkerCount?: number;
|
|
1188
|
+
/** Optional. The minimum number of workers for this schedule. */
|
|
1189
|
+
minWorkerCount?: number;
|
|
1190
|
+
}
|
|
1165
1191
|
interface ParDoInstruction {
|
|
1166
1192
|
/** The input. */
|
|
1167
1193
|
input?: InstructionInput;
|
|
@@ -1370,6 +1396,8 @@ declare namespace gapi.client {
|
|
|
1370
1396
|
maxNumWorkers?: number;
|
|
1371
1397
|
/** The minimum number of workers to scale down to. This field is currently only supported for Streaming Engine jobs. */
|
|
1372
1398
|
minNumWorkers?: number;
|
|
1399
|
+
/** Optional. The schedule for autoscaling. */
|
|
1400
|
+
schedules?: AutoscalingSchedule[];
|
|
1373
1401
|
/** Target worker utilization, compared against the aggregate utilization of the worker pool by autoscaler, to determine upscaling and downscaling when absent other constraints such as backlog. For more information, see [Update an existing pipeline](https://cloud.google.com/dataflow/docs/guides/updating-a-pipeline). */
|
|
1374
1402
|
workerUtilizationHint?: number;
|
|
1375
1403
|
}
|
|
@@ -2379,7 +2407,7 @@ declare namespace gapi.client {
|
|
|
2379
2407
|
): Request<{}>;
|
|
2380
2408
|
}
|
|
2381
2409
|
interface MessagesResource {
|
|
2382
|
-
/** 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`. */
|
|
2410
|
+
/** 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`. # IAM Permissions Requires the `dataflow.messages.list` permission on the job. */
|
|
2383
2411
|
list(request?: {
|
|
2384
2412
|
/** V1 error format. */
|
|
2385
2413
|
'$.xgafv'?: '1' | '2';
|
|
@@ -2554,7 +2582,7 @@ declare namespace gapi.client {
|
|
|
2554
2582
|
): Request<ReportWorkItemStatusResponse>;
|
|
2555
2583
|
}
|
|
2556
2584
|
interface JobsResource {
|
|
2557
|
-
/** List the jobs of a project across all regions. **Note:** This method doesn't support filtering the list of jobs by name. */
|
|
2585
|
+
/** List the jobs of a project across all regions. **Note:** This method doesn't support filtering the list of jobs by name. # IAM Permissions Requires the `dataflow.jobs.list` permission on the project. */
|
|
2558
2586
|
aggregated(request?: {
|
|
2559
2587
|
/** V1 error format. */
|
|
2560
2588
|
'$.xgafv'?: '1' | '2';
|
|
@@ -2597,7 +2625,7 @@ declare namespace gapi.client {
|
|
|
2597
2625
|
| 'JOB_VIEW_ALL'
|
|
2598
2626
|
| 'JOB_VIEW_DESCRIPTION';
|
|
2599
2627
|
}): Request<ListJobsResponse>;
|
|
2600
|
-
/** 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. */
|
|
2628
|
+
/** 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. # IAM Permissions 1. Requires the `dataflow.jobs.create` permission on the project. 2. `resourcemanager.projects.get` (Specifically required for regional endpoints to resolve regional resource metadata) */
|
|
2601
2629
|
create(request: {
|
|
2602
2630
|
/** V1 error format. */
|
|
2603
2631
|
'$.xgafv'?: '1' | '2';
|
|
@@ -2675,7 +2703,7 @@ declare namespace gapi.client {
|
|
|
2675
2703
|
},
|
|
2676
2704
|
body: Job,
|
|
2677
2705
|
): Request<Job>;
|
|
2678
|
-
/** 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`. */
|
|
2706
|
+
/** 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`. # IAM Permissions Requires the `dataflow.jobs.get` permission on the job. */
|
|
2679
2707
|
get(request?: {
|
|
2680
2708
|
/** V1 error format. */
|
|
2681
2709
|
'$.xgafv'?: '1' | '2';
|
|
@@ -2712,7 +2740,7 @@ declare namespace gapi.client {
|
|
|
2712
2740
|
| 'JOB_VIEW_ALL'
|
|
2713
2741
|
| 'JOB_VIEW_DESCRIPTION';
|
|
2714
2742
|
}): Request<Job>;
|
|
2715
|
-
/** 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`. */
|
|
2743
|
+
/** 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`. # IAM Permissions Requires the `dataflow.metrics.get` permission on the job. */
|
|
2716
2744
|
getMetrics(request?: {
|
|
2717
2745
|
/** V1 error format. */
|
|
2718
2746
|
'$.xgafv'?: '1' | '2';
|
|
@@ -2745,7 +2773,7 @@ declare namespace gapi.client {
|
|
|
2745
2773
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2746
2774
|
uploadType?: string;
|
|
2747
2775
|
}): Request<JobMetrics>;
|
|
2748
|
-
/** 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`. */
|
|
2776
|
+
/** 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`. # IAM Permissions Requires the `dataflow.jobs.list` permission on the project. */
|
|
2749
2777
|
list(request?: {
|
|
2750
2778
|
/** V1 error format. */
|
|
2751
2779
|
'$.xgafv'?: '1' | '2';
|
|
@@ -2788,7 +2816,7 @@ declare namespace gapi.client {
|
|
|
2788
2816
|
| 'JOB_VIEW_ALL'
|
|
2789
2817
|
| 'JOB_VIEW_DESCRIPTION';
|
|
2790
2818
|
}): Request<ListJobsResponse>;
|
|
2791
|
-
/** Snapshot the state of a streaming job. */
|
|
2819
|
+
/** Snapshot the state of a streaming job. # IAM Permissions Requires the `dataflow.jobs.snapshot` permission on the job. */
|
|
2792
2820
|
snapshot(request: {
|
|
2793
2821
|
/** V1 error format. */
|
|
2794
2822
|
'$.xgafv'?: '1' | '2';
|
|
@@ -2850,7 +2878,7 @@ declare namespace gapi.client {
|
|
|
2850
2878
|
},
|
|
2851
2879
|
body: SnapshotJobRequest,
|
|
2852
2880
|
): Request<Snapshot>;
|
|
2853
|
-
/** 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`. */
|
|
2881
|
+
/** 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`. # IAM Permissions 1. Requires the `dataflow.jobs.cancel` permission to cancel a job. 2. Requires the `dataflow.jobs.updateContents` permission to update runtime parameters. */
|
|
2854
2882
|
update(request: {
|
|
2855
2883
|
/** V1 error format. */
|
|
2856
2884
|
'$.xgafv'?: '1' | '2';
|
|
@@ -2925,7 +2953,7 @@ declare namespace gapi.client {
|
|
|
2925
2953
|
workItems: WorkItemsResource;
|
|
2926
2954
|
}
|
|
2927
2955
|
interface FlexTemplatesResource {
|
|
2928
|
-
/** Launch a job with a FlexTemplate. */
|
|
2956
|
+
/** Launch a job with a FlexTemplate. # IAM Permissions Requires the following IAM permission(s) on the resource: - `dataflow.jobs.create` - `resourcemanager.projects.get` - `iam.serviceAccounts.actAs` - `storage.buckets.get` - `storage.buckets.create` (Required if the default staging bucket must be created) */
|
|
2929
2957
|
launch(request: {
|
|
2930
2958
|
/** V1 error format. */
|
|
2931
2959
|
'$.xgafv'?: '1' | '2';
|
|
@@ -3189,7 +3217,7 @@ declare namespace gapi.client {
|
|
|
3189
3217
|
): Request<{}>;
|
|
3190
3218
|
}
|
|
3191
3219
|
interface MessagesResource {
|
|
3192
|
-
/** 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`. */
|
|
3220
|
+
/** 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`. # IAM Permissions Requires the `dataflow.messages.list` permission on the job. */
|
|
3193
3221
|
list(request?: {
|
|
3194
3222
|
/** V1 error format. */
|
|
3195
3223
|
'$.xgafv'?: '1' | '2';
|
|
@@ -3271,7 +3299,7 @@ declare namespace gapi.client {
|
|
|
3271
3299
|
}): Request<ListSnapshotsResponse>;
|
|
3272
3300
|
}
|
|
3273
3301
|
interface StagesResource {
|
|
3274
|
-
/** Request detailed information about the execution status of a stage of the job. EXPERIMENTAL. This API is subject to change or removal without notice. */
|
|
3302
|
+
/** Request detailed information about the execution status of a stage of the job. EXPERIMENTAL. This API is subject to change or removal without notice. # IAM Permissions Requires the `dataflow.metrics.get` permission on the job. */
|
|
3275
3303
|
getExecutionDetails(request?: {
|
|
3276
3304
|
/** V1 error format. */
|
|
3277
3305
|
'$.xgafv'?: '1' | '2';
|
|
@@ -3448,7 +3476,7 @@ declare namespace gapi.client {
|
|
|
3448
3476
|
): Request<ReportWorkItemStatusResponse>;
|
|
3449
3477
|
}
|
|
3450
3478
|
interface JobsResource {
|
|
3451
|
-
/** 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. */
|
|
3479
|
+
/** 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. # IAM Permissions 1. Requires the `dataflow.jobs.create` permission on the project. 2. `resourcemanager.projects.get` (Specifically required for regional endpoints to resolve regional resource metadata) */
|
|
3452
3480
|
create(request: {
|
|
3453
3481
|
/** V1 error format. */
|
|
3454
3482
|
'$.xgafv'?: '1' | '2';
|
|
@@ -3526,7 +3554,7 @@ declare namespace gapi.client {
|
|
|
3526
3554
|
},
|
|
3527
3555
|
body: Job,
|
|
3528
3556
|
): Request<Job>;
|
|
3529
|
-
/** 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`. */
|
|
3557
|
+
/** 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`. # IAM Permissions Requires the `dataflow.jobs.get` permission on the job. */
|
|
3530
3558
|
get(request?: {
|
|
3531
3559
|
/** V1 error format. */
|
|
3532
3560
|
'$.xgafv'?: '1' | '2';
|
|
@@ -3563,7 +3591,7 @@ declare namespace gapi.client {
|
|
|
3563
3591
|
| 'JOB_VIEW_ALL'
|
|
3564
3592
|
| 'JOB_VIEW_DESCRIPTION';
|
|
3565
3593
|
}): Request<Job>;
|
|
3566
|
-
/** Request detailed information about the execution status of the job. EXPERIMENTAL. This API is subject to change or removal without notice. */
|
|
3594
|
+
/** Request detailed information about the execution status of the job. EXPERIMENTAL. This API is subject to change or removal without notice. # IAM Permissions Requires the `dataflow.metrics.get` permission on the job. */
|
|
3567
3595
|
getExecutionDetails(request?: {
|
|
3568
3596
|
/** V1 error format. */
|
|
3569
3597
|
'$.xgafv'?: '1' | '2';
|
|
@@ -3598,7 +3626,7 @@ declare namespace gapi.client {
|
|
|
3598
3626
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3599
3627
|
uploadType?: string;
|
|
3600
3628
|
}): Request<JobExecutionDetails>;
|
|
3601
|
-
/** 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`. */
|
|
3629
|
+
/** 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`. # IAM Permissions Requires the `dataflow.metrics.get` permission on the job. */
|
|
3602
3630
|
getMetrics(request?: {
|
|
3603
3631
|
/** V1 error format. */
|
|
3604
3632
|
'$.xgafv'?: '1' | '2';
|
|
@@ -3631,7 +3659,7 @@ declare namespace gapi.client {
|
|
|
3631
3659
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3632
3660
|
uploadType?: string;
|
|
3633
3661
|
}): Request<JobMetrics>;
|
|
3634
|
-
/** 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`. */
|
|
3662
|
+
/** 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`. # IAM Permissions Requires the `dataflow.jobs.list` permission on the project. */
|
|
3635
3663
|
list(request?: {
|
|
3636
3664
|
/** V1 error format. */
|
|
3637
3665
|
'$.xgafv'?: '1' | '2';
|
|
@@ -3674,7 +3702,7 @@ declare namespace gapi.client {
|
|
|
3674
3702
|
| 'JOB_VIEW_ALL'
|
|
3675
3703
|
| 'JOB_VIEW_DESCRIPTION';
|
|
3676
3704
|
}): Request<ListJobsResponse>;
|
|
3677
|
-
/** Snapshot the state of a streaming job. */
|
|
3705
|
+
/** Snapshot the state of a streaming job. # IAM Permissions Requires the `dataflow.jobs.snapshot` permission on the job. */
|
|
3678
3706
|
snapshot(request: {
|
|
3679
3707
|
/** V1 error format. */
|
|
3680
3708
|
'$.xgafv'?: '1' | '2';
|
|
@@ -3740,7 +3768,7 @@ declare namespace gapi.client {
|
|
|
3740
3768
|
},
|
|
3741
3769
|
body: SnapshotJobRequest,
|
|
3742
3770
|
): Request<Snapshot>;
|
|
3743
|
-
/** 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`. */
|
|
3771
|
+
/** 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`. # IAM Permissions 1. Requires the `dataflow.jobs.cancel` permission to cancel a job. 2. Requires the `dataflow.jobs.updateContents` permission to update runtime parameters. */
|
|
3744
3772
|
update(request: {
|
|
3745
3773
|
/** V1 error format. */
|
|
3746
3774
|
'$.xgafv'?: '1' | '2';
|
|
@@ -3912,7 +3940,7 @@ declare namespace gapi.client {
|
|
|
3912
3940
|
}): Request<ListSnapshotsResponse>;
|
|
3913
3941
|
}
|
|
3914
3942
|
interface TemplatesResource {
|
|
3915
|
-
/** 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`. */
|
|
3943
|
+
/** 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`. # IAM Permissions Requires the following IAM permission(s) on the project: - `dataflow.jobs.create` - `resourcemanager.projects.get` */
|
|
3916
3944
|
create(request: {
|
|
3917
3945
|
/** V1 error format. */
|
|
3918
3946
|
'$.xgafv'?: '1' | '2';
|
|
@@ -3974,7 +4002,7 @@ declare namespace gapi.client {
|
|
|
3974
4002
|
},
|
|
3975
4003
|
body: CreateJobFromTemplateRequest,
|
|
3976
4004
|
): Request<Job>;
|
|
3977
|
-
/** 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. */
|
|
4005
|
+
/** 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. # IAM Permissions Requires the `resourcemanager.projects.get` permission on the project. */
|
|
3978
4006
|
get(request?: {
|
|
3979
4007
|
/** V1 error format. */
|
|
3980
4008
|
'$.xgafv'?: '1' | '2';
|
|
@@ -4007,7 +4035,7 @@ declare namespace gapi.client {
|
|
|
4007
4035
|
/** The view to retrieve. Defaults to METADATA_ONLY. */
|
|
4008
4036
|
view?: 'METADATA_ONLY';
|
|
4009
4037
|
}): Request<GetTemplateResponse>;
|
|
4010
|
-
/** 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`. */
|
|
4038
|
+
/** 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`. # IAM Permissions Requires the following IAM permission(s) on the project: - `dataflow.jobs.create` - `resourcemanager.projects.get` */
|
|
4011
4039
|
launch(request: {
|
|
4012
4040
|
/** V1 error format. */
|
|
4013
4041
|
'$.xgafv'?: '1' | '2';
|
|
@@ -4219,7 +4247,7 @@ declare namespace gapi.client {
|
|
|
4219
4247
|
}): Request<ListSnapshotsResponse>;
|
|
4220
4248
|
}
|
|
4221
4249
|
interface TemplatesResource {
|
|
4222
|
-
/** 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`. */
|
|
4250
|
+
/** 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`. # IAM Permissions Requires the following IAM permission(s) on the project: - `dataflow.jobs.create` - `resourcemanager.projects.get` */
|
|
4223
4251
|
create(request: {
|
|
4224
4252
|
/** V1 error format. */
|
|
4225
4253
|
'$.xgafv'?: '1' | '2';
|
|
@@ -4277,7 +4305,7 @@ declare namespace gapi.client {
|
|
|
4277
4305
|
},
|
|
4278
4306
|
body: CreateJobFromTemplateRequest,
|
|
4279
4307
|
): Request<Job>;
|
|
4280
|
-
/** 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. */
|
|
4308
|
+
/** 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. # IAM Permissions Requires the `resourcemanager.projects.get` permission on the project. */
|
|
4281
4309
|
get(request?: {
|
|
4282
4310
|
/** V1 error format. */
|
|
4283
4311
|
'$.xgafv'?: '1' | '2';
|
|
@@ -4310,7 +4338,7 @@ declare namespace gapi.client {
|
|
|
4310
4338
|
/** The view to retrieve. Defaults to METADATA_ONLY. */
|
|
4311
4339
|
view?: 'METADATA_ONLY';
|
|
4312
4340
|
}): Request<GetTemplateResponse>;
|
|
4313
|
-
/** 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`. */
|
|
4341
|
+
/** 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`. # IAM Permissions Requires the following IAM permission(s) on the project: - `dataflow.jobs.create` - `resourcemanager.projects.get` */
|
|
4314
4342
|
launch(request: {
|
|
4315
4343
|
/** V1 error format. */
|
|
4316
4344
|
'$.xgafv'?: '1' | '2';
|