class ProjectsProfiles extends Resource (View source)

The "profiles" collection of methods.

Typical usage is:

 $cloudprofilerService = new Google\Service\CloudProfiler(...);
 $profiles = $cloudprofilerService->projects_profiles;

Methods

create(string $parent, CreateProfileRequest $postBody, array $optParams = [])

CreateProfile creates a new profile resource in the online mode. _Direct use of this API is discouraged, please use a supported profiler agent instead for profile collection._ 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(string $parent, Profile $postBody, array $optParams = [])

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. _Direct use of this API is discouraged, please use a supported profiler agent instead for profile collection._ (profiles.createOffline)

listProjectsProfiles(string $parent, array $optParams = [])

Lists profiles which have been collected so far and for which the caller has permission to view. (profiles.listProjectsProfiles)

patch(string $name, Profile $postBody, array $optParams = [])

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. _Direct use of this API is discouraged, please use a supported profiler agent instead for profile collection._ (profiles.patch)

Details

Profile create(string $parent, CreateProfileRequest $postBody, array $optParams = [])

CreateProfile creates a new profile resource in the online mode. _Direct use of this API is discouraged, please use a supported profiler agent instead for profile collection._ 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)

Parameters

string $parent

Parent project to create the profile in.

CreateProfileRequest $postBody
array $optParams

Optional parameters.

Return Value

Profile

Exceptions

Exception

Profile createOffline(string $parent, Profile $postBody, array $optParams = [])

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. _Direct use of this API is discouraged, please use a supported profiler agent instead for profile collection._ (profiles.createOffline)

Parameters

string $parent

Parent project to create the profile in.

Profile $postBody
array $optParams

Optional parameters.

Return Value

Profile

Exceptions

Exception

ListProfilesResponse listProjectsProfiles(string $parent, array $optParams = [])

Lists profiles which have been collected so far and for which the caller has permission to view. (profiles.listProjectsProfiles)

Parameters

string $parent

Required. The parent, which owns this collection of profiles. Format: projects/{user_project_id}

array $optParams

Optional parameters.

Return Value

ListProfilesResponse

Exceptions

Exception

Profile patch(string $name, Profile $postBody, array $optParams = [])

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. _Direct use of this API is discouraged, please use a supported profiler agent instead for profile collection._ (profiles.patch)

Parameters

string $name

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

Profile $postBody
array $optParams

Optional parameters.

Return Value

Profile

Exceptions

Exception