OMGeeky/google-apis-rs
1
0
Fork 0
mirror of https://github.com/OMGeeky/google-apis-rs.git synced 2026-01-26 19:58:50 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
a20241b2412723b0062d1c19a8ec792837b145a4
google-apis-rs/google_cloudbuild1_cli/projects_builds-get/index.html
Sebastian Thiel a20241b241 Update documentation
2022-03-08 15:36:16 +08:00

550 lines
20 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>Builds Get - Cloud Build v3.0.0+20220218</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 Build v3.0.0+20220218</a>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<span>Locations</span>
<li class="toctree-l1 ">
<a class="" href="../locations_regional-webhook">Regional Webhook</a>
</li>
<span>Methods</span>
<li class="toctree-l1 ">
<a class="" href="../methods_webhook">Webhook</a>
</li>
<span>Operations</span>
<li class="toctree-l1 ">
<a class="" href="../operations_cancel">Cancel</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../operations_get">Get</a>
</li>
<span>Projects</span>
<li class="toctree-l1 ">
<a class="" href="../projects_builds-approve">Builds Approve</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_builds-cancel">Builds Cancel</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_builds-create">Builds Create</a>
</li>
<li class="toctree-l1 current">
<a class="current" href=".">Builds Get</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="#optional-output-flags">Optional Output Flags</a></li>
<li class="toctree-l2"><a href="#optional-method-properties">Optional Method Properties</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="../projects_builds-list">Builds List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_builds-retry">Builds Retry</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_github-enterprise-configs-create">Github Enterprise Configs Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_github-enterprise-configs-delete">Github Enterprise Configs Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_github-enterprise-configs-get">Github Enterprise Configs Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_github-enterprise-configs-list">Github Enterprise Configs List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_github-enterprise-configs-patch">Github Enterprise Configs Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-bitbucket-server-configs-add-bitbucket-server-connected-repository">Locations Bitbucket Server Configs Add Bitbucket Server Connected Repository</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-bitbucket-server-configs-connected-repositories-batch-create">Locations Bitbucket Server Configs Connected Repositories Batch Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-bitbucket-server-configs-create">Locations Bitbucket Server Configs Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-bitbucket-server-configs-delete">Locations Bitbucket Server Configs Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-bitbucket-server-configs-get">Locations Bitbucket Server Configs Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-bitbucket-server-configs-list">Locations Bitbucket Server Configs List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-bitbucket-server-configs-patch">Locations Bitbucket Server Configs Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-bitbucket-server-configs-remove-bitbucket-server-connected-repository">Locations Bitbucket Server Configs Remove Bitbucket Server Connected Repository</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-bitbucket-server-configs-repos-list">Locations Bitbucket Server Configs Repos List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-builds-approve">Locations Builds Approve</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-builds-cancel">Locations Builds Cancel</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-builds-create">Locations Builds Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-builds-get">Locations Builds Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-builds-list">Locations Builds List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-builds-retry">Locations Builds Retry</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-github-enterprise-configs-create">Locations Github Enterprise Configs Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-github-enterprise-configs-delete">Locations Github Enterprise Configs Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-github-enterprise-configs-get">Locations Github Enterprise Configs Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-github-enterprise-configs-list">Locations Github Enterprise Configs List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-github-enterprise-configs-patch">Locations Github Enterprise Configs Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-operations-cancel">Locations Operations Cancel</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-operations-get">Locations Operations Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-triggers-create">Locations Triggers Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-triggers-delete">Locations Triggers Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-triggers-get">Locations Triggers Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-triggers-list">Locations Triggers List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-triggers-patch">Locations Triggers Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-triggers-run">Locations Triggers Run</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-triggers-webhook">Locations Triggers Webhook</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-worker-pools-create">Locations Worker Pools Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-worker-pools-delete">Locations Worker Pools Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-worker-pools-get">Locations Worker Pools Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-worker-pools-list">Locations Worker Pools List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-worker-pools-patch">Locations Worker Pools Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_triggers-create">Triggers Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_triggers-delete">Triggers Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_triggers-get">Triggers Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_triggers-list">Triggers List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_triggers-patch">Triggers Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_triggers-run">Triggers Run</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_triggers-webhook">Triggers Webhook</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>Builds Get</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/cloudbuild1-cli" class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main">
<div class="section">
<p>Returns information about a previously requested build. The <code>Build</code> that is returned includes its status (such as <code>SUCCESS</code>, <code>FAILURE</code>, or <code>WORKING</code>), and timing information.</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>cloudbuild1 --scope &lt;scope&gt; projects builds-get ...</code></p>
<h1 id="required-scalar-arguments">Required Scalar Arguments</h1>
<ul>
<li><strong>&lt;project-id&gt;</strong> <em>(string)</em><ul>
<li>Required. ID of the project.</li>
</ul>
</li>
<li><strong>&lt;id&gt;</strong> <em>(string)</em><ul>
<li>Required. ID of the build.</li>
</ul>
</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 name=string</strong><ul>
<li>The name of the <code>Build</code> to retrieve. Format: <code>projects/{project}/locations/{location}/builds/{build}</code></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="../projects_builds-list" class="btn btn-neutral float-right" title="Builds List"/>Next <span class="icon icon-circle-arrow-right"></span></a>
<a href="../projects_builds-create" class="btn btn-neutral" title="Builds Create"><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="../projects_builds-create" style="color: #fcfcfc;">&laquo; Previous</a></span>
<span style="margin-left: 15px"><a href="../projects_builds-list" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink