Stackdriver Debugger V2 Client - Class Debugger2Client (1.7.0)

Version 1.7.0

• 1.8.7 (latest)
• 1.8.6
• 1.7.0
• 1.6.4
• 1.5.1
• 1.4.16

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

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.

This class is currently experimental and may be subject to changes. See Google\Cloud\Debugger\V2\Debugger2Client for the stable implementation

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.

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

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

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

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

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