Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 386cc8b06b57c3d4a564fe0ab0d1e51fc34270a8 / . / docs / dyn / compute_v1.httpHealthChecks.html
blob: 8f62f4dd6c5b33d33a3870b2f4e14aeab020ead5 [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]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_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
103Args:
104 project: string, Name of the project scoping this request. (required)
105 httpHealthCheck: string, Name of the HttpHealthCheck resource to delete. (required)
106
107Returns:
108 An object of the form:
109
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]110 { # An Operation resource, used to manage asynchronous API requests.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]111 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]112 "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]113 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]114 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]115 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
116 "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
117 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]118 "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 at when the operation will be complete. This number should monotonically increase as the operation progresses.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]119 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]120 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]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 RFC3339 text format.
123 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]124 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]125 "message": "A String", # [Output Only] Optional human-readable details for this warning.
126 "code": "A String", # [Output Only] The warning type identifier for this warning.
127 "data": [ # [Output Only] Metadata for this warning in key: value format.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]128 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]129 "value": "A String", # [Output Only] A warning data value corresponding to the key.
130 "key": "A String", # [Output Only] A key for the warning data.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]131 },
132 ],
133 },
134 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]135 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
136 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
137 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
138 "name": "A String", # [Output Only] Name of the resource.
139 "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
140 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]141 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]142 {
Craig Citroe633be12015-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 Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]146 },
147 ],
148 },
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]149 "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]150 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]151 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
John Asmuth614db982014-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
159Args:
160 project: string, Name of the project scoping this request. (required)
161 httpHealthCheck: string, Name of the HttpHealthCheck resource to return. (required)
162
163Returns:
164 An object of the form:
165
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]166 { # An HttpHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTP.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]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 Citroe633be12015-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 Asmuth614db982014-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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]172 "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]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 "/".
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]175 "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
176 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
177 "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server.
178 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
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. 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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]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
187Args:
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
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]192{ # An HttpHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTP.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]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 Citroe633be12015-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 Asmuth614db982014-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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]198 "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]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 "/".
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]201 "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
202 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
203 "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server.
204 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
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. 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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]206 }
207
208
209Returns:
210 An object of the form:
211
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]212 { # An Operation resource, used to manage asynchronous API requests.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]213 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]214 "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]215 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]216 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]217 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
218 "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
219 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]220 "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 at when the operation will be complete. This number should monotonically increase as the operation progresses.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]221 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]222 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]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 RFC3339 text format.
225 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]226 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]227 "message": "A String", # [Output Only] Optional human-readable details for this warning.
228 "code": "A String", # [Output Only] The warning type identifier for this warning.
229 "data": [ # [Output Only] Metadata for this warning in key: value format.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]230 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]231 "value": "A String", # [Output Only] A warning data value corresponding to the key.
232 "key": "A String", # [Output Only] A key for the warning data.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]233 },
234 ],
235 },
236 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]237 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
238 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
239 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
240 "name": "A String", # [Output Only] Name of the resource.
241 "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
242 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]243 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]244 {
Craig Citroe633be12015-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 Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]248 },
249 ],
250 },
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]251 "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]252 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]253 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
John Asmuth614db982014-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
261Args:
262 project: string, Name of the project scoping this request. (required)
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]263 maxResults: integer, Maximum count of results to be returned.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]264 pageToken: string, Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.
265 filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.
266
267The FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
268
269For example, filter=name ne example-instance.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]270
271Returns:
272 An object of the form:
273
274 { # Contains a list of HttpHealthCheck resources.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]275 "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]276 "items": [ # A list of HttpHealthCheck resources.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]277 { # An HttpHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTP.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]278 "kind": "compute#httpHealthCheck", # Type of the resource.
279 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]280 "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 Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]281 "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
282 "port": 42, # The TCP port number for the HTTP health check request. The default value is 80.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]283 "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]284 "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.
285 "requestPath": "A String", # The request path of the HTTP health check request. The default value is "/".
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]286 "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
287 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
288 "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server.
289 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
290 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]291 },
292 ],
293 "kind": "compute#httpHealthCheckList", # Type of resource.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]294 "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server.
295 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]296 }</pre>
297</div>
298
299<div class="method">
300 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
301 <pre>Retrieves the next page of results.
302
303Args:
304 previous_request: The request for the previous page. (required)
305 previous_response: The response from the request for the previous page. (required)
306
307Returns:
308 A request object that you can call 'execute()' on to request the next
309 page. Returns None if there are no more items in the collection.
310 </pre>
311</div>
312
313<div class="method">
314 <code class="details" id="patch">patch(project, httpHealthCheck, body)</code>
315 <pre>Updates a HttpHealthCheck resource in the specified project using the data included in the request. This method supports patch semantics.
316
317Args:
318 project: string, Name of the project scoping this request. (required)
319 httpHealthCheck: string, Name of the HttpHealthCheck resource to update. (required)
320 body: object, The request body. (required)
321 The object takes the form of:
322
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]323{ # An HttpHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTP.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]324 "kind": "compute#httpHealthCheck", # Type of the resource.
325 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]326 "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 Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]327 "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
328 "port": 42, # The TCP port number for the HTTP health check request. The default value is 80.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]329 "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]330 "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.
331 "requestPath": "A String", # The request path of the HTTP health check request. The default value is "/".
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]332 "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
333 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
334 "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server.
335 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
336 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]337 }
338
339
340Returns:
341 An object of the form:
342
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]343 { # An Operation resource, used to manage asynchronous API requests.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]344 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]345 "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]346 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]347 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]348 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
349 "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
350 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]351 "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 at when the operation will be complete. This number should monotonically increase as the operation progresses.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]352 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]353 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]354 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
355 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
356 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]357 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]358 "message": "A String", # [Output Only] Optional human-readable details for this warning.
359 "code": "A String", # [Output Only] The warning type identifier for this warning.
360 "data": [ # [Output Only] Metadata for this warning in key: value format.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]361 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]362 "value": "A String", # [Output Only] A warning data value corresponding to the key.
363 "key": "A String", # [Output Only] A key for the warning data.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]364 },
365 ],
366 },
367 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]368 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
369 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
370 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
371 "name": "A String", # [Output Only] Name of the resource.
372 "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
373 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]374 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]375 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]376 "message": "A String", # [Output Only] An optional, human-readable error message.
377 "code": "A String", # [Output Only] The error type identifier for this error.
378 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]379 },
380 ],
381 },
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]382 "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]383 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]384 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]385 }</pre>
386</div>
387
388<div class="method">
389 <code class="details" id="update">update(project, httpHealthCheck, body)</code>
390 <pre>Updates a HttpHealthCheck resource in the specified project using the data included in the request.
391
392Args:
393 project: string, Name of the project scoping this request. (required)
394 httpHealthCheck: string, Name of the HttpHealthCheck resource to update. (required)
395 body: object, The request body. (required)
396 The object takes the form of:
397
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]398{ # An HttpHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTP.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]399 "kind": "compute#httpHealthCheck", # Type of the resource.
400 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]401 "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 Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]402 "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
403 "port": 42, # The TCP port number for the HTTP health check request. The default value is 80.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]404 "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]405 "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.
406 "requestPath": "A String", # The request path of the HTTP health check request. The default value is "/".
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]407 "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
408 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
409 "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server.
410 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
411 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]412 }
413
414
415Returns:
416 An object of the form:
417
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]418 { # An Operation resource, used to manage asynchronous API requests.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]419 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]420 "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]421 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]422 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]423 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
424 "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
425 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]426 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should monotonically increase as the operation progresses.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]427 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]428 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]429 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
430 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
431 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]432 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]433 "message": "A String", # [Output Only] Optional human-readable details for this warning.
434 "code": "A String", # [Output Only] The warning type identifier for this warning.
435 "data": [ # [Output Only] Metadata for this warning in key: value format.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]436 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]437 "value": "A String", # [Output Only] A warning data value corresponding to the key.
438 "key": "A String", # [Output Only] A key for the warning data.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]439 },
440 ],
441 },
442 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]443 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
444 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
445 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
446 "name": "A String", # [Output Only] Name of the resource.
447 "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
448 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]449 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]450 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]451 "message": "A String", # [Output Only] An optional, human-readable error message.
452 "code": "A String", # [Output Only] The error type identifier for this error.
453 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]454 },
455 ],
456 },
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]457 "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]458 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]459 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]460 }</pre>
461</div>
462
463</body></html>