Class: Google::Devtools::Clouddebugger::V2::Breakpoint

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/debugger/v2/doc/google/devtools/clouddebugger/v2/data.rb

Overview

Represents the breakpoint specification, status and results.

Defined Under Namespace

Modules: Action, LogLevel

Instance Attribute Summary collapse

Instance Attribute Details

#action ⇒ Google::Devtools::Clouddebugger::V2::Breakpoint::Action

Returns Action that the agent should perform when the code at the breakpoint location is hit.

Returns:



350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'lib/google/cloud/debugger/v2/doc/google/devtools/clouddebugger/v2/data.rb', line 350

class Breakpoint
  # 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.

Returns:

  • (String) —

    Condition that triggers the breakpoint. The condition is a compound boolean expression composed using expressions in a programming language at the source location.



350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'lib/google/cloud/debugger/v2/doc/google/devtools/clouddebugger/v2/data.rb', line 350

class Breakpoint
  # 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.

Returns:



350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'lib/google/cloud/debugger/v2/doc/google/devtools/clouddebugger/v2/data.rb', line 350

class Breakpoint
  # 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::Devtools::Clouddebugger::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.

Returns:

  • (Array<Google::Devtools::Clouddebugger::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.



350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'lib/google/cloud/debugger/v2/doc/google/devtools/clouddebugger/v2/data.rb', line 350

class Breakpoint
  # 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.

Returns:

  • (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.



350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'lib/google/cloud/debugger/v2/doc/google/devtools/clouddebugger/v2/data.rb', line 350

class Breakpoint
  # 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.

Returns:



350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'lib/google/cloud/debugger/v2/doc/google/devtools/clouddebugger/v2/data.rb', line 350

class Breakpoint
  # 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.

Returns:

  • (String) —

    Breakpoint identifier, unique in the scope of the debuggee.



350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'lib/google/cloud/debugger/v2/doc/google/devtools/clouddebugger/v2/data.rb', line 350

class Breakpoint
  # 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 ⇒ true, false

Returns When true, indicates that this is a final result and the breakpoint state will not change from here on.

Returns:

  • (true, false) —

    When true, indicates that this is a final result and the breakpoint state will not change from here on.



350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'lib/google/cloud/debugger/v2/doc/google/devtools/clouddebugger/v2/data.rb', line 350

class Breakpoint
  # 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 ⇒ Hash{String => String}

Returns A set of custom breakpoint properties, populated by the agent, to be displayed to the user.

Returns:

  • (Hash{String => String}) —

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



350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'lib/google/cloud/debugger/v2/doc/google/devtools/clouddebugger/v2/data.rb', line 350

class Breakpoint
  # 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::Devtools::Clouddebugger::V2::SourceLocation

Returns Breakpoint source location.

Returns:



350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'lib/google/cloud/debugger/v2/doc/google/devtools/clouddebugger/v2/data.rb', line 350

class Breakpoint
  # 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::Devtools::Clouddebugger::V2::Breakpoint::LogLevel

Returns Indicates the severity of the log. Only relevant when action is +LOG+.

Returns:



350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'lib/google/cloud/debugger/v2/doc/google/devtools/clouddebugger/v2/data.rb', line 350

class Breakpoint
  # 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 ]+.

Returns:

  • (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 ]+.



350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'lib/google/cloud/debugger/v2/doc/google/devtools/clouddebugger/v2/data.rb', line 350

class Breakpoint
  # 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::Devtools::Clouddebugger::V2::StackFrame>

Returns The stack at breakpoint time.

Returns:



350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'lib/google/cloud/debugger/v2/doc/google/devtools/clouddebugger/v2/data.rb', line 350

class Breakpoint
  # 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::Devtools::Clouddebugger::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

Returns:

  • (Google::Devtools::Clouddebugger::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


350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'lib/google/cloud/debugger/v2/doc/google/devtools/clouddebugger/v2/data.rb', line 350

class Breakpoint
  # 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

Returns:

  • (String) —

    E-mail address of the user that created this breakpoint



350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'lib/google/cloud/debugger/v2/doc/google/devtools/clouddebugger/v2/data.rb', line 350

class Breakpoint
  # 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::Devtools::Clouddebugger::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.

Returns:

  • (Array<Google::Devtools::Clouddebugger::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.



350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'lib/google/cloud/debugger/v2/doc/google/devtools/clouddebugger/v2/data.rb', line 350

class Breakpoint
  # 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