Regen all docs. (#700)
* Stop recursing if discovery == {}
* Generate docs with 'make docs'.
diff --git a/docs/dyn/clouddebugger_v2.controller.debuggees.breakpoints.html b/docs/dyn/clouddebugger_v2.controller.debuggees.breakpoints.html
index 641c2cc..56ecd66 100644
--- a/docs/dyn/clouddebugger_v2.controller.debuggees.breakpoints.html
+++ b/docs/dyn/clouddebugger_v2.controller.debuggees.breakpoints.html
@@ -75,17 +75,17 @@
<h1><a href="clouddebugger_v2.html">Stackdriver Debugger API</a> . <a href="clouddebugger_v2.controller.html">controller</a> . <a href="clouddebugger_v2.controller.debuggees.html">debuggees</a> . <a href="clouddebugger_v2.controller.debuggees.breakpoints.html">breakpoints</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#list">list(debuggeeId, successOnTimeout=None, waitToken=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(debuggeeId, waitToken=None, successOnTimeout=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns the list of all active breakpoints for the debuggee.</p>
<p class="toc_element">
<code><a href="#update">update(debuggeeId, id, body, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the breakpoint state or mutable fields.</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="list">list(debuggeeId, successOnTimeout=None, waitToken=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(debuggeeId, waitToken=None, successOnTimeout=None, x__xgafv=None)</code>
<pre>Returns the list of all active breakpoints for the debuggee.
-The breakpoint specification (location, condition, and expression
+The breakpoint specification (`location`, `condition`, and `expressions`
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
@@ -99,15 +99,16 @@
Args:
debuggeeId: string, Identifies the debuggee. (required)
- successOnTimeout: boolean, 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).
+ waitToken: string, A 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 `next_wait_token` field in
+the last response. The initial value should be set to `"init"`.
+ successOnTimeout: boolean, If set to `true` (recommended), returns `google.rpc.Code.OK` status and
+sets the `wait_expired` response field to `true` when the server-selected
+timeout has expired.
-If set to `false`, returns `google.rpc.Code.ABORTED` status when the
-server-selected timeout has expired (deprecated).
- waitToken: string, 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.
+If set to `false` (deprecated), returns `google.rpc.Code.ABORTED` status
+when the server-selected timeout has expired.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -117,9 +118,10 @@
An object of the form:
{ # Response for listing active breakpoints.
- "waitExpired": True or False, # 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.
- "nextWaitToken": "A String", # A wait token that can be used in the next method call to block until
+ "waitExpired": True or False, # If set to `true`, indicates that there is no change to the
+ # list of active breakpoints and the server-selected timeout has expired.
+ # The `breakpoints` field would be empty and should be ignored.
+ "nextWaitToken": "A String", # A token that can be used in the next method call to block until
# the list of breakpoints changes.
"breakpoints": [ # List of all active breakpoints.
# The fields `id` and `location` are guaranteed to be set on each breakpoint.
@@ -336,12 +338,21 @@
},
],
"userEmail": "A String", # E-mail address of the user that created this breakpoint
+ "logMessageFormat": "A String", # 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 ]`.
"logLevel": "A String", # Indicates the severity of the log. Only relevant when action is `LOG`.
"labels": { # A set of custom breakpoint properties, populated by the agent, to be
# displayed to the user.
"a_key": "A String",
},
- "stackFrames": [ # The stack at breakpoint time.
+ "stackFrames": [ # The stack at breakpoint time, where stack_frames[0] represents the most
+ # recently entered function.
{ # Represents a stack frame context.
"function": "A String", # Demangled function name at the call site.
"arguments": [ # Set of arguments passed to this function.
@@ -675,19 +686,19 @@
},
],
"location": { # Represents a location in the source code. # Source location of the call site.
+ "column": 42, # Column within a line. The first column in a line as the value `1`.
+ # Agents that do not support setting breakpoints on specific columns ignore
+ # this field.
"path": "A String", # Path to the source file within the source context of the target binary.
"line": 42, # Line inside the file. The first line in the file has the value `1`.
},
},
],
"createTime": "A String", # Time this breakpoint was created by the server in seconds resolution.
- "expressions": [ # 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.
- "A String",
- ],
"location": { # Represents a location in the source code. # Breakpoint source location.
+ "column": 42, # Column within a line. The first column in a line as the value `1`.
+ # Agents that do not support setting breakpoints on specific columns ignore
+ # this field.
"path": "A String", # Path to the source file within the source context of the target binary.
"line": 42, # Line inside the file. The first line in the file has the value `1`.
},
@@ -695,14 +706,12 @@
# resolution.
"action": "A String", # Action that the agent should perform when the code at the
# breakpoint location is hit.
- "logMessageFormat": "A String", # 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 ]`.
+ "expressions": [ # 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.
+ "A String",
+ ],
"isFinalState": True or False, # When true, indicates that this is a final result and the
# breakpoint state will not change from here on.
"evaluatedExpressions": [ # Values of evaluated expressions at breakpoint time.
@@ -887,12 +896,11 @@
<div class="method">
<code class="details" id="update">update(debuggeeId, id, body, x__xgafv=None)</code>
<pre>Updates the breakpoint state or mutable fields.
-The entire Breakpoint message must be sent back to the controller
-service.
+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
+`condition` and `expressions` 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.
@@ -904,7 +912,8 @@
{ # Request to update an active breakpoint.
"breakpoint": { # Represents the breakpoint specification, status and results. # Updated breakpoint information.
- # The field 'id' must be set.
+ # The field `id` must be set.
+ # The agent must echo all Breakpoint specification fields in the update.
"status": { # Represents a contextual status message. # Breakpoint status.
#
# The status includes an error flag and a human readable message.
@@ -1117,12 +1126,21 @@
},
],
"userEmail": "A String", # E-mail address of the user that created this breakpoint
+ "logMessageFormat": "A String", # 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 ]`.
"logLevel": "A String", # Indicates the severity of the log. Only relevant when action is `LOG`.
"labels": { # A set of custom breakpoint properties, populated by the agent, to be
# displayed to the user.
"a_key": "A String",
},
- "stackFrames": [ # The stack at breakpoint time.
+ "stackFrames": [ # The stack at breakpoint time, where stack_frames[0] represents the most
+ # recently entered function.
{ # Represents a stack frame context.
"function": "A String", # Demangled function name at the call site.
"arguments": [ # Set of arguments passed to this function.
@@ -1456,19 +1474,19 @@
},
],
"location": { # Represents a location in the source code. # Source location of the call site.
+ "column": 42, # Column within a line. The first column in a line as the value `1`.
+ # Agents that do not support setting breakpoints on specific columns ignore
+ # this field.
"path": "A String", # Path to the source file within the source context of the target binary.
"line": 42, # Line inside the file. The first line in the file has the value `1`.
},
},
],
"createTime": "A String", # Time this breakpoint was created by the server in seconds resolution.
- "expressions": [ # 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.
- "A String",
- ],
"location": { # Represents a location in the source code. # Breakpoint source location.
+ "column": 42, # Column within a line. The first column in a line as the value `1`.
+ # Agents that do not support setting breakpoints on specific columns ignore
+ # this field.
"path": "A String", # Path to the source file within the source context of the target binary.
"line": 42, # Line inside the file. The first line in the file has the value `1`.
},
@@ -1476,14 +1494,12 @@
# resolution.
"action": "A String", # Action that the agent should perform when the code at the
# breakpoint location is hit.
- "logMessageFormat": "A String", # 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 ]`.
+ "expressions": [ # 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.
+ "A String",
+ ],
"isFinalState": True or False, # When true, indicates that this is a final result and the
# breakpoint state will not change from here on.
"evaluatedExpressions": [ # Values of evaluated expressions at breakpoint time.