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