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
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
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 | |
|---|---|
| Type | Description |
bool | |
setIsError
Distinguishes errors from informational messages.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getRefersTo
Reference to which the message applies.
| Returns | |
|---|---|
| Type | Description |
int | |
setRefersTo
Reference to which the message applies.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDescription
Status message text.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Debugger\V2\FormatMessage|null | |
hasDescription
clearDescription
setDescription
Status message text.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Debugger\V2\FormatMessage
|
| Returns | |
|---|---|
| Type | Description |
$this | |