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
Namespace
Google \ Cloud \ Debugger \ V2
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ format
string
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.
↳ 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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Stackdriver Debugger V2 Client - Class FormatMessage (1.9.5)\n\nVersion latestkeyboard_arrow_down\n\n- [1.9.5 (latest)](/php/docs/reference/cloud-debugger/latest/V2.FormatMessage)\n- [1.9.4](/php/docs/reference/cloud-debugger/1.9.4/V2.FormatMessage)\n- [1.8.8](/php/docs/reference/cloud-debugger/1.8.8/V2.FormatMessage)\n- [1.7.0](/php/docs/reference/cloud-debugger/1.7.0/V2.FormatMessage)\n- [1.6.4](/php/docs/reference/cloud-debugger/1.6.4/V2.FormatMessage)\n- [1.5.1](/php/docs/reference/cloud-debugger/1.5.1/V2.FormatMessage)\n- [1.4.16](/php/docs/reference/cloud-debugger/1.4.16/V2.FormatMessage) \nReference documentation and code samples for the Stackdriver Debugger V2 Client class FormatMessage.\n\nRepresents a message with parameters.\n\nGenerated from protobuf message `google.devtools.clouddebugger.v2.FormatMessage`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Debugger \\\\ V2\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getFormat\n\nFormat template for the message. The `format` uses placeholders `$0`,\n`$1`, etc. to reference parameters. `$$` can be used to denote the `$`\ncharacter.\n\nExamples:\n\n- `Failed to load '$0' which helps debug $1 the first time it\n is loaded. Again, $0 is very important.`\n- `Please pay $$10 to use $0 instead of $1.`\n\n### setFormat\n\nFormat template for the message. The `format` uses placeholders `$0`,\n`$1`, etc. to reference parameters. `$$` can be used to denote the `$`\ncharacter.\n\nExamples:\n\n- `Failed to load '$0' which helps debug $1 the first time it\n is loaded. Again, $0 is very important.`\n- `Please pay $$10 to use $0 instead of $1.`\n\n### getParameters\n\nOptional parameters to be embedded into the message.\n\n### setParameters\n\nOptional parameters to be embedded into the message."]]
