Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(78)

Issues Search
    My Issues | Starred     Open | Closed | All

Unified Diff: discovery/googleapis/clouddebugger__v2.json

Issue 2649893002: Api-roll 44: 2017-01-23 (Closed)
Patch Set: Created 3 years, 11 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « discovery/googleapis/cloudbuild__v1.json ('k') | discovery/googleapis/cloudresourcemanager__v1.json » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: discovery/googleapis/clouddebugger__v2.json
diff --git a/discovery/googleapis/clouddebugger__v2.json b/discovery/googleapis/clouddebugger__v2.json
index b3c2dc3c802551c432a47a25f0c868f81f7f1925..1182ce9251bb343f5977d601a1190f123513f778 100644
--- a/discovery/googleapis/clouddebugger__v2.json
+++ b/discovery/googleapis/clouddebugger__v2.json
@@ -15,10 +15,9 @@
"baseUrl": "https://clouddebugger.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Cloud Debugger",
- "description": "Examines the call stack and variables of a running application without stopping or slowing it down.",
+ "description": "Examines the call stack and variables of a running application without stopping or slowing it down.\n",
"discoveryVersion": "v1",
"documentationLink": "http://cloud.google.com/debugger",
- "etag": "\"tbys6C40o18GZwyMen5GMkdK-3s/QjifI48X3fgI9mRgli3ziT84a8U\"",
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
@@ -34,9 +33,41 @@
"location": "query",
"type": "string"
},
+ "prettyPrint": {
+ "default": "true",
+ "description": "Returns response with indentations and line breaks.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "location": "query",
+ "type": "string"
+ },
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "location": "query",
+ "type": "string"
+ },
+ "pp": {
+ "default": "true",
+ "description": "Pretty-print response.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query",
+ "type": "string"
+ },
"alt": {
"default": "json",
"description": "Data format for response.",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
@@ -45,8 +76,16 @@
"location": "query",
"type": "string"
},
- "bearer_token": {
- "description": "OAuth bearer token.",
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
"location": "query",
"type": "string"
},
@@ -55,35 +94,18 @@
"location": "query",
"type": "string"
},
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query",
- "type": "string"
- },
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query",
- "type": "string"
- },
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
- "pp": {
- "default": "true",
- "description": "Pretty-print response.",
- "location": "query",
- "type": "boolean"
- },
- "prettyPrint": {
- "default": "true",
- "description": "Returns response with indentations and line breaks.",
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
- "type": "boolean"
+ "type": "string"
},
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "bearer_token": {
+ "description": "OAuth bearer token.",
"location": "query",
"type": "string"
},
@@ -91,20 +113,6 @@
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "location": "query",
- "type": "string"
- },
- "$.xgafv": {
- "description": "V1 error format.",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "type": "string"
}
},
"protocol": "rest",
@@ -114,9 +122,11 @@
"debuggees": {
"methods": {
"register": {
- "description": "Registers the debuggee with the controller service. All agents attached to the same application should call this method with 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 allows the controller service to disable the agent or recover from any data loss. If the debuggee is disabled by the server, the response will have `is_disabled` set to `true`.",
+ "description": "Registers the debuggee with the controller service.\n\nAll agents attached to the same application should call this method with\nthe same request content to get back the same stable `debuggee_id`. Agents\nshould call this method again whenever `google.rpc.Code.NOT_FOUND` is\nreturned from any controller method.\n\nThis allows the controller service to disable the agent or recover from any\ndata loss. If the debuggee is disabled by the server, the response will\nhave `is_disabled` set to `true`.",
"httpMethod": "POST",
"id": "clouddebugger.controller.debuggees.register",
+ "parameterOrder": [],
+ "parameters": {},
"path": "v2/controller/debuggees/register",
"request": {
"$ref": "RegisterDebuggeeRequest"
@@ -133,68 +143,68 @@
"resources": {
"breakpoints": {
"methods": {
- "list": {
- "description": "Returns the list of all active breakpoints for the debuggee. The breakpoint specification (location, condition, and expression 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.",
- "httpMethod": "GET",
- "id": "clouddebugger.controller.debuggees.breakpoints.list",
+ "update": {
+ "description": "Updates the breakpoint state or mutable fields.\nThe entire Breakpoint message must be sent back to the controller\nservice.\n\nUpdates to active breakpoint fields are only allowed if the new value\ndoes not change the breakpoint specification. Updates to the `location`,\n`condition` and `expression` fields should not alter the breakpoint\nsemantics. These may only make changes such as canonicalizing a value\nor snapping the location to the correct line of code.",
+ "httpMethod": "PUT",
+ "id": "clouddebugger.controller.debuggees.breakpoints.update",
"parameterOrder": [
- "debuggeeId"
+ "debuggeeId",
+ "id"
],
"parameters": {
"debuggeeId": {
- "description": "Identifies the debuggee.",
+ "description": "Identifies the debuggee being debugged.",
"location": "path",
"required": true,
"type": "string"
},
- "waitToken": {
- "description": "A wait token that, if specified, blocks the method call until the list of active breakpoints has changed, or a server selected timeout has expired. The value should be set from the last returned response.",
- "location": "query",
+ "id": {
+ "description": "Breakpoint identifier, unique in the scope of the debuggee.",
+ "location": "path",
+ "required": true,
"type": "string"
- },
- "successOnTimeout": {
- "description": "If set to `true`, returns `google.rpc.Code.OK` status and sets the `wait_expired` response field to `true` when the server-selected timeout has expired (recommended). If set to `false`, returns `google.rpc.Code.ABORTED` status when the server-selected timeout has expired (deprecated).",
- "location": "query",
- "type": "boolean"
}
},
- "path": "v2/controller/debuggees/{debuggeeId}/breakpoints",
+ "path": "v2/controller/debuggees/{debuggeeId}/breakpoints/{id}",
+ "request": {
+ "$ref": "UpdateActiveBreakpointRequest"
+ },
"response": {
- "$ref": "ListActiveBreakpointsResponse"
+ "$ref": "UpdateActiveBreakpointResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud_debugger"
]
},
- "update": {
- "description": "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 `expression` 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.",
- "httpMethod": "PUT",
- "id": "clouddebugger.controller.debuggees.breakpoints.update",
+ "list": {
+ "description": "Returns the list of all active breakpoints for the debuggee.\n\nThe breakpoint specification (location, condition, and expression\nfields) is semantically immutable, although the field values may\nchange. For example, an agent may update the location line number\nto reflect the actual line where the breakpoint was set, but this\ndoesn't change the breakpoint semantics.\n\nThis means that an agent does not need to check if a breakpoint has changed\nwhen it encounters the same breakpoint on a successive call.\nMoreover, an agent should remember the breakpoints that are completed\nuntil the controller removes them from the active list to avoid\nsetting those breakpoints again.",
+ "httpMethod": "GET",
+ "id": "clouddebugger.controller.debuggees.breakpoints.list",
"parameterOrder": [
- "debuggeeId",
- "id"
+ "debuggeeId"
],
"parameters": {
"debuggeeId": {
- "description": "Identifies the debuggee being debugged.",
+ "description": "Identifies the debuggee.",
"location": "path",
"required": true,
"type": "string"
},
- "id": {
- "description": "Breakpoint identifier, unique in the scope of the debuggee.",
- "location": "path",
- "required": true,
+ "successOnTimeout": {
+ "description": "If set to `true`, returns `google.rpc.Code.OK` status and sets the\n`wait_expired` response field to `true` when the server-selected timeout\nhas expired (recommended).\n\nIf set to `false`, returns `google.rpc.Code.ABORTED` status when the\nserver-selected timeout has expired (deprecated).",
+ "location": "query",
+ "type": "boolean"
+ },
+ "waitToken": {
+ "description": "A wait token that, if specified, blocks the method call until the list\nof active breakpoints has changed, or a server selected timeout has\nexpired. The value should be set from the last returned response.",
+ "location": "query",
"type": "string"
}
},
- "path": "v2/controller/debuggees/{debuggeeId}/breakpoints/{id}",
- "request": {
- "$ref": "UpdateActiveBreakpointRequest"
- },
+ "path": "v2/controller/debuggees/{debuggeeId}/breakpoints",
"response": {
- "$ref": "UpdateActiveBreakpointResponse"
+ "$ref": "ListActiveBreakpointsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
@@ -215,19 +225,20 @@
"description": "Lists all the debuggees that the user can set breakpoints to.",
"httpMethod": "GET",
"id": "clouddebugger.debugger.debuggees.list",
+ "parameterOrder": [],
"parameters": {
+ "includeInactive": {
+ "description": "When set to `true`, the result includes all debuggees. Otherwise, the\nresult includes only debuggees that are active.",
+ "location": "query",
+ "type": "boolean"
+ },
"project": {
"description": "Project number of a Google Cloud project whose debuggees to list.",
"location": "query",
"type": "string"
},
- "includeInactive": {
- "description": "When set to `true`, the result includes all debuggees. Otherwise, the result includes only debuggees that are active.",
- "location": "query",
- "type": "boolean"
- },
"clientVersion": {
- "description": "The client version making the call. Following: `domain/type/version` (e.g., `google.com/intellij/v1`).",
+ "description": "The client version making the call.\nFollowing: `domain/type/version` (e.g., `google.com/intellij/v1`).",
"location": "query",
"type": "string"
}
@@ -245,38 +256,6 @@
"resources": {
"breakpoints": {
"methods": {
- "set": {
- "description": "Sets the breakpoint to the debuggee.",
- "httpMethod": "POST",
- "id": "clouddebugger.debugger.debuggees.breakpoints.set",
- "parameterOrder": [
- "debuggeeId"
- ],
- "parameters": {
- "debuggeeId": {
- "description": "ID of the debuggee where the breakpoint is to be set.",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "clientVersion": {
- "description": "The client version making the call. Following: `domain/type/version` (e.g., `google.com/intellij/v1`).",
- "location": "query",
- "type": "string"
- }
- },
- "path": "v2/debugger/debuggees/{debuggeeId}/breakpoints/set",
- "request": {
- "$ref": "Breakpoint"
- },
- "response": {
- "$ref": "SetBreakpointResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud_debugger"
- ]
- },
"get": {
"description": "Gets breakpoint information.",
"httpMethod": "GET",
@@ -299,7 +278,7 @@
"type": "string"
},
"clientVersion": {
- "description": "The client version making the call. Following: `domain/type/version` (e.g., `google.com/intellij/v1`).",
+ "description": "The client version making the call.\nFollowing: `domain/type/version` (e.g., `google.com/intellij/v1`).",
"location": "query",
"type": "string"
}
@@ -313,42 +292,6 @@
"https://www.googleapis.com/auth/cloud_debugger"
]
},
- "delete": {
- "description": "Deletes the breakpoint from the debuggee.",
- "httpMethod": "DELETE",
- "id": "clouddebugger.debugger.debuggees.breakpoints.delete",
- "parameterOrder": [
- "debuggeeId",
- "breakpointId"
- ],
- "parameters": {
- "debuggeeId": {
- "description": "ID of the debuggee whose breakpoint to delete.",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "breakpointId": {
- "description": "ID of the breakpoint to delete.",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "clientVersion": {
- "description": "The client version making the call. Following: `domain/type/version` (e.g., `google.com/intellij/v1`).",
- "location": "query",
- "type": "string"
- }
- },
- "path": "v2/debugger/debuggees/{debuggeeId}/breakpoints/{breakpointId}",
- "response": {
- "$ref": "Empty"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud_debugger"
- ]
- },
"list": {
"description": "Lists all breakpoints for the debuggee.",
"httpMethod": "GET",
@@ -363,13 +306,18 @@
"required": true,
"type": "string"
},
+ "clientVersion": {
+ "description": "The client version making the call.\nFollowing: `domain/type/version` (e.g., `google.com/intellij/v1`).",
+ "location": "query",
+ "type": "string"
+ },
"includeAllUsers": {
- "description": "When set to `true`, the response includes the list of breakpoints set by any user. Otherwise, it includes only breakpoints set by the caller.",
+ "description": "When set to `true`, the response includes the list of breakpoints set by\nany user. Otherwise, it includes only breakpoints set by the caller.",
"location": "query",
"type": "boolean"
},
- "includeInactive": {
- "description": "When set to `true`, the response includes active and inactive breakpoints. Otherwise, it includes only active breakpoints.",
+ "stripResults": {
+ "description": "This field is deprecated. The following fields are always stripped out of\nthe result: `stack_frames`, `evaluated_expressions` and `variable_table`.",
"location": "query",
"type": "boolean"
},
@@ -382,54 +330,106 @@
"location": "query",
"type": "string"
},
- "stripResults": {
- "description": "When set to `true`, the response breakpoints are stripped of the results fields: `stack_frames`, `evaluated_expressions` and `variable_table`.",
+ "includeInactive": {
+ "description": "When set to `true`, the response includes active and inactive\nbreakpoints. Otherwise, it includes only active breakpoints.",
"location": "query",
"type": "boolean"
},
"waitToken": {
- "description": "A wait token that, if specified, blocks the call until the breakpoints list has changed, or a server selected timeout has expired. The value should be set from the last response. The error code `google.rpc.Code.ABORTED` (RPC) is returned on wait timeout, which should be called again with the same `wait_token`.",
+ "description": "A wait token that, if specified, blocks the call until the breakpoints\nlist has changed, or a server selected timeout has expired. The value\nshould be set from the last response. The error code\n`google.rpc.Code.ABORTED` (RPC) is returned on wait timeout, which\nshould be called again with the same `wait_token`.",
"location": "query",
"type": "string"
+ }
+ },
+ "path": "v2/debugger/debuggees/{debuggeeId}/breakpoints",
+ "response": {
+ "$ref": "ListBreakpointsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud_debugger"
+ ]
+ },
+ "set": {
+ "description": "Sets the breakpoint to the debuggee.",
+ "httpMethod": "POST",
+ "id": "clouddebugger.debugger.debuggees.breakpoints.set",
+ "parameterOrder": [
+ "debuggeeId"
+ ],
+ "parameters": {
+ "debuggeeId": {
+ "description": "ID of the debuggee where the breakpoint is to be set.",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
"clientVersion": {
- "description": "The client version making the call. Following: `domain/type/version` (e.g., `google.com/intellij/v1`).",
+ "description": "The client version making the call.\nFollowing: `domain/type/version` (e.g., `google.com/intellij/v1`).",
"location": "query",
"type": "string"
}
},
- "path": "v2/debugger/debuggees/{debuggeeId}/breakpoints",
+ "path": "v2/debugger/debuggees/{debuggeeId}/breakpoints/set",
+ "request": {
+ "$ref": "Breakpoint"
+ },
"response": {
- "$ref": "ListBreakpointsResponse"
+ "$ref": "SetBreakpointResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud_debugger"
]
- }
- }
- }
- }
- }
- }
- }
- },
- "revision": "20160810",
- "rootUrl": "https://clouddebugger.googleapis.com/",
- "schemas": {
- "RegisterDebuggeeRequest": {
- "description": "Request to register a debuggee.",
- "id": "RegisterDebuggeeRequest",
- "properties": {
- "debuggee": {
- "$ref": "Debuggee",
- "description": "Debuggee information to register. The fields `project`, `uniquifier`, `description` and `agent_version` of the debuggee must be set."
+ },
+ "delete": {
+ "description": "Deletes the breakpoint from the debuggee.",
+ "httpMethod": "DELETE",
+ "id": "clouddebugger.debugger.debuggees.breakpoints.delete",
+ "parameterOrder": [
+ "debuggeeId",
+ "breakpointId"
+ ],
+ "parameters": {
+ "debuggeeId": {
+ "description": "ID of the debuggee whose breakpoint to delete.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "breakpointId": {
+ "description": "ID of the breakpoint to delete.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "clientVersion": {
+ "description": "The client version making the call.\nFollowing: `domain/type/version` (e.g., `google.com/intellij/v1`).",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v2/debugger/debuggees/{debuggeeId}/breakpoints/{breakpointId}",
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud_debugger"
+ ]
+ }
+ }
+ }
+ }
}
- },
- "type": "object"
- },
+ }
+ }
+ },
+ "revision": "20170117",
+ "rootUrl": "https://clouddebugger.googleapis.com/",
+ "schemas": {
"Debuggee": {
- "description": "Represents the application to debug. 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. The agents attached to the same debuggee are identified by using exactly the same field values when registering.",
+ "description": "Represents the application to debug. The application may include one or more\nreplicated processes executing the same code. Each of these processes is\nattached with a debugger agent, carrying out the debugging commands.\nThe agents attached to the same debuggee are identified by using exactly the\nsame field values when registering.",
"id": "Debuggee",
"properties": {
"id": {
@@ -437,135 +437,161 @@
"type": "string"
},
"project": {
- "description": "Project the debuggee is associated with. Use the project number when registering a Google Cloud Platform project.",
+ "description": "Project the debuggee is associated with.\nUse the project number when registering a Google Cloud Platform project.",
"type": "string"
},
- "uniquifier": {
- "description": "Debuggee uniquifier within the project. Any string that identifies the application within the project can be used. Including environment and version or build IDs is recommended.",
- "type": "string"
+ "extSourceContexts": {
+ "description": "References to the locations and revisions of the source code used in the\ndeployed application.\n\nContexts describing a remote repo related to the source code\nhave a `category` label of `remote_repo`. Source snapshot source\ncontexts have a `category` of `snapshot`.",
+ "items": {
+ "$ref": "ExtendedSourceContext"
+ },
+ "type": "array"
},
"description": {
- "description": "Human readable description of the debuggee. Including a human-readable project name, environment name and version information is recommended.",
+ "description": "Human readable description of the debuggee.\nIncluding a human-readable project name, environment name and version\ninformation is recommended.",
"type": "string"
},
+ "isDisabled": {
+ "description": "If set to `true`, indicates that the agent should disable itself and\ndetach from the debuggee.",
+ "type": "boolean"
+ },
+ "status": {
+ "$ref": "StatusMessage",
+ "description": "Human readable message to be displayed to the user about this debuggee.\nAbsence of this field indicates no status. The message can be either\ninformational or an error status."
+ },
"isInactive": {
- "description": "If set to `true`, indicates that the debuggee is considered as inactive by the Controller service.",
+ "description": "If set to `true`, indicates that the debuggee is considered as inactive by\nthe Controller service.",
"type": "boolean"
},
"agentVersion": {
- "description": "Version ID of the agent release. The version ID is structured as following: `domain/type/vmajor.minor` (for example `google.com/gcp-java/v1.1`).",
+ "description": "Version ID of the agent release. The version ID is structured as\nfollowing: `domain/type/vmajor.minor` (for example\n`google.com/gcp-java/v1.1`).",
"type": "string"
},
- "isDisabled": {
- "description": "If set to `true`, indicates that the agent should disable itself and detach from the debuggee.",
- "type": "boolean"
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "A set of custom debuggee properties, populated by the agent, to be\ndisplayed to the user.",
+ "type": "object"
},
- "status": {
- "$ref": "StatusMessage",
- "description": "Human readable message to be displayed to the user about this debuggee. Absence of this field indicates no status. The message can be either informational or an error status."
+ "uniquifier": {
+ "description": "Debuggee uniquifier within the project.\nAny string that identifies the application within the project can be used.\nIncluding environment and version or build IDs is recommended.",
+ "type": "string"
},
"sourceContexts": {
- "description": "References to the locations and revisions of the source code used in the deployed application. NOTE: This field is deprecated. Consumers should use `ext_source_contexts` if it is not empty. Debug agents should populate both this field and `ext_source_contexts`.",
+ "description": "References to the locations and revisions of the source code used in the\ndeployed application.\n\nNOTE: This field is deprecated. Consumers should use\n`ext_source_contexts` if it is not empty. Debug agents should populate\nboth this field and `ext_source_contexts`.",
"items": {
"$ref": "SourceContext"
},
"type": "array"
- },
- "extSourceContexts": {
- "description": "References to the locations and revisions of the source code used in the deployed application. Contexts describing a remote repo related to the source code have a `category` label of `remote_repo`. Source snapshot source contexts have a `category` of `snapshot`.",
+ }
+ },
+ "type": "object"
+ },
+ "StackFrame": {
+ "description": "Represents a stack frame context.",
+ "id": "StackFrame",
+ "properties": {
+ "locals": {
+ "description": "Set of local variables at the stack frame location.\nNote that this might not be populated for all stack frames.",
"items": {
- "$ref": "ExtendedSourceContext"
+ "$ref": "Variable"
},
"type": "array"
},
- "labels": {
- "additionalProperties": {
- "type": "string"
+ "function": {
+ "description": "Demangled function name at the call site.",
+ "type": "string"
+ },
+ "location": {
+ "$ref": "SourceLocation",
+ "description": "Source location of the call site."
+ },
+ "arguments": {
+ "description": "Set of arguments passed to this function.\nNote that this might not be populated for all stack frames.",
+ "items": {
+ "$ref": "Variable"
},
- "description": "A set of custom debuggee properties, populated by the agent, to be displayed to the user.",
- "type": "object"
+ "type": "array"
}
},
"type": "object"
},
- "StatusMessage": {
- "description": "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`.",
- "id": "StatusMessage",
+ "ListBreakpointsResponse": {
+ "description": "Response for listing breakpoints.",
+ "id": "ListBreakpointsResponse",
"properties": {
- "isError": {
- "description": "Distinguishes errors from informational messages.",
- "type": "boolean"
+ "breakpoints": {
+ "description": "List of breakpoints matching the request.\nThe fields `id` and `location` are guaranteed to be set on each breakpoint.\nThe fields: `stack_frames`, `evaluated_expressions` and `variable_table`\nare cleared on each breakpoint regardless of it's status.",
+ "items": {
+ "$ref": "Breakpoint"
+ },
+ "type": "array"
},
- "refersTo": {
- "description": "Reference to which the message applies.",
- "enum": [
- "UNSPECIFIED",
- "BREAKPOINT_SOURCE_LOCATION",
- "BREAKPOINT_CONDITION",
- "BREAKPOINT_EXPRESSION",
- "VARIABLE_NAME",
- "VARIABLE_VALUE"
- ],
+ "nextWaitToken": {
+ "description": "A wait token that can be used in the next call to `list` (REST) or\n`ListBreakpoints` (RPC) to block until the list of breakpoints has changes.",
"type": "string"
- },
- "description": {
- "$ref": "FormatMessage",
- "description": "Status message text."
}
},
"type": "object"
},
- "FormatMessage": {
- "description": "Represents a message with parameters.",
- "id": "FormatMessage",
+ "Variable": {
+ "description": "Represents a variable or an argument possibly of a compound object type.\nNote how the following variables are represented:\n\n1) A simple variable:\n\n int x = 5\n\n { name: \"x\", value: \"5\", type: \"int\" } // Captured variable\n\n2) A compound object:\n\n struct T {\n int m1;\n int m2;\n };\n T x = { 3, 7 };\n\n { // Captured variable\n name: \"x\",\n type: \"T\",\n members { name: \"m1\", value: \"3\", type: \"int\" },\n members { name: \"m2\", value: \"7\", type: \"int\" }\n }\n\n3) A pointer where the pointee was captured:\n\n T x = { 3, 7 };\n T* p = &x;\n\n { // Captured variable\n name: \"p\",\n type: \"T*\",\n value: \"0x00500500\",\n members { name: \"m1\", value: \"3\", type: \"int\" },\n members { name: \"m2\", value: \"7\", type: \"int\" }\n }\n\n4) A pointer where the pointee was not captured:\n\n T* p = new T;\n\n { // Captured variable\n name: \"p\",\n type: \"T*\",\n value: \"0x00400400\"\n status { is_error: true, description { format: \"unavailable\" } }\n }\n\nThe status should describe the reason for the missing value,\nsuch as `<optimized out>`, `<inaccessible>`, `<pointers limit reached>`.\n\nNote that a null pointer should not have members.\n\n5) An unnamed value:\n\n int* p = new int(7);\n\n { // Captured variable\n name: \"p\",\n value: \"0x00500500\",\n type: \"int*\",\n members { value: \"7\", type: \"int\" } }\n\n6) An unnamed pointer where the pointee was not captured:\n\n int* p = new int(7);\n int** pp = &p;\n\n { // Captured variable\n name: \"pp\",\n value: \"0x00500500\",\n type: \"int**\",\n members {\n value: \"0x00400400\",\n type: \"int*\"\n status {\n is_error: true,\n description: { format: \"unavailable\" } }\n }\n }\n }\n\nTo optimize computation, memory and network traffic, variables that\nrepeat in the output multiple times can be stored once in a shared\nvariable table and be referenced using the `var_table_index` field. The\nvariables stored in the shared table are nameless and are essentially\na partition of the complete variable. To reconstruct the complete\nvariable, merge the referencing variable with the referenced variable.\n\nWhen using the shared variable table, the following variables:\n\n T x = { 3, 7 };\n T* p = &x;\n T& r = x;\n\n { name: \"x\", var_table_index: 3, type: \"T\" } // Captured variables\n { name: \"p\", value \"0x00500500\", type=\"T*\", var_table_index: 3 }\n { name: \"r\", type=\"T&\", var_table_index: 3 }\n\n { // Shared variable table entry #3:\n members { name: \"m1\", value: \"3\", type: \"int\" },\n members { name: \"m2\", value: \"7\", type: \"int\" }\n }\n\nNote that the pointer address is stored with the referencing variable\nand not with the referenced variable. This allows the referenced variable\nto be shared between pointers and references.\n\nThe type field is optional. The debugger agent may or may not support it.",
+ "id": "Variable",
"properties": {
- "format": {
- "description": "Format template for the message. The `format` uses placeholders `$0`, `$1`, etc. to reference parameters. `$$` can be used to denote the `$` character. Examples: * `Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important.` * `Please pay $$10 to use $0 instead of $1.`",
- "type": "string"
+ "varTableIndex": {
+ "description": "Reference to a variable in the shared variable table. More than\none variable can reference the same variable in the table. The\n`var_table_index` field is an index into `variable_table` in Breakpoint.",
+ "format": "int32",
+ "type": "integer"
},
- "parameters": {
- "description": "Optional parameters to be embedded into the message.",
+ "status": {
+ "$ref": "StatusMessage",
+ "description": "Status associated with the variable. This field will usually stay\nunset. A status of a single variable only applies to that variable or\nexpression. The rest of breakpoint data still remains valid. Variables\nmight be reported in error state even when breakpoint is not in final\nstate.\n\nThe message may refer to variable name with `refers_to` set to\n`VARIABLE_NAME`. Alternatively `refers_to` will be set to `VARIABLE_VALUE`.\nIn either case variable value and members will be unset.\n\nExample of error message applied to name: `Invalid expression syntax`.\n\nExample of information message applied to value: `Not captured`.\n\nExamples of error message applied to value:\n\n* `Malformed string`,\n* `Field f not found in class C`\n* `Null pointer dereference`"
+ },
+ "members": {
+ "description": "Members contained or pointed to by the variable.",
"items": {
- "type": "string"
+ "$ref": "Variable"
},
"type": "array"
+ },
+ "name": {
+ "description": "Name of the variable, if any.",
+ "type": "string"
+ },
+ "value": {
+ "description": "Simple value of the variable.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Variable type (e.g. `MyClass`). If the variable is split with\n`var_table_index`, `type` goes next to `value`. The interpretation of\na type is agent specific. It is recommended to include the dynamic type\nrather than a static type of an object.",
+ "type": "string"
}
},
"type": "object"
},
- "SourceContext": {
- "description": "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.",
- "id": "SourceContext",
+ "SourceLocation": {
+ "description": "Represents a location in the source code.",
+ "id": "SourceLocation",
"properties": {
- "cloudRepo": {
- "$ref": "CloudRepoSourceContext",
- "description": "A SourceContext referring to a revision in a cloud repo."
- },
- "cloudWorkspace": {
- "$ref": "CloudWorkspaceSourceContext",
- "description": "A SourceContext referring to a snapshot in a cloud workspace."
- },
- "gerrit": {
- "$ref": "GerritSourceContext",
- "description": "A SourceContext referring to a Gerrit project."
+ "path": {
+ "description": "Path to the source file within the source context of the target binary.",
+ "type": "string"
},
- "git": {
- "$ref": "GitSourceContext",
- "description": "A SourceContext referring to any third party Git repo (e.g. GitHub)."
+ "line": {
+ "description": "Line inside the file. The first line in the file has the value `1`.",
+ "format": "int32",
+ "type": "integer"
}
},
"type": "object"
},
- "CloudRepoSourceContext": {
- "description": "A CloudRepoSourceContext denotes a particular revision in a cloud repo (a repo hosted by the Google Cloud Platform).",
- "id": "CloudRepoSourceContext",
+ "GerritSourceContext": {
+ "description": "A SourceContext referring to a Gerrit project.",
+ "id": "GerritSourceContext",
"properties": {
- "repoId": {
- "$ref": "RepoId",
- "description": "The ID of the repo."
- },
- "revisionId": {
- "description": "A revision ID.",
+ "hostUri": {
+ "description": "The URI of a running Gerrit instance.",
"type": "string"
},
"aliasName": {
@@ -575,36 +601,54 @@
"aliasContext": {
"$ref": "AliasContext",
"description": "An alias, which may be a branch or tag."
+ },
+ "gerritProject": {
+ "description": "The full project name within the host. Projects may be nested, so\n\"project/subproject\" is a valid project name.\nThe \"repo name\" is hostURI/project.",
+ "type": "string"
+ },
+ "revisionId": {
+ "description": "A revision (commit) ID.",
+ "type": "string"
}
},
"type": "object"
},
- "RepoId": {
- "description": "A unique identifier for a cloud repo.",
- "id": "RepoId",
+ "FormatMessage": {
+ "description": "Represents a message with parameters.",
+ "id": "FormatMessage",
"properties": {
- "projectRepoId": {
- "$ref": "ProjectRepoId",
- "description": "A combination of a project ID and a repo name."
+ "parameters": {
+ "description": "Optional parameters to be embedded into the message.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
},
- "uid": {
- "description": "A server-assigned, globally unique identifier.",
+ "format": {
+ "description": "Format template for the message. The `format` uses placeholders `$0`,\n`$1`, etc. to reference parameters. `$$` can be used to denote the `$`\ncharacter.\n\nExamples:\n\n* `Failed to load '$0' which helps debug $1 the first time it\n is loaded. Again, $0 is very important.`\n* `Please pay $$10 to use $0 instead of $1.`",
"type": "string"
}
},
"type": "object"
},
- "ProjectRepoId": {
- "description": "Selects a repo using a Google Cloud Platform project ID (e.g. winged-cargo-31) and a repo name within that project.",
- "id": "ProjectRepoId",
+ "RegisterDebuggeeResponse": {
+ "description": "Response for registering a debuggee.",
+ "id": "RegisterDebuggeeResponse",
"properties": {
- "projectId": {
- "description": "The ID of the project.",
- "type": "string"
- },
- "repoName": {
- "description": "The name of the repo. Leave empty for the default repo.",
- "type": "string"
+ "debuggee": {
+ "$ref": "Debuggee",
+ "description": "Debuggee resource.\nThe field `id` is guranteed to be set (in addition to the echoed fields)."
+ }
+ },
+ "type": "object"
+ },
+ "GetBreakpointResponse": {
+ "description": "Response for getting breakpoint information.",
+ "id": "GetBreakpointResponse",
+ "properties": {
+ "breakpoint": {
+ "$ref": "Breakpoint",
+ "description": "Complete breakpoint state.\nThe fields `id` and `location` are guaranteed to be set."
}
},
"type": "object"
@@ -621,6 +665,12 @@
"MOVABLE",
"OTHER"
],
+ "enumDescriptions": [
+ "Do not use.",
+ "Git tag",
+ "Git branch",
+ "OTHER is used to specify non-standard aliases, those not of the kinds\nabove. For example, if a Git repo has a ref named \"refs/foo/bar\", it\nis considered to be of kind OTHER."
+ ],
"type": "string"
},
"name": {
@@ -630,23 +680,8 @@
},
"type": "object"
},
- "CloudWorkspaceSourceContext": {
- "description": "A CloudWorkspaceSourceContext denotes a workspace at a particular snapshot.",
- "id": "CloudWorkspaceSourceContext",
- "properties": {
- "workspaceId": {
- "$ref": "CloudWorkspaceId",
- "description": "The ID of the workspace."
- },
- "snapshotId": {
- "description": "The ID of the snapshot. An empty snapshot_id refers to the most recent snapshot.",
- "type": "string"
- }
- },
- "type": "object"
- },
"CloudWorkspaceId": {
- "description": "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.",
+ "description": "A CloudWorkspaceId is a unique identifier for a cloud workspace.\nA cloud workspace is a place associated with a repo where modified files\ncan be stored before they are committed.",
"id": "CloudWorkspaceId",
"properties": {
"repoId": {
@@ -654,138 +689,74 @@
"description": "The ID of the repo containing the workspace."
},
"name": {
- "description": "The unique name of the workspace within the repo. This is the name chosen by the client in the Source API's CreateWorkspace method.",
+ "description": "The unique name of the workspace within the repo. This is the name\nchosen by the client in the Source API's CreateWorkspace method.",
"type": "string"
}
},
"type": "object"
},
- "GerritSourceContext": {
- "description": "A SourceContext referring to a Gerrit project.",
- "id": "GerritSourceContext",
+ "Breakpoint": {
+ "description": "Represents the breakpoint specification, status and results.",
+ "id": "Breakpoint",
"properties": {
- "hostUri": {
- "description": "The URI of a running Gerrit instance.",
- "type": "string"
- },
- "gerritProject": {
- "description": "The full project name within the host. Projects may be nested, so \"project/subproject\" is a valid project name. The \"repo name\" is hostURI/project.",
+ "id": {
+ "description": "Breakpoint identifier, unique in the scope of the debuggee.",
"type": "string"
},
- "revisionId": {
- "description": "A revision (commit) ID.",
- "type": "string"
+ "stackFrames": {
+ "description": "The stack at breakpoint time.",
+ "items": {
+ "$ref": "StackFrame"
+ },
+ "type": "array"
},
- "aliasName": {
- "description": "The name of an alias (branch, tag, etc.).",
- "type": "string"
+ "location": {
+ "$ref": "SourceLocation",
+ "description": "Breakpoint source location."
},
- "aliasContext": {
- "$ref": "AliasContext",
- "description": "An alias, which may be a branch or tag."
- }
- },
- "type": "object"
- },
- "GitSourceContext": {
- "description": "A GitSourceContext denotes a particular revision in a third party Git repository (e.g. GitHub).",
- "id": "GitSourceContext",
- "properties": {
- "url": {
- "description": "Git repository URL.",
- "type": "string"
+ "status": {
+ "$ref": "StatusMessage",
+ "description": "Breakpoint status.\n\nThe status includes an error flag and a human readable message.\nThis field is usually unset. The message can be either\ninformational or an error message. Regardless, clients should always\ndisplay the text message back to the user.\n\nError status indicates complete failure of the breakpoint.\n\nExample (non-final state): `Still loading symbols...`\n\nExamples (final state):\n\n* `Invalid line number` referring to location\n* `Field f not found in class C` referring to condition"
},
- "revisionId": {
- "description": "Git commit hash. required.",
+ "userEmail": {
+ "description": "E-mail address of the user that created this breakpoint",
"type": "string"
- }
- },
- "type": "object"
- },
- "ExtendedSourceContext": {
- "description": "An ExtendedSourceContext is a SourceContext combined with additional details describing the context.",
- "id": "ExtendedSourceContext",
- "properties": {
- "context": {
- "$ref": "SourceContext",
- "description": "Any source context."
- },
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Labels with user defined metadata.",
- "type": "object"
- }
- },
- "type": "object"
- },
- "RegisterDebuggeeResponse": {
- "description": "Response for registering a debuggee.",
- "id": "RegisterDebuggeeResponse",
- "properties": {
- "debuggee": {
- "$ref": "Debuggee",
- "description": "Debuggee resource. The field `id` is guranteed to be set (in addition to the echoed fields)."
- }
- },
- "type": "object"
- },
- "ListActiveBreakpointsResponse": {
- "description": "Response for listing active breakpoints.",
- "id": "ListActiveBreakpointsResponse",
- "properties": {
- "breakpoints": {
- "description": "List of all active breakpoints. The fields `id` and `location` are guaranteed to be set on each breakpoint.",
- "items": {
- "$ref": "Breakpoint"
- },
- "type": "array"
},
- "nextWaitToken": {
- "description": "A wait token that can be used in the next method call to block until the list of breakpoints changes.",
+ "condition": {
+ "description": "Condition that triggers the breakpoint.\nThe condition is a compound boolean expression composed using expressions\nin a programming language at the source location.",
"type": "string"
},
- "waitExpired": {
- "description": "The `wait_expired` field is set to true by the server when the request times out and the field `success_on_timeout` is set to true.",
- "type": "boolean"
- }
- },
- "type": "object"
- },
- "Breakpoint": {
- "description": "Represents the breakpoint specification, status and results.",
- "id": "Breakpoint",
- "properties": {
- "id": {
- "description": "Breakpoint identifier, unique in the scope of the debuggee.",
+ "finalTime": {
+ "description": "Time this breakpoint was finalized as seen by the server in seconds\nresolution.",
+ "format": "google-datetime",
"type": "string"
},
"action": {
- "description": "Action that the agent should perform when the code at the breakpoint location is hit.",
+ "description": "Action that the agent should perform when the code at the\nbreakpoint location is hit.",
"enum": [
"CAPTURE",
"LOG"
],
+ "enumDescriptions": [
+ "Capture stack frame and variables and update the breakpoint.\nThe data is only captured once. After that the breakpoint is set\nin a final state.",
+ "Log each breakpoint hit. The breakpoint remains active until\ndeleted or expired."
+ ],
"type": "string"
},
- "location": {
- "$ref": "SourceLocation",
- "description": "Breakpoint source location."
- },
- "condition": {
- "description": "Condition that triggers the breakpoint. The condition is a compound boolean expression composed using expressions in a programming language at the source location.",
- "type": "string"
- },
- "expressions": {
- "description": "List of read-only expressions to evaluate at the breakpoint location. The expressions are composed using expressions in the programming language at the source location. If the breakpoint action is `LOG`, the evaluated expressions are included in log statements.",
- "items": {
+ "labels": {
+ "additionalProperties": {
"type": "string"
},
- "type": "array"
+ "description": "A set of custom breakpoint properties, populated by the agent, to be\ndisplayed to the user.",
+ "type": "object"
},
"logMessageFormat": {
- "description": "Only relevant when action is `LOG`. Defines the message to log when the breakpoint hits. The message may include parameter placeholders `$0`, `$1`, etc. These placeholders are replaced with the evaluated value of the appropriate expression. Expressions not referenced in `log_message_format` are not logged. Example: `Message received, id = $0, count = $1` with `expressions` = `[ message.id, message.count ]`.",
+ "description": "Only relevant when action is `LOG`. Defines the message to log when\nthe breakpoint hits. The message may include parameter placeholders `$0`,\n`$1`, etc. These placeholders are replaced with the evaluated value\nof the appropriate expression. Expressions not referenced in\n`log_message_format` are not logged.\n\nExample: `Message received, id = $0, count = $1` with\n`expressions` = `[ message.id, message.count ]`.",
+ "type": "string"
+ },
+ "createTime": {
+ "description": "Time this breakpoint was created by the server in seconds resolution.",
+ "format": "google-datetime",
"type": "string"
},
"logLevel": {
@@ -795,213 +766,282 @@
"WARNING",
"ERROR"
],
+ "enumDescriptions": [
+ "Information log message.",
+ "Warning log message.",
+ "Error log message."
+ ],
"type": "string"
},
+ "evaluatedExpressions": {
+ "description": "Values of evaluated expressions at breakpoint time.\nThe evaluated expressions appear in exactly the same order they\nare listed in the `expressions` field.\nThe `name` field holds the original expression text, the `value` or\n`members` field holds the result of the evaluated expression.\nIf the expression cannot be evaluated, the `status` inside the `Variable`\nwill indicate an error and contain the error text.",
+ "items": {
+ "$ref": "Variable"
+ },
+ "type": "array"
+ },
"isFinalState": {
- "description": "When true, indicates that this is a final result and the breakpoint state will not change from here on.",
+ "description": "When true, indicates that this is a final result and the\nbreakpoint state will not change from here on.",
"type": "boolean"
},
- "createTime": {
- "description": "Time this breakpoint was created by the server in seconds resolution.",
- "type": "string"
- },
- "finalTime": {
- "description": "Time this breakpoint was finalized as seen by the server in seconds resolution.",
- "type": "string"
- },
- "userEmail": {
- "description": "E-mail address of the user that created this breakpoint",
- "type": "string"
- },
- "status": {
- "$ref": "StatusMessage",
- "description": "Breakpoint status. The status includes an error flag and a human readable message. This field is usually unset. The message can be either informational or an error message. Regardless, clients should always display the text message back to the user. Error status indicates complete failure of the breakpoint. Example (non-final state): `Still loading symbols...` Examples (final state): * `Invalid line number` referring to location * `Field f not found in class C` referring to condition"
- },
- "stackFrames": {
- "description": "The stack at breakpoint time.",
+ "expressions": {
+ "description": "List of read-only expressions to evaluate at the breakpoint location.\nThe expressions are composed using expressions in the programming language\nat the source location. If the breakpoint action is `LOG`, the evaluated\nexpressions are included in log statements.",
"items": {
- "$ref": "StackFrame"
+ "type": "string"
},
"type": "array"
},
- "evaluatedExpressions": {
- "description": "Values of evaluated expressions at breakpoint time. The evaluated expressions appear in exactly the same order they are listed in the `expressions` field. The `name` field holds the original expression text, the `value` or `members` field holds the result of the evaluated expression. If the expression cannot be evaluated, the `status` inside the `Variable` will indicate an error and contain the error text.",
+ "variableTable": {
+ "description": "The `variable_table` exists to aid with computation, memory and network\ntraffic optimization. It enables storing a variable once and reference\nit from multiple variables, including variables stored in the\n`variable_table` itself.\nFor example, the same `this` object, which may appear at many levels of\nthe stack, can have all of its data stored once in this table. The\nstack frame variables then would hold only a reference to it.\n\nThe variable `var_table_index` field is an index into this repeated field.\nThe stored objects are nameless and get their name from the referencing\nvariable. The effective variable is a merge of the referencing variable\nand the referenced variable.",
"items": {
"$ref": "Variable"
},
"type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "SetBreakpointResponse": {
+ "description": "Response for setting a breakpoint.",
+ "id": "SetBreakpointResponse",
+ "properties": {
+ "breakpoint": {
+ "$ref": "Breakpoint",
+ "description": "Breakpoint resource.\nThe field `id` is guaranteed to be set (in addition to the echoed fileds)."
+ }
+ },
+ "type": "object"
+ },
+ "ListActiveBreakpointsResponse": {
+ "description": "Response for listing active breakpoints.",
+ "id": "ListActiveBreakpointsResponse",
+ "properties": {
+ "waitExpired": {
+ "description": "The `wait_expired` field is set to true by the server when the\nrequest times out and the field `success_on_timeout` is set to true.",
+ "type": "boolean"
},
- "variableTable": {
- "description": "The `variable_table` exists to aid with computation, memory and network traffic optimization. It enables storing a variable once and reference it from multiple variables, including variables stored in the `variable_table` itself. For example, the same `this` object, which may appear at many levels of the stack, can have all of its data stored once in this table. The stack frame variables then would hold only a reference to it. The variable `var_table_index` field is an index into this repeated field. The stored objects are nameless and get their name from the referencing variable. The effective variable is a merge of the referencing variable and the referenced variable.",
+ "breakpoints": {
+ "description": "List of all active breakpoints.\nThe fields `id` and `location` are guaranteed to be set on each breakpoint.",
"items": {
- "$ref": "Variable"
+ "$ref": "Breakpoint"
},
"type": "array"
},
+ "nextWaitToken": {
+ "description": "A wait token that can be used in the next method call to block until\nthe list of breakpoints changes.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ExtendedSourceContext": {
+ "description": "An ExtendedSourceContext is a SourceContext combined with additional\ndetails describing the context.",
+ "id": "ExtendedSourceContext",
+ "properties": {
"labels": {
"additionalProperties": {
"type": "string"
},
- "description": "A set of custom breakpoint properties, populated by the agent, to be displayed to the user.",
+ "description": "Labels with user defined metadata.",
"type": "object"
+ },
+ "context": {
+ "$ref": "SourceContext",
+ "description": "Any source context."
}
},
"type": "object"
},
- "SourceLocation": {
- "description": "Represents a location in the source code.",
- "id": "SourceLocation",
+ "RegisterDebuggeeRequest": {
+ "description": "Request to register a debuggee.",
+ "id": "RegisterDebuggeeRequest",
"properties": {
- "path": {
- "description": "Path to the source file within the source context of the target binary.",
- "type": "string"
- },
- "line": {
- "description": "Line inside the file. The first line in the file has the value `1`.",
- "format": "int32",
- "type": "integer"
+ "debuggee": {
+ "$ref": "Debuggee",
+ "description": "Debuggee information to register.\nThe fields `project`, `uniquifier`, `description` and `agent_version`\nof the debuggee must be set."
}
},
"type": "object"
},
- "StackFrame": {
- "description": "Represents a stack frame context.",
- "id": "StackFrame",
+ "RepoId": {
+ "description": "A unique identifier for a cloud repo.",
+ "id": "RepoId",
"properties": {
- "function": {
- "description": "Demangled function name at the call site.",
- "type": "string"
- },
- "location": {
- "$ref": "SourceLocation",
- "description": "Source location of the call site."
- },
- "arguments": {
- "description": "Set of arguments passed to this function. Note that this might not be populated for all stack frames.",
- "items": {
- "$ref": "Variable"
- },
- "type": "array"
+ "projectRepoId": {
+ "$ref": "ProjectRepoId",
+ "description": "A combination of a project ID and a repo name."
},
- "locals": {
- "description": "Set of local variables at the stack frame location. Note that this might not be populated for all stack frames.",
- "items": {
- "$ref": "Variable"
- },
- "type": "array"
+ "uid": {
+ "description": "A server-assigned, globally unique identifier.",
+ "type": "string"
}
},
"type": "object"
},
- "Variable": {
- "description": "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 ``, ``, `\n`. 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 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 = &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.",
- "id": "Variable",
+ "ProjectRepoId": {
+ "description": "Selects a repo using a Google Cloud Platform project ID\n(e.g. winged-cargo-31) and a repo name within that project.",
+ "id": "ProjectRepoId",
"properties": {
- "name": {
- "description": "Name of the variable, if any.",
+ "repoName": {
+ "description": "The name of the repo. Leave empty for the default repo.",
"type": "string"
},
- "value": {
- "description": "Simple value of the variable.",
+ "projectId": {
+ "description": "The ID of the project.",
"type": "string"
- },
- "type": {
- "description": "Variable type (e.g. `MyClass`). If the variable is split with `var_table_index`, `type` goes next to `value`. The interpretation of a type is agent specific. It is recommended to include the dynamic type rather than a static type of an object.",
+ }
+ },
+ "type": "object"
+ },
+ "CloudWorkspaceSourceContext": {
+ "description": "A CloudWorkspaceSourceContext denotes a workspace at a particular snapshot.",
+ "id": "CloudWorkspaceSourceContext",
+ "properties": {
+ "snapshotId": {
+ "description": "The ID of the snapshot.\nAn empty snapshot_id refers to the most recent snapshot.",
"type": "string"
},
- "members": {
- "description": "Members contained or pointed to by the variable.",
+ "workspaceId": {
+ "$ref": "CloudWorkspaceId",
+ "description": "The ID of the workspace."
+ }
+ },
+ "type": "object"
+ },
+ "ListDebuggeesResponse": {
+ "description": "Response for listing debuggees.",
+ "id": "ListDebuggeesResponse",
+ "properties": {
+ "debuggees": {
+ "description": "List of debuggees accessible to the calling user.\nNote that the `description` field is the only human readable field\nthat should be displayed to the user.\nThe fields `debuggee.id` and `description` fields are guaranteed to be\nset on each debuggee.",
"items": {
- "$ref": "Variable"
+ "$ref": "Debuggee"
},
"type": "array"
- },
- "varTableIndex": {
- "description": "Reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The `var_table_index` field is an index into `variable_table` in Breakpoint.",
- "format": "int32",
- "type": "integer"
- },
- "status": {
- "$ref": "StatusMessage",
- "description": "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 with `refers_to` set to `VARIABLE_NAME`. Alternatively `refers_to` will be set to `VARIABLE_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": "object"
},
- "UpdateActiveBreakpointRequest": {
- "description": "Request to update an active breakpoint.",
- "id": "UpdateActiveBreakpointRequest",
+ "CloudRepoSourceContext": {
+ "description": "A CloudRepoSourceContext denotes a particular revision in a cloud\nrepo (a repo hosted by the Google Cloud Platform).",
+ "id": "CloudRepoSourceContext",
"properties": {
- "breakpoint": {
- "$ref": "Breakpoint",
- "description": "Updated breakpoint information. The field 'id' must be set."
+ "aliasName": {
+ "description": "The name of an alias (branch, tag, etc.).",
+ "type": "string"
+ },
+ "aliasContext": {
+ "$ref": "AliasContext",
+ "description": "An alias, which may be a branch or tag."
+ },
+ "repoId": {
+ "$ref": "RepoId",
+ "description": "The ID of the repo."
+ },
+ "revisionId": {
+ "description": "A revision ID.",
+ "type": "string"
}
},
"type": "object"
},
- "UpdateActiveBreakpointResponse": {
- "description": "Response for updating an active breakpoint. The message is defined to allow future extensions.",
- "id": "UpdateActiveBreakpointResponse",
- "type": "object"
- },
- "SetBreakpointResponse": {
- "description": "Response for setting a breakpoint.",
- "id": "SetBreakpointResponse",
+ "UpdateActiveBreakpointRequest": {
+ "description": "Request to update an active breakpoint.",
+ "id": "UpdateActiveBreakpointRequest",
"properties": {
"breakpoint": {
"$ref": "Breakpoint",
- "description": "Breakpoint resource. The field `id` is guaranteed to be set (in addition to the echoed fileds)."
+ "description": "Updated breakpoint information.\nThe field 'id' must be set."
}
},
"type": "object"
},
- "GetBreakpointResponse": {
- "description": "Response for getting breakpoint information.",
- "id": "GetBreakpointResponse",
+ "SourceContext": {
+ "description": "A SourceContext is a reference to a tree of files. A SourceContext together\nwith a path point to a unique revision of a single file or directory.",
+ "id": "SourceContext",
"properties": {
- "breakpoint": {
- "$ref": "Breakpoint",
- "description": "Complete breakpoint state. The fields `id` and `location` are guaranteed to be set."
+ "cloudRepo": {
+ "$ref": "CloudRepoSourceContext",
+ "description": "A SourceContext referring to a revision in a cloud repo."
+ },
+ "cloudWorkspace": {
+ "$ref": "CloudWorkspaceSourceContext",
+ "description": "A SourceContext referring to a snapshot in a cloud workspace."
+ },
+ "git": {
+ "$ref": "GitSourceContext",
+ "description": "A SourceContext referring to any third party Git repo (e.g. GitHub)."
+ },
+ "gerrit": {
+ "$ref": "GerritSourceContext",
+ "description": "A SourceContext referring to a Gerrit project."
}
},
"type": "object"
},
"Empty": {
- "description": "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 `{}`.",
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
"id": "Empty",
+ "properties": {},
"type": "object"
},
- "ListBreakpointsResponse": {
- "description": "Response for listing breakpoints.",
- "id": "ListBreakpointsResponse",
+ "GitSourceContext": {
+ "description": "A GitSourceContext denotes a particular revision in a third party Git\nrepository (e.g. GitHub).",
+ "id": "GitSourceContext",
"properties": {
- "breakpoints": {
- "description": "List of all breakpoints with complete state. The fields `id` and `location` are guaranteed to be set on each breakpoint.",
- "items": {
- "$ref": "Breakpoint"
- },
- "type": "array"
+ "url": {
+ "description": "Git repository URL.",
+ "type": "string"
},
- "nextWaitToken": {
- "description": "A wait token that can be used in the next call to `list` (REST) or `ListBreakpoints` (RPC) to block until the list of breakpoints has changes.",
+ "revisionId": {
+ "description": "Git commit hash.\nrequired.",
"type": "string"
}
},
"type": "object"
},
- "ListDebuggeesResponse": {
- "description": "Response for listing debuggees.",
- "id": "ListDebuggeesResponse",
+ "StatusMessage": {
+ "description": "Represents a contextual status message.\nThe message can indicate an error or informational status, and refer to\nspecific parts of the containing object.\nFor example, the `Breakpoint.status` field can indicate an error referring\nto the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`.",
+ "id": "StatusMessage",
"properties": {
- "debuggees": {
- "description": "List of debuggees accessible to the calling user. Note that the `description` field is the only human readable field that should be displayed to the user. The fields `debuggee.id` and `description` fields are guaranteed to be set on each debuggee.",
- "items": {
- "$ref": "Debuggee"
- },
- "type": "array"
+ "isError": {
+ "description": "Distinguishes errors from informational messages.",
+ "type": "boolean"
+ },
+ "description": {
+ "$ref": "FormatMessage",
+ "description": "Status message text."
+ },
+ "refersTo": {
+ "description": "Reference to which the message applies.",
+ "enum": [
+ "UNSPECIFIED",
+ "BREAKPOINT_SOURCE_LOCATION",
+ "BREAKPOINT_CONDITION",
+ "BREAKPOINT_EXPRESSION",
+ "BREAKPOINT_AGE",
+ "VARIABLE_NAME",
+ "VARIABLE_VALUE"
+ ],
+ "enumDescriptions": [
+ "Status doesn't refer to any particular input.",
+ "Status applies to the breakpoint and is related to its location.",
+ "Status applies to the breakpoint and is related to its condition.",
+ "Status applies to the breakpoint and is related to its expressions.",
+ "Status applies to the breakpoint and is related to its age.",
+ "Status applies to the entire variable.",
+ "Status applies to variable value (variable name is valid)."
+ ],
+ "type": "string"
}
},
"type": "object"
+ },
+ "UpdateActiveBreakpointResponse": {
+ "description": "Response for updating an active breakpoint.\nThe message is defined to allow future extensions.",
+ "id": "UpdateActiveBreakpointResponse",
+ "properties": {},
+ "type": "object"
}
},
"servicePath": "",
« no previous file with comments | « discovery/googleapis/cloudbuild__v1.json ('k') | discovery/googleapis/cloudresourcemanager__v1.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698