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