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.regionHealthChecks.html">regionHealthChecks</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#delete">delete(project, region, healthCheck, requestId=None)</a></code></p> 79<p class="firstline">Deletes the specified HealthCheck resource.</p> 80<p class="toc_element"> 81 <code><a href="#get">get(project, region, healthCheck)</a></code></p> 82<p class="firstline">Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() request.</p> 83<p class="toc_element"> 84 <code><a href="#insert">insert(project, region, body, requestId=None)</a></code></p> 85<p class="firstline">Creates a HealthCheck resource in the specified project using the data included in the request.</p> 86<p class="toc_element"> 87 <code><a href="#list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p> 88<p class="firstline">Retrieves the list of HealthCheck resources available to the specified project.</p> 89<p class="toc_element"> 90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 91<p class="firstline">Retrieves the next page of results.</p> 92<p class="toc_element"> 93 <code><a href="#patch">patch(project, region, healthCheck, body, requestId=None)</a></code></p> 94<p class="firstline">Updates a HealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.</p> 95<p class="toc_element"> 96 <code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body)</a></code></p> 97<p class="firstline">Returns permissions that a caller has on the specified resource.</p> 98<p class="toc_element"> 99 <code><a href="#update">update(project, region, healthCheck, body, requestId=None)</a></code></p> 100<p class="firstline">Updates a HealthCheck resource in the specified project using the data included in the request.</p> 101<h3>Method Details</h3> 102<div class="method"> 103 <code class="details" id="delete">delete(project, region, healthCheck, requestId=None)</code> 104 <pre>Deletes the specified HealthCheck resource. 105 106Args: 107 project: string, Project ID for this request. (required) 108 region: string, Name of the region scoping this request. (required) 109 healthCheck: string, Name of the HealthCheck resource to delete. (required) 110 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. 111 112For 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. 113 114The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). 115 116Returns: 117 An object of the form: 118 119 { # Represents an Operation resource. 120 # 121 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. 122 # 123 # Operations can be global, regional or zonal. 124 # - For global operations, use the globalOperations resource. 125 # - For regional operations, use the regionOperations resource. 126 # - For zonal operations, use the zonalOperations resource. 127 # 128 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) 129 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 130 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 131 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 132 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 133 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 134 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 135 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 136 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 137 "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. 138 "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. 139 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 140 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 141 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 142 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 143 { 144 "message": "A String", # [Output Only] A human-readable description of the warning code. 145 "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. 146 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 147 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 148 { 149 "value": "A String", # [Output Only] A warning data value corresponding to the key. 150 "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). 151 }, 152 ], 153 }, 154 ], 155 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 156 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 157 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 158 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 159 "name": "A String", # [Output Only] Name of the resource. 160 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 161 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 162 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 163 { 164 "message": "A String", # [Output Only] An optional, human-readable error message. 165 "code": "A String", # [Output Only] The error type identifier for this error. 166 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 167 }, 168 ], 169 }, 170 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 171 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 172 "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. 173 }</pre> 174</div> 175 176<div class="method"> 177 <code class="details" id="get">get(project, region, healthCheck)</code> 178 <pre>Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() request. 179 180Args: 181 project: string, Project ID for this request. (required) 182 region: string, Name of the region scoping this request. (required) 183 healthCheck: string, Name of the HealthCheck resource to return. (required) 184 185Returns: 186 An object of the form: 187 188 { # An HealthCheck resource. This resource defines a template for how individual virtual machines should be checked for health, via one of the supported protocols. 189 "kind": "compute#healthCheck", # Type of the resource. 190 "udpHealthCheck": { 191 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 192 "request": "A String", # Raw data of request to send in payload of UDP packet. It is an error if this is empty. The request data can only be ASCII. 193 "port": 42, # The UDP port number for the health check request. Valid values are 1 through 65535. 194 "response": "A String", # The bytes to match against the beginning of the response data. It is an error if this is empty. The response data can only be ASCII. 195 }, 196 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 197 "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec. 198 "type": "A String", # Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS or HTTP2. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field. 199 "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds. 200 "tcpHealthCheck": { 201 "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. 202 "request": "A String", # The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII. 203 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: 204 # USE_FIXED_PORT: The port number in 205 # port 206 # is used for health checking. 207 # USE_NAMED_PORT: The 208 # portName 209 # is used for health checking. 210 # USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. 211 # 212 # 213 # If not specified, TCP health check follows behavior specified in 214 # port 215 # and 216 # portName 217 # fields. 218 "port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535. 219 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 220 "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII. 221 }, 222 "httpHealthCheck": { 223 "requestPath": "A String", # The request path of the HTTP health check request. The default value is /. 224 "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. 225 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: 226 # USE_FIXED_PORT: The port number in 227 # port 228 # is used for health checking. 229 # USE_NAMED_PORT: The 230 # portName 231 # is used for health checking. 232 # USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. 233 # 234 # 235 # If not specified, HTTP health check follows behavior specified in 236 # port 237 # and 238 # portName 239 # fields. 240 "response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII. 241 "host": "A String", # The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used. 242 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 243 "port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535. 244 }, 245 "logConfig": { # Configuration of logging on a health check. If logging is enabled, logs will be exported to Stackdriver. # Configure logging on this health check. 246 "filter": "A String", # Specifies the desired filtering of logs on this health check. If this is unspecified and enable is true, logs are exported with LOG_TRANSITION filter. 247 "enable": True or False, # Indicates whether or not to export logs. This is false by default, which means no health check logging will be done. 248 }, 249 "httpsHealthCheck": { 250 "requestPath": "A String", # The request path of the HTTPS health check request. The default value is /. 251 "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. 252 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: 253 # USE_FIXED_PORT: The port number in 254 # port 255 # is used for health checking. 256 # USE_NAMED_PORT: The 257 # portName 258 # is used for health checking. 259 # USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. 260 # 261 # 262 # If not specified, HTTPS health check follows behavior specified in 263 # port 264 # and 265 # portName 266 # fields. 267 "response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII. 268 "host": "A String", # The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used. 269 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 270 "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. 271 }, 272 "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. 273 "sslHealthCheck": { 274 "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. 275 "request": "A String", # The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII. 276 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: 277 # USE_FIXED_PORT: The port number in 278 # port 279 # is used for health checking. 280 # USE_NAMED_PORT: The 281 # portName 282 # is used for health checking. 283 # USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. 284 # 285 # 286 # If not specified, SSL health check follows behavior specified in 287 # port 288 # and 289 # portName 290 # fields. 291 "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. 292 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 293 "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII. 294 }, 295 "http2HealthCheck": { 296 "requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is /. 297 "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. 298 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: 299 # USE_FIXED_PORT: The port number in 300 # port 301 # is used for health checking. 302 # USE_NAMED_PORT: The 303 # portName 304 # is used for health checking. 305 # USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. 306 # 307 # 308 # If not specified, HTTP2 health check follows behavior specified in 309 # port 310 # and 311 # portName 312 # fields. 313 "response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII. 314 "host": "A String", # The value of the host header in the HTTP/2 health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used. 315 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 316 "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. 317 }, 318 "region": "A String", # [Output Only] Region where the health check resides. Not applicable to global health checks. 319 "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. 320 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 321 "creationTimestamp": "A String", # [Output Only] Creation timestamp in 3339 text format. 322 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 323 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 324 "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. 325 }</pre> 326</div> 327 328<div class="method"> 329 <code class="details" id="insert">insert(project, region, body, requestId=None)</code> 330 <pre>Creates a HealthCheck resource in the specified project using the data included in the request. 331 332Args: 333 project: string, Project ID for this request. (required) 334 region: string, Name of the region scoping this request. (required) 335 body: object, The request body. (required) 336 The object takes the form of: 337 338{ # An HealthCheck resource. This resource defines a template for how individual virtual machines should be checked for health, via one of the supported protocols. 339 "kind": "compute#healthCheck", # Type of the resource. 340 "udpHealthCheck": { 341 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 342 "request": "A String", # Raw data of request to send in payload of UDP packet. It is an error if this is empty. The request data can only be ASCII. 343 "port": 42, # The UDP port number for the health check request. Valid values are 1 through 65535. 344 "response": "A String", # The bytes to match against the beginning of the response data. It is an error if this is empty. The response data can only be ASCII. 345 }, 346 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 347 "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec. 348 "type": "A String", # Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS or HTTP2. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field. 349 "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds. 350 "tcpHealthCheck": { 351 "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. 352 "request": "A String", # The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII. 353 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: 354 # USE_FIXED_PORT: The port number in 355 # port 356 # is used for health checking. 357 # USE_NAMED_PORT: The 358 # portName 359 # is used for health checking. 360 # USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. 361 # 362 # 363 # If not specified, TCP health check follows behavior specified in 364 # port 365 # and 366 # portName 367 # fields. 368 "port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535. 369 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 370 "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII. 371 }, 372 "httpHealthCheck": { 373 "requestPath": "A String", # The request path of the HTTP health check request. The default value is /. 374 "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. 375 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: 376 # USE_FIXED_PORT: The port number in 377 # port 378 # is used for health checking. 379 # USE_NAMED_PORT: The 380 # portName 381 # is used for health checking. 382 # USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. 383 # 384 # 385 # If not specified, HTTP health check follows behavior specified in 386 # port 387 # and 388 # portName 389 # fields. 390 "response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII. 391 "host": "A String", # The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used. 392 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 393 "port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535. 394 }, 395 "logConfig": { # Configuration of logging on a health check. If logging is enabled, logs will be exported to Stackdriver. # Configure logging on this health check. 396 "filter": "A String", # Specifies the desired filtering of logs on this health check. If this is unspecified and enable is true, logs are exported with LOG_TRANSITION filter. 397 "enable": True or False, # Indicates whether or not to export logs. This is false by default, which means no health check logging will be done. 398 }, 399 "httpsHealthCheck": { 400 "requestPath": "A String", # The request path of the HTTPS health check request. The default value is /. 401 "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. 402 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: 403 # USE_FIXED_PORT: The port number in 404 # port 405 # is used for health checking. 406 # USE_NAMED_PORT: The 407 # portName 408 # is used for health checking. 409 # USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. 410 # 411 # 412 # If not specified, HTTPS health check follows behavior specified in 413 # port 414 # and 415 # portName 416 # fields. 417 "response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII. 418 "host": "A String", # The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used. 419 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 420 "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. 421 }, 422 "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. 423 "sslHealthCheck": { 424 "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. 425 "request": "A String", # The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII. 426 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: 427 # USE_FIXED_PORT: The port number in 428 # port 429 # is used for health checking. 430 # USE_NAMED_PORT: The 431 # portName 432 # is used for health checking. 433 # USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. 434 # 435 # 436 # If not specified, SSL health check follows behavior specified in 437 # port 438 # and 439 # portName 440 # fields. 441 "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. 442 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 443 "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII. 444 }, 445 "http2HealthCheck": { 446 "requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is /. 447 "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. 448 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: 449 # USE_FIXED_PORT: The port number in 450 # port 451 # is used for health checking. 452 # USE_NAMED_PORT: The 453 # portName 454 # is used for health checking. 455 # USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. 456 # 457 # 458 # If not specified, HTTP2 health check follows behavior specified in 459 # port 460 # and 461 # portName 462 # fields. 463 "response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII. 464 "host": "A String", # The value of the host header in the HTTP/2 health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used. 465 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 466 "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. 467 }, 468 "region": "A String", # [Output Only] Region where the health check resides. Not applicable to global health checks. 469 "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. 470 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 471 "creationTimestamp": "A String", # [Output Only] Creation timestamp in 3339 text format. 472 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 473 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 474 "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. 475 } 476 477 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. 478 479For 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. 480 481The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). 482 483Returns: 484 An object of the form: 485 486 { # Represents an Operation resource. 487 # 488 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. 489 # 490 # Operations can be global, regional or zonal. 491 # - For global operations, use the globalOperations resource. 492 # - For regional operations, use the regionOperations resource. 493 # - For zonal operations, use the zonalOperations resource. 494 # 495 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) 496 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 497 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 498 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 499 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 500 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 501 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 502 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 503 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 504 "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. 505 "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. 506 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 507 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 508 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 509 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 510 { 511 "message": "A String", # [Output Only] A human-readable description of the warning code. 512 "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. 513 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 514 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 515 { 516 "value": "A String", # [Output Only] A warning data value corresponding to the key. 517 "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). 518 }, 519 ], 520 }, 521 ], 522 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 523 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 524 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 525 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 526 "name": "A String", # [Output Only] Name of the resource. 527 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 528 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 529 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 530 { 531 "message": "A String", # [Output Only] An optional, human-readable error message. 532 "code": "A String", # [Output Only] The error type identifier for this error. 533 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 534 }, 535 ], 536 }, 537 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 538 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 539 "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. 540 }</pre> 541</div> 542 543<div class="method"> 544 <code class="details" id="list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</code> 545 <pre>Retrieves the list of HealthCheck resources available to the specified project. 546 547Args: 548 project: string, Project ID for this request. (required) 549 region: string, Name of the region scoping this request. (required) 550 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 551 552You 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. 553 554Currently, only sorting by name or creationTimestamp desc is supported. 555 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) 556 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. 557 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. 558 559For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. 560 561You 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. 562 563To 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). 564 565Returns: 566 An object of the form: 567 568 { # Contains a list of HealthCheck resources. 569 "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. 570 "kind": "compute#healthCheckList", # Type of resource. 571 "items": [ # A list of HealthCheck resources. 572 { # An HealthCheck resource. This resource defines a template for how individual virtual machines should be checked for health, via one of the supported protocols. 573 "kind": "compute#healthCheck", # Type of the resource. 574 "udpHealthCheck": { 575 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 576 "request": "A String", # Raw data of request to send in payload of UDP packet. It is an error if this is empty. The request data can only be ASCII. 577 "port": 42, # The UDP port number for the health check request. Valid values are 1 through 65535. 578 "response": "A String", # The bytes to match against the beginning of the response data. It is an error if this is empty. The response data can only be ASCII. 579 }, 580 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 581 "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec. 582 "type": "A String", # Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS or HTTP2. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field. 583 "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds. 584 "tcpHealthCheck": { 585 "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. 586 "request": "A String", # The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII. 587 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: 588 # USE_FIXED_PORT: The port number in 589 # port 590 # is used for health checking. 591 # USE_NAMED_PORT: The 592 # portName 593 # is used for health checking. 594 # USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. 595 # 596 # 597 # If not specified, TCP health check follows behavior specified in 598 # port 599 # and 600 # portName 601 # fields. 602 "port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535. 603 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 604 "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII. 605 }, 606 "httpHealthCheck": { 607 "requestPath": "A String", # The request path of the HTTP health check request. The default value is /. 608 "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. 609 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: 610 # USE_FIXED_PORT: The port number in 611 # port 612 # is used for health checking. 613 # USE_NAMED_PORT: The 614 # portName 615 # is used for health checking. 616 # USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. 617 # 618 # 619 # If not specified, HTTP health check follows behavior specified in 620 # port 621 # and 622 # portName 623 # fields. 624 "response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII. 625 "host": "A String", # The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used. 626 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 627 "port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535. 628 }, 629 "logConfig": { # Configuration of logging on a health check. If logging is enabled, logs will be exported to Stackdriver. # Configure logging on this health check. 630 "filter": "A String", # Specifies the desired filtering of logs on this health check. If this is unspecified and enable is true, logs are exported with LOG_TRANSITION filter. 631 "enable": True or False, # Indicates whether or not to export logs. This is false by default, which means no health check logging will be done. 632 }, 633 "httpsHealthCheck": { 634 "requestPath": "A String", # The request path of the HTTPS health check request. The default value is /. 635 "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. 636 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: 637 # USE_FIXED_PORT: The port number in 638 # port 639 # is used for health checking. 640 # USE_NAMED_PORT: The 641 # portName 642 # is used for health checking. 643 # USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. 644 # 645 # 646 # If not specified, HTTPS health check follows behavior specified in 647 # port 648 # and 649 # portName 650 # fields. 651 "response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII. 652 "host": "A String", # The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used. 653 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 654 "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. 655 }, 656 "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. 657 "sslHealthCheck": { 658 "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. 659 "request": "A String", # The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII. 660 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: 661 # USE_FIXED_PORT: The port number in 662 # port 663 # is used for health checking. 664 # USE_NAMED_PORT: The 665 # portName 666 # is used for health checking. 667 # USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. 668 # 669 # 670 # If not specified, SSL health check follows behavior specified in 671 # port 672 # and 673 # portName 674 # fields. 675 "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. 676 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 677 "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII. 678 }, 679 "http2HealthCheck": { 680 "requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is /. 681 "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. 682 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: 683 # USE_FIXED_PORT: The port number in 684 # port 685 # is used for health checking. 686 # USE_NAMED_PORT: The 687 # portName 688 # is used for health checking. 689 # USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. 690 # 691 # 692 # If not specified, HTTP2 health check follows behavior specified in 693 # port 694 # and 695 # portName 696 # fields. 697 "response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII. 698 "host": "A String", # The value of the host header in the HTTP/2 health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used. 699 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 700 "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. 701 }, 702 "region": "A String", # [Output Only] Region where the health check resides. Not applicable to global health checks. 703 "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. 704 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 705 "creationTimestamp": "A String", # [Output Only] Creation timestamp in 3339 text format. 706 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 707 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 708 "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. 709 }, 710 ], 711 "warning": { # [Output Only] Informational warning message. 712 "message": "A String", # [Output Only] A human-readable description of the warning code. 713 "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. 714 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 715 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 716 { 717 "value": "A String", # [Output Only] A warning data value corresponding to the key. 718 "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). 719 }, 720 ], 721 }, 722 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 723 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 724 }</pre> 725</div> 726 727<div class="method"> 728 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 729 <pre>Retrieves the next page of results. 730 731Args: 732 previous_request: The request for the previous page. (required) 733 previous_response: The response from the request for the previous page. (required) 734 735Returns: 736 A request object that you can call 'execute()' on to request the next 737 page. Returns None if there are no more items in the collection. 738 </pre> 739</div> 740 741<div class="method"> 742 <code class="details" id="patch">patch(project, region, healthCheck, body, requestId=None)</code> 743 <pre>Updates a HealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. 744 745Args: 746 project: string, Project ID for this request. (required) 747 region: string, Name of the region scoping this request. (required) 748 healthCheck: string, Name of the HealthCheck resource to patch. (required) 749 body: object, The request body. (required) 750 The object takes the form of: 751 752{ # An HealthCheck resource. This resource defines a template for how individual virtual machines should be checked for health, via one of the supported protocols. 753 "kind": "compute#healthCheck", # Type of the resource. 754 "udpHealthCheck": { 755 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 756 "request": "A String", # Raw data of request to send in payload of UDP packet. It is an error if this is empty. The request data can only be ASCII. 757 "port": 42, # The UDP port number for the health check request. Valid values are 1 through 65535. 758 "response": "A String", # The bytes to match against the beginning of the response data. It is an error if this is empty. The response data can only be ASCII. 759 }, 760 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 761 "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec. 762 "type": "A String", # Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS or HTTP2. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field. 763 "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds. 764 "tcpHealthCheck": { 765 "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. 766 "request": "A String", # The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII. 767 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: 768 # USE_FIXED_PORT: The port number in 769 # port 770 # is used for health checking. 771 # USE_NAMED_PORT: The 772 # portName 773 # is used for health checking. 774 # USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. 775 # 776 # 777 # If not specified, TCP health check follows behavior specified in 778 # port 779 # and 780 # portName 781 # fields. 782 "port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535. 783 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 784 "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII. 785 }, 786 "httpHealthCheck": { 787 "requestPath": "A String", # The request path of the HTTP health check request. The default value is /. 788 "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. 789 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: 790 # USE_FIXED_PORT: The port number in 791 # port 792 # is used for health checking. 793 # USE_NAMED_PORT: The 794 # portName 795 # is used for health checking. 796 # USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. 797 # 798 # 799 # If not specified, HTTP health check follows behavior specified in 800 # port 801 # and 802 # portName 803 # fields. 804 "response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII. 805 "host": "A String", # The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used. 806 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 807 "port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535. 808 }, 809 "logConfig": { # Configuration of logging on a health check. If logging is enabled, logs will be exported to Stackdriver. # Configure logging on this health check. 810 "filter": "A String", # Specifies the desired filtering of logs on this health check. If this is unspecified and enable is true, logs are exported with LOG_TRANSITION filter. 811 "enable": True or False, # Indicates whether or not to export logs. This is false by default, which means no health check logging will be done. 812 }, 813 "httpsHealthCheck": { 814 "requestPath": "A String", # The request path of the HTTPS health check request. The default value is /. 815 "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. 816 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: 817 # USE_FIXED_PORT: The port number in 818 # port 819 # is used for health checking. 820 # USE_NAMED_PORT: The 821 # portName 822 # is used for health checking. 823 # USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. 824 # 825 # 826 # If not specified, HTTPS health check follows behavior specified in 827 # port 828 # and 829 # portName 830 # fields. 831 "response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII. 832 "host": "A String", # The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used. 833 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 834 "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. 835 }, 836 "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. 837 "sslHealthCheck": { 838 "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. 839 "request": "A String", # The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII. 840 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: 841 # USE_FIXED_PORT: The port number in 842 # port 843 # is used for health checking. 844 # USE_NAMED_PORT: The 845 # portName 846 # is used for health checking. 847 # USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. 848 # 849 # 850 # If not specified, SSL health check follows behavior specified in 851 # port 852 # and 853 # portName 854 # fields. 855 "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. 856 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 857 "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII. 858 }, 859 "http2HealthCheck": { 860 "requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is /. 861 "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. 862 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: 863 # USE_FIXED_PORT: The port number in 864 # port 865 # is used for health checking. 866 # USE_NAMED_PORT: The 867 # portName 868 # is used for health checking. 869 # USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. 870 # 871 # 872 # If not specified, HTTP2 health check follows behavior specified in 873 # port 874 # and 875 # portName 876 # fields. 877 "response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII. 878 "host": "A String", # The value of the host header in the HTTP/2 health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used. 879 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 880 "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. 881 }, 882 "region": "A String", # [Output Only] Region where the health check resides. Not applicable to global health checks. 883 "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. 884 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 885 "creationTimestamp": "A String", # [Output Only] Creation timestamp in 3339 text format. 886 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 887 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 888 "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. 889 } 890 891 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. 892 893For 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. 894 895The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). 896 897Returns: 898 An object of the form: 899 900 { # Represents an Operation resource. 901 # 902 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. 903 # 904 # Operations can be global, regional or zonal. 905 # - For global operations, use the globalOperations resource. 906 # - For regional operations, use the regionOperations resource. 907 # - For zonal operations, use the zonalOperations resource. 908 # 909 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) 910 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 911 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 912 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 913 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 914 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 915 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 916 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 917 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 918 "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. 919 "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. 920 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 921 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 922 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 923 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 924 { 925 "message": "A String", # [Output Only] A human-readable description of the warning code. 926 "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. 927 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 928 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 929 { 930 "value": "A String", # [Output Only] A warning data value corresponding to the key. 931 "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). 932 }, 933 ], 934 }, 935 ], 936 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 937 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 938 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 939 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 940 "name": "A String", # [Output Only] Name of the resource. 941 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 942 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 943 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 944 { 945 "message": "A String", # [Output Only] An optional, human-readable error message. 946 "code": "A String", # [Output Only] The error type identifier for this error. 947 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 948 }, 949 ], 950 }, 951 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 952 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 953 "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. 954 }</pre> 955</div> 956 957<div class="method"> 958 <code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body)</code> 959 <pre>Returns permissions that a caller has on the specified resource. 960 961Args: 962 project: string, Project ID for this request. (required) 963 region: string, The name of the region for this request. (required) 964 resource: string, Name or id of the resource for this request. (required) 965 body: object, The request body. (required) 966 The object takes the form of: 967 968{ 969 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. 970 "A String", 971 ], 972 } 973 974 975Returns: 976 An object of the form: 977 978 { 979 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. 980 "A String", 981 ], 982 }</pre> 983</div> 984 985<div class="method"> 986 <code class="details" id="update">update(project, region, healthCheck, body, requestId=None)</code> 987 <pre>Updates a HealthCheck resource in the specified project using the data included in the request. 988 989Args: 990 project: string, Project ID for this request. (required) 991 region: string, Name of the region scoping this request. (required) 992 healthCheck: string, Name of the HealthCheck resource to update. (required) 993 body: object, The request body. (required) 994 The object takes the form of: 995 996{ # An HealthCheck resource. This resource defines a template for how individual virtual machines should be checked for health, via one of the supported protocols. 997 "kind": "compute#healthCheck", # Type of the resource. 998 "udpHealthCheck": { 999 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 1000 "request": "A String", # Raw data of request to send in payload of UDP packet. It is an error if this is empty. The request data can only be ASCII. 1001 "port": 42, # The UDP port number for the health check request. Valid values are 1 through 65535. 1002 "response": "A String", # The bytes to match against the beginning of the response data. It is an error if this is empty. The response data can only be ASCII. 1003 }, 1004 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 1005 "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec. 1006 "type": "A String", # Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS or HTTP2. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field. 1007 "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds. 1008 "tcpHealthCheck": { 1009 "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. 1010 "request": "A String", # The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII. 1011 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: 1012 # USE_FIXED_PORT: The port number in 1013 # port 1014 # is used for health checking. 1015 # USE_NAMED_PORT: The 1016 # portName 1017 # is used for health checking. 1018 # USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. 1019 # 1020 # 1021 # If not specified, TCP health check follows behavior specified in 1022 # port 1023 # and 1024 # portName 1025 # fields. 1026 "port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535. 1027 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 1028 "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII. 1029 }, 1030 "httpHealthCheck": { 1031 "requestPath": "A String", # The request path of the HTTP health check request. The default value is /. 1032 "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. 1033 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: 1034 # USE_FIXED_PORT: The port number in 1035 # port 1036 # is used for health checking. 1037 # USE_NAMED_PORT: The 1038 # portName 1039 # is used for health checking. 1040 # USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. 1041 # 1042 # 1043 # If not specified, HTTP health check follows behavior specified in 1044 # port 1045 # and 1046 # portName 1047 # fields. 1048 "response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII. 1049 "host": "A String", # The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used. 1050 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 1051 "port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535. 1052 }, 1053 "logConfig": { # Configuration of logging on a health check. If logging is enabled, logs will be exported to Stackdriver. # Configure logging on this health check. 1054 "filter": "A String", # Specifies the desired filtering of logs on this health check. If this is unspecified and enable is true, logs are exported with LOG_TRANSITION filter. 1055 "enable": True or False, # Indicates whether or not to export logs. This is false by default, which means no health check logging will be done. 1056 }, 1057 "httpsHealthCheck": { 1058 "requestPath": "A String", # The request path of the HTTPS health check request. The default value is /. 1059 "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. 1060 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: 1061 # USE_FIXED_PORT: The port number in 1062 # port 1063 # is used for health checking. 1064 # USE_NAMED_PORT: The 1065 # portName 1066 # is used for health checking. 1067 # USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. 1068 # 1069 # 1070 # If not specified, HTTPS health check follows behavior specified in 1071 # port 1072 # and 1073 # portName 1074 # fields. 1075 "response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII. 1076 "host": "A String", # The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used. 1077 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 1078 "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. 1079 }, 1080 "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. 1081 "sslHealthCheck": { 1082 "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. 1083 "request": "A String", # The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII. 1084 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: 1085 # USE_FIXED_PORT: The port number in 1086 # port 1087 # is used for health checking. 1088 # USE_NAMED_PORT: The 1089 # portName 1090 # is used for health checking. 1091 # USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. 1092 # 1093 # 1094 # If not specified, SSL health check follows behavior specified in 1095 # port 1096 # and 1097 # portName 1098 # fields. 1099 "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. 1100 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 1101 "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII. 1102 }, 1103 "http2HealthCheck": { 1104 "requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is /. 1105 "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. 1106 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: 1107 # USE_FIXED_PORT: The port number in 1108 # port 1109 # is used for health checking. 1110 # USE_NAMED_PORT: The 1111 # portName 1112 # is used for health checking. 1113 # USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. 1114 # 1115 # 1116 # If not specified, HTTP2 health check follows behavior specified in 1117 # port 1118 # and 1119 # portName 1120 # fields. 1121 "response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII. 1122 "host": "A String", # The value of the host header in the HTTP/2 health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used. 1123 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 1124 "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. 1125 }, 1126 "region": "A String", # [Output Only] Region where the health check resides. Not applicable to global health checks. 1127 "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. 1128 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 1129 "creationTimestamp": "A String", # [Output Only] Creation timestamp in 3339 text format. 1130 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 1131 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1132 "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. 1133 } 1134 1135 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. 1136 1137For 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. 1138 1139The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). 1140 1141Returns: 1142 An object of the form: 1143 1144 { # Represents an Operation resource. 1145 # 1146 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. 1147 # 1148 # Operations can be global, regional or zonal. 1149 # - For global operations, use the globalOperations resource. 1150 # - For regional operations, use the regionOperations resource. 1151 # - For zonal operations, use the zonalOperations resource. 1152 # 1153 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) 1154 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 1155 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 1156 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 1157 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 1158 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 1159 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 1160 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 1161 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 1162 "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. 1163 "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. 1164 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 1165 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 1166 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 1167 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 1168 { 1169 "message": "A String", # [Output Only] A human-readable description of the warning code. 1170 "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. 1171 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 1172 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 1173 { 1174 "value": "A String", # [Output Only] A warning data value corresponding to the key. 1175 "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). 1176 }, 1177 ], 1178 }, 1179 ], 1180 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 1181 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 1182 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 1183 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 1184 "name": "A String", # [Output Only] Name of the resource. 1185 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 1186 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 1187 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 1188 { 1189 "message": "A String", # [Output Only] An optional, human-readable error message. 1190 "code": "A String", # [Output Only] The error type identifier for this error. 1191 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 1192 }, 1193 ], 1194 }, 1195 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 1196 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1197 "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. 1198 }</pre> 1199</div> 1200 1201</body></html>