Google Cloud Dataflow V1beta3 Client - Class AutoscalingEvent (0.4.1)

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 \ V1beta3

Methods

__construct

Constructor.

Parameters
NameDescription
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 Google\Cloud\Dataflow\V1beta3\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
TypeDescription
int|string

setCurrentNumWorkers

The current number of workers the job has.

Parameter
NameDescription
var int|string
Returns
TypeDescription
$this

getTargetNumWorkers

The target number of workers the worker pool wants to resize to use.

Returns
TypeDescription
int|string

setTargetNumWorkers

The target number of workers the worker pool wants to resize to use.

Parameter
NameDescription
var int|string
Returns
TypeDescription
$this

getEventType

The type of autoscaling event to report.

Returns
TypeDescription
int

setEventType

The type of autoscaling event to report.

Parameter
NameDescription
var int
Returns
TypeDescription
$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
TypeDescription
Google\Cloud\Dataflow\V1beta3\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
NameDescription
var Google\Cloud\Dataflow\V1beta3\StructuredMessage
Returns
TypeDescription
$this

getTime

The time this event was emitted to indicate a new target or current num_workers value.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasTime

clearTime

setTime

The time this event was emitted to indicate a new target or current num_workers value.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getWorkerPool

A short and friendly name for the worker pool this event refers to.

Returns
TypeDescription
string

setWorkerPool

A short and friendly name for the worker pool this event refers to.

Parameter
NameDescription
var string
Returns
TypeDescription
$this