Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 0669410c6b2c48884ae31671b9d710a9ff6346c6 / . / docs / dyn / compute_v1.targetPools.html
blob: a1c2e61fa3ec851566faccf618b38c9d4f8a22c3 [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">
78 <code><a href="#addHealthCheck">addHealthCheck(project, region, targetPool, body)</a></code></p>
79<p class="firstline">Adds health check URL to targetPool.</p>
80<p class="toc_element">
81 <code><a href="#addInstance">addInstance(project, region, targetPool, body)</a></code></p>
82<p class="firstline">Adds instance url to targetPool.</p>
83<p class="toc_element">
84 <code><a href="#aggregatedList">aggregatedList(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
85<p class="firstline">Retrieves the list of target pools grouped by scope.</p>
86<p class="toc_element">
87 <code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p>
88<p class="firstline">Retrieves the next page of results.</p>
89<p class="toc_element">
90 <code><a href="#delete">delete(project, region, targetPool)</a></code></p>
91<p class="firstline">Deletes the specified TargetPool resource.</p>
92<p class="toc_element">
93 <code><a href="#get">get(project, region, targetPool)</a></code></p>
94<p class="firstline">Returns the specified TargetPool resource.</p>
95<p class="toc_element">
96 <code><a href="#getHealth">getHealth(project, region, targetPool, body)</a></code></p>
97<p class="firstline">Gets the most recent health check results for each IP for the given instance that is referenced by given TargetPool.</p>
98<p class="toc_element">
99 <code><a href="#insert">insert(project, region, body)</a></code></p>
100<p class="firstline">Creates a TargetPool resource in the specified project and region using the data included in the request.</p>
101<p class="toc_element">
102 <code><a href="#list">list(project, region, maxResults=None, pageToken=None, filter=None)</a></code></p>
103<p class="firstline">Retrieves the list of TargetPool resources available to the specified project and region.</p>
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">
108 <code><a href="#removeHealthCheck">removeHealthCheck(project, region, targetPool, body)</a></code></p>
109<p class="firstline">Removes health check URL from targetPool.</p>
110<p class="toc_element">
111 <code><a href="#removeInstance">removeInstance(project, region, targetPool, body)</a></code></p>
112<p class="firstline">Removes instance URL from targetPool.</p>
113<p class="toc_element">
114 <code><a href="#setBackup">setBackup(project, region, targetPool, body, failoverRatio=None)</a></code></p>
115<p class="firstline">Changes backup pool configurations.</p>
116<h3>Method Details</h3>
117<div class="method">
118 <code class="details" id="addHealthCheck">addHealthCheck(project, region, targetPool, body)</code>
119 <pre>Adds health check URL to targetPool.
120
121Args:
122 project: string, A parameter (required)
123 region: string, Name of the region scoping this request. (required)
124 targetPool: string, Name of the TargetPool resource to which health_check_url is to be added. (required)
125 body: object, The request body. (required)
126 The object takes the form of:
127
128{
129 "healthChecks": [ # Health check URLs to be added to targetPool.
130 {
131 "healthCheck": "A String",
132 },
133 ],
134 }
135
136
137Returns:
138 An object of the form:
139
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]140 { # An Operation resource, used to manage asynchronous API requests.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]141 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]142 "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]143 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]144 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]145 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
146 "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
147 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]148 "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 at when the operation will be complete. This number should monotonically increase as the operation progresses.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]149 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]150 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]151 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
152 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
153 "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]154 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]155 "message": "A String", # [Output Only] Optional human-readable details for this warning.
156 "code": "A String", # [Output Only] The warning type identifier for this warning.
157 "data": [ # [Output Only] Metadata for this warning in key: value format.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]158 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]159 "value": "A String", # [Output Only] A warning data value corresponding to the key.
160 "key": "A String", # [Output Only] A key for the warning data.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]161 },
162 ],
163 },
164 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]165 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
166 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
167 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
168 "name": "A String", # [Output Only] Name of the resource.
169 "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
170 "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]171 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]172 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]173 "message": "A String", # [Output Only] An optional, human-readable error message.
174 "code": "A String", # [Output Only] The error type identifier for this error.
175 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]176 },
177 ],
178 },
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]179 "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]180 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]181 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]182 }</pre>
183</div>
184
185<div class="method">
186 <code class="details" id="addInstance">addInstance(project, region, targetPool, body)</code>
187 <pre>Adds instance url to targetPool.
188
189Args:
190 project: string, A parameter (required)
191 region: string, Name of the region scoping this request. (required)
192 targetPool: string, Name of the TargetPool resource to which instance_url is to be added. (required)
193 body: object, The request body. (required)
194 The object takes the form of:
195
196{
197 "instances": [ # URLs of the instances to be added to targetPool.
198 {
199 "instance": "A String",
200 },
201 ],
202 }
203
204
205Returns:
206 An object of the form:
207
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]208 { # An Operation resource, used to manage asynchronous API requests.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]209 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]210 "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]211 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]212 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]213 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
214 "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
215 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]216 "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 at when the operation will be complete. This number should monotonically increase as the operation progresses.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]217 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]218 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]219 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
220 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
221 "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]222 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]223 "message": "A String", # [Output Only] Optional human-readable details for this warning.
224 "code": "A String", # [Output Only] The warning type identifier for this warning.
225 "data": [ # [Output Only] Metadata for this warning in key: value format.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]226 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]227 "value": "A String", # [Output Only] A warning data value corresponding to the key.
228 "key": "A String", # [Output Only] A key for the warning data.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]229 },
230 ],
231 },
232 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]233 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
234 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
235 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
236 "name": "A String", # [Output Only] Name of the resource.
237 "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
238 "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]239 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]240 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]241 "message": "A String", # [Output Only] An optional, human-readable error message.
242 "code": "A String", # [Output Only] The error type identifier for this error.
243 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]244 },
245 ],
246 },
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]247 "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]248 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]249 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]250 }</pre>
251</div>
252
253<div class="method">
254 <code class="details" id="aggregatedList">aggregatedList(project, maxResults=None, pageToken=None, filter=None)</code>
255 <pre>Retrieves the list of target pools grouped by scope.
256
257Args:
258 project: string, Name of the project scoping this request. (required)
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]259 maxResults: integer, Maximum count of results to be returned.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]260 pageToken: string, Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.
261 filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.
262
263The FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
264
265For example, filter=name ne example-instance.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]266
267Returns:
268 An object of the form:
269
270 {
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]271 "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]272 "items": { # A map of scoped target pool lists.
273 "a_key": { # Name of the scope containing this set of target pools.
274 "warning": { # Informational warning which replaces the list of addresses when the list is empty.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]275 "message": "A String", # [Output Only] Optional human-readable details for this warning.
276 "code": "A String", # [Output Only] The warning type identifier for this warning.
277 "data": [ # [Output Only] Metadata for this warning in key: value format.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]278 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]279 "value": "A String", # [Output Only] A warning data value corresponding to the key.
280 "key": "A String", # [Output Only] A key for the warning data.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]281 },
282 ],
283 },
284 "targetPools": [ # List of target pools contained in this scope.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]285 { # A TargetPool resource. This resource defines a pool of instances, associated HttpHealthCheck resources, and the fallback TargetPool.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]286 "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].
287 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]288 # 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]289 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]290 # 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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]291 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]292 "region": "A String", # [Output Only] URL of the region where the target pool resides.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]293 "kind": "compute#targetPool", # Type of the resource.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]294 "sessionAffinity": "A String", # Sesssion affinity option, must be one of the following values: NONE: Connections from the same client IP may go to any instance in the pool; CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy. CLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol will go to the same instance in the pool while that instance remains healthy.
295 "instances": [ # A list of resource URLs to the member virtual machines 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]296 "A String",
297 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]298 "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]299 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]300 # 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]301 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]302 # 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.
303 "healthChecks": [ # A list of URLs to the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if all specified health checks pass. An empty list means all member instances will be considered healthy at all times.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]304 "A String",
305 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]306 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
307 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
308 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
309 "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]310 },
311 ],
312 },
313 },
314 "kind": "compute#targetPoolAggregatedList", # Type of resource.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]315 "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server.
316 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]317 }</pre>
318</div>
319
320<div class="method">
321 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>
322 <pre>Retrieves the next page of results.
323
324Args:
325 previous_request: The request for the previous page. (required)
326 previous_response: The response from the request for the previous page. (required)
327
328Returns:
329 A request object that you can call 'execute()' on to request the next
330 page. Returns None if there are no more items in the collection.
331 </pre>
332</div>
333
334<div class="method">
335 <code class="details" id="delete">delete(project, region, targetPool)</code>
336 <pre>Deletes the specified TargetPool resource.
337
338Args:
339 project: string, Name of the project scoping this request. (required)
340 region: string, Name of the region scoping this request. (required)
341 targetPool: string, Name of the TargetPool resource to delete. (required)
342
343Returns:
344 An object of the form:
345
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]346 { # An Operation resource, used to manage asynchronous API requests.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]347 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]348 "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]349 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]350 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]351 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
352 "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
353 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]354 "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 at when the operation will be complete. This number should monotonically increase as the operation progresses.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]355 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]356 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]357 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
358 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
359 "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]360 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]361 "message": "A String", # [Output Only] Optional human-readable details for this warning.
362 "code": "A String", # [Output Only] The warning type identifier for this warning.
363 "data": [ # [Output Only] Metadata for this warning in key: value format.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]364 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]365 "value": "A String", # [Output Only] A warning data value corresponding to the key.
366 "key": "A String", # [Output Only] A key for the warning data.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]367 },
368 ],
369 },
370 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]371 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
372 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
373 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
374 "name": "A String", # [Output Only] Name of the resource.
375 "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
376 "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]377 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]378 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]379 "message": "A String", # [Output Only] An optional, human-readable error message.
380 "code": "A String", # [Output Only] The error type identifier for this error.
381 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]382 },
383 ],
384 },
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]385 "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]386 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]387 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]388 }</pre>
389</div>
390
391<div class="method">
392 <code class="details" id="get">get(project, region, targetPool)</code>
393 <pre>Returns the specified TargetPool resource.
394
395Args:
396 project: string, Name of the project scoping this request. (required)
397 region: string, Name of the region scoping this request. (required)
398 targetPool: string, Name of the TargetPool resource to return. (required)
399
400Returns:
401 An object of the form:
402
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]403 { # A TargetPool resource. This resource defines a pool of instances, associated HttpHealthCheck resources, and the fallback TargetPool.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]404 "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].
405 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]406 # 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]407 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]408 # 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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]409 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]410 "region": "A String", # [Output Only] URL of the region where the target pool resides.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]411 "kind": "compute#targetPool", # Type of the resource.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]412 "sessionAffinity": "A String", # Sesssion affinity option, must be one of the following values: NONE: Connections from the same client IP may go to any instance in the pool; CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy. CLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol will go to the same instance in the pool while that instance remains healthy.
413 "instances": [ # A list of resource URLs to the member virtual machines 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]414 "A String",
415 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]416 "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]417 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]418 # 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]419 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]420 # 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.
421 "healthChecks": [ # A list of URLs to the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if all specified health checks pass. An empty list means all member instances will be considered healthy at all times.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]422 "A String",
423 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]424 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
425 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
426 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
427 "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]428 }</pre>
429</div>
430
431<div class="method">
432 <code class="details" id="getHealth">getHealth(project, region, targetPool, body)</code>
433 <pre>Gets the most recent health check results for each IP for the given instance that is referenced by given TargetPool.
434
435Args:
436 project: string, A parameter (required)
437 region: string, Name of the region scoping this request. (required)
438 targetPool: string, Name of the TargetPool resource to which the queried instance belongs. (required)
439 body: object, The request body. (required)
440 The object takes the form of:
441
442{
443 "instance": "A String",
444}
445
446
447Returns:
448 An object of the form:
449
450 {
451 "kind": "compute#targetPoolInstanceHealth", # Type of resource.
452 "healthStatus": [
453 {
454 "instance": "A String", # URL of the instance resource.
455 "healthState": "A String", # Health state of the instance.
456 "ipAddress": "A String", # The IP address represented by this resource.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]457 "port": 42, # The port on the instance.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]458 },
459 ],
460 }</pre>
461</div>
462
463<div class="method">
464 <code class="details" id="insert">insert(project, region, body)</code>
465 <pre>Creates a TargetPool resource in the specified project and region using the data included in the request.
466
467Args:
468 project: string, Name of the project scoping this request. (required)
469 region: string, Name of the region scoping this request. (required)
470 body: object, The request body. (required)
471 The object takes the form of:
472
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]473{ # A TargetPool resource. This resource defines a pool of instances, associated HttpHealthCheck resources, and the fallback TargetPool.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]474 "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].
475 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]476 # 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]477 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]478 # 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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]479 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]480 "region": "A String", # [Output Only] URL of the region where the target pool resides.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]481 "kind": "compute#targetPool", # Type of the resource.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]482 "sessionAffinity": "A String", # Sesssion affinity option, must be one of the following values: NONE: Connections from the same client IP may go to any instance in the pool; CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy. CLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol will go to the same instance in the pool while that instance remains healthy.
483 "instances": [ # A list of resource URLs to the member virtual machines 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]484 "A String",
485 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]486 "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]487 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]488 # 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]489 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]490 # 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.
491 "healthChecks": [ # A list of URLs to the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if all specified health checks pass. An empty list means all member instances will be considered healthy at all times.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]492 "A String",
493 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]494 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
495 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
496 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
497 "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]498 }
499
500
501Returns:
502 An object of the form:
503
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]504 { # An Operation resource, used to manage asynchronous API requests.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]505 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]506 "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]507 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]508 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]509 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
510 "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
511 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]512 "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 at when the operation will be complete. This number should monotonically increase as the operation progresses.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]513 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]514 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]515 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
516 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
517 "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]518 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]519 "message": "A String", # [Output Only] Optional human-readable details for this warning.
520 "code": "A String", # [Output Only] The warning type identifier for this warning.
521 "data": [ # [Output Only] Metadata for this warning in key: value format.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]522 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]523 "value": "A String", # [Output Only] A warning data value corresponding to the key.
524 "key": "A String", # [Output Only] A key for the warning data.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]525 },
526 ],
527 },
528 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]529 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
530 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
531 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
532 "name": "A String", # [Output Only] Name of the resource.
533 "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
534 "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]535 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]536 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]537 "message": "A String", # [Output Only] An optional, human-readable error message.
538 "code": "A String", # [Output Only] The error type identifier for this error.
539 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]540 },
541 ],
542 },
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]543 "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]544 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]545 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]546 }</pre>
547</div>
548
549<div class="method">
550 <code class="details" id="list">list(project, region, maxResults=None, pageToken=None, filter=None)</code>
551 <pre>Retrieves the list of TargetPool resources available to the specified project and region.
552
553Args:
554 project: string, Name of the project scoping this request. (required)
555 region: string, Name of the region scoping this request. (required)
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]556 maxResults: integer, Maximum count of results to be returned.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]557 pageToken: string, Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.
558 filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.
559
560The FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
561
562For example, filter=name ne example-instance.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]563
564Returns:
565 An object of the form:
566
567 { # Contains a list of TargetPool resources.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]568 "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]569 "items": [ # A list of TargetPool resources.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]570 { # A TargetPool resource. This resource defines a pool of instances, associated HttpHealthCheck resources, and the fallback TargetPool.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]571 "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].
572 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]573 # 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]574 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]575 # 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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]576 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]577 "region": "A String", # [Output Only] URL of the region where the target pool resides.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]578 "kind": "compute#targetPool", # Type of the resource.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]579 "sessionAffinity": "A String", # Sesssion affinity option, must be one of the following values: NONE: Connections from the same client IP may go to any instance in the pool; CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy. CLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol will go to the same instance in the pool while that instance remains healthy.
580 "instances": [ # A list of resource URLs to the member virtual machines 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]581 "A String",
582 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]583 "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]584 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]585 # 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]586 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]587 # 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.
588 "healthChecks": [ # A list of URLs to the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if all specified health checks pass. An empty list means all member instances will be considered healthy at all times.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]589 "A String",
590 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]591 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
592 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
593 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
594 "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]595 },
596 ],
597 "kind": "compute#targetPoolList", # Type of resource.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]598 "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server.
599 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]600 }</pre>
601</div>
602
603<div class="method">
604 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
605 <pre>Retrieves the next page of results.
606
607Args:
608 previous_request: The request for the previous page. (required)
609 previous_response: The response from the request for the previous page. (required)
610
611Returns:
612 A request object that you can call 'execute()' on to request the next
613 page. Returns None if there are no more items in the collection.
614 </pre>
615</div>
616
617<div class="method">
618 <code class="details" id="removeHealthCheck">removeHealthCheck(project, region, targetPool, body)</code>
619 <pre>Removes health check URL from targetPool.
620
621Args:
622 project: string, A parameter (required)
623 region: string, Name of the region scoping this request. (required)
624 targetPool: string, Name of the TargetPool resource to which health_check_url is to be removed. (required)
625 body: object, The request body. (required)
626 The object takes the form of:
627
628{
629 "healthChecks": [ # Health check URLs to be removed from targetPool.
630 {
631 "healthCheck": "A String",
632 },
633 ],
634 }
635
636
637Returns:
638 An object of the form:
639
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]640 { # An Operation resource, used to manage asynchronous API requests.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]641 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]642 "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]643 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]644 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]645 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
646 "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
647 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]648 "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 at when the operation will be complete. This number should monotonically increase as the operation progresses.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]649 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]650 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]651 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
652 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
653 "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]654 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]655 "message": "A String", # [Output Only] Optional human-readable details for this warning.
656 "code": "A String", # [Output Only] The warning type identifier for this warning.
657 "data": [ # [Output Only] Metadata for this warning in key: value format.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]658 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]659 "value": "A String", # [Output Only] A warning data value corresponding to the key.
660 "key": "A String", # [Output Only] A key for the warning data.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]661 },
662 ],
663 },
664 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]665 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
666 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
667 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
668 "name": "A String", # [Output Only] Name of the resource.
669 "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
670 "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]671 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]672 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]673 "message": "A String", # [Output Only] An optional, human-readable error message.
674 "code": "A String", # [Output Only] The error type identifier for this error.
675 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]676 },
677 ],
678 },
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]679 "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]680 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]681 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]682 }</pre>
683</div>
684
685<div class="method">
686 <code class="details" id="removeInstance">removeInstance(project, region, targetPool, body)</code>
687 <pre>Removes instance URL from targetPool.
688
689Args:
690 project: string, A parameter (required)
691 region: string, Name of the region scoping this request. (required)
692 targetPool: string, Name of the TargetPool resource to which instance_url is to be removed. (required)
693 body: object, The request body. (required)
694 The object takes the form of:
695
696{
697 "instances": [ # URLs of the instances to be removed from targetPool.
698 {
699 "instance": "A String",
700 },
701 ],
702 }
703
704
705Returns:
706 An object of the form:
707
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]708 { # An Operation resource, used to manage asynchronous API requests.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]709 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]710 "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]711 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]712 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]713 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
714 "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
715 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]716 "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 at when the operation will be complete. This number should monotonically increase as the operation progresses.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]717 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]718 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]719 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
720 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
721 "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]722 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]723 "message": "A String", # [Output Only] Optional human-readable details for this warning.
724 "code": "A String", # [Output Only] The warning type identifier for this warning.
725 "data": [ # [Output Only] Metadata for this warning in key: value format.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]726 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]727 "value": "A String", # [Output Only] A warning data value corresponding to the key.
728 "key": "A String", # [Output Only] A key for the warning data.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]729 },
730 ],
731 },
732 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]733 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
734 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
735 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
736 "name": "A String", # [Output Only] Name of the resource.
737 "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
738 "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]739 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]740 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]741 "message": "A String", # [Output Only] An optional, human-readable error message.
742 "code": "A String", # [Output Only] The error type identifier for this error.
743 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]744 },
745 ],
746 },
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]747 "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]748 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]749 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]750 }</pre>
751</div>
752
753<div class="method">
754 <code class="details" id="setBackup">setBackup(project, region, targetPool, body, failoverRatio=None)</code>
755 <pre>Changes backup pool configurations.
756
757Args:
758 project: string, Name of the project scoping this request. (required)
759 region: string, Name of the region scoping this request. (required)
760 targetPool: string, Name of the TargetPool resource for which the backup is to be set. (required)
761 body: object, The request body. (required)
762 The object takes the form of:
763
764{
765 "target": "A String",
766 }
767
768 failoverRatio: number, New failoverRatio value for the containing target pool.
769
770Returns:
771 An object of the form:
772
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]773 { # An Operation resource, used to manage asynchronous API requests.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]774 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]775 "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]776 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]777 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]778 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
779 "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
780 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]781 "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 at when the operation will be complete. This number should monotonically increase as the operation progresses.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]782 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]783 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]784 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
785 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
786 "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]787 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]788 "message": "A String", # [Output Only] Optional human-readable details for this warning.
789 "code": "A String", # [Output Only] The warning type identifier for this warning.
790 "data": [ # [Output Only] Metadata for this warning in key: value format.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]791 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]792 "value": "A String", # [Output Only] A warning data value corresponding to the key.
793 "key": "A String", # [Output Only] A key for the warning data.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]794 },
795 ],
796 },
797 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]798 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
799 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
800 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
801 "name": "A String", # [Output Only] Name of the resource.
802 "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
803 "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]804 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]805 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]806 "message": "A String", # [Output Only] An optional, human-readable error message.
807 "code": "A String", # [Output Only] The error type identifier for this error.
808 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]809 },
810 ],
811 },
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]812 "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]813 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]814 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]815 }</pre>
816</div>
817
818</body></html>