blob: 75483921824d69ed4e3cd1f5c73cfd55b587b604 [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -04001<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.targetPools.html">targetPools</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070078 <code><a href="#addHealthCheck">addHealthCheck(project, region, targetPool, body=None, requestId=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -080079<p class="firstline">Adds health check URLs to a target pool.</p>
John Asmuth614db982014-04-24 15:46:26 -040080<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070081 <code><a href="#addInstance">addInstance(project, region, targetPool, body=None, requestId=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -080082<p class="firstline">Adds an instance to a target pool.</p>
John Asmuth614db982014-04-24 15:46:26 -040083<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070084 <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None, includeAllScopes=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -080085<p class="firstline">Retrieves an aggregated list of target pools.</p>
John Asmuth614db982014-04-24 15:46:26 -040086<p class="toc_element">
87 <code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p>
88<p class="firstline">Retrieves the next page of results.</p>
89<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070090 <code><a href="#delete">delete(project, region, targetPool, requestId=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -080091<p class="firstline">Deletes the specified target pool.</p>
John Asmuth614db982014-04-24 15:46:26 -040092<p class="toc_element">
93 <code><a href="#get">get(project, region, targetPool)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070094<p class="firstline">Returns the specified target pool. Gets a list of available target pools by making a list() request.</p>
John Asmuth614db982014-04-24 15:46:26 -040095<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070096 <code><a href="#getHealth">getHealth(project, region, targetPool, body=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -080097<p class="firstline">Gets the most recent health check results for each IP for the instance that is referenced by the given target pool.</p>
John Asmuth614db982014-04-24 15:46:26 -040098<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070099 <code><a href="#insert">insert(project, region, body=None, requestId=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800100<p class="firstline">Creates a target pool in the specified project and region using the data included in the request.</p>
John Asmuth614db982014-04-24 15:46:26 -0400101<p class="toc_element">
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700102 <code><a href="#list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800103<p class="firstline">Retrieves a list of target pools available to the specified project and region.</p>
John Asmuth614db982014-04-24 15:46:26 -0400104<p class="toc_element">
105 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
106<p class="firstline">Retrieves the next page of results.</p>
107<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700108 <code><a href="#removeHealthCheck">removeHealthCheck(project, region, targetPool, body=None, requestId=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800109<p class="firstline">Removes health check URL from a target pool.</p>
John Asmuth614db982014-04-24 15:46:26 -0400110<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700111 <code><a href="#removeInstance">removeInstance(project, region, targetPool, body=None, requestId=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800112<p class="firstline">Removes instance URL from a target pool.</p>
John Asmuth614db982014-04-24 15:46:26 -0400113<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700114 <code><a href="#setBackup">setBackup(project, region, targetPool, body=None, failoverRatio=None, requestId=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800115<p class="firstline">Changes a backup target pool's configurations.</p>
John Asmuth614db982014-04-24 15:46:26 -0400116<h3>Method Details</h3>
117<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700118 <code class="details" id="addHealthCheck">addHealthCheck(project, region, targetPool, body=None, requestId=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800119 <pre>Adds health check URLs to a target pool.
John Asmuth614db982014-04-24 15:46:26 -0400120
121Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800122 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400123 region: string, Name of the region scoping this request. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800124 targetPool: string, Name of the target pool to add a health check to. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700125 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400126 The object takes the form of:
127
128{
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400129 "healthChecks": [ # The HttpHealthCheck to add to the target pool.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800130 { # A full or valid partial URL to a health check. For example, the following are valid URLs:
131 # - https://www.googleapis.com/compute/beta/projects/project-id/global/httpHealthChecks/health-check
132 # - projects/project-id/global/httpHealthChecks/health-check
133 # - global/httpHealthChecks/health-check
John Asmuth614db982014-04-24 15:46:26 -0400134 "healthCheck": "A String",
135 },
136 ],
137 }
138
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700139 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.
140
141For 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.
142
143The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
John Asmuth614db982014-04-24 15:46:26 -0400144
145Returns:
146 An object of the form:
147
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700148 { # Represents an Operation resource.
149 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700150 # Google Compute Engine has three Operation resources:
151 #
152 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
153 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700154 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
155 #
156 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700157 # - For global operations, use the `globalOperations` resource.
158 # - For regional operations, use the `regionOperations` resource.
159 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700160 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700161 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800162 "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 -0700163 "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 -0400164 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700165 "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 -0700166 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800167 "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 -0700168 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
169 "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 -0800170 "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 -0700171 "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 -0800172 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700173 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800174 "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 +0000175 "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 -0400176 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800177 "message": "A String", # [Output Only] A human-readable description of the warning code.
178 "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.
179 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
180 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth614db982014-04-24 15:46:26 -0400181 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000182 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700183 "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 -0400184 },
185 ],
186 },
187 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700188 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800189 "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 -0700190 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
191 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700192 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000193 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citroe633be12015-03-02 13:40:36 -0800194 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400195 {
Craig Citroe633be12015-03-02 13:40:36 -0800196 "message": "A String", # [Output Only] An optional, human-readable error message.
197 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700198 "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 -0400199 },
200 ],
201 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800202 "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 -0700203 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800204 "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 -0400205 }</pre>
206</div>
207
208<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700209 <code class="details" id="addInstance">addInstance(project, region, targetPool, body=None, requestId=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800210 <pre>Adds an instance to a target pool.
John Asmuth614db982014-04-24 15:46:26 -0400211
212Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800213 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400214 region: string, Name of the region scoping this request. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800215 targetPool: string, Name of the TargetPool resource to add instances to. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700216 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400217 The object takes the form of:
218
219{
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800220 "instances": [ # A full or partial URL to an instance to add to this target pool. This can be a full or partial URL. For example, the following are valid URLs:
221 # - https://www.googleapis.com/compute/v1/projects/project-id/zones/zone/instances/instance-name
222 # - projects/project-id/zones/zone/instances/instance-name
223 # - zones/zone/instances/instance-name
John Asmuth614db982014-04-24 15:46:26 -0400224 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800225 "instance": "A String", # The URL for a specific instance.
John Asmuth614db982014-04-24 15:46:26 -0400226 },
227 ],
228 }
229
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700230 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.
231
232For 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.
233
234The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
John Asmuth614db982014-04-24 15:46:26 -0400235
236Returns:
237 An object of the form:
238
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700239 { # Represents an Operation resource.
240 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700241 # Google Compute Engine has three Operation resources:
242 #
243 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
244 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700245 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
246 #
247 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700248 # - For global operations, use the `globalOperations` resource.
249 # - For regional operations, use the `regionOperations` resource.
250 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700251 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700252 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800253 "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 -0700254 "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 -0400255 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700256 "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 -0700257 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800258 "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 -0700259 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
260 "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 -0800261 "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 -0700262 "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 -0800263 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700264 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800265 "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 +0000266 "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 -0400267 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800268 "message": "A String", # [Output Only] A human-readable description of the warning code.
269 "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.
270 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
271 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth614db982014-04-24 15:46:26 -0400272 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000273 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700274 "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 -0400275 },
276 ],
277 },
278 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700279 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800280 "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 -0700281 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
282 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700283 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000284 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citroe633be12015-03-02 13:40:36 -0800285 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400286 {
Craig Citroe633be12015-03-02 13:40:36 -0800287 "message": "A String", # [Output Only] An optional, human-readable error message.
288 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700289 "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 -0400290 },
291 ],
292 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800293 "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 -0700294 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800295 "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 -0400296 }</pre>
297</div>
298
299<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700300 <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None, includeAllScopes=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800301 <pre>Retrieves an aggregated list of target pools.
John Asmuth614db982014-04-24 15:46:26 -0400302
303Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800304 project: string, Project ID for this request. (required)
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700305 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
306
Dan O'Mearadd494642020-05-01 07:42:23 -0700307You 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 Cheemalapatiea3a5e12016-10-12 14:05:53 -0700308
Dan O'Mearadd494642020-05-01 07:42:23 -0700309Currently, only sorting by `name` or `creationTimestamp desc` is supported.
310 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`)
311 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.
312 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;`.
Takashi Matsuo06694102015-09-11 13:55:40 -0700313
Dan O'Mearadd494642020-05-01 07:42:23 -0700314For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
Takashi Matsuo06694102015-09-11 13:55:40 -0700315
Dan O'Mearadd494642020-05-01 07:42:23 -0700316You 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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800317
Dan O'Mearadd494642020-05-01 07:42:23 -0700318To 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) ```
319 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.
John Asmuth614db982014-04-24 15:46:26 -0400320
321Returns:
322 An object of the form:
323
324 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800325 "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 -0700326 "kind": "compute#targetPoolAggregatedList", # [Output Only] Type of resource. Always compute#targetPoolAggregatedList for aggregated lists of target pools.
327 "items": { # A list of TargetPool resources.
John Asmuth614db982014-04-24 15:46:26 -0400328 "a_key": { # Name of the scope containing this set of target pools.
329 "warning": { # Informational warning which replaces the list of addresses when the list is empty.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800330 "message": "A String", # [Output Only] A human-readable description of the warning code.
331 "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.
332 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
333 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth614db982014-04-24 15:46:26 -0400334 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000335 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700336 "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 -0400337 },
338 ],
339 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700340 "targetPools": [ # A list of target pools contained in this scope.
Dan O'Mearadd494642020-05-01 07:42:23 -0700341 { # Represents a Target Pool resource.
342 #
343 # Target pools are used for network TCP/UDP load balancing. A target pool references member instances, an associated legacy HttpHealthCheck resource, and, optionally, a backup target pool. For more information, read Using target pools. (== resource_for {$api_version}.targetPools ==)
John Asmuth614db982014-04-24 15:46:26 -0400344 "failoverRatio": 3.14, # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool (i.e., not as a backup pool to some other target pool). The value of the field must be in [0, 1].
345 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700346 # If set, backupPool must also be set. They together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below this number, traffic arriving at the load-balanced IP will be directed to the backup pool.
John Asmuth614db982014-04-24 15:46:26 -0400347 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700348 # In case where failoverRatio is not set or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800349 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Takashi Matsuo06694102015-09-11 13:55:40 -0700350 "region": "A String", # [Output Only] URL of the region where the target pool resides.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800351 "kind": "compute#targetPool", # [Output Only] Type of the resource. Always compute#targetPool for target pools.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700352 "sessionAffinity": "A String", # Session affinity option, must be one of the following values:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800353 # NONE: Connections from the same client IP may go to any instance in the pool.
354 # CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy.
355 # CLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol will go to the same instance in the pool while that instance remains healthy.
356 "instances": [ # A list of resource URLs to the virtual machine instances serving this pool. They must live in zones contained in the same region as this pool.
John Asmuth614db982014-04-24 15:46:26 -0400357 "A String",
358 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700359 "backupPool": "A String", # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1].
John Asmuth614db982014-04-24 15:46:26 -0400360 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700361 # backupPool and failoverRatio together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below failoverRatio, traffic arriving at the load-balanced IP will be directed to the backup pool.
John Asmuth614db982014-04-24 15:46:26 -0400362 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700363 # In case where failoverRatio and backupPool are not set, or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400364 "healthChecks": [ # The URL of the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if the health checks pass. An empty list means all member instances will be considered healthy at all times. Only HttpHealthChecks are supported. Only one health check may be specified.
John Asmuth614db982014-04-24 15:46:26 -0400365 "A String",
366 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700367 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800368 "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 -0700369 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700370 "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 -0400371 },
372 ],
373 },
374 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700375 "warning": { # [Output Only] Informational warning message.
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 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Takashi Matsuo06694102015-09-11 13:55:40 -0700387 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
John Asmuth614db982014-04-24 15:46:26 -0400388 }</pre>
389</div>
390
391<div class="method">
392 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>
393 <pre>Retrieves the next page of results.
394
395Args:
396 previous_request: The request for the previous page. (required)
397 previous_response: The response from the request for the previous page. (required)
398
399Returns:
400 A request object that you can call 'execute()' on to request the next
401 page. Returns None if there are no more items in the collection.
402 </pre>
403</div>
404
405<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700406 <code class="details" id="delete">delete(project, region, targetPool, requestId=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800407 <pre>Deletes the specified target pool.
John Asmuth614db982014-04-24 15:46:26 -0400408
409Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800410 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400411 region: string, Name of the region scoping this request. (required)
412 targetPool: string, Name of the TargetPool resource to delete. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700413 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.
414
415For 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.
416
417The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
John Asmuth614db982014-04-24 15:46:26 -0400418
419Returns:
420 An object of the form:
421
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700422 { # Represents an Operation resource.
423 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700424 # Google Compute Engine has three Operation resources:
425 #
426 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
427 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700428 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
429 #
430 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700431 # - For global operations, use the `globalOperations` resource.
432 # - For regional operations, use the `regionOperations` resource.
433 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700434 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700435 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800436 "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 -0700437 "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 -0400438 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700439 "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 -0700440 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800441 "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 -0700442 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
443 "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 -0800444 "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 -0700445 "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 -0800446 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700447 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800448 "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 +0000449 "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 -0400450 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800451 "message": "A String", # [Output Only] A human-readable description of the warning code.
452 "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.
453 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
454 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth614db982014-04-24 15:46:26 -0400455 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000456 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700457 "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 -0400458 },
459 ],
460 },
461 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700462 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800463 "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 -0700464 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
465 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700466 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000467 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citroe633be12015-03-02 13:40:36 -0800468 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400469 {
Craig Citroe633be12015-03-02 13:40:36 -0800470 "message": "A String", # [Output Only] An optional, human-readable error message.
471 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700472 "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 -0400473 },
474 ],
475 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800476 "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 -0700477 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800478 "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 -0400479 }</pre>
480</div>
481
482<div class="method">
483 <code class="details" id="get">get(project, region, targetPool)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700484 <pre>Returns the specified target pool. Gets a list of available target pools by making a list() request.
John Asmuth614db982014-04-24 15:46:26 -0400485
486Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800487 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400488 region: string, Name of the region scoping this request. (required)
489 targetPool: string, Name of the TargetPool resource to return. (required)
490
491Returns:
492 An object of the form:
493
Dan O'Mearadd494642020-05-01 07:42:23 -0700494 { # Represents a Target Pool resource.
495 #
496 # Target pools are used for network TCP/UDP load balancing. A target pool references member instances, an associated legacy HttpHealthCheck resource, and, optionally, a backup target pool. For more information, read Using target pools. (== resource_for {$api_version}.targetPools ==)
John Asmuth614db982014-04-24 15:46:26 -0400497 "failoverRatio": 3.14, # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool (i.e., not as a backup pool to some other target pool). The value of the field must be in [0, 1].
498 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700499 # If set, backupPool must also be set. They together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below this number, traffic arriving at the load-balanced IP will be directed to the backup pool.
John Asmuth614db982014-04-24 15:46:26 -0400500 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700501 # In case where failoverRatio is not set or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800502 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Takashi Matsuo06694102015-09-11 13:55:40 -0700503 "region": "A String", # [Output Only] URL of the region where the target pool resides.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800504 "kind": "compute#targetPool", # [Output Only] Type of the resource. Always compute#targetPool for target pools.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700505 "sessionAffinity": "A String", # Session affinity option, must be one of the following values:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800506 # NONE: Connections from the same client IP may go to any instance in the pool.
507 # CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy.
508 # CLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol will go to the same instance in the pool while that instance remains healthy.
509 "instances": [ # A list of resource URLs to the virtual machine instances serving this pool. They must live in zones contained in the same region as this pool.
John Asmuth614db982014-04-24 15:46:26 -0400510 "A String",
511 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700512 "backupPool": "A String", # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1].
John Asmuth614db982014-04-24 15:46:26 -0400513 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700514 # backupPool and failoverRatio together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below failoverRatio, traffic arriving at the load-balanced IP will be directed to the backup pool.
John Asmuth614db982014-04-24 15:46:26 -0400515 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700516 # In case where failoverRatio and backupPool are not set, or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400517 "healthChecks": [ # The URL of the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if the health checks pass. An empty list means all member instances will be considered healthy at all times. Only HttpHealthChecks are supported. Only one health check may be specified.
John Asmuth614db982014-04-24 15:46:26 -0400518 "A String",
519 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700520 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800521 "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 -0700522 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700523 "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 -0400524 }</pre>
525</div>
526
527<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700528 <code class="details" id="getHealth">getHealth(project, region, targetPool, body=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800529 <pre>Gets the most recent health check results for each IP for the instance that is referenced by the given target pool.
John Asmuth614db982014-04-24 15:46:26 -0400530
531Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800532 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400533 region: string, Name of the region scoping this request. (required)
534 targetPool: string, Name of the TargetPool resource to which the queried instance belongs. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700535 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400536 The object takes the form of:
537
538{
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800539 "instance": "A String", # The URL for a specific instance.
John Asmuth614db982014-04-24 15:46:26 -0400540}
541
542
543Returns:
544 An object of the form:
545
546 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800547 "kind": "compute#targetPoolInstanceHealth", # [Output Only] Type of resource. Always compute#targetPoolInstanceHealth when checking the health of an instance.
John Asmuth614db982014-04-24 15:46:26 -0400548 "healthStatus": [
549 {
550 "instance": "A String", # URL of the instance resource.
551 "healthState": "A String", # Health state of the instance.
Dan O'Mearadd494642020-05-01 07:42:23 -0700552 "ipAddress": "A String", # A forwarding rule IP address assigned to this instance.
553 "port": 42, # The named port of the instance group, not necessarily the port that is health-checked.
John Asmuth614db982014-04-24 15:46:26 -0400554 },
555 ],
556 }</pre>
557</div>
558
559<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700560 <code class="details" id="insert">insert(project, region, body=None, requestId=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800561 <pre>Creates a target pool in the specified project and region using the data included in the request.
John Asmuth614db982014-04-24 15:46:26 -0400562
563Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800564 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400565 region: string, Name of the region scoping this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700566 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400567 The object takes the form of:
568
Dan O'Mearadd494642020-05-01 07:42:23 -0700569{ # Represents a Target Pool resource.
570 #
571 # Target pools are used for network TCP/UDP load balancing. A target pool references member instances, an associated legacy HttpHealthCheck resource, and, optionally, a backup target pool. For more information, read Using target pools. (== resource_for {$api_version}.targetPools ==)
John Asmuth614db982014-04-24 15:46:26 -0400572 "failoverRatio": 3.14, # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool (i.e., not as a backup pool to some other target pool). The value of the field must be in [0, 1].
573 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700574 # If set, backupPool must also be set. They together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below this number, traffic arriving at the load-balanced IP will be directed to the backup pool.
John Asmuth614db982014-04-24 15:46:26 -0400575 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700576 # In case where failoverRatio is not set or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800577 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Takashi Matsuo06694102015-09-11 13:55:40 -0700578 "region": "A String", # [Output Only] URL of the region where the target pool resides.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800579 "kind": "compute#targetPool", # [Output Only] Type of the resource. Always compute#targetPool for target pools.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700580 "sessionAffinity": "A String", # Session affinity option, must be one of the following values:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800581 # NONE: Connections from the same client IP may go to any instance in the pool.
582 # CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy.
583 # CLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol will go to the same instance in the pool while that instance remains healthy.
584 "instances": [ # A list of resource URLs to the virtual machine instances serving this pool. They must live in zones contained in the same region as this pool.
John Asmuth614db982014-04-24 15:46:26 -0400585 "A String",
586 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700587 "backupPool": "A String", # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1].
John Asmuth614db982014-04-24 15:46:26 -0400588 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700589 # backupPool and failoverRatio together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below failoverRatio, traffic arriving at the load-balanced IP will be directed to the backup pool.
John Asmuth614db982014-04-24 15:46:26 -0400590 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700591 # In case where failoverRatio and backupPool are not set, or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400592 "healthChecks": [ # The URL of the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if the health checks pass. An empty list means all member instances will be considered healthy at all times. Only HttpHealthChecks are supported. Only one health check may be specified.
John Asmuth614db982014-04-24 15:46:26 -0400593 "A String",
594 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700595 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800596 "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 -0700597 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700598 "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 -0400599 }
600
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700601 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.
602
603For 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.
604
605The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
John Asmuth614db982014-04-24 15:46:26 -0400606
607Returns:
608 An object of the form:
609
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700610 { # Represents an Operation resource.
611 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700612 # Google Compute Engine has three Operation resources:
613 #
614 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
615 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700616 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
617 #
618 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700619 # - For global operations, use the `globalOperations` resource.
620 # - For regional operations, use the `regionOperations` resource.
621 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700622 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700623 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800624 "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 -0700625 "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 -0400626 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700627 "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 -0700628 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800629 "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 -0700630 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
631 "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 -0800632 "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 -0700633 "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 -0800634 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700635 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800636 "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 +0000637 "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 -0400638 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800639 "message": "A String", # [Output Only] A human-readable description of the warning code.
640 "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.
641 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
642 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth614db982014-04-24 15:46:26 -0400643 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000644 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700645 "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 -0400646 },
647 ],
648 },
649 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700650 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800651 "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 -0700652 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
653 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700654 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000655 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citroe633be12015-03-02 13:40:36 -0800656 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400657 {
Craig Citroe633be12015-03-02 13:40:36 -0800658 "message": "A String", # [Output Only] An optional, human-readable error message.
659 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700660 "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 -0400661 },
662 ],
663 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800664 "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 -0700665 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800666 "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 -0400667 }</pre>
668</div>
669
670<div class="method">
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700671 <code class="details" id="list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800672 <pre>Retrieves a list of target pools available to the specified project and region.
John Asmuth614db982014-04-24 15:46:26 -0400673
674Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800675 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400676 region: string, Name of the region scoping this request. (required)
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700677 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
678
Dan O'Mearadd494642020-05-01 07:42:23 -0700679You 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 Cheemalapatiea3a5e12016-10-12 14:05:53 -0700680
Dan O'Mearadd494642020-05-01 07:42:23 -0700681Currently, only sorting by `name` or `creationTimestamp desc` is supported.
682 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`)
683 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.
684 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;`.
Takashi Matsuo06694102015-09-11 13:55:40 -0700685
Dan O'Mearadd494642020-05-01 07:42:23 -0700686For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
Takashi Matsuo06694102015-09-11 13:55:40 -0700687
Dan O'Mearadd494642020-05-01 07:42:23 -0700688You 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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800689
Dan O'Mearadd494642020-05-01 07:42:23 -0700690To 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) ```
John Asmuth614db982014-04-24 15:46:26 -0400691
692Returns:
693 An object of the form:
694
695 { # Contains a list of TargetPool resources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800696 "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 -0700697 "kind": "compute#targetPoolList", # [Output Only] Type of resource. Always compute#targetPoolList for lists of target pools.
Craig Citroe633be12015-03-02 13:40:36 -0800698 "items": [ # A list of TargetPool resources.
Dan O'Mearadd494642020-05-01 07:42:23 -0700699 { # Represents a Target Pool resource.
700 #
701 # Target pools are used for network TCP/UDP load balancing. A target pool references member instances, an associated legacy HttpHealthCheck resource, and, optionally, a backup target pool. For more information, read Using target pools. (== resource_for {$api_version}.targetPools ==)
John Asmuth614db982014-04-24 15:46:26 -0400702 "failoverRatio": 3.14, # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool (i.e., not as a backup pool to some other target pool). The value of the field must be in [0, 1].
703 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700704 # If set, backupPool must also be set. They together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below this number, traffic arriving at the load-balanced IP will be directed to the backup pool.
John Asmuth614db982014-04-24 15:46:26 -0400705 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700706 # In case where failoverRatio is not set or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800707 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Takashi Matsuo06694102015-09-11 13:55:40 -0700708 "region": "A String", # [Output Only] URL of the region where the target pool resides.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800709 "kind": "compute#targetPool", # [Output Only] Type of the resource. Always compute#targetPool for target pools.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700710 "sessionAffinity": "A String", # Session affinity option, must be one of the following values:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800711 # NONE: Connections from the same client IP may go to any instance in the pool.
712 # CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy.
713 # CLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol will go to the same instance in the pool while that instance remains healthy.
714 "instances": [ # A list of resource URLs to the virtual machine instances serving this pool. They must live in zones contained in the same region as this pool.
John Asmuth614db982014-04-24 15:46:26 -0400715 "A String",
716 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700717 "backupPool": "A String", # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1].
John Asmuth614db982014-04-24 15:46:26 -0400718 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700719 # backupPool and failoverRatio together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below failoverRatio, traffic arriving at the load-balanced IP will be directed to the backup pool.
John Asmuth614db982014-04-24 15:46:26 -0400720 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700721 # In case where failoverRatio and backupPool are not set, or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400722 "healthChecks": [ # The URL of the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if the health checks pass. An empty list means all member instances will be considered healthy at all times. Only HttpHealthChecks are supported. Only one health check may be specified.
John Asmuth614db982014-04-24 15:46:26 -0400723 "A String",
724 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700725 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800726 "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 -0700727 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700728 "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 -0400729 },
730 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700731 "warning": { # [Output Only] Informational warning message.
732 "message": "A String", # [Output Only] A human-readable description of the warning code.
733 "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.
734 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
735 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
736 {
737 "value": "A String", # [Output Only] A warning data value corresponding to the key.
738 "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).
739 },
740 ],
741 },
742 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Takashi Matsuo06694102015-09-11 13:55:40 -0700743 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
John Asmuth614db982014-04-24 15:46:26 -0400744 }</pre>
745</div>
746
747<div class="method">
748 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
749 <pre>Retrieves the next page of results.
750
751Args:
752 previous_request: The request for the previous page. (required)
753 previous_response: The response from the request for the previous page. (required)
754
755Returns:
756 A request object that you can call 'execute()' on to request the next
757 page. Returns None if there are no more items in the collection.
758 </pre>
759</div>
760
761<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700762 <code class="details" id="removeHealthCheck">removeHealthCheck(project, region, targetPool, body=None, requestId=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800763 <pre>Removes health check URL from a target pool.
John Asmuth614db982014-04-24 15:46:26 -0400764
765Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800766 project: string, Project ID for this request. (required)
767 region: string, Name of the region for this request. (required)
768 targetPool: string, Name of the target pool to remove health checks from. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700769 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400770 The object takes the form of:
771
772{
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800773 "healthChecks": [ # Health check URL to be removed. This can be a full or valid partial URL. For example, the following are valid URLs:
774 # - https://www.googleapis.com/compute/beta/projects/project/global/httpHealthChecks/health-check
775 # - projects/project/global/httpHealthChecks/health-check
776 # - global/httpHealthChecks/health-check
777 { # A full or valid partial URL to a health check. For example, the following are valid URLs:
778 # - https://www.googleapis.com/compute/beta/projects/project-id/global/httpHealthChecks/health-check
779 # - projects/project-id/global/httpHealthChecks/health-check
780 # - global/httpHealthChecks/health-check
John Asmuth614db982014-04-24 15:46:26 -0400781 "healthCheck": "A String",
782 },
783 ],
784 }
785
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700786 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.
787
788For 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.
789
790The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
John Asmuth614db982014-04-24 15:46:26 -0400791
792Returns:
793 An object of the form:
794
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700795 { # Represents an Operation resource.
796 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700797 # Google Compute Engine has three Operation resources:
798 #
799 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
800 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700801 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
802 #
803 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700804 # - For global operations, use the `globalOperations` resource.
805 # - For regional operations, use the `regionOperations` resource.
806 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700807 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700808 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800809 "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 -0700810 "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 -0400811 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700812 "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 -0700813 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800814 "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 -0700815 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
816 "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 -0800817 "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 -0700818 "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 -0800819 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700820 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800821 "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 +0000822 "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 -0400823 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800824 "message": "A String", # [Output Only] A human-readable description of the warning code.
825 "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.
826 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
827 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth614db982014-04-24 15:46:26 -0400828 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000829 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700830 "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 -0400831 },
832 ],
833 },
834 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700835 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800836 "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 -0700837 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
838 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700839 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000840 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citroe633be12015-03-02 13:40:36 -0800841 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400842 {
Craig Citroe633be12015-03-02 13:40:36 -0800843 "message": "A String", # [Output Only] An optional, human-readable error message.
844 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700845 "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 -0400846 },
847 ],
848 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800849 "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 -0700850 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800851 "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 -0400852 }</pre>
853</div>
854
855<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700856 <code class="details" id="removeInstance">removeInstance(project, region, targetPool, body=None, requestId=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800857 <pre>Removes instance URL from a target pool.
John Asmuth614db982014-04-24 15:46:26 -0400858
859Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800860 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400861 region: string, Name of the region scoping this request. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800862 targetPool: string, Name of the TargetPool resource to remove instances from. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700863 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400864 The object takes the form of:
865
866{
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800867 "instances": [ # URLs of the instances to be removed from target pool.
John Asmuth614db982014-04-24 15:46:26 -0400868 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800869 "instance": "A String", # The URL for a specific instance.
John Asmuth614db982014-04-24 15:46:26 -0400870 },
871 ],
872 }
873
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700874 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.
875
876For 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.
877
878The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
John Asmuth614db982014-04-24 15:46:26 -0400879
880Returns:
881 An object of the form:
882
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700883 { # Represents an Operation resource.
884 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700885 # Google Compute Engine has three Operation resources:
886 #
887 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
888 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700889 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
890 #
891 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700892 # - For global operations, use the `globalOperations` resource.
893 # - For regional operations, use the `regionOperations` resource.
894 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700895 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700896 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800897 "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 -0700898 "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 -0400899 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700900 "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 -0700901 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800902 "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 -0700903 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
904 "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 -0800905 "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 -0700906 "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 -0800907 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700908 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800909 "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 +0000910 "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 -0400911 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800912 "message": "A String", # [Output Only] A human-readable description of the warning code.
913 "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.
914 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
915 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth614db982014-04-24 15:46:26 -0400916 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000917 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700918 "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 -0400919 },
920 ],
921 },
922 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700923 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800924 "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 -0700925 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
926 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700927 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000928 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citroe633be12015-03-02 13:40:36 -0800929 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400930 {
Craig Citroe633be12015-03-02 13:40:36 -0800931 "message": "A String", # [Output Only] An optional, human-readable error message.
932 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700933 "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 -0400934 },
935 ],
936 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800937 "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 -0700938 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800939 "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 -0400940 }</pre>
941</div>
942
943<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700944 <code class="details" id="setBackup">setBackup(project, region, targetPool, body=None, failoverRatio=None, requestId=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800945 <pre>Changes a backup target pool's configurations.
John Asmuth614db982014-04-24 15:46:26 -0400946
947Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800948 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400949 region: string, Name of the region scoping this request. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800950 targetPool: string, Name of the TargetPool resource to set a backup pool for. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700951 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400952 The object takes the form of:
953
954{
955 "target": "A String",
956 }
957
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800958 failoverRatio: number, New failoverRatio value for the target pool.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700959 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.
960
961For 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.
962
963The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
John Asmuth614db982014-04-24 15:46:26 -0400964
965Returns:
966 An object of the form:
967
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700968 { # Represents an Operation resource.
969 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700970 # Google Compute Engine has three Operation resources:
971 #
972 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
973 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700974 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
975 #
976 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700977 # - For global operations, use the `globalOperations` resource.
978 # - For regional operations, use the `regionOperations` resource.
979 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700980 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700981 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800982 "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 -0700983 "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 -0400984 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700985 "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 -0700986 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800987 "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 -0700988 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
989 "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 -0800990 "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 -0700991 "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 -0800992 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700993 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800994 "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 +0000995 "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 -0400996 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800997 "message": "A String", # [Output Only] A human-readable description of the warning code.
998 "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.
999 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
1000 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth614db982014-04-24 15:46:26 -04001001 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +00001002 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -07001003 "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 -04001004 },
1005 ],
1006 },
1007 ],
Dan O'Mearadd494642020-05-01 07:42:23 -07001008 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -08001009 "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 -07001010 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
1011 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001012 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +00001013 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citroe633be12015-03-02 13:40:36 -08001014 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -04001015 {
Craig Citroe633be12015-03-02 13:40:36 -08001016 "message": "A String", # [Output Only] An optional, human-readable error message.
1017 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -07001018 "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 -04001019 },
1020 ],
1021 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -08001022 "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 -07001023 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08001024 "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 -04001025 }</pre>
1026</div>
1027
1028</body></html>