Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 065b5307fe180bfdd4a5d9af134b1c9a0a1d2aba / . / docs / dyn / compute_v1.globalAddresses.html
blob: a857d0e31060ba31bbccb1bd5fcceababbd13b16 [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="compute_v1.html">Compute Engine API</a> . <a href="compute_v1.globalAddresses.html">globalAddresses</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#delete">delete(project, address)</a></code></p>
79<p class="firstline">Deletes the specified address resource.</p>
80<p class="toc_element">
81 <code><a href="#get">get(project, address)</a></code></p>
82<p class="firstline">Returns the specified address resource.</p>
83<p class="toc_element">
84 <code><a href="#insert">insert(project, body)</a></code></p>
85<p class="firstline">Creates an address resource in the specified project using the data included in the request.</p>
86<p class="toc_element">
87 <code><a href="#list">list(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
88<p class="firstline">Retrieves the list of global address resources.</p>
89<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<h3>Method Details</h3>
93<div class="method">
94 <code class="details" id="delete">delete(project, address)</code>
95 <pre>Deletes the specified address resource.
96
97Args:
98 project: string, Name of the project scoping this request. (required)
99 address: string, Name of the address resource to delete. (required)
100
101Returns:
102 An object of the form:
103
104 { # An operation resource, used to manage asynchronous API requests.
105 "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
106 "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
107 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
108 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
109 "zone": "A String", # URL of the zone where the operation resides (output only).
110 "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
111 "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
112 "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
113 "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
114 "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
115 "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
116 "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
117 "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
118 {
119 "message": "A String", # Optional human-readable details for this warning.
120 "code": "A String", # The warning type identifier for this warning.
121 "data": [ # Metadata for this warning in 'key: value' format.
122 {
123 "value": "A String", # A warning data value corresponding to the key.
124 "key": "A String", # A key for the warning data.
125 },
126 ],
127 },
128 ],
129 "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
130 "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
131 "kind": "compute#operation", # Type of the resource.
132 "name": "A String", # Name of the resource (output only).
133 "region": "A String", # URL of the region where the operation resides (output only).
134 "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
135 "errors": [ # The array of errors encountered while processing this operation.
136 {
137 "message": "A String", # An optional, human-readable error message.
138 "code": "A String", # The error type identifier for this error.
139 "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
140 },
141 ],
142 },
143 "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
144 "selfLink": "A String", # Server defined URL for the resource (output only).
145 "targetLink": "A String", # URL of the resource the operation is mutating (output only).
146 }</pre>
147</div>
148
149<div class="method">
150 <code class="details" id="get">get(project, address)</code>
151 <pre>Returns the specified address resource.
152
153Args:
154 project: string, Name of the project scoping this request. (required)
155 address: string, Name of the address resource to return. (required)
156
157Returns:
158 An object of the form:
159
160 { # A reserved address resource.
161 "status": "A String", # The status of the address (output only).
162 "kind": "compute#address", # Type of the resource.
163 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
164 "region": "A String", # URL of the region where the regional address resides (output only). This field is not applicable to global addresses.
165 "address": "A String", # The IP address represented by this resource.
166 "users": [ # The resources that are using this address resource.
167 "A String",
168 ],
169 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
170 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
171 "selfLink": "A String", # Server defined URL for the resource (output only).
172 "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.
173 }</pre>
174</div>
175
176<div class="method">
177 <code class="details" id="insert">insert(project, body)</code>
178 <pre>Creates an address resource in the specified project using the data included in the request.
179
180Args:
181 project: string, Name of the project scoping this request. (required)
182 body: object, The request body. (required)
183 The object takes the form of:
184
185{ # A reserved address resource.
186 "status": "A String", # The status of the address (output only).
187 "kind": "compute#address", # Type of the resource.
188 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
189 "region": "A String", # URL of the region where the regional address resides (output only). This field is not applicable to global addresses.
190 "address": "A String", # The IP address represented by this resource.
191 "users": [ # The resources that are using this address resource.
192 "A String",
193 ],
194 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
195 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
196 "selfLink": "A String", # Server defined URL for the resource (output only).
197 "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.
198 }
199
200
201Returns:
202 An object of the form:
203
204 { # An operation resource, used to manage asynchronous API requests.
205 "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
206 "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
207 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
208 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
209 "zone": "A String", # URL of the zone where the operation resides (output only).
210 "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
211 "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
212 "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
213 "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
214 "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
215 "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
216 "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
217 "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
218 {
219 "message": "A String", # Optional human-readable details for this warning.
220 "code": "A String", # The warning type identifier for this warning.
221 "data": [ # Metadata for this warning in 'key: value' format.
222 {
223 "value": "A String", # A warning data value corresponding to the key.
224 "key": "A String", # A key for the warning data.
225 },
226 ],
227 },
228 ],
229 "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
230 "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
231 "kind": "compute#operation", # Type of the resource.
232 "name": "A String", # Name of the resource (output only).
233 "region": "A String", # URL of the region where the operation resides (output only).
234 "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
235 "errors": [ # The array of errors encountered while processing this operation.
236 {
237 "message": "A String", # An optional, human-readable error message.
238 "code": "A String", # The error type identifier for this error.
239 "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
240 },
241 ],
242 },
243 "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
244 "selfLink": "A String", # Server defined URL for the resource (output only).
245 "targetLink": "A String", # URL of the resource the operation is mutating (output only).
246 }</pre>
247</div>
248
249<div class="method">
250 <code class="details" id="list">list(project, maxResults=None, pageToken=None, filter=None)</code>
251 <pre>Retrieves the list of global address resources.
252
253Args:
254 project: string, Name of the project scoping this request. (required)
255 maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
256 pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
257 filter: string, Optional. Filter expression for filtering listed resources.
258
259Returns:
260 An object of the form:
261
262 { # Contains a list of address resources.
263 "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
264 "items": [ # The address resources.
265 { # A reserved address resource.
266 "status": "A String", # The status of the address (output only).
267 "kind": "compute#address", # Type of the resource.
268 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
269 "region": "A String", # URL of the region where the regional address resides (output only). This field is not applicable to global addresses.
270 "address": "A String", # The IP address represented by this resource.
271 "users": [ # The resources that are using this address resource.
272 "A String",
273 ],
274 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
275 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
276 "selfLink": "A String", # Server defined URL for the resource (output only).
277 "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.
278 },
279 ],
280 "kind": "compute#addressList", # Type of resource.
281 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
282 "selfLink": "A String", # Server defined URL for the resource (output only).
283 }</pre>
284</div>
285
286<div class="method">
287 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
288 <pre>Retrieves the next page of results.
289
290Args:
291 previous_request: The request for the previous page. (required)
292 previous_response: The response from the request for the previous page. (required)
293
294Returns:
295 A request object that you can call 'execute()' on to request the next
296 page. Returns None if there are no more items in the collection.
297 </pre>
298</div>
299
300</body></html>