2023-07-27
▼ ▲ clouddebugger.controller.debuggees.breakpoints.update
Description: 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.
Scopes:
Parameter Order:
Flat Path: v2/controller/debuggees/{debuggeeId}/breakpoints/{id}
Parameters:
debuggeeId
Required: Yes
Description: Required. Identifies the debuggee being debugged.
Type: string
Location: path
id
Type: string
Required: Yes
Description: Breakpoint identifier, unique in the scope of the debuggee.
Location: path
HTTP Method: PUT
Path: v2/controller/debuggees/{debuggeeId}/breakpoints/{id}
▼ ▲ clouddebugger.controller.debuggees.breakpoints.list
HTTP Method: GET
Parameters:
successOnTimeout
Description: If set to `true` (recommended), returns `google.rpc.Code.OK` status and sets the `wait_expired` 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.
Type: boolean
Location: query
agentId
Location: query
Type: string
Description: Identifies the agent. This is the ID returned in the RegisterDebuggee response.
waitToken
Location: query
Type: string
Description: 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 `next_wait_token` field in the last response. The initial value should be set to `"init"`.
debuggeeId
Location: path
Description: Required. Identifies the debuggee.
Type: string
Required: Yes
Flat Path: v2/controller/debuggees/{debuggeeId}/breakpoints
Scopes:
Path: v2/controller/debuggees/{debuggeeId}/breakpoints
Parameter Order: debuggeeId
Description: 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.
▼ ▲ clouddebugger.controller.debuggees.register
HTTP Method: POST
Scopes:
Path: v2/controller/debuggees/register
Description: Registers the debuggee with the controller service. All agents attached to the same application must call this method with exactly the same request content to get back the same stable `debuggee_id`. Agents should call this method again whenever `google.rpc.Code.NOT_FOUND` is returned from any controller method. This protocol allows the controller service to disable debuggees, recover from data loss, or change the `debuggee_id` format. Agents must handle `debuggee_id` value changing upon re-registration.
Flat Path: v2/controller/debuggees/register
▼ ▲ clouddebugger.debugger.debuggees.breakpoints.delete
Description: Deletes the breakpoint from the debuggee.
Scopes:
Flat Path: v2/debugger/debuggees/{debuggeeId}/breakpoints/{breakpointId}
Parameter Order:
Parameters:
clientVersion
Type: string
Description: Required. The client version making the call. Schema: `domain/type/version` (e.g., `google.com/intellij/v1`).
Location: query
breakpointId
Location: path
Required: Yes
Type: string
Description: Required. ID of the breakpoint to delete.
debuggeeId
Description: Required. ID of the debuggee whose breakpoint to delete.
Type: string
Location: path
Required: Yes
Path: v2/debugger/debuggees/{debuggeeId}/breakpoints/{breakpointId}
HTTP Method: DELETE
▼ ▲ clouddebugger.debugger.debuggees.breakpoints.get
HTTP Method: GET
Parameter Order:
Path: v2/debugger/debuggees/{debuggeeId}/breakpoints/{breakpointId}
Parameters:
breakpointId
Location: path
Required: Yes
Description: Required. ID of the breakpoint to get.
Type: string
debuggeeId
Location: path
Required: Yes
Description: Required. ID of the debuggee whose breakpoint to get.
Type: string
clientVersion
Type: string
Location: query
Description: Required. The client version making the call. Schema: `domain/type/version` (e.g., `google.com/intellij/v1`).
Description: Gets breakpoint information.
Scopes:
Flat Path: v2/debugger/debuggees/{debuggeeId}/breakpoints/{breakpointId}
▼ ▲ clouddebugger.debugger.debuggees.breakpoints.list
Flat Path: v2/debugger/debuggees/{debuggeeId}/breakpoints
Scopes:
Parameters:
action.value
Enum Descriptions:
Type: string
Description: Only breakpoints with the specified action will pass the filter.
Location: query
Enum:
stripResults
Deprecated: Yes
Description: This field is deprecated. The following fields are always stripped out of the result: `stack_frames`, `evaluated_expressions` and `variable_table`.
Type: boolean
Location: query
debuggeeId
Required: Yes
Type: string
Description: Required. ID of the debuggee whose breakpoints to list.
Location: path
includeInactive
Type: boolean
Description: When set to `true`, the response includes active and inactive breakpoints. Otherwise, it includes only active breakpoints.
Location: query
waitToken
Location: query
Description: A wait token that, if specified, blocks the call until the breakpoints list has changed, or a server selected timeout has expired. The value should be set from the last response. The error code `google.rpc.Code.ABORTED` (RPC) is returned on wait timeout, which should be called again with the same `wait_token`.
Type: string
clientVersion
Type: string
Description: Required. The client version making the call. Schema: `domain/type/version` (e.g., `google.com/intellij/v1`).
Location: query
includeAllUsers
Description: When set to `true`, the response includes the list of breakpoints set by any user. Otherwise, it includes only breakpoints set by the caller.
Type: boolean
Location: query
Path: v2/debugger/debuggees/{debuggeeId}/breakpoints
Parameter Order: debuggeeId
Description: Lists all breakpoints for the debuggee.
HTTP Method: GET
▼ ▲ clouddebugger.debugger.debuggees.breakpoints.set
Description: Sets the breakpoint to the debuggee.
HTTP Method: POST
Path: v2/debugger/debuggees/{debuggeeId}/breakpoints/set
Parameter Order: debuggeeId
Parameters:
debuggeeId
Location: path
Required: Yes
Type: string
Description: Required. ID of the debuggee where the breakpoint is to be set.
clientVersion
Location: query
Description: Required. The client version making the call. Schema: `domain/type/version` (e.g., `google.com/intellij/v1`).
Type: string
canaryOption
Enum:
Location: query
Description: The canary option set by the user upon setting breakpoint.
Type: string
Enum Descriptions:
Scopes:
Flat Path: v2/debugger/debuggees/{debuggeeId}/breakpoints/set
▼ ▲ clouddebugger.debugger.debuggees.list
Flat Path: v2/debugger/debuggees
Path: v2/debugger/debuggees
Parameters:
clientVersion
Description: Required. The client version making the call. Schema: `domain/type/version` (e.g., `google.com/intellij/v1`).
Location: query
Type: string
project
Location: query
Description: Required. Project number of a Google Cloud project whose debuggees to list.
Type: string
includeInactive
Type: boolean
Description: When set to `true`, the result includes all debuggees. Otherwise, the result includes only debuggees that are active.
Location: query
HTTP Method: GET
Description: Lists all the debuggees that the user has access to.
Scopes: