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

Version 2.5.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 class ProfilerService.ProfilerServiceClient : ClientBase<ProfilerService.ProfilerServiceClient>

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

Client for ProfilerService

Inheritance

object > ClientBase > ClientBaseProfilerServiceProfilerServiceClient > ProfilerService.ProfilerServiceClient

Inherited Members

ClientBase<ProfilerService.ProfilerServiceClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Profiler.V2

Assembly

Google.Cloud.Profiler.V2.dll

Constructors

ProfilerServiceClient()

protected ProfilerServiceClient()

Protected parameterless constructor to allow creation of test doubles.

ProfilerServiceClient(CallInvoker)

public ProfilerServiceClient(CallInvoker callInvoker)

Creates a new client for ProfilerService that uses a custom CallInvoker.

Parameter
Name	Description
callInvoker	CallInvoker The callInvoker to use to make remote calls.

ProfilerServiceClient(ChannelBase)

public ProfilerServiceClient(ChannelBase channel)

Creates a new client for ProfilerService

Parameter
Name	Description
channel	ChannelBase The channel to use to make remote calls.

ProfilerServiceClient(ClientBaseConfiguration)

protected ProfilerServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration The client configuration.

Methods

CreateOfflineProfile(CreateOfflineProfileRequest, CallOptions)

public virtual Profile CreateOfflineProfile(CreateOfflineProfileRequest request, CallOptions options)

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
Name	Description
request	CreateOfflineProfileRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Profile	The response received from the server.

CreateOfflineProfile(CreateOfflineProfileRequest, Metadata, DateTime?, CancellationToken)

public virtual Profile CreateOfflineProfile(CreateOfflineProfileRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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
Name	Description
request	CreateOfflineProfileRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Profile	The response received from the server.

CreateOfflineProfileAsync(CreateOfflineProfileRequest, CallOptions)

public virtual AsyncUnaryCall<Profile> CreateOfflineProfileAsync(CreateOfflineProfileRequest request, CallOptions options)

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
Name	Description
request	CreateOfflineProfileRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallProfile	The call object.

CreateOfflineProfileAsync(CreateOfflineProfileRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Profile> CreateOfflineProfileAsync(CreateOfflineProfileRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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
Name	Description
request	CreateOfflineProfileRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallProfile	The call object.

CreateProfile(CreateProfileRequest, CallOptions)

public virtual Profile CreateProfile(CreateProfileRequest request, CallOptions options)

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
Name	Description
request	CreateProfileRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Profile	The response received from the server.

CreateProfile(CreateProfileRequest, Metadata, DateTime?, CancellationToken)

public virtual Profile CreateProfile(CreateProfileRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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
Name	Description
request	CreateProfileRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Profile	The response received from the server.

CreateProfileAsync(CreateProfileRequest, CallOptions)

public virtual AsyncUnaryCall<Profile> CreateProfileAsync(CreateProfileRequest request, CallOptions options)

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
Name	Description
request	CreateProfileRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallProfile	The call object.

CreateProfileAsync(CreateProfileRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Profile> CreateProfileAsync(CreateProfileRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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
Name	Description
request	CreateProfileRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallProfile	The call object.

NewInstance(ClientBaseConfiguration)

protected override ProfilerService.ProfilerServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
ProfilerServiceProfilerServiceClient

Overrides

ClientBase<ProfilerService.ProfilerServiceClient>.NewInstance(ClientBase.ClientBaseConfiguration)

UpdateProfile(UpdateProfileRequest, CallOptions)

public virtual Profile UpdateProfile(UpdateProfileRequest request, CallOptions options)

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
Name	Description
request	UpdateProfileRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Profile	The response received from the server.

UpdateProfile(UpdateProfileRequest, Metadata, DateTime?, CancellationToken)

public virtual Profile UpdateProfile(UpdateProfileRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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
Name	Description
request	UpdateProfileRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Profile	The response received from the server.

UpdateProfileAsync(UpdateProfileRequest, CallOptions)

public virtual AsyncUnaryCall<Profile> UpdateProfileAsync(UpdateProfileRequest request, CallOptions options)

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
Name	Description
request	UpdateProfileRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallProfile	The call object.

UpdateProfileAsync(UpdateProfileRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Profile> UpdateProfileAsync(UpdateProfileRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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
Name	Description
request	UpdateProfileRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallProfile	The call object.