Reference documentation and code samples for the Google Cloud Dataflow V1beta3 Client class RuntimeUpdatableParams.
Additional job parameters that can only be updated during runtime using the
projects.jobs.update method. These fields have no effect when specified
during job creation.
Generated from protobuf message google.dataflow.v1beta3.RuntimeUpdatableParams
Namespace
Google \ Cloud \ Dataflow \ V1beta3
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ max_num_workers
int
The maximum number of workers to cap autoscaling at. This field is currently only supported for Streaming Engine jobs.
↳ min_num_workers
int
The minimum number of workers to scale down to. This field is currently only supported for Streaming Engine jobs.
↳ worker_utilization_hint
float
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.
getMaxNumWorkers
The maximum number of workers to cap autoscaling at. This field is
currently only supported for Streaming Engine jobs.
Returns
Type
Description
int
hasMaxNumWorkers
clearMaxNumWorkers
setMaxNumWorkers
The maximum number of workers to cap autoscaling at. This field is
currently only supported for Streaming Engine jobs.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getMinNumWorkers
The minimum number of workers to scale down to. This field is currently
only supported for Streaming Engine jobs.
Returns
Type
Description
int
hasMinNumWorkers
clearMinNumWorkers
setMinNumWorkers
The minimum number of workers to scale down to. This field is currently
only supported for Streaming Engine jobs.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getWorkerUtilizationHint
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.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Google Cloud Dataflow V1beta3 Client - Class RuntimeUpdatableParams (0.8.2)\n\nVersion latestkeyboard_arrow_down\n\n- [0.8.2 (latest)](/php/docs/reference/cloud-dataflow/latest/V1beta3.RuntimeUpdatableParams)\n- [0.8.1](/php/docs/reference/cloud-dataflow/0.8.1/V1beta3.RuntimeUpdatableParams)\n- [0.7.1](/php/docs/reference/cloud-dataflow/0.7.1/V1beta3.RuntimeUpdatableParams)\n- [0.6.6](/php/docs/reference/cloud-dataflow/0.6.6/V1beta3.RuntimeUpdatableParams)\n- [0.5.1](/php/docs/reference/cloud-dataflow/0.5.1/V1beta3.RuntimeUpdatableParams)\n- [0.4.1](/php/docs/reference/cloud-dataflow/0.4.1/V1beta3.RuntimeUpdatableParams)\n- [0.3.10](/php/docs/reference/cloud-dataflow/0.3.10/V1beta3.RuntimeUpdatableParams) \n| **Beta**\n|\n|\n| This library is covered by the [Pre-GA Offerings Terms](/terms/service-terms#1)\n| of the Terms of Service. Pre-GA libraries might have limited support,\n| and changes to pre-GA libraries might not be compatible with other pre-GA versions.\n| For more information, see the\n[launch stage descriptions](/products#product-launch-stages). \nReference documentation and code samples for the Google Cloud Dataflow V1beta3 Client class RuntimeUpdatableParams.\n\nAdditional job parameters that can only be updated during runtime using the\nprojects.jobs.update method. These fields have no effect when specified\nduring job creation.\n\nGenerated from protobuf message `google.dataflow.v1beta3.RuntimeUpdatableParams`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Dataflow \\\\ V1beta3\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getMaxNumWorkers\n\nThe maximum number of workers to cap autoscaling at. This field is\ncurrently only supported for Streaming Engine jobs.\n\n### hasMaxNumWorkers\n\n### clearMaxNumWorkers\n\n### setMaxNumWorkers\n\nThe maximum number of workers to cap autoscaling at. This field is\ncurrently only supported for Streaming Engine jobs.\n\n### getMinNumWorkers\n\nThe minimum number of workers to scale down to. This field is currently\nonly supported for Streaming Engine jobs.\n\n### hasMinNumWorkers\n\n### clearMinNumWorkers\n\n### setMinNumWorkers\n\nThe minimum number of workers to scale down to. This field is currently\nonly supported for Streaming Engine jobs.\n\n### getWorkerUtilizationHint\n\nTarget worker utilization, compared against the aggregate utilization of\nthe worker pool by autoscaler, to determine upscaling and downscaling when\nabsent other constraints such as backlog.\n\nFor more information, see\n[Update an existing\npipeline](https://cloud.google.com/dataflow/docs/guides/updating-a-pipeline).\n\n### hasWorkerUtilizationHint\n\n### clearWorkerUtilizationHint\n\n### setWorkerUtilizationHint\n\nTarget worker utilization, compared against the aggregate utilization of\nthe worker pool by autoscaler, to determine upscaling and downscaling when\nabsent other constraints such as backlog.\n\nFor more information, see\n[Update an existing\npipeline](https://cloud.google.com/dataflow/docs/guides/updating-a-pipeline)."]]
