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_beta.html">Compute Engine API</a> . <a href="compute_beta.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/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/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 "name": "A String", # [Output Only] Name of the operation. 146 "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. 147 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 148 "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. 149 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 150 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 151 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 152 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 153 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 154 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 155 "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. 156 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 157 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 158 { 159 "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. 160 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 161 { 162 "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). 163 "value": "A String", # [Output Only] A warning data value corresponding to the key. 164 }, 165 ], 166 "message": "A String", # [Output Only] A human-readable description of the warning code. 167 }, 168 ], 169 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 170}</pre> 171</div> 172 173<div class="method"> 174 <code class="details" id="get">get(project, httpHealthCheck, x__xgafv=None)</code> 175 <pre>Returns the specified HttpHealthCheck resource. Gets a list of available HTTP health checks by making a list() request. 176 177Args: 178 project: string, Project ID for this request. (required) 179 httpHealthCheck: string, Name of the HttpHealthCheck resource to return. (required) 180 x__xgafv: string, V1 error format. 181 Allowed values 182 1 - v1 error format 183 2 - v2 error format 184 185Returns: 186 An object of the form: 187 188 { # 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 . 189 "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds. 190 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 191 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 192 "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. 193 "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. 194 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 195 "kind": "compute#httpHealthCheck", # [Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks. 196 "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. 197 "port": 42, # The TCP port number for the HTTP health check request. The default value is 80. 198 "requestPath": "A String", # The request path of the HTTP health check request. The default value is /. This field does not support query parameters. 199 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 200 "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. 201 "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. 202}</pre> 203</div> 204 205<div class="method"> 206 <code class="details" id="insert">insert(project, body=None, requestId=None, x__xgafv=None)</code> 207 <pre>Creates a HttpHealthCheck resource in the specified project using the data included in the request. 208 209Args: 210 project: string, Project ID for this request. (required) 211 body: object, The request body. 212 The object takes the form of: 213 214{ # 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 . 215 "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds. 216 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 217 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 218 "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. 219 "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. 220 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 221 "kind": "compute#httpHealthCheck", # [Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks. 222 "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. 223 "port": 42, # The TCP port number for the HTTP health check request. The default value is 80. 224 "requestPath": "A String", # The request path of the HTTP health check request. The default value is /. This field does not support query parameters. 225 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 226 "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. 227 "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. 228} 229 230 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). 231 x__xgafv: string, V1 error format. 232 Allowed values 233 1 - v1 error format 234 2 - v2 error format 235 236Returns: 237 An object of the form: 238 239 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/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. 240 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 241 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 242 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 243 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 244 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 245 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 246 { 247 "code": "A String", # [Output Only] The error type identifier for this error. 248 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 249 "message": "A String", # [Output Only] An optional, human-readable error message. 250 }, 251 ], 252 }, 253 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 254 "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. 255 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 256 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 257 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 258 "name": "A String", # [Output Only] Name of the operation. 259 "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. 260 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 261 "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. 262 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 263 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 264 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 265 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 266 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 267 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 268 "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. 269 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 270 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 271 { 272 "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. 273 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 274 { 275 "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). 276 "value": "A String", # [Output Only] A warning data value corresponding to the key. 277 }, 278 ], 279 "message": "A String", # [Output Only] A human-readable description of the warning code. 280 }, 281 ], 282 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 283}</pre> 284</div> 285 286<div class="method"> 287 <code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> 288 <pre>Retrieves the list of HttpHealthCheck resources available to the specified project. 289 290Args: 291 project: string, Project ID for this request. (required) 292 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) ``` 293 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`) 294 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. 295 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. 296 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. 297 x__xgafv: string, V1 error format. 298 Allowed values 299 1 - v1 error format 300 2 - v2 error format 301 302Returns: 303 An object of the form: 304 305 { # Contains a list of HttpHealthCheck resources. 306 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 307 "items": [ # A list of HttpHealthCheck resources. 308 { # 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 . 309 "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds. 310 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 311 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 312 "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. 313 "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. 314 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 315 "kind": "compute#httpHealthCheck", # [Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks. 316 "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. 317 "port": 42, # The TCP port number for the HTTP health check request. The default value is 80. 318 "requestPath": "A String", # The request path of the HTTP health check request. The default value is /. This field does not support query parameters. 319 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 320 "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. 321 "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. 322 }, 323 ], 324 "kind": "compute#httpHealthCheckList", # Type of resource. 325 "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. 326 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 327 "warning": { # [Output Only] Informational warning message. 328 "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. 329 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 330 { 331 "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). 332 "value": "A String", # [Output Only] A warning data value corresponding to the key. 333 }, 334 ], 335 "message": "A String", # [Output Only] A human-readable description of the warning code. 336 }, 337}</pre> 338</div> 339 340<div class="method"> 341 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 342 <pre>Retrieves the next page of results. 343 344Args: 345 previous_request: The request for the previous page. (required) 346 previous_response: The response from the request for the previous page. (required) 347 348Returns: 349 A request object that you can call 'execute()' on to request the next 350 page. Returns None if there are no more items in the collection. 351 </pre> 352</div> 353 354<div class="method"> 355 <code class="details" id="patch">patch(project, httpHealthCheck, body=None, requestId=None, x__xgafv=None)</code> 356 <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. 357 358Args: 359 project: string, Project ID for this request. (required) 360 httpHealthCheck: string, Name of the HttpHealthCheck resource to patch. (required) 361 body: object, The request body. 362 The object takes the form of: 363 364{ # 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 . 365 "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds. 366 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 367 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 368 "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. 369 "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. 370 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 371 "kind": "compute#httpHealthCheck", # [Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks. 372 "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. 373 "port": 42, # The TCP port number for the HTTP health check request. The default value is 80. 374 "requestPath": "A String", # The request path of the HTTP health check request. The default value is /. This field does not support query parameters. 375 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 376 "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. 377 "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. 378} 379 380 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). 381 x__xgafv: string, V1 error format. 382 Allowed values 383 1 - v1 error format 384 2 - v2 error format 385 386Returns: 387 An object of the form: 388 389 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/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. 390 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 391 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 392 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 393 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 394 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 395 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 396 { 397 "code": "A String", # [Output Only] The error type identifier for this error. 398 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 399 "message": "A String", # [Output Only] An optional, human-readable error message. 400 }, 401 ], 402 }, 403 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 404 "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. 405 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 406 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 407 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 408 "name": "A String", # [Output Only] Name of the operation. 409 "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. 410 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 411 "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. 412 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 413 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 414 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 415 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 416 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 417 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 418 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. 419 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 420 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 421 { 422 "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. 423 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 424 { 425 "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). 426 "value": "A String", # [Output Only] A warning data value corresponding to the key. 427 }, 428 ], 429 "message": "A String", # [Output Only] A human-readable description of the warning code. 430 }, 431 ], 432 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 433}</pre> 434</div> 435 436<div class="method"> 437 <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body=None, x__xgafv=None)</code> 438 <pre>Returns permissions that a caller has on the specified resource. 439 440Args: 441 project: string, Project ID for this request. (required) 442 resource: string, Name or id of the resource for this request. (required) 443 body: object, The request body. 444 The object takes the form of: 445 446{ 447 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. 448 "A String", 449 ], 450} 451 452 x__xgafv: string, V1 error format. 453 Allowed values 454 1 - v1 error format 455 2 - v2 error format 456 457Returns: 458 An object of the form: 459 460 { 461 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. 462 "A String", 463 ], 464}</pre> 465</div> 466 467<div class="method"> 468 <code class="details" id="update">update(project, httpHealthCheck, body=None, requestId=None, x__xgafv=None)</code> 469 <pre>Updates a HttpHealthCheck resource in the specified project using the data included in the request. 470 471Args: 472 project: string, Project ID for this request. (required) 473 httpHealthCheck: string, Name of the HttpHealthCheck resource to update. (required) 474 body: object, The request body. 475 The object takes the form of: 476 477{ # 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 . 478 "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds. 479 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 480 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 481 "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. 482 "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. 483 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 484 "kind": "compute#httpHealthCheck", # [Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks. 485 "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. 486 "port": 42, # The TCP port number for the HTTP health check request. The default value is 80. 487 "requestPath": "A String", # The request path of the HTTP health check request. The default value is /. This field does not support query parameters. 488 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 489 "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. 490 "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. 491} 492 493 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). 494 x__xgafv: string, V1 error format. 495 Allowed values 496 1 - v1 error format 497 2 - v2 error format 498 499Returns: 500 An object of the form: 501 502 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/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. 503 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 504 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 505 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 506 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 507 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 508 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 509 { 510 "code": "A String", # [Output Only] The error type identifier for this error. 511 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 512 "message": "A String", # [Output Only] An optional, human-readable error message. 513 }, 514 ], 515 }, 516 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 517 "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. 518 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 519 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 520 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 521 "name": "A String", # [Output Only] Name of the operation. 522 "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. 523 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 524 "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. 525 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 526 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 527 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 528 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 529 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 530 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 531 "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. 532 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 533 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 534 { 535 "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. 536 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 537 { 538 "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). 539 "value": "A String", # [Output Only] A warning data value corresponding to the key. 540 }, 541 ], 542 "message": "A String", # [Output Only] A human-readable description of the warning code. 543 }, 544 ], 545 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 546}</pre> 547</div> 548 549</body></html>