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.httpHealthChecks.html">httpHealthChecks</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#delete">delete(project, httpHealthCheck, requestId=None, x__xgafv=None)</a></code></p> 82<p class="firstline">Deletes the specified HttpHealthCheck resource.</p> 83<p class="toc_element"> 84 <code><a href="#get">get(project, httpHealthCheck, x__xgafv=None)</a></code></p> 85<p class="firstline">Returns the specified HttpHealthCheck resource. Gets a list of available HTTP health checks by making a list() request.</p> 86<p class="toc_element"> 87 <code><a href="#insert">insert(project, body=None, requestId=None, x__xgafv=None)</a></code></p> 88<p class="firstline">Creates a HttpHealthCheck resource in the specified project using the data included in the request.</p> 89<p class="toc_element"> 90 <code><a href="#list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p> 91<p class="firstline">Retrieves the list of HttpHealthCheck resources available to the specified project.</p> 92<p class="toc_element"> 93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 94<p class="firstline">Retrieves the next page of results.</p> 95<p class="toc_element"> 96 <code><a href="#patch">patch(project, httpHealthCheck, body=None, requestId=None, x__xgafv=None)</a></code></p> 97<p class="firstline">Updates a HttpHealthCheck 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> 98<p class="toc_element"> 99 <code><a href="#testIamPermissions">testIamPermissions(project, resource, body=None, x__xgafv=None)</a></code></p> 100<p class="firstline">Returns permissions that a caller has on the specified resource.</p> 101<p class="toc_element"> 102 <code><a href="#update">update(project, httpHealthCheck, body=None, requestId=None, x__xgafv=None)</a></code></p> 103<p class="firstline">Updates a HttpHealthCheck resource in the specified project using the data included in the request.</p> 104<h3>Method Details</h3> 105<div class="method"> 106 <code class="details" id="close">close()</code> 107 <pre>Close httplib2 connections.</pre> 108</div> 109 110<div class="method"> 111 <code class="details" id="delete">delete(project, httpHealthCheck, requestId=None, x__xgafv=None)</code> 112 <pre>Deletes the specified HttpHealthCheck resource. 113 114Args: 115 project: string, Project ID for this request. (required) 116 httpHealthCheck: string, Name of the HttpHealthCheck resource to delete. (required) 117 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 118 x__xgafv: string, V1 error format. 119 Allowed values 120 1 - v1 error format 121 2 - v2 error format 122 123Returns: 124 An object of the form: 125 126 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 127 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 128 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 129 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 130 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 131 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 132 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 133 { 134 "code": "A String", # [Output Only] The error type identifier for this error. 135 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 136 "message": "A String", # [Output Only] An optional, human-readable error message. 137 }, 138 ], 139 }, 140 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 141 "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. 142 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 143 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 144 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 145 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 146 "a_key": "", # Properties of the object. Contains field @type with type URL. 147 }, 148 "name": "A String", # [Output Only] Name of the operation. 149 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 150 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 151 "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. 152 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 153 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 154 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 155 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 156 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 157 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 158 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 159 "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. 160 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 161 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 162 { 163 "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. 164 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 165 { 166 "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). 167 "value": "A String", # [Output Only] A warning data value corresponding to the key. 168 }, 169 ], 170 "message": "A String", # [Output Only] A human-readable description of the warning code. 171 }, 172 ], 173 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 174}</pre> 175</div> 176 177<div class="method"> 178 <code class="details" id="get">get(project, httpHealthCheck, x__xgafv=None)</code> 179 <pre>Returns the specified HttpHealthCheck resource. Gets a list of available HTTP health checks by making a list() request. 180 181Args: 182 project: string, Project ID for this request. (required) 183 httpHealthCheck: string, Name of the HttpHealthCheck resource to return. (required) 184 x__xgafv: string, V1 error format. 185 Allowed values 186 1 - v1 error format 187 2 - v2 error format 188 189Returns: 190 An object of the form: 191 192 { # Represents a legacy HTTP Health Check resource. Legacy HTTP health checks are now only required by target pool-based network load balancers. For all other load balancers, including backend service-based network load balancers, and for managed instance group auto-healing, you must use modern (non-legacy) health checks. For more information, see Health checks overview . 193 "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds. 194 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 195 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 196 "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. 197 "host": "A String", # The value of the host header in the HTTP health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used. 198 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 199 "kind": "compute#httpHealthCheck", # [Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks. 200 "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. 201 "port": 42, # The TCP port number for the HTTP health check request. The default value is 80. 202 "requestPath": "A String", # The request path of the HTTP health check request. The default value is /. This field does not support query parameters. 203 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 204 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 205 "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. 206 "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. 207}</pre> 208</div> 209 210<div class="method"> 211 <code class="details" id="insert">insert(project, body=None, requestId=None, x__xgafv=None)</code> 212 <pre>Creates a HttpHealthCheck resource in the specified project using the data included in the request. 213 214Args: 215 project: string, Project ID for this request. (required) 216 body: object, The request body. 217 The object takes the form of: 218 219{ # Represents a legacy HTTP Health Check resource. Legacy HTTP health checks are now only required by target pool-based network load balancers. For all other load balancers, including backend service-based network load balancers, and for managed instance group auto-healing, you must use modern (non-legacy) health checks. For more information, see Health checks overview . 220 "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds. 221 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 222 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 223 "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. 224 "host": "A String", # The value of the host header in the HTTP health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used. 225 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 226 "kind": "compute#httpHealthCheck", # [Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks. 227 "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. 228 "port": 42, # The TCP port number for the HTTP health check request. The default value is 80. 229 "requestPath": "A String", # The request path of the HTTP health check request. The default value is /. This field does not support query parameters. 230 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 231 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 232 "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. 233 "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. 234} 235 236 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 237 x__xgafv: string, V1 error format. 238 Allowed values 239 1 - v1 error format 240 2 - v2 error format 241 242Returns: 243 An object of the form: 244 245 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 246 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 247 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 248 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 249 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 250 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 251 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 252 { 253 "code": "A String", # [Output Only] The error type identifier for this error. 254 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 255 "message": "A String", # [Output Only] An optional, human-readable error message. 256 }, 257 ], 258 }, 259 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 260 "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. 261 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 262 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 263 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 264 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 265 "a_key": "", # Properties of the object. Contains field @type with type URL. 266 }, 267 "name": "A String", # [Output Only] Name of the operation. 268 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 269 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 270 "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. 271 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 272 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 273 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 274 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 275 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 276 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 277 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 278 "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. 279 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 280 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 281 { 282 "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. 283 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 284 { 285 "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). 286 "value": "A String", # [Output Only] A warning data value corresponding to the key. 287 }, 288 ], 289 "message": "A String", # [Output Only] A human-readable description of the warning code. 290 }, 291 ], 292 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 293}</pre> 294</div> 295 296<div class="method"> 297 <code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> 298 <pre>Retrieves the list of HttpHealthCheck resources available to the specified project. 299 300Args: 301 project: string, Project ID for this request. (required) 302 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` 303 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`) 304 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. 305 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. 306 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. 307 x__xgafv: string, V1 error format. 308 Allowed values 309 1 - v1 error format 310 2 - v2 error format 311 312Returns: 313 An object of the form: 314 315 { # Contains a list of HttpHealthCheck resources. 316 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 317 "items": [ # A list of HttpHealthCheck resources. 318 { # Represents a legacy HTTP Health Check resource. Legacy HTTP health checks are now only required by target pool-based network load balancers. For all other load balancers, including backend service-based network load balancers, and for managed instance group auto-healing, you must use modern (non-legacy) health checks. For more information, see Health checks overview . 319 "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds. 320 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 321 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 322 "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. 323 "host": "A String", # The value of the host header in the HTTP health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used. 324 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 325 "kind": "compute#httpHealthCheck", # [Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks. 326 "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. 327 "port": 42, # The TCP port number for the HTTP health check request. The default value is 80. 328 "requestPath": "A String", # The request path of the HTTP health check request. The default value is /. This field does not support query parameters. 329 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 330 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 331 "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. 332 "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. 333 }, 334 ], 335 "kind": "compute#httpHealthCheckList", # Type of resource. 336 "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. 337 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 338 "warning": { # [Output Only] Informational warning message. 339 "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. 340 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 341 { 342 "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). 343 "value": "A String", # [Output Only] A warning data value corresponding to the key. 344 }, 345 ], 346 "message": "A String", # [Output Only] A human-readable description of the warning code. 347 }, 348}</pre> 349</div> 350 351<div class="method"> 352 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 353 <pre>Retrieves the next page of results. 354 355Args: 356 previous_request: The request for the previous page. (required) 357 previous_response: The response from the request for the previous page. (required) 358 359Returns: 360 A request object that you can call 'execute()' on to request the next 361 page. Returns None if there are no more items in the collection. 362 </pre> 363</div> 364 365<div class="method"> 366 <code class="details" id="patch">patch(project, httpHealthCheck, body=None, requestId=None, x__xgafv=None)</code> 367 <pre>Updates a HttpHealthCheck 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. 368 369Args: 370 project: string, Project ID for this request. (required) 371 httpHealthCheck: string, Name of the HttpHealthCheck resource to patch. (required) 372 body: object, The request body. 373 The object takes the form of: 374 375{ # Represents a legacy HTTP Health Check resource. Legacy HTTP health checks are now only required by target pool-based network load balancers. For all other load balancers, including backend service-based network load balancers, and for managed instance group auto-healing, you must use modern (non-legacy) health checks. For more information, see Health checks overview . 376 "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds. 377 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 378 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 379 "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. 380 "host": "A String", # The value of the host header in the HTTP health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used. 381 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 382 "kind": "compute#httpHealthCheck", # [Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks. 383 "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. 384 "port": 42, # The TCP port number for the HTTP health check request. The default value is 80. 385 "requestPath": "A String", # The request path of the HTTP health check request. The default value is /. This field does not support query parameters. 386 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 387 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 388 "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. 389 "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. 390} 391 392 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 393 x__xgafv: string, V1 error format. 394 Allowed values 395 1 - v1 error format 396 2 - v2 error format 397 398Returns: 399 An object of the form: 400 401 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 402 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 403 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 404 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 405 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 406 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 407 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 408 { 409 "code": "A String", # [Output Only] The error type identifier for this error. 410 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 411 "message": "A String", # [Output Only] An optional, human-readable error message. 412 }, 413 ], 414 }, 415 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 416 "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. 417 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 418 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 419 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 420 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 421 "a_key": "", # Properties of the object. Contains field @type with type URL. 422 }, 423 "name": "A String", # [Output Only] Name of the operation. 424 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 425 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 426 "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. 427 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 428 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 429 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 430 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 431 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 432 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 433 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 434 "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. 435 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 436 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 437 { 438 "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. 439 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 440 { 441 "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). 442 "value": "A String", # [Output Only] A warning data value corresponding to the key. 443 }, 444 ], 445 "message": "A String", # [Output Only] A human-readable description of the warning code. 446 }, 447 ], 448 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 449}</pre> 450</div> 451 452<div class="method"> 453 <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body=None, x__xgafv=None)</code> 454 <pre>Returns permissions that a caller has on the specified resource. 455 456Args: 457 project: string, Project ID for this request. (required) 458 resource: string, Name or id of the resource for this request. (required) 459 body: object, The request body. 460 The object takes the form of: 461 462{ 463 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. 464 "A String", 465 ], 466} 467 468 x__xgafv: string, V1 error format. 469 Allowed values 470 1 - v1 error format 471 2 - v2 error format 472 473Returns: 474 An object of the form: 475 476 { 477 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. 478 "A String", 479 ], 480}</pre> 481</div> 482 483<div class="method"> 484 <code class="details" id="update">update(project, httpHealthCheck, body=None, requestId=None, x__xgafv=None)</code> 485 <pre>Updates a HttpHealthCheck resource in the specified project using the data included in the request. 486 487Args: 488 project: string, Project ID for this request. (required) 489 httpHealthCheck: string, Name of the HttpHealthCheck resource to update. (required) 490 body: object, The request body. 491 The object takes the form of: 492 493{ # Represents a legacy HTTP Health Check resource. Legacy HTTP health checks are now only required by target pool-based network load balancers. For all other load balancers, including backend service-based network load balancers, and for managed instance group auto-healing, you must use modern (non-legacy) health checks. For more information, see Health checks overview . 494 "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds. 495 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 496 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 497 "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. 498 "host": "A String", # The value of the host header in the HTTP health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used. 499 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 500 "kind": "compute#httpHealthCheck", # [Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks. 501 "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. 502 "port": 42, # The TCP port number for the HTTP health check request. The default value is 80. 503 "requestPath": "A String", # The request path of the HTTP health check request. The default value is /. This field does not support query parameters. 504 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 505 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 506 "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. 507 "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. 508} 509 510 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 511 x__xgafv: string, V1 error format. 512 Allowed values 513 1 - v1 error format 514 2 - v2 error format 515 516Returns: 517 An object of the form: 518 519 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 520 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 521 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 522 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 523 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 524 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 525 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 526 { 527 "code": "A String", # [Output Only] The error type identifier for this error. 528 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 529 "message": "A String", # [Output Only] An optional, human-readable error message. 530 }, 531 ], 532 }, 533 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 534 "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. 535 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 536 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 537 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 538 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 539 "a_key": "", # Properties of the object. Contains field @type with type URL. 540 }, 541 "name": "A String", # [Output Only] Name of the operation. 542 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 543 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 544 "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. 545 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 546 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 547 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 548 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 549 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 550 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 551 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 552 "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. 553 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 554 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 555 { 556 "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. 557 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 558 { 559 "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). 560 "value": "A String", # [Output Only] A warning data value corresponding to the key. 561 }, 562 ], 563 "message": "A String", # [Output Only] A human-readable description of the warning code. 564 }, 565 ], 566 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 567}</pre> 568</div> 569 570</body></html>