Reference documentation and code samples for the Stackdriver Debugger V2 Client class FormatMessage.
Represents a message with parameters.
Generated from protobuf message google.devtools.clouddebugger.v2.FormatMessage
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ format |
string
Format template for the message. The |
↳ parameters |
array
Optional parameters to be embedded into the message. |
getFormat
Format template for the message. The format uses placeholders $0,
$1, etc. to reference parameters. $$ can be used to denote the $
character.
Examples:
Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important.Please pay $$10 to use $0 instead of $1.
| Returns | |
|---|---|
| Type | Description |
string | |
setFormat
Format template for the message. The format uses placeholders $0,
$1, etc. to reference parameters. $$ can be used to denote the $
character.
Examples:
Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important.Please pay $$10 to use $0 instead of $1.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getParameters
Optional parameters to be embedded into the message.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setParameters
Optional parameters to be embedded into the message.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this | |