Stackdriver Debugger V2 Client - Class ListBreakpointsRequest (1.8.7)

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

Namespace

Google \ Cloud \ Debugger \ V2

Methods

__construct

Constructor.

Parameters
Name Description
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
Type Description
string

setDebuggeeId

Required. ID of the debuggee whose breakpoints to list.

Parameter
Name Description
var string
Returns
Type Description
$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
Type Description
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
Name Description
var bool
Returns
Type Description
$this

getIncludeInactive

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

Returns
Type Description
bool

setIncludeInactive

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

Parameter
Name Description
var bool
Returns
Type Description
$this

getAction

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

Returns
Type Description
Google\Cloud\Debugger\V2\ListBreakpointsRequest\BreakpointActionValue|null

hasAction

clearAction

setAction

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

Parameter
Name Description
var Google\Cloud\Debugger\V2\ListBreakpointsRequest\BreakpointActionValue
Returns
Type Description
$this

getStripResults

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

Returns
Type Description
bool

setStripResults

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

Parameter
Name Description
var bool
Returns
Type Description
$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
Type Description
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
Name Description
var string
Returns
Type Description
$this

getClientVersion

Required. The client version making the call.

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

Returns
Type Description
string

setClientVersion

Required. The client version making the call.

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

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameters
Name Description
debuggeeId string

Required. ID of the debuggee whose breakpoints to list.

clientVersion string

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

Returns
Type Description
Google\Cloud\Debugger\V2\ListBreakpointsRequest