Stackdriver Debugger V2 Client - Class Debugger2Client (1.9.5) Stay organized with collections Save and categorize content based on your preferences.
Reference documentation and code samples for the Stackdriver Debugger V2 Client class Debugger2Client.
Service Description: The Debugger service provides the API that allows users to collect run-timeinformation from a running application, without stopping or slowing it downand without modifying its state. An application may include one ormore replicated processes performing the same work.
A debugged application is represented using the Debuggee concept. TheDebugger service provides a way to query for available debuggees, but doesnot provide a way to create one. A debuggee is created using the Controllerservice, usually by running a debugger agent with the application.
The Debugger service enables the client to set one or more Breakpoints on aDebuggee and collect the results of the set Breakpoints.
This class provides the ability to make remote calls to the backing service through methodcalls that map to API methods.
Namespace
Google \ Cloud \ Debugger \ V2 \ ClientMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
options | arrayOptional. Options for configuring the service API wrapper. |
↳ apiEndpoint | stringThe address of the API remote host. May optionally include the port, formatted as " |
↳ credentials | string|array|FetchAuthTokenInterface|CredentialsWrapperThe credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array.Advanced usage: In addition, this option can also accept a pre-constructedGoogle\Auth\FetchAuthTokenInterface object orGoogle\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.Important: If you accept a credential configuration (credential JSON/File/Stream) from an external source for authentication to Google Cloud Platform, you must validate it before providing it to any Google API or library. Providing an unvalidated credential configuration to Google APIs can compromise the security of your systems and data. For more informationhttps://cloud.google.com/docs/authentication/external/externally-sourced-credentials |
↳ credentialsConfig | arrayOptions used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, seeGoogle\ApiCore\CredentialsWrapper::build() . |
↳ disableRetries | boolDetermines whether or not retries defined by the client configuration should be disabled. Defaults to |
↳ clientConfig | string|arrayClient method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder. |
↳ transport | string|TransportInterfaceThe transport used for executing network requests. May be either the string |
↳ transportConfig | arrayConfiguration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See theGoogle\ApiCore\Transport\GrpcTransport::build() andGoogle\ApiCore\Transport\RestTransport::build() methods for the supported options. |
↳ clientCertSource | callableA callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS. |
↳ logger | false|LoggerInterfaceA PSR-3 compliant logger. If set to false, logging is disabled, ignoring the 'GOOGLE_SDK_PHP_LOGGING' environment flag |
deleteBreakpoint
Deletes the breakpoint from the debuggee.
The async variant isDebugger2Client::deleteBreakpointAsync() .
| Parameters | |
|---|---|
| Name | Description |
request | Google\Cloud\Debugger\V2\DeleteBreakpointRequestA request to house fields associated with the call. |
callOptions | arrayOptional. |
↳ retrySettings | RetrySettings|arrayRetry settings to use for this call. Can be aGoogle\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation onGoogle\ApiCore\RetrySettings for example usage. |
use Google\ApiCore\ApiException;use Google\Cloud\Debugger\V2\Client\Debugger2Client;use Google\Cloud\Debugger\V2\DeleteBreakpointRequest;/** * @param string $debuggeeId ID of the debuggee whose breakpoint to delete. * @param string $breakpointId ID of the breakpoint to delete. * @param string $clientVersion The client version making the call. * Schema: `domain/type/version` (e.g., `google.com/intellij/v1`). */function delete_breakpoint_sample( string $debuggeeId, string $breakpointId, string $clientVersion): void { // Create a client. $debugger2Client = new Debugger2Client(); // Prepare the request message. $request = (new DeleteBreakpointRequest()) ->setDebuggeeId($debuggeeId) ->setBreakpointId($breakpointId) ->setClientVersion($clientVersion); // Call the API and handle any network failures. try { $debugger2Client->deleteBreakpoint($request); printf('Call completed successfully.' . PHP_EOL); } catch (ApiException $ex) { printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage()); }}/** * Helper to execute the sample. * * This sample has been automatically generated and should be regarded as a code * template only. It will require modifications to work: * - It may require correct/in-range values for request initialization. * - It may require specifying regional endpoints when creating the service client, * please see the apiEndpoint client configuration option for more details. */function callSample(): void{ $debuggeeId = '[DEBUGGEE_ID]'; $breakpointId = '[BREAKPOINT_ID]'; $clientVersion = '[CLIENT_VERSION]'; delete_breakpoint_sample($debuggeeId, $breakpointId, $clientVersion);}getBreakpoint
Gets breakpoint information.
The async variant isDebugger2Client::getBreakpointAsync() .
| Parameters | |
|---|---|
| Name | Description |
request | Google\Cloud\Debugger\V2\GetBreakpointRequestA request to house fields associated with the call. |
callOptions | arrayOptional. |
↳ retrySettings | RetrySettings|arrayRetry settings to use for this call. Can be aGoogle\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation onGoogle\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Debugger\V2\GetBreakpointResponse | |
use Google\ApiCore\ApiException;use Google\Cloud\Debugger\V2\Client\Debugger2Client;use Google\Cloud\Debugger\V2\GetBreakpointRequest;use Google\Cloud\Debugger\V2\GetBreakpointResponse;/** * @param string $debuggeeId ID of the debuggee whose breakpoint to get. * @param string $breakpointId ID of the breakpoint to get. * @param string $clientVersion The client version making the call. * Schema: `domain/type/version` (e.g., `google.com/intellij/v1`). */function get_breakpoint_sample( string $debuggeeId, string $breakpointId, string $clientVersion): void { // Create a client. $debugger2Client = new Debugger2Client(); // Prepare the request message. $request = (new GetBreakpointRequest()) ->setDebuggeeId($debuggeeId) ->setBreakpointId($breakpointId) ->setClientVersion($clientVersion); // Call the API and handle any network failures. try { /** @var GetBreakpointResponse $response */ $response = $debugger2Client->getBreakpoint($request); printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString()); } catch (ApiException $ex) { printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage()); }}/** * Helper to execute the sample. * * This sample has been automatically generated and should be regarded as a code * template only. It will require modifications to work: * - It may require correct/in-range values for request initialization. * - It may require specifying regional endpoints when creating the service client, * please see the apiEndpoint client configuration option for more details. */function callSample(): void{ $debuggeeId = '[DEBUGGEE_ID]'; $breakpointId = '[BREAKPOINT_ID]'; $clientVersion = '[CLIENT_VERSION]'; get_breakpoint_sample($debuggeeId, $breakpointId, $clientVersion);}listBreakpoints
Lists all breakpoints for the debuggee.
The async variant isDebugger2Client::listBreakpointsAsync() .
| Parameters | |
|---|---|
| Name | Description |
request | Google\Cloud\Debugger\V2\ListBreakpointsRequestA request to house fields associated with the call. |
callOptions | arrayOptional. |
↳ retrySettings | RetrySettings|arrayRetry settings to use for this call. Can be aGoogle\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation onGoogle\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Debugger\V2\ListBreakpointsResponse | |
use Google\ApiCore\ApiException;use Google\Cloud\Debugger\V2\Client\Debugger2Client;use Google\Cloud\Debugger\V2\ListBreakpointsRequest;use Google\Cloud\Debugger\V2\ListBreakpointsResponse;/** * @param string $debuggeeId ID of the debuggee whose breakpoints to list. * @param string $clientVersion The client version making the call. * Schema: `domain/type/version` (e.g., `google.com/intellij/v1`). */function list_breakpoints_sample(string $debuggeeId, string $clientVersion): void{ // Create a client. $debugger2Client = new Debugger2Client(); // Prepare the request message. $request = (new ListBreakpointsRequest()) ->setDebuggeeId($debuggeeId) ->setClientVersion($clientVersion); // Call the API and handle any network failures. try { /** @var ListBreakpointsResponse $response */ $response = $debugger2Client->listBreakpoints($request); printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString()); } catch (ApiException $ex) { printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage()); }}/** * Helper to execute the sample. * * This sample has been automatically generated and should be regarded as a code * template only. It will require modifications to work: * - It may require correct/in-range values for request initialization. * - It may require specifying regional endpoints when creating the service client, * please see the apiEndpoint client configuration option for more details. */function callSample(): void{ $debuggeeId = '[DEBUGGEE_ID]'; $clientVersion = '[CLIENT_VERSION]'; list_breakpoints_sample($debuggeeId, $clientVersion);}listDebuggees
Lists all the debuggees that the user has access to.
The async variant isDebugger2Client::listDebuggeesAsync() .
| Parameters | |
|---|---|
| Name | Description |
request | Google\Cloud\Debugger\V2\ListDebuggeesRequestA request to house fields associated with the call. |
callOptions | arrayOptional. |
↳ retrySettings | RetrySettings|arrayRetry settings to use for this call. Can be aGoogle\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation onGoogle\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Debugger\V2\ListDebuggeesResponse | |
use Google\ApiCore\ApiException;use Google\Cloud\Debugger\V2\Client\Debugger2Client;use Google\Cloud\Debugger\V2\ListDebuggeesRequest;use Google\Cloud\Debugger\V2\ListDebuggeesResponse;/** * @param string $project Project number of a Google Cloud project whose debuggees to list. * @param string $clientVersion The client version making the call. * Schema: `domain/type/version` (e.g., `google.com/intellij/v1`). */function list_debuggees_sample(string $project, string $clientVersion): void{ // Create a client. $debugger2Client = new Debugger2Client(); // Prepare the request message. $request = (new ListDebuggeesRequest()) ->setProject($project) ->setClientVersion($clientVersion); // Call the API and handle any network failures. try { /** @var ListDebuggeesResponse $response */ $response = $debugger2Client->listDebuggees($request); printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString()); } catch (ApiException $ex) { printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage()); }}/** * Helper to execute the sample. * * This sample has been automatically generated and should be regarded as a code * template only. It will require modifications to work: * - It may require correct/in-range values for request initialization. * - It may require specifying regional endpoints when creating the service client, * please see the apiEndpoint client configuration option for more details. */function callSample(): void{ $project = '[PROJECT]'; $clientVersion = '[CLIENT_VERSION]'; list_debuggees_sample($project, $clientVersion);}setBreakpoint
Sets the breakpoint to the debuggee.
The async variant isDebugger2Client::setBreakpointAsync() .
| Parameters | |
|---|---|
| Name | Description |
request | Google\Cloud\Debugger\V2\SetBreakpointRequestA request to house fields associated with the call. |
callOptions | arrayOptional. |
↳ retrySettings | RetrySettings|arrayRetry settings to use for this call. Can be aGoogle\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation onGoogle\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Debugger\V2\SetBreakpointResponse | |
use Google\ApiCore\ApiException;use Google\Cloud\Debugger\V2\Breakpoint;use Google\Cloud\Debugger\V2\Client\Debugger2Client;use Google\Cloud\Debugger\V2\SetBreakpointRequest;use Google\Cloud\Debugger\V2\SetBreakpointResponse;/** * @param string $debuggeeId ID of the debuggee where the breakpoint is to be set. * @param string $clientVersion The client version making the call. * Schema: `domain/type/version` (e.g., `google.com/intellij/v1`). */function set_breakpoint_sample(string $debuggeeId, string $clientVersion): void{ // Create a client. $debugger2Client = new Debugger2Client(); // Prepare the request message. $breakpoint = new Breakpoint(); $request = (new SetBreakpointRequest()) ->setDebuggeeId($debuggeeId) ->setBreakpoint($breakpoint) ->setClientVersion($clientVersion); // Call the API and handle any network failures. try { /** @var SetBreakpointResponse $response */ $response = $debugger2Client->setBreakpoint($request); printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString()); } catch (ApiException $ex) { printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage()); }}/** * Helper to execute the sample. * * This sample has been automatically generated and should be regarded as a code * template only. It will require modifications to work: * - It may require correct/in-range values for request initialization. * - It may require specifying regional endpoints when creating the service client, * please see the apiEndpoint client configuration option for more details. */function callSample(): void{ $debuggeeId = '[DEBUGGEE_ID]'; $clientVersion = '[CLIENT_VERSION]'; set_breakpoint_sample($debuggeeId, $clientVersion);}deleteBreakpointAsync
| Parameters | |
|---|---|
| Name | Description |
request | Google\Cloud\Debugger\V2\DeleteBreakpointRequest |
optionalArgs | array |
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<void> | |
getBreakpointAsync
| Parameters | |
|---|---|
| Name | Description |
request | Google\Cloud\Debugger\V2\GetBreakpointRequest |
optionalArgs | array |
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Debugger\V2\GetBreakpointResponse> | |
listBreakpointsAsync
| Parameters | |
|---|---|
| Name | Description |
request | Google\Cloud\Debugger\V2\ListBreakpointsRequest |
optionalArgs | array |
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Debugger\V2\ListBreakpointsResponse> | |
listDebuggeesAsync
| Parameters | |
|---|---|
| Name | Description |
request | Google\Cloud\Debugger\V2\ListDebuggeesRequest |
optionalArgs | array |
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Debugger\V2\ListDebuggeesResponse> | |
setBreakpointAsync
| Parameters | |
|---|---|
| Name | Description |
request | Google\Cloud\Debugger\V2\SetBreakpointRequest |
optionalArgs | array |
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Debugger\V2\SetBreakpointResponse> | |
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.