OMGeeky/google-apis-rs
1
0
Fork 0
mirror of https://github.com/OMGeeky/google-apis-rs.git synced 2026-01-28 04:41:02 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
a20241b2412723b0062d1c19a8ec792837b145a4
google-apis-rs/google_cloudresourcemanager3_cli/folders_search/index.html
Sebastian Thiel a20241b241 Update documentation
2022-03-08 15:36:16 +08:00

553 lines
19 KiB
HTML
Raw Blame History

<!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]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Search - Cloud Resource Manager v3.0.0+20220306</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>
</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-nav-search">
<a href=".." class="icon icon-home"> Cloud Resource Manager v3.0.0+20220306</a>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<span>Folders</span>
<li class="toctree-l1 ">
<a class="" href="../folders_create">Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../folders_delete">Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../folders_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../folders_get-iam-policy">Get Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../folders_list">List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../folders_move">Move</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../folders_patch">Patch</a>
</li>
<li class="toctree-l1 current">
<a class="current" href=".">Search</a>
<ul>
<li class="toctree-l2"><a href="#scopes">Scopes</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="../folders_set-iam-policy">Set Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../folders_test-iam-permissions">Test Iam Permissions</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../folders_undelete">Undelete</a>
</li>
<span>Liens</span>
<li class="toctree-l1 ">
<a class="" href="../liens_create">Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../liens_delete">Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../liens_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../liens_list">List</a>
</li>
<span>Operations</span>
<li class="toctree-l1 ">
<a class="" href="../operations_get">Get</a>
</li>
<span>Organizations</span>
<li class="toctree-l1 ">
<a class="" href="../organizations_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../organizations_get-iam-policy">Get Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../organizations_search">Search</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../organizations_set-iam-policy">Set Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../organizations_test-iam-permissions">Test Iam Permissions</a>
</li>
<span>Projects</span>
<li class="toctree-l1 ">
<a class="" href="../projects_create">Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_delete">Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_get-iam-policy">Get Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_list">List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_move">Move</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_patch">Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_search">Search</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_set-iam-policy">Set Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_test-iam-permissions">Test Iam Permissions</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_undelete">Undelete</a>
</li>
<span>Tag Bindings</span>
<li class="toctree-l1 ">
<a class="" href="../tag-bindings_create">Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../tag-bindings_delete">Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../tag-bindings_list">List</a>
</li>
<span>Tag Keys</span>
<li class="toctree-l1 ">
<a class="" href="../tag-keys_create">Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../tag-keys_delete">Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../tag-keys_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../tag-keys_get-iam-policy">Get Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../tag-keys_list">List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../tag-keys_patch">Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../tag-keys_set-iam-policy">Set Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../tag-keys_test-iam-permissions">Test Iam Permissions</a>
</li>
<span>Tag Values</span>
<li class="toctree-l1 ">
<a class="" href="../tag-values_create">Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../tag-values_delete">Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../tag-values_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../tag-values_get-iam-policy">Get Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../tag-values_list">List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../tag-values_patch">Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../tag-values_set-iam-policy">Set Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../tag-values_test-iam-permissions">Test Iam Permissions</a>
</li>
</ul>
</div>
&nbsp;
</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>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="..">Docs</a> &raquo;</li>
<li>Search</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/cloudresourcemanager3-cli" class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main">
<div class="section">
<p>Search for folders that match specific filter criteria. <code>search()</code> provides an eventually consistent view of the folders a user has access to which meet the specified filter criteria. This will only return folders on which the caller has the permission <code>resourcemanager.folders.get</code>.</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>cloudresourcemanager3 --scope &lt;scope&gt; folders search ...</code></p>
<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 page-size=integer</strong></p>
<ul>
<li>Optional. The maximum number of folders to return in the response. The server can return fewer folders than requested. If unspecified, server picks an appropriate default.</li>
</ul>
</li>
<li>
<p><strong>-p page-token=string</strong></p>
<ul>
<li>Optional. A pagination token returned from a previous call to <code>SearchFolders</code> that indicates from where search should continue.</li>
</ul>
</li>
<li>
<p><strong>-p query=string</strong></p>
<ul>
<li>Optional. Search criteria used to select the folders to return. If no search criteria is specified then all accessible folders will be returned. Query expressions can be used to restrict results based upon displayName, state and parent, where the operators <code>=</code> (<code>:</code>) <code>NOT</code>, <code>AND</code> and <code>OR</code> can be used along with the suffix wildcard symbol <code>*</code>. The <code>displayName</code> field in a query expression should use escaped quotes for values that include whitespace to prevent unexpected behavior. <code>| Field | Description | |-------------------------|----------------------------------------| | displayName | Filters by displayName. | | parent | Filters by parent (for example: folders/123). | | state, lifecycleState | Filters by state. |</code> Some example queries are: * Query <code>displayName=Test*</code> returns Folder resources whose display name starts with &#34;Test&#34;. * Query <code>state=ACTIVE</code> returns Folder resources with <code>state</code> set to <code>ACTIVE</code>. * Query <code>parent=folders/123</code> returns Folder resources that have <code>folders/123</code> as a parent resource. * Query <code>parent=folders/123 AND state=ACTIVE</code> returns active Folder resources that have <code>folders/123</code> as a parent resource. * Query <code>displayName=\\&amp;#34;Test String\\&amp;#34;</code> returns Folder resources with display names that include both &#34;Test&#34; and &#34;String&#34;.</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="../folders_set-iam-policy" class="btn btn-neutral float-right" title="Set Iam Policy"/>Next <span class="icon icon-circle-arrow-right"></span></a>
<a href="../folders_patch" class="btn btn-neutral" title="Patch"><span class="icon icon-circle-arrow-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
<!-- Copyright etc -->
</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>.
</footer>
</div>
</div>
</section>
</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="../folders_patch" style="color: #fcfcfc;">&laquo; Previous</a></span>
<span style="margin-left: 15px"><a href="../folders_set-iam-policy" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink