Google Cloud Debugger v2 API - Class Controller2Client (3.2.0)

public abstract class Controller2Client

Reference documentation and code samples for the Google Cloud Debugger v2 API class Controller2Client.

Controller2 client wrapper, for convenient use.

Inheritance

object > Controller2Client

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Derived Types

Controller2ClientImpl

Namespace

Google.Cloud.Debugger.V2

Assembly

Google.Cloud.Debugger.V2.dll

Remarks

The Controller service provides the API for orchestrating a collection of debugger agents to perform debugging tasks. These agents are each attached to a process of an application which may include one or more replicas.

The debugger agents register with the Controller to identify the application being debugged, the Debuggee. All agents that register with the same data, represent the same Debuggee, and are assigned the same debuggee_id.

The debugger agents call the Controller to retrieve the list of active Breakpoints. Agents with the same debuggee_id get the same breakpoints list. An agent that can fulfill the breakpoint request updates the Controller with the breakpoint result. The controller selects the first result received and discards the rest of the results. Agents that poll again for active breakpoints will no longer have the completed breakpoint in the list and should remove that breakpoint from their attached process.

The Controller service does not provide a way to retrieve the results of a completed breakpoint. This functionality is available using the Debugger service.

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the Controller2 service, which is a host of "clouddebugger.googleapis.com" and a port of 443.

Property Value
Type	Description
`string`

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default Controller2 scopes.

Property Value
Type	Description
`IReadOnlyListstring`

Remarks

The default Controller2 scopes are:

GrpcClient

public virtual Controller2.Controller2Client GrpcClient { get; }

The underlying gRPC Controller2 client

Property Value
Type	Description
`Controller2Controller2Client`

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
Type	Description
`ServiceMetadata`

Methods

Create()

public static Controller2Client Create()

Synchronously creates a Controller2Client using the default credentials, endpoint and settings. To specify custom credentials or other settings, use Controller2ClientBuilder.

Returns
Type	Description
`Controller2Client`	The created Controller2Client.

CreateAsync(CancellationToken)

public static Task<Controller2Client> CreateAsync(CancellationToken cancellationToken = default)

Asynchronously creates a Controller2Client using the default credentials, endpoint and settings. To specify custom credentials or other settings, use Controller2ClientBuilder.

Parameter
Name	Description
`cancellationToken`	`CancellationToken` The CancellationToken to use while creating the client.

Returns
Type	Description
`TaskController2Client`	The task representing the created Controller2Client.

ListActiveBreakpoints(ListActiveBreakpointsRequest, CallSettings)

public virtual ListActiveBreakpointsResponse ListActiveBreakpoints(ListActiveBreakpointsRequest request, CallSettings callSettings = null)

Returns the list of all active breakpoints for the debuggee.

The breakpoint specification (location, condition, and expressions fields) is semantically immutable, although the field values may change. For example, an agent may update the location line number to reflect the actual line where the breakpoint was set, but this doesn't change the breakpoint semantics.

This means that an agent does not need to check if a breakpoint has changed when it encounters the same breakpoint on a successive call. Moreover, an agent should remember the breakpoints that are completed until the controller removes them from the active list to avoid setting those breakpoints again.

Parameters
Name	Description
`request`	`ListActiveBreakpointsRequest` 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
`ListActiveBreakpointsResponse`	The RPC response.

Example

// Create client
Controller2Client controller2Client = Controller2Client.Create();
// Initialize request argument(s)
ListActiveBreakpointsRequest request = new ListActiveBreakpointsRequest
{
    DebuggeeId = "",
    WaitToken = "",
    SuccessOnTimeout = false,
};
// Make the request
ListActiveBreakpointsResponse response = controller2Client.ListActiveBreakpoints(request);

ListActiveBreakpoints(string, CallSettings)

public virtual ListActiveBreakpointsResponse ListActiveBreakpoints(string debuggeeId, CallSettings callSettings = null)

Returns the list of all active breakpoints for the debuggee.

Parameters
Name	Description
`debuggeeId`	`string` Required. Identifies the debuggee.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`ListActiveBreakpointsResponse`	The RPC response.

Example

// Create client
Controller2Client controller2Client = Controller2Client.Create();
// Initialize request argument(s)
string debuggeeId = "";
// Make the request
ListActiveBreakpointsResponse response = controller2Client.ListActiveBreakpoints(debuggeeId);

ListActiveBreakpointsAsync(ListActiveBreakpointsRequest, CallSettings)

public virtual Task<ListActiveBreakpointsResponse> ListActiveBreakpointsAsync(ListActiveBreakpointsRequest request, CallSettings callSettings = null)

Returns the list of all active breakpoints for the debuggee.

Parameters
Name	Description
`request`	`ListActiveBreakpointsRequest` 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
`TaskListActiveBreakpointsResponse`	A Task containing the RPC response.

Example

// Create client
Controller2Client controller2Client = await Controller2Client.CreateAsync();
// Initialize request argument(s)
ListActiveBreakpointsRequest request = new ListActiveBreakpointsRequest
{
    DebuggeeId = "",
    WaitToken = "",
    SuccessOnTimeout = false,
};
// Make the request
ListActiveBreakpointsResponse response = await controller2Client.ListActiveBreakpointsAsync(request);

ListActiveBreakpointsAsync(ListActiveBreakpointsRequest, CancellationToken)

public virtual Task<ListActiveBreakpointsResponse> ListActiveBreakpointsAsync(ListActiveBreakpointsRequest request, CancellationToken cancellationToken)

Returns the list of all active breakpoints for the debuggee.

Parameters
Name	Description
`request`	`ListActiveBreakpointsRequest` The request object containing all of the parameters for the API call.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`TaskListActiveBreakpointsResponse`	A Task containing the RPC response.

Example

// Create client
Controller2Client controller2Client = await Controller2Client.CreateAsync();
// Initialize request argument(s)
ListActiveBreakpointsRequest request = new ListActiveBreakpointsRequest
{
    DebuggeeId = "",
    WaitToken = "",
    SuccessOnTimeout = false,
};
// Make the request
ListActiveBreakpointsResponse response = await controller2Client.ListActiveBreakpointsAsync(request);

ListActiveBreakpointsAsync(string, CallSettings)

public virtual Task<ListActiveBreakpointsResponse> ListActiveBreakpointsAsync(string debuggeeId, CallSettings callSettings = null)

Returns the list of all active breakpoints for the debuggee.

Parameters
Name	Description
`debuggeeId`	`string` Required. Identifies the debuggee.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskListActiveBreakpointsResponse`	A Task containing the RPC response.

Example

// Create client
Controller2Client controller2Client = await Controller2Client.CreateAsync();
// Initialize request argument(s)
string debuggeeId = "";
// Make the request
ListActiveBreakpointsResponse response = await controller2Client.ListActiveBreakpointsAsync(debuggeeId);

ListActiveBreakpointsAsync(string, CancellationToken)

public virtual Task<ListActiveBreakpointsResponse> ListActiveBreakpointsAsync(string debuggeeId, CancellationToken cancellationToken)

Returns the list of all active breakpoints for the debuggee.

Parameters
Name	Description
`debuggeeId`	`string` Required. Identifies the debuggee.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`TaskListActiveBreakpointsResponse`	A Task containing the RPC response.

Example

// Create client
Controller2Client controller2Client = await Controller2Client.CreateAsync();
// Initialize request argument(s)
string debuggeeId = "";
// Make the request
ListActiveBreakpointsResponse response = await controller2Client.ListActiveBreakpointsAsync(debuggeeId);

RegisterDebuggee(Debuggee, CallSettings)

public virtual RegisterDebuggeeResponse RegisterDebuggee(Debuggee debuggee, CallSettings callSettings = null)

Registers the debuggee with the controller service.

All agents attached to the same application must call this method with exactly the same request content to get back the same stable debuggee_id. Agents should call this method again whenever google.rpc.Code.NOT_FOUND is returned from any controller method.

This protocol allows the controller service to disable debuggees, recover from data loss, or change the debuggee_id format. Agents must handle debuggee_id value changing upon re-registration.

Parameters
Name	Description
`debuggee`	`Debuggee` Required. Debuggee information to register. The fields `project`, `uniquifier`, `description` and `agent_version` of the debuggee must be set.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`RegisterDebuggeeResponse`	The RPC response.

Example

// Create client
Controller2Client controller2Client = Controller2Client.Create();
// Initialize request argument(s)
Debuggee debuggee = new Debuggee();
// Make the request
RegisterDebuggeeResponse response = controller2Client.RegisterDebuggee(debuggee);

RegisterDebuggee(RegisterDebuggeeRequest, CallSettings)

public virtual RegisterDebuggeeResponse RegisterDebuggee(RegisterDebuggeeRequest request, CallSettings callSettings = null)

Registers the debuggee with the controller service.

This protocol allows the controller service to disable debuggees, recover from data loss, or change the debuggee_id format. Agents must handle debuggee_id value changing upon re-registration.

Parameters
Name	Description
`request`	`RegisterDebuggeeRequest` 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
`RegisterDebuggeeResponse`	The RPC response.

Example

// Create client
Controller2Client controller2Client = Controller2Client.Create();
// Initialize request argument(s)
RegisterDebuggeeRequest request = new RegisterDebuggeeRequest
{
    Debuggee = new Debuggee(),
};
// Make the request
RegisterDebuggeeResponse response = controller2Client.RegisterDebuggee(request);

RegisterDebuggeeAsync(Debuggee, CallSettings)

public virtual Task<RegisterDebuggeeResponse> RegisterDebuggeeAsync(Debuggee debuggee, CallSettings callSettings = null)

Registers the debuggee with the controller service.

This protocol allows the controller service to disable debuggees, recover from data loss, or change the debuggee_id format. Agents must handle debuggee_id value changing upon re-registration.

Parameters
Name	Description
`debuggee`	`Debuggee` Required. Debuggee information to register. The fields `project`, `uniquifier`, `description` and `agent_version` of the debuggee must be set.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskRegisterDebuggeeResponse`	A Task containing the RPC response.

Example

// Create client
Controller2Client controller2Client = await Controller2Client.CreateAsync();
// Initialize request argument(s)
Debuggee debuggee = new Debuggee();
// Make the request
RegisterDebuggeeResponse response = await controller2Client.RegisterDebuggeeAsync(debuggee);

RegisterDebuggeeAsync(Debuggee, CancellationToken)

public virtual Task<RegisterDebuggeeResponse> RegisterDebuggeeAsync(Debuggee debuggee, CancellationToken cancellationToken)

Registers the debuggee with the controller service.

This protocol allows the controller service to disable debuggees, recover from data loss, or change the debuggee_id format. Agents must handle debuggee_id value changing upon re-registration.

Parameters
Name	Description
`debuggee`	`Debuggee` Required. Debuggee information to register. The fields `project`, `uniquifier`, `description` and `agent_version` of the debuggee must be set.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`TaskRegisterDebuggeeResponse`	A Task containing the RPC response.

Example

// Create client
Controller2Client controller2Client = await Controller2Client.CreateAsync();
// Initialize request argument(s)
Debuggee debuggee = new Debuggee();
// Make the request
RegisterDebuggeeResponse response = await controller2Client.RegisterDebuggeeAsync(debuggee);

RegisterDebuggeeAsync(RegisterDebuggeeRequest, CallSettings)

public virtual Task<RegisterDebuggeeResponse> RegisterDebuggeeAsync(RegisterDebuggeeRequest request, CallSettings callSettings = null)

Registers the debuggee with the controller service.

This protocol allows the controller service to disable debuggees, recover from data loss, or change the debuggee_id format. Agents must handle debuggee_id value changing upon re-registration.

Parameters
Name	Description
`request`	`RegisterDebuggeeRequest` 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
`TaskRegisterDebuggeeResponse`	A Task containing the RPC response.

Example

// Create client
Controller2Client controller2Client = await Controller2Client.CreateAsync();
// Initialize request argument(s)
RegisterDebuggeeRequest request = new RegisterDebuggeeRequest
{
    Debuggee = new Debuggee(),
};
// Make the request
RegisterDebuggeeResponse response = await controller2Client.RegisterDebuggeeAsync(request);

RegisterDebuggeeAsync(RegisterDebuggeeRequest, CancellationToken)

public virtual Task<RegisterDebuggeeResponse> RegisterDebuggeeAsync(RegisterDebuggeeRequest request, CancellationToken cancellationToken)

Registers the debuggee with the controller service.

This protocol allows the controller service to disable debuggees, recover from data loss, or change the debuggee_id format. Agents must handle debuggee_id value changing upon re-registration.

Parameters
Name	Description
`request`	`RegisterDebuggeeRequest` The request object containing all of the parameters for the API call.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`TaskRegisterDebuggeeResponse`	A Task containing the RPC response.

Example

// Create client
Controller2Client controller2Client = await Controller2Client.CreateAsync();
// Initialize request argument(s)
RegisterDebuggeeRequest request = new RegisterDebuggeeRequest
{
    Debuggee = new Debuggee(),
};
// Make the request
RegisterDebuggeeResponse response = await controller2Client.RegisterDebuggeeAsync(request);

ShutdownDefaultChannelsAsync()

public static Task ShutdownDefaultChannelsAsync()

Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.

Returns
Type	Description
`Task`	A task representing the asynchronous shutdown operation.

Remarks

After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.

UpdateActiveBreakpoint(UpdateActiveBreakpointRequest, CallSettings)

public virtual UpdateActiveBreakpointResponse UpdateActiveBreakpoint(UpdateActiveBreakpointRequest request, CallSettings callSettings = null)

Updates the breakpoint state or mutable fields. The entire Breakpoint message must be sent back to the controller service.

Updates to active breakpoint fields are only allowed if the new value does not change the breakpoint specification. Updates to the location, condition and expressions fields should not alter the breakpoint semantics. These may only make changes such as canonicalizing a value or snapping the location to the correct line of code.

Parameters
Name	Description
`request`	`UpdateActiveBreakpointRequest` 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
`UpdateActiveBreakpointResponse`	The RPC response.

Example

// Create client
Controller2Client controller2Client = Controller2Client.Create();
// Initialize request argument(s)
UpdateActiveBreakpointRequest request = new UpdateActiveBreakpointRequest
{
    DebuggeeId = "",
    Breakpoint = new Breakpoint(),
};
// Make the request
UpdateActiveBreakpointResponse response = controller2Client.UpdateActiveBreakpoint(request);

UpdateActiveBreakpoint(string, Breakpoint, CallSettings)

public virtual UpdateActiveBreakpointResponse UpdateActiveBreakpoint(string debuggeeId, Breakpoint breakpoint, CallSettings callSettings = null)

Updates the breakpoint state or mutable fields. The entire Breakpoint message must be sent back to the controller service.

Parameters
Name	Description
`debuggeeId`	`string` Required. Identifies the debuggee being debugged.
`breakpoint`	`Breakpoint` Required. Updated breakpoint information. The field `id` must be set. The agent must echo all Breakpoint specification fields in the update.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`UpdateActiveBreakpointResponse`	The RPC response.

Example

// Create client
Controller2Client controller2Client = Controller2Client.Create();
// Initialize request argument(s)
string debuggeeId = "";
Breakpoint breakpoint = new Breakpoint();
// Make the request
UpdateActiveBreakpointResponse response = controller2Client.UpdateActiveBreakpoint(debuggeeId, breakpoint);

UpdateActiveBreakpointAsync(UpdateActiveBreakpointRequest, CallSettings)

public virtual Task<UpdateActiveBreakpointResponse> UpdateActiveBreakpointAsync(UpdateActiveBreakpointRequest request, CallSettings callSettings = null)

Updates the breakpoint state or mutable fields. The entire Breakpoint message must be sent back to the controller service.

Parameters
Name	Description
`request`	`UpdateActiveBreakpointRequest` 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
`TaskUpdateActiveBreakpointResponse`	A Task containing the RPC response.

Example

// Create client
Controller2Client controller2Client = await Controller2Client.CreateAsync();
// Initialize request argument(s)
UpdateActiveBreakpointRequest request = new UpdateActiveBreakpointRequest
{
    DebuggeeId = "",
    Breakpoint = new Breakpoint(),
};
// Make the request
UpdateActiveBreakpointResponse response = await controller2Client.UpdateActiveBreakpointAsync(request);

UpdateActiveBreakpointAsync(UpdateActiveBreakpointRequest, CancellationToken)

public virtual Task<UpdateActiveBreakpointResponse> UpdateActiveBreakpointAsync(UpdateActiveBreakpointRequest request, CancellationToken cancellationToken)

Updates the breakpoint state or mutable fields. The entire Breakpoint message must be sent back to the controller service.

Parameters
Name	Description
`request`	`UpdateActiveBreakpointRequest` The request object containing all of the parameters for the API call.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`TaskUpdateActiveBreakpointResponse`	A Task containing the RPC response.

Example

// Create client
Controller2Client controller2Client = await Controller2Client.CreateAsync();
// Initialize request argument(s)
UpdateActiveBreakpointRequest request = new UpdateActiveBreakpointRequest
{
    DebuggeeId = "",
    Breakpoint = new Breakpoint(),
};
// Make the request
UpdateActiveBreakpointResponse response = await controller2Client.UpdateActiveBreakpointAsync(request);

UpdateActiveBreakpointAsync(string, Breakpoint, CallSettings)

public virtual Task<UpdateActiveBreakpointResponse> UpdateActiveBreakpointAsync(string debuggeeId, Breakpoint breakpoint, CallSettings callSettings = null)

Updates the breakpoint state or mutable fields. The entire Breakpoint message must be sent back to the controller service.

Parameters
Name	Description
`debuggeeId`	`string` Required. Identifies the debuggee being debugged.
`breakpoint`	`Breakpoint` Required. Updated breakpoint information. The field `id` must be set. The agent must echo all Breakpoint specification fields in the update.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskUpdateActiveBreakpointResponse`	A Task containing the RPC response.

Example

// Create client
Controller2Client controller2Client = await Controller2Client.CreateAsync();
// Initialize request argument(s)
string debuggeeId = "";
Breakpoint breakpoint = new Breakpoint();
// Make the request
UpdateActiveBreakpointResponse response = await controller2Client.UpdateActiveBreakpointAsync(debuggeeId, breakpoint);

UpdateActiveBreakpointAsync(string, Breakpoint, CancellationToken)

public virtual Task<UpdateActiveBreakpointResponse> UpdateActiveBreakpointAsync(string debuggeeId, Breakpoint breakpoint, CancellationToken cancellationToken)

Updates the breakpoint state or mutable fields. The entire Breakpoint message must be sent back to the controller service.

Parameters
Name	Description
`debuggeeId`	`string` Required. Identifies the debuggee being debugged.
`breakpoint`	`Breakpoint` Required. Updated breakpoint information. The field `id` must be set. The agent must echo all Breakpoint specification fields in the update.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`TaskUpdateActiveBreakpointResponse`	A Task containing the RPC response.

Example

// Create client
Controller2Client controller2Client = await Controller2Client.CreateAsync();
// Initialize request argument(s)
string debuggeeId = "";
Breakpoint breakpoint = new Breakpoint();
// Make the request
UpdateActiveBreakpointResponse response = await controller2Client.UpdateActiveBreakpointAsync(debuggeeId, breakpoint);