Stackdriver Debugger V2 Client - Class ListActiveBreakpointsRequest (1.9.0)

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

Request to list active breakpoints.

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

Namespace

Google \ Cloud \ Debugger \ V2

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ debuggee_id string

Required. Identifies the debuggee.

↳ wait_token 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 next_wait_token field in the last response. The initial value should be set to "init".

↳ success_on_timeout bool

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.

getDebuggeeId

Required. Identifies the debuggee.

Returns
Type Description
string

setDebuggeeId

Required. Identifies the debuggee.

Parameter
Name Description
var string
Returns
Type Description
$this

getWaitToken

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

Returns
Type Description
string

setWaitToken

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

Parameter
Name Description
var string
Returns
Type Description
$this

getSuccessOnTimeout

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.

Returns
Type Description
bool

setSuccessOnTimeout

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.

Parameter
Name Description
var bool
Returns
Type Description
$this

static::build

Parameter
Name Description
debuggeeId string

Required. Identifies the debuggee.

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