Google Cloud Workload Manager V1 Client - Class Execution (0.2.1)

Reference documentation and code samples for the Google Cloud Workload Manager V1 Client class Execution.

Execution that represents a single run of an Evaluation.

Generated from protobuf message google.cloud.workloadmanager.v1.Execution

Namespace

Google \ Cloud \ WorkloadManager \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` The name of execution resource. The format is projects/{project}/locations/{location}/evaluations/{evaluation}/executions/{execution}.
`↳ start_time`	`Google\Protobuf\Timestamp` Output only. [Output only] Start time stamp.
`↳ end_time`	`Google\Protobuf\Timestamp` Output only. [Output only] End time stamp.
`↳ inventory_time`	`Google\Protobuf\Timestamp` Output only. [Output only] Inventory time stamp.
`↳ state`	`int` Output only. [Output only] State.
`↳ evaluation_id`	`string` Output only. [Output only] Evaluation ID.
`↳ labels`	`array\|Google\Protobuf\Internal\MapField` Labels as key value pairs.
`↳ run_type`	`int` Type which represents whether the execution executed directly by user or scheduled according to the `Evaluation.schedule` field.
`↳ rule_results`	`array<RuleExecutionResult>` Output only. Execution result summary per rule.
`↳ external_data_sources`	`array<Execution\ExternalDataSources>` Optional. External data sources.
`↳ notices`	`array<Execution\Notice>` Output only. Additional information generated by the execution.
`↳ engine`	`int` Optional. Engine.
`↳ result_summary`	`Execution\Summary` Output only. [Output only] Result summary for the execution.

getName

The name of execution resource. The format is projects/{project}/locations/{location}/evaluations/{evaluation}/executions/{execution}.

Returns
Type	Description
`string`

setName

The name of execution resource. The format is projects/{project}/locations/{location}/evaluations/{evaluation}/executions/{execution}.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getStartTime

Output only. [Output only] Start time stamp.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasStartTime

clearStartTime

setStartTime

Output only. [Output only] Start time stamp.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getEndTime

Output only. [Output only] End time stamp.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasEndTime

clearEndTime

setEndTime

Output only. [Output only] End time stamp.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getInventoryTime

Output only. [Output only] Inventory time stamp.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasInventoryTime

clearInventoryTime

setInventoryTime

Output only. [Output only] Inventory time stamp.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getState

Output only. [Output only] State.

Returns
Type	Description
`int`	Enum of type State.

setState

Output only. [Output only] State.

Parameter
Name	Description
`var`	`int` Enum of type State.

Returns
Type	Description
`$this`

getEvaluationId

Output only. [Output only] Evaluation ID.

Returns
Type	Description
`string`

setEvaluationId

Output only. [Output only] Evaluation ID.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getLabels

Labels as key value pairs.

Returns
Type	Description
`Google\Protobuf\Internal\MapField`

setLabels

Labels as key value pairs.

Parameter
Name	Description
`var`	`array\|Google\Protobuf\Internal\MapField`

Returns
Type	Description
`$this`

getRunType

Type which represents whether the execution executed directly by user or scheduled according to the Evaluation.schedule field.

Returns
Type	Description
`int`	Enum of type Type.

setRunType