Reference documentation and code samples for the Stackdriver Debugger V2 Client class Breakpoint.
Represents the breakpoint specification, status and results.
Generated from protobuf message google.devtools.clouddebugger.v2.Breakpoint
Namespace
Google \ Cloud \ Debugger \ V2Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ id
string
Breakpoint identifier, unique in the scope of the debuggee.
↳ action
int
Action that the agent should perform when the code at the breakpoint location is hit.
↳ location
↳ condition
string
Condition that triggers the breakpoint. The condition is a compound boolean expression composed using expressions in a programming language at the source location.
↳ expressions
array
List of read-only expressions to evaluate at the breakpoint location. The expressions are composed using expressions in the programming language at the source location. If the breakpoint action is LOG
, the evaluated expressions are included in log statements.
↳ log_message_format
string
Only relevant when action is LOG
. Defines the message to log when the breakpoint hits. The message may include parameter placeholders $0
, $1
, etc. These placeholders are replaced with the evaluated value of the appropriate expression. Expressions not referenced in log_message_format
are not logged. Example: Message received, id = $0, count = $1
with expressions
= [ message.id, message.count ]
.
↳ log_level
int
Indicates the severity of the log. Only relevant when action is LOG
.
↳ is_final_state
bool
When true, indicates that this is a final result and the breakpoint state will not change from here on.
↳ create_time
↳ final_time
Google\Protobuf\Timestamp
Time this breakpoint was finalized as seen by the server in seconds resolution.
↳ user_email
string
E-mail address of the user that created this breakpoint
↳ status
Google\Cloud\Debugger\V2\StatusMessage
Breakpoint status. The status includes an error flag and a human readable message. This field is usually unset. The message can be either informational or an error message. Regardless, clients should always display the text message back to the user. Error status indicates complete failure of the breakpoint. Example (non-final state): Still loading symbols...
Examples (final state): * Invalid line number
referring to location * Field f not found in class C
referring to condition
↳ stack_frames
array< Google\Cloud\Debugger\V2\StackFrame
>
The stack at breakpoint time, where stack_frames[0] represents the most recently entered function.
↳ evaluated_expressions
array< Google\Cloud\Debugger\V2\Variable
>
Values of evaluated expressions at breakpoint time. The evaluated expressions appear in exactly the same order they are listed in the expressions
field. The name
field holds the original expression text, the value
or members
field holds the result of the evaluated expression. If the expression cannot be evaluated, the status
inside the Variable
will indicate an error and contain the error text.
↳ variable_table
array< Google\Cloud\Debugger\V2\Variable
>
The variable_table
exists to aid with computation, memory and network traffic optimization. It enables storing a variable once and reference it from multiple variables, including variables stored in the variable_table
itself. For example, the same this
object, which may appear at many levels of the stack, can have all of its data stored once in this table. The stack frame variables then would hold only a reference to it. The variable var_table_index
field is an index into this repeated field. The stored objects are nameless and get their name from the referencing variable. The effective variable is a merge of the referencing variable and the referenced variable.
↳ labels
array| Google\Protobuf\Internal\MapField
A set of custom breakpoint properties, populated by the agent, to be displayed to the user.
getId
Breakpoint identifier, unique in the scope of the debuggee.
string
setId
Breakpoint identifier, unique in the scope of the debuggee.
var
string
$this
getAction
Action that the agent should perform when the code at the breakpoint location is hit.
int
setAction
Action that the agent should perform when the code at the breakpoint location is hit.
var
int
$this
getLocation
Breakpoint source location.
hasLocation
clearLocation
setLocation
Breakpoint source location.
$this
getCondition
Condition that triggers the breakpoint.
The condition is a compound boolean expression composed using expressions in a programming language at the source location.
string
setCondition
Condition that triggers the breakpoint.
The condition is a compound boolean expression composed using expressions in a programming language at the source location.
var
string
$this
getExpressions
List of read-only expressions to evaluate at the breakpoint location.
The expressions are composed using expressions in the programming language
at the source location. If the breakpoint action is LOG
, the evaluated
expressions are included in log statements.
setExpressions
List of read-only expressions to evaluate at the breakpoint location.
The expressions are composed using expressions in the programming language
at the source location. If the breakpoint action is LOG
, the evaluated
expressions are included in log statements.
var
string[]
$this
getLogMessageFormat
Only relevant when action is LOG
. Defines the message to log when
the breakpoint hits. The message may include parameter placeholders $0
, $1
, etc. These placeholders are replaced with the evaluated value
of the appropriate expression. Expressions not referenced in log_message_format
are not logged.
Example: Message received, id = $0, count = $1
with expressions
= [ message.id, message.count ]
.
string
setLogMessageFormat
Only relevant when action is LOG
. Defines the message to log when
the breakpoint hits. The message may include parameter placeholders $0
, $1
, etc. These placeholders are replaced with the evaluated value
of the appropriate expression. Expressions not referenced in log_message_format
are not logged.
Example: Message received, id = $0, count = $1
with expressions
= [ message.id, message.count ]
.
var
string
$this
getLogLevel
Indicates the severity of the log. Only relevant when action is LOG
.
int
setLogLevel
Indicates the severity of the log. Only relevant when action is LOG
.
var
int
$this
getIsFinalState
When true, indicates that this is a final result and the breakpoint state will not change from here on.
bool
setIsFinalState
When true, indicates that this is a final result and the breakpoint state will not change from here on.
var
bool
$this
getCreateTime
Time this breakpoint was created by the server in seconds resolution.
hasCreateTime
clearCreateTime
setCreateTime
Time this breakpoint was created by the server in seconds resolution.
$this
getFinalTime
Time this breakpoint was finalized as seen by the server in seconds resolution.
hasFinalTime
clearFinalTime
setFinalTime
Time this breakpoint was finalized as seen by the server in seconds resolution.
$this
getUserEmail
E-mail address of the user that created this breakpoint
string
setUserEmail
E-mail address of the user that created this breakpoint
var
string
$this
getStatus
Breakpoint status.
The status includes an error flag and a human readable message.
This field is usually unset. The message can be either
informational or an error message. Regardless, clients should always
display the text message back to the user.
Error status indicates complete failure of the breakpoint.
Example (non-final state): Still loading symbols...
Examples (final state):
-
Invalid line numberreferring to location -
Field f not found in class Creferring to condition
hasStatus
clearStatus
setStatus
Breakpoint status.
The status includes an error flag and a human readable message.
This field is usually unset. The message can be either
informational or an error message. Regardless, clients should always
display the text message back to the user.
Error status indicates complete failure of the breakpoint.
Example (non-final state): Still loading symbols...
Examples (final state):
-
Invalid line numberreferring to location -
Field f not found in class Creferring to condition
$this
getStackFrames
The stack at breakpoint time, where stack_frames[0] represents the most recently entered function.
setStackFrames
The stack at breakpoint time, where stack_frames[0] represents the most recently entered function.
$this
getEvaluatedExpressions
Values of evaluated expressions at breakpoint time.
The evaluated expressions appear in exactly the same order they
are listed in the expressions
field.
The name
field holds the original expression text, the value
or members
field holds the result of the evaluated expression.
If the expression cannot be evaluated, the status
inside the Variable
will indicate an error and contain the error text.
setEvaluatedExpressions
Values of evaluated expressions at breakpoint time.
The evaluated expressions appear in exactly the same order they
are listed in the expressions
field.
The name
field holds the original expression text, the value
or members
field holds the result of the evaluated expression.
If the expression cannot be evaluated, the status
inside the Variable
will indicate an error and contain the error text.
$this
getVariableTable
The variable_table
exists to aid with computation, memory and network
traffic optimization. It enables storing a variable once and reference
it from multiple variables, including variables stored in the variable_table
itself.
For example, the same this
object, which may appear at many levels of
the stack, can have all of its data stored once in this table. The
stack frame variables then would hold only a reference to it.
The variable var_table_index
field is an index into this repeated field.
The stored objects are nameless and get their name from the referencing
variable. The effective variable is a merge of the referencing variable
and the referenced variable.
setVariableTable
The variable_table
exists to aid with computation, memory and network
traffic optimization. It enables storing a variable once and reference
it from multiple variables, including variables stored in the variable_table
itself.
For example, the same this
object, which may appear at many levels of
the stack, can have all of its data stored once in this table. The
stack frame variables then would hold only a reference to it.
The variable var_table_index
field is an index into this repeated field.
The stored objects are nameless and get their name from the referencing
variable. The effective variable is a merge of the referencing variable
and the referenced variable.
$this
getLabels
A set of custom breakpoint properties, populated by the agent, to be displayed to the user.
setLabels
A set of custom breakpoint properties, populated by the agent, to be displayed to the user.
$this
