1 <html><body> 2 <style> 3 4 body, 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 15 body { 16 font-size: 13px; 17 padding: 1em; 18 } 19 20 h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23 } 24 25 h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28 } 29 30 h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34 } 35 36 pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39 } 40 41 pre { 42 margin-top: 0.5em; 43 } 44 45 h1, h2, h3, p { 46 font-family: Arial, sans serif; 47 } 48 49 h1, 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, requestId=None)</a></code></p> 79 <p class="firstline">Adds health check URLs to a target pool.</p> 80 <p class="toc_element"> 81 <code><a href="#addInstance">addInstance(project, region, targetPool, body, requestId=None)</a></code></p> 82 <p class="firstline">Adds an instance to a target pool.</p> 83 <p class="toc_element"> 84 <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p> 85 <p class="firstline">Retrieves an aggregated list of target pools.</p> 86 <p class="toc_element"> 87 <code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p> 88 <p class="firstline">Retrieves the next page of results.</p> 89 <p class="toc_element"> 90 <code><a href="#delete">delete(project, region, targetPool, requestId=None)</a></code></p> 91 <p class="firstline">Deletes the specified target pool.</p> 92 <p class="toc_element"> 93 <code><a href="#get">get(project, region, targetPool)</a></code></p> 94 <p class="firstline">Returns the specified target pool. Get a list of available target pools by making a list() request.</p> 95 <p class="toc_element"> 96 <code><a href="#getHealth">getHealth(project, region, targetPool, body)</a></code></p> 97 <p class="firstline">Gets the most recent health check results for each IP for the instance that is referenced by the given target pool.</p> 98 <p class="toc_element"> 99 <code><a href="#insert">insert(project, region, body, requestId=None)</a></code></p> 100 <p class="firstline">Creates a target pool in the specified project and region using the data included in the request.</p> 101 <p class="toc_element"> 102 <code><a href="#list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p> 103 <p class="firstline">Retrieves a list of target pools available to the specified project and region.</p> 104 <p class="toc_element"> 105 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 106 <p class="firstline">Retrieves the next page of results.</p> 107 <p class="toc_element"> 108 <code><a href="#removeHealthCheck">removeHealthCheck(project, region, targetPool, body, requestId=None)</a></code></p> 109 <p class="firstline">Removes health check URL from a target pool.</p> 110 <p class="toc_element"> 111 <code><a href="#removeInstance">removeInstance(project, region, targetPool, body, requestId=None)</a></code></p> 112 <p class="firstline">Removes instance URL from a target pool.</p> 113 <p class="toc_element"> 114 <code><a href="#setBackup">setBackup(project, region, targetPool, body, failoverRatio=None, requestId=None)</a></code></p> 115 <p class="firstline">Changes a backup target pool's configurations.</p> 116 <p class="toc_element"> 117 <code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body)</a></code></p> 118 <p class="firstline">Returns permissions that a caller has on the specified resource.</p> 119 <h3>Method Details</h3> 120 <div class="method"> 121 <code class="details" id="addHealthCheck">addHealthCheck(project, region, targetPool, body, requestId=None)</code> 122 <pre>Adds health check URLs to a target pool. 123 124 Args: 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. (required) 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: 134 # - https://www.googleapis.com/compute/beta/projects/project-id/global/httpHealthChecks/health-check 135 # - projects/project-id/global/httpHealthChecks/health-check 136 # - global/httpHealthChecks/health-check 137 "healthCheck": "A String", 138 }, 139 ], 140 } 141 142 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. 143 144 Returns: 145 An object of the form: 146 147 { # An Operation resource, used to manage asynchronous API requests. 148 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 149 "clientOperationId": "A String", # [Output Only] Reserved for future use. 150 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 151 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 152 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 153 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 154 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 155 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 156 "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. 157 "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. 158 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 159 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 160 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 161 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 162 { 163 "message": "A String", # [Output Only] A human-readable description of the warning code. 164 "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. 165 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 166 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 167 { 168 "value": "A String", # [Output Only] A warning data value corresponding to the key. 169 "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). 170 }, 171 ], 172 }, 173 ], 174 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 175 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 176 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 177 "name": "A String", # [Output Only] Name of the resource. 178 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 179 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 180 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 181 { 182 "message": "A String", # [Output Only] An optional, human-readable error message. 183 "code": "A String", # [Output Only] The error type identifier for this error. 184 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 185 }, 186 ], 187 }, 188 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 189 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 190 "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. 191 }</pre> 192 </div> 193 194 <div class="method"> 195 <code class="details" id="addInstance">addInstance(project, region, targetPool, body, requestId=None)</code> 196 <pre>Adds an instance to a target pool. 197 198 Args: 199 project: string, Project ID for this request. (required) 200 region: string, Name of the region scoping this request. (required) 201 targetPool: string, Name of the TargetPool resource to add instances to. (required) 202 body: object, The request body. (required) 203 The object takes the form of: 204 205 { 206 "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: 207 # - https://www.googleapis.com/compute/v1/projects/project-id/zones/zone/instances/instance-name 208 # - projects/project-id/zones/zone/instances/instance-name 209 # - zones/zone/instances/instance-name 210 { 211 "instance": "A String", # The URL for a specific instance. 212 }, 213 ], 214 } 215 216 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. 217 218 Returns: 219 An object of the form: 220 221 { # An Operation resource, used to manage asynchronous API requests. 222 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 223 "clientOperationId": "A String", # [Output Only] Reserved for future use. 224 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 225 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 226 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 227 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 228 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 229 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 230 "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. 231 "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. 232 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 233 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 234 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 235 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 236 { 237 "message": "A String", # [Output Only] A human-readable description of the warning code. 238 "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. 239 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 240 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 241 { 242 "value": "A String", # [Output Only] A warning data value corresponding to the key. 243 "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). 244 }, 245 ], 246 }, 247 ], 248 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 249 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 250 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 251 "name": "A String", # [Output Only] Name of the resource. 252 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 253 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 254 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 255 { 256 "message": "A String", # [Output Only] An optional, human-readable error message. 257 "code": "A String", # [Output Only] The error type identifier for this error. 258 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 259 }, 260 ], 261 }, 262 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 263 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 264 "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. 265 }</pre> 266 </div> 267 268 <div class="method"> 269 <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code> 270 <pre>Retrieves an aggregated list of target pools. 271 272 Args: 273 project: string, Project ID for this request. (required) 274 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 275 276 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. 277 278 Currently, only sorting by name or creationTimestamp desc is supported. 279 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) 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 filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. 282 283 The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. 284 285 For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. 286 287 You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. 288 289 To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. 290 291 Returns: 292 An object of the form: 293 294 { 295 "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. 296 "items": { # [Output Only] A map of scoped target pool lists. 297 "a_key": { # Name of the scope containing this set of target pools. 298 "warning": { # Informational warning which replaces the list of addresses when the list is empty. 299 "message": "A String", # [Output Only] A human-readable description of the warning code. 300 "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. 301 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 302 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 303 { 304 "value": "A String", # [Output Only] A warning data value corresponding to the key. 305 "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). 306 }, 307 ], 308 }, 309 "targetPools": [ # List of target pools contained in this scope. 310 { # A TargetPool resource. This resource defines a pool of instances, an associated HttpHealthCheck resource, and the fallback target pool. 311 "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]. 312 # 313 # 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. 314 # 315 # 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. 316 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 317 "region": "A String", # [Output Only] URL of the region where the target pool resides. 318 "kind": "compute#targetPool", # [Output Only] Type of the resource. Always compute#targetPool for target pools. 319 "sessionAffinity": "A String", # Sesssion affinity option, must be one of the following values: 320 # NONE: Connections from the same client IP may go to any instance in the pool. 321 # CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy. 322 # 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. 323 "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. 324 "A String", 325 ], 326 "backupPool": "A String", # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1]. 327 # 328 # 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. 329 # 330 # 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. 331 "healthChecks": [ # The URL of the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if the health checks pass. An empty list means all member instances will be considered healthy at all times. Only HttpHealthChecks are supported. Only one health check may be specified. 332 "A String", 333 ], 334 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 335 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 336 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 337 "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. 338 }, 339 ], 340 }, 341 }, 342 "kind": "compute#targetPoolAggregatedList", # [Output Only] Type of resource. Always compute#targetPoolAggregatedList for aggregated lists of target pools. 343 "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server. 344 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 345 }</pre> 346 </div> 347 348 <div class="method"> 349 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code> 350 <pre>Retrieves the next page of results. 351 352 Args: 353 previous_request: The request for the previous page. (required) 354 previous_response: The response from the request for the previous page. (required) 355 356 Returns: 357 A request object that you can call 'execute()' on to request the next 358 page. Returns None if there are no more items in the collection. 359 </pre> 360 </div> 361 362 <div class="method"> 363 <code class="details" id="delete">delete(project, region, targetPool, requestId=None)</code> 364 <pre>Deletes the specified target pool. 365 366 Args: 367 project: string, Project ID for this request. (required) 368 region: string, Name of the region scoping this request. (required) 369 targetPool: string, Name of the TargetPool resource to delete. (required) 370 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. 371 372 Returns: 373 An object of the form: 374 375 { # An Operation resource, used to manage asynchronous API requests. 376 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 377 "clientOperationId": "A String", # [Output Only] Reserved for future use. 378 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 379 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 380 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 381 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 382 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 383 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 384 "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. 385 "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. 386 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 387 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 388 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 389 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 390 { 391 "message": "A String", # [Output Only] A human-readable description of the warning code. 392 "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. 393 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 394 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 395 { 396 "value": "A String", # [Output Only] A warning data value corresponding to the key. 397 "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). 398 }, 399 ], 400 }, 401 ], 402 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 403 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 404 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 405 "name": "A String", # [Output Only] Name of the resource. 406 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 407 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 408 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 409 { 410 "message": "A String", # [Output Only] An optional, human-readable error message. 411 "code": "A String", # [Output Only] The error type identifier for this error. 412 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 413 }, 414 ], 415 }, 416 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 417 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 418 "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. 419 }</pre> 420 </div> 421 422 <div class="method"> 423 <code class="details" id="get">get(project, region, targetPool)</code> 424 <pre>Returns the specified target pool. Get a list of available target pools by making a list() request. 425 426 Args: 427 project: string, Project ID for this request. (required) 428 region: string, Name of the region scoping this request. (required) 429 targetPool: string, Name of the TargetPool resource to return. (required) 430 431 Returns: 432 An object of the form: 433 434 { # A TargetPool resource. This resource defines a pool of instances, an associated HttpHealthCheck resource, and the fallback target pool. 435 "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]. 436 # 437 # 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. 438 # 439 # 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. 440 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 441 "region": "A String", # [Output Only] URL of the region where the target pool resides. 442 "kind": "compute#targetPool", # [Output Only] Type of the resource. Always compute#targetPool for target pools. 443 "sessionAffinity": "A String", # Sesssion affinity option, must be one of the following values: 444 # NONE: Connections from the same client IP may go to any instance in the pool. 445 # CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy. 446 # 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. 447 "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. 448 "A String", 449 ], 450 "backupPool": "A String", # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1]. 451 # 452 # 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. 453 # 454 # 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. 455 "healthChecks": [ # The URL of the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if the health checks pass. An empty list means all member instances will be considered healthy at all times. Only HttpHealthChecks are supported. Only one health check may be specified. 456 "A String", 457 ], 458 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 459 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 460 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 461 "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. 462 }</pre> 463 </div> 464 465 <div class="method"> 466 <code class="details" id="getHealth">getHealth(project, region, targetPool, body)</code> 467 <pre>Gets the most recent health check results for each IP for the instance that is referenced by the given target pool. 468 469 Args: 470 project: string, Project ID for this request. (required) 471 region: string, Name of the region scoping this request. (required) 472 targetPool: string, Name of the TargetPool resource to which the queried instance belongs. (required) 473 body: object, The request body. (required) 474 The object takes the form of: 475 476 { 477 "instance": "A String", # The URL for a specific instance. 478 } 479 480 481 Returns: 482 An object of the form: 483 484 { 485 "kind": "compute#targetPoolInstanceHealth", # [Output Only] Type of resource. Always compute#targetPoolInstanceHealth when checking the health of an instance. 486 "healthStatus": [ 487 { 488 "instance": "A String", # URL of the instance resource. 489 "healthState": "A String", # Health state of the instance. 490 "ipAddress": "A String", # The IP address represented by this resource. 491 "port": 42, # The port on the instance. 492 }, 493 ], 494 }</pre> 495 </div> 496 497 <div class="method"> 498 <code class="details" id="insert">insert(project, region, body, requestId=None)</code> 499 <pre>Creates a target pool in the specified project and region using the data included in the request. 500 501 Args: 502 project: string, Project ID for this request. (required) 503 region: string, Name of the region scoping this request. (required) 504 body: object, The request body. (required) 505 The object takes the form of: 506 507 { # A TargetPool resource. This resource defines a pool of instances, an associated HttpHealthCheck resource, and the fallback target pool. 508 "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]. 509 # 510 # 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. 511 # 512 # 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. 513 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 514 "region": "A String", # [Output Only] URL of the region where the target pool resides. 515 "kind": "compute#targetPool", # [Output Only] Type of the resource. Always compute#targetPool for target pools. 516 "sessionAffinity": "A String", # Sesssion affinity option, must be one of the following values: 517 # NONE: Connections from the same client IP may go to any instance in the pool. 518 # CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy. 519 # 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. 520 "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. 521 "A String", 522 ], 523 "backupPool": "A String", # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1]. 524 # 525 # 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. 526 # 527 # 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. 528 "healthChecks": [ # The URL of the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if the health checks pass. An empty list means all member instances will be considered healthy at all times. Only HttpHealthChecks are supported. Only one health check may be specified. 529 "A String", 530 ], 531 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 532 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 533 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 534 "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. 535 } 536 537 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. 538 539 Returns: 540 An object of the form: 541 542 { # An Operation resource, used to manage asynchronous API requests. 543 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 544 "clientOperationId": "A String", # [Output Only] Reserved for future use. 545 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 546 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 547 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 548 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 549 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 550 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 551 "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. 552 "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. 553 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 554 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 555 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 556 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 557 { 558 "message": "A String", # [Output Only] A human-readable description of the warning code. 559 "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. 560 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 561 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 562 { 563 "value": "A String", # [Output Only] A warning data value corresponding to the key. 564 "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). 565 }, 566 ], 567 }, 568 ], 569 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 570 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 571 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 572 "name": "A String", # [Output Only] Name of the resource. 573 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 574 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 575 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 576 { 577 "message": "A String", # [Output Only] An optional, human-readable error message. 578 "code": "A String", # [Output Only] The error type identifier for this error. 579 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 580 }, 581 ], 582 }, 583 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 584 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 585 "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. 586 }</pre> 587 </div> 588 589 <div class="method"> 590 <code class="details" id="list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</code> 591 <pre>Retrieves a list of target pools available to the specified project and region. 592 593 Args: 594 project: string, Project ID for this request. (required) 595 region: string, Name of the region scoping this request. (required) 596 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 597 598 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. 599 600 Currently, only sorting by name or creationTimestamp desc is supported. 601 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) 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 filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. 604 605 The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. 606 607 For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. 608 609 You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. 610 611 To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. 612 613 Returns: 614 An object of the form: 615 616 { # Contains a list of TargetPool resources. 617 "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. 618 "items": [ # A list of TargetPool resources. 619 { # A TargetPool resource. This resource defines a pool of instances, an associated HttpHealthCheck resource, and the fallback target pool. 620 "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]. 621 # 622 # 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. 623 # 624 # 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. 625 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 626 "region": "A String", # [Output Only] URL of the region where the target pool resides. 627 "kind": "compute#targetPool", # [Output Only] Type of the resource. Always compute#targetPool for target pools. 628 "sessionAffinity": "A String", # Sesssion affinity option, must be one of the following values: 629 # NONE: Connections from the same client IP may go to any instance in the pool. 630 # CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy. 631 # 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 "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. 633 "A String", 634 ], 635 "backupPool": "A String", # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1]. 636 # 637 # 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. 638 # 639 # 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. 640 "healthChecks": [ # The URL of the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if the health checks pass. An empty list means all member instances will be considered healthy at all times. Only HttpHealthChecks are supported. Only one health check may be specified. 641 "A String", 642 ], 643 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 644 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 645 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 646 "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. 647 }, 648 ], 649 "kind": "compute#targetPoolList", # [Output Only] Type of resource. Always compute#targetPoolList for lists of target pools. 650 "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server. 651 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 652 }</pre> 653 </div> 654 655 <div class="method"> 656 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 657 <pre>Retrieves the next page of results. 658 659 Args: 660 previous_request: The request for the previous page. (required) 661 previous_response: The response from the request for the previous page. (required) 662 663 Returns: 664 A request object that you can call 'execute()' on to request the next 665 page. Returns None if there are no more items in the collection. 666 </pre> 667 </div> 668 669 <div class="method"> 670 <code class="details" id="removeHealthCheck">removeHealthCheck(project, region, targetPool, body, requestId=None)</code> 671 <pre>Removes health check URL from a target pool. 672 673 Args: 674 project: string, Project ID for this request. (required) 675 region: string, Name of the region for this request. (required) 676 targetPool: string, Name of the target pool to remove health checks from. (required) 677 body: object, The request body. (required) 678 The object takes the form of: 679 680 { 681 "healthChecks": [ # Health check URL to be removed. This can be a full or valid partial URL. For example, the following are valid URLs: 682 # - https://www.googleapis.com/compute/beta/projects/project/global/httpHealthChecks/health-check 683 # - projects/project/global/httpHealthChecks/health-check 684 # - global/httpHealthChecks/health-check 685 { # A full or valid partial URL to a health check. For example, the following are valid URLs: 686 # - https://www.googleapis.com/compute/beta/projects/project-id/global/httpHealthChecks/health-check 687 # - projects/project-id/global/httpHealthChecks/health-check 688 # - global/httpHealthChecks/health-check 689 "healthCheck": "A String", 690 }, 691 ], 692 } 693 694 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. 695 696 Returns: 697 An object of the form: 698 699 { # An Operation resource, used to manage asynchronous API requests. 700 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 701 "clientOperationId": "A String", # [Output Only] Reserved for future use. 702 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 703 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 704 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 705 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 706 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 707 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 708 "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. 709 "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. 710 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 711 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 712 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 713 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 714 { 715 "message": "A String", # [Output Only] A human-readable description of the warning code. 716 "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. 717 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 718 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 719 { 720 "value": "A String", # [Output Only] A warning data value corresponding to the key. 721 "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). 722 }, 723 ], 724 }, 725 ], 726 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 727 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 728 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 729 "name": "A String", # [Output Only] Name of the resource. 730 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 731 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 732 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 733 { 734 "message": "A String", # [Output Only] An optional, human-readable error message. 735 "code": "A String", # [Output Only] The error type identifier for this error. 736 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 737 }, 738 ], 739 }, 740 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 741 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 742 "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. 743 }</pre> 744 </div> 745 746 <div class="method"> 747 <code class="details" id="removeInstance">removeInstance(project, region, targetPool, body, requestId=None)</code> 748 <pre>Removes instance URL from a target pool. 749 750 Args: 751 project: string, Project ID for this request. (required) 752 region: string, Name of the region scoping this request. (required) 753 targetPool: string, Name of the TargetPool resource to remove instances from. (required) 754 body: object, The request body. (required) 755 The object takes the form of: 756 757 { 758 "instances": [ # URLs of the instances to be removed from target pool. 759 { 760 "instance": "A String", # The URL for a specific instance. 761 }, 762 ], 763 } 764 765 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. 766 767 Returns: 768 An object of the form: 769 770 { # An Operation resource, used to manage asynchronous API requests. 771 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 772 "clientOperationId": "A String", # [Output Only] Reserved for future use. 773 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 774 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 775 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 776 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 777 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 778 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 779 "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. 780 "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. 781 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 782 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 783 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 784 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 785 { 786 "message": "A String", # [Output Only] A human-readable description of the warning code. 787 "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. 788 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 789 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 790 { 791 "value": "A String", # [Output Only] A warning data value corresponding to the key. 792 "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). 793 }, 794 ], 795 }, 796 ], 797 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 798 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 799 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 800 "name": "A String", # [Output Only] Name of the resource. 801 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 802 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 803 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 804 { 805 "message": "A String", # [Output Only] An optional, human-readable error message. 806 "code": "A String", # [Output Only] The error type identifier for this error. 807 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 808 }, 809 ], 810 }, 811 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 812 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 813 "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. 814 }</pre> 815 </div> 816 817 <div class="method"> 818 <code class="details" id="setBackup">setBackup(project, region, targetPool, body, failoverRatio=None, requestId=None)</code> 819 <pre>Changes a backup target pool's configurations. 820 821 Args: 822 project: string, Project ID for this request. (required) 823 region: string, Name of the region scoping this request. (required) 824 targetPool: string, Name of the TargetPool resource to set a backup pool for. (required) 825 body: object, The request body. (required) 826 The object takes the form of: 827 828 { 829 "target": "A String", 830 } 831 832 failoverRatio: number, New failoverRatio value for the target pool. 833 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. 834 835 Returns: 836 An object of the form: 837 838 { # An Operation resource, used to manage asynchronous API requests. 839 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 840 "clientOperationId": "A String", # [Output Only] Reserved for future use. 841 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 842 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 843 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 844 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 845 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 846 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 847 "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. 848 "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. 849 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 850 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 851 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 852 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 853 { 854 "message": "A String", # [Output Only] A human-readable description of the warning code. 855 "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. 856 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 857 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 858 { 859 "value": "A String", # [Output Only] A warning data value corresponding to the key. 860 "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). 861 }, 862 ], 863 }, 864 ], 865 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 866 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 867 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 868 "name": "A String", # [Output Only] Name of the resource. 869 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 870 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 871 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 872 { 873 "message": "A String", # [Output Only] An optional, human-readable error message. 874 "code": "A String", # [Output Only] The error type identifier for this error. 875 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 876 }, 877 ], 878 }, 879 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 880 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 881 "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. 882 }</pre> 883 </div> 884 885 <div class="method"> 886 <code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body)</code> 887 <pre>Returns permissions that a caller has on the specified resource. 888 889 Args: 890 project: string, Project ID for this request. (required) 891 region: string, The name of the region for this request. (required) 892 resource: string, Name of the resource for this request. (required) 893 body: object, The request body. (required) 894 The object takes the form of: 895 896 { 897 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. 898 "A String", 899 ], 900 } 901 902 903 Returns: 904 An object of the form: 905 906 { 907 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. 908 "A String", 909 ], 910 }</pre> 911 </div> 912 913 </body></html>
