Cloud Profiler v2 API - Class ProfilerService.ProfilerServiceBase (2.5.0)

[BindServiceMethod(typeof(ProfilerService), "BindService")]
public abstract class ProfilerService.ProfilerServiceBase

Reference documentation and code samples for the Cloud Profiler v2 API class ProfilerService.ProfilerServiceBase.

Base class for server-side implementations of ProfilerService

Inheritance

object > ProfilerService.ProfilerServiceBase

Namespace

Google.Cloud.Profiler.V2

Assembly

Google.Cloud.Profiler.V2.dll

Methods

CreateOfflineProfile(CreateOfflineProfileRequest, ServerCallContext)

public virtual Task<Profile> CreateOfflineProfile(CreateOfflineProfileRequest request, ServerCallContext context)

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.

Parameters
NameDescription
requestCreateOfflineProfileRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskProfile

The response to send back to the client (wrapped by a task).

CreateProfile(CreateProfileRequest, ServerCallContext)

public virtual Task<Profile> CreateProfile(CreateProfileRequest request, ServerCallContext context)

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".

Parameters
NameDescription
requestCreateProfileRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskProfile

The response to send back to the client (wrapped by a task).

UpdateProfile(UpdateProfileRequest, ServerCallContext)

public virtual Task<Profile> UpdateProfile(UpdateProfileRequest request, ServerCallContext context)

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.

Parameters
NameDescription
requestUpdateProfileRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskProfile

The response to send back to the client (wrapped by a task).