Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 692617a6eea5e47e71e221c9e73f5f2d5534e3bf / . / docs / dyn / compute_v1.targetInstances.html
blob: b89ef3d36af7945b46fb6ac472adcfaa6ea844cd [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">
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]78 <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]79<p class="firstline">Retrieves an aggregated list of target instances.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]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>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]88<p class="firstline">Returns the specified TargetInstance resource. Get a list of available target instances by making a list() request.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]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">
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]93 <code><a href="#list">list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]94<p class="firstline">Retrieves a list of TargetInstance resources available to the specified project and zone.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]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">
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]100 <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]101 <pre>Retrieves an aggregated list of target instances.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]102
103Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]104 project: string, Project ID for this request. (required)
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]105 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
106
107You 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.
108
109Currently, only sorting by name or creationTimestamp desc is supported.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]110 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.
111 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.
112 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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]113
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]114The 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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]115
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]116For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]117
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]118You 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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]119
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]120To 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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]121
122Returns:
123 An object of the form:
124
125 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]126 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]127 "items": { # A map of scoped target instance lists.
128 "a_key": { # Name of the scope containing this set of target instances.
129 "targetInstances": [ # List of target instances contained in this scope.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]130 { # A TargetInstance resource. This resource defines an endpoint instance that terminates traffic of certain protocols.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]131 "kind": "compute#targetInstance", # [Output Only] The type of the resource. Always compute#targetInstance for target instances.
132 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]133 "zone": "A String", # [Output Only] URL of the zone where the target instance resides.
134 "natPolicy": "A String", # NAT option controlling how IPs are NAT'ed to the instance. Currently only NO_NAT (default value) is supported.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]135 "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:
136 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance
137 # - projects/project/zones/zone/instances/instance
138 # - zones/zone/instances/instance
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]139 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]140 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]141 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
142 "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]143 },
144 ],
145 "warning": { # Informational warning which replaces the list of addresses when the list is empty.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]146 "message": "A String", # [Output Only] A human-readable description of the warning code.
147 "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.
148 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
149 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]150 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]151 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]152 "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).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]153 },
154 ],
155 },
156 },
157 },
158 "kind": "compute#targetInstanceAggregatedList", # Type of resource.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]159 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
160 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]161 }</pre>
162</div>
163
164<div class="method">
165 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>
166 <pre>Retrieves the next page of results.
167
168Args:
169 previous_request: The request for the previous page. (required)
170 previous_response: The response from the request for the previous page. (required)
171
172Returns:
173 A request object that you can call 'execute()' on to request the next
174 page. Returns None if there are no more items in the collection.
175 </pre>
176</div>
177
178<div class="method">
179 <code class="details" id="delete">delete(project, zone, targetInstance)</code>
180 <pre>Deletes the specified TargetInstance resource.
181
182Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]183 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]184 zone: string, Name of the zone scoping this request. (required)
185 targetInstance: string, Name of the TargetInstance resource to delete. (required)
186
187Returns:
188 An object of the form:
189
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]190 { # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]191 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
192 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]193 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]194 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
195 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
196 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
197 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]198 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]199 "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.
200 "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.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]201 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]202 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
203 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]204 "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]205 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]206 "message": "A String", # [Output Only] A human-readable description of the warning code.
207 "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.
208 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
209 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]210 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]211 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]212 "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).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]213 },
214 ],
215 },
216 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]217 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]218 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
219 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]220 "name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]221 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]222 "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]223 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]224 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]225 "message": "A String", # [Output Only] An optional, human-readable error message.
226 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]227 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]228 },
229 ],
230 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]231 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]232 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]233 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]234 }</pre>
235</div>
236
237<div class="method">
238 <code class="details" id="get">get(project, zone, targetInstance)</code>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]239 <pre>Returns the specified TargetInstance resource. Get a list of available target instances by making a list() request.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]240
241Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]242 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]243 zone: string, Name of the zone scoping this request. (required)
244 targetInstance: string, Name of the TargetInstance resource to return. (required)
245
246Returns:
247 An object of the form:
248
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]249 { # A TargetInstance resource. This resource defines an endpoint instance that terminates traffic of certain protocols.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]250 "kind": "compute#targetInstance", # [Output Only] The type of the resource. Always compute#targetInstance for target instances.
251 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]252 "zone": "A String", # [Output Only] URL of the zone where the target instance resides.
253 "natPolicy": "A String", # NAT option controlling how IPs are NAT'ed to the instance. Currently only NO_NAT (default value) is supported.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]254 "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:
255 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance
256 # - projects/project/zones/zone/instances/instance
257 # - zones/zone/instances/instance
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]258 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]259 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]260 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
261 "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]262 }</pre>
263</div>
264
265<div class="method">
266 <code class="details" id="insert">insert(project, zone, body)</code>
267 <pre>Creates a TargetInstance resource in the specified project and zone using the data included in the request.
268
269Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]270 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]271 zone: string, Name of the zone scoping this request. (required)
272 body: object, The request body. (required)
273 The object takes the form of:
274
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]275{ # A TargetInstance resource. This resource defines an endpoint instance that terminates traffic of certain protocols.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]276 "kind": "compute#targetInstance", # [Output Only] The type of the resource. Always compute#targetInstance for target instances.
277 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]278 "zone": "A String", # [Output Only] URL of the zone where the target instance resides.
279 "natPolicy": "A String", # NAT option controlling how IPs are NAT'ed to the instance. Currently only NO_NAT (default value) is supported.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]280 "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:
281 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance
282 # - projects/project/zones/zone/instances/instance
283 # - zones/zone/instances/instance
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]284 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]285 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is 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.
287 "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]288 }
289
290
291Returns:
292 An object of the form:
293
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]294 { # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]295 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
296 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]297 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]298 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
299 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
300 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
301 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]302 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]303 "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.
304 "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.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]305 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]306 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
307 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]308 "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]309 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]310 "message": "A String", # [Output Only] A human-readable description of the warning code.
311 "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.
312 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
313 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]314 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]315 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]316 "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).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]317 },
318 ],
319 },
320 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]321 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]322 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
323 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]324 "name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]325 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]326 "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]327 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]328 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]329 "message": "A String", # [Output Only] An optional, human-readable error message.
330 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]331 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]332 },
333 ],
334 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]335 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]336 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]337 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]338 }</pre>
339</div>
340
341<div class="method">
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]342 <code class="details" id="list">list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]343 <pre>Retrieves a list of TargetInstance resources available to the specified project and zone.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]344
345Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]346 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]347 zone: string, Name of the zone scoping this request. (required)
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]348 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
349
350You 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.
351
352Currently, only sorting by name or creationTimestamp desc is supported.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]353 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.
354 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.
355 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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]356
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]357The 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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]358
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]359For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]360
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]361You 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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]362
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]363To 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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]364
365Returns:
366 An object of the form:
367
368 { # Contains a list of TargetInstance resources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]369 "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.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]370 "items": [ # A list of TargetInstance resources.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]371 { # A TargetInstance resource. This resource defines an endpoint instance that terminates traffic of certain protocols.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]372 "kind": "compute#targetInstance", # [Output Only] The type of the resource. Always compute#targetInstance for target instances.
373 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]374 "zone": "A String", # [Output Only] URL of the zone where the target instance resides.
375 "natPolicy": "A String", # NAT option controlling how IPs are NAT'ed to the instance. Currently only NO_NAT (default value) is supported.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]376 "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:
377 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance
378 # - projects/project/zones/zone/instances/instance
379 # - zones/zone/instances/instance
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]380 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]381 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]382 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
383 "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]384 },
385 ],
386 "kind": "compute#targetInstanceList", # Type of resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]387 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]388 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]389 }</pre>
390</div>
391
392<div class="method">
393 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
394 <pre>Retrieves the next page of results.
395
396Args:
397 previous_request: The request for the previous page. (required)
398 previous_response: The response from the request for the previous page. (required)
399
400Returns:
401 A request object that you can call 'execute()' on to request the next
402 page. Returns None if there are no more items in the collection.
403 </pre>
404</div>
405
406</body></html>