Cloud Debugger is deprecated and will be shutdown May 31, 2023. See the deprecations page and release notes for more information.

Method: controller.debuggees.breakpoints.update

Stay organized with collections Save and categorize content based on your preferences.

Updates the breakpoint state or mutable fields. The entire Breakpoint message must be sent back to the controller service.

Updates to active breakpoint fields are only allowed if the new value does not change the breakpoint specification. Updates to the location, condition and expressions fields should not alter the breakpoint semantics. These may only make changes such as canonicalizing a value or snapping the location to the correct line of code.

HTTP request

PUT https://clouddebugger.googleapis.com/v2/controller/debuggees/{debuggeeId}/breakpoints/{breakpoint.id}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
debuggeeId

string

Required. Identifies the debuggee being debugged.
breakpoint.id

string

Breakpoint identifier, unique in the scope of the debuggee.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "breakpoint": {
    "id": string,
    "action": enum (Action),
    "location": {
      "path": string,
      "line": integer,
      "column": integer
    },
    "condition": string,
    "expressions": [
      string
    ],
    "logMessageFormat": string,
    "logLevel": enum (LogLevel),
    "isFinalState": boolean,
    "createTime": string,
    "finalTime": string,
    "userEmail": string,
    "status": {
      "isError": boolean,
      "refersTo": enum (Reference),
      "description": {
        object (FormatMessage)
      }
    },
    "stackFrames": [
      {
        "function": string,
        "location": {
          object (SourceLocation)
        },
        "arguments": [
          {
            object (Variable)
          }
        ],
        "locals": [
          {
            object (Variable)
          }
        ]
      }
    ],
    "evaluatedExpressions": [
      {
        "name": string,
        "value": string,
        "type": string,
        "members": [
          {
            object (Variable)
          }
        ],
        "varTableIndex": integer,
        "status": {
          object (StatusMessage)
        }
      }
    ],
    "variableTable": [
      {
        "name": string,
        "value": string,
        "type": string,
        "members": [
          {
            object (Variable)
          }
        ],
        "varTableIndex": integer,
        "status": {
          object (StatusMessage)
        }
      }
    ],
    "labels": {
      string: string,
      ...
    },
    "canaryExpireTime": string,
    "state": enum (State)
  }
}
Fields
breakpoint.action

enum (Action)

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

object (SourceLocation)

Breakpoint source location.
breakpoint.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.
breakpoint.expressions[]

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.
breakpoint.logMessageFormat

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 logMessageFormat are not logged.

Example: Message received, id = $0, count = $1 with expressions = [ message.id, message.count ].
breakpoint.logLevel

enum (LogLevel)

Indicates the severity of the log. Only relevant when action is LOG.
breakpoint.isFinalState

boolean

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

string (Timestamp format)

Time this breakpoint was created by the server in seconds resolution.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
breakpoint.finalTime

string (Timestamp format)

Time this breakpoint was finalized as seen by the server in seconds resolution.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
breakpoint.userEmail

string

E-mail address of the user that created this breakpoint
breakpoint.status

object (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
breakpoint.stackFrames[]

object (StackFrame)

The stack at breakpoint time, where stackFrames[0] represents the most recently entered function.
breakpoint.evaluatedExpressions[]

object (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.
breakpoint.variableTable[]

object (Variable)

The variableTable 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 variableTable 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 varTableIndex 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.
breakpoint.labels

map (key: string, value: string)

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

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
breakpoint.canaryExpireTime

string (Timestamp format)

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

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
breakpoint.state

enum (State)

The current state of the breakpoint.

Response body

If successful, the response body is empty.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud_debugger
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.