Skip to content

Commit 5ffe5e5

Browse files
Update template parameters documentation (#10545) (#7301)
[upstream:2abb74f38b67c029192384957da4a3fe9c9ce093] Signed-off-by: Modular Magician <[email protected]>
1 parent fcbbe94 commit 5ffe5e5

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

website/docs/r/dataflow_flex_template_job.html.markdown

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -95,9 +95,9 @@ Template.
9595

9696
* `autoscaling_algorithm` - (Optional) The algorithm to use for autoscaling.
9797

98-
* `parameters` - (Optional) Key/Value pairs to be passed to the Dataflow job (as
99-
used in the template). Additional [pipeline options](https://cloud.google.com/dataflow/docs/guides/specifying-exec-params#setting-other-cloud-dataflow-pipeline-options)
100-
such as `serviceAccount`, `workerMachineType`, etc can be specified here.
98+
* `parameters` - **Template specific** Key/Value pairs to be forwarded to the pipeline's options; keys are
99+
case-sensitive based on the language on which the pipeline is coded, mostly Java.
100+
**Note**: do not configure Dataflow options here in parameters.
101101

102102
* `enable_streaming_engine` - (Optional) Immutable. Indicates if the job should use the streaming engine feature.
103103

website/docs/r/dataflow_job.html.markdown

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,9 @@ The following arguments are supported:
9999

100100
- - -
101101

102-
* `parameters` - (Optional) Key/Value pairs to be passed to the Dataflow job (as used in the template).
102+
* `parameters` - **Template specific** Key/Value pairs to be forwarded to the pipeline's options; keys are
103+
case-sensitive based on the language on which the pipeline is coded, mostly Java.
104+
**Note**: do not configure Dataflow options here in parameters.
103105
* `labels` - (Optional) User labels to be specified for the job. Keys and values should follow the restrictions
104106
specified in the [labeling restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions) page.
105107
**Note**: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field `effective_labels` for all of the labels present on the resource.

0 commit comments

Comments
 (0)