Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 7d5badbac4f925c1867e20b50cf0a1a70a5fb573 / . / docs / dyn / resourceviews_v1beta1.zoneViews.html
blob: 3805b375c2e8031497a94003b1373250b919e0fd [file] [log] [blame]
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]1<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="resourceviews_v1beta1.html">Resource Views API</a> . <a href="resourceviews_v1beta1.zoneViews.html">zoneViews</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#addresources">addresources(projectName, zone, resourceViewName, body)</a></code></p>
79<p class="firstline">Add resources to the view.</p>
80<p class="toc_element">
81 <code><a href="#delete">delete(projectName, zone, resourceViewName)</a></code></p>
82<p class="firstline">Delete a resource view.</p>
83<p class="toc_element">
84 <code><a href="#get">get(projectName, zone, resourceViewName)</a></code></p>
85<p class="firstline">Get the information of a zonal resource view.</p>
86<p class="toc_element">
87 <code><a href="#insert">insert(projectName, zone, body)</a></code></p>
88<p class="firstline">Create a resource view.</p>
89<p class="toc_element">
90 <code><a href="#list">list(projectName, zone, pageToken=None, maxResults=None)</a></code></p>
91<p class="firstline">List resource views.</p>
92<p class="toc_element">
93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
94<p class="firstline">Retrieves the next page of results.</p>
95<p class="toc_element">
96 <code><a href="#listresources">listresources(projectName, zone, resourceViewName, pageToken=None, maxResults=None)</a></code></p>
97<p class="firstline">List the resources of the resource view.</p>
98<p class="toc_element">
99 <code><a href="#listresources_next">listresources_next(previous_request, previous_response)</a></code></p>
100<p class="firstline">Retrieves the next page of results.</p>
101<p class="toc_element">
102 <code><a href="#removeresources">removeresources(projectName, zone, resourceViewName, body)</a></code></p>
103<p class="firstline">Remove resources from the view.</p>
104<h3>Method Details</h3>
105<div class="method">
106 <code class="details" id="addresources">addresources(projectName, zone, resourceViewName, body)</code>
107 <pre>Add resources to the view.
108
109Args:
110 projectName: string, The project name of the resource view. (required)
111 zone: string, The zone name of the resource view. (required)
112 resourceViewName: string, The name of the resource view. (required)
113 body: object, The request body. (required)
114 The object takes the form of:
115
116{ # The request to add resources to the resource view.
117 "resources": [ # The list of resources to be added.
118 "A String",
119 ],
120 }
121
122</pre>
123</div>
124
125<div class="method">
126 <code class="details" id="delete">delete(projectName, zone, resourceViewName)</code>
127 <pre>Delete a resource view.
128
129Args:
130 projectName: string, The project name of the resource view. (required)
131 zone: string, The zone name of the resource view. (required)
132 resourceViewName: string, The name of the resource view. (required)
133</pre>
134</div>
135
136<div class="method">
137 <code class="details" id="get">get(projectName, zone, resourceViewName)</code>
138 <pre>Get the information of a zonal resource view.
139
140Args:
141 projectName: string, The project name of the resource view. (required)
142 zone: string, The zone name of the resource view. (required)
143 resourceViewName: string, The name of the resource view. (required)
144
145Returns:
146 An object of the form:
147
148 { # The resource view object.
149 "kind": "resourceviews#resourceView", # Type of the resource.
150 "numMembers": 42, # The total number of resources in the resource view.
151 "description": "A String", # The detailed description of the resource view.
152 "lastModified": "A String", # The last modified time of the view. Not supported yet.
153 "labels": [ # The labels for events.
154 { # The Label to be applied to the resource views.
155 "value": "A String", # Value of the label.
156 "key": "A String", # Key of the label.
157 },
158 ],
159 "creationTime": "A String", # The creation time of the resource view.
160 "members": [ # A list of all resources in the resource view.
161 "A String",
162 ],
163 "id": "A String", # [Output Only] The ID of the resource view.
164 "selfLink": "A String", # [Output Only] A self-link to the resource view.
165 "name": "A String", # The name of the resource view.
166 }</pre>
167</div>
168
169<div class="method">
170 <code class="details" id="insert">insert(projectName, zone, body)</code>
171 <pre>Create a resource view.
172
173Args:
174 projectName: string, The project name of the resource view. (required)
175 zone: string, The zone name of the resource view. (required)
176 body: object, The request body. (required)
177 The object takes the form of:
178
179{ # The resource view object.
180 "kind": "resourceviews#resourceView", # Type of the resource.
181 "numMembers": 42, # The total number of resources in the resource view.
182 "description": "A String", # The detailed description of the resource view.
183 "lastModified": "A String", # The last modified time of the view. Not supported yet.
184 "labels": [ # The labels for events.
185 { # The Label to be applied to the resource views.
186 "value": "A String", # Value of the label.
187 "key": "A String", # Key of the label.
188 },
189 ],
190 "creationTime": "A String", # The creation time of the resource view.
191 "members": [ # A list of all resources in the resource view.
192 "A String",
193 ],
194 "id": "A String", # [Output Only] The ID of the resource view.
195 "selfLink": "A String", # [Output Only] A self-link to the resource view.
196 "name": "A String", # The name of the resource view.
197 }
198
199
200Returns:
201 An object of the form:
202
203 { # The response to an insert request.
204 "resource": { # The resource view object. # The resource view object that has been inserted.
205 "kind": "resourceviews#resourceView", # Type of the resource.
206 "numMembers": 42, # The total number of resources in the resource view.
207 "description": "A String", # The detailed description of the resource view.
208 "lastModified": "A String", # The last modified time of the view. Not supported yet.
209 "labels": [ # The labels for events.
210 { # The Label to be applied to the resource views.
211 "value": "A String", # Value of the label.
212 "key": "A String", # Key of the label.
213 },
214 ],
215 "creationTime": "A String", # The creation time of the resource view.
216 "members": [ # A list of all resources in the resource view.
217 "A String",
218 ],
219 "id": "A String", # [Output Only] The ID of the resource view.
220 "selfLink": "A String", # [Output Only] A self-link to the resource view.
221 "name": "A String", # The name of the resource view.
222 },
223 }</pre>
224</div>
225
226<div class="method">
227 <code class="details" id="list">list(projectName, zone, pageToken=None, maxResults=None)</code>
228 <pre>List resource views.
229
230Args:
231 projectName: string, The project name of the resource view. (required)
232 zone: string, The zone name of the resource view. (required)
233 pageToken: string, Specifies a nextPageToken returned by a previous list request. This token can be used to request the next page of results from a previous list request.
234 maxResults: integer, Maximum count of results to be returned. Acceptable values are 0 to 5000, inclusive. (Default: 5000)
235
236Returns:
237 An object of the form:
238
239 { # The response to a list request.
240 "nextPageToken": "A String", # A token used for pagination.
241 "resourceViews": [ # The result that contains all resource views that meet the criteria.
242 { # The resource view object.
243 "kind": "resourceviews#resourceView", # Type of the resource.
244 "numMembers": 42, # The total number of resources in the resource view.
245 "description": "A String", # The detailed description of the resource view.
246 "lastModified": "A String", # The last modified time of the view. Not supported yet.
247 "labels": [ # The labels for events.
248 { # The Label to be applied to the resource views.
249 "value": "A String", # Value of the label.
250 "key": "A String", # Key of the label.
251 },
252 ],
253 "creationTime": "A String", # The creation time of the resource view.
254 "members": [ # A list of all resources in the resource view.
255 "A String",
256 ],
257 "id": "A String", # [Output Only] The ID of the resource view.
258 "selfLink": "A String", # [Output Only] A self-link to the resource view.
259 "name": "A String", # The name of the resource view.
260 },
261 ],
262 }</pre>
263</div>
264
265<div class="method">
266 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
267 <pre>Retrieves the next page of results.
268
269Args:
270 previous_request: The request for the previous page. (required)
271 previous_response: The response from the request for the previous page. (required)
272
273Returns:
274 A request object that you can call 'execute()' on to request the next
275 page. Returns None if there are no more items in the collection.
276 </pre>
277</div>
278
279<div class="method">
280 <code class="details" id="listresources">listresources(projectName, zone, resourceViewName, pageToken=None, maxResults=None)</code>
281 <pre>List the resources of the resource view.
282
283Args:
284 projectName: string, The project name of the resource view. (required)
285 zone: string, The zone name of the resource view. (required)
286 resourceViewName: string, The name of the resource view. (required)
287 pageToken: string, Specifies a nextPageToken returned by a previous list request. This token can be used to request the next page of results from a previous list request.
288 maxResults: integer, Maximum count of results to be returned. Acceptable values are 0 to 5000, inclusive. (Default: 5000)
289
290Returns:
291 An object of the form:
292
293 { # The response to a list resource request.
294 "nextPageToken": "A String", # A token used for pagination.
295 "members": [ # The full URL of resources in the view.
296 "A String",
297 ],
298 }</pre>
299</div>
300
301<div class="method">
302 <code class="details" id="listresources_next">listresources_next(previous_request, previous_response)</code>
303 <pre>Retrieves the next page of results.
304
305Args:
306 previous_request: The request for the previous page. (required)
307 previous_response: The response from the request for the previous page. (required)
308
309Returns:
310 A request object that you can call 'execute()' on to request the next
311 page. Returns None if there are no more items in the collection.
312 </pre>
313</div>
314
315<div class="method">
316 <code class="details" id="removeresources">removeresources(projectName, zone, resourceViewName, body)</code>
317 <pre>Remove resources from the view.
318
319Args:
320 projectName: string, The project name of the resource view. (required)
321 zone: string, The zone name of the resource view. (required)
322 resourceViewName: string, The name of the resource view. (required)
323 body: object, The request body. (required)
324 The object takes the form of:
325
326{ # The request to remove resources from the resource view.
327 "resources": [ # The list of resources to be removed.
328 "A String",
329 ],
330 }
331
332</pre>
333</div>
334
335</body></html>