Documentation

Google_Service_CloudProfiler_Resource_ProjectsProfiles extends Google_Service_Resource
in package

The "profiles" collection of methods.

Typical usage is: $cloudprofilerService = new Google_Service_CloudProfiler(...); $profiles = $cloudprofilerService->profiles;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
create()  : Google_Service_CloudProfiler_Profile
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". (profiles.create)
createOffline()  : Google_Service_CloudProfiler_Profile
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. (profiles.createOffline)
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
patch()  : Google_Service_CloudProfiler_Profile
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. (profiles.patch)
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass

create()

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". (profiles.create)

public create(string $parent, Google_Service_CloudProfiler_CreateProfileRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudProfiler_Profile
Parameters
$parent : string

Parent project to create the profile in.

$postBody : Google_Service_CloudProfiler_CreateProfileRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_CloudProfiler_Profile

createOffline()

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. (profiles.createOffline)

public createOffline(string $parent, Google_Service_CloudProfiler_Profile $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudProfiler_Profile
Parameters
$parent : string

Parent project to create the profile in.

$postBody : Google_Service_CloudProfiler_Profile
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_CloudProfiler_Profile

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string

$requestUrl

patch()

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. (profiles.patch)

public patch(string $name, Google_Service_CloudProfiler_Profile $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudProfiler_Profile
Parameters
$name : string

Output only. Opaque, server-assigned, unique ID for this profile.

$postBody : Google_Service_CloudProfiler_Profile
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string updateMask 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.

Return values
Google_Service_CloudProfiler_Profile

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed

Search results