Stackdriver Debugger V2 Client - Class StatusMessage (1.6.4)

Reference documentation and code samples for the Stackdriver Debugger V2 Client class StatusMessage.

Represents a contextual status message.

The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the Breakpoint.status field can indicate an error referring to the BREAKPOINT_SOURCE_LOCATION with the message Location not found.

Generated from protobuf message google.devtools.clouddebugger.v2.StatusMessage

Namespace

Google \ Cloud \ Debugger \ V2

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ is_error bool

Distinguishes errors from informational messages.

↳ refers_to int

Reference to which the message applies.

↳ description Google\Cloud\Debugger\V2\FormatMessage

Status message text.

getIsError

Distinguishes errors from informational messages.

Returns
TypeDescription
bool

setIsError

Distinguishes errors from informational messages.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getRefersTo

Reference to which the message applies.

Returns
TypeDescription
int

setRefersTo

Reference to which the message applies.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getDescription

Status message text.

Returns
TypeDescription
Google\Cloud\Debugger\V2\FormatMessage|null

hasDescription

clearDescription

setDescription

Status message text.

Parameter
NameDescription
var Google\Cloud\Debugger\V2\FormatMessage
Returns
TypeDescription
$this