Update documentation

This commit is contained in:
Sebastian Thiel
2024-03-05 21:06:01 +01:00
parent a20241b241
commit f4bb79d2d6
47205 changed files with 10667990 additions and 8269099 deletions

View File

@@ -1,198 +1,113 @@
<!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]-->
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Patch - Cloud Support v3.0.0+20220305</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>
<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-cloudsupport2_beta-cli/cases_patch/" />
<link rel="shortcut icon" href="../img/favicon.ico" />
<title>Patch - Cloud Support v5.0.4+20240304</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 = "cases_patch.md";
var mkdocs_page_url = "/google-apis-rs/google-cloudsupport2_beta-cli/cases_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"> Cloud Support v3.0.0+20220305</a>
<a href=".." class="icon icon-home"> Cloud Support v5.0.4+20240304
</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="main navigation">
<ul class="current">
<span>Attachments</span>
<li class="toctree-l1 ">
<a class="" href="../attachments_create">Create</a>
<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>
<span>Case Classifications</span>
<li class="toctree-l1 ">
<a class="" href="../case-classifications_search">Search</a>
</li>
<span>Cases</span>
<li class="toctree-l1 ">
<a class="" href="../cases_attachments-list">Attachments List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../cases_close">Close</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../cases_comments-create">Comments Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../cases_comments-list">Comments List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../cases_create">Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../cases_escalate">Escalate</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../cases_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../cases_list">List</a>
</li>
<li class="toctree-l1 current">
<a class="current" href=".">Patch</a>
<ul>
<li class="toctree-l2"><a href="#scopes">Scopes</a></li>
<li class="toctree-l2"><a href="#required-scalar-argument">Required Scalar Argument</a></li>
<li class="toctree-l2"><a href="#required-request-value">Required Request Value</a></li>
<li><a class="toctree-l3" href="#about-cursors">About Cursors</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="../cases_search">Search</a>
</li>
<span>Media</span>
<li class="toctree-l1 ">
<a class="" href="../media_download">Download</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../media_upload">Upload</a>
</li>
</ul>
</ul>
<p class="caption"><span class="caption-text">Case Classifications</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../case-classifications_search/">Search</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Cases</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../cases_attachments-list/">Attachments List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../cases_close/">Close</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../cases_comments-create/">Comments Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../cases_comments-list/">Comments List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../cases_create/">Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../cases_escalate/">Escalate</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../cases_get/">Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../cases_list/">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="../cases_search/">Search</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Media</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../media_download/">Download</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../media_upload/">Upload</a>
</li>
</ul>
</div>
&nbsp;
</div>
</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 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 Support v5.0.4+20240304</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="..">Docs</a> &raquo;</li>
<li>Patch</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/cloudsupport2_beta-cli" class="icon icon-github"> Edit on GitHub</a>
</li>
<li><a href=".." class="icon icon-home" alt="Docs"></a> &raquo;</li>
<li>Cases &raquo;</li>
<li>Patch</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/cloudsupport2_beta-cli/edit/master/docs/cases_patch.md"
class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main">
<div class="section">
<p>Update the specified case. Only a subset of fields (display_name, description, time_zone, subscriber_email_addresses, related_resources, severity, priority, primary_contact, and labels) can be updated.</p>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div class="section" itemprop="articleBody">
<p>Update a case. Only some fields can be updated. EXAMPLES: cURL: <code>shell case=&amp;#34;projects/some-project/cases/43595344&amp;#34; curl \ --request PATCH \ --header &amp;#34;Authorization: Bearer $(gcloud auth print-access-token)&amp;#34; \ --header &amp;#34;Content-Type: application/json&amp;#34; \ --data &amp;#39;{ &amp;#34;priority&amp;#34;: &amp;#34;P1&amp;#34; }&amp;#39; \ &amp;#34;https://cloudsupport.googleapis.com/v2/$case?updateMask=priority&amp;#34;</code> Python: <code>python import googleapiclient.discovery api_version = &amp;#34;v2&amp;#34; supportApiService = googleapiclient.discovery.build( serviceName=&amp;#34;cloudsupport&amp;#34;, version=api_version, discoveryServiceUrl=f&amp;#34;https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}&amp;#34;, ) request = supportApiService.cases().patch( name=&amp;#34;projects/some-project/cases/43112854&amp;#34;, body={ &amp;#34;displayName&amp;#34;: &amp;#34;This is Now a New Title&amp;#34;, &amp;#34;priority&amp;#34;: &amp;#34;P2&amp;#34;, }, ) print(request.execute())</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>.
@@ -212,14 +127,20 @@ In the latter case it is advised to set the field-cursor to the data-structure's
classification:
display-name: string
id: string
product:
product-line: string
product-subline: string
contact-email: string
create-time: string
creator:
display-name: string
email: string
google-support: boolean
username: string
description: string
display-name: string
escalated: boolean
language-code: string
name: string
priority: string
severity: string
@@ -230,70 +151,89 @@ In the latter case it is advised to set the field-cursor to the data-structure's
update-time: 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 .classification display-name=dolor</code><ul>
<li>The display name of the classification.</li>
<li><code>-r .classification display-name=lorem</code><ul>
<li>A display name for the classification. The display name is not static and can change. To uniquely and consistently identify classifications, use the <code>CaseClassification.id</code> field.</li>
</ul>
</li>
<li><code>id=eos</code><ul>
<li>The unique ID for a classification. Must be specified for case creation. To retrieve valid classification IDs for case creation, use <code>caseClassifications.search</code>. Classification IDs returned by <code>caseClassifications.search</code> are guaranteed to be valid for at least 6 months. If a given classification is deactiveated, it will immediately stop being returned. After 6 months, <code>case.create</code> requests using the classification ID will fail.</li>
</ul>
</li>
<li><code>product product-line=labore</code><ul>
<li>The Product Line of the Product.</li>
</ul>
</li>
<li>
<p><code>id=lorem</code></p>
<p><code>product-subline=sed</code></p>
<ul>
<li>The unique ID for a classification. Must be specified for case creation.</li>
<li>The Product Subline of the Product, such as &#34;Maps Billing&#34;.</li>
</ul>
</li>
<li>
<p><code>.. create-time=eos</code></p>
<p><code>... contact-email=duo</code></p>
<ul>
<li>A user-supplied email address to send case update notifications for. This should only be used in BYOID flows, where we cannot infer the user&#39;s email address directly from their EUCs.</li>
</ul>
</li>
<li><code>create-time=sed</code><ul>
<li>Output only. The time this case was created.</li>
</ul>
</li>
<li><code>creator display-name=labore</code><ul>
<li><code>creator display-name=no</code><ul>
<li>The name to display for the actor. If not provided, it is inferred from credentials supplied during case creation. When an email is provided, a display name must also be provided. This will be obfuscated if the user is a Google Support agent.</li>
</ul>
</li>
<li><code>email=sed</code><ul>
<li>The email address of the actor. If not provided, it is inferred from credentials supplied during case creation. If the authenticated principal does not have an email address, one must be provided. When a name is provided, an email must also be provided. This will be obfuscated if the user is a Google Support agent.</li>
<li><code>email=stet</code><ul>
<li>The email address of the actor. If not provided, it is inferred from the credentials supplied during case creation. When a name is provided, an email must also be provided. If the user is a Google Support agent, this is obfuscated. This field is deprecated. Use <strong>username</strong> field instead.</li>
</ul>
</li>
<li>
<p><code>google-support=false</code></p>
<ul>
<li><code>google-support=true</code><ul>
<li>Output only. Whether the actor is a Google support actor.</li>
</ul>
</li>
<li>
<p><code>.. description=sed</code></p>
<p><code>username=et</code></p>
<ul>
<li>Output only. The username of the actor. It may look like an email or other format provided by the identity provider. If not provided, it is inferred from the credentials supplied. When a name is provided, a username must also be provided. If the user is a Google Support agent, this will not be set.</li>
</ul>
</li>
<li>
<p><code>.. description=et</code></p>
<ul>
<li>A broad description of the issue.</li>
</ul>
</li>
<li><code>display-name=no</code><ul>
<li><code>display-name=vero</code><ul>
<li>The short summary of the issue reported in this case.</li>
</ul>
</li>
<li><code>escalated=true</code><ul>
<li><code>escalated=false</code><ul>
<li>Whether the case is currently escalated.</li>
</ul>
</li>
<li><code>name=et</code><ul>
<li><code>language-code=duo</code><ul>
<li>The language the user has requested to receive support in. This should be a BCP 47 language code (e.g., <code>&amp;#34;en&amp;#34;</code>, <code>&amp;#34;zh-CN&amp;#34;</code>, <code>&amp;#34;zh-TW&amp;#34;</code>, <code>&amp;#34;ja&amp;#34;</code>, <code>&amp;#34;ko&amp;#34;</code>). If no language or an unsupported language is specified, this field defaults to English (en). Language selection during case creation may affect your available support options. For a list of supported languages and their support working hours, see: https://cloud.google.com/support/docs/language-working-hours</li>
</ul>
</li>
<li><code>name=dolore</code><ul>
<li>The resource name for the case.</li>
</ul>
</li>
<li><code>priority=et</code><ul>
<li>The priority of this case. If this is set, do not set severity.</li>
<li>The priority of this case.</li>
</ul>
</li>
<li><code>severity=vero</code><ul>
<li>The severity of this case. Deprecated. Use priority instead.</li>
<li><code>severity=voluptua.</code><ul>
<li>REMOVED. The severity of this case. Use priority instead.</li>
</ul>
</li>
<li><code>state=erat</code><ul>
<li><code>state=amet.</code><ul>
<li>Output only. The current status of the support case.</li>
</ul>
</li>
<li><code>subscriber-email-addresses=sed</code><ul>
<li><code>subscriber-email-addresses=consetetur</code><ul>
<li>The email addresses to receive updates on this case.</li>
<li>Each invocation of this argument appends the given value to the array.</li>
</ul>
@@ -302,11 +242,11 @@ In the latter case it is advised to set the field-cursor to the data-structure's
<li>Whether this case was created for internal API testing and should not be acted on by the support team.</li>
</ul>
</li>
<li><code>time-zone=diam</code><ul>
<li><code>time-zone=dolor</code><ul>
<li>The timezone of the user who created the support case. It should be in a format IANA recognizes: https://www.iana.org/time-zones. There is no additional validation done by the API.</li>
</ul>
</li>
<li><code>update-time=dolor</code><ul>
<li><code>update-time=et</code><ul>
<li>Output only. The time this case was last updated.</li>
</ul>
</li>
@@ -336,7 +276,7 @@ or more key-value-pairs, and is called like this <code>-p k1=v1 k2=v2</code> eve
<code>-p</code> for completeness.</p>
<ul>
<li><strong>-p update-mask=string</strong><ul>
<li>A field that represents attributes of a case object that should be updated as part of this request. Supported values are severity, display_name, and subscriber_email_addresses. If no fields are specified, all supported fields will be updated. WARNING: If you do not provide a field mask then you may accidentally clear some fields. For example, if you leave field mask empty and do not provide a value for subscriber_email_addresses then subscriber_email_addresses will be updated to empty.</li>
<li>A list of attributes of the case that should be updated. Supported values are <code>priority</code>, <code>display_name</code>, and <code>subscriber_email_addresses</code>. If no fields are specified, all supported fields are updated. Be careful - if you do not provide a field mask, then you might accidentally clear some fields. For example, if you leave the field mask empty and do not provide a value for <code>subscriber_email_addresses</code>, then <code>subscriber_email_addresses</code> is updated to empty.</li>
</ul>
</li>
</ul>
@@ -410,32 +350,24 @@ or more key-value-pairs, and is called like this <code>-p k1=v1 k2=v2</code> eve
</ul>
</li>
</ul>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../cases_search" class="btn btn-neutral float-right" title="Search"/>Next <span class="icon icon-circle-arrow-right"></span></a>
<a href="../cases_list" class="btn btn-neutral" title="List"><span class="icon icon-circle-arrow-left"></span> Previous</a>
</div><footer>
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
<a href="../cases_list/" class="btn btn-neutral float-left" title="List"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<a href="../cases_search/" class="btn btn-neutral float-right" title="Search">Next <span class="icon icon-circle-arrow-right"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>
<!-- Copyright etc -->
</p>
<p>Copyright &copy; 2015-2020, `Sebastian Thiel`</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>.
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>
@@ -443,14 +375,30 @@ or more key-value-pairs, and is called like this <code>-p k1=v1 k2=v2</code> eve
</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="../cases_list" style="color: #fcfcfc;">&laquo; Previous</a></span>
<span style="margin-left: 15px"><a href="../cases_search" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
<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/cloudsupport2_beta-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
</span>
<span><a href="../cases_list/" style="color: #fcfcfc">&laquo; Previous</a></span>
<span><a href="../cases_search/" 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>
</html>