mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-25 12:44:07 +01:00
364 lines
18 KiB
HTML
364 lines
18 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_domain-mappings-patch/" />
|
|
<link rel="shortcut icon" href="../img/favicon.ico" />
|
|
<title>Domain Mappings 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 = "Domain Mappings Patch";
|
|
var mkdocs_page_input_path = "apps_domain-mappings-patch.md";
|
|
var mkdocs_page_url = "/google-apis-rs/google-appengine1-cli/apps_domain-mappings-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 current"><a class="reference internal current" href="./">Domain Mappings Patch</a>
|
|
<ul class="current">
|
|
</ul>
|
|
</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"><a class="reference internal" href="../apps_patch/">Patch</a>
|
|
</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>Domain Mappings 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_domain-mappings-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 domain mapping. To map an SSL certificate to a domain mapping, update certificate_id to point to an AuthorizedCertificate resource. A user must be authorized to administer the associated domain in order to update a DomainMapping resource.</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 domain-mappings-patch ...</code></p>
|
|
<h1 id="required-scalar-arguments">Required Scalar Arguments</h1>
|
|
<ul>
|
|
<li><strong><apps-id></strong> <em>(string)</em><ul>
|
|
<li>Part of <code>name</code>. Name of the resource to update. Example: apps/myapp/domainMappings/example.com.</li>
|
|
</ul>
|
|
</li>
|
|
<li><strong><domain-mappings-id></strong> <em>(string)</em><ul>
|
|
<li>Part of <code>name</code>. See documentation of <code>appsId</code>.</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>DomainMapping:
|
|
id: string
|
|
name: string
|
|
ssl-settings:
|
|
certificate-id: string
|
|
pending-managed-certificate-id: string
|
|
ssl-management-type: 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 . id=et</code><ul>
|
|
<li>Relative name of the domain serving the application. Example: example.com.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>name=et</code><ul>
|
|
<li>Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.@OutputOnly</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>ssl-settings certificate-id=vero</code><ul>
|
|
<li>ID of the AuthorizedCertificate resource configuring SSL for the application. Clearing this field will remove SSL support.By default, a managed certificate is automatically created for every domain mapping. To omit SSL support or to configure SSL manually, specify SslManagementType.MANUAL on a CREATE or UPDATE request. You must be authorized to administer the AuthorizedCertificate resource to manually map it to a DomainMapping resource. Example: 12345.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>pending-managed-certificate-id=erat</code><ul>
|
|
<li>ID of the managed AuthorizedCertificate resource currently being provisioned, if applicable. Until the new managed certificate has been successfully provisioned, the previous SSL state will be preserved. Once the provisioning process completes, the certificate_id field will reflect the new managed certificate and this field will be left empty. To remove SSL support while there is still a pending managed certificate, clear the certificate_id field with an UpdateDomainMappingRequest.@OutputOnly</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>ssl-management-type=sed</code><ul>
|
|
<li>SSL management type for this domain. If AUTOMATIC, a managed certificate is automatically provisioned. If MANUAL, certificate_id must be manually specified in order to configure SSL for this domain.</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_domain-mappings-list/" class="btn btn-neutral float-left" title="Domain Mappings List"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
|
<a href="../apps_firewall-ingress-rules-batch-update/" class="btn btn-neutral float-right" title="Firewall Ingress Rules Batch Update">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_domain-mappings-list/" style="color: #fcfcfc">« Previous</a></span>
|
|
|
|
|
|
<span><a href="../apps_firewall-ingress-rules-batch-update/" 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>
|