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