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

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

Returns the list of all active breakpoints for the debuggee.

The breakpoint specification (location, condition, and expressions fields) is semantically immutable, although the field values may change. For example, an agent may update the location line number to reflect the actual line where the breakpoint was set, but this doesn't change the breakpoint semantics.

This means that an agent does not need to check if a breakpoint has changed when it encounters the same breakpoint on a successive call. Moreover, an agent should remember the breakpoints that are completed until the controller removes them from the active list to avoid setting those breakpoints again.

HTTP request

GET https://clouddebugger.googleapis.com/v2/controller/debuggees/{debuggeeId}/breakpoints

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
debuggeeId

string

Required. Identifies the debuggee.

Query parameters

Parameters
waitToken

string

A token that, if specified, blocks the method call until the list of active breakpoints has changed, or a server-selected timeout has expired. The value should be set from the nextWaitToken field in the last response. The initial value should be set to "init".
successOnTimeout

boolean

If set to true (recommended), returns google.rpc.Code.OK status and sets the waitExpired response field to true when the server-selected timeout has expired.

If set to false (deprecated), returns google.rpc.Code.ABORTED status when the server-selected timeout has expired.
agentId

string

Identifies the agent. This is the ID returned in the debuggees.register response.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

Response for listing active breakpoints.

JSON representation 
{
  "breakpoints": [
    {
      object (Breakpoint)
    }
  ],
  "nextWaitToken": string,
  "waitExpired": boolean
}
Fields
breakpoints[]

object (Breakpoint)

List of all active breakpoints. The fields id and location are guaranteed to be set on each breakpoint.
nextWaitToken

string

A token that can be used in the next method call to block until the list of breakpoints changes.
waitExpired

boolean

If set to true, indicates that there is no change to the list of active breakpoints and the server-selected timeout has expired. The breakpoints field would be empty and should be ignored.

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.