Class Debugger2Client (2.11.0)

The Debugger service provides the API that allows users to collect run-time information from a running application, without stopping or slowing it down and without modifying its state.

An application may include one or more replicated processes performing the same work.

A debugged application is represented using the Debuggee concept. The Debugger service provides a way to query for available debuggees, but does not provide a way to create one. A debuggee is created using the Controller service, usually by running a debugger agent with the application.

The Debugger service enables the client to set one or more Breakpoints on a Debuggee and collect the results of the set Breakpoints.

Equality

Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection> objects compare equal. Objects that compare equal share the same underlying resources.

Performance

Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.

Thread Safety

Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.

Constructors

Debugger2Client(Debugger2Client const &)

Copy and move support

Parameter
Name	Description
	`Debugger2Client const &`

Debugger2Client(Debugger2Client &&)

Copy and move support

Parameter
Name	Description
	`Debugger2Client &&`

Debugger2Client(std::shared_ptr< Debugger2Connection >, Options)

Parameters
Name	Description
`connection`	`std::shared_ptr< Debugger2Connection >`
`opts`	`Options`

Operators

operator=(Debugger2Client const &)

Copy and move support

Parameter
Name	Description
	`Debugger2Client const &`

Returns
Type	Description
`Debugger2Client &`

operator=(Debugger2Client &&)

Copy and move support

Parameter
Name	Description
	`Debugger2Client &&`

Returns
Type	Description
`Debugger2Client &`

Functions

SetBreakpoint(std::string const &, google::devtools::clouddebugger::v2::Breakpoint const &, std::string const &, Options)

Sets the breakpoint to the debuggee.

Parameters
Name	Description
`debuggee_id`	`std::string const &` Required. ID of the debuggee where the breakpoint is to be set.
`breakpoint`	`google::devtools::clouddebugger::v2::Breakpoint const &` Required. Breakpoint specification to set. The field `location` of the breakpoint must be set.
`client_version`	`std::string const &` Required. The client version making the call. Schema: `domain/type/version` (e.g., `google.com/intellij/v1`).
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::devtools::clouddebugger::v2::SetBreakpointResponse >`	the result of the RPC. The response message type (google.devtools.clouddebugger.v2.SetBreakpointResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

SetBreakpoint(google::devtools::clouddebugger::v2::SetBreakpointRequest const &, Options)

Sets the breakpoint to the debuggee.

Parameters
Name	Description
`request`	`google::devtools::clouddebugger::v2::SetBreakpointRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.devtools.clouddebugger.v2.SetBreakpointRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::devtools::clouddebugger::v2::SetBreakpointResponse >`	the result of the RPC. The response message type (google.devtools.clouddebugger.v2.SetBreakpointResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetBreakpoint(std::string const &, std::string const &, std::string const &, Options)

Gets breakpoint information.

Parameters
Name	Description
`debuggee_id`	`std::string const &` Required. ID of the debuggee whose breakpoint to get.
`breakpoint_id`	`std::string const &` Required. ID of the breakpoint to get.
`client_version`	`std::string const &` Required. The client version making the call. Schema: `domain/type/version` (e.g., `google.com/intellij/v1`).
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::devtools::clouddebugger::v2::GetBreakpointResponse >`	the result of the RPC. The response message type (google.devtools.clouddebugger.v2.GetBreakpointResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetBreakpoint(google::devtools::clouddebugger::v2::GetBreakpointRequest const &, Options)

Gets breakpoint information.

Parameters
Name	Description
`request`	`google::devtools::clouddebugger::v2::GetBreakpointRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.devtools.clouddebugger.v2.GetBreakpointRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::devtools::clouddebugger::v2::GetBreakpointResponse >`	the result of the RPC. The response message type (google.devtools.clouddebugger.v2.GetBreakpointResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

DeleteBreakpoint(std::string const &, std::string const &, std::string const &, Options)

Deletes the breakpoint from the debuggee.

Parameters
Name	Description
`debuggee_id`	`std::string const &` Required. ID of the debuggee whose breakpoint to delete.
`breakpoint_id`	`std::string const &` Required. ID of the breakpoint to delete.
`client_version`	`std::string const &` Required. The client version making the call. Schema: `domain/type/version` (e.g., `google.com/intellij/v1`).
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

DeleteBreakpoint(google::devtools::clouddebugger::v2::DeleteBreakpointRequest const &, Options)

Deletes the breakpoint from the debuggee.

Parameters
Name	Description
`request`	`google::devtools::clouddebugger::v2::DeleteBreakpointRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.devtools.clouddebugger.v2.DeleteBreakpointRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

ListBreakpoints(std::string const &, std::string const &, Options)

Lists all breakpoints for the debuggee.

Parameters
Name	Description
`debuggee_id`	`std::string const &` Required. ID of the debuggee whose breakpoints to list.
`client_version`	`std::string const &` Required. The client version making the call. Schema: `domain/type/version` (e.g., `google.com/intellij/v1`).
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::devtools::clouddebugger::v2::ListBreakpointsResponse >`	the result of the RPC. The response message type (google.devtools.clouddebugger.v2.ListBreakpointsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

ListBreakpoints(google::devtools::clouddebugger::v2::ListBreakpointsRequest const &, Options)

Lists all breakpoints for the debuggee.

Parameters
Name	Description
`request`	`google::devtools::clouddebugger::v2::ListBreakpointsRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.devtools.clouddebugger.v2.ListBreakpointsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::devtools::clouddebugger::v2::ListBreakpointsResponse >`	the result of the RPC. The response message type (google.devtools.clouddebugger.v2.ListBreakpointsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

ListDebuggees(std::string const &, std::string const &, Options)

Lists all the debuggees that the user has access to.

Parameters
Name	Description
`project`	`std::string const &` Required. Project number of a Google Cloud project whose debuggees to list.
`client_version`	`std::string const &` Required. The client version making the call. Schema: `domain/type/version` (e.g., `google.com/intellij/v1`).
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::devtools::clouddebugger::v2::ListDebuggeesResponse >`	the result of the RPC. The response message type (google.devtools.clouddebugger.v2.ListDebuggeesResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

ListDebuggees(google::devtools::clouddebugger::v2::ListDebuggeesRequest const &, Options)

Lists all the debuggees that the user has access to.

Parameters
Name	Description
`request`	`google::devtools::clouddebugger::v2::ListDebuggeesRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.devtools.clouddebugger.v2.ListDebuggeesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::devtools::clouddebugger::v2::ListDebuggeesResponse >`	the result of the RPC. The response message type (google.devtools.clouddebugger.v2.ListDebuggeesResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.