Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 64b25041f06b049f122bff3b67b7e0ca691fbb52 / . / docs / dyn / compute_v1.addresses.html
blob: ad6e877e0d0f04d1cfb02f1c199b281ca6baeb50 [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -0400[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="compute_v1.html">Compute Engine API</a> . <a href="compute_v1.addresses.html">addresses</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#aggregatedList">aggregatedList(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
79<p class="firstline">Retrieves the list of addresses grouped by scope.</p>
80<p class="toc_element">
81 <code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p>
82<p class="firstline">Retrieves the next page of results.</p>
83<p class="toc_element">
84 <code><a href="#delete">delete(project, region, address)</a></code></p>
85<p class="firstline">Deletes the specified address resource.</p>
86<p class="toc_element">
87 <code><a href="#get">get(project, region, address)</a></code></p>
88<p class="firstline">Returns the specified address resource.</p>
89<p class="toc_element">
90 <code><a href="#insert">insert(project, region, body)</a></code></p>
91<p class="firstline">Creates an address resource in the specified project using the data included in the request.</p>
92<p class="toc_element">
93 <code><a href="#list">list(project, region, maxResults=None, pageToken=None, filter=None)</a></code></p>
94<p class="firstline">Retrieves the list of address resources contained within the specified region.</p>
95<p class="toc_element">
96 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
97<p class="firstline">Retrieves the next page of results.</p>
98<h3>Method Details</h3>
99<div class="method">
100 <code class="details" id="aggregatedList">aggregatedList(project, maxResults=None, pageToken=None, filter=None)</code>
101 <pre>Retrieves the list of addresses grouped by scope.
102
103Args:
104 project: string, Name of the project scoping this request. (required)
105 maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
106 pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
107 filter: string, Optional. Filter expression for filtering listed resources.
108
109Returns:
110 An object of the form:
111
112 {
113 "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
114 "items": { # A map of scoped address lists.
115 "a_key": { # Name of the scope containing this set of addresses.
116 "warning": { # Informational warning which replaces the list of addresses when the list is empty.
117 "message": "A String", # Optional human-readable details for this warning.
118 "code": "A String", # The warning type identifier for this warning.
119 "data": [ # Metadata for this warning in 'key: value' format.
120 {
121 "value": "A String", # A warning data value corresponding to the key.
122 "key": "A String", # A key for the warning data.
123 },
124 ],
125 },
126 "addresses": [ # List of addresses contained in this scope.
127 { # A reserved address resource.
128 "status": "A String", # The status of the address (output only).
129 "kind": "compute#address", # Type of the resource.
130 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]131 "region": "A String", # URL of the region where the regional address resides (output only). This field is not applicable to global addresses.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]132 "address": "A String", # The IP address represented by this resource.
133 "users": [ # The resources that are using this address resource.
134 "A String",
135 ],
136 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
137 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
138 "selfLink": "A String", # Server defined URL for the resource (output only).
139 "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
140 },
141 ],
142 },
143 },
144 "kind": "compute#addressAggregatedList", # Type of resource.
145 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
146 "selfLink": "A String", # Server defined URL for this resource (output only).
147 }</pre>
148</div>
149
150<div class="method">
151 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>
152 <pre>Retrieves the next page of results.
153
154Args:
155 previous_request: The request for the previous page. (required)
156 previous_response: The response from the request for the previous page. (required)
157
158Returns:
159 A request object that you can call 'execute()' on to request the next
160 page. Returns None if there are no more items in the collection.
161 </pre>
162</div>
163
164<div class="method">
165 <code class="details" id="delete">delete(project, region, address)</code>
166 <pre>Deletes the specified address resource.
167
168Args:
169 project: string, Name of the project scoping this request. (required)
170 region: string, Name of the region scoping this request. (required)
171 address: string, Name of the address resource to delete. (required)
172
173Returns:
174 An object of the form:
175
176 { # An operation resource, used to manage asynchronous API requests.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]177 "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
178 "clientOperationId": "A String",
179 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
180 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
181 "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
182 "operationType": "A String",
183 "httpErrorMessage": "A String",
184 "progress": 42,
185 "httpErrorStatusCode": 42,
186 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
187 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
188 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
189 "warnings": [
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]190 {
191 "message": "A String", # Optional human-readable details for this warning.
192 "code": "A String", # The warning type identifier for this warning.
193 "data": [ # Metadata for this warning in 'key: value' format.
194 {
195 "value": "A String", # A warning data value corresponding to the key.
196 "key": "A String", # A key for the warning data.
197 },
198 ],
199 },
200 ],
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]201 "user": "A String",
202 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
203 "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
204 "name": "A String", # [Output Only] Name of the resource (output only).
205 "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
206 "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
207 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]208 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]209 "message": "A String", # [Output Only] An optional, human-readable error message.
210 "code": "A String", # [Output Only] The error type identifier for this error.
211 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]212 },
213 ],
214 },
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]215 "endTime": "A String",
216 "selfLink": "A String", # [Output Only] Server defined URL for the resource.
217 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]218 }</pre>
219</div>
220
221<div class="method">
222 <code class="details" id="get">get(project, region, address)</code>
223 <pre>Returns the specified address resource.
224
225Args:
226 project: string, Name of the project scoping this request. (required)
227 region: string, Name of the region scoping this request. (required)
228 address: string, Name of the address resource to return. (required)
229
230Returns:
231 An object of the form:
232
233 { # A reserved address resource.
234 "status": "A String", # The status of the address (output only).
235 "kind": "compute#address", # Type of the resource.
236 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]237 "region": "A String", # URL of the region where the regional address resides (output only). This field is not applicable to global addresses.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]238 "address": "A String", # The IP address represented by this resource.
239 "users": [ # The resources that are using this address resource.
240 "A String",
241 ],
242 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
243 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
244 "selfLink": "A String", # Server defined URL for the resource (output only).
245 "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
246 }</pre>
247</div>
248
249<div class="method">
250 <code class="details" id="insert">insert(project, region, body)</code>
251 <pre>Creates an address resource in the specified project using the data included in the request.
252
253Args:
254 project: string, Name of the project scoping this request. (required)
255 region: string, Name of the region scoping this request. (required)
256 body: object, The request body. (required)
257 The object takes the form of:
258
259{ # A reserved address resource.
260 "status": "A String", # The status of the address (output only).
261 "kind": "compute#address", # Type of the resource.
262 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]263 "region": "A String", # URL of the region where the regional address resides (output only). This field is not applicable to global addresses.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]264 "address": "A String", # The IP address represented by this resource.
265 "users": [ # The resources that are using this address resource.
266 "A String",
267 ],
268 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
269 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
270 "selfLink": "A String", # Server defined URL for the resource (output only).
271 "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
272 }
273
274
275Returns:
276 An object of the form:
277
278 { # An operation resource, used to manage asynchronous API requests.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]279 "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
280 "clientOperationId": "A String",
281 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
282 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
283 "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
284 "operationType": "A String",
285 "httpErrorMessage": "A String",
286 "progress": 42,
287 "httpErrorStatusCode": 42,
288 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
289 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
290 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
291 "warnings": [
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]292 {
293 "message": "A String", # Optional human-readable details for this warning.
294 "code": "A String", # The warning type identifier for this warning.
295 "data": [ # Metadata for this warning in 'key: value' format.
296 {
297 "value": "A String", # A warning data value corresponding to the key.
298 "key": "A String", # A key for the warning data.
299 },
300 ],
301 },
302 ],
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]303 "user": "A String",
304 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
305 "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
306 "name": "A String", # [Output Only] Name of the resource (output only).
307 "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
308 "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
309 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]310 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]311 "message": "A String", # [Output Only] An optional, human-readable error message.
312 "code": "A String", # [Output Only] The error type identifier for this error.
313 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]314 },
315 ],
316 },
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]317 "endTime": "A String",
318 "selfLink": "A String", # [Output Only] Server defined URL for the resource.
319 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]320 }</pre>
321</div>
322
323<div class="method">
324 <code class="details" id="list">list(project, region, maxResults=None, pageToken=None, filter=None)</code>
325 <pre>Retrieves the list of address resources contained within the specified region.
326
327Args:
328 project: string, Name of the project scoping this request. (required)
329 region: string, Name of the region scoping this request. (required)
330 maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
331 pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
332 filter: string, Optional. Filter expression for filtering listed resources.
333
334Returns:
335 An object of the form:
336
337 { # Contains a list of address resources.
338 "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]339 "items": [ # A list of Address resources.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]340 { # A reserved address resource.
341 "status": "A String", # The status of the address (output only).
342 "kind": "compute#address", # Type of the resource.
343 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]344 "region": "A String", # URL of the region where the regional address resides (output only). This field is not applicable to global addresses.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]345 "address": "A String", # The IP address represented by this resource.
346 "users": [ # The resources that are using this address resource.
347 "A String",
348 ],
349 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
350 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
351 "selfLink": "A String", # Server defined URL for the resource (output only).
352 "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
353 },
354 ],
355 "kind": "compute#addressList", # Type of resource.
356 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
357 "selfLink": "A String", # Server defined URL for the resource (output only).
358 }</pre>
359</div>
360
361<div class="method">
362 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
363 <pre>Retrieves the next page of results.
364
365Args:
366 previous_request: The request for the previous page. (required)
367 previous_response: The response from the request for the previous page. (required)
368
369Returns:
370 A request object that you can call 'execute()' on to request the next
371 page. Returns None if there are no more items in the collection.
372 </pre>
373</div>
374
375</body></html>