mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-02-15 22:18:10 +01:00
357 lines
21 KiB
HTML
357 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-recommender1-cli/organizations_locations-recommenders-recommendations-mark-failed/" />
|
|
<link rel="shortcut icon" href="../img/favicon.ico" />
|
|
<title>Locations Recommenders Recommendations Mark Failed - Recommender 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 = "Locations Recommenders Recommendations Mark Failed";
|
|
var mkdocs_page_input_path = "organizations_locations-recommenders-recommendations-mark-failed.md";
|
|
var mkdocs_page_url = "/google-apis-rs/google-recommender1-cli/organizations_locations-recommenders-recommendations-mark-failed/";
|
|
</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"> Recommender 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">Billing Accounts</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../billing-accounts_locations-insight-types-get-config/">Locations Insight Types Get Config</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../billing-accounts_locations-insight-types-insights-get/">Locations Insight Types Insights Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../billing-accounts_locations-insight-types-insights-list/">Locations Insight Types Insights List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../billing-accounts_locations-insight-types-insights-mark-accepted/">Locations Insight Types Insights Mark Accepted</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../billing-accounts_locations-insight-types-update-config/">Locations Insight Types Update Config</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../billing-accounts_locations-recommenders-get-config/">Locations Recommenders Get Config</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../billing-accounts_locations-recommenders-recommendations-get/">Locations Recommenders Recommendations Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../billing-accounts_locations-recommenders-recommendations-list/">Locations Recommenders Recommendations List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../billing-accounts_locations-recommenders-recommendations-mark-claimed/">Locations Recommenders Recommendations Mark Claimed</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../billing-accounts_locations-recommenders-recommendations-mark-dismissed/">Locations Recommenders Recommendations Mark Dismissed</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../billing-accounts_locations-recommenders-recommendations-mark-failed/">Locations Recommenders Recommendations Mark Failed</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../billing-accounts_locations-recommenders-recommendations-mark-succeeded/">Locations Recommenders Recommendations Mark Succeeded</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../billing-accounts_locations-recommenders-update-config/">Locations Recommenders Update Config</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Folders</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../folders_locations-insight-types-insights-get/">Locations Insight Types Insights Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../folders_locations-insight-types-insights-list/">Locations Insight Types Insights List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../folders_locations-insight-types-insights-mark-accepted/">Locations Insight Types Insights Mark Accepted</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../folders_locations-recommenders-recommendations-get/">Locations Recommenders Recommendations Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../folders_locations-recommenders-recommendations-list/">Locations Recommenders Recommendations List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../folders_locations-recommenders-recommendations-mark-claimed/">Locations Recommenders Recommendations Mark Claimed</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../folders_locations-recommenders-recommendations-mark-dismissed/">Locations Recommenders Recommendations Mark Dismissed</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../folders_locations-recommenders-recommendations-mark-failed/">Locations Recommenders Recommendations Mark Failed</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../folders_locations-recommenders-recommendations-mark-succeeded/">Locations Recommenders Recommendations Mark Succeeded</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Organizations</span></p>
|
|
<ul class="current">
|
|
<li class="toctree-l1"><a class="reference internal" href="../organizations_locations-insight-types-get-config/">Locations Insight Types Get Config</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../organizations_locations-insight-types-insights-get/">Locations Insight Types Insights Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../organizations_locations-insight-types-insights-list/">Locations Insight Types Insights List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../organizations_locations-insight-types-insights-mark-accepted/">Locations Insight Types Insights Mark Accepted</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../organizations_locations-insight-types-update-config/">Locations Insight Types Update Config</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../organizations_locations-recommenders-get-config/">Locations Recommenders Get Config</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../organizations_locations-recommenders-recommendations-get/">Locations Recommenders Recommendations Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../organizations_locations-recommenders-recommendations-list/">Locations Recommenders Recommendations List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../organizations_locations-recommenders-recommendations-mark-claimed/">Locations Recommenders Recommendations Mark Claimed</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../organizations_locations-recommenders-recommendations-mark-dismissed/">Locations Recommenders Recommendations Mark Dismissed</a>
|
|
</li>
|
|
<li class="toctree-l1 current"><a class="reference internal current" href="./">Locations Recommenders Recommendations Mark Failed</a>
|
|
<ul class="current">
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../organizations_locations-recommenders-recommendations-mark-succeeded/">Locations Recommenders Recommendations Mark Succeeded</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../organizations_locations-recommenders-update-config/">Locations Recommenders Update Config</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-insight-types-get-config/">Locations Insight Types Get Config</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-insight-types-insights-get/">Locations Insight Types Insights Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-insight-types-insights-list/">Locations Insight Types Insights List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-insight-types-insights-mark-accepted/">Locations Insight Types Insights Mark Accepted</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-insight-types-update-config/">Locations Insight Types Update Config</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-recommenders-get-config/">Locations Recommenders Get Config</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-recommenders-recommendations-get/">Locations Recommenders Recommendations Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-recommenders-recommendations-list/">Locations Recommenders Recommendations List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-recommenders-recommendations-mark-claimed/">Locations Recommenders Recommendations Mark Claimed</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-recommenders-recommendations-mark-dismissed/">Locations Recommenders Recommendations Mark Dismissed</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-recommenders-recommendations-mark-failed/">Locations Recommenders Recommendations Mark Failed</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-recommenders-recommendations-mark-succeeded/">Locations Recommenders Recommendations Mark Succeeded</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-recommenders-update-config/">Locations Recommenders Update Config</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="..">Recommender 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>Organizations »</li>
|
|
<li>Locations Recommenders Recommendations Mark Failed</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/recommender1-cli/edit/master/docs/organizations_locations-recommenders-recommendations-mark-failed.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>Marks the Recommendation State as Failed. Users can use this method to indicate to the Recommender API that they have applied the recommendation themselves, and the operation failed. This stops the recommendation content from being updated. Associated insights are frozen and placed in the ACCEPTED state. MarkRecommendationFailed can be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. Requires the recommender.*.update IAM permission for the specified recommender.</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>recommender1 --scope <scope> organizations locations-recommenders-recommendations-mark-failed ...</code></p>
|
|
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
|
<ul>
|
|
<li><strong><name></strong> <em>(string)</em><ul>
|
|
<li>Required. Name of the recommendation.</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>GoogleCloudRecommenderV1MarkRecommendationFailedRequest:
|
|
etag: string
|
|
state-metadata: { string: 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 . etag=no</code><ul>
|
|
<li>Required. Fingerprint of the Recommendation. Provides optimistic locking.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>state-metadata=key=stet</code><ul>
|
|
<li>State properties to include with this state. Overwrites any existing <code>state_metadata</code>. Keys must match the regex <code>/^a-z0-9{0,62}$/</code>. Values must match the regex <code>/^[a-zA-Z0-9_./-]{0,255}$/</code>.</li>
|
|
<li>the value will be associated with the given <code>key</code></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-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="../organizations_locations-recommenders-recommendations-mark-dismissed/" class="btn btn-neutral float-left" title="Locations Recommenders Recommendations Mark Dismissed"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
|
<a href="../organizations_locations-recommenders-recommendations-mark-succeeded/" class="btn btn-neutral float-right" title="Locations Recommenders Recommendations Mark Succeeded">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/recommender1-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
|
</span>
|
|
|
|
|
|
<span><a href="../organizations_locations-recommenders-recommendations-mark-dismissed/" style="color: #fcfcfc">« Previous</a></span>
|
|
|
|
|
|
<span><a href="../organizations_locations-recommenders-recommendations-mark-succeeded/" 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>
|