blob: 854e4da25db1f4699170c95e785ce71cb57a7b23 [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">
yoshi-code-bot0f0918f2021-06-11 00:22:02 -070078 <code><a href="#addHealthCheck">addHealthCheck(project, region, targetPool, body=None, requestId=None, x__xgafv=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">
yoshi-code-bot0f0918f2021-06-11 00:22:02 -070081 <code><a href="#addInstance">addInstance(project, region, targetPool, body=None, requestId=None, x__xgafv=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">
yoshi-code-bot0f0918f2021-06-11 00:22:02 -070084 <code><a href="#aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=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">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070090 <code><a href="#close">close()</a></code></p>
91<p class="firstline">Close httplib2 connections.</p>
92<p class="toc_element">
yoshi-code-bot0f0918f2021-06-11 00:22:02 -070093 <code><a href="#delete">delete(project, region, targetPool, requestId=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -080094<p class="firstline">Deletes the specified target pool.</p>
John Asmuth614db982014-04-24 15:46:26 -040095<p class="toc_element">
yoshi-code-bot0f0918f2021-06-11 00:22:02 -070096 <code><a href="#get">get(project, region, targetPool, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070097<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 -040098<p class="toc_element">
yoshi-code-bot0f0918f2021-06-11 00:22:02 -070099 <code><a href="#getHealth">getHealth(project, region, targetPool, body=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800100<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 -0400101<p class="toc_element">
yoshi-code-bot0f0918f2021-06-11 00:22:02 -0700102 <code><a href="#insert">insert(project, region, body=None, requestId=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800103<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 -0400104<p class="toc_element">
yoshi-code-bot0f0918f2021-06-11 00:22:02 -0700105 <code><a href="#list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800106<p class="firstline">Retrieves a list of target pools available to the specified project and region.</p>
John Asmuth614db982014-04-24 15:46:26 -0400107<p class="toc_element">
108 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
109<p class="firstline">Retrieves the next page of results.</p>
110<p class="toc_element">
yoshi-code-bot0f0918f2021-06-11 00:22:02 -0700111 <code><a href="#removeHealthCheck">removeHealthCheck(project, region, targetPool, body=None, requestId=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800112<p class="firstline">Removes health check URL from a target pool.</p>
John Asmuth614db982014-04-24 15:46:26 -0400113<p class="toc_element">
yoshi-code-bot0f0918f2021-06-11 00:22:02 -0700114 <code><a href="#removeInstance">removeInstance(project, region, targetPool, body=None, requestId=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800115<p class="firstline">Removes instance URL from a target pool.</p>
John Asmuth614db982014-04-24 15:46:26 -0400116<p class="toc_element">
yoshi-code-bot0f0918f2021-06-11 00:22:02 -0700117 <code><a href="#setBackup">setBackup(project, region, targetPool, body=None, failoverRatio=None, requestId=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800118<p class="firstline">Changes a backup target pool's configurations.</p>
John Asmuth614db982014-04-24 15:46:26 -0400119<h3>Method Details</h3>
120<div class="method">
yoshi-code-bot0f0918f2021-06-11 00:22:02 -0700121 <code class="details" id="addHealthCheck">addHealthCheck(project, region, targetPool, body=None, requestId=None, x__xgafv=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800122 <pre>Adds health check URLs to a target pool.
John Asmuth614db982014-04-24 15:46:26 -0400123
124Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800125 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400126 region: string, Name of the region scoping this request. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800127 targetPool: string, Name of the target pool to add a health check to. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700128 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400129 The object takes the form of:
130
131{
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800132 &quot;healthChecks&quot;: [ # The HttpHealthCheck to add to the target pool.
yoshi-code-bot0f0918f2021-06-11 00:22:02 -0700133 { # A full or valid partial URL to a health check. For example, the following are valid URLs: - https://www.googleapis.com/compute/beta/projects/project-id/global/httpHealthChecks/health-check - projects/project-id/global/httpHealthChecks/health-check - global/httpHealthChecks/health-check
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800134 &quot;healthCheck&quot;: &quot;A String&quot;,
135 },
136 ],
137}
John Asmuth614db982014-04-24 15:46:26 -0400138
yoshi-code-bot0f0918f2021-06-11 00:22:02 -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. For 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
140 x__xgafv: string, V1 error format.
141 Allowed values
142 1 - v1 error format
143 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400144
145Returns:
146 An object of the form:
147
yoshi-code-bot0f0918f2021-06-11 00:22:02 -0700148 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800149 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
150 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
151 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
152 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
153 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
154 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700155 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800156 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
157 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
158 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700159 },
160 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800161 },
162 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
163 &quot;httpErrorStatusCode&quot;: 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.
164 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
165 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
166 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
167 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800168 &quot;operationGroupId&quot;: &quot;A String&quot;, # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800169 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
170 &quot;progress&quot;: 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.
171 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
172 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
173 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
174 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
175 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
176 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
177 &quot;targetLink&quot;: &quot;A String&quot;, # [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.
178 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
179 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
180 {
181 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-bot0f0918f2021-06-11 00:22:02 -0700182 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example: &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800183 {
184 &quot;key&quot;: &quot;A String&quot;, # [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).
185 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
186 },
187 ],
188 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
189 },
190 ],
191 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
192}</pre>
John Asmuth614db982014-04-24 15:46:26 -0400193</div>
194
195<div class="method">
yoshi-code-bot0f0918f2021-06-11 00:22:02 -0700196 <code class="details" id="addInstance">addInstance(project, region, targetPool, body=None, requestId=None, x__xgafv=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800197 <pre>Adds an instance to a target pool.
John Asmuth614db982014-04-24 15:46:26 -0400198
199Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800200 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400201 region: string, Name of the region scoping this request. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800202 targetPool: string, Name of the TargetPool resource to add instances to. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700203 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400204 The object takes the form of:
205
206{
yoshi-code-bot0f0918f2021-06-11 00:22:02 -0700207 &quot;instances&quot;: [ # 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: - https://www.googleapis.com/compute/v1/projects/project-id/zones/zone /instances/instance-name - projects/project-id/zones/zone/instances/instance-name - zones/zone/instances/instance-name
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800208 {
yoshi-code-bot0f0918f2021-06-11 00:22:02 -0700209 &quot;instance&quot;: &quot;A String&quot;, # The URL for a specific instance. @required compute.instancegroups.addInstances/removeInstances
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800210 },
211 ],
212}
John Asmuth614db982014-04-24 15:46:26 -0400213
yoshi-code-bot0f0918f2021-06-11 00:22:02 -0700214 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. For 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
215 x__xgafv: string, V1 error format.
216 Allowed values
217 1 - v1 error format
218 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400219
220Returns:
221 An object of the form:
222
yoshi-code-bot0f0918f2021-06-11 00:22:02 -0700223 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800224 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
225 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
226 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
227 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
228 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
229 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700230 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800231 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
232 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
233 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700234 },
235 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800236 },
237 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
238 &quot;httpErrorStatusCode&quot;: 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.
239 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
240 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
241 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
242 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800243 &quot;operationGroupId&quot;: &quot;A String&quot;, # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800244 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
245 &quot;progress&quot;: 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.
246 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
247 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
248 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
249 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
250 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
251 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
252 &quot;targetLink&quot;: &quot;A String&quot;, # [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.
253 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
254 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
255 {
256 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-bot0f0918f2021-06-11 00:22:02 -0700257 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example: &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800258 {
259 &quot;key&quot;: &quot;A String&quot;, # [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).
260 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
261 },
262 ],
263 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
264 },
265 ],
266 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
267}</pre>
John Asmuth614db982014-04-24 15:46:26 -0400268</div>
269
270<div class="method">
yoshi-code-bot0f0918f2021-06-11 00:22:02 -0700271 <code class="details" id="aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800272 <pre>Retrieves an aggregated list of target pools.
John Asmuth614db982014-04-24 15:46:26 -0400273
274Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800275 project: string, Project ID for this request. (required)
yoshi-code-bot0f0918f2021-06-11 00:22:02 -0700276 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;`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. You 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. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = &quot;Intel Skylake&quot;) ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = &quot;Intel Skylake&quot;) OR (cpuPlatform = &quot;Intel Broadwell&quot;) AND (scheduling.automaticRestart = true) ```
Dan O'Mearadd494642020-05-01 07:42:23 -0700277 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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700278 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`)
yoshi-code-bot0f0918f2021-06-11 00:22:02 -0700279 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. 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. Currently, only sorting by `name` or `creationTimestamp desc` is supported.
Bu Sun Kim65020912020-05-20 12:08:20 -0700280 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.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800281 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
yoshi-code-bot0f0918f2021-06-11 00:22:02 -0700282 x__xgafv: string, V1 error format.
283 Allowed values
284 1 - v1 error format
285 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400286
287Returns:
288 An object of the form:
289
290 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800291 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
292 &quot;items&quot;: { # A list of TargetPool resources.
293 &quot;a_key&quot;: { # Name of the scope containing this set of target pools.
294 &quot;targetPools&quot;: [ # A list of target pools contained in this scope.
yoshi-code-bot0f0918f2021-06-11 00:22:02 -0700295 { # Represents a Target Pool resource. 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.
296 &quot;backupPool&quot;: &quot;A String&quot;, # The server-defined URL for the resource. 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]. 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. 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 &quot;force&quot; mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800297 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp in RFC3339 text format.
298 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you create the resource.
yoshi-code-bot0f0918f2021-06-11 00:22:02 -0700299 &quot;failoverRatio&quot;: 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]. 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. 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 &quot;force&quot; mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800300 &quot;healthChecks&quot;: [ # The URL of the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if the health checks pass. Only legacy HttpHealthChecks are supported. Only one health check may be specified.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800301 &quot;A String&quot;,
John Asmuth614db982014-04-24 15:46:26 -0400302 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800303 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
304 &quot;instances&quot;: [ # 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.
305 &quot;A String&quot;,
306 ],
307 &quot;kind&quot;: &quot;compute#targetPool&quot;, # [Output Only] Type of the resource. Always compute#targetPool for target pools.
308 &quot;name&quot;: &quot;A String&quot;, # 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.
309 &quot;region&quot;: &quot;A String&quot;, # [Output Only] URL of the region where the target pool resides.
310 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
yoshi-code-bot0f0918f2021-06-11 00:22:02 -0700311 &quot;sessionAffinity&quot;: &quot;A String&quot;, # Session affinity option, must be one of the following values: NONE: Connections from the same client IP may go to any instance in the pool. CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy. 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700312 },
313 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800314 &quot;warning&quot;: { # Informational warning which replaces the list of addresses when the list is empty.
315 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-bot0f0918f2021-06-11 00:22:02 -0700316 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example: &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800317 {
318 &quot;key&quot;: &quot;A String&quot;, # [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).
319 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
320 },
321 ],
322 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
323 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700324 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800325 },
326 &quot;kind&quot;: &quot;compute#targetPoolAggregatedList&quot;, # [Output Only] Type of resource. Always compute#targetPoolAggregatedList for aggregated lists of target pools.
327 &quot;nextPageToken&quot;: &quot;A String&quot;, # [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.
328 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource.
329 &quot;unreachables&quot;: [ # [Output Only] Unreachable resources.
330 &quot;A String&quot;,
331 ],
332 &quot;warning&quot;: { # [Output Only] Informational warning message.
333 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-bot0f0918f2021-06-11 00:22:02 -0700334 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example: &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800335 {
336 &quot;key&quot;: &quot;A String&quot;, # [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).
337 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
338 },
339 ],
340 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
341 },
342}</pre>
John Asmuth614db982014-04-24 15:46:26 -0400343</div>
344
345<div class="method">
346 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>
347 <pre>Retrieves the next page of results.
348
349Args:
350 previous_request: The request for the previous page. (required)
351 previous_response: The response from the request for the previous page. (required)
352
353Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700354 A request object that you can call &#x27;execute()&#x27; on to request the next
John Asmuth614db982014-04-24 15:46:26 -0400355 page. Returns None if there are no more items in the collection.
356 </pre>
357</div>
358
359<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700360 <code class="details" id="close">close()</code>
361 <pre>Close httplib2 connections.</pre>
362</div>
363
364<div class="method">
yoshi-code-bot0f0918f2021-06-11 00:22:02 -0700365 <code class="details" id="delete">delete(project, region, targetPool, requestId=None, x__xgafv=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800366 <pre>Deletes the specified target pool.
John Asmuth614db982014-04-24 15:46:26 -0400367
368Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800369 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400370 region: string, Name of the region scoping this request. (required)
371 targetPool: string, Name of the TargetPool resource to delete. (required)
yoshi-code-bot0f0918f2021-06-11 00:22:02 -0700372 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. For 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
373 x__xgafv: string, V1 error format.
374 Allowed values
375 1 - v1 error format
376 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400377
378Returns:
379 An object of the form:
380
yoshi-code-bot0f0918f2021-06-11 00:22:02 -0700381 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800382 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
383 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
384 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
385 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
386 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
387 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700388 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800389 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
390 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
391 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700392 },
393 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800394 },
395 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
396 &quot;httpErrorStatusCode&quot;: 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.
397 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
398 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
399 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
400 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800401 &quot;operationGroupId&quot;: &quot;A String&quot;, # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800402 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
403 &quot;progress&quot;: 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.
404 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
405 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
406 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
407 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
408 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
409 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
410 &quot;targetLink&quot;: &quot;A String&quot;, # [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.
411 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
412 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
413 {
414 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-bot0f0918f2021-06-11 00:22:02 -0700415 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example: &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800416 {
417 &quot;key&quot;: &quot;A String&quot;, # [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).
418 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
419 },
420 ],
421 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
422 },
423 ],
424 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
425}</pre>
John Asmuth614db982014-04-24 15:46:26 -0400426</div>
427
428<div class="method">
yoshi-code-bot0f0918f2021-06-11 00:22:02 -0700429 <code class="details" id="get">get(project, region, targetPool, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700430 <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 -0400431
432Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800433 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400434 region: string, Name of the region scoping this request. (required)
435 targetPool: string, Name of the TargetPool resource to return. (required)
yoshi-code-bot0f0918f2021-06-11 00:22:02 -0700436 x__xgafv: string, V1 error format.
437 Allowed values
438 1 - v1 error format
439 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400440
441Returns:
442 An object of the form:
443
yoshi-code-bot0f0918f2021-06-11 00:22:02 -0700444 { # Represents a Target Pool resource. 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.
445 &quot;backupPool&quot;: &quot;A String&quot;, # The server-defined URL for the resource. 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]. 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. 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 &quot;force&quot; mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800446 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp in RFC3339 text format.
447 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you create the resource.
yoshi-code-bot0f0918f2021-06-11 00:22:02 -0700448 &quot;failoverRatio&quot;: 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]. 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. 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 &quot;force&quot; mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800449 &quot;healthChecks&quot;: [ # The URL of the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if the health checks pass. Only legacy HttpHealthChecks are supported. Only one health check may be specified.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800450 &quot;A String&quot;,
451 ],
452 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
453 &quot;instances&quot;: [ # 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.
454 &quot;A String&quot;,
455 ],
456 &quot;kind&quot;: &quot;compute#targetPool&quot;, # [Output Only] Type of the resource. Always compute#targetPool for target pools.
457 &quot;name&quot;: &quot;A String&quot;, # 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.
458 &quot;region&quot;: &quot;A String&quot;, # [Output Only] URL of the region where the target pool resides.
459 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
yoshi-code-bot0f0918f2021-06-11 00:22:02 -0700460 &quot;sessionAffinity&quot;: &quot;A String&quot;, # Session affinity option, must be one of the following values: NONE: Connections from the same client IP may go to any instance in the pool. CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy. 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.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800461}</pre>
John Asmuth614db982014-04-24 15:46:26 -0400462</div>
463
464<div class="method">
yoshi-code-bot0f0918f2021-06-11 00:22:02 -0700465 <code class="details" id="getHealth">getHealth(project, region, targetPool, body=None, x__xgafv=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800466 <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 -0400467
468Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800469 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400470 region: string, Name of the region scoping this request. (required)
471 targetPool: string, Name of the TargetPool resource to which the queried instance belongs. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700472 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400473 The object takes the form of:
474
475{
yoshi-code-bot0f0918f2021-06-11 00:22:02 -0700476 &quot;instance&quot;: &quot;A String&quot;, # The URL for a specific instance. @required compute.instancegroups.addInstances/removeInstances
John Asmuth614db982014-04-24 15:46:26 -0400477}
478
yoshi-code-bot0f0918f2021-06-11 00:22:02 -0700479 x__xgafv: string, V1 error format.
480 Allowed values
481 1 - v1 error format
482 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400483
484Returns:
485 An object of the form:
486
487 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800488 &quot;healthStatus&quot;: [
489 {
490 &quot;annotations&quot;: { # Metadata defined as annotations for network endpoint.
491 &quot;a_key&quot;: &quot;A String&quot;,
John Asmuth614db982014-04-24 15:46:26 -0400492 },
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400493 &quot;forwardingRule&quot;: &quot;A String&quot;, # URL of the forwarding rule associated with the health status of the instance.
494 &quot;forwardingRuleIp&quot;: &quot;A String&quot;, # A forwarding rule IP address assigned to this instance.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800495 &quot;healthState&quot;: &quot;A String&quot;, # Health state of the instance.
496 &quot;instance&quot;: &quot;A String&quot;, # URL of the instance resource.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800497 &quot;ipAddress&quot;: &quot;A String&quot;, # For target pool based Network Load Balancing, it indicates the forwarding rule&#x27;s IP address assigned to this instance. For other types of load balancing, the field indicates VM internal ip.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800498 &quot;port&quot;: 42, # The named port of the instance group, not necessarily the port that is health-checked.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800499 &quot;weight&quot;: &quot;A String&quot;,
500 &quot;weightError&quot;: &quot;A String&quot;,
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800501 },
502 ],
503 &quot;kind&quot;: &quot;compute#targetPoolInstanceHealth&quot;, # [Output Only] Type of resource. Always compute#targetPoolInstanceHealth when checking the health of an instance.
504}</pre>
John Asmuth614db982014-04-24 15:46:26 -0400505</div>
506
507<div class="method">
yoshi-code-bot0f0918f2021-06-11 00:22:02 -0700508 <code class="details" id="insert">insert(project, region, body=None, requestId=None, x__xgafv=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800509 <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 -0400510
511Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800512 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400513 region: string, Name of the region scoping this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700514 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400515 The object takes the form of:
516
yoshi-code-bot0f0918f2021-06-11 00:22:02 -0700517{ # Represents a Target Pool resource. 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.
518 &quot;backupPool&quot;: &quot;A String&quot;, # The server-defined URL for the resource. 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]. 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. 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 &quot;force&quot; mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
Bu Sun Kim65020912020-05-20 12:08:20 -0700519 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp in RFC3339 text format.
520 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you create the resource.
yoshi-code-bot0f0918f2021-06-11 00:22:02 -0700521 &quot;failoverRatio&quot;: 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]. 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. 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 &quot;force&quot; mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800522 &quot;healthChecks&quot;: [ # The URL of the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if the health checks pass. Only legacy HttpHealthChecks are supported. Only one health check may be specified.
Bu Sun Kim65020912020-05-20 12:08:20 -0700523 &quot;A String&quot;,
524 ],
525 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
526 &quot;instances&quot;: [ # 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.
527 &quot;A String&quot;,
528 ],
529 &quot;kind&quot;: &quot;compute#targetPool&quot;, # [Output Only] Type of the resource. Always compute#targetPool for target pools.
530 &quot;name&quot;: &quot;A String&quot;, # 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.
531 &quot;region&quot;: &quot;A String&quot;, # [Output Only] URL of the region where the target pool resides.
532 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
yoshi-code-bot0f0918f2021-06-11 00:22:02 -0700533 &quot;sessionAffinity&quot;: &quot;A String&quot;, # Session affinity option, must be one of the following values: NONE: Connections from the same client IP may go to any instance in the pool. CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy. 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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700534}
John Asmuth614db982014-04-24 15:46:26 -0400535
yoshi-code-bot0f0918f2021-06-11 00:22:02 -0700536 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. For 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
537 x__xgafv: string, V1 error format.
538 Allowed values
539 1 - v1 error format
540 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400541
542Returns:
543 An object of the form:
544
yoshi-code-bot0f0918f2021-06-11 00:22:02 -0700545 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800546 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
547 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
548 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
549 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
550 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
551 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700552 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800553 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
554 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
555 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700556 },
557 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800558 },
559 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
560 &quot;httpErrorStatusCode&quot;: 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.
561 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
562 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
563 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
564 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800565 &quot;operationGroupId&quot;: &quot;A String&quot;, # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800566 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
567 &quot;progress&quot;: 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.
568 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
569 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
570 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
571 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
572 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
573 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
574 &quot;targetLink&quot;: &quot;A String&quot;, # [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.
575 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
576 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
577 {
578 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-bot0f0918f2021-06-11 00:22:02 -0700579 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example: &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800580 {
581 &quot;key&quot;: &quot;A String&quot;, # [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).
582 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
583 },
584 ],
585 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
586 },
587 ],
588 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
589}</pre>
John Asmuth614db982014-04-24 15:46:26 -0400590</div>
591
592<div class="method">
yoshi-code-bot0f0918f2021-06-11 00:22:02 -0700593 <code class="details" id="list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800594 <pre>Retrieves a list of target pools available to the specified project and region.
John Asmuth614db982014-04-24 15:46:26 -0400595
596Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800597 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400598 region: string, Name of the region scoping this request. (required)
yoshi-code-bot0f0918f2021-06-11 00:22:02 -0700599 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;`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. You 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. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = &quot;Intel Skylake&quot;) ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = &quot;Intel Skylake&quot;) OR (cpuPlatform = &quot;Intel Broadwell&quot;) AND (scheduling.automaticRestart = true) ```
Bu Sun Kim65020912020-05-20 12:08:20 -0700600 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`)
yoshi-code-bot0f0918f2021-06-11 00:22:02 -0700601 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. 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. Currently, only sorting by `name` or `creationTimestamp desc` is supported.
Bu Sun Kim65020912020-05-20 12:08:20 -0700602 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.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800603 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
yoshi-code-bot0f0918f2021-06-11 00:22:02 -0700604 x__xgafv: string, V1 error format.
605 Allowed values
606 1 - v1 error format
607 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400608
609Returns:
610 An object of the form:
611
612 { # Contains a list of TargetPool resources.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800613 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
614 &quot;items&quot;: [ # A list of TargetPool resources.
yoshi-code-bot0f0918f2021-06-11 00:22:02 -0700615 { # Represents a Target Pool resource. 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.
616 &quot;backupPool&quot;: &quot;A String&quot;, # The server-defined URL for the resource. 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]. 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. 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 &quot;force&quot; mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800617 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp in RFC3339 text format.
618 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you create the resource.
yoshi-code-bot0f0918f2021-06-11 00:22:02 -0700619 &quot;failoverRatio&quot;: 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]. 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. 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 &quot;force&quot; mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800620 &quot;healthChecks&quot;: [ # The URL of the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if the health checks pass. Only legacy HttpHealthChecks are supported. Only one health check may be specified.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800621 &quot;A String&quot;,
622 ],
623 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
624 &quot;instances&quot;: [ # 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.
625 &quot;A String&quot;,
626 ],
627 &quot;kind&quot;: &quot;compute#targetPool&quot;, # [Output Only] Type of the resource. Always compute#targetPool for target pools.
628 &quot;name&quot;: &quot;A String&quot;, # 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.
629 &quot;region&quot;: &quot;A String&quot;, # [Output Only] URL of the region where the target pool resides.
630 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
yoshi-code-bot0f0918f2021-06-11 00:22:02 -0700631 &quot;sessionAffinity&quot;: &quot;A String&quot;, # Session affinity option, must be one of the following values: NONE: Connections from the same client IP may go to any instance in the pool. CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy. 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.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800632 },
633 ],
634 &quot;kind&quot;: &quot;compute#targetPoolList&quot;, # [Output Only] Type of resource. Always compute#targetPoolList for lists of target pools.
635 &quot;nextPageToken&quot;: &quot;A String&quot;, # [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.
636 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource.
637 &quot;warning&quot;: { # [Output Only] Informational warning message.
638 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-bot0f0918f2021-06-11 00:22:02 -0700639 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example: &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800640 {
641 &quot;key&quot;: &quot;A String&quot;, # [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).
642 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
Bu Sun Kim65020912020-05-20 12:08:20 -0700643 },
John Asmuth614db982014-04-24 15:46:26 -0400644 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800645 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
646 },
647}</pre>
John Asmuth614db982014-04-24 15:46:26 -0400648</div>
649
650<div class="method">
651 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
652 <pre>Retrieves the next page of results.
653
654Args:
655 previous_request: The request for the previous page. (required)
656 previous_response: The response from the request for the previous page. (required)
657
658Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700659 A request object that you can call &#x27;execute()&#x27; on to request the next
John Asmuth614db982014-04-24 15:46:26 -0400660 page. Returns None if there are no more items in the collection.
661 </pre>
662</div>
663
664<div class="method">
yoshi-code-bot0f0918f2021-06-11 00:22:02 -0700665 <code class="details" id="removeHealthCheck">removeHealthCheck(project, region, targetPool, body=None, requestId=None, x__xgafv=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800666 <pre>Removes health check URL from a target pool.
John Asmuth614db982014-04-24 15:46:26 -0400667
668Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800669 project: string, Project ID for this request. (required)
670 region: string, Name of the region for this request. (required)
671 targetPool: string, Name of the target pool to remove health checks from. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700672 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400673 The object takes the form of:
674
675{
yoshi-code-bot0f0918f2021-06-11 00:22:02 -0700676 &quot;healthChecks&quot;: [ # Health check URL to be removed. This can be a full or valid partial URL. For example, the following are valid URLs: - https://www.googleapis.com/compute/beta/projects/project /global/httpHealthChecks/health-check - projects/project/global/httpHealthChecks/health-check - global/httpHealthChecks/health-check
677 { # A full or valid partial URL to a health check. For example, the following are valid URLs: - https://www.googleapis.com/compute/beta/projects/project-id/global/httpHealthChecks/health-check - projects/project-id/global/httpHealthChecks/health-check - global/httpHealthChecks/health-check
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800678 &quot;healthCheck&quot;: &quot;A String&quot;,
679 },
680 ],
681}
John Asmuth614db982014-04-24 15:46:26 -0400682
yoshi-code-bot0f0918f2021-06-11 00:22:02 -0700683 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. For 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
684 x__xgafv: string, V1 error format.
685 Allowed values
686 1 - v1 error format
687 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400688
689Returns:
690 An object of the form:
691
yoshi-code-bot0f0918f2021-06-11 00:22:02 -0700692 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800693 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
694 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
695 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
696 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
697 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
698 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700699 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800700 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
701 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
702 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700703 },
704 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800705 },
706 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
707 &quot;httpErrorStatusCode&quot;: 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.
708 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
709 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
710 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
711 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800712 &quot;operationGroupId&quot;: &quot;A String&quot;, # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800713 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
714 &quot;progress&quot;: 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.
715 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
716 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
717 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
718 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
719 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
720 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
721 &quot;targetLink&quot;: &quot;A String&quot;, # [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.
722 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
723 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
724 {
725 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-bot0f0918f2021-06-11 00:22:02 -0700726 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example: &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800727 {
728 &quot;key&quot;: &quot;A String&quot;, # [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).
729 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
730 },
731 ],
732 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
733 },
734 ],
735 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
736}</pre>
John Asmuth614db982014-04-24 15:46:26 -0400737</div>
738
739<div class="method">
yoshi-code-bot0f0918f2021-06-11 00:22:02 -0700740 <code class="details" id="removeInstance">removeInstance(project, region, targetPool, body=None, requestId=None, x__xgafv=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800741 <pre>Removes instance URL from a target pool.
John Asmuth614db982014-04-24 15:46:26 -0400742
743Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800744 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400745 region: string, Name of the region scoping this request. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800746 targetPool: string, Name of the TargetPool resource to remove instances from. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700747 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400748 The object takes the form of:
749
750{
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800751 &quot;instances&quot;: [ # URLs of the instances to be removed from target pool.
752 {
yoshi-code-bot0f0918f2021-06-11 00:22:02 -0700753 &quot;instance&quot;: &quot;A String&quot;, # The URL for a specific instance. @required compute.instancegroups.addInstances/removeInstances
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800754 },
755 ],
756}
John Asmuth614db982014-04-24 15:46:26 -0400757
yoshi-code-bot0f0918f2021-06-11 00:22:02 -0700758 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. For 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
759 x__xgafv: string, V1 error format.
760 Allowed values
761 1 - v1 error format
762 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400763
764Returns:
765 An object of the form:
766
yoshi-code-bot0f0918f2021-06-11 00:22:02 -0700767 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800768 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
769 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
770 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
771 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
772 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
773 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700774 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800775 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
776 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
777 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700778 },
779 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800780 },
781 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
782 &quot;httpErrorStatusCode&quot;: 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.
783 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
784 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
785 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
786 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800787 &quot;operationGroupId&quot;: &quot;A String&quot;, # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800788 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
789 &quot;progress&quot;: 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.
790 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
791 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
792 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
793 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
794 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
795 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
796 &quot;targetLink&quot;: &quot;A String&quot;, # [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.
797 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
798 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
799 {
800 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-bot0f0918f2021-06-11 00:22:02 -0700801 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example: &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800802 {
803 &quot;key&quot;: &quot;A String&quot;, # [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).
804 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
805 },
806 ],
807 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
808 },
809 ],
810 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
811}</pre>
John Asmuth614db982014-04-24 15:46:26 -0400812</div>
813
814<div class="method">
yoshi-code-bot0f0918f2021-06-11 00:22:02 -0700815 <code class="details" id="setBackup">setBackup(project, region, targetPool, body=None, failoverRatio=None, requestId=None, x__xgafv=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700816 <pre>Changes a backup target pool&#x27;s configurations.
John Asmuth614db982014-04-24 15:46:26 -0400817
818Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800819 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400820 region: string, Name of the region scoping this request. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800821 targetPool: string, Name of the TargetPool resource to set a backup pool for. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700822 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400823 The object takes the form of:
824
825{
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800826 &quot;target&quot;: &quot;A String&quot;,
827}
John Asmuth614db982014-04-24 15:46:26 -0400828
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800829 failoverRatio: number, New failoverRatio value for the target pool.
yoshi-code-bot0f0918f2021-06-11 00:22:02 -0700830 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. For 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
831 x__xgafv: string, V1 error format.
832 Allowed values
833 1 - v1 error format
834 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400835
836Returns:
837 An object of the form:
838
yoshi-code-bot0f0918f2021-06-11 00:22:02 -0700839 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800840 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
841 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
842 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
843 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
844 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
845 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700846 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800847 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
848 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
849 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700850 },
851 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800852 },
853 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
854 &quot;httpErrorStatusCode&quot;: 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.
855 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
856 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
857 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
858 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800859 &quot;operationGroupId&quot;: &quot;A String&quot;, # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800860 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
861 &quot;progress&quot;: 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.
862 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
863 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
864 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
865 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
866 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
867 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
868 &quot;targetLink&quot;: &quot;A String&quot;, # [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.
869 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
870 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
871 {
872 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-bot0f0918f2021-06-11 00:22:02 -0700873 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example: &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800874 {
875 &quot;key&quot;: &quot;A String&quot;, # [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).
876 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
877 },
878 ],
879 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
880 },
881 ],
882 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
883}</pre>
John Asmuth614db982014-04-24 15:46:26 -0400884</div>
885
886</body></html>