blob: f583b4bc74ce429269ba778f0776e6887303a9af [file] [log] [blame]
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="cloudasset_v1p1beta1.html">Cloud Asset API</a> . <a href="cloudasset_v1p1beta1.resources.html">resources</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#searchAll">searchAll(scope, orderBy=None, pageToken=None, assetTypes=None, query=None, pageSize=None, x__xgafv=None)</a></code></p>
<p class="firstline">Searches all the resources within a given accessible CRM scope</p>
<p class="toc_element">
<code><a href="#searchAll_next">searchAll_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="searchAll">searchAll(scope, orderBy=None, pageToken=None, assetTypes=None, query=None, pageSize=None, x__xgafv=None)</code>
<pre>Searches all the resources within a given accessible CRM scope
(project/folder/organization). This RPC gives callers especially
administrators the ability to search all the resources within a scope, even
if they don&#x27;t have `.get` permission of all the resources. Callers should
have `cloud.assets.SearchAllResources` permission on the requested scope,
otherwise the request will be rejected.
Args:
scope: string, Required. The relative name of an asset. The search is limited to the resources
within the `scope`. The allowed value must be:
* Organization number (such as &quot;organizations/123&quot;)
* Folder number(such as &quot;folders/1234&quot;)
* Project number (such as &quot;projects/12345&quot;)
* Project id (such as &quot;projects/abc&quot;) (required)
orderBy: string, Optional. A comma separated list of fields specifying the sorting order of the
results. The default order is ascending. Add ` DESC` after the field name
to indicate descending order. Redundant space characters are ignored. For
example, ` location DESC , name `.
pageToken: string, Optional. If present, then retrieve the next batch of results from the preceding call
to this method. `page_token` must be the value of `next_page_token` from
the previous response. The values of all other method parameters, must be
identical to those in the previous call.
assetTypes: string, Optional. A list of asset types that this request searches for. If empty, it will
search all the supported asset types. (repeated)
query: string, Optional. The query statement.
pageSize: integer, Optional. The page size for search result pagination. Page size is capped at 500 even
if a larger value is given. If set to zero, server will pick an appropriate
default. Returned results may be fewer than requested. When this happens,
there could be more results as long as `next_page_token` is returned.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Search all resources response.
&quot;results&quot;: [ # A list of resource that match the search query.
{ # The standard metadata of a cloud resource.
&quot;networkTags&quot;: [ # Network tags associated with this resource. Like labels, network tags are a
# type of annotations used to group GCP resources. See [Labelling GCP
# resources](lhttps://cloud.google.com/blog/products/gcp/labelling-and-grouping-your-google-cloud-platform-resources)
# for more information.
&quot;A String&quot;,
],
&quot;description&quot;: &quot;A String&quot;, # One or more paragraphs of text description of this resource. Maximum length
# could be up to 1M bytes.
&quot;additionalAttributes&quot;: [ # Additional searchable attributes of this resource.
# Informational only. The exact set of attributes is subject to change.
# For example: project id, DNS name etc.
&quot;A String&quot;,
],
&quot;project&quot;: &quot;A String&quot;, # The project that this resource belongs to, in the form of
# `projects/{project_number}`.
&quot;displayName&quot;: &quot;A String&quot;, # The display name of this resource.
&quot;labels&quot;: { # Labels associated with this resource. See [Labelling and grouping GCP
# resources](https://cloud.google.com/blog/products/gcp/labelling-and-grouping-your-google-cloud-platform-resources)
# for more information.
&quot;a_key&quot;: &quot;A String&quot;,
},
&quot;name&quot;: &quot;A String&quot;, # The full resource name. For example:
# `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`.
# See [Resource
# Names](https://cloud.google.com/apis/design/resource_names#full_resource_name)
# for more information.
&quot;location&quot;: &quot;A String&quot;, # Location can be &quot;global&quot;, regional like &quot;us-east1&quot;, or zonal like
# &quot;us-west1-b&quot;.
&quot;assetType&quot;: &quot;A String&quot;, # The type of this resource.
# For example: &quot;compute.googleapis.com/Disk&quot;.
},
],
&quot;nextPageToken&quot;: &quot;A String&quot;, # If there are more results than those appearing in this response, then
# `next_page_token` is included. To get the next set of results, call this
# method again using the value of `next_page_token` as `page_token`.
}</pre>
</div>
<div class="method">
<code class="details" id="searchAll_next">searchAll_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call &#x27;execute()&#x27; on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>