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