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