Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / compute_alpha.targetInstances.html
blob: 0f9ae8488f6249a83db3b605a584f6c09b4f47b5 [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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]78 <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, returnPartialSuccess=None, filter=None, includeAllScopes=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]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>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]88<p class="firstline">Returns the specified TargetInstance resource. Gets a list of available target instances by making a list() request.</p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]89<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]90 <code><a href="#insert">insert(project, zone, body=None, 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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]93 <code><a href="#list">list(project, zone, orderBy=None, pageToken=None, maxResults=None, returnPartialSuccess=None, filter=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]99 <code><a href="#testIamPermissions">testIamPermissions(project, zone, resource, body=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]100<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
101<h3>Method Details</h3>
102<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]103 <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, returnPartialSuccess=None, filter=None, includeAllScopes=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]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
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]111
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]112Currently, only sorting by `name` or `creationTimestamp desc` is supported.
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`)
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 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.
116 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `&gt;`, or `&lt;`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]117
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]118For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]119
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]120You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]121
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]122To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```
123 includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]130 "kind": "compute#targetInstanceAggregatedList", # Type of resource.
131 "items": { # A list of TargetInstance resources.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]132 "a_key": { # Name of the scope containing this set of target instances.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]133 "targetInstances": [ # A list of target instances contained in this scope.
134 { # Represents a Target Instance resource.
135 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]136 # You can use a target instance to handle traffic for one or more forwarding rules, which is ideal for forwarding protocol traffic that is managed by a single source. For example, ESP, AH, TCP, or UDP. For more information, read Target instances. (== resource_for {$api_version}.targetInstances ==)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]137 "kind": "compute#targetInstance", # [Output Only] The type of the resource. Always compute#targetInstance for target instances.
138 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]139 "zone": "A String", # [Output Only] URL of the zone where the target instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]140 "natPolicy": "A String", # NAT option controlling how IPs are NAT'ed to the instance. Currently only NO_NAT (default value) is supported.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]141 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]142 "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:
143 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance
144 # - projects/project/zones/zone/instances/instance
145 # - zones/zone/instances/instance
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]146 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]147 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
148 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]149 "network": "A String", # The URL of the network this target instance uses to forward traffic. If not specified, the traffic will be forwarded to the network that the default network interface belongs to.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]150 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]151 },
152 ],
153 "warning": { # Informational warning which replaces the list of addresses when the list is empty.
154 "message": "A String", # [Output Only] A human-readable description of the warning code.
155 "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.
156 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
157 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
158 {
159 "value": "A String", # [Output Only] A warning data value corresponding to the key.
160 "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).
161 },
162 ],
163 },
164 },
165 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]166 "warning": { # [Output Only] Informational warning message.
167 "message": "A String", # [Output Only] A human-readable description of the warning code.
168 "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.
169 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
170 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
171 {
172 "value": "A String", # [Output Only] A warning data value corresponding to the key.
173 "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).
174 },
175 ],
176 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]177 "unreachables": [ # [Output Only] Unreachable resources.
178 "A String",
179 ],
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]180 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
181 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
182 }</pre>
183</div>
184
185<div class="method">
186 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>
187 <pre>Retrieves the next page of results.
188
189Args:
190 previous_request: The request for the previous page. (required)
191 previous_response: The response from the request for the previous page. (required)
192
193Returns:
194 A request object that you can call 'execute()' on to request the next
195 page. Returns None if there are no more items in the collection.
196 </pre>
197</div>
198
199<div class="method">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]200 <code class="details" id="delete">delete(project, zone, targetInstance, requestId=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]201 <pre>Deletes the specified TargetInstance resource.
202
203Args:
204 project: string, Project ID for this request. (required)
205 zone: string, Name of the zone scoping this request. (required)
206 targetInstance: string, Name of the TargetInstance resource to delete. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]207 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
208
209For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
210
211The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]212
213Returns:
214 An object of the form:
215
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]216 { # Represents an Operation resource.
217 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]218 # Google Compute Engine has three Operation resources:
219 #
220 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
221 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]222 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
223 #
224 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]225 # - For global operations, use the `globalOperations` resource.
226 # - For regional operations, use the `regionOperations` resource.
227 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]228 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]229 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]230 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]231 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]232 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]233 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]234 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]235 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]236 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
237 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]238 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]239 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]240 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]241 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]242 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
243 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
244 {
245 "message": "A String", # [Output Only] A human-readable description of the warning code.
246 "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.
247 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
248 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
249 {
250 "value": "A String", # [Output Only] A warning data value corresponding to the key.
251 "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).
252 },
253 ],
254 },
255 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]256 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]257 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]258 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]259 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
260 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]261 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]262 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
263 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
264 {
265 "message": "A String", # [Output Only] An optional, human-readable error message.
266 "code": "A String", # [Output Only] The error type identifier for this error.
267 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
268 },
269 ],
270 },
271 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
272 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]273 "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]274 }</pre>
275</div>
276
277<div class="method">
278 <code class="details" id="get">get(project, zone, targetInstance)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]279 <pre>Returns the specified TargetInstance resource. Gets a list of available target instances by making a list() request.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]280
281Args:
282 project: string, Project ID for this request. (required)
283 zone: string, Name of the zone scoping this request. (required)
284 targetInstance: string, Name of the TargetInstance resource to return. (required)
285
286Returns:
287 An object of the form:
288
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]289 { # Represents a Target Instance resource.
290 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]291 # You can use a target instance to handle traffic for one or more forwarding rules, which is ideal for forwarding protocol traffic that is managed by a single source. For example, ESP, AH, TCP, or UDP. For more information, read Target instances. (== resource_for {$api_version}.targetInstances ==)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]292 "kind": "compute#targetInstance", # [Output Only] The type of the resource. Always compute#targetInstance for target instances.
293 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]294 "zone": "A String", # [Output Only] URL of the zone where the target instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]295 "natPolicy": "A String", # NAT option controlling how IPs are NAT'ed to the instance. Currently only NO_NAT (default value) is supported.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]296 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]297 "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:
298 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance
299 # - projects/project/zones/zone/instances/instance
300 # - zones/zone/instances/instance
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]301 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]302 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
303 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]304 "network": "A String", # The URL of the network this target instance uses to forward traffic. If not specified, the traffic will be forwarded to the network that the default network interface belongs to.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]305 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]306 }</pre>
307</div>
308
309<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]310 <code class="details" id="insert">insert(project, zone, body=None, requestId=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]311 <pre>Creates a TargetInstance resource in the specified project and zone using the data included in the request.
312
313Args:
314 project: string, Project ID for this request. (required)
315 zone: string, Name of the zone scoping this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]316 body: object, The request body.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]317 The object takes the form of:
318
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]319{ # Represents a Target Instance resource.
320 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]321 # You can use a target instance to handle traffic for one or more forwarding rules, which is ideal for forwarding protocol traffic that is managed by a single source. For example, ESP, AH, TCP, or UDP. For more information, read Target instances. (== resource_for {$api_version}.targetInstances ==)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]322 "kind": "compute#targetInstance", # [Output Only] The type of the resource. Always compute#targetInstance for target instances.
323 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]324 "zone": "A String", # [Output Only] URL of the zone where the target instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]325 "natPolicy": "A String", # NAT option controlling how IPs are NAT'ed to the instance. Currently only NO_NAT (default value) is supported.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]326 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]327 "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:
328 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance
329 # - projects/project/zones/zone/instances/instance
330 # - zones/zone/instances/instance
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]331 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]332 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
333 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]334 "network": "A String", # The URL of the network this target instance uses to forward traffic. If not specified, the traffic will be forwarded to the network that the default network interface belongs to.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]335 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]336 }
337
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]338 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
339
340For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
341
342The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]343
344Returns:
345 An object of the form:
346
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]347 { # Represents an Operation resource.
348 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]349 # Google Compute Engine has three Operation resources:
350 #
351 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
352 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]353 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
354 #
355 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]356 # - For global operations, use the `globalOperations` resource.
357 # - For regional operations, use the `regionOperations` resource.
358 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]359 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]360 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]361 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]362 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]363 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]364 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]365 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]366 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]367 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
368 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]369 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]370 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]371 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]372 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]373 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
374 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
375 {
376 "message": "A String", # [Output Only] A human-readable description of the warning code.
377 "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.
378 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
379 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
380 {
381 "value": "A String", # [Output Only] A warning data value corresponding to the key.
382 "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).
383 },
384 ],
385 },
386 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]387 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]388 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]389 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]390 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
391 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]392 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]393 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
394 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
395 {
396 "message": "A String", # [Output Only] An optional, human-readable error message.
397 "code": "A String", # [Output Only] The error type identifier for this error.
398 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
399 },
400 ],
401 },
402 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
403 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]404 "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]405 }</pre>
406</div>
407
408<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]409 <code class="details" id="list">list(project, zone, orderBy=None, pageToken=None, maxResults=None, returnPartialSuccess=None, filter=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]410 <pre>Retrieves a list of TargetInstance resources available to the specified project and zone.
411
412Args:
413 project: string, Project ID for this request. (required)
414 zone: string, Name of the zone scoping this request. (required)
415 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
416
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]417You 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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]418
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]419Currently, only sorting by `name` or `creationTimestamp desc` is supported.
420 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.
421 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`)
422 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.
423 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `&gt;`, or `&lt;`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]424
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]425For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]426
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]427You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]428
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]429To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]430
431Returns:
432 An object of the form:
433
434 { # Contains a list of TargetInstance resources.
435 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]436 "kind": "compute#targetInstanceList", # Type of resource.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]437 "items": [ # A list of TargetInstance resources.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]438 { # Represents a Target Instance resource.
439 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]440 # You can use a target instance to handle traffic for one or more forwarding rules, which is ideal for forwarding protocol traffic that is managed by a single source. For example, ESP, AH, TCP, or UDP. For more information, read Target instances. (== resource_for {$api_version}.targetInstances ==)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]441 "kind": "compute#targetInstance", # [Output Only] The type of the resource. Always compute#targetInstance for target instances.
442 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]443 "zone": "A String", # [Output Only] URL of the zone where the target instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]444 "natPolicy": "A String", # NAT option controlling how IPs are NAT'ed to the instance. Currently only NO_NAT (default value) is supported.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]445 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]446 "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:
447 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance
448 # - projects/project/zones/zone/instances/instance
449 # - zones/zone/instances/instance
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]450 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]451 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
452 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]453 "network": "A String", # The URL of the network this target instance uses to forward traffic. If not specified, the traffic will be forwarded to the network that the default network interface belongs to.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]454 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]455 },
456 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]457 "warning": { # [Output Only] Informational warning message.
458 "message": "A String", # [Output Only] A human-readable description of the warning code.
459 "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.
460 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
461 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
462 {
463 "value": "A String", # [Output Only] A warning data value corresponding to the key.
464 "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).
465 },
466 ],
467 },
468 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]469 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
470 }</pre>
471</div>
472
473<div class="method">
474 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
475 <pre>Retrieves the next page of results.
476
477Args:
478 previous_request: The request for the previous page. (required)
479 previous_response: The response from the request for the previous page. (required)
480
481Returns:
482 A request object that you can call 'execute()' on to request the next
483 page. Returns None if there are no more items in the collection.
484 </pre>
485</div>
486
487<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]488 <code class="details" id="testIamPermissions">testIamPermissions(project, zone, resource, body=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]489 <pre>Returns permissions that a caller has on the specified resource.
490
491Args:
492 project: string, Project ID for this request. (required)
493 zone: string, The name of the zone for this request. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]494 resource: string, Name or id of the resource for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]495 body: object, The request body.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]496 The object takes the form of:
497
498{
499 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
500 "A String",
501 ],
502 }
503
504
505Returns:
506 An object of the form:
507
508 {
509 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
510 "A String",
511 ],
512 }</pre>
513</div>
514
515</body></html>