mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-27 04:10:02 +01:00
389 lines
16 KiB
HTML
389 lines
16 KiB
HTML
<!DOCTYPE html>
|
|
<html class="writer-html5" lang="en" >
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><link rel="canonical" href="http://byron.github.io/google-apis-rs/google-remotebuildexecution2-cli/action-results_update/" />
|
|
<link rel="shortcut icon" href="../img/favicon.ico" />
|
|
<title>Update - Remote Build Execution v5.0.4+20210329</title>
|
|
<link rel="stylesheet" href="../css/theme.css" />
|
|
<link rel="stylesheet" href="../css/theme_extra.css" />
|
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
|
|
|
|
<script>
|
|
// Current page data
|
|
var mkdocs_page_name = "Update";
|
|
var mkdocs_page_input_path = "action-results_update.md";
|
|
var mkdocs_page_url = "/google-apis-rs/google-remotebuildexecution2-cli/action-results_update/";
|
|
</script>
|
|
|
|
<script src="../js/jquery-3.6.0.min.js" defer></script>
|
|
<!--[if lt IE 9]>
|
|
<script src="../js/html5shiv.min.js"></script>
|
|
<![endif]-->
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
|
|
<script>hljs.initHighlightingOnLoad();</script>
|
|
</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-scroll">
|
|
<div class="wy-side-nav-search">
|
|
<a href=".." class="icon icon-home"> Remote Build Execution v5.0.4+20210329
|
|
</a><div role="search">
|
|
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
|
|
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
|
|
</form>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="..">Home</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Action Results</span></p>
|
|
<ul class="current">
|
|
<li class="toctree-l1"><a class="reference internal" href="../action-results_get/">Get</a>
|
|
</li>
|
|
<li class="toctree-l1 current"><a class="reference internal current" href="./">Update</a>
|
|
<ul class="current">
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Actions</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../actions_execute/">Execute</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Blobs</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../blobs_batch-read/">Batch Read</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../blobs_batch-update/">Batch Update</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../blobs_find-missing/">Find Missing</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../blobs_get-tree/">Get Tree</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Methods</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../methods_get-capabilities/">Get Capabilities</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Operations</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../operations_wait-execution/">Wait Execution</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
|
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|
<a href="..">Remote Build Execution v5.0.4+20210329</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=".." class="icon icon-home" alt="Docs"></a> »</li>
|
|
<li>Action Results »</li>
|
|
<li>Update</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/remotebuildexecution2-cli/edit/master/docs/action-results_update.md"
|
|
class="icon icon-github"> Edit on GitHub</a>
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|
<div class="section" itemprop="articleBody">
|
|
|
|
<p>Upload a new execution result. In order to allow the server to perform access control based on the type of action, and to assist with client debugging, the client MUST first upload the Action that produced the result, along with its Command, into the <code>ContentAddressableStorage</code>. Server implementations MAY modify the <code>UpdateActionResultRequest.action_result</code> and return an equivalent value. Errors: * <code>INVALID_ARGUMENT</code>: One or more arguments are invalid. * <code>FAILED_PRECONDITION</code>: One or more errors occurred in updating the action result, such as a missing command or action. * <code>RESOURCE_EXHAUSTED</code>: There is insufficient storage space to add the entry to the cache.</p>
|
|
<h1 id="scopes">Scopes</h1>
|
|
<p>You will need authorization for the <em>https://www.googleapis.com/auth/cloud-platform</em> scope to make a valid call.</p>
|
|
<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>remotebuildexecution2 --scope <scope> action-results update ...</code></p>
|
|
<h1 id="required-scalar-arguments">Required Scalar Arguments</h1>
|
|
<ul>
|
|
<li><strong><instance-name></strong> <em>(string)</em><ul>
|
|
<li>The instance of the execution system to operate against. A server may support multiple instances of the execution system (with their own workers, storage, caches, etc.). The server MAY require use of this field to select between them in an implementation-defined fashion, otherwise it can be omitted.</li>
|
|
</ul>
|
|
</li>
|
|
<li><strong><hash></strong> <em>(string)</em><ul>
|
|
<li>The hash. In the case of SHA-256, it will always be a lowercase hex string exactly 64 characters long.</li>
|
|
</ul>
|
|
</li>
|
|
<li><strong><size-bytes></strong> <em>(string)</em><ul>
|
|
<li>The size of the blob, in bytes.</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>BuildBazelRemoteExecutionV2ActionResult:
|
|
execution-metadata:
|
|
execution-completed-timestamp: string
|
|
execution-start-timestamp: string
|
|
input-fetch-completed-timestamp: string
|
|
input-fetch-start-timestamp: string
|
|
output-upload-completed-timestamp: string
|
|
output-upload-start-timestamp: string
|
|
queued-timestamp: string
|
|
worker: string
|
|
worker-completed-timestamp: string
|
|
worker-start-timestamp: string
|
|
exit-code: integer
|
|
stderr-digest:
|
|
hash: string
|
|
size-bytes: string
|
|
stderr-raw: string
|
|
stdout-digest:
|
|
hash: string
|
|
size-bytes: string
|
|
stdout-raw: 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 .execution-metadata execution-completed-timestamp=et</code><ul>
|
|
<li>When the worker completed executing the action command.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>execution-start-timestamp=magna</code><ul>
|
|
<li>When the worker started executing the action command.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>input-fetch-completed-timestamp=no</code><ul>
|
|
<li>When the worker finished fetching action inputs.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>input-fetch-start-timestamp=ipsum</code><ul>
|
|
<li>When the worker started fetching action inputs.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>output-upload-completed-timestamp=voluptua.</code><ul>
|
|
<li>When the worker finished uploading action outputs.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>output-upload-start-timestamp=at</code><ul>
|
|
<li>When the worker started uploading action outputs.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>queued-timestamp=sanctus</code><ul>
|
|
<li>When was the action added to the queue.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>worker=sed</code><ul>
|
|
<li>The name of the worker which ran the execution.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>worker-completed-timestamp=amet.</code><ul>
|
|
<li>When the worker completed the action, including all stages.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>worker-start-timestamp=takimata</code></p>
|
|
<ul>
|
|
<li>When the worker received the action.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. exit-code=49</code></p>
|
|
<ul>
|
|
<li>The exit code of the command.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>stderr-digest hash=duo</code><ul>
|
|
<li>The hash. In the case of SHA-256, it will always be a lowercase hex string exactly 64 characters long.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>size-bytes=ipsum</code></p>
|
|
<ul>
|
|
<li>The size of the blob, in bytes.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. stderr-raw=gubergren</code></p>
|
|
<ul>
|
|
<li>The standard error buffer of the action. The server SHOULD NOT inline stderr unless requested by the client in the GetActionResultRequest message. The server MAY omit inlining, even if requested, and MUST do so if inlining would cause the response to exceed message size limits.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>stdout-digest hash=lorem</code><ul>
|
|
<li>The hash. In the case of SHA-256, it will always be a lowercase hex string exactly 64 characters long.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>size-bytes=gubergren</code></p>
|
|
<ul>
|
|
<li>The size of the blob, in bytes.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. stdout-raw=eos</code></p>
|
|
<ul>
|
|
<li>The standard output buffer of the action. The server SHOULD NOT inline stdout unless requested by the client in the GetActionResultRequest message. The server MAY omit inlining, even if requested, and MUST do so if inlining would cause the response to exceed message size limits.</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-method-properties">Optional Method Properties</h1>
|
|
<p>You may set the following properties to further configure the call. Please note that <code>-p</code> is followed by one
|
|
or more key-value-pairs, and is called like this <code>-p k1=v1 k2=v2</code> even though the listing below repeats the
|
|
<code>-p</code> for completeness.</p>
|
|
<ul>
|
|
<li><strong>-p results-cache-policy-priority=integer</strong><ul>
|
|
<li>The priority (relative importance) of this content in the overall cache. Generally, a lower value means a longer retention time or other advantage, but the interpretation of a given value is server-dependent. A priority of 0 means a <em>default</em> value, decided by the server. The particular semantics of this field is up to the server. In particular, every server will have their own supported range of priorities, and will decide how these map into retention/eviction policy.</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. "media", "multipart").</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p upload-protocol=string</strong></p>
|
|
<ul>
|
|
<li>Upload protocol for media (e.g. "raw", "multipart").</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div><footer>
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
|
|
<a href="../action-results_get/" class="btn btn-neutral float-left" title="Get"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
|
<a href="../actions_execute/" class="btn btn-neutral float-right" title="Execute">Next <span class="icon icon-circle-arrow-right"></span></a>
|
|
</div>
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<!-- Copyright etc -->
|
|
<p>Copyright © 2015-2020, `Sebastian Thiel`</p>
|
|
</div>
|
|
|
|
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/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" aria-label="Versions">
|
|
<span class="rst-current-version" data-toggle="rst-current-version">
|
|
|
|
<span>
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/remotebuildexecution2-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
|
</span>
|
|
|
|
|
|
<span><a href="../action-results_get/" style="color: #fcfcfc">« Previous</a></span>
|
|
|
|
|
|
<span><a href="../actions_execute/" style="color: #fcfcfc">Next »</a></span>
|
|
|
|
</span>
|
|
</div>
|
|
<script>var base_url = '..';</script>
|
|
<script src="../js/theme_extra.js" defer></script>
|
|
<script src="../js/theme.js" defer></script>
|
|
<script src="../search/main.js" defer></script>
|
|
<script defer>
|
|
window.onload = function () {
|
|
SphinxRtdTheme.Navigation.enable(true);
|
|
};
|
|
</script>
|
|
|
|
</body>
|
|
</html>
|