Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / c30d2b5d4478b230246dcaaa9f1c533ca3304387 / . / docs / dyn / compute_alpha.httpsHealthChecks.html
blob: 11d40de3cc7e86704176b415a4165685a54a9758 [file] [log] [blame]
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[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_alpha.html">Compute Engine API</a> . <a href="compute_alpha.httpsHealthChecks.html">httpsHealthChecks</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]78 <code><a href="#delete">delete(project, httpsHealthCheck, requestId=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]79<p class="firstline">Deletes the specified HttpsHealthCheck resource.</p>
80<p class="toc_element">
81 <code><a href="#get">get(project, httpsHealthCheck)</a></code></p>
82<p class="firstline">Returns the specified HttpsHealthCheck resource. Get a list of available HTTPS health checks by making a list() request.</p>
83<p class="toc_element">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]84 <code><a href="#insert">insert(project, body, requestId=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]85<p class="firstline">Creates a HttpsHealthCheck resource in the specified project using the data included in the request.</p>
86<p class="toc_element">
87 <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
88<p class="firstline">Retrieves the list of HttpsHealthCheck 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">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]93 <code><a href="#patch">patch(project, httpsHealthCheck, body, requestId=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]94<p class="firstline">Updates a HttpsHealthCheck 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="#testIamPermissions">testIamPermissions(project, resource, body)</a></code></p>
97<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
98<p class="toc_element">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]99 <code><a href="#update">update(project, httpsHealthCheck, body, requestId=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]100<p class="firstline">Updates a HttpsHealthCheck resource in the specified project using the data included in the request.</p>
101<h3>Method Details</h3>
102<div class="method">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]103 <code class="details" id="delete">delete(project, httpsHealthCheck, requestId=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]104 <pre>Deletes the specified HttpsHealthCheck resource.
105
106Args:
107 project: string, Project ID for this request. (required)
108 httpsHealthCheck: string, Name of the HttpsHealthCheck resource to delete. (required)
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]109 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]110
111Returns:
112 An object of the form:
113
114 { # An Operation resource, used to manage asynchronous API requests.
115 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
116 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]117 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]118 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
119 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
120 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
121 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
122 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
123 "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.
124 "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.
125 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
126 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
127 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
128 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
129 {
130 "message": "A String", # [Output Only] A human-readable description of the warning code.
131 "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.
132 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
133 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
134 {
135 "value": "A String", # [Output Only] A warning data value corresponding to the key.
136 "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).
137 },
138 ],
139 },
140 ],
141 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
142 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
143 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
144 "name": "A String", # [Output Only] Name of the resource.
145 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
146 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
147 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
148 {
149 "message": "A String", # [Output Only] An optional, human-readable error message.
150 "code": "A String", # [Output Only] The error type identifier for this error.
151 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
152 },
153 ],
154 },
155 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
156 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]157 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]158 }</pre>
159</div>
160
161<div class="method">
162 <code class="details" id="get">get(project, httpsHealthCheck)</code>
163 <pre>Returns the specified HttpsHealthCheck resource. Get a list of available HTTPS health checks by making a list() request.
164
165Args:
166 project: string, Project ID for this request. (required)
167 httpsHealthCheck: string, Name of the HttpsHealthCheck resource to return. (required)
168
169Returns:
170 An object of the form:
171
172 { # An HttpsHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTPS.
173 "kind": "compute#httpsHealthCheck", # Type of the resource.
174 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
175 "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have a greater value than checkIntervalSec.
176 "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
177 "port": 42, # The TCP port number for the HTTPS health check request. The default value is 443.
178 "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
179 "host": "A String", # The value of the host header in the HTTPS health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.
180 "requestPath": "A String", # The request path of the HTTPS health check request. The default value is "/".
181 "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
182 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
183 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
184 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
185 "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.
186 }</pre>
187</div>
188
189<div class="method">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]190 <code class="details" id="insert">insert(project, body, requestId=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]191 <pre>Creates a HttpsHealthCheck resource in the specified project using the data included in the request.
192
193Args:
194 project: string, Project ID for this request. (required)
195 body: object, The request body. (required)
196 The object takes the form of:
197
198{ # An HttpsHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTPS.
199 "kind": "compute#httpsHealthCheck", # Type of the resource.
200 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
201 "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have a greater value than checkIntervalSec.
202 "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
203 "port": 42, # The TCP port number for the HTTPS health check request. The default value is 443.
204 "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
205 "host": "A String", # The value of the host header in the HTTPS health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.
206 "requestPath": "A String", # The request path of the HTTPS health check request. The default value is "/".
207 "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
208 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
209 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
210 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
211 "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.
212 }
213
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]214 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]215
216Returns:
217 An object of the form:
218
219 { # An Operation resource, used to manage asynchronous API requests.
220 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
221 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]222 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]223 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
224 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
225 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
226 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
227 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
228 "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.
229 "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.
230 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
231 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
232 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
233 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
234 {
235 "message": "A String", # [Output Only] A human-readable description of the warning code.
236 "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.
237 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
238 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
239 {
240 "value": "A String", # [Output Only] A warning data value corresponding to the key.
241 "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).
242 },
243 ],
244 },
245 ],
246 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
247 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
248 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
249 "name": "A String", # [Output Only] Name of the resource.
250 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
251 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
252 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
253 {
254 "message": "A String", # [Output Only] An optional, human-readable error message.
255 "code": "A String", # [Output Only] The error type identifier for this error.
256 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
257 },
258 ],
259 },
260 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
261 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]262 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]263 }</pre>
264</div>
265
266<div class="method">
267 <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
268 <pre>Retrieves the list of HttpsHealthCheck resources available to the specified project.
269
270Args:
271 project: string, Project ID for this request. (required)
272 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
273
274You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
275
276Currently, only sorting by name or creationTimestamp desc is supported.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]277 maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]278 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.
279 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.
280
281The 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.
282
283For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
284
285You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
286
287To filter on multiple expressions, provide 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.
288
289Returns:
290 An object of the form:
291
292 { # Contains a list of HttpsHealthCheck resources.
293 "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.
294 "items": [ # A list of HttpsHealthCheck resources.
295 { # An HttpsHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTPS.
296 "kind": "compute#httpsHealthCheck", # Type of the resource.
297 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
298 "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have a greater value than checkIntervalSec.
299 "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
300 "port": 42, # The TCP port number for the HTTPS health check request. The default value is 443.
301 "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
302 "host": "A String", # The value of the host header in the HTTPS health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.
303 "requestPath": "A String", # The request path of the HTTPS health check request. The default value is "/".
304 "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
305 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
306 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
307 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
308 "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.
309 },
310 ],
311 "kind": "compute#httpsHealthCheckList", # Type of resource.
312 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
313 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
314 }</pre>
315</div>
316
317<div class="method">
318 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
319 <pre>Retrieves the next page of results.
320
321Args:
322 previous_request: The request for the previous page. (required)
323 previous_response: The response from the request for the previous page. (required)
324
325Returns:
326 A request object that you can call 'execute()' on to request the next
327 page. Returns None if there are no more items in the collection.
328 </pre>
329</div>
330
331<div class="method">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]332 <code class="details" id="patch">patch(project, httpsHealthCheck, body, requestId=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]333 <pre>Updates a HttpsHealthCheck resource in the specified project using the data included in the request. This method supports patch semantics.
334
335Args:
336 project: string, Project ID for this request. (required)
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]337 httpsHealthCheck: string, Name of the HttpsHealthCheck resource to patch. (required)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]338 body: object, The request body. (required)
339 The object takes the form of:
340
341{ # An HttpsHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTPS.
342 "kind": "compute#httpsHealthCheck", # Type of the resource.
343 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
344 "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have a greater value than checkIntervalSec.
345 "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
346 "port": 42, # The TCP port number for the HTTPS health check request. The default value is 443.
347 "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
348 "host": "A String", # The value of the host header in the HTTPS health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.
349 "requestPath": "A String", # The request path of the HTTPS health check request. The default value is "/".
350 "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
351 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
352 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
353 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
354 "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.
355 }
356
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]357 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]358
359Returns:
360 An object of the form:
361
362 { # An Operation resource, used to manage asynchronous API requests.
363 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
364 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]365 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]366 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
367 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
368 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
369 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
370 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
371 "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.
372 "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.
373 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
374 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
375 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
376 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
377 {
378 "message": "A String", # [Output Only] A human-readable description of the warning code.
379 "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.
380 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
381 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
382 {
383 "value": "A String", # [Output Only] A warning data value corresponding to the key.
384 "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).
385 },
386 ],
387 },
388 ],
389 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
390 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
391 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
392 "name": "A String", # [Output Only] Name of the resource.
393 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
394 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
395 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
396 {
397 "message": "A String", # [Output Only] An optional, human-readable error message.
398 "code": "A String", # [Output Only] The error type identifier for this error.
399 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
400 },
401 ],
402 },
403 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
404 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]405 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]406 }</pre>
407</div>
408
409<div class="method">
410 <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body)</code>
411 <pre>Returns permissions that a caller has on the specified resource.
412
413Args:
414 project: string, Project ID for this request. (required)
415 resource: string, Name of the resource for this request. (required)
416 body: object, The request body. (required)
417 The object takes the form of:
418
419{
420 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
421 "A String",
422 ],
423 }
424
425
426Returns:
427 An object of the form:
428
429 {
430 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
431 "A String",
432 ],
433 }</pre>
434</div>
435
436<div class="method">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]437 <code class="details" id="update">update(project, httpsHealthCheck, body, requestId=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]438 <pre>Updates a HttpsHealthCheck resource in the specified project using the data included in the request.
439
440Args:
441 project: string, Project ID for this request. (required)
442 httpsHealthCheck: string, Name of the HttpsHealthCheck resource to update. (required)
443 body: object, The request body. (required)
444 The object takes the form of:
445
446{ # An HttpsHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTPS.
447 "kind": "compute#httpsHealthCheck", # Type of the resource.
448 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
449 "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have a greater value than checkIntervalSec.
450 "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
451 "port": 42, # The TCP port number for the HTTPS health check request. The default value is 443.
452 "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
453 "host": "A String", # The value of the host header in the HTTPS health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.
454 "requestPath": "A String", # The request path of the HTTPS health check request. The default value is "/".
455 "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
456 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
457 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
458 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
459 "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.
460 }
461
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]462 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]463
464Returns:
465 An object of the form:
466
467 { # An Operation resource, used to manage asynchronous API requests.
468 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
469 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]470 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]471 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
472 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
473 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
474 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
475 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
476 "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.
477 "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.
478 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
479 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
480 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
481 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
482 {
483 "message": "A String", # [Output Only] A human-readable description of the warning code.
484 "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.
485 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
486 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
487 {
488 "value": "A String", # [Output Only] A warning data value corresponding to the key.
489 "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).
490 },
491 ],
492 },
493 ],
494 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
495 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
496 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
497 "name": "A String", # [Output Only] Name of the resource.
498 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
499 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
500 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
501 {
502 "message": "A String", # [Output Only] An optional, human-readable error message.
503 "code": "A String", # [Output Only] The error type identifier for this error.
504 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
505 },
506 ],
507 },
508 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
509 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]510 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]511 }</pre>
512</div>
513
514</body></html>