Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / c30d2b5d4478b230246dcaaa9f1c533ca3304387 / . / docs / dyn / compute_alpha.targetInstances.html
blob: ed20b01fb1ac6f872e295af7af39f76fc253eaaa [file] [log] [blame]
Sai Cheemalapatidf613972016-10-21 13:59:49 -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_alpha.html">Compute Engine API</a> . <a href="compute_alpha.targetInstances.html">targetInstances</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
79<p class="firstline">Retrieves an aggregated list of target instances.</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">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]84 <code><a href="#delete">delete(project, zone, targetInstance, requestId=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]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. Get a list of available target instances by making a list() request.</p>
89<p class="toc_element">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]90 <code><a href="#insert">insert(project, zone, body, requestId=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]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, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
94<p class="firstline">Retrieves a 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<p class="toc_element">
99 <code><a href="#testIamPermissions">testIamPermissions(project, zone, resource, body)</a></code></p>
100<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
101<h3>Method Details</h3>
102<div class="method">
103 <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
104 <pre>Retrieves an aggregated list of target instances.
105
106Args:
107 project: string, Project ID for this request. (required)
108 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
109
110You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
111
112Currently, only sorting by name or creationTimestamp desc is supported.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]113 maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]114 pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
115 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.
116
117The 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 you are filtering by (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.
118
119For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
120
121You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
122
123To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
124
125Returns:
126 An object of the form:
127
128 {
129 "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
130 "items": { # A map of scoped target instance lists.
131 "a_key": { # Name of the scope containing this set of target instances.
132 "targetInstances": [ # List of target instances contained in this scope.
133 { # A TargetInstance resource. This resource defines an endpoint instance that terminates traffic of certain protocols.
134 "kind": "compute#targetInstance", # [Output Only] The type of the resource. Always compute#targetInstance for target instances.
135 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
136 "zone": "A String", # [Output Only] URL of the zone where the target instance resides.
137 "natPolicy": "A String", # NAT option controlling how IPs are NAT'ed to the instance. Currently only NO_NAT (default value) is supported.
138 "instance": "A String", # A URL to the virtual machine instance that handles traffic for this target instance. When creating a target instance, you can provide the fully-qualified URL or a valid partial URL to the desired virtual machine. For example, the following are all valid URLs:
139 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance
140 # - projects/project/zones/zone/instances/instance
141 # - zones/zone/instances/instance
142 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
143 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
144 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
145 "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.
146 },
147 ],
148 "warning": { # Informational warning which replaces the list of addresses when the list is empty.
149 "message": "A String", # [Output Only] A human-readable description of the warning code.
150 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
151 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
152 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
153 {
154 "value": "A String", # [Output Only] A warning data value corresponding to the key.
155 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
156 },
157 ],
158 },
159 },
160 },
161 "kind": "compute#targetInstanceAggregatedList", # Type of resource.
162 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
163 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
164 }</pre>
165</div>
166
167<div class="method">
168 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>
169 <pre>Retrieves the next page of results.
170
171Args:
172 previous_request: The request for the previous page. (required)
173 previous_response: The response from the request for the previous page. (required)
174
175Returns:
176 A request object that you can call 'execute()' on to request the next
177 page. Returns None if there are no more items in the collection.
178 </pre>
179</div>
180
181<div class="method">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]182 <code class="details" id="delete">delete(project, zone, targetInstance, requestId=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]183 <pre>Deletes the specified TargetInstance resource.
184
185Args:
186 project: string, Project ID for this request. (required)
187 zone: string, Name of the zone scoping this request. (required)
188 targetInstance: string, Name of the TargetInstance resource to delete. (required)
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]189 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]190
191Returns:
192 An object of the form:
193
194 { # An Operation resource, used to manage asynchronous API requests.
195 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
196 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]197 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]198 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
199 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
200 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
201 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
202 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
203 "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 when the operation will be complete. This number should monotonically increase as the operation progresses.
204 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
205 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
206 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
207 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
208 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
209 {
210 "message": "A String", # [Output Only] A human-readable description of the warning code.
211 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
212 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
213 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
214 {
215 "value": "A String", # [Output Only] A warning data value corresponding to the key.
216 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
217 },
218 ],
219 },
220 ],
221 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
222 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
223 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
224 "name": "A String", # [Output Only] Name of the resource.
225 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
226 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
227 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
228 {
229 "message": "A String", # [Output Only] An optional, human-readable error message.
230 "code": "A String", # [Output Only] The error type identifier for this error.
231 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
232 },
233 ],
234 },
235 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
236 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]237 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]238 }</pre>
239</div>
240
241<div class="method">
242 <code class="details" id="get">get(project, zone, targetInstance)</code>
243 <pre>Returns the specified TargetInstance resource. Get a list of available target instances by making a list() request.
244
245Args:
246 project: string, Project ID for this request. (required)
247 zone: string, Name of the zone scoping this request. (required)
248 targetInstance: string, Name of the TargetInstance resource to return. (required)
249
250Returns:
251 An object of the form:
252
253 { # A TargetInstance resource. This resource defines an endpoint instance that terminates traffic of certain protocols.
254 "kind": "compute#targetInstance", # [Output Only] The type of the resource. Always compute#targetInstance for target instances.
255 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
256 "zone": "A String", # [Output Only] URL of the zone where the target instance resides.
257 "natPolicy": "A String", # NAT option controlling how IPs are NAT'ed to the instance. Currently only NO_NAT (default value) is supported.
258 "instance": "A String", # A URL to the virtual machine instance that handles traffic for this target instance. When creating a target instance, you can provide the fully-qualified URL or a valid partial URL to the desired virtual machine. For example, the following are all valid URLs:
259 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance
260 # - projects/project/zones/zone/instances/instance
261 # - zones/zone/instances/instance
262 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
263 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
264 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
265 "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.
266 }</pre>
267</div>
268
269<div class="method">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]270 <code class="details" id="insert">insert(project, zone, body, requestId=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]271 <pre>Creates a TargetInstance resource in the specified project and zone using the data included in the request.
272
273Args:
274 project: string, Project ID for this request. (required)
275 zone: string, Name of the zone scoping this request. (required)
276 body: object, The request body. (required)
277 The object takes the form of:
278
279{ # A TargetInstance resource. This resource defines an endpoint instance that terminates traffic of certain protocols.
280 "kind": "compute#targetInstance", # [Output Only] The type of the resource. Always compute#targetInstance for target instances.
281 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
282 "zone": "A String", # [Output Only] URL of the zone where the target instance resides.
283 "natPolicy": "A String", # NAT option controlling how IPs are NAT'ed to the instance. Currently only NO_NAT (default value) is supported.
284 "instance": "A String", # A URL to the virtual machine instance that handles traffic for this target instance. When creating a target instance, you can provide the fully-qualified URL or a valid partial URL to the desired virtual machine. For example, the following are all valid URLs:
285 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance
286 # - projects/project/zones/zone/instances/instance
287 # - zones/zone/instances/instance
288 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
289 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
290 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
291 "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.
292 }
293
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]294 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]295
296Returns:
297 An object of the form:
298
299 { # An Operation resource, used to manage asynchronous API requests.
300 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
301 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]302 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]303 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
304 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
305 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
306 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
307 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
308 "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 when the operation will be complete. This number should monotonically increase as the operation progresses.
309 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
310 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
311 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
312 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
313 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
314 {
315 "message": "A String", # [Output Only] A human-readable description of the warning code.
316 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
317 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
318 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
319 {
320 "value": "A String", # [Output Only] A warning data value corresponding to the key.
321 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
322 },
323 ],
324 },
325 ],
326 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
327 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
328 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
329 "name": "A String", # [Output Only] Name of the resource.
330 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
331 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
332 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
333 {
334 "message": "A String", # [Output Only] An optional, human-readable error message.
335 "code": "A String", # [Output Only] The error type identifier for this error.
336 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
337 },
338 ],
339 },
340 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
341 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]342 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]343 }</pre>
344</div>
345
346<div class="method">
347 <code class="details" id="list">list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
348 <pre>Retrieves a list of TargetInstance resources available to the specified project and zone.
349
350Args:
351 project: string, Project ID for this request. (required)
352 zone: string, Name of the zone scoping this request. (required)
353 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
354
355You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
356
357Currently, only sorting by name or creationTimestamp desc is supported.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]358 maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]359 pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
360 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.
361
362The 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 you are filtering by (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.
363
364For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
365
366You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
367
368To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
369
370Returns:
371 An object of the form:
372
373 { # Contains a list of TargetInstance resources.
374 "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
375 "items": [ # A list of TargetInstance resources.
376 { # A TargetInstance resource. This resource defines an endpoint instance that terminates traffic of certain protocols.
377 "kind": "compute#targetInstance", # [Output Only] The type of the resource. Always compute#targetInstance for target instances.
378 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
379 "zone": "A String", # [Output Only] URL of the zone where the target instance resides.
380 "natPolicy": "A String", # NAT option controlling how IPs are NAT'ed to the instance. Currently only NO_NAT (default value) is supported.
381 "instance": "A String", # A URL to the virtual machine instance that handles traffic for this target instance. When creating a target instance, you can provide the fully-qualified URL or a valid partial URL to the desired virtual machine. For example, the following are all valid URLs:
382 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance
383 # - projects/project/zones/zone/instances/instance
384 # - zones/zone/instances/instance
385 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
386 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
387 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
388 "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.
389 },
390 ],
391 "kind": "compute#targetInstanceList", # Type of resource.
392 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
393 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
394 }</pre>
395</div>
396
397<div class="method">
398 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
399 <pre>Retrieves the next page of results.
400
401Args:
402 previous_request: The request for the previous page. (required)
403 previous_response: The response from the request for the previous page. (required)
404
405Returns:
406 A request object that you can call 'execute()' on to request the next
407 page. Returns None if there are no more items in the collection.
408 </pre>
409</div>
410
411<div class="method">
412 <code class="details" id="testIamPermissions">testIamPermissions(project, zone, resource, body)</code>
413 <pre>Returns permissions that a caller has on the specified resource.
414
415Args:
416 project: string, Project ID for this request. (required)
417 zone: string, The name of the zone for this request. (required)
418 resource: string, Name of the resource for this request. (required)
419 body: object, The request body. (required)
420 The object takes the form of:
421
422{
423 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
424 "A String",
425 ],
426 }
427
428
429Returns:
430 An object of the form:
431
432 {
433 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
434 "A String",
435 ],
436 }</pre>
437</div>
438
439</body></html>