blob: e1a180350653c29b191b9e1886567c7375b89580 [file] [log] [blame]
Bu Sun Kim65020912020-05-20 12:08:20 -07001<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="cloudasset_v1p1beta1.html">Cloud Asset API</a> . <a href="cloudasset_v1p1beta1.resources.html">resources</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -070078 <code><a href="#searchAll">searchAll(scope, orderBy=None, pageToken=None, pageSize=None, query=None, assetTypes=None, x__xgafv=None)</a></code></p>
Bu Sun Kim65020912020-05-20 12:08:20 -070079<p class="firstline">Searches all the resources under a given accessible CRM scope</p>
80<p class="toc_element">
81 <code><a href="#searchAll_next">searchAll_next(previous_request, previous_response)</a></code></p>
82<p class="firstline">Retrieves the next page of results.</p>
83<h3>Method Details</h3>
84<div class="method">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -070085 <code class="details" id="searchAll">searchAll(scope, orderBy=None, pageToken=None, pageSize=None, query=None, assetTypes=None, x__xgafv=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -070086 <pre>Searches all the resources under a given accessible CRM scope
87(project/folder/organization). This RPC gives callers
88especially admins the ability to search all the resources under a scope,
89even if they don&#x27;t have .get permission of all the resources. Callers
90should have cloud.assets.SearchAllResources permission on the requested
91scope, otherwise it will be rejected.
92
93Args:
94 scope: string, Required. The relative name of an asset. The search is limited to the resources
95within the `scope`. The allowed value must be:
96* Organization number (such as &quot;organizations/123&quot;)
97* Folder number(such as &quot;folders/1234&quot;)
98* Project number (such as &quot;projects/12345&quot;)
99* Project id (such as &quot;projects/abc&quot;) (required)
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700100 orderBy: string, Optional. A comma separated list of fields specifying the sorting order of the
101results. The default order is ascending. Add &quot; desc&quot; after the field name
102to indicate descending order. Redundant space characters are ignored. For
103example, &quot; foo , bar desc &quot;.
Bu Sun Kim65020912020-05-20 12:08:20 -0700104 pageToken: string, Optional. If present, then retrieve the next batch of results from the preceding call
105to this method. `page_token` must be the value of `next_page_token` from
106the previous response. The values of all other method parameters, must be
107identical to those in the previous call.
108 pageSize: integer, Optional. The page size for search result pagination. Page size is capped at 500 even
109if a larger value is given. If set to zero, server will pick an appropriate
110default. Returned results may be fewer than requested. When this happens,
111there could be more results as long as `next_page_token` is returned.
112 query: string, Optional. The query statement.
113 assetTypes: string, Optional. A list of asset types that this request searches for. If empty, it will
114search all the supported asset types. (repeated)
Bu Sun Kim65020912020-05-20 12:08:20 -0700115 x__xgafv: string, V1 error format.
116 Allowed values
117 1 - v1 error format
118 2 - v2 error format
119
120Returns:
121 An object of the form:
122
123 { # Search all resources response.
Bu Sun Kim65020912020-05-20 12:08:20 -0700124 &quot;results&quot;: [ # A list of resource that match the search query.
125 { # The standard metadata of a cloud resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700126 &quot;location&quot;: &quot;A String&quot;, # Location can be &quot;global&quot;, regional like &quot;us-east1&quot;, or zonal like
127 # &quot;us-west1-b&quot;.
128 &quot;assetType&quot;: &quot;A String&quot;, # The type of this resource.
129 # For example: &quot;compute.googleapis.com/Disk&quot;.
130 &quot;additionalAttributes&quot;: [ # Additional searchable attributes of this resource.
131 # Informational only. The exact set of attributes is subject to change.
132 # For example: project id, DNS name etc.
133 &quot;A String&quot;,
134 ],
135 &quot;description&quot;: &quot;A String&quot;, # One or more paragraphs of text description of this resource. Maximum length
136 # could be up to 1M bytes.
137 &quot;displayName&quot;: &quot;A String&quot;, # The display name of this resource.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700138 &quot;labels&quot;: { # Labels associated with this resource. See [Labelling and grouping GCP
139 # resources](https://cloud.google.com/blog/products/gcp/labelling-and-grouping-your-google-cloud-platform-resources)
140 # for more information.
141 &quot;a_key&quot;: &quot;A String&quot;,
142 },
143 &quot;name&quot;: &quot;A String&quot;, # The full resource name. For example:
144 # `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`.
145 # See [Resource
146 # Names](https://cloud.google.com/apis/design/resource_names#full_resource_name)
147 # for more information.
148 &quot;project&quot;: &quot;A String&quot;, # The project that this resource belongs to, in the form of
149 # `projects/{project_number}`.
150 &quot;networkTags&quot;: [ # Network tags associated with this resource. Like labels, network tags are a
151 # type of annotations used to group GCP resources. See [Labelling GCP
152 # resources](lhttps://cloud.google.com/blog/products/gcp/labelling-and-grouping-your-google-cloud-platform-resources)
153 # for more information.
154 &quot;A String&quot;,
155 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700156 },
157 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700158 &quot;nextPageToken&quot;: &quot;A String&quot;, # If there are more results than those appearing in this response, then
159 # `next_page_token` is included. To get the next set of results, call this
160 # method again using the value of `next_page_token` as `page_token`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700161 }</pre>
162</div>
163
164<div class="method">
165 <code class="details" id="searchAll_next">searchAll_next(previous_request, previous_response)</code>
166 <pre>Retrieves the next page of results.
167
168Args:
169 previous_request: The request for the previous page. (required)
170 previous_response: The response from the request for the previous page. (required)
171
172Returns:
173 A request object that you can call &#x27;execute()&#x27; on to request the next
174 page. Returns None if there are no more items in the collection.
175 </pre>
176</div>
177
178</body></html>