mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-25 12:44:07 +01:00
434 lines
21 KiB
HTML
434 lines
21 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-appengine1-cli/apps_patch/" />
|
|
<link rel="shortcut icon" href="../img/favicon.ico" />
|
|
<title>Patch - appengine v5.0.4+20240226</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 = "Patch";
|
|
var mkdocs_page_input_path = "apps_patch.md";
|
|
var mkdocs_page_url = "/google-apis-rs/google-appengine1-cli/apps_patch/";
|
|
</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"> appengine v5.0.4+20240226
|
|
</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">Apps</span></p>
|
|
<ul class="current">
|
|
<li class="toctree-l1"><a class="reference internal" href="../apps_authorized-certificates-create/">Authorized Certificates Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../apps_authorized-certificates-delete/">Authorized Certificates Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../apps_authorized-certificates-get/">Authorized Certificates Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../apps_authorized-certificates-list/">Authorized Certificates List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../apps_authorized-certificates-patch/">Authorized Certificates Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../apps_authorized-domains-list/">Authorized Domains List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../apps_create/">Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../apps_domain-mappings-create/">Domain Mappings Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../apps_domain-mappings-delete/">Domain Mappings Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../apps_domain-mappings-get/">Domain Mappings Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../apps_domain-mappings-list/">Domain Mappings List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../apps_domain-mappings-patch/">Domain Mappings Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../apps_firewall-ingress-rules-batch-update/">Firewall Ingress Rules Batch Update</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../apps_firewall-ingress-rules-create/">Firewall Ingress Rules Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../apps_firewall-ingress-rules-delete/">Firewall Ingress Rules Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../apps_firewall-ingress-rules-get/">Firewall Ingress Rules Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../apps_firewall-ingress-rules-list/">Firewall Ingress Rules List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../apps_firewall-ingress-rules-patch/">Firewall Ingress Rules Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../apps_get/">Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../apps_list-runtimes/">List Runtimes</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../apps_locations-get/">Locations Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../apps_locations-list/">Locations List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../apps_operations-get/">Operations Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../apps_operations-list/">Operations List</a>
|
|
</li>
|
|
<li class="toctree-l1 current"><a class="reference internal current" href="./">Patch</a>
|
|
<ul class="current">
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../apps_repair/">Repair</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../apps_services-delete/">Services Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../apps_services-get/">Services Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../apps_services-list/">Services List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../apps_services-patch/">Services Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../apps_services-versions-create/">Services Versions Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../apps_services-versions-delete/">Services Versions Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../apps_services-versions-get/">Services Versions Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../apps_services-versions-instances-debug/">Services Versions Instances Debug</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../apps_services-versions-instances-delete/">Services Versions Instances Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../apps_services-versions-instances-get/">Services Versions Instances Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../apps_services-versions-instances-list/">Services Versions Instances List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../apps_services-versions-list/">Services Versions List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../apps_services-versions-patch/">Services Versions Patch</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Projects</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-applications-authorized-domains-list/">Locations Applications Authorized Domains List</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="..">appengine v5.0.4+20240226</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>Apps »</li>
|
|
<li>Patch</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/appengine1-cli/edit/master/docs/apps_patch.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>Updates the specified Application resource. You can update the following fields: auth_domain - Google authentication domain for controlling user access to the application. default_cookie_expiration - Cookie expiration policy for the application. iap - Identity-Aware Proxy properties for the application.</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>appengine1 --scope <scope> apps patch ...</code></p>
|
|
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
|
<ul>
|
|
<li><strong><apps-id></strong> <em>(string)</em><ul>
|
|
<li>Part of <code>name</code>. Name of the Application resource to update. Example: apps/myapp.</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>Application:
|
|
auth-domain: string
|
|
code-bucket: string
|
|
database-type: string
|
|
default-bucket: string
|
|
default-cookie-expiration: string
|
|
default-hostname: string
|
|
feature-settings:
|
|
split-health-checks: boolean
|
|
use-container-optimized-os: boolean
|
|
gcr-domain: string
|
|
iap:
|
|
enabled: boolean
|
|
oauth2-client-id: string
|
|
oauth2-client-secret: string
|
|
oauth2-client-secret-sha256: string
|
|
id: string
|
|
location-id: string
|
|
name: string
|
|
service-account: string
|
|
serving-status: 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 . auth-domain=et</code><ul>
|
|
<li>Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>code-bucket=et</code><ul>
|
|
<li>Output only. Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands.@OutputOnly</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>database-type=sadipscing</code><ul>
|
|
<li>The type of the Cloud Firestore or Cloud Datastore database associated with this application.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>default-bucket=stet</code><ul>
|
|
<li>Output only. Google Cloud Storage bucket that can be used by this application to store content.@OutputOnly</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>default-cookie-expiration=dolor</code><ul>
|
|
<li>Cookie expiration policy for this application.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>default-hostname=duo</code><ul>
|
|
<li>Output only. Hostname used to reach this application, as resolved by App Engine.@OutputOnly</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>feature-settings split-health-checks=false</code><ul>
|
|
<li>Boolean value indicating if split health checks should be used instead of the legacy health checks. At an app.yaml level, this means defaulting to 'readiness_check' and 'liveness_check' values instead of 'health_check' ones. Once the legacy 'health_check' behavior is deprecated, and this value is always true, this setting can be removed.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>use-container-optimized-os=false</code></p>
|
|
<ul>
|
|
<li>If true, use Container-Optimized OS (https://cloud.google.com/container-optimized-os/) base image for VMs, rather than a base Debian image.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. gcr-domain=invidunt</code></p>
|
|
<ul>
|
|
<li>Output only. The Google Container Registry domain used for storing managed build docker images for this application.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>iap enabled=true</code><ul>
|
|
<li>Whether the serving infrastructure will authenticate and authorize all incoming requests.If true, the oauth2_client_id and oauth2_client_secret fields must be non-empty.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>oauth2-client-id=vero</code><ul>
|
|
<li>OAuth2 client ID to use for the authentication flow.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>oauth2-client-secret=elitr</code><ul>
|
|
<li>OAuth2 client secret to use for the authentication flow.For security reasons, this value cannot be retrieved via the API. Instead, the SHA-256 hash of the value is returned in the oauth2_client_secret_sha256 field.@InputOnly</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>oauth2-client-secret-sha256=lorem</code></p>
|
|
<ul>
|
|
<li>Output only. Hex-encoded SHA-256 hash of the client secret.@OutputOnly</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. id=diam</code></p>
|
|
<ul>
|
|
<li>Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: myapp.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>location-id=no</code><ul>
|
|
<li>Location from which this application runs. Application instances run out of the data centers in the specified location, which is also where all of the application's end user content is stored.Defaults to us-central.View the list of supported locations (https://cloud.google.com/appengine/docs/locations).</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>name=ipsum</code><ul>
|
|
<li>Output only. Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>service-account=accusam</code><ul>
|
|
<li>The service account associated with the application. This is the app-level default identity. If no identity provided during create version, Admin API will fallback to this one.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>serving-status=takimata</code><ul>
|
|
<li>Serving status of this application.</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 update-mask=string</strong><ul>
|
|
<li>Required. Standard field mask for the set of fields to be updated.</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="../apps_operations-list/" class="btn btn-neutral float-left" title="Operations List"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
|
<a href="../apps_repair/" class="btn btn-neutral float-right" title="Repair">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/appengine1-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
|
</span>
|
|
|
|
|
|
<span><a href="../apps_operations-list/" style="color: #fcfcfc">« Previous</a></span>
|
|
|
|
|
|
<span><a href="../apps_repair/" 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>
|