API Reference google_api_cloud_debugger v0.18.0

Modules

API client metadata for GoogleApi.CloudDebugger.V2.

API calls for all endpoints tagged Controller.

API calls for all endpoints tagged Debugger.

Handle Tesla connections for GoogleApi.CloudDebugger.V2.

An alias to a repo revision.

------------------------------------------------------------------------------ ## Breakpoint (the resource) Represents the breakpoint specification, status and results.

A CloudRepoSourceContext denotes a particular revision in a cloud repo (a repo hosted by the Google Cloud Platform).

A CloudWorkspaceId is a unique identifier for a cloud workspace. A cloud workspace is a place associated with a repo where modified files can be stored before they are committed.

A CloudWorkspaceSourceContext denotes a workspace at a particular snapshot.

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.

A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}.

An ExtendedSourceContext is a SourceContext combined with additional details describing the context.

Represents a message with parameters.

A SourceContext referring to a Gerrit project.

Response for getting breakpoint information.

A GitSourceContext denotes a particular revision in a third party Git repository (e.g. GitHub).

Response for listing active breakpoints.

Selects a repo using a Google Cloud Platform project ID (e.g. winged-cargo-31) and a repo name within that project.

Response for registering a debuggee.

A unique identifier for a cloud repo.

Response for setting a breakpoint.

A SourceContext is a reference to a tree of files. A SourceContext together with a path point to a unique revision of a single file or directory.

Represents a location in the source code.

Represents a stack frame context.

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.

Request to update an active breakpoint.

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

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 ,, `. 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 = &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 thevar_table_indexfield. 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 = &x; T& 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&", 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. ## Attributes *members(*type:*list(GoogleApi.CloudDebugger.V2.Model.Variable.t), *default:*nil) - Members contained or pointed to by the variable. *name(*type:*String.t, *default:*nil) - Name of the variable, if any. *status(*type:*GoogleApi.CloudDebugger.V2.Model.StatusMessage.t, *default:*nil) - Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state. The message may refer to variable name withrefers_toset toVARIABLE_NAME. Alternativelyrefers_towill be set toVARIABLE_VALUE. In either case variable value and members will be unset. Example of error message applied to name:Invalid expression syntax. Example of information message applied to value:Not captured. Examples of error message applied to value: *Malformed string, *Field f not found in class C*Null pointer dereference*type(*type:*String.t, *default:*nil) - Variable type (e.g.MyClass). If the variable is split withvar_table_index,typegoes next tovalue. The interpretation of a type is agent specific. It is recommended to include the dynamic type rather than a static type of an object. *value(*type:*String.t, *default:*nil) - Simple value of the variable. *varTableIndex(*type:*integer(), *default:*nil) - Reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. Thevar_table_indexfield is an index intovariable_table` in Breakpoint.