blob: cac3dbbfe5398b96028738eb714ff4b1a5bfbfaf [file] [log] [blame] [edit]
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="run_v2.html">Cloud Run Admin API</a> . <a href="run_v2.projects.html">projects</a> . <a href="run_v2.projects.locations.html">locations</a> . <a href="run_v2.projects.locations.builds.html">builds</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#submit">submit(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Submits a build in a given project.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="submit">submit(parent, body=None, x__xgafv=None)</code>
<pre>Submits a build in a given project.
Args:
parent: string, Required. The project and location to build in. Location must be a region, e.g., &#x27;us-central1&#x27; or &#x27;global&#x27; if the global builder is to be used. Format: `projects/{project}/locations/{location}` (required)
body: object, The request body.
The object takes the form of:
{ # Request message for submitting a Build.
&quot;buildpackBuild&quot;: { # Build the source using Buildpacks. # Build the source using Buildpacks.
&quot;baseImage&quot;: &quot;A String&quot;, # Optional. The base image to use for the build.
&quot;cacheImageUri&quot;: &quot;A String&quot;, # Optional. cache_image_uri is the GCR/AR URL where the cache image will be stored. cache_image_uri is optional and omitting it will disable caching. This URL must be stable across builds. It is used to derive a build-specific temporary URL by substituting the tag with the build ID. The build will clean up the temporary image on a best-effort basis.
&quot;enableAutomaticUpdates&quot;: True or False, # Optional. Whether or not the application container will be enrolled in automatic base image updates. When true, the application will be built on a scratch base image, so the base layers can be appended at run time.
&quot;environmentVariables&quot;: { # Optional. User-provided build-time environment variables.
&quot;a_key&quot;: &quot;A String&quot;,
},
&quot;functionTarget&quot;: &quot;A String&quot;, # Optional. Name of the function target if the source is a function source. Required for function builds.
&quot;projectDescriptor&quot;: &quot;A String&quot;, # Optional. project_descriptor stores the path to the project descriptor file. When empty, it means that there is no project descriptor file in the source.
&quot;runtime&quot;: &quot;A String&quot;, # The runtime name, e.g. &#x27;go113&#x27;. Leave blank for generic builds.
},
&quot;dockerBuild&quot;: { # Build the source using Docker. This means the source has a Dockerfile. # Build the source using Docker. This means the source has a Dockerfile.
},
&quot;imageUri&quot;: &quot;A String&quot;, # Required. Artifact Registry URI to store the built image.
&quot;serviceAccount&quot;: &quot;A String&quot;, # Optional. The service account to use for the build. If not set, the default Cloud Build service account for the project will be used.
&quot;storageSource&quot;: { # Location of the source in an archive file in Google Cloud Storage. # Required. Source for the build.
&quot;bucket&quot;: &quot;A String&quot;, # Required. Google Cloud Storage bucket containing the source (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
&quot;generation&quot;: &quot;A String&quot;, # Optional. Google Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used.
&quot;object&quot;: &quot;A String&quot;, # Required. Google Cloud Storage object containing the source. This object must be a gzipped archive file (`.tar.gz`) containing source to build.
},
&quot;tags&quot;: [ # Optional. Additional tags to annotate the build.
&quot;A String&quot;,
],
&quot;workerPool&quot;: &quot;A String&quot;, # Optional. Name of the Cloud Build Custom Worker Pool that should be used to build the function. The format of this field is `projects/{project}/locations/{region}/workerPools/{workerPool}` where `{project}` and `{region}` are the project id and region respectively where the worker pool is defined and `{workerPool}` is the short name of the worker pool.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for submitting a Build.
&quot;baseImageUri&quot;: &quot;A String&quot;, # URI of the base builder image in Artifact Registry being used in the build. Used to opt into automatic base image updates.
&quot;baseImageWarning&quot;: &quot;A String&quot;, # Warning message for the base image.
&quot;buildOperation&quot;: { # This resource represents a long-running operation that is the result of a network API call. # Cloud Build operation to be polled via CloudBuild API.
&quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
&quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
&quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
&quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
],
&quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
&quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
&quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
&quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
},
}</pre>
</div>
</body></html>