Stackdriver Debugger V2 Client - Class Debugger2Client (1.5.1)

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. Sample code to get started:

$debugger2Client = new Debugger2Client();
try {
    $debuggeeId = 'debuggee_id';
    $breakpointId = 'breakpoint_id';
    $clientVersion = 'client_version';
    $debugger2Client->deleteBreakpoint($debuggeeId, $breakpointId, $clientVersion);
} finally {
    $debugger2Client->close();
}

Namespace

Google \ Cloud \ Debugger \ V2

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.

Parameters
Name	Description
`debuggeeId`	`string` Required. ID of the debuggee whose breakpoint to delete.
`breakpointId`	`string` Required. ID of the breakpoint to delete.
`clientVersion`	`string` Required. The client version making the call. Schema: `domain/type/version` (e.g., `google.com/intellij/v1`).
`optionalArgs`	`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\Debugger2Client;

/**
 * @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();

    // Call the API and handle any network failures.
    try {
        $debugger2Client->deleteBreakpoint($debuggeeId, $breakpointId, $clientVersion);
        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.

Parameters
Name	Description
`debuggeeId`	`string` Required. ID of the debuggee whose breakpoint to get.
`breakpointId`	`string` Required. ID of the breakpoint to get.
`clientVersion`	`string` Required. The client version making the call. Schema: `domain/type/version` (e.g., `google.com/intellij/v1`).
`optionalArgs`	`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\Debugger2Client;
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();

    // Call the API and handle any network failures.
    try {
        /** @var GetBreakpointResponse $response */
        $response = $debugger2Client->getBreakpoint($debuggeeId, $breakpointId, $clientVersion);
        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.

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`).
`optionalArgs`	`array` Optional.
`↳ includeAllUsers`	`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.
`↳ includeInactive`	`bool` When set to `true`, the response includes active and inactive breakpoints. Otherwise, it includes only active breakpoints.
`↳ action`	`BreakpointActionValue` When set, the response includes only breakpoints with the specified action.
`↳ stripResults`	`bool` This field is deprecated. The following fields are always stripped out of the result: `stack_frames`, `evaluated_expressions` and `variable_table`.
`↳ waitToken`	`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`.
`↳ 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\Debugger2Client;
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();

    // Call the API and handle any network failures.
    try {
        /** @var ListBreakpointsResponse $response */
        $response = $debugger2Client->listBreakpoints($debuggeeId, $clientVersion);
        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.

Parameters
Name	Description
`project`	`string` Required. Project number of a Google Cloud project whose debuggees to list.
`clientVersion`	`string` Required. The client version making the call. Schema: `domain/type/version` (e.g., `google.com/intellij/v1`).
`optionalArgs`	`array` Optional.
`↳ includeInactive`	`bool` When set to `true`, the result includes all debuggees. Otherwise, the result includes only debuggees that are active.
`↳ 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\Debugger2Client;
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();

    // Call the API and handle any network failures.
    try {
        /** @var ListDebuggeesResponse $response */
        $response = $debugger2Client->listDebuggees($project, $clientVersion);
        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.

Parameters
Name	Description
`debuggeeId`	`string` Required. ID of the debuggee where the breakpoint is to be set.
`breakpoint`	`Google\Cloud\Debugger\V2\Breakpoint` Required. Breakpoint specification to set. The field `location` of the breakpoint must be set.
`clientVersion`	`string` Required. The client version making the call. Schema: `domain/type/version` (e.g., `google.com/intellij/v1`).
`optionalArgs`	`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\Debugger2Client;
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 any non-scalar elements to be passed along with the request.
    $breakpoint = new Breakpoint();

    // Call the API and handle any network failures.
    try {
        /** @var SetBreakpointResponse $response */
        $response = $debugger2Client->setBreakpoint($debuggeeId, $breakpoint, $clientVersion);
        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);
}

Constants

SERVICE_NAME

Value: 'google.devtools.clouddebugger.v2.Debugger2'

The name of the service.

SERVICE_ADDRESS

Value: 'clouddebugger.googleapis.com'

The default address of the service.

DEFAULT_SERVICE_PORT

Value: 443

The default port of the service.

CODEGEN_NAME

Value: 'gapic'

The name of the code generator, to be included in the agent header.