Class Breakpoint (1.6.1)

Version 1.6.1

• 1.7.0 (latest)
• 1.6.1
• 1.5.0
• 1.4.3
• 1.3.2
• 1.2.1
• 1.1.0
• 1.0.2
• 0.1.5

Breakpoint(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Represents the breakpoint specification, status and results.

Attributes
Name	Description
id	str Breakpoint identifier, unique in the scope of the debuggee.
action	google.cloud.debugger_v2.types.Breakpoint.Action Action that the agent should perform when the code at the breakpoint location is hit.
location	google.cloud.debugger_v2.types.SourceLocation Breakpoint source location.
condition	str Condition that triggers the breakpoint. The condition is a compound boolean expression composed using expressions in a programming language at the source location.
expressions	MutableSequence[str] 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	str 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	google.cloud.debugger_v2.types.Breakpoint.LogLevel 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	google.protobuf.timestamp_pb2.Timestamp Time this breakpoint was created by the server in seconds resolution.
final_time	google.protobuf.timestamp_pb2.Timestamp Time this breakpoint was finalized as seen by the server in seconds resolution.
user_email	str E-mail address of the user that created this breakpoint
status	google.cloud.debugger_v2.types.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	MutableSequence[google.cloud.debugger_v2.types.StackFrame] The stack at breakpoint time, where stack_frames[0] represents the most recently entered function.
evaluated_expressions	MutableSequence[google.cloud.debugger_v2.types.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	MutableSequence[google.cloud.debugger_v2.types.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	MutableMapping[str, str] A set of custom breakpoint properties, populated by the agent, to be displayed to the user.

Classes

Action

Action(value)

Actions that can be taken when a breakpoint hits. Agents should reject breakpoints with unsupported or unknown action values.

Values: CAPTURE (0): Capture stack frame and variables and update the breakpoint. The data is only captured once. After that the breakpoint is set in a final state. LOG (1): Log each breakpoint hit. The breakpoint remains active until deleted or expired.

LabelsEntry

LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name	Description
kwargs	dict Keys and values corresponding to the fields of the message.
mapping	Union[dict, .Message] A dictionary or message to be used to determine the values for this message.
ignore_unknown_fields	Optional(bool) If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.

LogLevel

LogLevel(value)

Log severity levels.

Values: INFO (0): Information log message. WARNING (1): Warning log message. ERROR (2): Error log message.