Stackdriver Debugger V2 Client - Class ListBreakpointsRequest (1.4.16)

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

Request to list breakpoints.

Generated from protobuf message google.devtools.clouddebugger.v2.ListBreakpointsRequest

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ debuggee_id string

Required. ID of the debuggee whose breakpoints to list.

↳ include_all_users bool

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

↳ include_inactive bool

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

↳ action Google\Cloud\Debugger\V2\ListBreakpointsRequest\BreakpointActionValue

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

↳ strip_results bool

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

↳ wait_token string

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.

↳ client_version string

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
var string
Returns
TypeDescription
$this

getIncludeAllUsers

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

Returns
TypeDescription
bool

setIncludeAllUsers

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

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getIncludeInactive

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

Returns
TypeDescription
bool

setIncludeInactive

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

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getAction

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

Returns
TypeDescription
Google\Cloud\Debugger\V2\ListBreakpointsRequest\BreakpointActionValue|null

hasAction

clearAction

setAction

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

Parameter
NameDescription
var Google\Cloud\Debugger\V2\ListBreakpointsRequest\BreakpointActionValue
Returns
TypeDescription
$this

getStripResults

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

Returns
TypeDescription
bool

setStripResults

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

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getWaitToken

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.

Returns
TypeDescription
string

setWaitToken

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.

Parameter
NameDescription
var string
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
var string
Returns
TypeDescription
$this