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
f4bb79d2d629ee5166f17b80ca2aa0e621d1c837
google-apis-rs/google_cloudbuild1_cli/build_html/projects_builds-create/index.html
Sebastian Thiel f4bb79d2d6 Update documentation
2024-03-05 21:06:01 +01:00

967 lines
44 KiB
HTML
Raw Blame History

<!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-cloudbuild1-cli/projects_builds-create/" />
<link rel="shortcut icon" href="../img/favicon.ico" />
<title>Builds Create - Cloud Build v5.0.4+20240223</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 = "Builds Create";
var mkdocs_page_input_path = "projects_builds-create.md";
var mkdocs_page_url = "/google-apis-rs/google-cloudbuild1-cli/projects_builds-create/";
</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"> Cloud Build v5.0.4+20240223
</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">Github Dot Com Webhook</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../github-dot-com-webhook_receive/">Receive</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Locations</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../locations_regional-webhook/">Regional Webhook</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Methods</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../methods_webhook/">Webhook</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Operations</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../operations_cancel/">Cancel</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../operations_get/">Get</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Projects</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../projects_builds-approve/">Builds Approve</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_builds-cancel/">Builds Cancel</a>
</li>
<li class="toctree-l1 current"><a class="reference internal current" href="./">Builds Create</a>
<ul class="current">
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_builds-get/">Builds Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_builds-list/">Builds List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_builds-retry/">Builds Retry</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_github-enterprise-configs-create/">Github Enterprise Configs Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_github-enterprise-configs-delete/">Github Enterprise Configs Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_github-enterprise-configs-get/">Github Enterprise Configs Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_github-enterprise-configs-list/">Github Enterprise Configs List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_github-enterprise-configs-patch/">Github Enterprise Configs Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" 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="reference internal" href="../projects_locations-bitbucket-server-configs-create/">Locations Bitbucket Server Configs Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-bitbucket-server-configs-delete/">Locations Bitbucket Server Configs Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-bitbucket-server-configs-get/">Locations Bitbucket Server Configs Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-bitbucket-server-configs-list/">Locations Bitbucket Server Configs List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-bitbucket-server-configs-patch/">Locations Bitbucket Server Configs Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" 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="reference internal" href="../projects_locations-bitbucket-server-configs-repos-list/">Locations Bitbucket Server Configs Repos List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-builds-approve/">Locations Builds Approve</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-builds-cancel/">Locations Builds Cancel</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-builds-create/">Locations Builds Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-builds-get/">Locations Builds Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-builds-list/">Locations Builds List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-builds-retry/">Locations Builds Retry</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-get-default-service-account/">Locations Get Default Service Account</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-git-lab-configs-connected-repositories-batch-create/">Locations Git Lab Configs Connected Repositories Batch Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-git-lab-configs-create/">Locations Git Lab Configs Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-git-lab-configs-delete/">Locations Git Lab Configs Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-git-lab-configs-get/">Locations Git Lab Configs Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-git-lab-configs-list/">Locations Git Lab Configs List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-git-lab-configs-patch/">Locations Git Lab Configs Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-git-lab-configs-remove-git-lab-connected-repository/">Locations Git Lab Configs Remove Git Lab Connected Repository</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-git-lab-configs-repos-list/">Locations Git Lab Configs Repos List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-github-enterprise-configs-create/">Locations Github Enterprise Configs Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-github-enterprise-configs-delete/">Locations Github Enterprise Configs Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-github-enterprise-configs-get/">Locations Github Enterprise Configs Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-github-enterprise-configs-list/">Locations Github Enterprise Configs List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-github-enterprise-configs-patch/">Locations Github Enterprise Configs Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-operations-cancel/">Locations Operations Cancel</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-operations-get/">Locations Operations Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-triggers-create/">Locations Triggers Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-triggers-delete/">Locations Triggers Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-triggers-get/">Locations Triggers Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-triggers-list/">Locations Triggers List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-triggers-patch/">Locations Triggers Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-triggers-run/">Locations Triggers Run</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-triggers-webhook/">Locations Triggers Webhook</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-worker-pools-create/">Locations Worker Pools Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-worker-pools-delete/">Locations Worker Pools Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-worker-pools-get/">Locations Worker Pools Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-worker-pools-list/">Locations Worker Pools List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-worker-pools-patch/">Locations Worker Pools Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_triggers-create/">Triggers Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_triggers-delete/">Triggers Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_triggers-get/">Triggers Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_triggers-list/">Triggers List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_triggers-patch/">Triggers Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_triggers-run/">Triggers Run</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_triggers-webhook/">Triggers Webhook</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="..">Cloud Build v5.0.4+20240223</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> &raquo;</li>
<li>Projects &raquo;</li>
<li>Builds Create</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/cloudbuild1-cli/edit/master/docs/projects_builds-create.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>Starts a build with the specified configuration. This method returns a long-running <code>Operation</code>, which includes the build ID. Pass the build ID to <code>GetBuild</code> to determine the build status (such as <code>SUCCESS</code> or <code>FAILURE</code>).</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-create ...</code></p>
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
<ul>
<li><strong>&lt;project-id&gt;</strong> <em>(string)</em><ul>
<li>Required. ID of the project.</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>Build:
approval:
config:
approval-required: boolean
result:
approval-time: string
approver-account: string
comment: string
decision: string
url: string
state: string
artifacts:
images: [string]
objects:
location: string
paths: [string]
timing:
end-time: string
start-time: string
build-trigger-id: string
create-time: string
failure-info:
detail: string
type: string
finish-time: string
id: string
images: [string]
log-url: string
logs-bucket: string
name: string
options:
automap-substitutions: boolean
default-logs-bucket-behavior: string
disk-size-gb: string
dynamic-substitutions: boolean
env: [string]
log-streaming-option: string
logging: string
machine-type: string
pool:
name: string
requested-verify-option: string
secret-env: [string]
source-provenance-hash: [string]
substitution-option: string
worker-pool: string
project-id: string
queue-ttl: string
results:
artifact-manifest: string
artifact-timing:
end-time: string
start-time: string
build-step-images: [string]
build-step-outputs: [string]
num-artifacts: string
service-account: string
source:
connected-repository:
dir: string
repository: string
revision: string
git-source:
dir: string
revision: string
url: string
repo-source:
branch-name: string
commit-sha: string
dir: string
invert-regex: boolean
project-id: string
repo-name: string
substitutions: { string: string }
tag-name: string
storage-source:
bucket: string
generation: string
object: string
source-fetcher: string
storage-source-manifest:
bucket: string
generation: string
object: string
source-provenance:
resolved-connected-repository:
dir: string
repository: string
revision: string
resolved-git-source:
dir: string
revision: string
url: string
resolved-repo-source:
branch-name: string
commit-sha: string
dir: string
invert-regex: boolean
project-id: string
repo-name: string
substitutions: { string: string }
tag-name: string
resolved-storage-source:
bucket: string
generation: string
object: string
source-fetcher: string
resolved-storage-source-manifest:
bucket: string
generation: string
object: string
start-time: string
status: string
status-detail: string
substitutions: { string: string }
tags: [string]
timeout: 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>
<p><code>-r .approval.config approval-required=true</code></p>
<ul>
<li>Whether or not approval is needed. If this is set on a build, it will become pending when created, and will need to be explicitly approved to start.</li>
</ul>
</li>
<li>
<p><code>..result approval-time=gubergren</code></p>
<ul>
<li>Output only. The time when the approval decision was made.</li>
</ul>
</li>
<li><code>approver-account=eos</code><ul>
<li>Output only. Email of the user that called the ApproveBuild API to approve or reject a build at the time that the API was called.</li>
</ul>
</li>
<li><code>comment=dolor</code><ul>
<li>Optional. An optional comment for this manual approval result.</li>
</ul>
</li>
<li><code>decision=ea</code><ul>
<li>Required. The decision of this manual approval.</li>
</ul>
</li>
<li>
<p><code>url=ipsum</code></p>
<ul>
<li>Optional. An optional URL tied to this manual approval result. This field is essentially the same as comment, except that it will be rendered by the UI differently. An example use case is a link to an external job that approved this Build.</li>
</ul>
</li>
<li>
<p><code>.. state=invidunt</code></p>
<ul>
<li>Output only. The state of this build&#39;s approval.</li>
</ul>
</li>
<li>
<p><code>..artifacts images=amet</code></p>
<ul>
<li>A list of images to be pushed upon the successful completion of all build steps. The images will be pushed using the builder service account&#39;s credentials. The digests of the pushed images will be stored in the Build resource&#39;s results field. If any of the images fail to be pushed, the build is marked FAILURE.</li>
<li>Each invocation of this argument appends the given value to the array.</li>
</ul>
</li>
<li><code>objects location=duo</code><ul>
<li>Cloud Storage bucket and optional object path, in the form &#34;gs://bucket/path/to/somewhere/&#34;. (see <a href="https://cloud.google.com/storage/docs/bucket-naming#requirements">Bucket Name Requirements</a>). Files in the workspace matching any path pattern will be uploaded to Cloud Storage with this location as a prefix.</li>
</ul>
</li>
<li><code>paths=ipsum</code><ul>
<li>Path globs used to match files in the build&#39;s workspace.</li>
<li>Each invocation of this argument appends the given value to the array.</li>
</ul>
</li>
<li><code>timing end-time=sed</code><ul>
<li>End of time span.</li>
</ul>
</li>
<li>
<p><code>start-time=ut</code></p>
<ul>
<li>Start of time span.</li>
</ul>
</li>
<li>
<p><code>.... build-trigger-id=gubergren</code></p>
<ul>
<li>Output only. The ID of the <code>BuildTrigger</code> that triggered this build, if it was triggered automatically.</li>
</ul>
</li>
<li><code>create-time=rebum.</code><ul>
<li>Output only. Time at which the request to create the build was received.</li>
</ul>
</li>
<li><code>failure-info detail=est</code><ul>
<li>Explains the failure issue in more detail using hard-coded text.</li>
</ul>
</li>
<li>
<p><code>type=ipsum</code></p>
<ul>
<li>The name of the failure.</li>
</ul>
</li>
<li>
<p><code>.. finish-time=ipsum</code></p>
<ul>
<li>Output only. Time at which execution of the build was finished. The difference between finish_time and start_time is the duration of the build&#39;s execution.</li>
</ul>
</li>
<li><code>id=est</code><ul>
<li>Output only. Unique identifier of the build.</li>
</ul>
</li>
<li><code>images=gubergren</code><ul>
<li>A list of images to be pushed upon the successful completion of all build steps. The images are pushed using the builder service account&#39;s credentials. The digests of the pushed images will be stored in the <code>Build</code> resource&#39;s results field. If any of the images fail to be pushed, the build status is marked <code>FAILURE</code>.</li>
<li>Each invocation of this argument appends the given value to the array.</li>
</ul>
</li>
<li><code>log-url=ea</code><ul>
<li>Output only. URL to logs for this build in Google Cloud Console.</li>
</ul>
</li>
<li><code>logs-bucket=dolor</code><ul>
<li>Cloud Storage bucket where logs should be written (see <a href="https://cloud.google.com/storage/docs/bucket-naming#requirements">Bucket Name Requirements</a>). Logs file names will be of the format <code>${logs_bucket}/log-${build_id}.txt</code>.</li>
</ul>
</li>
<li><code>name=lorem</code><ul>
<li>Output only. The &#39;Build&#39; name with format: <code>projects/{project}/locations/{location}/builds/{build}</code>, where {build} is a unique identifier generated by the service.</li>
</ul>
</li>
<li><code>options automap-substitutions=false</code><ul>
<li>Option to include built-in and custom substitutions as env variables for all build steps.</li>
</ul>
</li>
<li><code>default-logs-bucket-behavior=sed</code><ul>
<li>Optional. Option to specify how default logs buckets are setup.</li>
</ul>
</li>
<li><code>disk-size-gb=duo</code><ul>
<li>Requested disk size for the VM that runs the build. Note that this is <em>NOT</em> &#34;disk free&#34;; some of the space will be used by the operating system and build utilities. Also note that this is the minimum disk size that will be allocated for the build -- the build may run with a larger disk than requested. At present, the maximum disk size is 2000GB; builds that request more than the maximum are rejected with an error.</li>
</ul>
</li>
<li><code>dynamic-substitutions=false</code><ul>
<li>Option to specify whether or not to apply bash style string operations to the substitutions. NOTE: this is always enabled for triggered builds and cannot be overridden in the build configuration file.</li>
</ul>
</li>
<li><code>env=no</code><ul>
<li>A list of global environment variable definitions that will exist for all build steps in this build. If a variable is defined in both globally and in a build step, the variable will use the build step value. The elements are of the form &#34;KEY=VALUE&#34; for the environment variable &#34;KEY&#34; being given the value &#34;VALUE&#34;.</li>
<li>Each invocation of this argument appends the given value to the array.</li>
</ul>
</li>
<li><code>log-streaming-option=stet</code><ul>
<li>Option to define build log streaming behavior to Cloud Storage.</li>
</ul>
</li>
<li><code>logging=kasd</code><ul>
<li>Option to specify the logging mode, which determines if and where build logs are stored.</li>
</ul>
</li>
<li><code>machine-type=et</code><ul>
<li>Compute Engine machine type on which to run the build.</li>
</ul>
</li>
<li>
<p><code>pool name=sed</code></p>
<ul>
<li>The <code>WorkerPool</code> resource to execute the build on. You must have <code>cloudbuild.workerpools.use</code> on the project hosting the WorkerPool. Format projects/{project}/locations/{location}/workerPools/{workerPoolId}</li>
</ul>
</li>
<li>
<p><code>.. requested-verify-option=et</code></p>
<ul>
<li>Requested verifiability options.</li>
</ul>
</li>
<li><code>secret-env=et</code><ul>
<li>A list of global environment variables, which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build&#39;s <code>Secret</code>. These variables will be available to all build steps in this build.</li>
<li>Each invocation of this argument appends the given value to the array.</li>
</ul>
</li>
<li><code>source-provenance-hash=vero</code><ul>
<li>Requested hash for SourceProvenance.</li>
<li>Each invocation of this argument appends the given value to the array.</li>
</ul>
</li>
<li><code>substitution-option=erat</code><ul>
<li>Option to specify behavior when there is an error in the substitution checks. NOTE: this is always set to ALLOW_LOOSE for triggered builds and cannot be overridden in the build configuration file.</li>
</ul>
</li>
<li>
<p><code>worker-pool=sed</code></p>
<ul>
<li>This field deprecated; please use <code>pool.name</code> instead.</li>
</ul>
</li>
<li>
<p><code>.. project-id=duo</code></p>
<ul>
<li>Output only. ID of the project.</li>
</ul>
</li>
<li><code>queue-ttl=dolore</code><ul>
<li>TTL in queue for this build. If provided and the build is enqueued longer than this value, the build will expire and the build status will be <code>EXPIRED</code>. The TTL starts ticking from create_time.</li>
</ul>
</li>
<li><code>results artifact-manifest=et</code><ul>
<li>Path to the artifact manifest for non-container artifacts uploaded to Cloud Storage. Only populated when artifacts are uploaded to Cloud Storage.</li>
</ul>
</li>
<li><code>artifact-timing end-time=voluptua.</code><ul>
<li>End of time span.</li>
</ul>
</li>
<li>
<p><code>start-time=amet.</code></p>
<ul>
<li>Start of time span.</li>
</ul>
</li>
<li>
<p><code>.. build-step-images=consetetur</code></p>
<ul>
<li>List of build step digests, in the order corresponding to build step indices.</li>
<li>Each invocation of this argument appends the given value to the array.</li>
</ul>
</li>
<li><code>build-step-outputs=diam</code><ul>
<li>List of build step outputs, produced by builder images, in the order corresponding to build step indices. <a href="https://cloud.google.com/cloud-build/docs/cloud-builders">Cloud Builders</a> can produce this output by writing to <code>$BUILDER_OUTPUT/output</code>. Only the first 50KB of data is stored.</li>
<li>Each invocation of this argument appends the given value to the array.</li>
</ul>
</li>
<li>
<p><code>num-artifacts=dolor</code></p>
<ul>
<li>Number of non-container artifacts uploaded to Cloud Storage. Only populated when artifacts are uploaded to Cloud Storage.</li>
</ul>
</li>
<li>
<p><code>.. service-account=et</code></p>
<ul>
<li>IAM service account whose credentials will be used at build runtime. Must be of the format <code>projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}</code>. ACCOUNT can be email address or uniqueId of the service account. </li>
</ul>
</li>
<li><code>source.connected-repository dir=et</code><ul>
<li>Directory, relative to the source root, in which to run the build.</li>
</ul>
</li>
<li><code>repository=sadipscing</code><ul>
<li>Required. Name of the Google Cloud Build repository, formatted as <code>projects/*/locations/*/connections/*/repositories/*</code>.</li>
</ul>
</li>
<li>
<p><code>revision=stet</code></p>
<ul>
<li>The revision to fetch from the Git repository such as a branch, a tag, a commit SHA, or any Git ref.</li>
</ul>
</li>
<li>
<p><code>..git-source dir=dolor</code></p>
<ul>
<li>Directory, relative to the source root, in which to run the build. This must be a relative path. If a step&#39;s <code>dir</code> is specified and is an absolute path, this value is ignored for that step&#39;s execution.</li>
</ul>
</li>
<li><code>revision=duo</code><ul>
<li>The revision to fetch from the Git repository such as a branch, a tag, a commit SHA, or any Git ref. Cloud Build uses <code>git fetch</code> to fetch the revision from the Git repository; therefore make sure that the string you provide for <code>revision</code> is parsable by the command. For information on string values accepted by <code>git fetch</code>, see https://git-scm.com/docs/gitrevisions#_specifying_revisions. For information on <code>git fetch</code>, see https://git-scm.com/docs/git-fetch.</li>
</ul>
</li>
<li>
<p><code>url=vero</code></p>
<ul>
<li>Location of the Git repo to build. This will be used as a <code>git remote</code>, see https://git-scm.com/docs/git-remote.</li>
</ul>
</li>
<li>
<p><code>..repo-source branch-name=vero</code></p>
<ul>
<li>Regex matching branches to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax</li>
</ul>
</li>
<li><code>commit-sha=invidunt</code><ul>
<li>Explicit commit SHA to build.</li>
</ul>
</li>
<li><code>dir=stet</code><ul>
<li>Directory, relative to the source root, in which to run the build. This must be a relative path. If a step&#39;s <code>dir</code> is specified and is an absolute path, this value is ignored for that step&#39;s execution.</li>
</ul>
</li>
<li><code>invert-regex=false</code><ul>
<li>Only trigger a build if the revision regex does NOT match the revision regex.</li>
</ul>
</li>
<li><code>project-id=elitr</code><ul>
<li>ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed.</li>
</ul>
</li>
<li><code>repo-name=lorem</code><ul>
<li>Name of the Cloud Source Repository.</li>
</ul>
</li>
<li><code>substitutions=key=diam</code><ul>
<li>Substitutions to use in a triggered build. Should only be used with RunBuildTrigger</li>
<li>the value will be associated with the given <code>key</code></li>
</ul>
</li>
<li>
<p><code>tag-name=no</code></p>
<ul>
<li>Regex matching tags to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax</li>
</ul>
</li>
<li>
<p><code>..storage-source bucket=ipsum</code></p>
<ul>
<li>Cloud Storage bucket containing the source (see <a href="https://cloud.google.com/storage/docs/bucket-naming#requirements">Bucket Name Requirements</a>).</li>
</ul>
</li>
<li><code>generation=accusam</code><ul>
<li>Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used.</li>
</ul>
</li>
<li><code>object=takimata</code><ul>
<li>Cloud Storage object containing the source. This object must be a zipped (<code>.zip</code>) or gzipped archive file (<code>.tar.gz</code>) containing source to build.</li>
</ul>
</li>
<li>
<p><code>source-fetcher=consetetur</code></p>
<ul>
<li>Optional. Option to specify the tool to fetch the source file for the build.</li>
</ul>
</li>
<li>
<p><code>..storage-source-manifest bucket=voluptua.</code></p>
<ul>
<li>Cloud Storage bucket containing the source manifest (see <a href="https://cloud.google.com/storage/docs/bucket-naming#requirements">Bucket Name Requirements</a>).</li>
</ul>
</li>
<li><code>generation=et</code><ul>
<li>Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used.</li>
</ul>
</li>
<li>
<p><code>object=erat</code></p>
<ul>
<li>Cloud Storage object containing the source manifest. This object must be a JSON file.</li>
</ul>
</li>
<li>
<p><code>...source-provenance.resolved-connected-repository dir=consetetur</code></p>
<ul>
<li>Directory, relative to the source root, in which to run the build.</li>
</ul>
</li>
<li><code>repository=amet.</code><ul>
<li>Required. Name of the Google Cloud Build repository, formatted as <code>projects/*/locations/*/connections/*/repositories/*</code>.</li>
</ul>
</li>
<li>
<p><code>revision=sed</code></p>
<ul>
<li>The revision to fetch from the Git repository such as a branch, a tag, a commit SHA, or any Git ref.</li>
</ul>
</li>
<li>
<p><code>..resolved-git-source dir=takimata</code></p>
<ul>
<li>Directory, relative to the source root, in which to run the build. This must be a relative path. If a step&#39;s <code>dir</code> is specified and is an absolute path, this value is ignored for that step&#39;s execution.</li>
</ul>
</li>
<li><code>revision=dolores</code><ul>
<li>The revision to fetch from the Git repository such as a branch, a tag, a commit SHA, or any Git ref. Cloud Build uses <code>git fetch</code> to fetch the revision from the Git repository; therefore make sure that the string you provide for <code>revision</code> is parsable by the command. For information on string values accepted by <code>git fetch</code>, see https://git-scm.com/docs/gitrevisions#_specifying_revisions. For information on <code>git fetch</code>, see https://git-scm.com/docs/git-fetch.</li>
</ul>
</li>
<li>
<p><code>url=gubergren</code></p>
<ul>
<li>Location of the Git repo to build. This will be used as a <code>git remote</code>, see https://git-scm.com/docs/git-remote.</li>
</ul>
</li>
<li>
<p><code>..resolved-repo-source branch-name=et</code></p>
<ul>
<li>Regex matching branches to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax</li>
</ul>
</li>
<li><code>commit-sha=accusam</code><ul>
<li>Explicit commit SHA to build.</li>
</ul>
</li>
<li><code>dir=voluptua.</code><ul>
<li>Directory, relative to the source root, in which to run the build. This must be a relative path. If a step&#39;s <code>dir</code> is specified and is an absolute path, this value is ignored for that step&#39;s execution.</li>
</ul>
</li>
<li><code>invert-regex=false</code><ul>
<li>Only trigger a build if the revision regex does NOT match the revision regex.</li>
</ul>
</li>
<li><code>project-id=amet.</code><ul>
<li>ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed.</li>
</ul>
</li>
<li><code>repo-name=ea</code><ul>
<li>Name of the Cloud Source Repository.</li>
</ul>
</li>
<li><code>substitutions=key=sadipscing</code><ul>
<li>Substitutions to use in a triggered build. Should only be used with RunBuildTrigger</li>
<li>the value will be associated with the given <code>key</code></li>
</ul>
</li>
<li>
<p><code>tag-name=lorem</code></p>
<ul>
<li>Regex matching tags to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax</li>
</ul>
</li>
<li>
<p><code>..resolved-storage-source bucket=invidunt</code></p>
<ul>
<li>Cloud Storage bucket containing the source (see <a href="https://cloud.google.com/storage/docs/bucket-naming#requirements">Bucket Name Requirements</a>).</li>
</ul>
</li>
<li><code>generation=no</code><ul>
<li>Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used.</li>
</ul>
</li>
<li><code>object=est</code><ul>
<li>Cloud Storage object containing the source. This object must be a zipped (<code>.zip</code>) or gzipped archive file (<code>.tar.gz</code>) containing source to build.</li>
</ul>
</li>
<li>
<p><code>source-fetcher=at</code></p>
<ul>
<li>Optional. Option to specify the tool to fetch the source file for the build.</li>
</ul>
</li>
<li>
<p><code>..resolved-storage-source-manifest bucket=sed</code></p>
<ul>
<li>Cloud Storage bucket containing the source manifest (see <a href="https://cloud.google.com/storage/docs/bucket-naming#requirements">Bucket Name Requirements</a>).</li>
</ul>
</li>
<li><code>generation=sit</code><ul>
<li>Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used.</li>
</ul>
</li>
<li>
<p><code>object=et</code></p>
<ul>
<li>Cloud Storage object containing the source manifest. This object must be a JSON file.</li>
</ul>
</li>
<li>
<p><code>... start-time=tempor</code></p>
<ul>
<li>Output only. Time at which execution of the build was started.</li>
</ul>
</li>
<li><code>status=aliquyam</code><ul>
<li>Output only. Status of the build.</li>
</ul>
</li>
<li><code>status-detail=ipsum</code><ul>
<li>Output only. Customer-readable message about the current status.</li>
</ul>
</li>
<li><code>substitutions=key=et</code><ul>
<li>Substitutions data for <code>Build</code> resource.</li>
<li>the value will be associated with the given <code>key</code></li>
</ul>
</li>
<li><code>tags=sanctus</code><ul>
<li>Tags for annotation of a <code>Build</code>. These are not docker tags.</li>
<li>Each invocation of this argument appends the given value to the array.</li>
</ul>
</li>
<li><code>timeout=lorem</code><ul>
<li>Amount of time that this build should be allowed to run, to second granularity. If this amount of time elapses, work on the build will cease and the build status will be <code>TIMEOUT</code>. <code>timeout</code> starts ticking from <code>startTime</code>. Default time is 60 minutes.</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 parent=string</strong><ul>
<li>The parent resource where this build will be created. Format: <code>projects/{project}/locations/{location}</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-cancel/" class="btn btn-neutral float-left" title="Builds Cancel"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<a href="../projects_builds-get/" class="btn btn-neutral float-right" title="Builds Get">Next <span class="icon icon-circle-arrow-right"></span></a>
</div>
<hr/>
<div role="contentinfo">
<!-- Copyright etc -->
<p>Copyright &copy; 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/cloudbuild1-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
</span>
<span><a href="../projects_builds-cancel/" style="color: #fcfcfc">&laquo; Previous</a></span>
<span><a href="../projects_builds-get/" style="color: #fcfcfc">Next &raquo;</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>
Reference in New Issue View Git Blame Copy Permalink