John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| 75 | <h1><a href="compute_v1.html">Compute Engine API</a> . <a href="compute_v1.httpHealthChecks.html">httpHealthChecks</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="#delete">delete(project, httpHealthCheck)</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.</p> |
| 83 | <p class="toc_element"> |
| 84 | <code><a href="#insert">insert(project, body)</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, 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)</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.</p> |
| 95 | <p class="toc_element"> |
| 96 | <code><a href="#update">update(project, httpHealthCheck, body)</a></code></p> |
| 97 | <p class="firstline">Updates a HttpHealthCheck resource in the specified project using the data included in the request.</p> |
| 98 | <h3>Method Details</h3> |
| 99 | <div class="method"> |
| 100 | <code class="details" id="delete">delete(project, httpHealthCheck)</code> |
| 101 | <pre>Deletes the specified HttpHealthCheck resource. |
| 102 | |
| 103 | Args: |
| 104 | project: string, Name of the project scoping this request. (required) |
| 105 | httpHealthCheck: string, Name of the HttpHealthCheck resource to delete. (required) |
| 106 | |
| 107 | Returns: |
| 108 | An object of the form: |
| 109 | |
| 110 | { # An operation resource, used to manage asynchronous API requests. |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 111 | "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target. |
| 112 | "clientOperationId": "A String", |
| 113 | "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only). |
| 114 | "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. |
| 115 | "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only). |
| 116 | "operationType": "A String", |
| 117 | "httpErrorMessage": "A String", |
| 118 | "progress": 42, |
| 119 | "httpErrorStatusCode": 42, |
| 120 | "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. |
| 121 | "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE". |
| 122 | "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format. |
| 123 | "warnings": [ |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 124 | { |
| 125 | "message": "A String", # Optional human-readable details for this warning. |
| 126 | "code": "A String", # The warning type identifier for this warning. |
| 127 | "data": [ # Metadata for this warning in 'key: value' format. |
| 128 | { |
| 129 | "value": "A String", # A warning data value corresponding to the key. |
| 130 | "key": "A String", # A key for the warning data. |
| 131 | }, |
| 132 | ], |
| 133 | }, |
| 134 | ], |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 135 | "user": "A String", |
| 136 | "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format. |
| 137 | "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources. |
| 138 | "name": "A String", # [Output Only] Name of the resource (output only). |
| 139 | "region": "A String", # [Output Only] URL of the region where the operation resides (output only). |
| 140 | "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated. |
| 141 | "errors": [ # [Output Only] The array of errors encountered while processing this operation. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 142 | { |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 143 | "message": "A String", # [Output Only] An optional, human-readable error message. |
| 144 | "code": "A String", # [Output Only] The error type identifier for this error. |
| 145 | "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 146 | }, |
| 147 | ], |
| 148 | }, |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 149 | "endTime": "A String", |
| 150 | "selfLink": "A String", # [Output Only] Server defined URL for the resource. |
| 151 | "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only). |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 152 | }</pre> |
| 153 | </div> |
| 154 | |
| 155 | <div class="method"> |
| 156 | <code class="details" id="get">get(project, httpHealthCheck)</code> |
| 157 | <pre>Returns the specified HttpHealthCheck resource. |
| 158 | |
| 159 | Args: |
| 160 | project: string, Name of the project scoping this request. (required) |
| 161 | httpHealthCheck: string, Name of the HttpHealthCheck resource to return. (required) |
| 162 | |
| 163 | Returns: |
| 164 | An object of the form: |
| 165 | |
| 166 | { # An HttpHealthCheck resource. This resource defines a template for how individual VMs should be checked for health, via HTTP. |
| 167 | "kind": "compute#httpHealthCheck", # Type of the resource. |
| 168 | "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created. |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 169 | "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. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 170 | "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds. |
| 171 | "port": 42, # The TCP port number for the HTTP health check request. The default value is 80. |
| 172 | "healthyThreshold": 42, # A so-far unhealthy VM will be marked healthy after this many consecutive successes. The default value is 2. |
| 173 | "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. |
| 174 | "requestPath": "A String", # The request path of the HTTP health check request. The default value is "/". |
| 175 | "unhealthyThreshold": 42, # A so-far healthy VM will be marked unhealthy after this many consecutive failures. The default value is 2. |
| 176 | "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only). |
| 177 | "id": "A String", # Unique identifier for the resource; defined by the server (output only). |
| 178 | "selfLink": "A String", # Server defined URL for the resource (output only). |
| 179 | "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. |
| 180 | }</pre> |
| 181 | </div> |
| 182 | |
| 183 | <div class="method"> |
| 184 | <code class="details" id="insert">insert(project, body)</code> |
| 185 | <pre>Creates a HttpHealthCheck resource in the specified project using the data included in the request. |
| 186 | |
| 187 | Args: |
| 188 | project: string, Name of the project scoping this request. (required) |
| 189 | body: object, The request body. (required) |
| 190 | The object takes the form of: |
| 191 | |
| 192 | { # An HttpHealthCheck resource. This resource defines a template for how individual VMs should be checked for health, via HTTP. |
| 193 | "kind": "compute#httpHealthCheck", # Type of the resource. |
| 194 | "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created. |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 195 | "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. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 196 | "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds. |
| 197 | "port": 42, # The TCP port number for the HTTP health check request. The default value is 80. |
| 198 | "healthyThreshold": 42, # A so-far unhealthy VM will be marked healthy after this many consecutive successes. The default value is 2. |
| 199 | "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. |
| 200 | "requestPath": "A String", # The request path of the HTTP health check request. The default value is "/". |
| 201 | "unhealthyThreshold": 42, # A so-far healthy VM will be marked unhealthy after this many consecutive failures. The default value is 2. |
| 202 | "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only). |
| 203 | "id": "A String", # Unique identifier for the resource; defined by the server (output only). |
| 204 | "selfLink": "A String", # Server defined URL for the resource (output only). |
| 205 | "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. |
| 206 | } |
| 207 | |
| 208 | |
| 209 | Returns: |
| 210 | An object of the form: |
| 211 | |
| 212 | { # An operation resource, used to manage asynchronous API requests. |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 213 | "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target. |
| 214 | "clientOperationId": "A String", |
| 215 | "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only). |
| 216 | "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. |
| 217 | "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only). |
| 218 | "operationType": "A String", |
| 219 | "httpErrorMessage": "A String", |
| 220 | "progress": 42, |
| 221 | "httpErrorStatusCode": 42, |
| 222 | "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. |
| 223 | "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE". |
| 224 | "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format. |
| 225 | "warnings": [ |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 226 | { |
| 227 | "message": "A String", # Optional human-readable details for this warning. |
| 228 | "code": "A String", # The warning type identifier for this warning. |
| 229 | "data": [ # Metadata for this warning in 'key: value' format. |
| 230 | { |
| 231 | "value": "A String", # A warning data value corresponding to the key. |
| 232 | "key": "A String", # A key for the warning data. |
| 233 | }, |
| 234 | ], |
| 235 | }, |
| 236 | ], |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 237 | "user": "A String", |
| 238 | "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format. |
| 239 | "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources. |
| 240 | "name": "A String", # [Output Only] Name of the resource (output only). |
| 241 | "region": "A String", # [Output Only] URL of the region where the operation resides (output only). |
| 242 | "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated. |
| 243 | "errors": [ # [Output Only] The array of errors encountered while processing this operation. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 244 | { |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 245 | "message": "A String", # [Output Only] An optional, human-readable error message. |
| 246 | "code": "A String", # [Output Only] The error type identifier for this error. |
| 247 | "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 248 | }, |
| 249 | ], |
| 250 | }, |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 251 | "endTime": "A String", |
| 252 | "selfLink": "A String", # [Output Only] Server defined URL for the resource. |
| 253 | "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only). |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 254 | }</pre> |
| 255 | </div> |
| 256 | |
| 257 | <div class="method"> |
| 258 | <code class="details" id="list">list(project, maxResults=None, pageToken=None, filter=None)</code> |
| 259 | <pre>Retrieves the list of HttpHealthCheck resources available to the specified project. |
| 260 | |
| 261 | Args: |
| 262 | project: string, Name of the project scoping this request. (required) |
| 263 | maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500. |
| 264 | pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request. |
| 265 | filter: string, Optional. Filter expression for filtering listed resources. |
| 266 | |
| 267 | Returns: |
| 268 | An object of the form: |
| 269 | |
| 270 | { # Contains a list of HttpHealthCheck resources. |
| 271 | "nextPageToken": "A String", # A token used to continue a truncated list request (output only). |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 272 | "items": [ # A list of HttpHealthCheck resources. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 273 | { # An HttpHealthCheck resource. This resource defines a template for how individual VMs should be checked for health, via HTTP. |
| 274 | "kind": "compute#httpHealthCheck", # Type of the resource. |
| 275 | "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created. |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 276 | "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. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 277 | "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds. |
| 278 | "port": 42, # The TCP port number for the HTTP health check request. The default value is 80. |
| 279 | "healthyThreshold": 42, # A so-far unhealthy VM will be marked healthy after this many consecutive successes. The default value is 2. |
| 280 | "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. |
| 281 | "requestPath": "A String", # The request path of the HTTP health check request. The default value is "/". |
| 282 | "unhealthyThreshold": 42, # A so-far healthy VM will be marked unhealthy after this many consecutive failures. The default value is 2. |
| 283 | "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only). |
| 284 | "id": "A String", # Unique identifier for the resource; defined by the server (output only). |
| 285 | "selfLink": "A String", # Server defined URL for the resource (output only). |
| 286 | "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. |
| 287 | }, |
| 288 | ], |
| 289 | "kind": "compute#httpHealthCheckList", # Type of resource. |
| 290 | "id": "A String", # Unique identifier for the resource; defined by the server (output only). |
| 291 | "selfLink": "A String", # Server defined URL for this resource (output only). |
| 292 | }</pre> |
| 293 | </div> |
| 294 | |
| 295 | <div class="method"> |
| 296 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 297 | <pre>Retrieves the next page of results. |
| 298 | |
| 299 | Args: |
| 300 | previous_request: The request for the previous page. (required) |
| 301 | previous_response: The response from the request for the previous page. (required) |
| 302 | |
| 303 | Returns: |
| 304 | A request object that you can call 'execute()' on to request the next |
| 305 | page. Returns None if there are no more items in the collection. |
| 306 | </pre> |
| 307 | </div> |
| 308 | |
| 309 | <div class="method"> |
| 310 | <code class="details" id="patch">patch(project, httpHealthCheck, body)</code> |
| 311 | <pre>Updates a HttpHealthCheck resource in the specified project using the data included in the request. This method supports patch semantics. |
| 312 | |
| 313 | Args: |
| 314 | project: string, Name of the project scoping this request. (required) |
| 315 | httpHealthCheck: string, Name of the HttpHealthCheck resource to update. (required) |
| 316 | body: object, The request body. (required) |
| 317 | The object takes the form of: |
| 318 | |
| 319 | { # An HttpHealthCheck resource. This resource defines a template for how individual VMs should be checked for health, via HTTP. |
| 320 | "kind": "compute#httpHealthCheck", # Type of the resource. |
| 321 | "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created. |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 322 | "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. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 323 | "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds. |
| 324 | "port": 42, # The TCP port number for the HTTP health check request. The default value is 80. |
| 325 | "healthyThreshold": 42, # A so-far unhealthy VM will be marked healthy after this many consecutive successes. The default value is 2. |
| 326 | "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. |
| 327 | "requestPath": "A String", # The request path of the HTTP health check request. The default value is "/". |
| 328 | "unhealthyThreshold": 42, # A so-far healthy VM will be marked unhealthy after this many consecutive failures. The default value is 2. |
| 329 | "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only). |
| 330 | "id": "A String", # Unique identifier for the resource; defined by the server (output only). |
| 331 | "selfLink": "A String", # Server defined URL for the resource (output only). |
| 332 | "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. |
| 333 | } |
| 334 | |
| 335 | |
| 336 | Returns: |
| 337 | An object of the form: |
| 338 | |
| 339 | { # An operation resource, used to manage asynchronous API requests. |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 340 | "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target. |
| 341 | "clientOperationId": "A String", |
| 342 | "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only). |
| 343 | "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. |
| 344 | "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only). |
| 345 | "operationType": "A String", |
| 346 | "httpErrorMessage": "A String", |
| 347 | "progress": 42, |
| 348 | "httpErrorStatusCode": 42, |
| 349 | "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. |
| 350 | "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE". |
| 351 | "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format. |
| 352 | "warnings": [ |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 353 | { |
| 354 | "message": "A String", # Optional human-readable details for this warning. |
| 355 | "code": "A String", # The warning type identifier for this warning. |
| 356 | "data": [ # Metadata for this warning in 'key: value' format. |
| 357 | { |
| 358 | "value": "A String", # A warning data value corresponding to the key. |
| 359 | "key": "A String", # A key for the warning data. |
| 360 | }, |
| 361 | ], |
| 362 | }, |
| 363 | ], |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 364 | "user": "A String", |
| 365 | "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format. |
| 366 | "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources. |
| 367 | "name": "A String", # [Output Only] Name of the resource (output only). |
| 368 | "region": "A String", # [Output Only] URL of the region where the operation resides (output only). |
| 369 | "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated. |
| 370 | "errors": [ # [Output Only] The array of errors encountered while processing this operation. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 371 | { |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 372 | "message": "A String", # [Output Only] An optional, human-readable error message. |
| 373 | "code": "A String", # [Output Only] The error type identifier for this error. |
| 374 | "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 375 | }, |
| 376 | ], |
| 377 | }, |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 378 | "endTime": "A String", |
| 379 | "selfLink": "A String", # [Output Only] Server defined URL for the resource. |
| 380 | "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only). |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 381 | }</pre> |
| 382 | </div> |
| 383 | |
| 384 | <div class="method"> |
| 385 | <code class="details" id="update">update(project, httpHealthCheck, body)</code> |
| 386 | <pre>Updates a HttpHealthCheck resource in the specified project using the data included in the request. |
| 387 | |
| 388 | Args: |
| 389 | project: string, Name of the project scoping this request. (required) |
| 390 | httpHealthCheck: string, Name of the HttpHealthCheck resource to update. (required) |
| 391 | body: object, The request body. (required) |
| 392 | The object takes the form of: |
| 393 | |
| 394 | { # An HttpHealthCheck resource. This resource defines a template for how individual VMs should be checked for health, via HTTP. |
| 395 | "kind": "compute#httpHealthCheck", # Type of the resource. |
| 396 | "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created. |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 397 | "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. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 398 | "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds. |
| 399 | "port": 42, # The TCP port number for the HTTP health check request. The default value is 80. |
| 400 | "healthyThreshold": 42, # A so-far unhealthy VM will be marked healthy after this many consecutive successes. The default value is 2. |
| 401 | "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. |
| 402 | "requestPath": "A String", # The request path of the HTTP health check request. The default value is "/". |
| 403 | "unhealthyThreshold": 42, # A so-far healthy VM will be marked unhealthy after this many consecutive failures. The default value is 2. |
| 404 | "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only). |
| 405 | "id": "A String", # Unique identifier for the resource; defined by the server (output only). |
| 406 | "selfLink": "A String", # Server defined URL for the resource (output only). |
| 407 | "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. |
| 408 | } |
| 409 | |
| 410 | |
| 411 | Returns: |
| 412 | An object of the form: |
| 413 | |
| 414 | { # An operation resource, used to manage asynchronous API requests. |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 415 | "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target. |
| 416 | "clientOperationId": "A String", |
| 417 | "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only). |
| 418 | "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. |
| 419 | "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only). |
| 420 | "operationType": "A String", |
| 421 | "httpErrorMessage": "A String", |
| 422 | "progress": 42, |
| 423 | "httpErrorStatusCode": 42, |
| 424 | "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. |
| 425 | "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE". |
| 426 | "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format. |
| 427 | "warnings": [ |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 428 | { |
| 429 | "message": "A String", # Optional human-readable details for this warning. |
| 430 | "code": "A String", # The warning type identifier for this warning. |
| 431 | "data": [ # Metadata for this warning in 'key: value' format. |
| 432 | { |
| 433 | "value": "A String", # A warning data value corresponding to the key. |
| 434 | "key": "A String", # A key for the warning data. |
| 435 | }, |
| 436 | ], |
| 437 | }, |
| 438 | ], |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 439 | "user": "A String", |
| 440 | "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format. |
| 441 | "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources. |
| 442 | "name": "A String", # [Output Only] Name of the resource (output only). |
| 443 | "region": "A String", # [Output Only] URL of the region where the operation resides (output only). |
| 444 | "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated. |
| 445 | "errors": [ # [Output Only] The array of errors encountered while processing this operation. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 446 | { |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 447 | "message": "A String", # [Output Only] An optional, human-readable error message. |
| 448 | "code": "A String", # [Output Only] The error type identifier for this error. |
| 449 | "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 450 | }, |
| 451 | ], |
| 452 | }, |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 453 | "endTime": "A String", |
| 454 | "selfLink": "A String", # [Output Only] Server defined URL for the resource. |
| 455 | "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only). |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 456 | }</pre> |
| 457 | </div> |
| 458 | |
| 459 | </body></html> |