Stackdriver Debugger V2 Client - Class Debugger2Client (1.9.0)

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-time information from a running application, without stopping or slowing it down and without modifying its state. An application may include one or more replicated processes performing the same work.

A debugged application is represented using the Debuggee concept. The Debugger service provides a way to query for available debuggees, but does not provide a way to create one. A debuggee is created using the Controller service, usually by running a debugger agent with the application.

The Debugger service enables the client to set one or more Breakpoints on a Debuggee and collect the results of the set Breakpoints.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods.

Namespace

Google \ Cloud \ Debugger \ V2 \ Client

Methods

__construct

Constructor.

Parameters
Name Description
options array

Optional. Options for configuring the service API wrapper.
↳ apiEndpoint string

The address of the API remote host. May optionally include the port, formatted as "
↳ credentials string|array|FetchAuthTokenInterface|CredentialsWrapper

The 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-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.
↳ credentialsConfig array

Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .
↳ disableRetries bool

Determines whether or not retries defined by the client configuration should be disabled. Defaults to false.
↳ clientConfig string|array

Client 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|TransportInterface

The transport used for executing network requests. May be either the string rest or grpc. Defaults to grpc if gRPC support is detected on the system. Advanced usage: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
↳ transportConfig array

Configuration 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 the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.
↳ clientCertSource callable

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

deleteBreakpoint

Deletes the breakpoint from the debuggee.

The async variant is Google\Cloud\Debugger\V2\Client\Debugger2Client::deleteBreakpointAsync() .

Parameters
Name Description
request Google\Cloud\Debugger\V2\DeleteBreakpointRequest

A request to house fields associated with the call.
callOptions array

Optional.
↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
Example 
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 is Google\Cloud\Debugger\V2\Client\Debugger2Client::getBreakpointAsync() .

Parameters
Name Description
request Google\Cloud\Debugger\V2\GetBreakpointRequest

A request to house fields associated with the call.
callOptions array

Optional.
↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
Returns
Type Description
Google\Cloud\Debugger\V2\GetBreakpointResponse
Example 
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 is Google\Cloud\Debugger\V2\Client\Debugger2Client::listBreakpointsAsync() .

Parameters
Name Description
request Google\Cloud\Debugger\V2\ListBreakpointsRequest

A request to house fields associated with the call.
callOptions array

Optional.
↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
Returns
Type Description
Google\Cloud\Debugger\V2\ListBreakpointsResponse
Example 
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 is Google\Cloud\Debugger\V2\Client\Debugger2Client::listDebuggeesAsync() .

Parameters
Name Description
request Google\Cloud\Debugger\V2\ListDebuggeesRequest

A request to house fields associated with the call.
callOptions array

Optional.
↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
Returns
Type Description
Google\Cloud\Debugger\V2\ListDebuggeesResponse
Example 
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 is Google\Cloud\Debugger\V2\Client\Debugger2Client::setBreakpointAsync() .

Parameters
Name Description
request Google\Cloud\Debugger\V2\SetBreakpointRequest

A request to house fields associated with the call.
callOptions array

Optional.
↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
Returns
Type Description
Google\Cloud\Debugger\V2\SetBreakpointResponse
Example 
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

getBreakpointAsync

Parameters
Name Description
request Google\Cloud\Debugger\V2\GetBreakpointRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

listBreakpointsAsync

Parameters
Name Description
request Google\Cloud\Debugger\V2\ListBreakpointsRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

listDebuggeesAsync

Parameters
Name Description
request Google\Cloud\Debugger\V2\ListDebuggeesRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

setBreakpointAsync

Parameters
Name Description
request Google\Cloud\Debugger\V2\SetBreakpointRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface