Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 36e41bc9e5f0c6e6d5920ae4a5c9802ca63554e2 / . / docs / dyn / compute_v1.httpHealthChecks.html
blob: cae6634873dd7d24cea3229ef67bd09bafe70292 [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:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]104 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]111 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
112 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]113 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]114 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
115 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
116 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
117 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]118 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]119 "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.
120 "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.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]121 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]122 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
123 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]124 "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]125 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]126 "message": "A String", # [Output Only] A human-readable description of the warning code.
127 "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.
128 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
129 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]130 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]131 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]132 "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).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]133 },
134 ],
135 },
136 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]137 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]138 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
139 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]140 "name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]141 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]142 "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]143 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]144 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]145 "message": "A String", # [Output Only] An optional, human-readable error message.
146 "code": "A String", # [Output Only] The error type identifier for this error.
147 "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]148 },
149 ],
150 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]151 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]152 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]153 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]154 }</pre>
155</div>
156
157<div class="method">
158 <code class="details" id="get">get(project, httpHealthCheck)</code>
159 <pre>Returns the specified HttpHealthCheck resource.
160
161Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]162 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]163 httpHealthCheck: string, Name of the HttpHealthCheck resource to return. (required)
164
165Returns:
166 An object of the form:
167
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]168 { # An HttpHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTP.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]169 "kind": "compute#httpHealthCheck", # [Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks.
170 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]171 "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]172 "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
173 "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]174 "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]175 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]176 "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]177 "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
178 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]179 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]180 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
181 "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]182 }</pre>
183</div>
184
185<div class="method">
186 <code class="details" id="insert">insert(project, body)</code>
187 <pre>Creates a HttpHealthCheck resource in the specified project using the data included in the request.
188
189Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]190 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]191 body: object, The request body. (required)
192 The object takes the form of:
193
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]194{ # An HttpHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTP.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]195 "kind": "compute#httpHealthCheck", # [Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks.
196 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]197 "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]198 "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
199 "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]200 "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]201 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]202 "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]203 "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
204 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]205 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]206 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
207 "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]208 }
209
210
211Returns:
212 An object of the form:
213
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]214 { # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]215 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
216 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]217 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]218 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
219 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
220 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
221 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]222 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]223 "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.
224 "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.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]225 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]226 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
227 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]228 "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]229 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]230 "message": "A String", # [Output Only] A human-readable description of the warning code.
231 "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.
232 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
233 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]234 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]235 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]236 "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).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]237 },
238 ],
239 },
240 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]241 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]242 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
243 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]244 "name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]245 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]246 "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]247 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]248 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]249 "message": "A String", # [Output Only] An optional, human-readable error message.
250 "code": "A String", # [Output Only] The error type identifier for this error.
251 "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]252 },
253 ],
254 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]255 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]256 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]257 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]258 }</pre>
259</div>
260
261<div class="method">
262 <code class="details" id="list">list(project, maxResults=None, pageToken=None, filter=None)</code>
263 <pre>Retrieves the list of HttpHealthCheck resources available to the specified project.
264
265Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]266 project: string, Project ID for this request. (required)
267 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.
268 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.
269 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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]270
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]271The 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 you are filtering by (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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]272
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]273For example, to filter for instances whose name is not equal to example-instance, you would use filter=name ne example-instance.
274
275Compute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.
276
277The Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions meaning that resources must match all expressions to pass the filters.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]278
279Returns:
280 An object of the form:
281
282 { # Contains a list of HttpHealthCheck resources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]283 "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.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]284 "items": [ # A list of HttpHealthCheck resources.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]285 { # An HttpHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTP.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]286 "kind": "compute#httpHealthCheck", # [Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks.
287 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]288 "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]289 "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
290 "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]291 "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]292 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]293 "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]294 "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
295 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]296 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]297 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
298 "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]299 },
300 ],
301 "kind": "compute#httpHealthCheckList", # Type of resource.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]302 "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server.
303 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]304 }</pre>
305</div>
306
307<div class="method">
308 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
309 <pre>Retrieves the next page of results.
310
311Args:
312 previous_request: The request for the previous page. (required)
313 previous_response: The response from the request for the previous page. (required)
314
315Returns:
316 A request object that you can call 'execute()' on to request the next
317 page. Returns None if there are no more items in the collection.
318 </pre>
319</div>
320
321<div class="method">
322 <code class="details" id="patch">patch(project, httpHealthCheck, body)</code>
323 <pre>Updates a HttpHealthCheck resource in the specified project using the data included in the request. This method supports patch semantics.
324
325Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]326 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]327 httpHealthCheck: string, Name of the HttpHealthCheck resource to update. (required)
328 body: object, The request body. (required)
329 The object takes the form of:
330
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]331{ # An HttpHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTP.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]332 "kind": "compute#httpHealthCheck", # [Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks.
333 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]334 "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]335 "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
336 "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]337 "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]338 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]339 "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]340 "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
341 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]342 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]343 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
344 "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]345 }
346
347
348Returns:
349 An object of the form:
350
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]351 { # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]352 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
353 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]354 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]355 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
356 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
357 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
358 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]359 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]360 "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.
361 "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.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]362 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]363 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
364 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]365 "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]366 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]367 "message": "A String", # [Output Only] A human-readable description of the warning code.
368 "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.
369 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
370 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]371 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]372 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]373 "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).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]374 },
375 ],
376 },
377 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]378 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]379 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
380 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]381 "name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]382 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]383 "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]384 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]385 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]386 "message": "A String", # [Output Only] An optional, human-readable error message.
387 "code": "A String", # [Output Only] The error type identifier for this error.
388 "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]389 },
390 ],
391 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]392 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]393 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]394 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]395 }</pre>
396</div>
397
398<div class="method">
399 <code class="details" id="update">update(project, httpHealthCheck, body)</code>
400 <pre>Updates a HttpHealthCheck resource in the specified project using the data included in the request.
401
402Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]403 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]404 httpHealthCheck: string, Name of the HttpHealthCheck resource to update. (required)
405 body: object, The request body. (required)
406 The object takes the form of:
407
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]408{ # An HttpHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTP.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]409 "kind": "compute#httpHealthCheck", # [Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks.
410 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]411 "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]412 "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
413 "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]414 "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]415 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]416 "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]417 "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
418 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]419 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]420 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
421 "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]422 }
423
424
425Returns:
426 An object of the form:
427
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]428 { # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]429 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
430 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]431 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]432 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
433 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
434 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
435 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]436 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]437 "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.
438 "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.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]439 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]440 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
441 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]442 "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]443 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]444 "message": "A String", # [Output Only] A human-readable description of the warning code.
445 "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.
446 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
447 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]448 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]449 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]450 "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).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]451 },
452 ],
453 },
454 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]455 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]456 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
457 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]458 "name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]459 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]460 "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]461 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]462 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]463 "message": "A String", # [Output Only] An optional, human-readable error message.
464 "code": "A String", # [Output Only] The error type identifier for this error.
465 "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]466 },
467 ],
468 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]469 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]470 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]471 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]472 }</pre>
473</div>
474
475</body></html>