Cloud Debugger V2 API - Class Google::Cloud::Debugger::V2::Breakpoint (v0.3.5)

Reference documentation and code samples for the Cloud Debugger V2 API class Google::Cloud::Debugger::V2::Breakpoint.

Represents the breakpoint specification, status and results.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#action

def action() -> ::Google::Cloud::Debugger::V2::Breakpoint::Action

Returns

(::Google::Cloud::Debugger::V2::Breakpoint::Action) — Action that the agent should perform when the code at the breakpoint location is hit.

#action=

def action=(value) -> ::Google::Cloud::Debugger::V2::Breakpoint::Action

Parameter

value (::Google::Cloud::Debugger::V2::Breakpoint::Action) — Action that the agent should perform when the code at the breakpoint location is hit.

Returns

(::Google::Cloud::Debugger::V2::Breakpoint::Action) — Action that the agent should perform when the code at the breakpoint location is hit.

#condition

def condition() -> ::String

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.

#condition=

def condition=(value) -> ::String

Parameter

value (::String) — 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.

#create_time

def create_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Time this breakpoint was created by the server in seconds resolution.

#create_time=

def create_time=(value) -> ::Google::Protobuf::Timestamp

Parameter

value (::Google::Protobuf::Timestamp) — Time this breakpoint was created by the server in seconds resolution.

Returns

(::Google::Protobuf::Timestamp) — Time this breakpoint was created by the server in seconds resolution.

#evaluated_expressions

def evaluated_expressions() -> ::Array<::Google::Cloud::Debugger::V2::Variable>

Returns

(::Array<::Google::Cloud::Debugger::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.

#evaluated_expressions=

def evaluated_expressions=(value) -> ::Array<::Google::Cloud::Debugger::V2::Variable>

Parameter

value (::Array<::Google::Cloud::Debugger::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.

Returns

(::Array<::Google::Cloud::Debugger::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.

#expressions

def expressions() -> ::Array<::String>

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.

#expressions=

def expressions=(value) -> ::Array<::String>

Parameter

value (::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.

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.

#final_time

def final_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Time this breakpoint was finalized as seen by the server in seconds resolution.

#final_time=

def final_time=(value) -> ::Google::Protobuf::Timestamp

Parameter

value (::Google::Protobuf::Timestamp) — Time this breakpoint was finalized as seen by the server in seconds resolution.

Returns

(::Google::Protobuf::Timestamp) — Time this breakpoint was finalized as seen by the server in seconds resolution.

#id

def id() -> ::String

Returns

(::String) — Breakpoint identifier, unique in the scope of the debuggee.

#id=

def id=(value) -> ::String

Parameter

value (::String) — Breakpoint identifier, unique in the scope of the debuggee.

Returns

(::String) — Breakpoint identifier, unique in the scope of the debuggee.

#is_final_state

def is_final_state() -> ::Boolean

Returns

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

#is_final_state=

def is_final_state=(value) -> ::Boolean

Parameter

value (::Boolean) — When true, indicates that this is a final result and the breakpoint state will not change from here on.

Returns

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

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}

Returns

(::Google::Protobuf::Map{::String => ::String}) — A set of custom breakpoint properties, populated by the agent, to be displayed to the user.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}

Parameter

value (::Google::Protobuf::Map{::String => ::String}) — A set of custom breakpoint properties, populated by the agent, to be displayed to the user.

Returns

(::Google::Protobuf::Map{::String => ::String}) — A set of custom breakpoint properties, populated by the agent, to be displayed to the user.

#location

def location() -> ::Google::Cloud::Debugger::V2::SourceLocation

Returns

(::Google::Cloud::Debugger::V2::SourceLocation) — Breakpoint source location.

#location=

def location=(value) -> ::Google::Cloud::Debugger::V2::SourceLocation

Parameter

value (::Google::Cloud::Debugger::V2::SourceLocation) — Breakpoint source location.

Returns

(::Google::Cloud::Debugger::V2::SourceLocation) — Breakpoint source location.

#log_level

def log_level() -> ::Google::Cloud::Debugger::V2::Breakpoint::LogLevel

Returns

(::Google::Cloud::Debugger::V2::Breakpoint::LogLevel) — Indicates the severity of the log. Only relevant when action is LOG.

#log_level=

def log_level=(value) -> ::Google::Cloud::Debugger::V2::Breakpoint::LogLevel

Parameter

value (::Google::Cloud::Debugger::V2::Breakpoint::LogLevel) — Indicates the severity of the log. Only relevant when action is LOG.

Returns

(::Google::Cloud::Debugger::V2::Breakpoint::LogLevel) — Indicates the severity of the log. Only relevant when action is LOG.

#log_message_format

def log_message_format() -> ::String

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 ].

#log_message_format=

def log_message_format=(value) -> ::String

Parameter

value (::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 ].

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 ].

#stack_frames

def stack_frames() -> ::Array<::Google::Cloud::Debugger::V2::StackFrame>

Returns

(::Array<::Google::Cloud::Debugger::V2::StackFrame>) — The stack at breakpoint time, where stack_frames[0] represents the most recently entered function.

#stack_frames=

def stack_frames=(value) -> ::Array<::Google::Cloud::Debugger::V2::StackFrame>

Parameter

value (::Array<::Google::Cloud::Debugger::V2::StackFrame>) — The stack at breakpoint time, where stack_frames[0] represents the most recently entered function.

Returns

(::Array<::Google::Cloud::Debugger::V2::StackFrame>) — The stack at breakpoint time, where stack_frames[0] represents the most recently entered function.

#status

def status() -> ::Google::Cloud::Debugger::V2::StatusMessage

Returns

(::Google::Cloud::Debugger::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

#status=

def status=(value) -> ::Google::Cloud::Debugger::V2::StatusMessage

Parameter

value (::Google::Cloud::Debugger::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

Returns

(::Google::Cloud::Debugger::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

#user_email

def user_email() -> ::String

Returns

(::String) — E-mail address of the user that created this breakpoint

#user_email=

def user_email=(value) -> ::String

Parameter

value (::String) — E-mail address of the user that created this breakpoint

Returns

(::String) — E-mail address of the user that created this breakpoint

#variable_table

def variable_table() -> ::Array<::Google::Cloud::Debugger::V2::Variable>

Returns

(::Array<::Google::Cloud::Debugger::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.

#variable_table=

def variable_table=(value) -> ::Array<::Google::Cloud::Debugger::V2::Variable>

Parameter

value (::Array<::Google::Cloud::Debugger::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.

Returns

(::Array<::Google::Cloud::Debugger::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.