Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 0669410c6b2c48884ae31671b9d710a9ff6346c6 / . / docs / dyn / compute_v1.globalAddresses.html
blob: 59b59d36d560d533fee2eb0fd5ace7bd124d9e9d [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:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]98 project: string, Project ID for this request. (required)
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]99 address: string, Name of the address resource to delete. (required)
100
101Returns:
102 An object of the form:
103
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]104 { # An Operation resource, used to manage asynchronous API requests.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]105 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]106 "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]107 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]108 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]109 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
110 "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
111 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]112 "progress": 42, # [Output Only] 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 monotonically increase as the operation progresses.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]113 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]114 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]115 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
116 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
117 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]118 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]119 "message": "A String", # [Output Only] Optional human-readable details for this warning.
120 "code": "A String", # [Output Only] The warning type identifier for this warning.
121 "data": [ # [Output Only] Metadata for this warning in key: value format.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]122 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]123 "value": "A String", # [Output Only] A warning data value corresponding to the key.
124 "key": "A String", # [Output Only] A key for the warning data.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]125 },
126 ],
127 },
128 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]129 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
130 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
131 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
132 "name": "A String", # [Output Only] Name of the resource.
133 "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
134 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]135 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]136 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]137 "message": "A String", # [Output Only] An optional, human-readable error message.
138 "code": "A String", # [Output Only] The error type identifier for this error.
139 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]140 },
141 ],
142 },
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]143 "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]144 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]145 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]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:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]154 project: string, Project ID for this request. (required)
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]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.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]161 "status": "A String", # [Output Only] The status of the address, which can be either IN_USE or RESERVED. An address that is RESERVED is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.
162 "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]163 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]164 "region": "A String", # [Output Only] URL of the region where the regional address resides. This field is not applicable to global addresses.
165 "address": "A String", # The static external IP address represented by this resource.
166 "users": [ # [Output Only] The URLs of the resources that are using this address.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]167 "A String",
168 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]169 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
170 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]171 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]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:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]181 project: string, Project ID for this request. (required)
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]182 body: object, The request body. (required)
183 The object takes the form of:
184
185{ # A reserved address resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]186 "status": "A String", # [Output Only] The status of the address, which can be either IN_USE or RESERVED. An address that is RESERVED is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.
187 "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]188 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]189 "region": "A String", # [Output Only] URL of the region where the regional address resides. This field is not applicable to global addresses.
190 "address": "A String", # The static external IP address represented by this resource.
191 "users": [ # [Output Only] The URLs of the resources that are using this address.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]192 "A String",
193 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]194 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
195 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]196 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]198 }
199
200
201Returns:
202 An object of the form:
203
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]204 { # An Operation resource, used to manage asynchronous API requests.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]205 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]206 "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]207 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]208 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]209 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
210 "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
211 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]212 "progress": 42, # [Output Only] 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 monotonically increase as the operation progresses.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]213 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]214 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]215 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
216 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
217 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]218 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]219 "message": "A String", # [Output Only] Optional human-readable details for this warning.
220 "code": "A String", # [Output Only] The warning type identifier for this warning.
221 "data": [ # [Output Only] Metadata for this warning in key: value format.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]222 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]223 "value": "A String", # [Output Only] A warning data value corresponding to the key.
224 "key": "A String", # [Output Only] A key for the warning data.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]225 },
226 ],
227 },
228 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]229 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
230 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
231 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
232 "name": "A String", # [Output Only] Name of the resource.
233 "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
234 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]235 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]236 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]237 "message": "A String", # [Output Only] An optional, human-readable error message.
238 "code": "A String", # [Output Only] The error type identifier for this error.
239 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]240 },
241 ],
242 },
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]243 "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]244 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]245 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]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:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]254 project: string, Project ID for this request. (required)
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]255 maxResults: integer, Maximum count of results to be returned.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]256 pageToken: string, Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.
257 filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.
258
259The FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
260
261For example, filter=name ne example-instance.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]262
263Returns:
264 An object of the form:
265
266 { # Contains a list of address resources.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]267 "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
268 "items": [ # [Output Only] A list of Address resources.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]269 { # A reserved address resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]270 "status": "A String", # [Output Only] The status of the address, which can be either IN_USE or RESERVED. An address that is RESERVED is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.
271 "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]272 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]273 "region": "A String", # [Output Only] URL of the region where the regional address resides. This field is not applicable to global addresses.
274 "address": "A String", # The static external IP address represented by this resource.
275 "users": [ # [Output Only] The URLs of the resources that are using this address.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]276 "A String",
277 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]278 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
279 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]280 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]281 "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]282 },
283 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]284 "kind": "compute#addressList", # [Output Only] Type of resource. Always compute#addressList for lists of addresses.
285 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]286 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]287 }</pre>
288</div>
289
290<div class="method">
291 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
292 <pre>Retrieves the next page of results.
293
294Args:
295 previous_request: The request for the previous page. (required)
296 previous_response: The response from the request for the previous page. (required)
297
298Returns:
299 A request object that you can call 'execute()' on to request the next
300 page. Returns None if there are no more items in the collection.
301 </pre>
302</div>
303
304</body></html>