| Index: generated/googleapis/lib/clouddebugger/v2.dart
|
| diff --git a/generated/googleapis/lib/clouddebugger/v2.dart b/generated/googleapis/lib/clouddebugger/v2.dart
|
| index 7d765ea58e95b17b3f784c1264a1e7892cfc1244..b0e451106248e971bfe8d380302c87c4c15cdea2 100644
|
| --- a/generated/googleapis/lib/clouddebugger/v2.dart
|
| +++ b/generated/googleapis/lib/clouddebugger/v2.dart
|
| @@ -55,13 +55,16 @@ class ControllerDebuggeesResourceApi {
|
| _requester = client;
|
|
|
| /**
|
| - * 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`.
|
| + * 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`.
|
| *
|
| * [request] - The metadata request object.
|
| *
|
| @@ -109,29 +112,36 @@ class ControllerDebuggeesBreakpointsResourceApi {
|
| _requester = client;
|
|
|
| /**
|
| - * 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.
|
| + * 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.
|
| *
|
| * Request parameters:
|
| *
|
| * [debuggeeId] - Identifies the debuggee.
|
| *
|
| - * [waitToken] - 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.
|
| - *
|
| * [successOnTimeout] - 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).
|
| + * 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).
|
| + *
|
| + * [waitToken] - 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.
|
| *
|
| * Completes with a [ListActiveBreakpointsResponse].
|
| *
|
| @@ -141,7 +151,7 @@ class ControllerDebuggeesBreakpointsResourceApi {
|
| * If the used [http.Client] completes with an error when making a REST call,
|
| * this method will complete with the same error.
|
| */
|
| - async.Future<ListActiveBreakpointsResponse> list(core.String debuggeeId, {core.String waitToken, core.bool successOnTimeout}) {
|
| + async.Future<ListActiveBreakpointsResponse> list(core.String debuggeeId, {core.bool successOnTimeout, core.String waitToken}) {
|
| var _url = null;
|
| var _queryParams = new core.Map();
|
| var _uploadMedia = null;
|
| @@ -152,12 +162,12 @@ class ControllerDebuggeesBreakpointsResourceApi {
|
| if (debuggeeId == null) {
|
| throw new core.ArgumentError("Parameter debuggeeId is required.");
|
| }
|
| - if (waitToken != null) {
|
| - _queryParams["waitToken"] = [waitToken];
|
| - }
|
| if (successOnTimeout != null) {
|
| _queryParams["successOnTimeout"] = ["${successOnTimeout}"];
|
| }
|
| + if (waitToken != null) {
|
| + _queryParams["waitToken"] = [waitToken];
|
| + }
|
|
|
| _url = 'v2/controller/debuggees/' + commons.Escaper.ecapeVariable('$debuggeeId') + '/breakpoints';
|
|
|
| @@ -172,13 +182,15 @@ class ControllerDebuggeesBreakpointsResourceApi {
|
| }
|
|
|
| /**
|
| - * 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.
|
| + * 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.
|
| *
|
| * [request] - The metadata request object.
|
| *
|
| @@ -252,14 +264,15 @@ class DebuggerDebuggeesResourceApi {
|
| *
|
| * Request parameters:
|
| *
|
| + * [includeInactive] - When set to `true`, the result includes all debuggees.
|
| + * Otherwise, the
|
| + * result includes only debuggees that are active.
|
| + *
|
| * [project] - Project number of a Google Cloud project whose debuggees to
|
| * list.
|
| *
|
| - * [includeInactive] - When set to `true`, the result includes all debuggees.
|
| - * Otherwise, the result includes only debuggees that are active.
|
| - *
|
| - * [clientVersion] - The client version making the call. Following:
|
| - * `domain/type/version` (e.g., `google.com/intellij/v1`).
|
| + * [clientVersion] - The client version making the call.
|
| + * Following: `domain/type/version` (e.g., `google.com/intellij/v1`).
|
| *
|
| * Completes with a [ListDebuggeesResponse].
|
| *
|
| @@ -269,7 +282,7 @@ class DebuggerDebuggeesResourceApi {
|
| * If the used [http.Client] completes with an error when making a REST call,
|
| * this method will complete with the same error.
|
| */
|
| - async.Future<ListDebuggeesResponse> list({core.String project, core.bool includeInactive, core.String clientVersion}) {
|
| + async.Future<ListDebuggeesResponse> list({core.bool includeInactive, core.String project, core.String clientVersion}) {
|
| var _url = null;
|
| var _queryParams = new core.Map();
|
| var _uploadMedia = null;
|
| @@ -277,12 +290,12 @@ class DebuggerDebuggeesResourceApi {
|
| var _downloadOptions = commons.DownloadOptions.Metadata;
|
| var _body = null;
|
|
|
| - if (project != null) {
|
| - _queryParams["project"] = [project];
|
| - }
|
| if (includeInactive != null) {
|
| _queryParams["includeInactive"] = ["${includeInactive}"];
|
| }
|
| + if (project != null) {
|
| + _queryParams["project"] = [project];
|
| + }
|
| if (clientVersion != null) {
|
| _queryParams["clientVersion"] = [clientVersion];
|
| }
|
| @@ -317,8 +330,8 @@ class DebuggerDebuggeesBreakpointsResourceApi {
|
| *
|
| * [breakpointId] - ID of the breakpoint to delete.
|
| *
|
| - * [clientVersion] - The client version making the call. Following:
|
| - * `domain/type/version` (e.g., `google.com/intellij/v1`).
|
| + * [clientVersion] - The client version making the call.
|
| + * Following: `domain/type/version` (e.g., `google.com/intellij/v1`).
|
| *
|
| * Completes with a [Empty].
|
| *
|
| @@ -367,8 +380,8 @@ class DebuggerDebuggeesBreakpointsResourceApi {
|
| *
|
| * [breakpointId] - ID of the breakpoint to get.
|
| *
|
| - * [clientVersion] - The client version making the call. Following:
|
| - * `domain/type/version` (e.g., `google.com/intellij/v1`).
|
| + * [clientVersion] - The client version making the call.
|
| + * Following: `domain/type/version` (e.g., `google.com/intellij/v1`).
|
| *
|
| * Completes with a [GetBreakpointResponse].
|
| *
|
| @@ -415,12 +428,16 @@ class DebuggerDebuggeesBreakpointsResourceApi {
|
| *
|
| * [debuggeeId] - ID of the debuggee whose breakpoints to list.
|
| *
|
| + * [clientVersion] - The client version making the call.
|
| + * Following: `domain/type/version` (e.g., `google.com/intellij/v1`).
|
| + *
|
| * [includeAllUsers] - When set to `true`, the response includes the list of
|
| - * breakpoints set by any user. Otherwise, it includes only breakpoints set by
|
| - * the caller.
|
| + * breakpoints set by
|
| + * any user. Otherwise, it includes only breakpoints set by the caller.
|
| *
|
| - * [includeInactive] - When set to `true`, the response includes active and
|
| - * inactive breakpoints. Otherwise, it includes only active breakpoints.
|
| + * [stripResults] - This field is deprecated. The following fields are always
|
| + * stripped out of
|
| + * the result: `stack_frames`, `evaluated_expressions` and `variable_table`.
|
| *
|
| * [action_value] - Only breakpoints with the specified action will pass the
|
| * filter.
|
| @@ -428,18 +445,16 @@ class DebuggerDebuggeesBreakpointsResourceApi {
|
| * - "CAPTURE" : A CAPTURE.
|
| * - "LOG" : A LOG.
|
| *
|
| - * [stripResults] - When set to `true`, the response breakpoints are stripped
|
| - * of the results fields: `stack_frames`, `evaluated_expressions` and
|
| - * `variable_table`.
|
| + * [includeInactive] - When set to `true`, the response includes active and
|
| + * inactive
|
| + * breakpoints. Otherwise, it includes only active breakpoints.
|
| *
|
| * [waitToken] - 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`.
|
| - *
|
| - * [clientVersion] - The client version making the call. Following:
|
| - * `domain/type/version` (e.g., `google.com/intellij/v1`).
|
| + * 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`.
|
| *
|
| * Completes with a [ListBreakpointsResponse].
|
| *
|
| @@ -449,7 +464,7 @@ class DebuggerDebuggeesBreakpointsResourceApi {
|
| * If the used [http.Client] completes with an error when making a REST call,
|
| * this method will complete with the same error.
|
| */
|
| - async.Future<ListBreakpointsResponse> list(core.String debuggeeId, {core.bool includeAllUsers, core.bool includeInactive, core.String action_value, core.bool stripResults, core.String waitToken, core.String clientVersion}) {
|
| + async.Future<ListBreakpointsResponse> list(core.String debuggeeId, {core.String clientVersion, core.bool includeAllUsers, core.bool stripResults, core.String action_value, core.bool includeInactive, core.String waitToken}) {
|
| var _url = null;
|
| var _queryParams = new core.Map();
|
| var _uploadMedia = null;
|
| @@ -460,24 +475,24 @@ class DebuggerDebuggeesBreakpointsResourceApi {
|
| if (debuggeeId == null) {
|
| throw new core.ArgumentError("Parameter debuggeeId is required.");
|
| }
|
| + if (clientVersion != null) {
|
| + _queryParams["clientVersion"] = [clientVersion];
|
| + }
|
| if (includeAllUsers != null) {
|
| _queryParams["includeAllUsers"] = ["${includeAllUsers}"];
|
| }
|
| - if (includeInactive != null) {
|
| - _queryParams["includeInactive"] = ["${includeInactive}"];
|
| + if (stripResults != null) {
|
| + _queryParams["stripResults"] = ["${stripResults}"];
|
| }
|
| if (action_value != null) {
|
| _queryParams["action.value"] = [action_value];
|
| }
|
| - if (stripResults != null) {
|
| - _queryParams["stripResults"] = ["${stripResults}"];
|
| + if (includeInactive != null) {
|
| + _queryParams["includeInactive"] = ["${includeInactive}"];
|
| }
|
| if (waitToken != null) {
|
| _queryParams["waitToken"] = [waitToken];
|
| }
|
| - if (clientVersion != null) {
|
| - _queryParams["clientVersion"] = [clientVersion];
|
| - }
|
|
|
| _url = 'v2/debugger/debuggees/' + commons.Escaper.ecapeVariable('$debuggeeId') + '/breakpoints';
|
|
|
| @@ -500,8 +515,8 @@ class DebuggerDebuggeesBreakpointsResourceApi {
|
| *
|
| * [debuggeeId] - ID of the debuggee where the breakpoint is to be set.
|
| *
|
| - * [clientVersion] - The client version making the call. Following:
|
| - * `domain/type/version` (e.g., `google.com/intellij/v1`).
|
| + * [clientVersion] - The client version making the call.
|
| + * Following: `domain/type/version` (e.g., `google.com/intellij/v1`).
|
| *
|
| * Completes with a [SetBreakpointResponse].
|
| *
|
| @@ -550,10 +565,13 @@ class AliasContext {
|
| /**
|
| * The alias kind.
|
| * Possible string values are:
|
| - * - "ANY" : A ANY.
|
| - * - "FIXED" : A FIXED.
|
| - * - "MOVABLE" : A MOVABLE.
|
| - * - "OTHER" : A OTHER.
|
| + * - "ANY" : Do not use.
|
| + * - "FIXED" : Git tag
|
| + * - "MOVABLE" : Git branch
|
| + * - "OTHER" : OTHER is used to specify non-standard aliases, those not of the
|
| + * kinds
|
| + * above. For example, if a Git repo has a ref named "refs/foo/bar", it
|
| + * is considered to be of kind OTHER.
|
| */
|
| core.String kind;
|
| /** The alias name. */
|
| @@ -585,34 +603,38 @@ class AliasContext {
|
| /** Represents the breakpoint specification, status and results. */
|
| class Breakpoint {
|
| /**
|
| - * Action that the agent should perform when the code at the breakpoint
|
| - * location is hit.
|
| + * Action that the agent should perform when the code at the
|
| + * breakpoint location is hit.
|
| * Possible string values are:
|
| - * - "CAPTURE" : A CAPTURE.
|
| - * - "LOG" : A LOG.
|
| + * - "CAPTURE" : Capture stack frame and variables and update the breakpoint.
|
| + * The data is only captured once. After that the breakpoint is set
|
| + * in a final state.
|
| + * - "LOG" : Log each breakpoint hit. The breakpoint remains active until
|
| + * deleted or expired.
|
| */
|
| core.String action;
|
| /**
|
| - * Condition that triggers the breakpoint. The condition is a compound boolean
|
| - * expression composed using expressions in a programming language at the
|
| - * source location.
|
| + * Condition that triggers the breakpoint.
|
| + * The condition is a compound boolean expression composed using expressions
|
| + * in a programming language at the source location.
|
| */
|
| core.String condition;
|
| /** Time this breakpoint was created by the server in seconds resolution. */
|
| core.String createTime;
|
| /**
|
| - * 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.
|
| + * 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.
|
| */
|
| core.List<Variable> evaluatedExpressions;
|
| /**
|
| - * 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
|
| + * 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.
|
| */
|
| core.List<core.String> expressions;
|
| @@ -624,8 +646,8 @@ class Breakpoint {
|
| /** Breakpoint identifier, unique in the scope of the debuggee. */
|
| core.String id;
|
| /**
|
| - * When true, indicates that this is a final result and the breakpoint state
|
| - * will not change from here on.
|
| + * When true, indicates that this is a final result and the
|
| + * breakpoint state will not change from here on.
|
| */
|
| core.bool isFinalState;
|
| /**
|
| @@ -638,45 +660,57 @@ class Breakpoint {
|
| /**
|
| * Indicates the severity of the log. Only relevant when action is `LOG`.
|
| * Possible string values are:
|
| - * - "INFO" : A INFO.
|
| - * - "WARNING" : A WARNING.
|
| - * - "ERROR" : A ERROR.
|
| + * - "INFO" : Information log message.
|
| + * - "WARNING" : Warning log message.
|
| + * - "ERROR" : Error log message.
|
| */
|
| core.String logLevel;
|
| /**
|
| - * 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
|
| + * 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 ]`.
|
| */
|
| core.String logMessageFormat;
|
| /** The stack at breakpoint time. */
|
| core.List<StackFrame> stackFrames;
|
| /**
|
| - * Breakpoint status. The status includes an error flag and a human readable
|
| - * message. This field is usually unset. The message can be either
|
| + * 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
|
| + * 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
|
| */
|
| StatusMessage status;
|
| /** E-mail address of the user that created this breakpoint */
|
| core.String userEmail;
|
| /**
|
| * 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.
|
| + * 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.
|
| */
|
| core.List<Variable> variableTable;
|
|
|
| @@ -788,8 +822,8 @@ class Breakpoint {
|
| }
|
|
|
| /**
|
| - * A CloudRepoSourceContext denotes a particular revision in a cloud repo (a
|
| - * repo hosted by the Google Cloud Platform).
|
| + * A CloudRepoSourceContext denotes a particular revision in a cloud
|
| + * repo (a repo hosted by the Google Cloud Platform).
|
| */
|
| class CloudRepoSourceContext {
|
| /** An alias, which may be a branch or tag. */
|
| @@ -837,14 +871,14 @@ class CloudRepoSourceContext {
|
| }
|
|
|
| /**
|
| - * 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 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.
|
| */
|
| class CloudWorkspaceId {
|
| /**
|
| - * The unique name of the workspace within the repo. This is the name chosen
|
| - * by the client in the Source API's CreateWorkspace method.
|
| + * The unique name of the workspace within the repo. This is the name
|
| + * chosen by the client in the Source API's CreateWorkspace method.
|
| */
|
| core.String name;
|
| /** The ID of the repo containing the workspace. */
|
| @@ -878,8 +912,8 @@ class CloudWorkspaceId {
|
| */
|
| class CloudWorkspaceSourceContext {
|
| /**
|
| - * The ID of the snapshot. An empty snapshot_id refers to the most recent
|
| - * snapshot.
|
| + * The ID of the snapshot.
|
| + * An empty snapshot_id refers to the most recent snapshot.
|
| */
|
| core.String snapshotId;
|
| /** The ID of the workspace. */
|
| @@ -911,26 +945,30 @@ class CloudWorkspaceSourceContext {
|
| /**
|
| * 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.
|
| + * 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.
|
| */
|
| class Debuggee {
|
| /**
|
| - * 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`).
|
| + * 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`).
|
| */
|
| core.String agentVersion;
|
| /**
|
| - * Human readable description of the debuggee. Including a human-readable
|
| - * project name, environment name and version information is recommended.
|
| + * Human readable description of the debuggee.
|
| + * Including a human-readable project name, environment name and version
|
| + * information is recommended.
|
| */
|
| core.String 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`.
|
| + * 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`.
|
| */
|
| core.List<ExtendedSourceContext> extSourceContexts;
|
| /**
|
| @@ -938,8 +976,8 @@ class Debuggee {
|
| */
|
| core.String id;
|
| /**
|
| - * If set to `true`, indicates that the agent should disable itself and detach
|
| - * from the debuggee.
|
| + * If set to `true`, indicates that the agent should disable itself and
|
| + * detach from the debuggee.
|
| */
|
| core.bool isDisabled;
|
| /**
|
| @@ -953,15 +991,17 @@ class Debuggee {
|
| */
|
| core.Map<core.String, core.String> labels;
|
| /**
|
| - * Project the debuggee is associated with. Use the project number when
|
| - * registering a Google Cloud Platform project.
|
| + * Project the debuggee is associated with.
|
| + * Use the project number when registering a Google Cloud Platform project.
|
| */
|
| core.String project;
|
| /**
|
| * 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`.
|
| + * 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`.
|
| */
|
| core.List<SourceContext> sourceContexts;
|
| /**
|
| @@ -971,9 +1011,9 @@ class Debuggee {
|
| */
|
| StatusMessage status;
|
| /**
|
| - * 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.
|
| + * 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.
|
| */
|
| core.String uniquifier;
|
|
|
| @@ -1056,10 +1096,14 @@ class Debuggee {
|
|
|
| /**
|
| * 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 `{}`.
|
| + * 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 `{}`.
|
| */
|
| class Empty {
|
|
|
| @@ -1075,8 +1119,8 @@ class Empty {
|
| }
|
|
|
| /**
|
| - * An ExtendedSourceContext is a SourceContext combined with additional details
|
| - * describing the context.
|
| + * An ExtendedSourceContext is a SourceContext combined with additional
|
| + * details describing the context.
|
| */
|
| class ExtendedSourceContext {
|
| /** Any source context. */
|
| @@ -1110,11 +1154,15 @@ class ExtendedSourceContext {
|
| /** Represents a message with parameters. */
|
| class FormatMessage {
|
| /**
|
| - * 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.`
|
| + * 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.`
|
| */
|
| core.String format;
|
| /** Optional parameters to be embedded into the message. */
|
| @@ -1151,8 +1199,8 @@ class GerritSourceContext {
|
| core.String aliasName;
|
| /**
|
| * 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.
|
| + * "project/subproject" is a valid project name.
|
| + * The "repo name" is hostURI/project.
|
| */
|
| core.String gerritProject;
|
| /** The URI of a running Gerrit instance. */
|
| @@ -1204,8 +1252,8 @@ class GerritSourceContext {
|
| /** Response for getting breakpoint information. */
|
| class GetBreakpointResponse {
|
| /**
|
| - * Complete breakpoint state. The fields `id` and `location` are guaranteed to
|
| - * be set.
|
| + * Complete breakpoint state.
|
| + * The fields `id` and `location` are guaranteed to be set.
|
| */
|
| Breakpoint breakpoint;
|
|
|
| @@ -1231,7 +1279,10 @@ class GetBreakpointResponse {
|
| * repository (e.g. GitHub).
|
| */
|
| class GitSourceContext {
|
| - /** Git commit hash. required. */
|
| + /**
|
| + * Git commit hash.
|
| + * required.
|
| + */
|
| core.String revisionId;
|
| /** Git repository URL. */
|
| core.String url;
|
| @@ -1262,18 +1313,18 @@ class GitSourceContext {
|
| /** Response for listing active breakpoints. */
|
| class ListActiveBreakpointsResponse {
|
| /**
|
| - * List of all active breakpoints. The fields `id` and `location` are
|
| - * guaranteed to be set on each breakpoint.
|
| + * List of all active breakpoints.
|
| + * The fields `id` and `location` are guaranteed to be set on each breakpoint.
|
| */
|
| core.List<Breakpoint> breakpoints;
|
| /**
|
| - * A wait token that can be used in the next method call to block until the
|
| - * list of breakpoints changes.
|
| + * A wait token that can be used in the next method call to block until
|
| + * the list of breakpoints changes.
|
| */
|
| core.String nextWaitToken;
|
| /**
|
| - * 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.
|
| + * 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.
|
| */
|
| core.bool waitExpired;
|
|
|
| @@ -1309,8 +1360,10 @@ class ListActiveBreakpointsResponse {
|
| /** Response for listing breakpoints. */
|
| class ListBreakpointsResponse {
|
| /**
|
| - * List of all breakpoints with complete state. The fields `id` and `location`
|
| - * are guaranteed to be set on each breakpoint.
|
| + * List of breakpoints matching the request.
|
| + * The fields `id` and `location` are guaranteed to be set on each breakpoint.
|
| + * The fields: `stack_frames`, `evaluated_expressions` and `variable_table`
|
| + * are cleared on each breakpoint regardless of it's status.
|
| */
|
| core.List<Breakpoint> breakpoints;
|
| /**
|
| @@ -1345,10 +1398,11 @@ class ListBreakpointsResponse {
|
| /** Response for listing debuggees. */
|
| class ListDebuggeesResponse {
|
| /**
|
| - * 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.
|
| + * 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.
|
| */
|
| core.List<Debuggee> debuggees;
|
|
|
| @@ -1370,8 +1424,8 @@ class ListDebuggeesResponse {
|
| }
|
|
|
| /**
|
| - * Selects a repo using a Google Cloud Platform project ID (e.g.
|
| - * winged-cargo-31) and a repo name within that project.
|
| + * Selects a repo using a Google Cloud Platform project ID
|
| + * (e.g. winged-cargo-31) and a repo name within that project.
|
| */
|
| class ProjectRepoId {
|
| /** The ID of the project. */
|
| @@ -1405,8 +1459,9 @@ class ProjectRepoId {
|
| /** Request to register a debuggee. */
|
| class RegisterDebuggeeRequest {
|
| /**
|
| - * Debuggee information to register. The fields `project`, `uniquifier`,
|
| - * `description` and `agent_version` of the debuggee must be set.
|
| + * Debuggee information to register.
|
| + * The fields `project`, `uniquifier`, `description` and `agent_version`
|
| + * of the debuggee must be set.
|
| */
|
| Debuggee debuggee;
|
|
|
| @@ -1430,8 +1485,8 @@ class RegisterDebuggeeRequest {
|
| /** Response for registering a debuggee. */
|
| class RegisterDebuggeeResponse {
|
| /**
|
| - * Debuggee resource. The field `id` is guranteed to be set (in addition to
|
| - * the echoed fields).
|
| + * Debuggee resource.
|
| + * The field `id` is guranteed to be set (in addition to the echoed fields).
|
| */
|
| Debuggee debuggee;
|
|
|
| @@ -1485,8 +1540,8 @@ class RepoId {
|
| /** Response for setting a breakpoint. */
|
| class SetBreakpointResponse {
|
| /**
|
| - * Breakpoint resource. The field `id` is guaranteed to be set (in addition to
|
| - * the echoed fileds).
|
| + * Breakpoint resource.
|
| + * The field `id` is guaranteed to be set (in addition to the echoed fileds).
|
| */
|
| Breakpoint breakpoint;
|
|
|
| @@ -1591,15 +1646,15 @@ class SourceLocation {
|
| /** Represents a stack frame context. */
|
| class StackFrame {
|
| /**
|
| - * Set of arguments passed to this function. Note that this might not be
|
| - * populated for all stack frames.
|
| + * Set of arguments passed to this function.
|
| + * Note that this might not be populated for all stack frames.
|
| */
|
| core.List<Variable> arguments;
|
| /** Demangled function name at the call site. */
|
| core.String function;
|
| /**
|
| - * Set of local variables at the stack frame location. Note that this might
|
| - * not be populated for all stack frames.
|
| + * Set of local variables at the stack frame location.
|
| + * Note that this might not be populated for all stack frames.
|
| */
|
| core.List<Variable> locals;
|
| /** Source location of the call site. */
|
| @@ -1641,10 +1696,11 @@ class StackFrame {
|
| }
|
|
|
| /**
|
| - * 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`.
|
| + * 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`.
|
| */
|
| class StatusMessage {
|
| /** Status message text. */
|
| @@ -1654,12 +1710,18 @@ class StatusMessage {
|
| /**
|
| * Reference to which the message applies.
|
| * Possible string values are:
|
| - * - "UNSPECIFIED" : A UNSPECIFIED.
|
| - * - "BREAKPOINT_SOURCE_LOCATION" : A BREAKPOINT_SOURCE_LOCATION.
|
| - * - "BREAKPOINT_CONDITION" : A BREAKPOINT_CONDITION.
|
| - * - "BREAKPOINT_EXPRESSION" : A BREAKPOINT_EXPRESSION.
|
| - * - "VARIABLE_NAME" : A VARIABLE_NAME.
|
| - * - "VARIABLE_VALUE" : A VARIABLE_VALUE.
|
| + * - "UNSPECIFIED" : Status doesn't refer to any particular input.
|
| + * - "BREAKPOINT_SOURCE_LOCATION" : Status applies to the breakpoint and is
|
| + * related to its location.
|
| + * - "BREAKPOINT_CONDITION" : Status applies to the breakpoint and is related
|
| + * to its condition.
|
| + * - "BREAKPOINT_EXPRESSION" : Status applies to the breakpoint and is related
|
| + * to its expressions.
|
| + * - "BREAKPOINT_AGE" : Status applies to the breakpoint and is related to its
|
| + * age.
|
| + * - "VARIABLE_NAME" : Status applies to the entire variable.
|
| + * - "VARIABLE_VALUE" : Status applies to variable value (variable name is
|
| + * valid).
|
| */
|
| core.String refersTo;
|
|
|
| @@ -1694,7 +1756,10 @@ class StatusMessage {
|
|
|
| /** Request to update an active breakpoint. */
|
| class UpdateActiveBreakpointRequest {
|
| - /** Updated breakpoint information. The field 'id' must be set. */
|
| + /**
|
| + * Updated breakpoint information.
|
| + * The field 'id' must be set.
|
| + */
|
| Breakpoint breakpoint;
|
|
|
| UpdateActiveBreakpointRequest();
|
| @@ -1715,8 +1780,8 @@ class UpdateActiveBreakpointRequest {
|
| }
|
|
|
| /**
|
| - * Response for updating an active breakpoint. The message is defined to allow
|
| - * future extensions.
|
| + * Response for updating an active breakpoint.
|
| + * The message is defined to allow future extensions.
|
| */
|
| class UpdateActiveBreakpointResponse {
|
|
|
| @@ -1732,40 +1797,115 @@ class UpdateActiveBreakpointResponse {
|
| }
|
|
|
| /**
|
| - * 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 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.
|
| + * 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 = &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.
|
| */
|
| class Variable {
|
| /** Members contained or pointed to by the variable. */
|
| @@ -1773,31 +1913,39 @@ class Variable {
|
| /** Name of the variable, if any. */
|
| core.String name;
|
| /**
|
| - * 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`
|
| + * 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`
|
| */
|
| StatusMessage status;
|
| /**
|
| * 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
|
| + * `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.
|
| */
|
| core.String type;
|
| /** Simple value of the variable. */
|
| core.String value;
|
| /**
|
| - * Reference to a variable in the shared variable table. More than one
|
| - * variable can reference the same variable in the table. The
|
| + * 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.
|
| */
|
| core.int varTableIndex;
|
|
|