Moodle PHP Documentation 4.4
Moodle 4.4.1 (Build: 20240610) (db07c09afc5)
Google_Service_Clouddebugger_ControllerDebuggeesBreakpoints_Resource Class Reference

The "breakpoints" collection of methods. More...

Inheritance diagram for Google_Service_Clouddebugger_ControllerDebuggeesBreakpoints_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 listControllerDebuggeesBreakpoints ($debuggeeId, $optParams=array())
 Returns the list of all active breakpoints for the specified debuggee.
 
 update ($debuggeeId, $id, Google_Service_Clouddebugger_UpdateActiveBreakpointRequest $postBody, $optParams=array())
 Updates the breakpoint state or mutable fields.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "breakpoints" collection of methods.

Typical usage is: $clouddebuggerService = new Google_Service_Clouddebugger(...); $breakpoints = $clouddebuggerService->breakpoints;

Member Function Documentation

◆ call()

Google_Service_Resource::call ( $name,
$arguments,
$expected_class = null )
inherited

TODO: This function needs simplifying.

Parameters
$name
$arguments
$expected_class- optional, the expected class name
Return values
Google_Http_Request|expected_class
Exceptions
Google_Exception

◆ listControllerDebuggeesBreakpoints()

Google_Service_Clouddebugger_ControllerDebuggeesBreakpoints_Resource::listControllerDebuggeesBreakpoints ( $debuggeeId,
$optParams = array() )

Returns the list of all active breakpoints for the specified debuggee.

The breakpoint specification (location, condition, and expression 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 the breakpoint was set to, but that doesn't change the breakpoint semantics. Thus, 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 breakpoints that are complete until the controller removes them from the active list to avoid setting those breakpoints again. (breakpoints.listControllerDebuggeesBreakpoints)

Parameters
string$debuggeeIdIdentifies the debuggee.
array$optParamsOptional parameters.

@opt_param string waitToken A wait 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 last returned response. The error code google.rpc.Code.ABORTED is returned on wait timeout (which does not require the agent to re-register with the server)

Return values
Google_Service_Clouddebugger_ListActiveBreakpointsResponse

◆ update()

Google_Service_Clouddebugger_ControllerDebuggeesBreakpoints_Resource::update ( $debuggeeId,
$id,
Google_Service_Clouddebugger_UpdateActiveBreakpointRequest $postBody,
$optParams = array() )

Updates the breakpoint state or mutable fields.

The entire Breakpoint protobuf must be sent back to the controller. Updates to active breakpoint fields are only allowed if the new value does not change the breakpoint specification. Updates to the 'location', 'condition' and 'expression' fields should not alter the breakpoint semantics. They are restricted to changes such as canonicalizing a value or snapping the location to the correct line of code. (breakpoints.update)

Parameters
string$debuggeeIdIdentifies the debuggee being debugged.
string$idBreakpoint identifier, unique in the scope of the debuggee.
Google_UpdateActiveBreakpointRequest$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Clouddebugger_UpdateActiveBreakpointResponse

The documentation for this class was generated from the following file: