Reference documentation and code samples for the Google Cloud Dataflow V1beta3 Client class AutoscalingEvent.
A structured message reporting an autoscaling decision made by the Dataflow service.
Generated from protobuf message google.dataflow.v1beta3.AutoscalingEvent
Namespace
Google \ Cloud \ Dataflow \ V1beta3Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ current_num_workers |
int|string
The current number of workers the job has. |
↳ target_num_workers |
int|string
The target number of workers the worker pool wants to resize to use. |
↳ event_type |
int
The type of autoscaling event to report. |
↳ description |
StructuredMessage
A message describing why the system decided to adjust the current number of workers, why it failed, or why the system decided to not make any changes to the number of workers. |
↳ time |
Google\Protobuf\Timestamp
The time this event was emitted to indicate a new target or current num_workers value. |
↳ worker_pool |
string
A short and friendly name for the worker pool this event refers to. |
getCurrentNumWorkers
The current number of workers the job has.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
setCurrentNumWorkers
The current number of workers the job has.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTargetNumWorkers
The target number of workers the worker pool wants to resize to use.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
setTargetNumWorkers
The target number of workers the worker pool wants to resize to use.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEventType
The type of autoscaling event to report.
| Returns | |
|---|---|
| Type | Description |
int |
|
setEventType
The type of autoscaling event to report.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDescription
A message describing why the system decided to adjust the current number of workers, why it failed, or why the system decided to not make any changes to the number of workers.
| Returns | |
|---|---|
| Type | Description |
StructuredMessage|null |
|
hasDescription
clearDescription
setDescription
A message describing why the system decided to adjust the current number of workers, why it failed, or why the system decided to not make any changes to the number of workers.
| Parameter | |
|---|---|
| Name | Description |
var |
StructuredMessage
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTime
The time this event was emitted to indicate a new target or current num_workers value.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasTime
clearTime
setTime
The time this event was emitted to indicate a new target or current num_workers value.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getWorkerPool
A short and friendly name for the worker pool this event refers to.
| Returns | |
|---|---|
| Type | Description |
string |
|
setWorkerPool
A short and friendly name for the worker pool this event refers to.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|