OMGeeky/google-apis-rs
1
0
Fork 0
mirror of https://github.com/OMGeeky/google-apis-rs.git synced 2026-01-25 12:44:07 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
a20241b2412723b0062d1c19a8ec792837b145a4
google-apis-rs/google_clouddebugger2_cli/controller_debuggees-breakpoints-update/index.html
Sebastian Thiel a20241b241 Update documentation
2022-03-08 15:36:16 +08:00

432 lines
16 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Debuggees Breakpoints Update - Cloud Debugger v3.0.0+20220225</title>
<link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
<link rel="stylesheet" href="../css/theme.css" type="text/css" />
<link rel="stylesheet" href="../css/theme_extra.css" type="text/css" />
<link rel="stylesheet" href="../css/highlight.css">
<script src="//cdnjs.cloudflare.com/ajax/libs/jquery/2.1.1/jquery.min.js"></script>
<script src="//cdnjs.cloudflare.com/ajax/libs/modernizr/2.8.3/modernizr.min.js"></script>
<script type="text/javascript" src="../js/highlight.pack.js"></script>
<script src="../js/theme.js"></script>
<style>
body {font-size: 90%;}
pre, code {font-size: 100%;}
h3, h4, h5, h6 {color: #2980b9; font-weight: 300}
</style>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-nav-search">
<a href=".." class="icon icon-home"> Cloud Debugger v3.0.0+20220225</a>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<span>Controller</span>
<li class="toctree-l1 ">
<a class="" href="../controller_debuggees-breakpoints-list">Debuggees Breakpoints List</a>
</li>
<li class="toctree-l1 current">
<a class="current" href=".">Debuggees Breakpoints Update</a>
<ul>
<li class="toctree-l2"><a href="#scopes">Scopes</a></li>
<li class="toctree-l2"><a href="#required-scalar-arguments">Required Scalar Arguments</a></li>
<li class="toctree-l2"><a href="#required-request-value">Required Request Value</a></li>
<li><a class="toctree-l3" href="#about-cursors">About Cursors</a></li>
<li class="toctree-l2"><a href="#optional-output-flags">Optional Output Flags</a></li>
<li class="toctree-l2"><a href="#optional-general-properties">Optional General Properties</a></li>
</ul>
</li>
<li class="toctree-l1 ">
<a class="" href="../controller_debuggees-register">Debuggees Register</a>
</li>
<span>Debugger</span>
<li class="toctree-l1 ">
<a class="" href="../debugger_debuggees-breakpoints-delete">Debuggees Breakpoints Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../debugger_debuggees-breakpoints-get">Debuggees Breakpoints Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../debugger_debuggees-breakpoints-list">Debuggees Breakpoints List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../debugger_debuggees-breakpoints-set">Debuggees Breakpoints Set</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../debugger_debuggees-list">Debuggees List</a>
</li>
</ul>
</div>
&nbsp;
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="icon icon-reorder"></i>
<a href=".."></a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="..">Docs</a> &raquo;</li>
<li>Debuggees Breakpoints Update</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/clouddebugger2-cli" class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main">
<div class="section">
<p>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 <code>location</code>, <code>condition</code> and <code>expressions</code> 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.</p>
<h1 id="scopes">Scopes</h1>
<p>You will need authorization for at least one of the following scopes to make a valid call:</p>
<ul>
<li><em>https://www.googleapis.com/auth/cloud-platform</em></li>
<li><em>https://www.googleapis.com/auth/cloud_debugger</em></li>
</ul>
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/cloud-platform</em>.
You can set the scope for this method like this: <code>clouddebugger2 --scope &lt;scope&gt; controller debuggees-breakpoints-update ...</code></p>
<h1 id="required-scalar-arguments">Required Scalar Arguments</h1>
<ul>
<li><strong>&lt;debuggee-id&gt;</strong> <em>(string)</em><ul>
<li>Required. Identifies the debuggee being debugged.</li>
</ul>
</li>
<li><strong>&lt;id&gt;</strong> <em>(string)</em><ul>
<li>Breakpoint identifier, unique in the scope of the debuggee.</li>
</ul>
</li>
</ul>
<h1 id="required-request-value">Required Request Value</h1>
<p>The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure.
In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.</p>
<p>For example, a structure like this:</p>
<pre><code>UpdateActiveBreakpointRequest:
breakpoint:
action: string
canary-expire-time: string
condition: string
create-time: string
expressions: [string]
final-time: string
id: string
is-final-state: boolean
labels: { string: string }
location:
column: integer
line: integer
path: string
log-level: string
log-message-format: string
state: string
status:
description:
format: string
parameters: [string]
is-error: boolean
refers-to: string
user-email: string
</code></pre>
<p>can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.</p>
<ul>
<li><code>-r .breakpoint action=et</code><ul>
<li>Action that the agent should perform when the code at the breakpoint location is hit.</li>
</ul>
</li>
<li><code>canary-expire-time=magna</code><ul>
<li>The deadline for the breakpoint to stay in CANARY_ACTIVE state. The value is meaningless when the breakpoint is not in CANARY_ACTIVE state.</li>
</ul>
</li>
<li><code>condition=no</code><ul>
<li>Condition that triggers the breakpoint. The condition is a compound boolean expression composed using expressions in a programming language at the source location.</li>
</ul>
</li>
<li><code>create-time=ipsum</code><ul>
<li>Time this breakpoint was created by the server in seconds resolution.</li>
</ul>
</li>
<li><code>expressions=voluptua.</code><ul>
<li>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 <code>LOG</code>, the evaluated expressions are included in log statements.</li>
<li>Each invocation of this argument appends the given value to the array.</li>
</ul>
</li>
<li><code>final-time=at</code><ul>
<li>Time this breakpoint was finalized as seen by the server in seconds resolution.</li>
</ul>
</li>
<li><code>id=sanctus</code><ul>
<li>Breakpoint identifier, unique in the scope of the debuggee.</li>
</ul>
</li>
<li><code>is-final-state=false</code><ul>
<li>When true, indicates that this is a final result and the breakpoint state will not change from here on.</li>
</ul>
</li>
<li><code>labels=key=amet.</code><ul>
<li>A set of custom breakpoint properties, populated by the agent, to be displayed to the user.</li>
<li>the value will be associated with the given <code>key</code></li>
</ul>
</li>
<li><code>location column=42</code><ul>
<li>Column within a line. The first column in a line as the value <code>1</code>. Agents that do not support setting breakpoints on specific columns ignore this field.</li>
</ul>
</li>
<li><code>line=49</code><ul>
<li>Line inside the file. The first line in the file has the value <code>1</code>.</li>
</ul>
</li>
<li>
<p><code>path=duo</code></p>
<ul>
<li>Path to the source file within the source context of the target binary.</li>
</ul>
</li>
<li>
<p><code>.. log-level=ipsum</code></p>
<ul>
<li>Indicates the severity of the log. Only relevant when action is <code>LOG</code>.</li>
</ul>
</li>
<li><code>log-message-format=gubergren</code><ul>
<li>Only relevant when action is <code>LOG</code>. Defines the message to log when the breakpoint hits. The message may include parameter placeholders <code>$0</code>, <code>$1</code>, etc. These placeholders are replaced with the evaluated value of the appropriate expression. Expressions not referenced in <code>log_message_format</code> are not logged. Example: <code>Message received, id = $0, count = $1</code> with <code>expressions</code> = <code>[ message.id, message.count ]</code>.</li>
</ul>
</li>
<li><code>state=lorem</code><ul>
<li>The current state of the breakpoint.</li>
</ul>
</li>
<li><code>status.description format=gubergren</code><ul>
<li>Format template for the message. The <code>format</code> uses placeholders <code>$0</code>, <code>$1</code>, etc. to reference parameters. <code>$$</code> can be used to denote the <code>$</code> character. Examples: * <code>Failed to load &amp;#39;$0&amp;#39; which helps debug $1 the first time it is loaded. Again, $0 is very important.</code> * <code>Please pay $$10 to use $0 instead of $1.</code></li>
</ul>
</li>
<li>
<p><code>parameters=eos</code></p>
<ul>
<li>Optional parameters to be embedded into the message.</li>
<li>Each invocation of this argument appends the given value to the array.</li>
</ul>
</li>
<li>
<p><code>.. is-error=true</code></p>
<ul>
<li>Distinguishes errors from informational messages.</li>
</ul>
</li>
<li>
<p><code>refers-to=invidunt</code></p>
<ul>
<li>Reference to which the message applies.</li>
</ul>
</li>
<li>
<p><code>.. user-email=amet</code></p>
<ul>
<li>E-mail address of the user that created this breakpoint</li>
</ul>
</li>
</ul>
<h3 id="about-cursors">About Cursors</h3>
<p>The cursor position is key to comfortably set complex nested structures. The following rules apply:</p>
<ul>
<li>The cursor position is always set relative to the current one, unless the field name starts with the <code>.</code> character. Fields can be nested such as in <code>-r f.s.o</code> .</li>
<li>The cursor position is set relative to the top-level structure if it starts with <code>.</code>, e.g. <code>-r .s.s</code></li>
<li>You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify <code>-r struct.sub_struct=bar</code>.</li>
<li>You can move the cursor one level up by using <code>..</code>. Each additional <code>.</code> moves it up one additional level. E.g. <code>...</code> would go three levels up.</li>
</ul>
<h1 id="optional-output-flags">Optional Output Flags</h1>
<p>The method's return value a JSON encoded structure, which will be written to standard output by default.</p>
<ul>
<li><strong>-o out</strong><ul>
<li><em>out</em> specifies the <em>destination</em> to which to write the server's result to.
It will be a JSON-encoded structure.
The <em>destination</em> may be <code>-</code> to indicate standard output, or a filepath that is to contain the received bytes.
If unset, it defaults to standard output.</li>
</ul>
</li>
</ul>
<h1 id="optional-general-properties">Optional General Properties</h1>
<p>The following properties can configure any call, and are not specific to this method.</p>
<ul>
<li>
<p><strong>-p $-xgafv=string</strong></p>
<ul>
<li>V1 error format.</li>
</ul>
</li>
<li>
<p><strong>-p access-token=string</strong></p>
<ul>
<li>OAuth access token.</li>
</ul>
</li>
<li>
<p><strong>-p alt=string</strong></p>
<ul>
<li>Data format for response.</li>
</ul>
</li>
<li>
<p><strong>-p callback=string</strong></p>
<ul>
<li>JSONP</li>
</ul>
</li>
<li>
<p><strong>-p fields=string</strong></p>
<ul>
<li>Selector specifying which fields to include in a partial response.</li>
</ul>
</li>
<li>
<p><strong>-p key=string</strong></p>
<ul>
<li>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.</li>
</ul>
</li>
<li>
<p><strong>-p oauth-token=string</strong></p>
<ul>
<li>OAuth 2.0 token for the current user.</li>
</ul>
</li>
<li>
<p><strong>-p pretty-print=boolean</strong></p>
<ul>
<li>Returns response with indentations and line breaks.</li>
</ul>
</li>
<li>
<p><strong>-p quota-user=string</strong></p>
<ul>
<li>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.</li>
</ul>
</li>
<li>
<p><strong>-p upload-type=string</strong></p>
<ul>
<li>Legacy upload protocol for media (e.g. &#34;media&#34;, &#34;multipart&#34;).</li>
</ul>
</li>
<li>
<p><strong>-p upload-protocol=string</strong></p>
<ul>
<li>Upload protocol for media (e.g. &#34;raw&#34;, &#34;multipart&#34;).</li>
</ul>
</li>
</ul>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../controller_debuggees-register" class="btn btn-neutral float-right" title="Debuggees Register"/>Next <span class="icon icon-circle-arrow-right"></span></a>
<a href="../controller_debuggees-breakpoints-list" class="btn btn-neutral" title="Debuggees Breakpoints List"><span class="icon icon-circle-arrow-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
<!-- Copyright etc -->
</p>
</div>
Built with <a href="http://www.mkdocs.org">MkDocs</a>, using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" role="note" style="cursor: pointer">
<span class="rst-current-version" data-toggle="rst-current-version">
<a class="icon icon-github" style="float: left; color: #fcfcfc"> GitHub</a>
<span><a href="../controller_debuggees-breakpoints-list" style="color: #fcfcfc;">&laquo; Previous</a></span>
<span style="margin-left: 15px"><a href="../controller_debuggees-register" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink