Skip to content

Commit 1f67690

Browse files
yoshi-automationsofisl
authored andcommittedAug 27, 2024
feat(dataflow): update the API
#### dataflow:v1b3 The following keys were added: - schemas.LeaseWorkItemRequest.properties.projectNumber.description - schemas.LeaseWorkItemRequest.properties.projectNumber.format - schemas.LeaseWorkItemRequest.properties.projectNumber.type - schemas.ReportWorkItemStatusRequest.properties.projectNumber.description - schemas.ReportWorkItemStatusRequest.properties.projectNumber.format - schemas.ReportWorkItemStatusRequest.properties.projectNumber.type - schemas.StreamingConfigTask.properties.userWorkerRunnerV1Settings.description - schemas.StreamingConfigTask.properties.userWorkerRunnerV1Settings.format - schemas.StreamingConfigTask.properties.userWorkerRunnerV1Settings.type - schemas.StreamingConfigTask.properties.userWorkerRunnerV2Settings.description - schemas.StreamingConfigTask.properties.userWorkerRunnerV2Settings.format - schemas.StreamingConfigTask.properties.userWorkerRunnerV2Settings.type The following keys were changed: - endpoints - resources.projects.resources.locations.resources.templates.methods.create.description - resources.projects.resources.locations.resources.templates.methods.get.description - resources.projects.resources.locations.resources.templates.methods.launch.description - resources.projects.resources.templates.methods.create.description - resources.projects.resources.templates.methods.get.description - resources.projects.resources.templates.methods.launch.description
1 parent b0db98e commit 1f67690

File tree

2 files changed

+54
-13
lines changed

2 files changed

+54
-13
lines changed
 

‎discovery/dataflow-v1b3.json

+32-7
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,11 @@
8484
"endpointUrl": "https://dataflow.us-west2.rep.googleapis.com/",
8585
"location": "us-west2"
8686
},
87+
{
88+
"description": "Regional Endpoint",
89+
"endpointUrl": "https://dataflow.us-west3.rep.googleapis.com/",
90+
"location": "us-west3"
91+
},
8792
{
8893
"description": "Regional Endpoint",
8994
"endpointUrl": "https://dataflow.us-west4.rep.googleapis.com/",
@@ -1852,7 +1857,7 @@
18521857
"templates": {
18531858
"methods": {
18541859
"create": {
1855-
"description": "Creates a Cloud Dataflow job from a template. Do not enter confidential information when you supply string values using the API.",
1860+
"description": "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`.",
18561861
"flatPath": "v1b3/projects/{projectId}/locations/{location}/templates",
18571862
"httpMethod": "POST",
18581863
"id": "dataflow.projects.locations.templates.create",
@@ -1887,7 +1892,7 @@
18871892
]
18881893
},
18891894
"get": {
1890-
"description": "Get the template associated with a template.",
1895+
"description": "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.",
18911896
"flatPath": "v1b3/projects/{projectId}/locations/{location}/templates:get",
18921897
"httpMethod": "GET",
18931898
"id": "dataflow.projects.locations.templates.get",
@@ -1935,7 +1940,7 @@
19351940
]
19361941
},
19371942
"launch": {
1938-
"description": "Launch a template.",
1943+
"description": "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`.",
19391944
"flatPath": "v1b3/projects/{projectId}/locations/{location}/templates:launch",
19401945
"httpMethod": "POST",
19411946
"id": "dataflow.projects.locations.templates.launch",
@@ -2072,7 +2077,7 @@
20722077
"templates": {
20732078
"methods": {
20742079
"create": {
2075-
"description": "Creates a Cloud Dataflow job from a template. Do not enter confidential information when you supply string values using the API.",
2080+
"description": "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`.",
20762081
"flatPath": "v1b3/projects/{projectId}/templates",
20772082
"httpMethod": "POST",
20782083
"id": "dataflow.projects.templates.create",
@@ -2100,7 +2105,7 @@
21002105
]
21012106
},
21022107
"get": {
2103-
"description": "Get the template associated with a template.",
2108+
"description": "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.",
21042109
"flatPath": "v1b3/projects/{projectId}/templates:get",
21052110
"httpMethod": "GET",
21062111
"id": "dataflow.projects.templates.get",
@@ -2146,7 +2151,7 @@
21462151
]
21472152
},
21482153
"launch": {
2149-
"description": "Launch a template.",
2154+
"description": "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`.",
21502155
"flatPath": "v1b3/projects/{projectId}/templates:launch",
21512156
"httpMethod": "POST",
21522157
"id": "dataflow.projects.templates.launch",
@@ -2203,7 +2208,7 @@
22032208
}
22042209
}
22052210
},
2206-
"revision": "20240709",
2211+
"revision": "20240817",
22072212
"rootUrl": "https://dataflow.googleapis.com/",
22082213
"schemas": {
22092214
"ApproximateProgress": {
@@ -4413,6 +4418,11 @@
44134418
"description": "The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the WorkItem's job.",
44144419
"type": "string"
44154420
},
4421+
"projectNumber": {
4422+
"description": "Optional. The project number of the project this worker belongs to.",
4423+
"format": "int64",
4424+
"type": "string"
4425+
},
44164426
"requestedLeaseDuration": {
44174427
"description": "The initial lease period.",
44184428
"format": "google-duration",
@@ -5375,6 +5385,11 @@
53755385
"description": "The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the WorkItem's job.",
53765386
"type": "string"
53775387
},
5388+
"projectNumber": {
5389+
"description": "Optional. The project number of the project which owns the WorkItem's job.",
5390+
"format": "int64",
5391+
"type": "string"
5392+
},
53785393
"unifiedWorkerRequest": {
53795394
"additionalProperties": {
53805395
"description": "Properties of the object. Contains field @type with type URL.",
@@ -6746,6 +6761,16 @@
67466761
"description": "Map from user step names to state families.",
67476762
"type": "object"
67486763
},
6764+
"userWorkerRunnerV1Settings": {
6765+
"description": "Binary encoded proto to control runtime behavior of the java runner v1 user worker.",
6766+
"format": "byte",
6767+
"type": "string"
6768+
},
6769+
"userWorkerRunnerV2Settings": {
6770+
"description": "Binary encoded proto to control runtime behavior of the runner v2 user worker.",
6771+
"format": "byte",
6772+
"type": "string"
6773+
},
67496774
"windmillServiceEndpoint": {
67506775
"description": "If present, the worker must use this endpoint to communicate with Windmill Service dispatchers, otherwise the worker must continue to use whatever endpoint it had been using.",
67516776
"type": "string"

‎src/apis/dataflow/v1b3.ts

+22-6
Original file line numberDiff line numberDiff line change
@@ -1655,6 +1655,10 @@ export namespace dataflow_v1b3 {
16551655
* The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the WorkItem's job.
16561656
*/
16571657
location?: string | null;
1658+
/**
1659+
* Optional. The project number of the project this worker belongs to.
1660+
*/
1661+
projectNumber?: string | null;
16581662
/**
16591663
* The initial lease period.
16601664
*/
@@ -2345,6 +2349,10 @@ export namespace dataflow_v1b3 {
23452349
* The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the WorkItem's job.
23462350
*/
23472351
location?: string | null;
2352+
/**
2353+
* Optional. The project number of the project which owns the WorkItem's job.
2354+
*/
2355+
projectNumber?: string | null;
23482356
/**
23492357
* Untranslated bag-of-bytes WorkProgressUpdateRequest from UnifiedWorker.
23502358
*/
@@ -3253,6 +3261,14 @@ export namespace dataflow_v1b3 {
32533261
* Map from user step names to state families.
32543262
*/
32553263
userStepToStateFamilyNameMap?: {[key: string]: string} | null;
3264+
/**
3265+
* Binary encoded proto to control runtime behavior of the java runner v1 user worker.
3266+
*/
3267+
userWorkerRunnerV1Settings?: string | null;
3268+
/**
3269+
* Binary encoded proto to control runtime behavior of the runner v2 user worker.
3270+
*/
3271+
userWorkerRunnerV2Settings?: string | null;
32563272
/**
32573273
* If present, the worker must use this endpoint to communicate with Windmill Service dispatchers, otherwise the worker must continue to use whatever endpoint it had been using.
32583274
*/
@@ -8034,7 +8050,7 @@ export namespace dataflow_v1b3 {
80348050
}
80358051

80368052
/**
8037-
* Creates a Cloud Dataflow job from a template. Do not enter confidential information when you supply string values using the API.
8053+
* 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`.
80388054
*
80398055
* @param params - Parameters for request
80408056
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -8122,7 +8138,7 @@ export namespace dataflow_v1b3 {
81228138
}
81238139

81248140
/**
8125-
* Get the template associated with a template.
8141+
* 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.
81268142
*
81278143
* @param params - Parameters for request
81288144
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -8213,7 +8229,7 @@ export namespace dataflow_v1b3 {
82138229
}
82148230

82158231
/**
8216-
* Launch a template.
8232+
* 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`.
82178233
*
82188234
* @param params - Parameters for request
82198235
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -8599,7 +8615,7 @@ export namespace dataflow_v1b3 {
85998615
}
86008616

86018617
/**
8602-
* Creates a Cloud Dataflow job from a template. Do not enter confidential information when you supply string values using the API.
8618+
* 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`.
86038619
*
86048620
* @param params - Parameters for request
86058621
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -8687,7 +8703,7 @@ export namespace dataflow_v1b3 {
86878703
}
86888704

86898705
/**
8690-
* Get the template associated with a template.
8706+
* 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.
86918707
*
86928708
* @param params - Parameters for request
86938709
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -8778,7 +8794,7 @@ export namespace dataflow_v1b3 {
87788794
}
87798795

87808796
/**
8781-
* Launch a template.
8797+
* 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`.
87828798
*
87838799
* @param params - Parameters for request
87848800
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.

0 commit comments

Comments
 (0)
Please sign in to comment.