Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 715bd7f9ca9a324a05ee05a6476af383e54930f9 / . / docs / dyn / compute_v1.targetPools.html
blob: 81c34c7396db05a344686a78a32d7086caf8606d [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="compute_v1.html">Compute Engine API</a> . <a href="compute_v1.targetPools.html">targetPools</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]78 <code><a href="#addHealthCheck">addHealthCheck(project, region, targetPool, body, requestId=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]79<p class="firstline">Adds health check URLs to a target pool.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]80<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]81 <code><a href="#addInstance">addInstance(project, region, targetPool, body, requestId=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]82<p class="firstline">Adds an instance to a target pool.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]83<p class="toc_element">
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]84 <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]85<p class="firstline">Retrieves an aggregated list of target pools.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]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">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]90 <code><a href="#delete">delete(project, region, targetPool, requestId=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]91<p class="firstline">Deletes the specified target pool.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]92<p class="toc_element">
93 <code><a href="#get">get(project, region, targetPool)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]94<p class="firstline">Returns the specified target pool. Gets a list of available target pools by making a list() request.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]95<p class="toc_element">
96 <code><a href="#getHealth">getHealth(project, region, targetPool, body)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]97<p class="firstline">Gets the most recent health check results for each IP for the instance that is referenced by the given target pool.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]98<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]99 <code><a href="#insert">insert(project, region, body, requestId=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]100<p class="firstline">Creates a target pool in the specified project and region using the data included in the request.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]101<p class="toc_element">
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]102 <code><a href="#list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]103<p class="firstline">Retrieves a list of target pools available to the specified project and region.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]104<p class="toc_element">
105 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
106<p class="firstline">Retrieves the next page of results.</p>
107<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]108 <code><a href="#removeHealthCheck">removeHealthCheck(project, region, targetPool, body, requestId=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]109<p class="firstline">Removes health check URL from a target pool.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]110<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]111 <code><a href="#removeInstance">removeInstance(project, region, targetPool, body, requestId=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]112<p class="firstline">Removes instance URL from a target pool.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]113<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]114 <code><a href="#setBackup">setBackup(project, region, targetPool, body, failoverRatio=None, requestId=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]115<p class="firstline">Changes a backup target pool's configurations.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]116<h3>Method Details</h3>
117<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]118 <code class="details" id="addHealthCheck">addHealthCheck(project, region, targetPool, body, requestId=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]119 <pre>Adds health check URLs to a target pool.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]120
121Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]122 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]123 region: string, Name of the region scoping this request. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]124 targetPool: string, Name of the target pool to add a health check to. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]125 body: object, The request body. (required)
126 The object takes the form of:
127
128{
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]129 "healthChecks": [ # The HttpHealthCheck to add to the target pool.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]130 { # A full or valid partial URL to a health check. For example, the following are valid URLs:
131 # - https://www.googleapis.com/compute/beta/projects/project-id/global/httpHealthChecks/health-check
132 # - projects/project-id/global/httpHealthChecks/health-check
133 # - global/httpHealthChecks/health-check
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]134 "healthCheck": "A String",
135 },
136 ],
137 }
138
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]139 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
140
141For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
142
143The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]144
145Returns:
146 An object of the form:
147
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]148 { # Represents an Operation resource.
149 #
150 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
151 #
152 # Operations can be global, regional or zonal.
153 # - For global operations, use the globalOperations resource.
154 # - For regional operations, use the regionOperations resource.
155 # - For zonal operations, use the zonalOperations resource.
156 #
157 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]158 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]159 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]160 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]161 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]162 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]163 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
164 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]165 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]166 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
167 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]168 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]169 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
170 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]171 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]172 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]173 "message": "A String", # [Output Only] A human-readable description of the warning code.
174 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
175 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
176 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]177 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]178 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]179 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]180 },
181 ],
182 },
183 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]184 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]185 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
186 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]187 "name": "A String", # [Output Only] Name of the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]188 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]189 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]190 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]191 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]192 "message": "A String", # [Output Only] An optional, human-readable error message.
193 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]194 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]195 },
196 ],
197 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]198 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]199 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]200 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]201 }</pre>
202</div>
203
204<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]205 <code class="details" id="addInstance">addInstance(project, region, targetPool, body, requestId=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]206 <pre>Adds an instance to a target pool.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]207
208Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]209 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]210 region: string, Name of the region scoping this request. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]211 targetPool: string, Name of the TargetPool resource to add instances to. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]212 body: object, The request body. (required)
213 The object takes the form of:
214
215{
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]216 "instances": [ # A full or partial URL to an instance to add to this target pool. This can be a full or partial URL. For example, the following are valid URLs:
217 # - https://www.googleapis.com/compute/v1/projects/project-id/zones/zone/instances/instance-name
218 # - projects/project-id/zones/zone/instances/instance-name
219 # - zones/zone/instances/instance-name
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]220 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]221 "instance": "A String", # The URL for a specific instance.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]222 },
223 ],
224 }
225
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]226 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.
227
228For 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.
229
230The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]231
232Returns:
233 An object of the form:
234
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]235 { # Represents an Operation resource.
236 #
237 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
238 #
239 # Operations can be global, regional or zonal.
240 # - For global operations, use the globalOperations resource.
241 # - For regional operations, use the regionOperations resource.
242 # - For zonal operations, use the zonalOperations resource.
243 #
244 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]245 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]246 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]247 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]248 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]249 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]250 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
251 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]252 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]253 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
254 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]255 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]256 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
257 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]258 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]259 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]260 "message": "A String", # [Output Only] A human-readable description of the warning code.
261 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
262 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
263 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]264 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]265 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]266 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]267 },
268 ],
269 },
270 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]271 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]272 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
273 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]274 "name": "A String", # [Output Only] Name of the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]275 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]276 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]277 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]278 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]279 "message": "A String", # [Output Only] An optional, human-readable error message.
280 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]281 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]282 },
283 ],
284 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]285 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]286 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]287 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]288 }</pre>
289</div>
290
291<div class="method">
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]292 <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]293 <pre>Retrieves an aggregated list of target pools.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]294
295Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]296 project: string, Project ID for this request. (required)
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]297 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
298
299You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
300
301Currently, only sorting by name or creationTimestamp desc is supported.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]302 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)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]303 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]304 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 =, !=, >, or <.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]305
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]306For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]307
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]308You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]309
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]310To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]311
312Returns:
313 An object of the form:
314
315 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]316 "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]317 "kind": "compute#targetPoolAggregatedList", # [Output Only] Type of resource. Always compute#targetPoolAggregatedList for aggregated lists of target pools.
318 "items": { # A list of TargetPool resources.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]319 "a_key": { # Name of the scope containing this set of target pools.
320 "warning": { # Informational warning which replaces the list of addresses when the list is empty.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]321 "message": "A String", # [Output Only] A human-readable description of the warning code.
322 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
323 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
324 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]325 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]326 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]327 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]328 },
329 ],
330 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]331 "targetPools": [ # A list of target pools contained in this scope.
332 { # A TargetPool resource. This resource defines a pool of instances, an associated HttpHealthCheck resource, and the fallback target pool. (== resource_for beta.targetPools ==) (== resource_for v1.targetPools ==)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]333 "failoverRatio": 3.14, # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool (i.e., not as a backup pool to some other target pool). The value of the field must be in [0, 1].
334 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]335 # If set, backupPool must also be set. They together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below this number, traffic arriving at the load-balanced IP will be directed to the backup pool.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]336 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]337 # In case where failoverRatio is not set or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]338 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]339 "region": "A String", # [Output Only] URL of the region where the target pool resides.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]340 "kind": "compute#targetPool", # [Output Only] Type of the resource. Always compute#targetPool for target pools.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]341 "sessionAffinity": "A String", # Session affinity option, must be one of the following values:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]342 # NONE: Connections from the same client IP may go to any instance in the pool.
343 # CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy.
344 # 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.
345 "instances": [ # A list of resource URLs to the virtual machine instances serving this pool. They must live in zones contained in the same region as this pool.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]346 "A String",
347 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]348 "backupPool": "A String", # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1].
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]349 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]350 # backupPool and failoverRatio together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below failoverRatio, traffic arriving at the load-balanced IP will be directed to the backup pool.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]351 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]352 # In case where failoverRatio and backupPool are not set, or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]353 "healthChecks": [ # The URL of the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if the health checks pass. An empty list means all member instances will be considered healthy at all times. Only HttpHealthChecks are supported. Only one health check may be specified.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]354 "A String",
355 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]356 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]357 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]358 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]359 "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]360 },
361 ],
362 },
363 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]364 "warning": { # [Output Only] Informational warning message.
365 "message": "A String", # [Output Only] A human-readable description of the warning code.
366 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
367 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
368 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
369 {
370 "value": "A String", # [Output Only] A warning data value corresponding to the key.
371 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
372 },
373 ],
374 },
375 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]376 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]377 }</pre>
378</div>
379
380<div class="method">
381 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>
382 <pre>Retrieves the next page of results.
383
384Args:
385 previous_request: The request for the previous page. (required)
386 previous_response: The response from the request for the previous page. (required)
387
388Returns:
389 A request object that you can call 'execute()' on to request the next
390 page. Returns None if there are no more items in the collection.
391 </pre>
392</div>
393
394<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]395 <code class="details" id="delete">delete(project, region, targetPool, requestId=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]396 <pre>Deletes the specified target pool.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]397
398Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]399 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]400 region: string, Name of the region scoping this request. (required)
401 targetPool: string, Name of the TargetPool resource to delete. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]402 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.
403
404For 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.
405
406The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]407
408Returns:
409 An object of the form:
410
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]411 { # Represents an Operation resource.
412 #
413 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
414 #
415 # Operations can be global, regional or zonal.
416 # - For global operations, use the globalOperations resource.
417 # - For regional operations, use the regionOperations resource.
418 # - For zonal operations, use the zonalOperations resource.
419 #
420 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]421 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]422 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]423 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]424 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]425 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]426 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
427 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]428 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]429 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
430 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]431 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]432 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
433 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]434 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]435 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]436 "message": "A String", # [Output Only] A human-readable description of the warning code.
437 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
438 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
439 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]440 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]441 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]442 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]443 },
444 ],
445 },
446 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]447 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]448 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
449 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]450 "name": "A String", # [Output Only] Name of the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]451 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]452 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]453 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]454 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]455 "message": "A String", # [Output Only] An optional, human-readable error message.
456 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]457 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]458 },
459 ],
460 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]461 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]462 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]463 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]464 }</pre>
465</div>
466
467<div class="method">
468 <code class="details" id="get">get(project, region, targetPool)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]469 <pre>Returns the specified target pool. Gets a list of available target pools by making a list() request.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]470
471Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]472 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]473 region: string, Name of the region scoping this request. (required)
474 targetPool: string, Name of the TargetPool resource to return. (required)
475
476Returns:
477 An object of the form:
478
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]479 { # A TargetPool resource. This resource defines a pool of instances, an associated HttpHealthCheck resource, and the fallback target pool. (== resource_for beta.targetPools ==) (== resource_for v1.targetPools ==)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]480 "failoverRatio": 3.14, # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool (i.e., not as a backup pool to some other target pool). The value of the field must be in [0, 1].
481 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]482 # If set, backupPool must also be set. They together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below this number, traffic arriving at the load-balanced IP will be directed to the backup pool.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]483 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]484 # In case where failoverRatio is not set or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]485 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]486 "region": "A String", # [Output Only] URL of the region where the target pool resides.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]487 "kind": "compute#targetPool", # [Output Only] Type of the resource. Always compute#targetPool for target pools.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]488 "sessionAffinity": "A String", # Session affinity option, must be one of the following values:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]489 # NONE: Connections from the same client IP may go to any instance in the pool.
490 # CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy.
491 # 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.
492 "instances": [ # A list of resource URLs to the virtual machine instances serving this pool. They must live in zones contained in the same region as this pool.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]493 "A String",
494 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]495 "backupPool": "A String", # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1].
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]496 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]497 # backupPool and failoverRatio together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below failoverRatio, traffic arriving at the load-balanced IP will be directed to the backup pool.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]498 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]499 # In case where failoverRatio and backupPool are not set, or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]500 "healthChecks": [ # The URL of the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if the health checks pass. An empty list means all member instances will be considered healthy at all times. Only HttpHealthChecks are supported. Only one health check may be specified.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]501 "A String",
502 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]503 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]504 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]505 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]506 "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]507 }</pre>
508</div>
509
510<div class="method">
511 <code class="details" id="getHealth">getHealth(project, region, targetPool, body)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]512 <pre>Gets the most recent health check results for each IP for the instance that is referenced by the given target pool.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]513
514Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]515 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]516 region: string, Name of the region scoping this request. (required)
517 targetPool: string, Name of the TargetPool resource to which the queried instance belongs. (required)
518 body: object, The request body. (required)
519 The object takes the form of:
520
521{
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]522 "instance": "A String", # The URL for a specific instance.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]523}
524
525
526Returns:
527 An object of the form:
528
529 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]530 "kind": "compute#targetPoolInstanceHealth", # [Output Only] Type of resource. Always compute#targetPoolInstanceHealth when checking the health of an instance.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]531 "healthStatus": [
532 {
533 "instance": "A String", # URL of the instance resource.
534 "healthState": "A String", # Health state of the instance.
535 "ipAddress": "A String", # The IP address represented by this resource.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]536 "port": 42, # The port on the instance.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]537 },
538 ],
539 }</pre>
540</div>
541
542<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]543 <code class="details" id="insert">insert(project, region, body, requestId=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]544 <pre>Creates a target pool in the specified project and region using the data included in the request.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]545
546Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]547 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]548 region: string, Name of the region scoping this request. (required)
549 body: object, The request body. (required)
550 The object takes the form of:
551
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]552{ # A TargetPool resource. This resource defines a pool of instances, an associated HttpHealthCheck resource, and the fallback target pool. (== resource_for beta.targetPools ==) (== resource_for v1.targetPools ==)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]553 "failoverRatio": 3.14, # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool (i.e., not as a backup pool to some other target pool). The value of the field must be in [0, 1].
554 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]555 # If set, backupPool must also be set. They together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below this number, traffic arriving at the load-balanced IP will be directed to the backup pool.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]556 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]557 # In case where failoverRatio is not set or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]558 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]559 "region": "A String", # [Output Only] URL of the region where the target pool resides.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]560 "kind": "compute#targetPool", # [Output Only] Type of the resource. Always compute#targetPool for target pools.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]561 "sessionAffinity": "A String", # Session affinity option, must be one of the following values:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]562 # NONE: Connections from the same client IP may go to any instance in the pool.
563 # CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy.
564 # 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.
565 "instances": [ # A list of resource URLs to the virtual machine instances serving this pool. They must live in zones contained in the same region as this pool.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]566 "A String",
567 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]568 "backupPool": "A String", # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1].
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]569 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]570 # backupPool and failoverRatio together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below failoverRatio, traffic arriving at the load-balanced IP will be directed to the backup pool.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]571 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]572 # In case where failoverRatio and backupPool are not set, or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]573 "healthChecks": [ # The URL of the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if the health checks pass. An empty list means all member instances will be considered healthy at all times. Only HttpHealthChecks are supported. Only one health check may be specified.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]574 "A String",
575 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]576 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]577 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]578 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]579 "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]580 }
581
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]582 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.
583
584For 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.
585
586The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]587
588Returns:
589 An object of the form:
590
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]591 { # Represents an Operation resource.
592 #
593 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
594 #
595 # Operations can be global, regional or zonal.
596 # - For global operations, use the globalOperations resource.
597 # - For regional operations, use the regionOperations resource.
598 # - For zonal operations, use the zonalOperations resource.
599 #
600 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]601 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]602 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]603 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]604 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]605 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]606 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
607 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]608 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]609 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
610 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]611 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]612 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
613 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]614 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]615 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]616 "message": "A String", # [Output Only] A human-readable description of the warning code.
617 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
618 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
619 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]620 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]621 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]622 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]623 },
624 ],
625 },
626 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]627 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]628 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
629 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]630 "name": "A String", # [Output Only] Name of the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]631 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]632 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]633 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]634 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]635 "message": "A String", # [Output Only] An optional, human-readable error message.
636 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]637 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]638 },
639 ],
640 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]641 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]642 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]643 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]644 }</pre>
645</div>
646
647<div class="method">
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]648 <code class="details" id="list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]649 <pre>Retrieves a list of target pools available to the specified project and region.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]650
651Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]652 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]653 region: string, Name of the region scoping this request. (required)
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]654 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
655
656You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
657
658Currently, only sorting by name or creationTimestamp desc is supported.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]659 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)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]660 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]661 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 =, !=, >, or <.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]662
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]663For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]664
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]665You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]666
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]667To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]668
669Returns:
670 An object of the form:
671
672 { # Contains a list of TargetPool resources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]673 "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]674 "kind": "compute#targetPoolList", # [Output Only] Type of resource. Always compute#targetPoolList for lists of target pools.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]675 "items": [ # A list of TargetPool resources.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]676 { # A TargetPool resource. This resource defines a pool of instances, an associated HttpHealthCheck resource, and the fallback target pool. (== resource_for beta.targetPools ==) (== resource_for v1.targetPools ==)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]677 "failoverRatio": 3.14, # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool (i.e., not as a backup pool to some other target pool). The value of the field must be in [0, 1].
678 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]679 # If set, backupPool must also be set. They together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below this number, traffic arriving at the load-balanced IP will be directed to the backup pool.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]680 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]681 # In case where failoverRatio is not set or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]682 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]683 "region": "A String", # [Output Only] URL of the region where the target pool resides.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]684 "kind": "compute#targetPool", # [Output Only] Type of the resource. Always compute#targetPool for target pools.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]685 "sessionAffinity": "A String", # Session affinity option, must be one of the following values:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]686 # NONE: Connections from the same client IP may go to any instance in the pool.
687 # CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy.
688 # 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.
689 "instances": [ # A list of resource URLs to the virtual machine instances serving this pool. They must live in zones contained in the same region as this pool.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]690 "A String",
691 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]692 "backupPool": "A String", # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1].
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]693 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]694 # backupPool and failoverRatio together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below failoverRatio, traffic arriving at the load-balanced IP will be directed to the backup pool.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]695 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]696 # In case where failoverRatio and backupPool are not set, or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]697 "healthChecks": [ # The URL of the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if the health checks pass. An empty list means all member instances will be considered healthy at all times. Only HttpHealthChecks are supported. Only one health check may be specified.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]698 "A String",
699 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]700 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]701 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]702 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]703 "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]704 },
705 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]706 "warning": { # [Output Only] Informational warning message.
707 "message": "A String", # [Output Only] A human-readable description of the warning code.
708 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
709 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
710 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
711 {
712 "value": "A String", # [Output Only] A warning data value corresponding to the key.
713 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
714 },
715 ],
716 },
717 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]718 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]719 }</pre>
720</div>
721
722<div class="method">
723 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
724 <pre>Retrieves the next page of results.
725
726Args:
727 previous_request: The request for the previous page. (required)
728 previous_response: The response from the request for the previous page. (required)
729
730Returns:
731 A request object that you can call 'execute()' on to request the next
732 page. Returns None if there are no more items in the collection.
733 </pre>
734</div>
735
736<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]737 <code class="details" id="removeHealthCheck">removeHealthCheck(project, region, targetPool, body, requestId=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]738 <pre>Removes health check URL from a target pool.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]739
740Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]741 project: string, Project ID for this request. (required)
742 region: string, Name of the region for this request. (required)
743 targetPool: string, Name of the target pool to remove health checks from. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]744 body: object, The request body. (required)
745 The object takes the form of:
746
747{
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]748 "healthChecks": [ # Health check URL to be removed. This can be a full or valid partial URL. For example, the following are valid URLs:
749 # - https://www.googleapis.com/compute/beta/projects/project/global/httpHealthChecks/health-check
750 # - projects/project/global/httpHealthChecks/health-check
751 # - global/httpHealthChecks/health-check
752 { # A full or valid partial URL to a health check. For example, the following are valid URLs:
753 # - https://www.googleapis.com/compute/beta/projects/project-id/global/httpHealthChecks/health-check
754 # - projects/project-id/global/httpHealthChecks/health-check
755 # - global/httpHealthChecks/health-check
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]756 "healthCheck": "A String",
757 },
758 ],
759 }
760
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]761 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.
762
763For 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.
764
765The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]766
767Returns:
768 An object of the form:
769
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]770 { # Represents an Operation resource.
771 #
772 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
773 #
774 # Operations can be global, regional or zonal.
775 # - For global operations, use the globalOperations resource.
776 # - For regional operations, use the regionOperations resource.
777 # - For zonal operations, use the zonalOperations resource.
778 #
779 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]780 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]781 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]782 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]783 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]784 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]785 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
786 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]787 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]788 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
789 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]790 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]791 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
792 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]793 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]794 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]795 "message": "A String", # [Output Only] A human-readable description of the warning code.
796 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
797 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
798 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]799 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]800 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]801 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]802 },
803 ],
804 },
805 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]806 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]807 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
808 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]809 "name": "A String", # [Output Only] Name of the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]810 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]811 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]812 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]813 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]814 "message": "A String", # [Output Only] An optional, human-readable error message.
815 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]816 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]817 },
818 ],
819 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]820 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]821 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]822 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]823 }</pre>
824</div>
825
826<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]827 <code class="details" id="removeInstance">removeInstance(project, region, targetPool, body, requestId=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]828 <pre>Removes instance URL from a target pool.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]829
830Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]831 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]832 region: string, Name of the region scoping this request. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]833 targetPool: string, Name of the TargetPool resource to remove instances from. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]834 body: object, The request body. (required)
835 The object takes the form of:
836
837{
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]838 "instances": [ # URLs of the instances to be removed from target pool.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]839 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]840 "instance": "A String", # The URL for a specific instance.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]841 },
842 ],
843 }
844
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]845 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.
846
847For 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.
848
849The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]850
851Returns:
852 An object of the form:
853
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]854 { # Represents an Operation resource.
855 #
856 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
857 #
858 # Operations can be global, regional or zonal.
859 # - For global operations, use the globalOperations resource.
860 # - For regional operations, use the regionOperations resource.
861 # - For zonal operations, use the zonalOperations resource.
862 #
863 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]864 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]865 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]866 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]867 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]868 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]869 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
870 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]871 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]872 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
873 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]874 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]875 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
876 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]877 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]878 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]879 "message": "A String", # [Output Only] A human-readable description of the warning code.
880 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
881 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
882 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]883 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]884 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]885 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]886 },
887 ],
888 },
889 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]890 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]891 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
892 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]893 "name": "A String", # [Output Only] Name of the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]894 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]895 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]896 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]897 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]898 "message": "A String", # [Output Only] An optional, human-readable error message.
899 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]900 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]901 },
902 ],
903 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]904 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]905 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]906 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]907 }</pre>
908</div>
909
910<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]911 <code class="details" id="setBackup">setBackup(project, region, targetPool, body, failoverRatio=None, requestId=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]912 <pre>Changes a backup target pool's configurations.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]913
914Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]915 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]916 region: string, Name of the region scoping this request. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]917 targetPool: string, Name of the TargetPool resource to set a backup pool for. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]918 body: object, The request body. (required)
919 The object takes the form of:
920
921{
922 "target": "A String",
923 }
924
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]925 failoverRatio: number, New failoverRatio value for the target pool.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]926 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.
927
928For 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.
929
930The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]931
932Returns:
933 An object of the form:
934
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]935 { # Represents an Operation resource.
936 #
937 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
938 #
939 # Operations can be global, regional or zonal.
940 # - For global operations, use the globalOperations resource.
941 # - For regional operations, use the regionOperations resource.
942 # - For zonal operations, use the zonalOperations resource.
943 #
944 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]945 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]946 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]947 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]948 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]949 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]950 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
951 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]952 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]953 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
954 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]955 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]956 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
957 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]958 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]959 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]960 "message": "A String", # [Output Only] A human-readable description of the warning code.
961 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
962 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
963 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]964 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]965 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]966 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]967 },
968 ],
969 },
970 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]971 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]972 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
973 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]974 "name": "A String", # [Output Only] Name of the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]975 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]976 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]977 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]978 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]979 "message": "A String", # [Output Only] An optional, human-readable error message.
980 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]981 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]982 },
983 ],
984 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]985 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]986 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]987 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]988 }</pre>
989</div>
990
991</body></html>