Class: Google::Cloud::Debugger::V2::Breakpoint
- Inherits:
-
Object
- Object
- Google::Cloud::Debugger::V2::Breakpoint
- Extended by:
- Protobuf::MessageExts::ClassMethods
- Includes:
- Protobuf::MessageExts
- Defined in:
- proto_docs/google/devtools/clouddebugger/v2/data.rb
Overview
Represents the breakpoint specification, status and results.
Defined Under Namespace
Modules: Action, LogLevel Classes: LabelsEntry
Instance Attribute Summary collapse
-
#action ⇒ ::Google::Cloud::Debugger::V2::Breakpoint::Action
Action that the agent should perform when the code at the breakpoint location is hit.
-
#condition ⇒ ::String
Condition that triggers the breakpoint.
-
#create_time ⇒ ::Google::Protobuf::Timestamp
Time this breakpoint was created by the server in seconds resolution.
-
#evaluated_expressions ⇒ ::Array<::Google::Cloud::Debugger::V2::Variable>
Values of evaluated expressions at breakpoint time.
-
#expressions ⇒ ::Array<::String>
List of read-only expressions to evaluate at the breakpoint location.
-
#final_time ⇒ ::Google::Protobuf::Timestamp
Time this breakpoint was finalized as seen by the server in seconds resolution.
-
#id ⇒ ::String
Breakpoint identifier, unique in the scope of the debuggee.
-
#is_final_state ⇒ ::Boolean
When true, indicates that this is a final result and the breakpoint state will not change from here on.
-
#labels ⇒ ::Google::Protobuf::Map{::String => ::String}
A set of custom breakpoint properties, populated by the agent, to be displayed to the user.
-
#location ⇒ ::Google::Cloud::Debugger::V2::SourceLocation
Breakpoint source location.
-
#log_level ⇒ ::Google::Cloud::Debugger::V2::Breakpoint::LogLevel
Indicates the severity of the log.
-
#log_message_format ⇒ ::String
Only relevant when action is
LOG
. -
#stack_frames ⇒ ::Array<::Google::Cloud::Debugger::V2::StackFrame>
The stack at breakpoint time, where stack_frames[0] represents the most recently entered function.
-
#status ⇒ ::Google::Cloud::Debugger::V2::StatusMessage
Breakpoint status.
-
#user_email ⇒ ::String
E-mail address of the user that created this breakpoint.
-
#variable_table ⇒ ::Array<::Google::Cloud::Debugger::V2::Variable>
The
variable_table
exists to aid with computation, memory and network traffic optimization.
Instance Attribute Details
#action ⇒ ::Google::Cloud::Debugger::V2::Breakpoint::Action
Returns Action that the agent should perform when the code at the breakpoint location is hit.
376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 |
# File 'proto_docs/google/devtools/clouddebugger/v2/data.rb', line 376 class Breakpoint include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Actions that can be taken when a breakpoint hits. # Agents should reject breakpoints with unsupported or unknown action values. module Action # 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. CAPTURE = 0 # Log each breakpoint hit. The breakpoint remains active until # deleted or expired. LOG = 1 end # Log severity levels. module LogLevel # Information log message. INFO = 0 # Warning log message. WARNING = 1 # Error log message. ERROR = 2 end end |
#condition ⇒ ::String
Returns Condition that triggers the breakpoint. The condition is a compound boolean expression composed using expressions in a programming language at the source location.
376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 |
# File 'proto_docs/google/devtools/clouddebugger/v2/data.rb', line 376 class Breakpoint include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Actions that can be taken when a breakpoint hits. # Agents should reject breakpoints with unsupported or unknown action values. module Action # 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. CAPTURE = 0 # Log each breakpoint hit. The breakpoint remains active until # deleted or expired. LOG = 1 end # Log severity levels. module LogLevel # Information log message. INFO = 0 # Warning log message. WARNING = 1 # Error log message. ERROR = 2 end end |
#create_time ⇒ ::Google::Protobuf::Timestamp
Returns Time this breakpoint was created by the server in seconds resolution.
376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 |
# File 'proto_docs/google/devtools/clouddebugger/v2/data.rb', line 376 class Breakpoint include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Actions that can be taken when a breakpoint hits. # Agents should reject breakpoints with unsupported or unknown action values. module Action # 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. CAPTURE = 0 # Log each breakpoint hit. The breakpoint remains active until # deleted or expired. LOG = 1 end # Log severity levels. module LogLevel # Information log message. INFO = 0 # Warning log message. WARNING = 1 # Error log message. ERROR = 2 end end |
#evaluated_expressions ⇒ ::Array<::Google::Cloud::Debugger::V2::Variable>
Returns 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.
376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 |
# File 'proto_docs/google/devtools/clouddebugger/v2/data.rb', line 376 class Breakpoint include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Actions that can be taken when a breakpoint hits. # Agents should reject breakpoints with unsupported or unknown action values. module Action # 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. CAPTURE = 0 # Log each breakpoint hit. The breakpoint remains active until # deleted or expired. LOG = 1 end # Log severity levels. module LogLevel # Information log message. INFO = 0 # Warning log message. WARNING = 1 # Error log message. ERROR = 2 end end |
#expressions ⇒ ::Array<::String>
Returns 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.
376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 |
# File 'proto_docs/google/devtools/clouddebugger/v2/data.rb', line 376 class Breakpoint include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Actions that can be taken when a breakpoint hits. # Agents should reject breakpoints with unsupported or unknown action values. module Action # 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. CAPTURE = 0 # Log each breakpoint hit. The breakpoint remains active until # deleted or expired. LOG = 1 end # Log severity levels. module LogLevel # Information log message. INFO = 0 # Warning log message. WARNING = 1 # Error log message. ERROR = 2 end end |
#final_time ⇒ ::Google::Protobuf::Timestamp
Returns Time this breakpoint was finalized as seen by the server in seconds resolution.
376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 |
# File 'proto_docs/google/devtools/clouddebugger/v2/data.rb', line 376 class Breakpoint include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Actions that can be taken when a breakpoint hits. # Agents should reject breakpoints with unsupported or unknown action values. module Action # 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. CAPTURE = 0 # Log each breakpoint hit. The breakpoint remains active until # deleted or expired. LOG = 1 end # Log severity levels. module LogLevel # Information log message. INFO = 0 # Warning log message. WARNING = 1 # Error log message. ERROR = 2 end end |
#id ⇒ ::String
Returns Breakpoint identifier, unique in the scope of the debuggee.
376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 |
# File 'proto_docs/google/devtools/clouddebugger/v2/data.rb', line 376 class Breakpoint include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Actions that can be taken when a breakpoint hits. # Agents should reject breakpoints with unsupported or unknown action values. module Action # 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. CAPTURE = 0 # Log each breakpoint hit. The breakpoint remains active until # deleted or expired. LOG = 1 end # Log severity levels. module LogLevel # Information log message. INFO = 0 # Warning log message. WARNING = 1 # Error log message. ERROR = 2 end end |
#is_final_state ⇒ ::Boolean
Returns When true, indicates that this is a final result and the breakpoint state will not change from here on.
376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 |
# File 'proto_docs/google/devtools/clouddebugger/v2/data.rb', line 376 class Breakpoint include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Actions that can be taken when a breakpoint hits. # Agents should reject breakpoints with unsupported or unknown action values. module Action # 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. CAPTURE = 0 # Log each breakpoint hit. The breakpoint remains active until # deleted or expired. LOG = 1 end # Log severity levels. module LogLevel # Information log message. INFO = 0 # Warning log message. WARNING = 1 # Error log message. ERROR = 2 end end |
#labels ⇒ ::Google::Protobuf::Map{::String => ::String}
Returns A set of custom breakpoint properties, populated by the agent, to be displayed to the user.
376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 |
# File 'proto_docs/google/devtools/clouddebugger/v2/data.rb', line 376 class Breakpoint include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Actions that can be taken when a breakpoint hits. # Agents should reject breakpoints with unsupported or unknown action values. module Action # 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. CAPTURE = 0 # Log each breakpoint hit. The breakpoint remains active until # deleted or expired. LOG = 1 end # Log severity levels. module LogLevel # Information log message. INFO = 0 # Warning log message. WARNING = 1 # Error log message. ERROR = 2 end end |
#location ⇒ ::Google::Cloud::Debugger::V2::SourceLocation
Returns Breakpoint source location.
376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 |
# File 'proto_docs/google/devtools/clouddebugger/v2/data.rb', line 376 class Breakpoint include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Actions that can be taken when a breakpoint hits. # Agents should reject breakpoints with unsupported or unknown action values. module Action # 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. CAPTURE = 0 # Log each breakpoint hit. The breakpoint remains active until # deleted or expired. LOG = 1 end # Log severity levels. module LogLevel # Information log message. INFO = 0 # Warning log message. WARNING = 1 # Error log message. ERROR = 2 end end |
#log_level ⇒ ::Google::Cloud::Debugger::V2::Breakpoint::LogLevel
Returns Indicates the severity of the log. Only relevant when action is LOG
.
376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 |
# File 'proto_docs/google/devtools/clouddebugger/v2/data.rb', line 376 class Breakpoint include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Actions that can be taken when a breakpoint hits. # Agents should reject breakpoints with unsupported or unknown action values. module Action # 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. CAPTURE = 0 # Log each breakpoint hit. The breakpoint remains active until # deleted or expired. LOG = 1 end # Log severity levels. module LogLevel # Information log message. INFO = 0 # Warning log message. WARNING = 1 # Error log message. ERROR = 2 end end |
#log_message_format ⇒ ::String
Returns 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 ]
.
376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 |
# File 'proto_docs/google/devtools/clouddebugger/v2/data.rb', line 376 class Breakpoint include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Actions that can be taken when a breakpoint hits. # Agents should reject breakpoints with unsupported or unknown action values. module Action # 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. CAPTURE = 0 # Log each breakpoint hit. The breakpoint remains active until # deleted or expired. LOG = 1 end # Log severity levels. module LogLevel # Information log message. INFO = 0 # Warning log message. WARNING = 1 # Error log message. ERROR = 2 end end |
#stack_frames ⇒ ::Array<::Google::Cloud::Debugger::V2::StackFrame>
Returns The stack at breakpoint time, where stack_frames[0] represents the most recently entered function.
376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 |
# File 'proto_docs/google/devtools/clouddebugger/v2/data.rb', line 376 class Breakpoint include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Actions that can be taken when a breakpoint hits. # Agents should reject breakpoints with unsupported or unknown action values. module Action # 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. CAPTURE = 0 # Log each breakpoint hit. The breakpoint remains active until # deleted or expired. LOG = 1 end # Log severity levels. module LogLevel # Information log message. INFO = 0 # Warning log message. WARNING = 1 # Error log message. ERROR = 2 end end |
#status ⇒ ::Google::Cloud::Debugger::V2::StatusMessage
Returns 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.
376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 |
# File 'proto_docs/google/devtools/clouddebugger/v2/data.rb', line 376 class Breakpoint include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Actions that can be taken when a breakpoint hits. # Agents should reject breakpoints with unsupported or unknown action values. module Action # 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. CAPTURE = 0 # Log each breakpoint hit. The breakpoint remains active until # deleted or expired. LOG = 1 end # Log severity levels. module LogLevel # Information log message. INFO = 0 # Warning log message. WARNING = 1 # Error log message. ERROR = 2 end end |
#user_email ⇒ ::String
Returns E-mail address of the user that created this breakpoint.
376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 |
# File 'proto_docs/google/devtools/clouddebugger/v2/data.rb', line 376 class Breakpoint include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Actions that can be taken when a breakpoint hits. # Agents should reject breakpoints with unsupported or unknown action values. module Action # 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. CAPTURE = 0 # Log each breakpoint hit. The breakpoint remains active until # deleted or expired. LOG = 1 end # Log severity levels. module LogLevel # Information log message. INFO = 0 # Warning log message. WARNING = 1 # Error log message. ERROR = 2 end end |
#variable_table ⇒ ::Array<::Google::Cloud::Debugger::V2::Variable>
Returns 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.
376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 |
# File 'proto_docs/google/devtools/clouddebugger/v2/data.rb', line 376 class Breakpoint include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Actions that can be taken when a breakpoint hits. # Agents should reject breakpoints with unsupported or unknown action values. module Action # 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. CAPTURE = 0 # Log each breakpoint hit. The breakpoint remains active until # deleted or expired. LOG = 1 end # Log severity levels. module LogLevel # Information log message. INFO = 0 # Warning log message. WARNING = 1 # Error log message. ERROR = 2 end end |