Google Cloud Debugger v2 API - Class Controller2.Controller2Client (3.1.0)

public class Controller2Client : ClientBase<Controller2.Controller2Client>

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

Client for Controller2

Inheritance

Object > ClientBase > ClientBase<Controller2.Controller2Client> > Controller2.Controller2Client

Inherited Members

ClientBase<Controller2.Controller2Client>.WithHost(String)

ClientBase.CallInvoker

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.Debugger.V2

Assembly

Google.Cloud.Debugger.V2.dll

Constructors

Controller2Client()

protected Controller2Client()

Protected parameterless constructor to allow creation of test doubles.

Controller2Client(CallInvoker)

public Controller2Client(CallInvoker callInvoker)

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

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

Controller2Client(ChannelBase)

public Controller2Client(ChannelBase channel)

Creates a new client for Controller2

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

Controller2Client(ClientBase.ClientBaseConfiguration)

protected Controller2Client(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
`configuration`	`ClientBase.ClientBaseConfiguration` The client configuration.

Methods

ListActiveBreakpoints(ListActiveBreakpointsRequest, CallOptions)

public virtual ListActiveBreakpointsResponse ListActiveBreakpoints(ListActiveBreakpointsRequest request, CallOptions options)

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 to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`ListActiveBreakpointsResponse`	The response received from the server.

ListActiveBreakpoints(ListActiveBreakpointsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ListActiveBreakpointsResponse ListActiveBreakpoints(ListActiveBreakpointsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Returns the list of all active breakpoints for the debuggee.

Parameters
Name	Description
`request`	`ListActiveBreakpointsRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<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
`ListActiveBreakpointsResponse`	The response received from the server.

ListActiveBreakpointsAsync(ListActiveBreakpointsRequest, CallOptions)

public virtual AsyncUnaryCall<ListActiveBreakpointsResponse> ListActiveBreakpointsAsync(ListActiveBreakpointsRequest request, CallOptions options)

Returns the list of all active breakpoints for the debuggee.

Parameters
Name	Description
`request`	`ListActiveBreakpointsRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCall<ListActiveBreakpointsResponse>`	The call object.

ListActiveBreakpointsAsync(ListActiveBreakpointsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ListActiveBreakpointsResponse> ListActiveBreakpointsAsync(ListActiveBreakpointsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Returns the list of all active breakpoints for the debuggee.

Parameters
Name	Description
`request`	`ListActiveBreakpointsRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<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
`AsyncUnaryCall<ListActiveBreakpointsResponse>`	The call object.

NewInstance(ClientBase.ClientBaseConfiguration)

protected override Controller2.Controller2Client NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
`configuration`	`ClientBase.ClientBaseConfiguration`

Returns
Type	Description
`Controller2.Controller2Client`

Overrides

Grpc.Core.ClientBase<Google.Cloud.Debugger.V2.Controller2.Controller2Client>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

RegisterDebuggee(RegisterDebuggeeRequest, CallOptions)

public virtual RegisterDebuggeeResponse RegisterDebuggee(RegisterDebuggeeRequest request, CallOptions options)

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
`request`	`RegisterDebuggeeRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`RegisterDebuggeeResponse`	The response received from the server.

RegisterDebuggee(RegisterDebuggeeRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual RegisterDebuggeeResponse RegisterDebuggee(RegisterDebuggeeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(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 to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<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
`RegisterDebuggeeResponse`	The response received from the server.

RegisterDebuggeeAsync(RegisterDebuggeeRequest, CallOptions)

public virtual AsyncUnaryCall<RegisterDebuggeeResponse> RegisterDebuggeeAsync(RegisterDebuggeeRequest request, CallOptions options)

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 to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCall<RegisterDebuggeeResponse>`	The call object.

RegisterDebuggeeAsync(RegisterDebuggeeRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<RegisterDebuggeeResponse> RegisterDebuggeeAsync(RegisterDebuggeeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(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 to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<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
`AsyncUnaryCall<RegisterDebuggeeResponse>`	The call object.

UpdateActiveBreakpoint(UpdateActiveBreakpointRequest, CallOptions)

public virtual UpdateActiveBreakpointResponse UpdateActiveBreakpoint(UpdateActiveBreakpointRequest request, CallOptions options)

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 to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`UpdateActiveBreakpointResponse`	The response received from the server.

UpdateActiveBreakpoint(UpdateActiveBreakpointRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual UpdateActiveBreakpointResponse UpdateActiveBreakpoint(UpdateActiveBreakpointRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(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 to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<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
`UpdateActiveBreakpointResponse`	The response received from the server.

UpdateActiveBreakpointAsync(UpdateActiveBreakpointRequest, CallOptions)

public virtual AsyncUnaryCall<UpdateActiveBreakpointResponse> UpdateActiveBreakpointAsync(UpdateActiveBreakpointRequest request, CallOptions options)

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 to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCall<UpdateActiveBreakpointResponse>`	The call object.

UpdateActiveBreakpointAsync(UpdateActiveBreakpointRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<UpdateActiveBreakpointResponse> UpdateActiveBreakpointAsync(UpdateActiveBreakpointRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(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 to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<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
`AsyncUnaryCall<UpdateActiveBreakpointResponse>`	The call object.