Package com.google.devtools.clouddebugger.v2 (1.24.0)

Classes

Breakpoint

Represents the breakpoint specification, status and results.

Protobuf type google.devtools.clouddebugger.v2.Breakpoint

Breakpoint.Builder

Represents the breakpoint specification, status and results.

Protobuf type google.devtools.clouddebugger.v2.Breakpoint

Controller2Grpc

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.

Controller2Grpc.Controller2BlockingStub

A stub to allow clients to do synchronous rpc calls to service Controller2.

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.

Controller2Grpc.Controller2FutureStub

A stub to allow clients to do ListenableFuture-style rpc calls to service Controller2.

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.

Controller2Grpc.Controller2ImplBase

Base class for the server implementation of the service Controller2.

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.

Controller2Grpc.Controller2Stub

A stub to allow clients to do asynchronous rpc calls to service Controller2.

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.

ControllerProto

DataProto

Debuggee

Represents the debugged application. The application may include one or more replicated processes executing the same code. Each of these processes is attached with a debugger agent, carrying out the debugging commands. Agents attached to the same debuggee identify themselves as such by using exactly the same Debuggee message value when registering.

Protobuf type google.devtools.clouddebugger.v2.Debuggee

Debuggee.Builder

Represents the debugged application. The application may include one or more replicated processes executing the same code. Each of these processes is attached with a debugger agent, carrying out the debugging commands. Agents attached to the same debuggee identify themselves as such by using exactly the same Debuggee message value when registering.

Protobuf type google.devtools.clouddebugger.v2.Debuggee

Debugger2Grpc

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.

Debugger2Grpc.Debugger2BlockingStub

A stub to allow clients to do synchronous rpc calls to service Debugger2.

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.

Debugger2Grpc.Debugger2FutureStub

A stub to allow clients to do ListenableFuture-style rpc calls to service Debugger2.

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.

Debugger2Grpc.Debugger2ImplBase

Base class for the server implementation of the service Debugger2.

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.

Debugger2Grpc.Debugger2Stub

A stub to allow clients to do asynchronous rpc calls to service Debugger2.

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.

DebuggerProto

DeleteBreakpointRequest

Request to delete a breakpoint.

Protobuf type google.devtools.clouddebugger.v2.DeleteBreakpointRequest

DeleteBreakpointRequest.Builder

Request to delete a breakpoint.

Protobuf type google.devtools.clouddebugger.v2.DeleteBreakpointRequest

FormatMessage

Represents a message with parameters.

Protobuf type google.devtools.clouddebugger.v2.FormatMessage

FormatMessage.Builder

Represents a message with parameters.

Protobuf type google.devtools.clouddebugger.v2.FormatMessage

GetBreakpointRequest

Request to get breakpoint information.

Protobuf type google.devtools.clouddebugger.v2.GetBreakpointRequest

GetBreakpointRequest.Builder

Request to get breakpoint information.

Protobuf type google.devtools.clouddebugger.v2.GetBreakpointRequest

GetBreakpointResponse

Response for getting breakpoint information.

Protobuf type google.devtools.clouddebugger.v2.GetBreakpointResponse

GetBreakpointResponse.Builder

Response for getting breakpoint information.

Protobuf type google.devtools.clouddebugger.v2.GetBreakpointResponse

ListActiveBreakpointsRequest

Request to list active breakpoints.

Protobuf type google.devtools.clouddebugger.v2.ListActiveBreakpointsRequest

ListActiveBreakpointsRequest.Builder

Request to list active breakpoints.

Protobuf type google.devtools.clouddebugger.v2.ListActiveBreakpointsRequest

ListActiveBreakpointsResponse

Response for listing active breakpoints.

Protobuf type google.devtools.clouddebugger.v2.ListActiveBreakpointsResponse

ListActiveBreakpointsResponse.Builder

Response for listing active breakpoints.

Protobuf type google.devtools.clouddebugger.v2.ListActiveBreakpointsResponse

ListBreakpointsRequest

Request to list breakpoints.

Protobuf type google.devtools.clouddebugger.v2.ListBreakpointsRequest

ListBreakpointsRequest.BreakpointActionValue

Wrapper message for Breakpoint.Action. Defines a filter on the action field of breakpoints.

Protobuf type google.devtools.clouddebugger.v2.ListBreakpointsRequest.BreakpointActionValue

ListBreakpointsRequest.BreakpointActionValue.Builder

Wrapper message for Breakpoint.Action. Defines a filter on the action field of breakpoints.

Protobuf type google.devtools.clouddebugger.v2.ListBreakpointsRequest.BreakpointActionValue

ListBreakpointsRequest.Builder

Request to list breakpoints.

Protobuf type google.devtools.clouddebugger.v2.ListBreakpointsRequest

ListBreakpointsResponse

Response for listing breakpoints.

Protobuf type google.devtools.clouddebugger.v2.ListBreakpointsResponse

ListBreakpointsResponse.Builder

Response for listing breakpoints.

Protobuf type google.devtools.clouddebugger.v2.ListBreakpointsResponse

ListDebuggeesRequest

Request to list debuggees.

Protobuf type google.devtools.clouddebugger.v2.ListDebuggeesRequest

ListDebuggeesRequest.Builder

Request to list debuggees.

Protobuf type google.devtools.clouddebugger.v2.ListDebuggeesRequest

ListDebuggeesResponse

Response for listing debuggees.

Protobuf type google.devtools.clouddebugger.v2.ListDebuggeesResponse

ListDebuggeesResponse.Builder

Response for listing debuggees.

Protobuf type google.devtools.clouddebugger.v2.ListDebuggeesResponse

RegisterDebuggeeRequest

Request to register a debuggee.

Protobuf type google.devtools.clouddebugger.v2.RegisterDebuggeeRequest

RegisterDebuggeeRequest.Builder

Request to register a debuggee.

Protobuf type google.devtools.clouddebugger.v2.RegisterDebuggeeRequest

RegisterDebuggeeResponse

Response for registering a debuggee.

Protobuf type google.devtools.clouddebugger.v2.RegisterDebuggeeResponse

RegisterDebuggeeResponse.Builder

Response for registering a debuggee.

Protobuf type google.devtools.clouddebugger.v2.RegisterDebuggeeResponse

SetBreakpointRequest

Request to set a breakpoint

Protobuf type google.devtools.clouddebugger.v2.SetBreakpointRequest

SetBreakpointRequest.Builder

Request to set a breakpoint

Protobuf type google.devtools.clouddebugger.v2.SetBreakpointRequest

SetBreakpointResponse

Response for setting a breakpoint.

Protobuf type google.devtools.clouddebugger.v2.SetBreakpointResponse

SetBreakpointResponse.Builder

Response for setting a breakpoint.

Protobuf type google.devtools.clouddebugger.v2.SetBreakpointResponse

SourceLocation

Represents a location in the source code.

Protobuf type google.devtools.clouddebugger.v2.SourceLocation

SourceLocation.Builder

Represents a location in the source code.

Protobuf type google.devtools.clouddebugger.v2.SourceLocation

StackFrame

Represents a stack frame context.

Protobuf type google.devtools.clouddebugger.v2.StackFrame

StackFrame.Builder

Represents a stack frame context.

Protobuf type google.devtools.clouddebugger.v2.StackFrame

StatusMessage

Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the Breakpoint.status field can indicate an error referring to the BREAKPOINT_SOURCE_LOCATION with the message Location not found.

Protobuf type google.devtools.clouddebugger.v2.StatusMessage

StatusMessage.Builder

Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the Breakpoint.status field can indicate an error referring to the BREAKPOINT_SOURCE_LOCATION with the message Location not found.

Protobuf type google.devtools.clouddebugger.v2.StatusMessage

UpdateActiveBreakpointRequest

Request to update an active breakpoint.

Protobuf type google.devtools.clouddebugger.v2.UpdateActiveBreakpointRequest

UpdateActiveBreakpointRequest.Builder

Request to update an active breakpoint.

Protobuf type google.devtools.clouddebugger.v2.UpdateActiveBreakpointRequest

UpdateActiveBreakpointResponse

Response for updating an active breakpoint. The message is defined to allow future extensions.

Protobuf type google.devtools.clouddebugger.v2.UpdateActiveBreakpointResponse

UpdateActiveBreakpointResponse.Builder

Response for updating an active breakpoint. The message is defined to allow future extensions.

Protobuf type google.devtools.clouddebugger.v2.UpdateActiveBreakpointResponse

Variable

Represents a variable or an argument possibly of a compound object type. Note how the following variables are represented:

1) A simple variable:

 int x = 5

 { name: "x", value: "5", type: "int" }  // Captured variable

2) A compound object:

 struct T {
     int m1;
     int m2;
 };
 T x = { 3, 7 };

 {  // Captured variable
     name: "x",
     type: "T",
     members { name: "m1", value: "3", type: "int" },
     members { name: "m2", value: "7", type: "int" }
 }

3) A pointer where the pointee was captured:

 T x = { 3, 7 };
 T* p = &x;

 {   // Captured variable
     name: "p",
     type: "T*",
     value: "0x00500500",
     members { name: "m1", value: "3", type: "int" },
     members { name: "m2", value: "7", type: "int" }
 }

4) A pointer where the pointee was not captured:

 T* p = new T;

 {   // Captured variable
     name: "p",
     type: "T*",
     value: "0x00400400"
     status { is_error: true, description { format: "unavailable" } }
 }

The status should describe the reason for the missing value, such as <optimized out>, <inaccessible>, <pointers limit reached>.

Note that a null pointer should not have members.

5) An unnamed value:

 int* p = new int(7);

 {   // Captured variable
     name: "p",
     value: "0x00500500",
     type: "int*",
     members { value: "7", type: "int" } }

6) An unnamed pointer where the pointee was not captured:

 int* p = new int(7);
 int** pp = &amp;p;

 {  // Captured variable
     name: "pp",
     value: "0x00500500",
     type: "int**",
     members {
         value: "0x00400400",
         type: "int*"
         status {
             is_error: true,
             description: { format: "unavailable" } }
         }
     }
 }

To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the var_table_index field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable, merge the referencing variable with the referenced variable.

When using the shared variable table, the following variables:

 T x = { 3, 7 };
 T* p = &amp;x;
 T&amp; r = x;

 { name: "x", var_table_index: 3, type: "T" }  // Captured variables
 { name: "p", value "0x00500500", type="T*", var_table_index: 3 }
 { name: "r", type="T&amp;", var_table_index: 3 }

 {  // Shared variable table entry #3:
     members { name: "m1", value: "3", type: "int" },
     members { name: "m2", value: "7", type: "int" }
 }

Note that the pointer address is stored with the referencing variable and not with the referenced variable. This allows the referenced variable to be shared between pointers and references.

The type field is optional. The debugger agent may or may not support it.

Protobuf type google.devtools.clouddebugger.v2.Variable

Variable.Builder

Represents a variable or an argument possibly of a compound object type. Note how the following variables are represented:

1) A simple variable:

 int x = 5

 { name: "x", value: "5", type: "int" }  // Captured variable

2) A compound object:

 struct T {
     int m1;
     int m2;
 };
 T x = { 3, 7 };

 {  // Captured variable
     name: "x",
     type: "T",
     members { name: "m1", value: "3", type: "int" },
     members { name: "m2", value: "7", type: "int" }
 }

3) A pointer where the pointee was captured:

 T x = { 3, 7 };
 T* p = &amp;x;

 {   // Captured variable
     name: "p",
     type: "T*",
     value: "0x00500500",
     members { name: "m1", value: "3", type: "int" },
     members { name: "m2", value: "7", type: "int" }
 }

4) A pointer where the pointee was not captured:

 T* p = new T;

 {   // Captured variable
     name: "p",
     type: "T*",
     value: "0x00400400"
     status { is_error: true, description { format: "unavailable" } }
 }

The status should describe the reason for the missing value, such as <optimized out>, <inaccessible>, <pointers limit reached>.

Note that a null pointer should not have members.

5) An unnamed value:

 int* p = new int(7);

 {   // Captured variable
     name: "p",
     value: "0x00500500",
     type: "int*",
     members { value: "7", type: "int" } }

6) An unnamed pointer where the pointee was not captured:

 int* p = new int(7);
 int** pp = &amp;p;

 {  // Captured variable
     name: "pp",
     value: "0x00500500",
     type: "int**",
     members {
         value: "0x00400400",
         type: "int*"
         status {
             is_error: true,
             description: { format: "unavailable" } }
         }
     }
 }

To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the var_table_index field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable, merge the referencing variable with the referenced variable.

When using the shared variable table, the following variables:

 T x = { 3, 7 };
 T* p = &amp;x;
 T&amp; r = x;

 { name: "x", var_table_index: 3, type: "T" }  // Captured variables
 { name: "p", value "0x00500500", type="T*", var_table_index: 3 }
 { name: "r", type="T&amp;", var_table_index: 3 }

 {  // Shared variable table entry #3:
     members { name: "m1", value: "3", type: "int" },
     members { name: "m2", value: "7", type: "int" }
 }

Note that the pointer address is stored with the referencing variable and not with the referenced variable. This allows the referenced variable to be shared between pointers and references.

The type field is optional. The debugger agent may or may not support it.

Protobuf type google.devtools.clouddebugger.v2.Variable

Interfaces

BreakpointOrBuilder

Controller2Grpc.AsyncService

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.

DebuggeeOrBuilder

Debugger2Grpc.AsyncService

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.

DeleteBreakpointRequestOrBuilder

FormatMessageOrBuilder

GetBreakpointRequestOrBuilder

GetBreakpointResponseOrBuilder

ListActiveBreakpointsRequestOrBuilder

ListActiveBreakpointsResponseOrBuilder

ListBreakpointsRequest.BreakpointActionValueOrBuilder

ListBreakpointsRequestOrBuilder

ListBreakpointsResponseOrBuilder

ListDebuggeesRequestOrBuilder

ListDebuggeesResponseOrBuilder

RegisterDebuggeeRequestOrBuilder

RegisterDebuggeeResponseOrBuilder

SetBreakpointRequestOrBuilder

SetBreakpointResponseOrBuilder

SourceLocationOrBuilder

StackFrameOrBuilder

StatusMessageOrBuilder

UpdateActiveBreakpointRequestOrBuilder

UpdateActiveBreakpointResponseOrBuilder

VariableOrBuilder

Enums

Breakpoint.Action

Actions that can be taken when a breakpoint hits. Agents should reject breakpoints with unsupported or unknown action values.

Protobuf enum google.devtools.clouddebugger.v2.Breakpoint.Action

Breakpoint.LogLevel

Log severity levels.

Protobuf enum google.devtools.clouddebugger.v2.Breakpoint.LogLevel

StatusMessage.Reference

Enumerates references to which the message applies.

Protobuf enum google.devtools.clouddebugger.v2.StatusMessage.Reference