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=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<h3>Method Details</h3> 120<div class="method"> 121 <code class="details" id="addHealthCheck">addHealthCheck(project, region, targetPool, body=None, requestId=None, x__xgafv=None)</code> 122 <pre>Adds health check URLs to a target pool. 123 124Args: 125 project: string, Project ID for this request. (required) 126 region: string, Name of the region scoping this request. (required) 127 targetPool: string, Name of the target pool to add a health check to. (required) 128 body: object, The request body. 129 The object takes the form of: 130 131{ 132 "healthChecks": [ # The HttpHealthCheck to add to the target pool. 133 { # 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 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. 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). 140 x__xgafv: string, V1 error format. 141 Allowed values 142 1 - v1 error format 143 2 - v2 error format 144 145Returns: 146 An object of the form: 147 148 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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. 149 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 150 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 151 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 152 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 153 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 154 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 155 { 156 "code": "A String", # [Output Only] The error type identifier for this error. 157 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 158 "message": "A String", # [Output Only] An optional, human-readable error message. 159 }, 160 ], 161 }, 162 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 163 "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. 164 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 165 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 166 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 167 "name": "A String", # [Output Only] Name of the operation. 168 "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. 169 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 170 "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. 171 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 172 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 173 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 174 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 175 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 176 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 177 "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. 178 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 179 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 180 { 181 "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. 182 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 183 { 184 "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). 185 "value": "A String", # [Output Only] A warning data value corresponding to the key. 186 }, 187 ], 188 "message": "A String", # [Output Only] A human-readable description of the warning code. 189 }, 190 ], 191 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 192}</pre> 193</div> 194 195<div class="method"> 196 <code class="details" id="addInstance">addInstance(project, region, targetPool, body=None, requestId=None, x__xgafv=None)</code> 197 <pre>Adds an instance to a target pool. 198 199Args: 200 project: string, Project ID for this request. (required) 201 region: string, Name of the region scoping this request. (required) 202 targetPool: string, Name of the TargetPool resource to add instances to. (required) 203 body: object, The request body. 204 The object takes the form of: 205 206{ 207 "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 208 { 209 "instance": "A String", # The URL for a specific instance. @required compute.instancegroups.addInstances/removeInstances 210 }, 211 ], 212} 213 214 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). 215 x__xgafv: string, V1 error format. 216 Allowed values 217 1 - v1 error format 218 2 - v2 error format 219 220Returns: 221 An object of the form: 222 223 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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. 224 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 225 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 226 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 227 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 228 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 229 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 230 { 231 "code": "A String", # [Output Only] The error type identifier for this error. 232 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 233 "message": "A String", # [Output Only] An optional, human-readable error message. 234 }, 235 ], 236 }, 237 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 238 "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. 239 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 240 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 241 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 242 "name": "A String", # [Output Only] Name of the operation. 243 "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. 244 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 245 "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. 246 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 247 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 248 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 249 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 250 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 251 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 252 "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. 253 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 254 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 255 { 256 "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. 257 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 258 { 259 "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). 260 "value": "A String", # [Output Only] A warning data value corresponding to the key. 261 }, 262 ], 263 "message": "A String", # [Output Only] A human-readable description of the warning code. 264 }, 265 ], 266 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 267}</pre> 268</div> 269 270<div class="method"> 271 <code class="details" id="aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> 272 <pre>Retrieves an aggregated list of target pools. 273 274Args: 275 project: string, Project ID for this request. (required) 276 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) ``` 277 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. 278 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`) 279 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. 280 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. 281 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. 282 x__xgafv: string, V1 error format. 283 Allowed values 284 1 - v1 error format 285 2 - v2 error format 286 287Returns: 288 An object of the form: 289 290 { 291 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 292 "items": { # A list of TargetPool resources. 293 "a_key": { # Name of the scope containing this set of target pools. 294 "targetPools": [ # A list of target pools contained in this scope. 295 { # 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. 296 "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. 297 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 298 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 299 "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. 300 "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. 301 "A String", 302 ], 303 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 304 "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. 305 "A String", 306 ], 307 "kind": "compute#targetPool", # [Output Only] Type of the resource. Always compute#targetPool for target pools. 308 "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. 309 "region": "A String", # [Output Only] URL of the region where the target pool resides. 310 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 311 "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. 312 }, 313 ], 314 "warning": { # Informational warning which replaces the list of addresses when the list is empty. 315 "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. 316 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 317 { 318 "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). 319 "value": "A String", # [Output Only] A warning data value corresponding to the key. 320 }, 321 ], 322 "message": "A String", # [Output Only] A human-readable description of the warning code. 323 }, 324 }, 325 }, 326 "kind": "compute#targetPoolAggregatedList", # [Output Only] Type of resource. Always compute#targetPoolAggregatedList for aggregated lists of target pools. 327 "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. 328 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 329 "unreachables": [ # [Output Only] Unreachable resources. 330 "A String", 331 ], 332 "warning": { # [Output Only] Informational warning message. 333 "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. 334 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 335 { 336 "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). 337 "value": "A String", # [Output Only] A warning data value corresponding to the key. 338 }, 339 ], 340 "message": "A String", # [Output Only] A human-readable description of the warning code. 341 }, 342}</pre> 343</div> 344 345<div class="method"> 346 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code> 347 <pre>Retrieves the next page of results. 348 349Args: 350 previous_request: The request for the previous page. (required) 351 previous_response: The response from the request for the previous page. (required) 352 353Returns: 354 A request object that you can call 'execute()' on to request the next 355 page. Returns None if there are no more items in the collection. 356 </pre> 357</div> 358 359<div class="method"> 360 <code class="details" id="close">close()</code> 361 <pre>Close httplib2 connections.</pre> 362</div> 363 364<div class="method"> 365 <code class="details" id="delete">delete(project, region, targetPool, requestId=None, x__xgafv=None)</code> 366 <pre>Deletes the specified target pool. 367 368Args: 369 project: string, Project ID for this request. (required) 370 region: string, Name of the region scoping this request. (required) 371 targetPool: string, Name of the TargetPool resource to delete. (required) 372 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). 373 x__xgafv: string, V1 error format. 374 Allowed values 375 1 - v1 error format 376 2 - v2 error format 377 378Returns: 379 An object of the form: 380 381 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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. 382 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 383 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 384 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 385 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 386 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 387 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 388 { 389 "code": "A String", # [Output Only] The error type identifier for this error. 390 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 391 "message": "A String", # [Output Only] An optional, human-readable error message. 392 }, 393 ], 394 }, 395 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 396 "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. 397 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 398 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 399 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 400 "name": "A String", # [Output Only] Name of the operation. 401 "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. 402 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 403 "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. 404 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 405 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 406 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 407 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 408 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 409 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 410 "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. 411 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 412 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 413 { 414 "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. 415 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 416 { 417 "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). 418 "value": "A String", # [Output Only] A warning data value corresponding to the key. 419 }, 420 ], 421 "message": "A String", # [Output Only] A human-readable description of the warning code. 422 }, 423 ], 424 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 425}</pre> 426</div> 427 428<div class="method"> 429 <code class="details" id="get">get(project, region, targetPool, x__xgafv=None)</code> 430 <pre>Returns the specified target pool. Gets a list of available target pools by making a list() request. 431 432Args: 433 project: string, Project ID for this request. (required) 434 region: string, Name of the region scoping this request. (required) 435 targetPool: string, Name of the TargetPool resource to return. (required) 436 x__xgafv: string, V1 error format. 437 Allowed values 438 1 - v1 error format 439 2 - v2 error format 440 441Returns: 442 An object of the form: 443 444 { # 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. 445 "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. 446 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 447 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 448 "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. 449 "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. 450 "A String", 451 ], 452 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 453 "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. 454 "A String", 455 ], 456 "kind": "compute#targetPool", # [Output Only] Type of the resource. Always compute#targetPool for target pools. 457 "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. 458 "region": "A String", # [Output Only] URL of the region where the target pool resides. 459 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 460 "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. 461}</pre> 462</div> 463 464<div class="method"> 465 <code class="details" id="getHealth">getHealth(project, region, targetPool, body=None, x__xgafv=None)</code> 466 <pre>Gets the most recent health check results for each IP for the instance that is referenced by the given target pool. 467 468Args: 469 project: string, Project ID for this request. (required) 470 region: string, Name of the region scoping this request. (required) 471 targetPool: string, Name of the TargetPool resource to which the queried instance belongs. (required) 472 body: object, The request body. 473 The object takes the form of: 474 475{ 476 "instance": "A String", # The URL for a specific instance. @required compute.instancegroups.addInstances/removeInstances 477} 478 479 x__xgafv: string, V1 error format. 480 Allowed values 481 1 - v1 error format 482 2 - v2 error format 483 484Returns: 485 An object of the form: 486 487 { 488 "healthStatus": [ 489 { 490 "annotations": { # Metadata defined as annotations for network endpoint. 491 "a_key": "A String", 492 }, 493 "forwardingRule": "A String", # URL of the forwarding rule associated with the health status of the instance. 494 "forwardingRuleIp": "A String", # A forwarding rule IP address assigned to this instance. 495 "healthState": "A String", # Health state of the instance. 496 "instance": "A String", # URL of the instance resource. 497 "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. 498 "port": 42, # The named port of the instance group, not necessarily the port that is health-checked. 499 "weight": "A String", 500 "weightError": "A String", 501 }, 502 ], 503 "kind": "compute#targetPoolInstanceHealth", # [Output Only] Type of resource. Always compute#targetPoolInstanceHealth when checking the health of an instance. 504}</pre> 505</div> 506 507<div class="method"> 508 <code class="details" id="insert">insert(project, region, body=None, requestId=None, x__xgafv=None)</code> 509 <pre>Creates a target pool in the specified project and region using the data included in the request. 510 511Args: 512 project: string, Project ID for this request. (required) 513 region: string, Name of the region scoping this request. (required) 514 body: object, The request body. 515 The object takes the form of: 516 517{ # 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. 518 "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. 519 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 520 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 521 "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. 522 "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. 523 "A String", 524 ], 525 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 526 "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. 527 "A String", 528 ], 529 "kind": "compute#targetPool", # [Output Only] Type of the resource. Always compute#targetPool for target pools. 530 "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. 531 "region": "A String", # [Output Only] URL of the region where the target pool resides. 532 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 533 "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. 534} 535 536 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). 537 x__xgafv: string, V1 error format. 538 Allowed values 539 1 - v1 error format 540 2 - v2 error format 541 542Returns: 543 An object of the form: 544 545 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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. 546 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 547 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 548 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 549 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 550 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 551 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 552 { 553 "code": "A String", # [Output Only] The error type identifier for this error. 554 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 555 "message": "A String", # [Output Only] An optional, human-readable error message. 556 }, 557 ], 558 }, 559 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 560 "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. 561 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 562 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 563 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 564 "name": "A String", # [Output Only] Name of the operation. 565 "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. 566 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 567 "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. 568 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 569 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 570 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 571 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 572 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 573 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 574 "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. 575 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 576 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 577 { 578 "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. 579 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 580 { 581 "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). 582 "value": "A String", # [Output Only] A warning data value corresponding to the key. 583 }, 584 ], 585 "message": "A String", # [Output Only] A human-readable description of the warning code. 586 }, 587 ], 588 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 589}</pre> 590</div> 591 592<div class="method"> 593 <code class="details" id="list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> 594 <pre>Retrieves a list of target pools available to the specified project and region. 595 596Args: 597 project: string, Project ID for this request. (required) 598 region: string, Name of the region scoping this request. (required) 599 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) ``` 600 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`) 601 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. 602 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. 603 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. 604 x__xgafv: string, V1 error format. 605 Allowed values 606 1 - v1 error format 607 2 - v2 error format 608 609Returns: 610 An object of the form: 611 612 { # Contains a list of TargetPool resources. 613 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 614 "items": [ # A list of TargetPool resources. 615 { # 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. 616 "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. 617 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 618 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 619 "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. 620 "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. 621 "A String", 622 ], 623 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 624 "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. 625 "A String", 626 ], 627 "kind": "compute#targetPool", # [Output Only] Type of the resource. Always compute#targetPool for target pools. 628 "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. 629 "region": "A String", # [Output Only] URL of the region where the target pool resides. 630 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 631 "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. 632 }, 633 ], 634 "kind": "compute#targetPoolList", # [Output Only] Type of resource. Always compute#targetPoolList for lists of target pools. 635 "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. 636 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 637 "warning": { # [Output Only] Informational warning message. 638 "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. 639 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 640 { 641 "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). 642 "value": "A String", # [Output Only] A warning data value corresponding to the key. 643 }, 644 ], 645 "message": "A String", # [Output Only] A human-readable description of the warning code. 646 }, 647}</pre> 648</div> 649 650<div class="method"> 651 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 652 <pre>Retrieves the next page of results. 653 654Args: 655 previous_request: The request for the previous page. (required) 656 previous_response: The response from the request for the previous page. (required) 657 658Returns: 659 A request object that you can call 'execute()' on to request the next 660 page. Returns None if there are no more items in the collection. 661 </pre> 662</div> 663 664<div class="method"> 665 <code class="details" id="removeHealthCheck">removeHealthCheck(project, region, targetPool, body=None, requestId=None, x__xgafv=None)</code> 666 <pre>Removes health check URL from a target pool. 667 668Args: 669 project: string, Project ID for this request. (required) 670 region: string, Name of the region for this request. (required) 671 targetPool: string, Name of the target pool to remove health checks from. (required) 672 body: object, The request body. 673 The object takes the form of: 674 675{ 676 "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 677 { # 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 678 "healthCheck": "A String", 679 }, 680 ], 681} 682 683 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). 684 x__xgafv: string, V1 error format. 685 Allowed values 686 1 - v1 error format 687 2 - v2 error format 688 689Returns: 690 An object of the form: 691 692 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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. 693 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 694 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 695 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 696 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 697 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 698 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 699 { 700 "code": "A String", # [Output Only] The error type identifier for this error. 701 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 702 "message": "A String", # [Output Only] An optional, human-readable error message. 703 }, 704 ], 705 }, 706 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 707 "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. 708 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 709 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 710 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 711 "name": "A String", # [Output Only] Name of the operation. 712 "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. 713 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 714 "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. 715 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 716 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 717 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 718 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 719 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 720 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 721 "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. 722 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 723 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 724 { 725 "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. 726 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 727 { 728 "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). 729 "value": "A String", # [Output Only] A warning data value corresponding to the key. 730 }, 731 ], 732 "message": "A String", # [Output Only] A human-readable description of the warning code. 733 }, 734 ], 735 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 736}</pre> 737</div> 738 739<div class="method"> 740 <code class="details" id="removeInstance">removeInstance(project, region, targetPool, body=None, requestId=None, x__xgafv=None)</code> 741 <pre>Removes instance URL from a target pool. 742 743Args: 744 project: string, Project ID for this request. (required) 745 region: string, Name of the region scoping this request. (required) 746 targetPool: string, Name of the TargetPool resource to remove instances from. (required) 747 body: object, The request body. 748 The object takes the form of: 749 750{ 751 "instances": [ # URLs of the instances to be removed from target pool. 752 { 753 "instance": "A String", # The URL for a specific instance. @required compute.instancegroups.addInstances/removeInstances 754 }, 755 ], 756} 757 758 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). 759 x__xgafv: string, V1 error format. 760 Allowed values 761 1 - v1 error format 762 2 - v2 error format 763 764Returns: 765 An object of the form: 766 767 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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. 768 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 769 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 770 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 771 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 772 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 773 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 774 { 775 "code": "A String", # [Output Only] The error type identifier for this error. 776 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 777 "message": "A String", # [Output Only] An optional, human-readable error message. 778 }, 779 ], 780 }, 781 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 782 "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. 783 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 784 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 785 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 786 "name": "A String", # [Output Only] Name of the operation. 787 "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. 788 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 789 "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. 790 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 791 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 792 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 793 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 794 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 795 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 796 "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. 797 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 798 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 799 { 800 "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. 801 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 802 { 803 "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). 804 "value": "A String", # [Output Only] A warning data value corresponding to the key. 805 }, 806 ], 807 "message": "A String", # [Output Only] A human-readable description of the warning code. 808 }, 809 ], 810 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 811}</pre> 812</div> 813 814<div class="method"> 815 <code class="details" id="setBackup">setBackup(project, region, targetPool, body=None, failoverRatio=None, requestId=None, x__xgafv=None)</code> 816 <pre>Changes a backup target pool's configurations. 817 818Args: 819 project: string, Project ID for this request. (required) 820 region: string, Name of the region scoping this request. (required) 821 targetPool: string, Name of the TargetPool resource to set a backup pool for. (required) 822 body: object, The request body. 823 The object takes the form of: 824 825{ 826 "target": "A String", 827} 828 829 failoverRatio: number, New failoverRatio value for the target pool. 830 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). 831 x__xgafv: string, V1 error format. 832 Allowed values 833 1 - v1 error format 834 2 - v2 error format 835 836Returns: 837 An object of the form: 838 839 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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. 840 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 841 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 842 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 843 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 844 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 845 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 846 { 847 "code": "A String", # [Output Only] The error type identifier for this error. 848 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 849 "message": "A String", # [Output Only] An optional, human-readable error message. 850 }, 851 ], 852 }, 853 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 854 "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. 855 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 856 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 857 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 858 "name": "A String", # [Output Only] Name of the operation. 859 "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. 860 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 861 "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. 862 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 863 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 864 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 865 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 866 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 867 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 868 "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. 869 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 870 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 871 { 872 "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. 873 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 874 { 875 "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). 876 "value": "A String", # [Output Only] A warning data value corresponding to the key. 877 }, 878 ], 879 "message": "A String", # [Output Only] A human-readable description of the warning code. 880 }, 881 ], 882 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 883}</pre> 884</div> 885 886</body></html>