Package com.google.devtools.clouddebugger.v2

Interface BreakpointOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Breakpoint, Breakpoint.Builder
    public interface BreakpointOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getId

        String getId()
         Breakpoint identifier, unique in the scope of the debuggee.
        string id = 1;
        Returns:
        The id.

      • getIdBytes

        com.google.protobuf.ByteString getIdBytes()
         Breakpoint identifier, unique in the scope of the debuggee.
        string id = 1;
        Returns:
        The bytes for id.

      • getActionValue

        int getActionValue()
         Action that the agent should perform when the code at the
 breakpoint location is hit.
        .google.devtools.clouddebugger.v2.Breakpoint.Action action = 13;
        Returns:
        The enum numeric value on the wire for action.

      • getAction

        Breakpoint.Action getAction()
         Action that the agent should perform when the code at the
 breakpoint location is hit.
        .google.devtools.clouddebugger.v2.Breakpoint.Action action = 13;
        Returns:
        The action.

      • hasLocation

        boolean hasLocation()
         Breakpoint source location.
        .google.devtools.clouddebugger.v2.SourceLocation location = 2;
        Returns:
        Whether the location field is set.

      • getLocation

        SourceLocation getLocation()
         Breakpoint source location.
        .google.devtools.clouddebugger.v2.SourceLocation location = 2;
        Returns:
        The location.

      • getLocationOrBuilder

        SourceLocationOrBuilder getLocationOrBuilder()
         Breakpoint source location.
        .google.devtools.clouddebugger.v2.SourceLocation location = 2;

      • getCondition

        String getCondition()
         Condition that triggers the breakpoint.
 The condition is a compound boolean expression composed using expressions
 in a programming language at the source location.
        string condition = 3;
        Returns:
        The condition.

      • getConditionBytes

        com.google.protobuf.ByteString getConditionBytes()
         Condition that triggers the breakpoint.
 The condition is a compound boolean expression composed using expressions
 in a programming language at the source location.
        string condition = 3;
        Returns:
        The bytes for condition.

      • getExpressionsList

        List<String> getExpressionsList()
         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.
        repeated string expressions = 4;
        Returns:
        A list containing the expressions.

      • getExpressionsCount

        int getExpressionsCount()
         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.
        repeated string expressions = 4;
        Returns:
        The count of expressions.

      • getExpressions

        String getExpressions​(int index)
         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.
        repeated string expressions = 4;
        Parameters:
        index - The index of the element to return.
        Returns:
        The expressions at the given index.

      • getExpressionsBytes

        com.google.protobuf.ByteString getExpressionsBytes​(int index)
         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.
        repeated string expressions = 4;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the expressions at the given index.

      • getLogMessageFormat

        String getLogMessageFormat()
         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 ]`.
        string log_message_format = 14;
        Returns:
        The logMessageFormat.

      • getLogMessageFormatBytes

        com.google.protobuf.ByteString getLogMessageFormatBytes()
         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 ]`.
        string log_message_format = 14;
        Returns:
        The bytes for logMessageFormat.

      • getLogLevelValue

        int getLogLevelValue()
         Indicates the severity of the log. Only relevant when action is `LOG`.
        .google.devtools.clouddebugger.v2.Breakpoint.LogLevel log_level = 15;
        Returns:
        The enum numeric value on the wire for logLevel.

      • getLogLevel

        Breakpoint.LogLevel getLogLevel()
         Indicates the severity of the log. Only relevant when action is `LOG`.
        .google.devtools.clouddebugger.v2.Breakpoint.LogLevel log_level = 15;
        Returns:
        The logLevel.

      • getIsFinalState

        boolean getIsFinalState()
         When true, indicates that this is a final result and the
 breakpoint state will not change from here on.
        bool is_final_state = 5;
        Returns:
        The isFinalState.

      • hasCreateTime

        boolean hasCreateTime()
         Time this breakpoint was created by the server in seconds resolution.
        .google.protobuf.Timestamp create_time = 11;
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        com.google.protobuf.Timestamp getCreateTime()
         Time this breakpoint was created by the server in seconds resolution.
        .google.protobuf.Timestamp create_time = 11;
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Time this breakpoint was created by the server in seconds resolution.
        .google.protobuf.Timestamp create_time = 11;

      • hasFinalTime

        boolean hasFinalTime()
         Time this breakpoint was finalized as seen by the server in seconds
 resolution.
        .google.protobuf.Timestamp final_time = 12;
        Returns:
        Whether the finalTime field is set.

      • getFinalTime

        com.google.protobuf.Timestamp getFinalTime()
         Time this breakpoint was finalized as seen by the server in seconds
 resolution.
        .google.protobuf.Timestamp final_time = 12;
        Returns:
        The finalTime.

      • getFinalTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getFinalTimeOrBuilder()
         Time this breakpoint was finalized as seen by the server in seconds
 resolution.
        .google.protobuf.Timestamp final_time = 12;

      • getUserEmail

        String getUserEmail()
         E-mail address of the user that created this breakpoint
        string user_email = 16;
        Returns:
        The userEmail.

      • getUserEmailBytes

        com.google.protobuf.ByteString getUserEmailBytes()
         E-mail address of the user that created this breakpoint
        string user_email = 16;
        Returns:
        The bytes for userEmail.

      • hasStatus

        boolean hasStatus()
         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
        .google.devtools.clouddebugger.v2.StatusMessage status = 10;
        Returns:
        Whether the status field is set.

      • getStatus

        StatusMessage getStatus()
         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
        .google.devtools.clouddebugger.v2.StatusMessage status = 10;
        Returns:
        The status.

      • getStatusOrBuilder

        StatusMessageOrBuilder getStatusOrBuilder()
         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
        .google.devtools.clouddebugger.v2.StatusMessage status = 10;

      • getStackFramesList

        List<StackFrame> getStackFramesList()
         The stack at breakpoint time, where stack_frames[0] represents the most
 recently entered function.
        repeated .google.devtools.clouddebugger.v2.StackFrame stack_frames = 7;

      • getStackFrames

        StackFrame getStackFrames​(int index)
         The stack at breakpoint time, where stack_frames[0] represents the most
 recently entered function.
        repeated .google.devtools.clouddebugger.v2.StackFrame stack_frames = 7;

      • getStackFramesCount

        int getStackFramesCount()
         The stack at breakpoint time, where stack_frames[0] represents the most
 recently entered function.
        repeated .google.devtools.clouddebugger.v2.StackFrame stack_frames = 7;

      • getStackFramesOrBuilderList

        List<? extends StackFrameOrBuilder> getStackFramesOrBuilderList()
         The stack at breakpoint time, where stack_frames[0] represents the most
 recently entered function.
        repeated .google.devtools.clouddebugger.v2.StackFrame stack_frames = 7;

      • getStackFramesOrBuilder

        StackFrameOrBuilder getStackFramesOrBuilder​(int index)
         The stack at breakpoint time, where stack_frames[0] represents the most
 recently entered function.
        repeated .google.devtools.clouddebugger.v2.StackFrame stack_frames = 7;

      • getEvaluatedExpressionsList

        List<Variable> getEvaluatedExpressionsList()
         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.
        repeated .google.devtools.clouddebugger.v2.Variable evaluated_expressions = 8;

      • getEvaluatedExpressions

        Variable getEvaluatedExpressions​(int index)
         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.
        repeated .google.devtools.clouddebugger.v2.Variable evaluated_expressions = 8;

      • getEvaluatedExpressionsCount

        int getEvaluatedExpressionsCount()
         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.
        repeated .google.devtools.clouddebugger.v2.Variable evaluated_expressions = 8;

      • getEvaluatedExpressionsOrBuilderList

        List<? extends VariableOrBuilder> getEvaluatedExpressionsOrBuilderList()
         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.
        repeated .google.devtools.clouddebugger.v2.Variable evaluated_expressions = 8;

      • getEvaluatedExpressionsOrBuilder

        VariableOrBuilder getEvaluatedExpressionsOrBuilder​(int index)
         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.
        repeated .google.devtools.clouddebugger.v2.Variable evaluated_expressions = 8;

      • getVariableTableList

        List<Variable> getVariableTableList()
         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.
        repeated .google.devtools.clouddebugger.v2.Variable variable_table = 9;

      • getVariableTable

        Variable getVariableTable​(int index)
         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.
        repeated .google.devtools.clouddebugger.v2.Variable variable_table = 9;

      • getVariableTableCount

        int getVariableTableCount()
         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.
        repeated .google.devtools.clouddebugger.v2.Variable variable_table = 9;

      • getVariableTableOrBuilderList

        List<? extends VariableOrBuilder> getVariableTableOrBuilderList()
         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.
        repeated .google.devtools.clouddebugger.v2.Variable variable_table = 9;

      • getVariableTableOrBuilder

        VariableOrBuilder getVariableTableOrBuilder​(int index)
         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.
        repeated .google.devtools.clouddebugger.v2.Variable variable_table = 9;

      • getLabelsCount

        int getLabelsCount()
         A set of custom breakpoint properties, populated by the agent, to be
 displayed to the user.
        map<string, string> labels = 17;

      • containsLabels

        boolean containsLabels​(String key)
         A set of custom breakpoint properties, populated by the agent, to be
 displayed to the user.
        map<string, string> labels = 17;

      • getLabelsMap

        Map<String,​String> getLabelsMap()
         A set of custom breakpoint properties, populated by the agent, to be
 displayed to the user.
        map<string, string> labels = 17;

      • getLabelsOrDefault

        String getLabelsOrDefault​(String key,
                          String defaultValue)
         A set of custom breakpoint properties, populated by the agent, to be
 displayed to the user.
        map<string, string> labels = 17;

      • getLabelsOrThrow

        String getLabelsOrThrow​(String key)
         A set of custom breakpoint properties, populated by the agent, to be
 displayed to the user.
        map<string, string> labels = 17;