Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / ea3a5e1b5572e5438ba86ec0074f60029bd94855 / . / docs / dyn / runtimeconfig_v1beta1.projects.configs.waiters.html
blob: 57c2c09dc4e358bfadebafc6e8ec8a3d586b1f94 [file] [log] [blame]
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -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="runtimeconfig_v1beta1.html">Google Cloud RuntimeConfig API</a> . <a href="runtimeconfig_v1beta1.projects.html">projects</a> . <a href="runtimeconfig_v1beta1.projects.configs.html">configs</a> . <a href="runtimeconfig_v1beta1.projects.configs.waiters.html">waiters</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame^]78 <code><a href="#create">create(parent=None, body, requestId=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]79<p class="firstline">Creates a Waiter resource. This operation returns a long-running Operation</p>
80<p class="toc_element">
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]81 <code><a href="#delete">delete(name=None, x__xgafv=None)</a></code></p>
82<p class="firstline">Deletes the waiter with the specified name.</p>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]83<p class="toc_element">
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]84 <code><a href="#get">get(name=None, x__xgafv=None)</a></code></p>
85<p class="firstline">Gets information about a single waiter.</p>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]86<p class="toc_element">
87 <code><a href="#list">list(parent=None, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]88<p class="firstline">List waiters within the given configuration.</p>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]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<h3>Method Details</h3>
93<div class="method">
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame^]94 <code class="details" id="create">create(parent=None, body, requestId=None, x__xgafv=None)</code>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]95 <pre>Creates a Waiter resource. This operation returns a long-running Operation
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]96resource which can be polled for completion. However, a waiter with the
97given name will exist (and can be retrieved) prior to the operation
98completing. If the operation fails, the failed Waiter resource will
99still exist and must be deleted prior to subsequent creation attempts.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]100
101Args:
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]102 parent: string, The path to the configuration that will own the waiter.
103The configuration must exist beforehand; the path must by in the format:
104
105`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`. (required)
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]106 body: object, The request body. (required)
107 The object takes the form of:
108
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]109{ # A Waiter resource waits for some end condition within a RuntimeConfig resource
110 # to be met before it returns. For example, assume you have a distributed
111 # system where each node writes to a Variable resource indidicating the node's
112 # readiness as part of the startup process.
113 #
114 # You then configure a Waiter resource with the success condition set to wait
115 # until some number of nodes have checked in. Afterwards, your application
116 # runs some arbitrary code after the condition has been met and the waiter
117 # returns successfully.
118 #
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]119 # Once created, a Waiter resource is immutable.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]120 #
121 # To learn more about using waiters, read the
122 # [Creating a Waiter](/deployment-manager/runtime-configurator/creating-a-waiter)
123 # documentation.
124 "name": "A String", # The name of the Waiter resource, in the format:
125 #
126 # projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]
127 #
128 # The `[PROJECT_ID]` must be a valid Google Cloud project ID,
129 # the `[CONFIG_NAME]` must be a valid RuntimeConfig resource, the
130 # `[WAITER_NAME]` must match RFC 1035 segment specification, and the length
131 # of `[WAITER_NAME]` must be less than 64 bytes.
132 #
133 # After you create a Waiter resource, you cannot change the resource name.
134 "success": { # The condition that a Waiter resource is waiting for. # [Required] The success condition. If this condition is met, `done` will be
135 # set to `true` and the `error` value will remain unset. The failure condition
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]136 # takes precedence over the success condition. If both conditions are met, a
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]137 # failure will be indicated.
138 "cardinality": { # A Cardinality condition for the Waiter resource. A cardinality condition is # The cardinality of the `EndCondition`.
139 # met when the number of variables under a specified path prefix reaches a
140 # predefined number. For example, if you set a Cardinality condition where
141 # the `path` is set to `/foo` and the number of paths is set to 2, the
142 # following variables would meet the condition in a RuntimeConfig resource:
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]143 #
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]144 # + `/foo/variable1 = "value1"`
145 # + `/foo/variable2 = "value2"`
146 # + `/bar/variable3 = "value3"`
147 #
148 # It would not would not satisify the same condition with the `number` set to
149 # 3, however, because there is only 2 paths that start with `/foo`.
150 # Cardinality conditions are recursive; all subtrees under the specific
151 # path prefix are counted.
152 "path": "A String", # The root of the variable subtree to monitor. For example, `/foo`.
153 "number": 42, # The number variables under the `path` that must exist to meet this
154 # condition. Defaults to 1 if not specified.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]155 },
156 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]157 "failure": { # The condition that a Waiter resource is waiting for. # [Optional] The failure condition of this waiter. If this condition is met,
158 # `done` will be set to `true` and the `error` code will be set to `ABORTED`.
159 # The failure condition takes precedence over the success condition. If both
160 # conditions are met, a failure will be indicated. This value is optional; if
161 # no failure condition is set, the only failure scenario will be a timeout.
162 "cardinality": { # A Cardinality condition for the Waiter resource. A cardinality condition is # The cardinality of the `EndCondition`.
163 # met when the number of variables under a specified path prefix reaches a
164 # predefined number. For example, if you set a Cardinality condition where
165 # the `path` is set to `/foo` and the number of paths is set to 2, the
166 # following variables would meet the condition in a RuntimeConfig resource:
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]167 #
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]168 # + `/foo/variable1 = "value1"`
169 # + `/foo/variable2 = "value2"`
170 # + `/bar/variable3 = "value3"`
171 #
172 # It would not would not satisify the same condition with the `number` set to
173 # 3, however, because there is only 2 paths that start with `/foo`.
174 # Cardinality conditions are recursive; all subtrees under the specific
175 # path prefix are counted.
176 "path": "A String", # The root of the variable subtree to monitor. For example, `/foo`.
177 "number": 42, # The number variables under the `path` that must exist to meet this
178 # condition. Defaults to 1 if not specified.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]179 },
180 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]181 "done": True or False, # [Output Only] If the value is `false`, it means the waiter is still waiting
182 # for one of its conditions to be met.
183 #
184 # If true, the waiter has finished. If the waiter finished due to a timeout
185 # or failure, `error` will be set.
186 "timeout": "A String", # [Required] Specifies the timeout of the waiter in seconds, beginning from
187 # the instant that `waiters().create` method is called. If this time elapses
188 # before the success or failure conditions are met, the waiter fails and sets
189 # the `error` code to `DEADLINE_EXCEEDED`.
190 "error": { # The `Status` type defines a logical error model that is suitable for different # [Output Only] If the waiter ended due to a failure or timeout, this value
191 # will be set.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]192 # programming environments, including REST APIs and RPC APIs. It is used by
193 # [gRPC](https://github.com/grpc). The error model is designed to be:
194 #
195 # - Simple to use and understand for most users
196 # - Flexible enough to meet unexpected needs
197 #
198 # # Overview
199 #
200 # The `Status` message contains three pieces of data: error code, error message,
201 # and error details. The error code should be an enum value of
202 # google.rpc.Code, but it may accept additional error codes if needed. The
203 # error message should be a developer-facing English message that helps
204 # developers *understand* and *resolve* the error. If a localized user-facing
205 # error message is needed, put the localized message in the error details or
206 # localize it in the client. The optional error details may contain arbitrary
207 # information about the error. There is a predefined set of error detail types
208 # in the package `google.rpc` which can be used for common error conditions.
209 #
210 # # Language mapping
211 #
212 # The `Status` message is the logical representation of the error model, but it
213 # is not necessarily the actual wire format. When the `Status` message is
214 # exposed in different client libraries and different wire protocols, it can be
215 # mapped differently. For example, it will likely be mapped to some exceptions
216 # in Java, but more likely mapped to some error codes in C.
217 #
218 # # Other uses
219 #
220 # The error model and the `Status` message can be used in a variety of
221 # environments, either with or without APIs, to provide a
222 # consistent developer experience across different environments.
223 #
224 # Example uses of this error model include:
225 #
226 # - Partial errors. If a service needs to return partial errors to the client,
227 # it may embed the `Status` in the normal response to indicate the partial
228 # errors.
229 #
230 # - Workflow errors. A typical workflow has multiple steps. Each step may
231 # have a `Status` message for error reporting purpose.
232 #
233 # - Batch operations. If a client uses batch request and batch response, the
234 # `Status` message should be used directly inside batch response, one for
235 # each error sub-response.
236 #
237 # - Asynchronous operations. If an API call embeds asynchronous operation
238 # results in its response, the status of those operations should be
239 # represented directly using the `Status` message.
240 #
241 # - Logging. If some API errors are stored in logs, the message `Status` could
242 # be used directly after any stripping needed for security/privacy reasons.
243 "message": "A String", # A developer-facing error message, which should be in English. Any
244 # user-facing error message should be localized and sent in the
245 # google.rpc.Status.details field, or localized by the client.
246 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
247 "details": [ # A list of messages that carry the error details. There will be a
248 # common set of message types for APIs to use.
249 {
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]250 "a_key": "", # Properties of the object. Contains field @type with type URL.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]251 },
252 ],
253 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]254 "createTime": "A String", # [Output Only] The instant at which this Waiter resource was created. Adding
255 # the value of `timeout` to this instant yields the timeout deadline for the
256 # waiter.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]257 }
258
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame^]259 requestId: string, An optional unique request_id. If server receives two Create requests with
260the same request_id then second request will be ignored and information
261stored in the backend will be returned. Empty request_id fields are
262ignored.
263It is responsibility of the client to ensure uniqueness of the request_id
264strings.
265The strings are limited to 64 characters.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]266 x__xgafv: string, V1 error format.
267 Allowed values
268 1 - v1 error format
269 2 - v2 error format
270
271Returns:
272 An object of the form:
273
274 { # This resource represents a long-running operation that is the result of a
275 # network API call.
276 "metadata": { # Service-specific metadata associated with the operation. It typically
277 # contains progress information and common metadata such as create time.
278 # Some services might not provide such metadata. Any method that returns a
279 # long-running operation should document the metadata type, if any.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]280 "a_key": "", # Properties of the object. Contains field @type with type URL.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]281 },
282 "done": True or False, # If the value is `false`, it means the operation is still in progress.
283 # If true, the operation is completed, and either `error` or `response` is
284 # available.
285 "response": { # The normal response of the operation in case of success. If the original
286 # method returns no data on success, such as `Delete`, the response is
287 # `google.protobuf.Empty`. If the original method is standard
288 # `Get`/`Create`/`Update`, the response should be the resource. For other
289 # methods, the response should have the type `XxxResponse`, where `Xxx`
290 # is the original method name. For example, if the original method name
291 # is `TakeSnapshot()`, the inferred response type is
292 # `TakeSnapshotResponse`.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]293 "a_key": "", # Properties of the object. Contains field @type with type URL.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]294 },
295 "name": "A String", # The server-assigned name, which is only unique within the same service that
296 # originally returns it. If you use the default HTTP mapping, the
297 # `name` should have the format of `operations/some/unique/name`.
298 "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure.
299 # programming environments, including REST APIs and RPC APIs. It is used by
300 # [gRPC](https://github.com/grpc). The error model is designed to be:
301 #
302 # - Simple to use and understand for most users
303 # - Flexible enough to meet unexpected needs
304 #
305 # # Overview
306 #
307 # The `Status` message contains three pieces of data: error code, error message,
308 # and error details. The error code should be an enum value of
309 # google.rpc.Code, but it may accept additional error codes if needed. The
310 # error message should be a developer-facing English message that helps
311 # developers *understand* and *resolve* the error. If a localized user-facing
312 # error message is needed, put the localized message in the error details or
313 # localize it in the client. The optional error details may contain arbitrary
314 # information about the error. There is a predefined set of error detail types
315 # in the package `google.rpc` which can be used for common error conditions.
316 #
317 # # Language mapping
318 #
319 # The `Status` message is the logical representation of the error model, but it
320 # is not necessarily the actual wire format. When the `Status` message is
321 # exposed in different client libraries and different wire protocols, it can be
322 # mapped differently. For example, it will likely be mapped to some exceptions
323 # in Java, but more likely mapped to some error codes in C.
324 #
325 # # Other uses
326 #
327 # The error model and the `Status` message can be used in a variety of
328 # environments, either with or without APIs, to provide a
329 # consistent developer experience across different environments.
330 #
331 # Example uses of this error model include:
332 #
333 # - Partial errors. If a service needs to return partial errors to the client,
334 # it may embed the `Status` in the normal response to indicate the partial
335 # errors.
336 #
337 # - Workflow errors. A typical workflow has multiple steps. Each step may
338 # have a `Status` message for error reporting purpose.
339 #
340 # - Batch operations. If a client uses batch request and batch response, the
341 # `Status` message should be used directly inside batch response, one for
342 # each error sub-response.
343 #
344 # - Asynchronous operations. If an API call embeds asynchronous operation
345 # results in its response, the status of those operations should be
346 # represented directly using the `Status` message.
347 #
348 # - Logging. If some API errors are stored in logs, the message `Status` could
349 # be used directly after any stripping needed for security/privacy reasons.
350 "message": "A String", # A developer-facing error message, which should be in English. Any
351 # user-facing error message should be localized and sent in the
352 # google.rpc.Status.details field, or localized by the client.
353 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
354 "details": [ # A list of messages that carry the error details. There will be a
355 # common set of message types for APIs to use.
356 {
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]357 "a_key": "", # Properties of the object. Contains field @type with type URL.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]358 },
359 ],
360 },
361 }</pre>
362</div>
363
364<div class="method">
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]365 <code class="details" id="delete">delete(name=None, x__xgafv=None)</code>
366 <pre>Deletes the waiter with the specified name.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]367
368Args:
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]369 name: string, The Waiter resource to delete, in the format:
370
371 `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]` (required)
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]372 x__xgafv: string, V1 error format.
373 Allowed values
374 1 - v1 error format
375 2 - v2 error format
376
377Returns:
378 An object of the form:
379
380 { # A generic empty message that you can re-use to avoid defining duplicated
381 # empty messages in your APIs. A typical example is to use it as the request
382 # or the response type of an API method. For instance:
383 #
384 # service Foo {
385 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
386 # }
387 #
388 # The JSON representation for `Empty` is empty JSON object `{}`.
389 }</pre>
390</div>
391
392<div class="method">
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]393 <code class="details" id="get">get(name=None, x__xgafv=None)</code>
394 <pre>Gets information about a single waiter.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]395
396Args:
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]397 name: string, The fully-qualified name of the Waiter resource object to retrieve, in the
398format:
399
400`projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]` (required)
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]401 x__xgafv: string, V1 error format.
402 Allowed values
403 1 - v1 error format
404 2 - v2 error format
405
406Returns:
407 An object of the form:
408
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]409 { # A Waiter resource waits for some end condition within a RuntimeConfig resource
410 # to be met before it returns. For example, assume you have a distributed
411 # system where each node writes to a Variable resource indidicating the node's
412 # readiness as part of the startup process.
413 #
414 # You then configure a Waiter resource with the success condition set to wait
415 # until some number of nodes have checked in. Afterwards, your application
416 # runs some arbitrary code after the condition has been met and the waiter
417 # returns successfully.
418 #
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]419 # Once created, a Waiter resource is immutable.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]420 #
421 # To learn more about using waiters, read the
422 # [Creating a Waiter](/deployment-manager/runtime-configurator/creating-a-waiter)
423 # documentation.
424 "name": "A String", # The name of the Waiter resource, in the format:
425 #
426 # projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]
427 #
428 # The `[PROJECT_ID]` must be a valid Google Cloud project ID,
429 # the `[CONFIG_NAME]` must be a valid RuntimeConfig resource, the
430 # `[WAITER_NAME]` must match RFC 1035 segment specification, and the length
431 # of `[WAITER_NAME]` must be less than 64 bytes.
432 #
433 # After you create a Waiter resource, you cannot change the resource name.
434 "success": { # The condition that a Waiter resource is waiting for. # [Required] The success condition. If this condition is met, `done` will be
435 # set to `true` and the `error` value will remain unset. The failure condition
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]436 # takes precedence over the success condition. If both conditions are met, a
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]437 # failure will be indicated.
438 "cardinality": { # A Cardinality condition for the Waiter resource. A cardinality condition is # The cardinality of the `EndCondition`.
439 # met when the number of variables under a specified path prefix reaches a
440 # predefined number. For example, if you set a Cardinality condition where
441 # the `path` is set to `/foo` and the number of paths is set to 2, the
442 # following variables would meet the condition in a RuntimeConfig resource:
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]443 #
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]444 # + `/foo/variable1 = "value1"`
445 # + `/foo/variable2 = "value2"`
446 # + `/bar/variable3 = "value3"`
447 #
448 # It would not would not satisify the same condition with the `number` set to
449 # 3, however, because there is only 2 paths that start with `/foo`.
450 # Cardinality conditions are recursive; all subtrees under the specific
451 # path prefix are counted.
452 "path": "A String", # The root of the variable subtree to monitor. For example, `/foo`.
453 "number": 42, # The number variables under the `path` that must exist to meet this
454 # condition. Defaults to 1 if not specified.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]455 },
456 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]457 "failure": { # The condition that a Waiter resource is waiting for. # [Optional] The failure condition of this waiter. If this condition is met,
458 # `done` will be set to `true` and the `error` code will be set to `ABORTED`.
459 # The failure condition takes precedence over the success condition. If both
460 # conditions are met, a failure will be indicated. This value is optional; if
461 # no failure condition is set, the only failure scenario will be a timeout.
462 "cardinality": { # A Cardinality condition for the Waiter resource. A cardinality condition is # The cardinality of the `EndCondition`.
463 # met when the number of variables under a specified path prefix reaches a
464 # predefined number. For example, if you set a Cardinality condition where
465 # the `path` is set to `/foo` and the number of paths is set to 2, the
466 # following variables would meet the condition in a RuntimeConfig resource:
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]467 #
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]468 # + `/foo/variable1 = "value1"`
469 # + `/foo/variable2 = "value2"`
470 # + `/bar/variable3 = "value3"`
471 #
472 # It would not would not satisify the same condition with the `number` set to
473 # 3, however, because there is only 2 paths that start with `/foo`.
474 # Cardinality conditions are recursive; all subtrees under the specific
475 # path prefix are counted.
476 "path": "A String", # The root of the variable subtree to monitor. For example, `/foo`.
477 "number": 42, # The number variables under the `path` that must exist to meet this
478 # condition. Defaults to 1 if not specified.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]479 },
480 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]481 "done": True or False, # [Output Only] If the value is `false`, it means the waiter is still waiting
482 # for one of its conditions to be met.
483 #
484 # If true, the waiter has finished. If the waiter finished due to a timeout
485 # or failure, `error` will be set.
486 "timeout": "A String", # [Required] Specifies the timeout of the waiter in seconds, beginning from
487 # the instant that `waiters().create` method is called. If this time elapses
488 # before the success or failure conditions are met, the waiter fails and sets
489 # the `error` code to `DEADLINE_EXCEEDED`.
490 "error": { # The `Status` type defines a logical error model that is suitable for different # [Output Only] If the waiter ended due to a failure or timeout, this value
491 # will be set.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]492 # programming environments, including REST APIs and RPC APIs. It is used by
493 # [gRPC](https://github.com/grpc). The error model is designed to be:
494 #
495 # - Simple to use and understand for most users
496 # - Flexible enough to meet unexpected needs
497 #
498 # # Overview
499 #
500 # The `Status` message contains three pieces of data: error code, error message,
501 # and error details. The error code should be an enum value of
502 # google.rpc.Code, but it may accept additional error codes if needed. The
503 # error message should be a developer-facing English message that helps
504 # developers *understand* and *resolve* the error. If a localized user-facing
505 # error message is needed, put the localized message in the error details or
506 # localize it in the client. The optional error details may contain arbitrary
507 # information about the error. There is a predefined set of error detail types
508 # in the package `google.rpc` which can be used for common error conditions.
509 #
510 # # Language mapping
511 #
512 # The `Status` message is the logical representation of the error model, but it
513 # is not necessarily the actual wire format. When the `Status` message is
514 # exposed in different client libraries and different wire protocols, it can be
515 # mapped differently. For example, it will likely be mapped to some exceptions
516 # in Java, but more likely mapped to some error codes in C.
517 #
518 # # Other uses
519 #
520 # The error model and the `Status` message can be used in a variety of
521 # environments, either with or without APIs, to provide a
522 # consistent developer experience across different environments.
523 #
524 # Example uses of this error model include:
525 #
526 # - Partial errors. If a service needs to return partial errors to the client,
527 # it may embed the `Status` in the normal response to indicate the partial
528 # errors.
529 #
530 # - Workflow errors. A typical workflow has multiple steps. Each step may
531 # have a `Status` message for error reporting purpose.
532 #
533 # - Batch operations. If a client uses batch request and batch response, the
534 # `Status` message should be used directly inside batch response, one for
535 # each error sub-response.
536 #
537 # - Asynchronous operations. If an API call embeds asynchronous operation
538 # results in its response, the status of those operations should be
539 # represented directly using the `Status` message.
540 #
541 # - Logging. If some API errors are stored in logs, the message `Status` could
542 # be used directly after any stripping needed for security/privacy reasons.
543 "message": "A String", # A developer-facing error message, which should be in English. Any
544 # user-facing error message should be localized and sent in the
545 # google.rpc.Status.details field, or localized by the client.
546 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
547 "details": [ # A list of messages that carry the error details. There will be a
548 # common set of message types for APIs to use.
549 {
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]550 "a_key": "", # Properties of the object. Contains field @type with type URL.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]551 },
552 ],
553 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]554 "createTime": "A String", # [Output Only] The instant at which this Waiter resource was created. Adding
555 # the value of `timeout` to this instant yields the timeout deadline for the
556 # waiter.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]557 }</pre>
558</div>
559
560<div class="method">
561 <code class="details" id="list">list(parent=None, pageToken=None, x__xgafv=None, pageSize=None)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]562 <pre>List waiters within the given configuration.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]563
564Args:
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]565 parent: string, The path to the configuration for which you want to get a list of waiters.
566The configuration must exist beforehand; the path must by in the format:
567
568`projects/[PROJECT_ID]/configs/[CONFIG_NAME]` (required)
569 pageToken: string, Specifies a page token to use. Set `pageToken` to a `nextPageToken`
570returned by a previous list request to get the next page of results.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]571 x__xgafv: string, V1 error format.
572 Allowed values
573 1 - v1 error format
574 2 - v2 error format
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]575 pageSize: integer, Specifies the number of results to return per page. If there are fewer
576elements than the specified number, returns all elements.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]577
578Returns:
579 An object of the form:
580
581 { # Response for the `ListWaiters()` method.
582 # Order of returned waiter objects is arbitrary.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]583 "nextPageToken": "A String", # This token allows you to get the next page of results for list requests.
584 # If the number of results is larger than `pageSize`, use the `nextPageToken`
585 # as a value for the query parameter `pageToken` in the next list request.
586 # Subsequent list requests will have their own `nextPageToken` to continue
587 # paging through the results
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]588 "waiters": [ # Found waiters in the project.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]589 { # A Waiter resource waits for some end condition within a RuntimeConfig resource
590 # to be met before it returns. For example, assume you have a distributed
591 # system where each node writes to a Variable resource indidicating the node's
592 # readiness as part of the startup process.
593 #
594 # You then configure a Waiter resource with the success condition set to wait
595 # until some number of nodes have checked in. Afterwards, your application
596 # runs some arbitrary code after the condition has been met and the waiter
597 # returns successfully.
598 #
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]599 # Once created, a Waiter resource is immutable.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]600 #
601 # To learn more about using waiters, read the
602 # [Creating a Waiter](/deployment-manager/runtime-configurator/creating-a-waiter)
603 # documentation.
604 "name": "A String", # The name of the Waiter resource, in the format:
605 #
606 # projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]
607 #
608 # The `[PROJECT_ID]` must be a valid Google Cloud project ID,
609 # the `[CONFIG_NAME]` must be a valid RuntimeConfig resource, the
610 # `[WAITER_NAME]` must match RFC 1035 segment specification, and the length
611 # of `[WAITER_NAME]` must be less than 64 bytes.
612 #
613 # After you create a Waiter resource, you cannot change the resource name.
614 "success": { # The condition that a Waiter resource is waiting for. # [Required] The success condition. If this condition is met, `done` will be
615 # set to `true` and the `error` value will remain unset. The failure condition
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]616 # takes precedence over the success condition. If both conditions are met, a
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]617 # failure will be indicated.
618 "cardinality": { # A Cardinality condition for the Waiter resource. A cardinality condition is # The cardinality of the `EndCondition`.
619 # met when the number of variables under a specified path prefix reaches a
620 # predefined number. For example, if you set a Cardinality condition where
621 # the `path` is set to `/foo` and the number of paths is set to 2, the
622 # following variables would meet the condition in a RuntimeConfig resource:
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]623 #
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]624 # + `/foo/variable1 = "value1"`
625 # + `/foo/variable2 = "value2"`
626 # + `/bar/variable3 = "value3"`
627 #
628 # It would not would not satisify the same condition with the `number` set to
629 # 3, however, because there is only 2 paths that start with `/foo`.
630 # Cardinality conditions are recursive; all subtrees under the specific
631 # path prefix are counted.
632 "path": "A String", # The root of the variable subtree to monitor. For example, `/foo`.
633 "number": 42, # The number variables under the `path` that must exist to meet this
634 # condition. Defaults to 1 if not specified.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]635 },
636 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]637 "failure": { # The condition that a Waiter resource is waiting for. # [Optional] The failure condition of this waiter. If this condition is met,
638 # `done` will be set to `true` and the `error` code will be set to `ABORTED`.
639 # The failure condition takes precedence over the success condition. If both
640 # conditions are met, a failure will be indicated. This value is optional; if
641 # no failure condition is set, the only failure scenario will be a timeout.
642 "cardinality": { # A Cardinality condition for the Waiter resource. A cardinality condition is # The cardinality of the `EndCondition`.
643 # met when the number of variables under a specified path prefix reaches a
644 # predefined number. For example, if you set a Cardinality condition where
645 # the `path` is set to `/foo` and the number of paths is set to 2, the
646 # following variables would meet the condition in a RuntimeConfig resource:
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]647 #
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]648 # + `/foo/variable1 = "value1"`
649 # + `/foo/variable2 = "value2"`
650 # + `/bar/variable3 = "value3"`
651 #
652 # It would not would not satisify the same condition with the `number` set to
653 # 3, however, because there is only 2 paths that start with `/foo`.
654 # Cardinality conditions are recursive; all subtrees under the specific
655 # path prefix are counted.
656 "path": "A String", # The root of the variable subtree to monitor. For example, `/foo`.
657 "number": 42, # The number variables under the `path` that must exist to meet this
658 # condition. Defaults to 1 if not specified.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]659 },
660 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]661 "done": True or False, # [Output Only] If the value is `false`, it means the waiter is still waiting
662 # for one of its conditions to be met.
663 #
664 # If true, the waiter has finished. If the waiter finished due to a timeout
665 # or failure, `error` will be set.
666 "timeout": "A String", # [Required] Specifies the timeout of the waiter in seconds, beginning from
667 # the instant that `waiters().create` method is called. If this time elapses
668 # before the success or failure conditions are met, the waiter fails and sets
669 # the `error` code to `DEADLINE_EXCEEDED`.
670 "error": { # The `Status` type defines a logical error model that is suitable for different # [Output Only] If the waiter ended due to a failure or timeout, this value
671 # will be set.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]672 # programming environments, including REST APIs and RPC APIs. It is used by
673 # [gRPC](https://github.com/grpc). The error model is designed to be:
674 #
675 # - Simple to use and understand for most users
676 # - Flexible enough to meet unexpected needs
677 #
678 # # Overview
679 #
680 # The `Status` message contains three pieces of data: error code, error message,
681 # and error details. The error code should be an enum value of
682 # google.rpc.Code, but it may accept additional error codes if needed. The
683 # error message should be a developer-facing English message that helps
684 # developers *understand* and *resolve* the error. If a localized user-facing
685 # error message is needed, put the localized message in the error details or
686 # localize it in the client. The optional error details may contain arbitrary
687 # information about the error. There is a predefined set of error detail types
688 # in the package `google.rpc` which can be used for common error conditions.
689 #
690 # # Language mapping
691 #
692 # The `Status` message is the logical representation of the error model, but it
693 # is not necessarily the actual wire format. When the `Status` message is
694 # exposed in different client libraries and different wire protocols, it can be
695 # mapped differently. For example, it will likely be mapped to some exceptions
696 # in Java, but more likely mapped to some error codes in C.
697 #
698 # # Other uses
699 #
700 # The error model and the `Status` message can be used in a variety of
701 # environments, either with or without APIs, to provide a
702 # consistent developer experience across different environments.
703 #
704 # Example uses of this error model include:
705 #
706 # - Partial errors. If a service needs to return partial errors to the client,
707 # it may embed the `Status` in the normal response to indicate the partial
708 # errors.
709 #
710 # - Workflow errors. A typical workflow has multiple steps. Each step may
711 # have a `Status` message for error reporting purpose.
712 #
713 # - Batch operations. If a client uses batch request and batch response, the
714 # `Status` message should be used directly inside batch response, one for
715 # each error sub-response.
716 #
717 # - Asynchronous operations. If an API call embeds asynchronous operation
718 # results in its response, the status of those operations should be
719 # represented directly using the `Status` message.
720 #
721 # - Logging. If some API errors are stored in logs, the message `Status` could
722 # be used directly after any stripping needed for security/privacy reasons.
723 "message": "A String", # A developer-facing error message, which should be in English. Any
724 # user-facing error message should be localized and sent in the
725 # google.rpc.Status.details field, or localized by the client.
726 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
727 "details": [ # A list of messages that carry the error details. There will be a
728 # common set of message types for APIs to use.
729 {
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]730 "a_key": "", # Properties of the object. Contains field @type with type URL.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]731 },
732 ],
733 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]734 "createTime": "A String", # [Output Only] The instant at which this Waiter resource was created. Adding
735 # the value of `timeout` to this instant yields the timeout deadline for the
736 # waiter.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]737 },
738 ],
739 }</pre>
740</div>
741
742<div class="method">
743 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
744 <pre>Retrieves the next page of results.
745
746Args:
747 previous_request: The request for the previous page. (required)
748 previous_response: The response from the request for the previous page. (required)
749
750Returns:
751 A request object that you can call 'execute()' on to request the next
752 page. Returns None if there are no more items in the collection.
753 </pre>
754</div>
755
756</body></html>