Cloud Profiler v2 API - Class ProfilerServiceClientImpl (2.1.0)

Version 2.1.0

• 2.6.0 (latest)
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.2.0
• 1.1.0
• 1.0.0

public sealed class ProfilerServiceClientImpl : ProfilerServiceClient

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

ProfilerService client wrapper implementation, for convenient use.

Inheritance

Object > ProfilerServiceClient > ProfilerServiceClientImpl

Inherited Members

ProfilerServiceClient.DefaultEndpoint

ProfilerServiceClient.DefaultScopes

ProfilerServiceClient.ServiceMetadata

ProfilerServiceClient.CreateAsync(CancellationToken)

ProfilerServiceClient.Create()

ProfilerServiceClient.ShutdownDefaultChannelsAsync()

ProfilerServiceClient.CreateProfileAsync(CreateProfileRequest, CancellationToken)

ProfilerServiceClient.CreateOfflineProfileAsync(CreateOfflineProfileRequest, CancellationToken)

ProfilerServiceClient.UpdateProfileAsync(UpdateProfileRequest, CancellationToken)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.Profiler.V2

Assembly

Google.Cloud.Profiler.V2.dll

Remarks

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.

Constructors

ProfilerServiceClientImpl(ProfilerService.ProfilerServiceClient, ProfilerServiceSettings, ILogger)

public ProfilerServiceClientImpl(ProfilerService.ProfilerServiceClient grpcClient, ProfilerServiceSettings settings, ILogger logger)

Constructs a client wrapper for the ProfilerService service, with the specified gRPC client and settings.

Parameters
Name	Description
grpcClient	ProfilerService.ProfilerServiceClient The underlying gRPC client.
settings	ProfilerServiceSettings The base ProfilerServiceSettings used within this client.
logger	ILogger Optional ILogger to use within this client.

Properties

GrpcClient

public override ProfilerService.ProfilerServiceClient GrpcClient { get; }

The underlying gRPC ProfilerService client

Property Value
Type	Description
ProfilerService.ProfilerServiceClient

Overrides

ProfilerServiceClient.GrpcClient

Methods

CreateOfflineProfile(CreateOfflineProfileRequest, CallSettings)

public override Profile CreateOfflineProfile(CreateOfflineProfileRequest request, CallSettings callSettings = null)

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
request	CreateOfflineProfileRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Profile	The RPC response.

Overrides

ProfilerServiceClient.CreateOfflineProfile(CreateOfflineProfileRequest, CallSettings)

CreateOfflineProfileAsync(CreateOfflineProfileRequest, CallSettings)

public override Task<Profile> CreateOfflineProfileAsync(CreateOfflineProfileRequest request, CallSettings callSettings = null)

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
request	CreateOfflineProfileRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<Profile>	A Task containing the RPC response.

Overrides

ProfilerServiceClient.CreateOfflineProfileAsync(CreateOfflineProfileRequest, CallSettings)

CreateProfile(CreateProfileRequest, CallSettings)

public override Profile CreateProfile(CreateProfileRequest request, CallSettings callSettings = null)

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
request	CreateProfileRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Profile	The RPC response.

Overrides

ProfilerServiceClient.CreateProfile(CreateProfileRequest, CallSettings)

CreateProfileAsync(CreateProfileRequest, CallSettings)

public override Task<Profile> CreateProfileAsync(CreateProfileRequest request, CallSettings callSettings = null)

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
request	CreateProfileRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<Profile>	A Task containing the RPC response.

Overrides

ProfilerServiceClient.CreateProfileAsync(CreateProfileRequest, CallSettings)

UpdateProfile(UpdateProfileRequest, CallSettings)

public override Profile UpdateProfile(UpdateProfileRequest request, CallSettings callSettings = null)

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
request	UpdateProfileRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Profile	The RPC response.

Overrides

ProfilerServiceClient.UpdateProfile(UpdateProfileRequest, CallSettings)

UpdateProfileAsync(UpdateProfileRequest, CallSettings)

public override Task<Profile> UpdateProfileAsync(UpdateProfileRequest request, CallSettings callSettings = null)

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
request	UpdateProfileRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<Profile>	A Task containing the RPC response.

Overrides

ProfilerServiceClient.UpdateProfileAsync(UpdateProfileRequest, CallSettings)