Files
google-apis-rs/google_ml1_cli/projects_models-list/index.html
2024-03-05 21:06:01 +01:00

343 lines
16 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-ml1-cli/projects_models-list/" />
<link rel="shortcut icon" href="../img/favicon.ico" />
<title>Models List - Cloud Machine Learning Engine v5.0.4+20240127</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 = "Models List";
var mkdocs_page_input_path = "projects_models-list.md";
var mkdocs_page_url = "/google-apis-rs/google-ml1-cli/projects_models-list/";
</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 Machine Learning Engine v5.0.4+20240127
</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">Projects</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../projects_explain/">Explain</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_get-config/">Get Config</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_jobs-cancel/">Jobs Cancel</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_jobs-create/">Jobs Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_jobs-get/">Jobs Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_jobs-get-iam-policy/">Jobs Get Iam Policy</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_jobs-list/">Jobs List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_jobs-patch/">Jobs Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_jobs-set-iam-policy/">Jobs Set Iam Policy</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_jobs-test-iam-permissions/">Jobs Test Iam Permissions</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-get/">Locations Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-list/">Locations List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-operations-cancel/">Locations Operations Cancel</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-operations-get/">Locations Operations Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-studies-create/">Locations Studies Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-studies-delete/">Locations Studies Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-studies-get/">Locations Studies Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-studies-list/">Locations Studies List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-studies-trials-add-measurement/">Locations Studies Trials Add Measurement</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-studies-trials-check-early-stopping-state/">Locations Studies Trials Check Early Stopping State</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-studies-trials-complete/">Locations Studies Trials Complete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-studies-trials-create/">Locations Studies Trials Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-studies-trials-delete/">Locations Studies Trials Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-studies-trials-get/">Locations Studies Trials Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-studies-trials-list/">Locations Studies Trials List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-studies-trials-list-optimal-trials/">Locations Studies Trials List Optimal Trials</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-studies-trials-stop/">Locations Studies Trials Stop</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-studies-trials-suggest/">Locations Studies Trials Suggest</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_models-create/">Models Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_models-delete/">Models Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_models-get/">Models Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_models-get-iam-policy/">Models Get Iam Policy</a>
</li>
<li class="toctree-l1 current"><a class="reference internal current" href="./">Models List</a>
<ul class="current">
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_models-patch/">Models Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_models-set-iam-policy/">Models Set Iam Policy</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_models-test-iam-permissions/">Models Test Iam Permissions</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_models-versions-create/">Models Versions Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_models-versions-delete/">Models Versions Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_models-versions-get/">Models Versions Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_models-versions-list/">Models Versions List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_models-versions-patch/">Models Versions Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_models-versions-set-default/">Models Versions Set Default</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_operations-cancel/">Operations Cancel</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_operations-get/">Operations Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_operations-list/">Operations List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_predict/">Predict</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="..">Cloud Machine Learning Engine v5.0.4+20240127</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> &raquo;</li>
<li>Projects &raquo;</li>
<li>Models List</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/ml1-cli/edit/master/docs/projects_models-list.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>Lists the models in a project. Each project can contain multiple models, and each model can have multiple versions. If there are no models that match the request parameters, the list request returns an empty response body: {}.</p>
<h1 id="scopes">Scopes</h1>
<p>You will need authorization for at least one of the following scopes to make a valid call:</p>
<ul>
<li><em>https://www.googleapis.com/auth/cloud-platform</em></li>
<li><em>https://www.googleapis.com/auth/cloud-platform.read-only</em></li>
</ul>
<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>ml1 --scope &lt;scope&gt; projects models-list ...</code></p>
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
<ul>
<li><strong>&lt;parent&gt;</strong> <em>(string)</em><ul>
<li>Required. The name of the project whose models are to be listed.</li>
</ul>
</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>
<p><strong>-p filter=string</strong></p>
<ul>
<li>Optional. Specifies the subset of models to retrieve.</li>
</ul>
</li>
<li>
<p><strong>-p page-size=integer</strong></p>
<ul>
<li>Optional. The number of models to retrieve per &#34;page&#34; of results. If there are more remaining results than this number, the response message will contain a valid value in the <code>next_page_token</code> field. The default value is 20, and the maximum page size is 100.</li>
</ul>
</li>
<li>
<p><strong>-p page-token=string</strong></p>
<ul>
<li>Optional. A page token to request the next page of results. You get the token from the <code>next_page_token</code> field of the response from the previous call.</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. &#34;media&#34;, &#34;multipart&#34;).</li>
</ul>
</li>
<li>
<p><strong>-p upload-protocol=string</strong></p>
<ul>
<li>Upload protocol for media (e.g. &#34;raw&#34;, &#34;multipart&#34;).</li>
</ul>
</li>
</ul>
</div>
</div><footer>
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
<a href="../projects_models-get-iam-policy/" class="btn btn-neutral float-left" title="Models Get Iam Policy"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<a href="../projects_models-patch/" class="btn btn-neutral float-right" title="Models Patch">Next <span class="icon icon-circle-arrow-right"></span></a>
</div>
<hr/>
<div role="contentinfo">
<!-- Copyright etc -->
<p>Copyright &copy; 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/ml1-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
</span>
<span><a href="../projects_models-get-iam-policy/" style="color: #fcfcfc">&laquo; Previous</a></span>
<span><a href="../projects_models-patch/" 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>