Stackdriver Debugger V2 Client - Class ListBreakpointsRequest (1.9.5)

Reference documentation and code samples for the Stackdriver Debugger V2 Client class ListBreakpointsRequest.

Request to list breakpoints.

Generated from protobuf messagegoogle.devtools.clouddebugger.v2.ListBreakpointsRequest

Namespace

Google \ Cloud \ Debugger \ V2

Methods

__construct

Constructor.

Parameters
NameDescription
dataarray

Optional. Data for populating the Message object.

↳ debuggee_idstring

Required. ID of the debuggee whose breakpoints to list.

↳ include_all_usersbool

When set totrue, the response includes the list of breakpoints set by any user. Otherwise, it includes only breakpoints set by the caller.

↳ include_inactivebool

When set totrue, the response includes active and inactive breakpoints. Otherwise, it includes only active breakpoints.

↳ actionListBreakpointsRequest\BreakpointActionValue

When set, the response includes only breakpoints with the specified action.

↳ strip_resultsbool

This field is deprecated. The following fields are always stripped out of the result:stack_frames,evaluated_expressions andvariable_table.

↳ wait_tokenstring

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 codegoogle.rpc.Code.ABORTED (RPC) is returned on wait timeout, which should be called again with the samewait_token.

↳ client_versionstring

Required. The client version making the call. Schema:domain/type/version (e.g.,google.com/intellij/v1).

getDebuggeeId

Required. ID of the debuggee whose breakpoints to list.

Returns
TypeDescription
string

setDebuggeeId

Required. ID of the debuggee whose breakpoints to list.

Parameter
NameDescription
varstring
Returns
TypeDescription
$this

getIncludeAllUsers

When set totrue, the response includes the list of breakpoints set byany user. Otherwise, it includes only breakpoints set by the caller.

Returns
TypeDescription
bool

setIncludeAllUsers

When set totrue, the response includes the list of breakpoints set byany user. Otherwise, it includes only breakpoints set by the caller.

Parameter
NameDescription
varbool
Returns
TypeDescription
$this

getIncludeInactive

When set totrue, the response includes active and inactivebreakpoints. Otherwise, it includes only active breakpoints.

Returns
TypeDescription
bool

setIncludeInactive

When set totrue, the response includes active and inactivebreakpoints. Otherwise, it includes only active breakpoints.

Parameter
NameDescription
varbool
Returns
TypeDescription
$this

getAction

When set, the response includes only breakpoints with the specified action.

Returns
TypeDescription
ListBreakpointsRequest\BreakpointActionValue|null

hasAction

clearAction

setAction

When set, the response includes only breakpoints with the specified action.

Parameter
NameDescription
varListBreakpointsRequest\BreakpointActionValue
Returns
TypeDescription
$this

getStripResults

This field is deprecated. The following fields are always stripped out ofthe result:stack_frames,evaluated_expressions andvariable_table.

Returns
TypeDescription
bool

setStripResults

This field is deprecated. The following fields are always stripped out ofthe result:stack_frames,evaluated_expressions andvariable_table.

Parameter
NameDescription
varbool
Returns
TypeDescription
$this

getWaitToken

A wait token that, if specified, blocks the call until the breakpointslist has changed, or a server selected timeout has expired. The valueshould be set from the last response. The error codegoogle.rpc.Code.ABORTED (RPC) is returned on wait timeout, whichshould be called again with the samewait_token.

Returns
TypeDescription
string

setWaitToken

A wait token that, if specified, blocks the call until the breakpointslist has changed, or a server selected timeout has expired. The valueshould be set from the last response. The error codegoogle.rpc.Code.ABORTED (RPC) is returned on wait timeout, whichshould be called again with the samewait_token.

Parameter
NameDescription
varstring
Returns
TypeDescription
$this

getClientVersion

Required. The client version making the call.

Schema:domain/type/version (e.g.,google.com/intellij/v1).

Returns
TypeDescription
string

setClientVersion

Required. The client version making the call.

Schema:domain/type/version (e.g.,google.com/intellij/v1).

Parameter
NameDescription
varstring
Returns
TypeDescription
$this

static::build

Parameters
NameDescription
debuggeeIdstring

Required. ID of the debuggee whose breakpoints to list.

clientVersionstring

Required. The client version making the call.Schema:domain/type/version (e.g.,google.com/intellij/v1).

Returns
TypeDescription
ListBreakpointsRequest

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-10-30 UTC.