Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / ea3a5e1b5572e5438ba86ec0074f60029bd94855 / . / docs / dyn / compute_v1.targetPools.html
blob: a2272ad9b66f4a1d94f6fc77f213eaac30fddf1c [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>
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">
81 <code><a href="#addInstance">addInstance(project, region, targetPool, body)</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">
90 <code><a href="#delete">delete(project, region, targetPool)</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>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]94<p class="firstline">Returns the specified target pool. Get 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">
99 <code><a href="#insert">insert(project, region, body)</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">
108 <code><a href="#removeHealthCheck">removeHealthCheck(project, region, targetPool, body)</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">
111 <code><a href="#removeInstance">removeInstance(project, region, targetPool, body)</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">
114 <code><a href="#setBackup">setBackup(project, region, targetPool, body, failoverRatio=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">
118 <code class="details" id="addHealthCheck">addHealthCheck(project, region, targetPool, body)</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{
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]129 "healthChecks": [ # A list of HttpHealthCheck resources to add to the target pool.
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
139
140Returns:
141 An object of the form:
142
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]143 { # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]144 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
145 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]146 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]147 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
148 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
149 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
150 "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]151 "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]152 "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.
153 "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]154 "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]155 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
156 "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]157 "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]158 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]159 "message": "A String", # [Output Only] A human-readable description of the warning code.
160 "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.
161 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
162 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]163 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]164 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]165 "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]166 },
167 ],
168 },
169 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]170 "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]171 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
172 "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]173 "name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]174 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]175 "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]176 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]177 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]178 "message": "A String", # [Output Only] An optional, human-readable error message.
179 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]180 "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]181 },
182 ],
183 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]184 "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]185 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame^]186 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]187 }</pre>
188</div>
189
190<div class="method">
191 <code class="details" id="addInstance">addInstance(project, region, targetPool, body)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]192 <pre>Adds an instance to a target pool.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]193
194Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]195 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]196 region: string, Name of the region scoping this request. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]197 targetPool: string, Name of the TargetPool resource to add instances to. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]198 body: object, The request body. (required)
199 The object takes the form of:
200
201{
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]202 "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:
203 # - https://www.googleapis.com/compute/v1/projects/project-id/zones/zone/instances/instance-name
204 # - projects/project-id/zones/zone/instances/instance-name
205 # - zones/zone/instances/instance-name
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]206 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]207 "instance": "A String", # The URL for a specific instance.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]208 },
209 ],
210 }
211
212
213Returns:
214 An object of the form:
215
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]216 { # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]217 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
218 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]219 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]220 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
221 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
222 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
223 "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]224 "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]225 "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.
226 "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]227 "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]228 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
229 "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]230 "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]231 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]232 "message": "A String", # [Output Only] A human-readable description of the warning code.
233 "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.
234 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
235 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]236 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]237 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]238 "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]239 },
240 ],
241 },
242 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]243 "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]244 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
245 "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]246 "name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]247 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]248 "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]249 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]250 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]251 "message": "A String", # [Output Only] An optional, human-readable error message.
252 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]253 "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]254 },
255 ],
256 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]257 "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]258 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame^]259 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]260 }</pre>
261</div>
262
263<div class="method">
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame^]264 <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]265 <pre>Retrieves an aggregated list of target pools.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]266
267Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]268 project: string, Project ID for this request. (required)
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame^]269 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
270
271You 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.
272
273Currently, only sorting by name or creationTimestamp desc is supported.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]274 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.
275 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.
276 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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]277
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]278The 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 you are filtering by (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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]279
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]280For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]281
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]282You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]283
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]284To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]285
286Returns:
287 An object of the form:
288
289 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]290 "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.
291 "items": { # [Output Only] A map of scoped target pool lists.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]292 "a_key": { # Name of the scope containing this set of target pools.
293 "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]294 "message": "A String", # [Output Only] A human-readable description of the warning code.
295 "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.
296 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
297 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]298 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]299 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]300 "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]301 },
302 ],
303 },
304 "targetPools": [ # List of target pools contained in this scope.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]305 { # A TargetPool resource. This resource defines a pool of instances, associated HttpHealthCheck resources, and the fallback target pool.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]306 "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].
307 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]308 # 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]309 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]310 # 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]311 "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]312 "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]313 "kind": "compute#targetPool", # [Output Only] Type of the resource. Always compute#targetPool for target pools.
314 "sessionAffinity": "A String", # Sesssion affinity option, must be one of the following values:
315 # NONE: Connections from the same client IP may go to any instance in the pool.
316 # CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy.
317 # 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.
318 "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]319 "A String",
320 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]321 "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]322 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]323 # 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]324 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]325 # 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.
326 "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]327 "A String",
328 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]329 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]330 "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]331 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
332 "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]333 },
334 ],
335 },
336 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]337 "kind": "compute#targetPoolAggregatedList", # [Output Only] Type of resource. Always compute#targetPoolAggregatedList for aggregated lists of target pools.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]338 "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server.
339 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]340 }</pre>
341</div>
342
343<div class="method">
344 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>
345 <pre>Retrieves the next page of results.
346
347Args:
348 previous_request: The request for the previous page. (required)
349 previous_response: The response from the request for the previous page. (required)
350
351Returns:
352 A request object that you can call 'execute()' on to request the next
353 page. Returns None if there are no more items in the collection.
354 </pre>
355</div>
356
357<div class="method">
358 <code class="details" id="delete">delete(project, region, targetPool)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]359 <pre>Deletes the specified target pool.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]360
361Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]362 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]363 region: string, Name of the region scoping this request. (required)
364 targetPool: string, Name of the TargetPool resource to delete. (required)
365
366Returns:
367 An object of the form:
368
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]369 { # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]370 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
371 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]372 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]373 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
374 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
375 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
376 "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]377 "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]378 "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.
379 "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]380 "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]381 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
382 "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]383 "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]384 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]385 "message": "A String", # [Output Only] A human-readable description of the warning code.
386 "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.
387 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
388 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]389 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]390 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]391 "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]392 },
393 ],
394 },
395 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]396 "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]397 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
398 "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]399 "name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]400 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]401 "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]402 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]403 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]404 "message": "A String", # [Output Only] An optional, human-readable error message.
405 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]406 "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]407 },
408 ],
409 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]410 "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]411 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame^]412 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]413 }</pre>
414</div>
415
416<div class="method">
417 <code class="details" id="get">get(project, region, targetPool)</code>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]418 <pre>Returns the specified target pool. Get a list of available target pools by making a list() request.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]419
420Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]421 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]422 region: string, Name of the region scoping this request. (required)
423 targetPool: string, Name of the TargetPool resource to return. (required)
424
425Returns:
426 An object of the form:
427
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]428 { # A TargetPool resource. This resource defines a pool of instances, associated HttpHealthCheck resources, and the fallback target pool.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]429 "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].
430 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]431 # 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]432 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]433 # 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]434 "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]435 "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]436 "kind": "compute#targetPool", # [Output Only] Type of the resource. Always compute#targetPool for target pools.
437 "sessionAffinity": "A String", # Sesssion affinity option, must be one of the following values:
438 # NONE: Connections from the same client IP may go to any instance in the pool.
439 # CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy.
440 # 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.
441 "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]442 "A String",
443 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]444 "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]445 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]446 # 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]447 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]448 # 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.
449 "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]450 "A String",
451 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]452 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]453 "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]454 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
455 "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]456 }</pre>
457</div>
458
459<div class="method">
460 <code class="details" id="getHealth">getHealth(project, region, targetPool, body)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]461 <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]462
463Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]464 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]465 region: string, Name of the region scoping this request. (required)
466 targetPool: string, Name of the TargetPool resource to which the queried instance belongs. (required)
467 body: object, The request body. (required)
468 The object takes the form of:
469
470{
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]471 "instance": "A String", # The URL for a specific instance.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]472}
473
474
475Returns:
476 An object of the form:
477
478 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]479 "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]480 "healthStatus": [
481 {
482 "instance": "A String", # URL of the instance resource.
483 "healthState": "A String", # Health state of the instance.
484 "ipAddress": "A String", # The IP address represented by this resource.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]485 "port": 42, # The port on the instance.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]486 },
487 ],
488 }</pre>
489</div>
490
491<div class="method">
492 <code class="details" id="insert">insert(project, region, body)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]493 <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]494
495Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]496 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]497 region: string, Name of the region scoping this request. (required)
498 body: object, The request body. (required)
499 The object takes the form of:
500
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]501{ # A TargetPool resource. This resource defines a pool of instances, associated HttpHealthCheck resources, and the fallback target pool.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]502 "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].
503 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]504 # 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]505 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]506 # 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]507 "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]508 "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]509 "kind": "compute#targetPool", # [Output Only] Type of the resource. Always compute#targetPool for target pools.
510 "sessionAffinity": "A String", # Sesssion affinity option, must be one of the following values:
511 # NONE: Connections from the same client IP may go to any instance in the pool.
512 # CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy.
513 # 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.
514 "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]515 "A String",
516 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]517 "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]518 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]519 # 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]520 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]521 # 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.
522 "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]523 "A String",
524 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]525 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]526 "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]527 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
528 "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]529 }
530
531
532Returns:
533 An object of the form:
534
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]535 { # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]536 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
537 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]538 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]539 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
540 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
541 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
542 "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]543 "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]544 "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.
545 "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]546 "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]547 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
548 "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]549 "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]550 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]551 "message": "A String", # [Output Only] A human-readable description of the warning code.
552 "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.
553 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
554 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]555 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]556 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]557 "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]558 },
559 ],
560 },
561 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]562 "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]563 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
564 "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]565 "name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]566 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]567 "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]568 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]569 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]570 "message": "A String", # [Output Only] An optional, human-readable error message.
571 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]572 "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]573 },
574 ],
575 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]576 "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]577 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame^]578 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]579 }</pre>
580</div>
581
582<div class="method">
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame^]583 <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]584 <pre>Retrieves a list of target pools available to the specified project and region.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]585
586Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]587 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]588 region: string, Name of the region scoping this request. (required)
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame^]589 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
590
591You 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.
592
593Currently, only sorting by name or creationTimestamp desc is supported.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]594 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.
595 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.
596 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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]597
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]598The 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 you are filtering by (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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]599
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]600For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]601
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]602You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]603
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]604To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]605
606Returns:
607 An object of the form:
608
609 { # Contains a list of TargetPool resources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]610 "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.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]611 "items": [ # A list of TargetPool resources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]612 { # A TargetPool resource. This resource defines a pool of instances, associated HttpHealthCheck resources, and the fallback target pool.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]613 "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].
614 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]615 # 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]616 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]617 # 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]618 "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]619 "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]620 "kind": "compute#targetPool", # [Output Only] Type of the resource. Always compute#targetPool for target pools.
621 "sessionAffinity": "A String", # Sesssion affinity option, must be one of the following values:
622 # NONE: Connections from the same client IP may go to any instance in the pool.
623 # CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy.
624 # 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.
625 "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]626 "A String",
627 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]628 "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]629 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]630 # 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]631 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]632 # 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.
633 "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]634 "A String",
635 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]636 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]637 "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]638 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
639 "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]640 },
641 ],
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]642 "kind": "compute#targetPoolList", # [Output Only] Type of resource. Always compute#targetPoolList for lists of target pools.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]643 "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server.
644 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]645 }</pre>
646</div>
647
648<div class="method">
649 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
650 <pre>Retrieves the next page of results.
651
652Args:
653 previous_request: The request for the previous page. (required)
654 previous_response: The response from the request for the previous page. (required)
655
656Returns:
657 A request object that you can call 'execute()' on to request the next
658 page. Returns None if there are no more items in the collection.
659 </pre>
660</div>
661
662<div class="method">
663 <code class="details" id="removeHealthCheck">removeHealthCheck(project, region, targetPool, body)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]664 <pre>Removes health check URL from a target pool.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]665
666Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]667 project: string, Project ID for this request. (required)
668 region: string, Name of the region for this request. (required)
669 targetPool: string, Name of the target pool to remove health checks from. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]670 body: object, The request body. (required)
671 The object takes the form of:
672
673{
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]674 "healthChecks": [ # Health check URL to be removed. This can be a full or valid partial URL. For example, the following are valid URLs:
675 # - https://www.googleapis.com/compute/beta/projects/project/global/httpHealthChecks/health-check
676 # - projects/project/global/httpHealthChecks/health-check
677 # - global/httpHealthChecks/health-check
678 { # A full or valid partial URL to a health check. For example, the following are valid URLs:
679 # - https://www.googleapis.com/compute/beta/projects/project-id/global/httpHealthChecks/health-check
680 # - projects/project-id/global/httpHealthChecks/health-check
681 # - global/httpHealthChecks/health-check
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]682 "healthCheck": "A String",
683 },
684 ],
685 }
686
687
688Returns:
689 An object of the form:
690
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]691 { # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]692 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
693 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]694 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]695 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
696 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
697 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
698 "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]699 "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]700 "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.
701 "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]702 "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]703 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
704 "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]705 "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]706 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]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" }
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]711 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]712 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]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).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]714 },
715 ],
716 },
717 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]718 "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]719 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
720 "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]721 "name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]722 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]723 "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]724 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]725 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]726 "message": "A String", # [Output Only] An optional, human-readable error message.
727 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]728 "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]729 },
730 ],
731 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]732 "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]733 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame^]734 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]735 }</pre>
736</div>
737
738<div class="method">
739 <code class="details" id="removeInstance">removeInstance(project, region, targetPool, body)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]740 <pre>Removes instance URL from a target pool.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]741
742Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]743 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]744 region: string, Name of the region scoping this request. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]745 targetPool: string, Name of the TargetPool resource to remove instances from. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]746 body: object, The request body. (required)
747 The object takes the form of:
748
749{
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]750 "instances": [ # URLs of the instances to be removed from target pool.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]751 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]752 "instance": "A String", # The URL for a specific instance.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]753 },
754 ],
755 }
756
757
758Returns:
759 An object of the form:
760
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]761 { # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]762 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
763 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]764 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]765 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
766 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
767 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
768 "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]769 "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]770 "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.
771 "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]772 "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]773 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
774 "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]775 "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]776 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]777 "message": "A String", # [Output Only] A human-readable description of the warning code.
778 "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.
779 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
780 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]781 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]782 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]783 "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]784 },
785 ],
786 },
787 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]788 "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]789 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
790 "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]791 "name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]792 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]793 "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]794 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]795 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]796 "message": "A String", # [Output Only] An optional, human-readable error message.
797 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]798 "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]799 },
800 ],
801 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]802 "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]803 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame^]804 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]805 }</pre>
806</div>
807
808<div class="method">
809 <code class="details" id="setBackup">setBackup(project, region, targetPool, body, failoverRatio=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]810 <pre>Changes a backup target pool's configurations.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]811
812Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]813 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]814 region: string, Name of the region scoping this request. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]815 targetPool: string, Name of the TargetPool resource to set a backup pool for. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]816 body: object, The request body. (required)
817 The object takes the form of:
818
819{
820 "target": "A String",
821 }
822
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]823 failoverRatio: number, New failoverRatio value for the target pool.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]824
825Returns:
826 An object of the form:
827
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]828 { # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]829 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
830 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]831 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]832 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
833 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
834 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
835 "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]836 "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]837 "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.
838 "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]839 "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]840 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
841 "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]842 "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]843 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]844 "message": "A String", # [Output Only] A human-readable description of the warning code.
845 "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.
846 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
847 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]848 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]849 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]850 "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]851 },
852 ],
853 },
854 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]855 "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]856 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
857 "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]858 "name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]859 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]860 "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]861 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]862 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]863 "message": "A String", # [Output Only] An optional, human-readable error message.
864 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]865 "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]866 },
867 ],
868 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]869 "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]870 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame^]871 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]872 }</pre>
873</div>
874
875</body></html>