Class: Google::Apis::ClouddebuggerV2::Breakpoint
- Inherits:
-
Object
- Object
- Google::Apis::ClouddebuggerV2::Breakpoint
- Defined in:
- generated/google/apis/clouddebugger_v2/classes.rb,
generated/google/apis/clouddebugger_v2/representations.rb,
generated/google/apis/clouddebugger_v2/representations.rb
Overview
Represents the breakpoint specification, status and results.
Instance Attribute Summary collapse
-
#action ⇒ String
Action that the agent should perform when the code at the breakpoint location is hit.
-
#condition ⇒ String
Condition that triggers the breakpoint.
-
#create_time ⇒ String
Time this breakpoint was created by the server in seconds resolution.
-
#evaluated_expressions ⇒ Array<Google::Apis::ClouddebuggerV2::Variable>
Values of evaluated expressions at breakpoint time.
-
#expressions ⇒ Array<String>
List of read-only expressions to evaluate at the breakpoint location.
-
#final_time ⇒ String
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
(also: #is_final_state?)
When true, indicates that this is a final result and the breakpoint state will not change from here on.
-
#labels ⇒ Hash<String,String>
A set of custom breakpoint properties, populated by the agent, to be displayed to the user.
-
#location ⇒ Google::Apis::ClouddebuggerV2::SourceLocation
Represents a location in the source code.
-
#log_level ⇒ String
Indicates the severity of the log.
-
#log_message_format ⇒ String
Only relevant when action is
LOG
. -
#stack_frames ⇒ Array<Google::Apis::ClouddebuggerV2::StackFrame>
The stack at breakpoint time.
-
#status ⇒ Google::Apis::ClouddebuggerV2::StatusMessage
Represents a contextual status message.
-
#user_email ⇒ String
E-mail address of the user that created this breakpoint Corresponds to the JSON property
userEmail
. -
#variable_table ⇒ Array<Google::Apis::ClouddebuggerV2::Variable>
The
variable_table
exists to aid with computation, memory and network traffic optimization.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Breakpoint
constructor
A new instance of Breakpoint.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Google::Apis::Core::JsonObjectSupport
Methods included from Google::Apis::Core::Hashable
Constructor Details
#initialize(**args) ⇒ Breakpoint
Returns a new instance of Breakpoint
170 171 172 |
# File 'generated/google/apis/clouddebugger_v2/classes.rb', line 170 def initialize(**args) update!(**args) end |
Instance Attribute Details
#action ⇒ String
Action that the agent should perform when the code at the
breakpoint location is hit.
Corresponds to the JSON property action
58 59 60 |
# File 'generated/google/apis/clouddebugger_v2/classes.rb', line 58 def action @action end |
#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.
Corresponds to the JSON property condition
65 66 67 |
# File 'generated/google/apis/clouddebugger_v2/classes.rb', line 65 def condition @condition end |
#create_time ⇒ String
Time this breakpoint was created by the server in seconds resolution.
Corresponds to the JSON property createTime
70 71 72 |
# File 'generated/google/apis/clouddebugger_v2/classes.rb', line 70 def create_time @create_time end |
#evaluated_expressions ⇒ Array<Google::Apis::ClouddebuggerV2::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.
Corresponds to the JSON property evaluatedExpressions
81 82 83 |
# File 'generated/google/apis/clouddebugger_v2/classes.rb', line 81 def evaluated_expressions @evaluated_expressions end |
#expressions ⇒ Array<String>
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.
Corresponds to the JSON property expressions
89 90 91 |
# File 'generated/google/apis/clouddebugger_v2/classes.rb', line 89 def expressions @expressions end |
#final_time ⇒ String
Time this breakpoint was finalized as seen by the server in seconds
resolution.
Corresponds to the JSON property finalTime
95 96 97 |
# File 'generated/google/apis/clouddebugger_v2/classes.rb', line 95 def final_time @final_time end |
#id ⇒ String
Breakpoint identifier, unique in the scope of the debuggee.
Corresponds to the JSON property id
100 101 102 |
# File 'generated/google/apis/clouddebugger_v2/classes.rb', line 100 def id @id end |
#is_final_state ⇒ Boolean Also known as: is_final_state?
When true, indicates that this is a final result and the
breakpoint state will not change from here on.
Corresponds to the JSON property isFinalState
106 107 108 |
# File 'generated/google/apis/clouddebugger_v2/classes.rb', line 106 def is_final_state @is_final_state end |
#labels ⇒ Hash<String,String>
A set of custom breakpoint properties, populated by the agent, to be
displayed to the user.
Corresponds to the JSON property labels
113 114 115 |
# File 'generated/google/apis/clouddebugger_v2/classes.rb', line 113 def labels @labels end |
#location ⇒ Google::Apis::ClouddebuggerV2::SourceLocation
Represents a location in the source code.
Corresponds to the JSON property location
118 119 120 |
# File 'generated/google/apis/clouddebugger_v2/classes.rb', line 118 def location @location end |
#log_level ⇒ String
Indicates the severity of the log. Only relevant when action is LOG
.
Corresponds to the JSON property logLevel
123 124 125 |
# File 'generated/google/apis/clouddebugger_v2/classes.rb', line 123 def log_level @log_level end |
#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 ]
.
Corresponds to the JSON property logMessageFormat
134 135 136 |
# File 'generated/google/apis/clouddebugger_v2/classes.rb', line 134 def @log_message_format end |
#stack_frames ⇒ Array<Google::Apis::ClouddebuggerV2::StackFrame>
The stack at breakpoint time.
Corresponds to the JSON property stackFrames
139 140 141 |
# File 'generated/google/apis/clouddebugger_v2/classes.rb', line 139 def stack_frames @stack_frames end |
#status ⇒ Google::Apis::ClouddebuggerV2::StatusMessage
Represents a contextual status message.
The message can indicate an error or informational status, and refer to
specific parts of the containing object.
For example, the Breakpoint.status
field can indicate an error referring
to the BREAKPOINT_SOURCE_LOCATION
with the message Location not found
.
Corresponds to the JSON property status
148 149 150 |
# File 'generated/google/apis/clouddebugger_v2/classes.rb', line 148 def status @status end |
#user_email ⇒ String
E-mail address of the user that created this breakpoint
Corresponds to the JSON property userEmail
153 154 155 |
# File 'generated/google/apis/clouddebugger_v2/classes.rb', line 153 def user_email @user_email end |
#variable_table ⇒ Array<Google::Apis::ClouddebuggerV2::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.
Corresponds to the JSON property variableTable
168 169 170 |
# File 'generated/google/apis/clouddebugger_v2/classes.rb', line 168 def variable_table @variable_table end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 |
# File 'generated/google/apis/clouddebugger_v2/classes.rb', line 175 def update!(**args) @action = args[:action] if args.key?(:action) @condition = args[:condition] if args.key?(:condition) @create_time = args[:create_time] if args.key?(:create_time) @evaluated_expressions = args[:evaluated_expressions] if args.key?(:evaluated_expressions) @expressions = args[:expressions] if args.key?(:expressions) @final_time = args[:final_time] if args.key?(:final_time) @id = args[:id] if args.key?(:id) @is_final_state = args[:is_final_state] if args.key?(:is_final_state) @labels = args[:labels] if args.key?(:labels) @location = args[:location] if args.key?(:location) @log_level = args[:log_level] if args.key?(:log_level) @log_message_format = args[:log_message_format] if args.key?(:log_message_format) @stack_frames = args[:stack_frames] if args.key?(:stack_frames) @status = args[:status] if args.key?(:status) @user_email = args[:user_email] if args.key?(:user_email) @variable_table = args[:variable_table] if args.key?(:variable_table) end |