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 \ V1beta3Methods
__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. |
↳ acceptable_backlog_duration |
Google\Protobuf\Duration
Optional. Deprecated: Use |
↳ autoscaling_tier |
string
Optional. The backlog threshold tier for autoscaling. Value must be one of "low-latency", "medium-latency", or "high-latency". |
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.
For more information, see Update an existing pipeline.
| Returns | |
|---|---|
| Type | Description |
float |
|
hasWorkerUtilizationHint
clearWorkerUtilizationHint
setWorkerUtilizationHint
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.
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAcceptableBacklogDuration
Optional. Deprecated: Use autoscaling_tier instead.
The backlog threshold duration in seconds for autoscaling. Value must be non-negative.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Duration|null |
|
hasAcceptableBacklogDuration
clearAcceptableBacklogDuration
setAcceptableBacklogDuration
Optional. Deprecated: Use autoscaling_tier instead.
The backlog threshold duration in seconds for autoscaling. Value must be non-negative.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Duration
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAutoscalingTier
Optional. The backlog threshold tier for autoscaling. Value must be one of "low-latency", "medium-latency", or "high-latency".
| Returns | |
|---|---|
| Type | Description |
string |
|
hasAutoscalingTier
clearAutoscalingTier
setAutoscalingTier
Optional. The backlog threshold tier for autoscaling. Value must be one of "low-latency", "medium-latency", or "high-latency".
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|