Google Cloud Workflows V1 Client - Class Error (0.3.0)

Reference documentation and code samples for the Google Cloud Workflows V1 Client class Error.

Error describes why the execution was abnormally terminated.

Generated from protobuf message google.cloud.workflows.executions.v1.Execution.Error

Namespace

Google \ Cloud \ Workflows \ Executions \ V1 \ Execution

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ payload string

Error message and data returned represented as a JSON string.

↳ context string

Human-readable stack trace string.

↳ stack_trace Google\Cloud\Workflows\Executions\V1\Execution\StackTrace

Stack trace with detailed information of where error was generated.

getPayload

Error message and data returned represented as a JSON string.

Returns
TypeDescription
string

setPayload

Error message and data returned represented as a JSON string.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getContext

Human-readable stack trace string.

Returns
TypeDescription
string

setContext

Human-readable stack trace string.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getStackTrace

Stack trace with detailed information of where error was generated.

Returns
TypeDescription
Google\Cloud\Workflows\Executions\V1\Execution\StackTrace|null

hasStackTrace

clearStackTrace

setStackTrace

Stack trace with detailed information of where error was generated.

Parameter
NameDescription
var Google\Cloud\Workflows\Executions\V1\Execution\StackTrace
Returns
TypeDescription
$this