Google Cloud Profiler V2 Client - Class ProfilerServiceClient (1.2.4)

Reference documentation and code samples for the Google Cloud Profiler V2 Client class ProfilerServiceClient.

Service Description: Manage the collection of continuous profiling data provided by profiling agents running in the cloud or by an offline provider of profiling data.

General guidelines:

Profiles for a single deployment must be created in ascending time order.
Profiles can be created in either online or offline mode, see below.

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:

$profilerServiceClient = new ProfilerServiceClient();
try {
    $response = $profilerServiceClient->createOfflineProfile();
} finally {
    $profilerServiceClient->close();
}

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.

This service has a new (beta) implementation. See Google\Cloud\Profiler\V2\Client\ProfilerServiceClient to use the new surface.

Namespace

Google \ Cloud \ Profiler \ 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.

createOfflineProfile

CreateOfflineProfile creates a new profile resource in the offline mode.

The client provides the profile to create along with the profile bytes, the server records it.

Parameters
Name	Description
`optionalArgs`	`array` Optional.
`↳ parent`	`string` Parent project to create the profile in.
`↳ profile`	`Profile` Contents of the profile to create.
`↳ 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\Profiler\V2\Profile`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Profiler\V2\Profile;
use Google\Cloud\Profiler\V2\ProfilerServiceClient;

/**
 * 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 create_offline_profile_sample(): void
{
    // Create a client.
    $profilerServiceClient = new ProfilerServiceClient();

    // Call the API and handle any network failures.
    try {
        /** @var Profile $response */
        $response = $profilerServiceClient->createOfflineProfile();
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

createProfile

CreateProfile creates a new profile resource in the online mode.

The server ensures that the new profiles are created at a constant rate per deployment, so the creation request may hang for some time until the next profile session is available.

The request may fail with ABORTED error if the creation is not available within ~1m, the response will indicate the duration of the backoff the client should take before attempting creating a profile again. The backoff duration is returned in google.rpc.RetryInfo extension on the response status. To a gRPC client, the extension will be return as a binary-serialized proto in the trailing metadata item named "google.rpc.retryinfo-bin".

Parameters
Name	Description
`optionalArgs`	`array` Optional.
`↳ parent`	`string` Parent project to create the profile in.
`↳ deployment`	`Deployment` Deployment details.
`↳ profileType`	`int[]` One or more profile types that the agent is capable of providing. For allowed values, use constants defined on Google\Cloud\Profiler\V2\ProfileType
`↳ 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\Profiler\V2\Profile`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Profiler\V2\Profile;
use Google\Cloud\Profiler\V2\ProfilerServiceClient;

/**
 * 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 create_profile_sample(): void
{
    // Create a client.
    $profilerServiceClient = new ProfilerServiceClient();

    // Call the API and handle any network failures.
    try {
        /** @var Profile $response */
        $response = $profilerServiceClient->createProfile();
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

updateProfile

UpdateProfile updates the profile bytes and labels on the profile resource created in the online mode. Updating the bytes for profiles created in the offline mode is currently not supported: the profile content must be provided at the time of the profile creation.

Parameters
Name	Description
`optionalArgs`	`array` Optional.
`↳ profile`	`Profile` Profile to update.
`↳ updateMask`	`FieldMask` Field mask used to specify the fields to be overwritten. Currently only profile_bytes and labels fields are supported by UpdateProfile, so only those fields can be specified in the mask. When no mask is provided, all fields are overwritten.
`↳ 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\Profiler\V2\Profile`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Profiler\V2\Profile;
use Google\Cloud\Profiler\V2\ProfilerServiceClient;

/**
 * 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 update_profile_sample(): void
{
    // Create a client.
    $profilerServiceClient = new ProfilerServiceClient();

    // Call the API and handle any network failures.
    try {
        /** @var Profile $response */
        $response = $profilerServiceClient->updateProfile();
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

static::profileName

Formats a string containing the fully-qualified path to represent a profile resource.

Parameters
Name	Description
`project`	`string`
`profile`	`string`

Returns
Type	Description
`string`	The formatted profile resource.

static::projectName

Formats a string containing the fully-qualified path to represent a project resource.

Parameter
Name	Description
`project`	`string`

Returns
Type	Description
`string`	The formatted project resource.

static::parseName

Parses a formatted name string and returns an associative array of the components in the name.

The following name formats are supported: Template: Pattern

profile: projects/{project}/profiles/{profile}
project: projects/{project}

The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.

Parameters
Name	Description
`formattedName`	`string` The formatted name string
`template`	`string` Optional name of template to match

Returns
Type	Description
`array`	An associative array from name component IDs to component values.

Constants

SERVICE_NAME

Value: 'google.devtools.cloudprofiler.v2.ProfilerService'

The name of the service.

SERVICE_ADDRESS

Value: 'cloudprofiler.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.