Reference documentation and code samples for the Google Cloud Batch V1 Client class StatusEvent.
Status event.
Generated from protobuf message google.cloud.batch.v1.StatusEvent
Namespace
Google \ Cloud \ Batch \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ type |
string
Type of the event. |
↳ description |
string
Description of the event. |
↳ event_time |
Google\Protobuf\Timestamp
The time this event occurred. |
↳ task_execution |
Google\Cloud\Batch\V1\TaskExecution
Task Execution. This field is only defined for task-level status events where the task fails. |
↳ task_state |
int
Task State. This field is only defined for task-level status events. |
getType
Type of the event.
| Returns | |
|---|---|
| Type | Description |
string |
|
setType
Type of the event.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDescription
Description of the event.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDescription
Description of the event.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEventTime
The time this event occurred.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasEventTime
clearEventTime
setEventTime
The time this event occurred.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTaskExecution
Task Execution.
This field is only defined for task-level status events where the task fails.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Batch\V1\TaskExecution|null |
|
hasTaskExecution
clearTaskExecution
setTaskExecution
Task Execution.
This field is only defined for task-level status events where the task fails.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Batch\V1\TaskExecution
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTaskState
Task State.
This field is only defined for task-level status events.
| Returns | |
|---|---|
| Type | Description |
int |
|
setTaskState
Task State.
This field is only defined for task-level status events.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|