Class: Google::Apis::ClouddebuggerV2::Breakpoint

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/clouddebugger_v2/classes.rb,
generated/google/apis/clouddebugger_v2/representations.rb,
generated/google/apis/clouddebugger_v2/representations.rb

Overview


Breakpoint (the resource) Represents the breakpoint specification, status

and results.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Breakpoint

Returns a new instance of Breakpoint.


179
180
181
# File 'generated/google/apis/clouddebugger_v2/classes.rb', line 179

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#actionString

Action that the agent should perform when the code at the breakpoint location is hit. Corresponds to the JSON property action

Returns:

  • (String)

60
61
62
# File 'generated/google/apis/clouddebugger_v2/classes.rb', line 60

def action
  @action
end

#canary_expire_timeString

The deadline for the breakpoint to stay in CANARY_ACTIVE state. The value is meaningless when the breakpoint is not in CANARY_ACTIVE state. Corresponds to the JSON property canaryExpireTime

Returns:

  • (String)

66
67
68
# File 'generated/google/apis/clouddebugger_v2/classes.rb', line 66

def canary_expire_time
  @canary_expire_time
end

#conditionString

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

Returns:

  • (String)

73
74
75
# File 'generated/google/apis/clouddebugger_v2/classes.rb', line 73

def condition
  @condition
end

#create_timeString

Time this breakpoint was created by the server in seconds resolution. Corresponds to the JSON property createTime

Returns:

  • (String)

78
79
80
# File 'generated/google/apis/clouddebugger_v2/classes.rb', line 78

def create_time
  @create_time
end

#evaluated_expressionsArray<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


88
89
90
# File 'generated/google/apis/clouddebugger_v2/classes.rb', line 88

def evaluated_expressions
  @evaluated_expressions
end

#expressionsArray<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

Returns:

  • (Array<String>)

96
97
98
# File 'generated/google/apis/clouddebugger_v2/classes.rb', line 96

def expressions
  @expressions
end

#final_timeString

Time this breakpoint was finalized as seen by the server in seconds resolution. Corresponds to the JSON property finalTime

Returns:

  • (String)

101
102
103
# File 'generated/google/apis/clouddebugger_v2/classes.rb', line 101

def final_time
  @final_time
end

#idString

Breakpoint identifier, unique in the scope of the debuggee. Corresponds to the JSON property id

Returns:

  • (String)

106
107
108
# File 'generated/google/apis/clouddebugger_v2/classes.rb', line 106

def id
  @id
end

#is_final_stateBoolean 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

Returns:

  • (Boolean)

112
113
114
# File 'generated/google/apis/clouddebugger_v2/classes.rb', line 112

def is_final_state
  @is_final_state
end

#labelsHash<String,String>

A set of custom breakpoint properties, populated by the agent, to be displayed to the user. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>)

119
120
121
# File 'generated/google/apis/clouddebugger_v2/classes.rb', line 119

def labels
  @labels
end

#locationGoogle::Apis::ClouddebuggerV2::SourceLocation

Represents a location in the source code. Corresponds to the JSON property location


124
125
126
# File 'generated/google/apis/clouddebugger_v2/classes.rb', line 124

def location
  @location
end

#log_levelString

Indicates the severity of the log. Only relevant when action is LOG. Corresponds to the JSON property logLevel

Returns:

  • (String)

129
130
131
# File 'generated/google/apis/clouddebugger_v2/classes.rb', line 129

def log_level
  @log_level
end

#log_message_formatString

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

Returns:

  • (String)

139
140
141
# File 'generated/google/apis/clouddebugger_v2/classes.rb', line 139

def log_message_format
  @log_message_format
end

#stack_framesArray<Google::Apis::ClouddebuggerV2::StackFrame>

The stack at breakpoint time, where stack_frames[0] represents the most recently entered function. Corresponds to the JSON property stackFrames


145
146
147
# File 'generated/google/apis/clouddebugger_v2/classes.rb', line 145

def stack_frames
  @stack_frames
end

#stateString

The current state of the breakpoint. Corresponds to the JSON property state

Returns:

  • (String)

150
151
152
# File 'generated/google/apis/clouddebugger_v2/classes.rb', line 150

def state
  @state
end

#statusGoogle::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


158
159
160
# File 'generated/google/apis/clouddebugger_v2/classes.rb', line 158

def status
  @status
end

#user_emailString

E-mail address of the user that created this breakpoint Corresponds to the JSON property userEmail

Returns:

  • (String)

163
164
165
# File 'generated/google/apis/clouddebugger_v2/classes.rb', line 163

def user_email
  @user_email
end

#variable_tableArray<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


177
178
179
# File 'generated/google/apis/clouddebugger_v2/classes.rb', line 177

def variable_table
  @variable_table
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
# File 'generated/google/apis/clouddebugger_v2/classes.rb', line 184

def update!(**args)
  @action = args[:action] if args.key?(:action)
  @canary_expire_time = args[:canary_expire_time] if args.key?(:canary_expire_time)
  @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)
  @state = args[:state] if args.key?(:state)
  @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