blob: 9c60ef084e982424af59b87a8682cc91a87bc0da [file] [log] [blame]
Sai Cheemalapatidf613972016-10-21 13:59:49 -07001<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="compute_alpha.html">Compute Engine API</a> . <a href="compute_alpha.targetPools.html">targetPools</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
yoshi-code-bot36591372021-06-16 00:22:06 -070078 <code><a href="#addHealthCheck">addHealthCheck(project, region, targetPool, body=None, requestId=None, x__xgafv=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -070079<p class="firstline">Adds health check URLs to a target pool.</p>
80<p class="toc_element">
yoshi-code-bot36591372021-06-16 00:22:06 -070081 <code><a href="#addInstance">addInstance(project, region, targetPool, body=None, requestId=None, x__xgafv=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -070082<p class="firstline">Adds an instance to a target pool.</p>
83<p class="toc_element">
yoshi-code-bot36591372021-06-16 00:22:06 -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>
Sai Cheemalapatidf613972016-10-21 13:59:49 -070085<p class="firstline">Retrieves an aggregated list of target pools.</p>
86<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-bot36591372021-06-16 00:22:06 -070093 <code><a href="#delete">delete(project, region, targetPool, requestId=None, x__xgafv=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -070094<p class="firstline">Deletes the specified target pool.</p>
95<p class="toc_element">
yoshi-code-bot36591372021-06-16 00:22:06 -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>
Sai Cheemalapatidf613972016-10-21 13:59:49 -070098<p class="toc_element">
yoshi-code-bot36591372021-06-16 00:22:06 -070099 <code><a href="#getHealth">getHealth(project, region, targetPool, body=None, x__xgafv=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700100<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>
101<p class="toc_element">
yoshi-code-bot36591372021-06-16 00:22:06 -0700102 <code><a href="#insert">insert(project, region, body=None, requestId=None, x__xgafv=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700103<p class="firstline">Creates a target pool in the specified project and region using the data included in the request.</p>
104<p class="toc_element">
yoshi-code-bot36591372021-06-16 00:22:06 -0700105 <code><a href="#list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700106<p class="firstline">Retrieves a list of target pools available to the specified project and region.</p>
107<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-bot36591372021-06-16 00:22:06 -0700111 <code><a href="#removeHealthCheck">removeHealthCheck(project, region, targetPool, body=None, requestId=None, x__xgafv=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700112<p class="firstline">Removes health check URL from a target pool.</p>
113<p class="toc_element">
yoshi-code-bot36591372021-06-16 00:22:06 -0700114 <code><a href="#removeInstance">removeInstance(project, region, targetPool, body=None, requestId=None, x__xgafv=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700115<p class="firstline">Removes instance URL from a target pool.</p>
116<p class="toc_element">
yoshi-code-bot36591372021-06-16 00:22:06 -0700117 <code><a href="#setBackup">setBackup(project, region, targetPool, body=None, failoverRatio=None, requestId=None, x__xgafv=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700118<p class="firstline">Changes a backup target pool's configurations.</p>
119<p class="toc_element">
yoshi-code-bot36591372021-06-16 00:22:06 -0700120 <code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body=None, x__xgafv=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700121<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
122<h3>Method Details</h3>
123<div class="method">
yoshi-code-bot36591372021-06-16 00:22:06 -0700124 <code class="details" id="addHealthCheck">addHealthCheck(project, region, targetPool, body=None, requestId=None, x__xgafv=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700125 <pre>Adds health check URLs to a target pool.
126
127Args:
128 project: string, Project ID for this request. (required)
129 region: string, Name of the region scoping this request. (required)
130 targetPool: string, Name of the target pool to add a health check to. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700131 body: object, The request body.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700132 The object takes the form of:
133
134{
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800135 &quot;healthChecks&quot;: [ # The HttpHealthCheck to add to the target pool.
yoshi-code-bot36591372021-06-16 00:22:06 -0700136 { # 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 -0800137 &quot;healthCheck&quot;: &quot;A String&quot;,
138 },
139 ],
140}
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700141
yoshi-code-bot36591372021-06-16 00:22:06 -0700142 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).
143 x__xgafv: string, V1 error format.
144 Allowed values
145 1 - v1 error format
146 2 - v2 error format
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700147
148Returns:
149 An object of the form:
150
yoshi-code-bot36591372021-06-16 00:22:06 -0700151 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/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 -0800152 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
153 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
154 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
155 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
156 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
157 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700158 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800159 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
160 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
161 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700162 },
163 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800164 },
165 &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`.
166 &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.
167 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
168 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
169 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
yoshi-code-bota41c7b92021-11-02 00:26:17 -0700170 &quot;metadata&quot;: { # [Output Only] Service-specific metadata attached to this operation.
171 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
172 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800173 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800174 &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 -0800175 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
176 &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.
177 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
178 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
179 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource with the resource id.
180 &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.
181 &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`.
182 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
183 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
184 &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.
185 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
186 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
187 {
188 &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-bot36591372021-06-16 00:22:06 -0700189 &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 -0800190 {
191 &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).
192 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
193 },
194 ],
195 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
196 },
197 ],
198 &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.
199}</pre>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700200</div>
201
202<div class="method">
yoshi-code-bot36591372021-06-16 00:22:06 -0700203 <code class="details" id="addInstance">addInstance(project, region, targetPool, body=None, requestId=None, x__xgafv=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700204 <pre>Adds an instance to a target pool.
205
206Args:
207 project: string, Project ID for this request. (required)
208 region: string, Name of the region scoping this request. (required)
209 targetPool: string, Name of the TargetPool resource to add instances to. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700210 body: object, The request body.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700211 The object takes the form of:
212
213{
yoshi-code-bot36591372021-06-16 00:22:06 -0700214 &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 -0800215 {
yoshi-code-bot36591372021-06-16 00:22:06 -0700216 &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 -0800217 },
218 ],
219}
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700220
yoshi-code-bot36591372021-06-16 00:22:06 -0700221 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).
222 x__xgafv: string, V1 error format.
223 Allowed values
224 1 - v1 error format
225 2 - v2 error format
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700226
227Returns:
228 An object of the form:
229
yoshi-code-bot36591372021-06-16 00:22:06 -0700230 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/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 -0800231 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
232 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
233 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
234 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
235 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
236 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700237 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800238 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
239 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
240 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700241 },
242 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800243 },
244 &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`.
245 &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.
246 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
247 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
248 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
yoshi-code-bota41c7b92021-11-02 00:26:17 -0700249 &quot;metadata&quot;: { # [Output Only] Service-specific metadata attached to this operation.
250 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
251 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800252 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800253 &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 -0800254 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
255 &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.
256 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
257 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
258 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource with the resource id.
259 &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.
260 &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`.
261 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
262 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
263 &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.
264 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
265 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
266 {
267 &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-bot36591372021-06-16 00:22:06 -0700268 &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 -0800269 {
270 &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).
271 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
272 },
273 ],
274 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
275 },
276 ],
277 &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.
278}</pre>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700279</div>
280
281<div class="method">
yoshi-code-bot36591372021-06-16 00:22:06 -0700282 <code class="details" id="aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700283 <pre>Retrieves an aggregated list of target pools.
284
285Args:
286 project: string, Project ID for this request. (required)
yoshi-code-bot36591372021-06-16 00:22:06 -0700287 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 -0700288 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 -0700289 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-bot36591372021-06-16 00:22:06 -0700290 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 -0700291 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 -0800292 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
yoshi-code-bot36591372021-06-16 00:22:06 -0700293 x__xgafv: string, V1 error format.
294 Allowed values
295 1 - v1 error format
296 2 - v2 error format
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700297
298Returns:
299 An object of the form:
300
301 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800302 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
303 &quot;items&quot;: { # A list of TargetPool resources.
304 &quot;a_key&quot;: { # Name of the scope containing this set of target pools.
305 &quot;targetPools&quot;: [ # A list of target pools contained in this scope.
yoshi-code-bot36591372021-06-16 00:22:06 -0700306 { # 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.
307 &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 -0800308 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp in RFC3339 text format.
309 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you create the resource.
yoshi-code-bot36591372021-06-16 00:22:06 -0700310 &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 -0800311 &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 -0800312 &quot;A String&quot;,
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700313 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800314 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
315 &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.
316 &quot;A String&quot;,
317 ],
318 &quot;kind&quot;: &quot;compute#targetPool&quot;, # [Output Only] Type of the resource. Always compute#targetPool for target pools.
319 &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.
320 &quot;region&quot;: &quot;A String&quot;, # [Output Only] URL of the region where the target pool resides.
321 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
322 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource with the resource id.
yoshi-code-bot36591372021-06-16 00:22:06 -0700323 &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 -0700324 },
325 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800326 &quot;warning&quot;: { # Informational warning which replaces the list of addresses when the list is empty.
327 &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-bot36591372021-06-16 00:22:06 -0700328 &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 -0800329 {
330 &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).
331 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
332 },
333 ],
334 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
335 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700336 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800337 },
338 &quot;kind&quot;: &quot;compute#targetPoolAggregatedList&quot;, # [Output Only] Type of resource. Always compute#targetPoolAggregatedList for aggregated lists of target pools.
339 &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.
340 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource.
341 &quot;unreachables&quot;: [ # [Output Only] Unreachable resources.
342 &quot;A String&quot;,
343 ],
344 &quot;warning&quot;: { # [Output Only] Informational warning message.
345 &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-bot36591372021-06-16 00:22:06 -0700346 &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 -0800347 {
348 &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).
349 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
350 },
351 ],
352 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
353 },
354}</pre>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700355</div>
356
357<div class="method">
358 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>
359 <pre>Retrieves the next page of results.
360
361Args:
362 previous_request: The request for the previous page. (required)
363 previous_response: The response from the request for the previous page. (required)
364
365Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700366 A request object that you can call &#x27;execute()&#x27; on to request the next
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700367 page. Returns None if there are no more items in the collection.
368 </pre>
369</div>
370
371<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700372 <code class="details" id="close">close()</code>
373 <pre>Close httplib2 connections.</pre>
374</div>
375
376<div class="method">
yoshi-code-bot36591372021-06-16 00:22:06 -0700377 <code class="details" id="delete">delete(project, region, targetPool, requestId=None, x__xgafv=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700378 <pre>Deletes the specified target pool.
379
380Args:
381 project: string, Project ID for this request. (required)
382 region: string, Name of the region scoping this request. (required)
383 targetPool: string, Name of the TargetPool resource to delete. (required)
yoshi-code-bot36591372021-06-16 00:22:06 -0700384 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).
385 x__xgafv: string, V1 error format.
386 Allowed values
387 1 - v1 error format
388 2 - v2 error format
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700389
390Returns:
391 An object of the form:
392
yoshi-code-bot36591372021-06-16 00:22:06 -0700393 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/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 -0800394 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
395 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
396 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
397 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
398 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
399 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700400 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800401 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
402 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
403 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700404 },
405 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800406 },
407 &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`.
408 &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.
409 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
410 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
411 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
yoshi-code-bota41c7b92021-11-02 00:26:17 -0700412 &quot;metadata&quot;: { # [Output Only] Service-specific metadata attached to this operation.
413 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
414 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800415 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800416 &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 -0800417 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
418 &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.
419 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
420 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
421 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource with the resource id.
422 &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.
423 &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`.
424 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
425 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
426 &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.
427 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
428 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
429 {
430 &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-bot36591372021-06-16 00:22:06 -0700431 &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 -0800432 {
433 &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).
434 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
435 },
436 ],
437 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
438 },
439 ],
440 &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.
441}</pre>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700442</div>
443
444<div class="method">
yoshi-code-bot36591372021-06-16 00:22:06 -0700445 <code class="details" id="get">get(project, region, targetPool, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700446 <pre>Returns the specified target pool. Gets a list of available target pools by making a list() request.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700447
448Args:
449 project: string, Project ID for this request. (required)
450 region: string, Name of the region scoping this request. (required)
451 targetPool: string, Name of the TargetPool resource to return. (required)
yoshi-code-bot36591372021-06-16 00:22:06 -0700452 x__xgafv: string, V1 error format.
453 Allowed values
454 1 - v1 error format
455 2 - v2 error format
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700456
457Returns:
458 An object of the form:
459
yoshi-code-bot36591372021-06-16 00:22:06 -0700460 { # 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.
461 &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 -0800462 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp in RFC3339 text format.
463 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you create the resource.
yoshi-code-bot36591372021-06-16 00:22:06 -0700464 &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 -0800465 &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 -0800466 &quot;A String&quot;,
467 ],
468 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
469 &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.
470 &quot;A String&quot;,
471 ],
472 &quot;kind&quot;: &quot;compute#targetPool&quot;, # [Output Only] Type of the resource. Always compute#targetPool for target pools.
473 &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.
474 &quot;region&quot;: &quot;A String&quot;, # [Output Only] URL of the region where the target pool resides.
475 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
476 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource with the resource id.
yoshi-code-bot36591372021-06-16 00:22:06 -0700477 &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 -0800478}</pre>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700479</div>
480
481<div class="method">
yoshi-code-bot36591372021-06-16 00:22:06 -0700482 <code class="details" id="getHealth">getHealth(project, region, targetPool, body=None, x__xgafv=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700483 <pre>Gets the most recent health check results for each IP for the instance that is referenced by the given target pool.
484
485Args:
486 project: string, Project ID for this request. (required)
487 region: string, Name of the region scoping this request. (required)
488 targetPool: string, Name of the TargetPool resource to which the queried instance belongs. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700489 body: object, The request body.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700490 The object takes the form of:
491
492{
yoshi-code-bot36591372021-06-16 00:22:06 -0700493 &quot;instance&quot;: &quot;A String&quot;, # The URL for a specific instance. @required compute.instancegroups.addInstances/removeInstances
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700494}
495
yoshi-code-bot36591372021-06-16 00:22:06 -0700496 x__xgafv: string, V1 error format.
497 Allowed values
498 1 - v1 error format
499 2 - v2 error format
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700500
501Returns:
502 An object of the form:
503
504 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800505 &quot;healthStatus&quot;: [
506 {
507 &quot;annotations&quot;: { # Metadata defined as annotations for network endpoint.
508 &quot;a_key&quot;: &quot;A String&quot;,
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700509 },
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700510 &quot;forwardingRule&quot;: &quot;A String&quot;, # URL of the forwarding rule associated with the health status of the instance.
511 &quot;forwardingRuleIp&quot;: &quot;A String&quot;, # A forwarding rule IP address assigned to this instance.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800512 &quot;healthState&quot;: &quot;A String&quot;, # Health state of the instance.
513 &quot;instance&quot;: &quot;A String&quot;, # URL of the instance resource.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800514 &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 -0800515 &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 -0800516 &quot;weight&quot;: &quot;A String&quot;,
517 &quot;weightError&quot;: &quot;A String&quot;,
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800518 },
519 ],
520 &quot;kind&quot;: &quot;compute#targetPoolInstanceHealth&quot;, # [Output Only] Type of resource. Always compute#targetPoolInstanceHealth when checking the health of an instance.
521}</pre>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700522</div>
523
524<div class="method">
yoshi-code-bot36591372021-06-16 00:22:06 -0700525 <code class="details" id="insert">insert(project, region, body=None, requestId=None, x__xgafv=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700526 <pre>Creates a target pool in the specified project and region using the data included in the request.
527
528Args:
529 project: string, Project ID for this request. (required)
530 region: string, Name of the region scoping this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700531 body: object, The request body.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700532 The object takes the form of:
533
yoshi-code-bot36591372021-06-16 00:22:06 -0700534{ # 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.
535 &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 -0700536 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp in RFC3339 text format.
537 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you create the resource.
yoshi-code-bot36591372021-06-16 00:22:06 -0700538 &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 -0800539 &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 -0700540 &quot;A String&quot;,
541 ],
542 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
543 &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.
544 &quot;A String&quot;,
545 ],
546 &quot;kind&quot;: &quot;compute#targetPool&quot;, # [Output Only] Type of the resource. Always compute#targetPool for target pools.
547 &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.
548 &quot;region&quot;: &quot;A String&quot;, # [Output Only] URL of the region where the target pool resides.
549 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
550 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource with the resource id.
yoshi-code-bot36591372021-06-16 00:22:06 -0700551 &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 -0700552}
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700553
yoshi-code-bot36591372021-06-16 00:22:06 -0700554 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).
555 x__xgafv: string, V1 error format.
556 Allowed values
557 1 - v1 error format
558 2 - v2 error format
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700559
560Returns:
561 An object of the form:
562
yoshi-code-bot36591372021-06-16 00:22:06 -0700563 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/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 -0800564 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
565 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
566 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
567 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
568 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
569 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700570 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800571 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
572 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
573 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700574 },
575 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800576 },
577 &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`.
578 &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.
579 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
580 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
581 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
yoshi-code-bota41c7b92021-11-02 00:26:17 -0700582 &quot;metadata&quot;: { # [Output Only] Service-specific metadata attached to this operation.
583 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
584 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800585 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800586 &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 -0800587 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
588 &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.
589 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
590 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
591 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource with the resource id.
592 &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.
593 &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`.
594 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
595 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
596 &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.
597 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
598 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
599 {
600 &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-bot36591372021-06-16 00:22:06 -0700601 &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 -0800602 {
603 &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).
604 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
605 },
606 ],
607 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
608 },
609 ],
610 &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.
611}</pre>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700612</div>
613
614<div class="method">
yoshi-code-bot36591372021-06-16 00:22:06 -0700615 <code class="details" id="list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700616 <pre>Retrieves a list of target pools available to the specified project and region.
617
618Args:
619 project: string, Project ID for this request. (required)
620 region: string, Name of the region scoping this request. (required)
yoshi-code-bot36591372021-06-16 00:22:06 -0700621 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 -0700622 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-bot36591372021-06-16 00:22:06 -0700623 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 -0700624 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 -0800625 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
yoshi-code-bot36591372021-06-16 00:22:06 -0700626 x__xgafv: string, V1 error format.
627 Allowed values
628 1 - v1 error format
629 2 - v2 error format
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700630
631Returns:
632 An object of the form:
633
634 { # Contains a list of TargetPool resources.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800635 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
636 &quot;items&quot;: [ # A list of TargetPool resources.
yoshi-code-bot36591372021-06-16 00:22:06 -0700637 { # 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.
638 &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 -0800639 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp in RFC3339 text format.
640 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you create the resource.
yoshi-code-bot36591372021-06-16 00:22:06 -0700641 &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 -0800642 &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 -0800643 &quot;A String&quot;,
644 ],
645 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
646 &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.
647 &quot;A String&quot;,
648 ],
649 &quot;kind&quot;: &quot;compute#targetPool&quot;, # [Output Only] Type of the resource. Always compute#targetPool for target pools.
650 &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.
651 &quot;region&quot;: &quot;A String&quot;, # [Output Only] URL of the region where the target pool resides.
652 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
653 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource with the resource id.
yoshi-code-bot36591372021-06-16 00:22:06 -0700654 &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 -0800655 },
656 ],
657 &quot;kind&quot;: &quot;compute#targetPoolList&quot;, # [Output Only] Type of resource. Always compute#targetPoolList for lists of target pools.
658 &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.
659 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource.
660 &quot;warning&quot;: { # [Output Only] Informational warning message.
661 &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-bot36591372021-06-16 00:22:06 -0700662 &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 -0800663 {
664 &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).
665 &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 -0700666 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700667 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800668 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
669 },
670}</pre>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700671</div>
672
673<div class="method">
674 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
675 <pre>Retrieves the next page of results.
676
677Args:
678 previous_request: The request for the previous page. (required)
679 previous_response: The response from the request for the previous page. (required)
680
681Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700682 A request object that you can call &#x27;execute()&#x27; on to request the next
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700683 page. Returns None if there are no more items in the collection.
684 </pre>
685</div>
686
687<div class="method">
yoshi-code-bot36591372021-06-16 00:22:06 -0700688 <code class="details" id="removeHealthCheck">removeHealthCheck(project, region, targetPool, body=None, requestId=None, x__xgafv=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700689 <pre>Removes health check URL from a target pool.
690
691Args:
692 project: string, Project ID for this request. (required)
693 region: string, Name of the region for this request. (required)
694 targetPool: string, Name of the target pool to remove health checks from. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700695 body: object, The request body.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700696 The object takes the form of:
697
698{
yoshi-code-bot36591372021-06-16 00:22:06 -0700699 &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
700 { # 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 -0800701 &quot;healthCheck&quot;: &quot;A String&quot;,
702 },
703 ],
704}
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700705
yoshi-code-bot36591372021-06-16 00:22:06 -0700706 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).
707 x__xgafv: string, V1 error format.
708 Allowed values
709 1 - v1 error format
710 2 - v2 error format
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700711
712Returns:
713 An object of the form:
714
yoshi-code-bot36591372021-06-16 00:22:06 -0700715 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/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 -0800716 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
717 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
718 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
719 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
720 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
721 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700722 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800723 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
724 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
725 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700726 },
727 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800728 },
729 &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`.
730 &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.
731 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
732 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
733 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
yoshi-code-bota41c7b92021-11-02 00:26:17 -0700734 &quot;metadata&quot;: { # [Output Only] Service-specific metadata attached to this operation.
735 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
736 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800737 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800738 &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 -0800739 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
740 &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.
741 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
742 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
743 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource with the resource id.
744 &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.
745 &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`.
746 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
747 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
748 &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.
749 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
750 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
751 {
752 &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-bot36591372021-06-16 00:22:06 -0700753 &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 -0800754 {
755 &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).
756 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
757 },
758 ],
759 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
760 },
761 ],
762 &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.
763}</pre>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700764</div>
765
766<div class="method">
yoshi-code-bot36591372021-06-16 00:22:06 -0700767 <code class="details" id="removeInstance">removeInstance(project, region, targetPool, body=None, requestId=None, x__xgafv=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700768 <pre>Removes instance URL from a target pool.
769
770Args:
771 project: string, Project ID for this request. (required)
772 region: string, Name of the region scoping this request. (required)
773 targetPool: string, Name of the TargetPool resource to remove instances from. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700774 body: object, The request body.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700775 The object takes the form of:
776
777{
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800778 &quot;instances&quot;: [ # URLs of the instances to be removed from target pool.
779 {
yoshi-code-bot36591372021-06-16 00:22:06 -0700780 &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 -0800781 },
782 ],
783}
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700784
yoshi-code-bot36591372021-06-16 00:22:06 -0700785 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).
786 x__xgafv: string, V1 error format.
787 Allowed values
788 1 - v1 error format
789 2 - v2 error format
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700790
791Returns:
792 An object of the form:
793
yoshi-code-bot36591372021-06-16 00:22:06 -0700794 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/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 -0800795 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
796 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
797 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
798 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
799 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
800 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700801 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800802 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
803 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
804 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700805 },
806 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800807 },
808 &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`.
809 &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.
810 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
811 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
812 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
yoshi-code-bota41c7b92021-11-02 00:26:17 -0700813 &quot;metadata&quot;: { # [Output Only] Service-specific metadata attached to this operation.
814 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
815 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800816 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800817 &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 -0800818 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
819 &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.
820 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
821 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
822 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource with the resource id.
823 &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.
824 &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`.
825 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
826 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
827 &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.
828 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
829 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
830 {
831 &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-bot36591372021-06-16 00:22:06 -0700832 &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 -0800833 {
834 &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).
835 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
836 },
837 ],
838 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
839 },
840 ],
841 &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.
842}</pre>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700843</div>
844
845<div class="method">
yoshi-code-bot36591372021-06-16 00:22:06 -0700846 <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 -0700847 <pre>Changes a backup target pool&#x27;s configurations.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700848
849Args:
850 project: string, Project ID for this request. (required)
851 region: string, Name of the region scoping this request. (required)
852 targetPool: string, Name of the TargetPool resource to set a backup pool for. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700853 body: object, The request body.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700854 The object takes the form of:
855
856{
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800857 &quot;target&quot;: &quot;A String&quot;,
858}
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700859
860 failoverRatio: number, New failoverRatio value for the target pool.
yoshi-code-bot36591372021-06-16 00:22:06 -0700861 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).
862 x__xgafv: string, V1 error format.
863 Allowed values
864 1 - v1 error format
865 2 - v2 error format
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700866
867Returns:
868 An object of the form:
869
yoshi-code-bot36591372021-06-16 00:22:06 -0700870 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/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 -0800871 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
872 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
873 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
874 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
875 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
876 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700877 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800878 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
879 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
880 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700881 },
882 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800883 },
884 &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`.
885 &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.
886 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
887 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
888 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
yoshi-code-bota41c7b92021-11-02 00:26:17 -0700889 &quot;metadata&quot;: { # [Output Only] Service-specific metadata attached to this operation.
890 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
891 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800892 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800893 &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 -0800894 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
895 &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.
896 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
897 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
898 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource with the resource id.
899 &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.
900 &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`.
901 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
902 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
903 &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.
904 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
905 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
906 {
907 &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-bot36591372021-06-16 00:22:06 -0700908 &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 -0800909 {
910 &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).
911 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
912 },
913 ],
914 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
915 },
916 ],
917 &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.
918}</pre>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700919</div>
920
921<div class="method">
yoshi-code-bot36591372021-06-16 00:22:06 -0700922 <code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body=None, x__xgafv=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700923 <pre>Returns permissions that a caller has on the specified resource.
924
925Args:
926 project: string, Project ID for this request. (required)
927 region: string, The name of the region for this request. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700928 resource: string, Name or id of the resource for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700929 body: object, The request body.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700930 The object takes the form of:
931
932{
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800933 &quot;permissions&quot;: [ # The set of permissions to check for the &#x27;resource&#x27;. Permissions with wildcards (such as &#x27;*&#x27; or &#x27;storage.*&#x27;) are not allowed.
934 &quot;A String&quot;,
935 ],
936}
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700937
yoshi-code-bot36591372021-06-16 00:22:06 -0700938 x__xgafv: string, V1 error format.
939 Allowed values
940 1 - v1 error format
941 2 - v2 error format
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700942
943Returns:
944 An object of the form:
945
946 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800947 &quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
948 &quot;A String&quot;,
949 ],
950}</pre>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700951</div>
952
953</body></html>