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