Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / d059ad881c7ae58c67931c48788d0bd7343ab16c / . / docs / dyn / runtimeconfig_v1beta1.projects.configs.waiters.html
blob: f14f7b666d2872bf9a6c14dd0d79cde77beb65d0 [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
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]75<h1><a href="runtimeconfig_v1beta1.html">Cloud Runtime Configuration 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>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]78 <code><a href="#create">create(parent, body=None, 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">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]81 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]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">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]84 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]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">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]87 <code><a href="#list">list(parent, pageToken=None, pageSize=None, x__xgafv=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>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]92<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]93 <code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]94<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]95<h3>Method Details</h3>
96<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]97 <code class="details" id="create">create(parent, body=None, requestId=None, x__xgafv=None)</code>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]98 <pre>Creates a Waiter resource. This operation returns a long-running Operation
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]99resource which can be polled for completion. However, a waiter with the
100given name will exist (and can be retrieved) prior to the operation
101completing. If the operation fails, the failed Waiter resource will
102still exist and must be deleted prior to subsequent creation attempts.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]103
104Args:
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]105 parent: string, The path to the configuration that will own the waiter.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]106The configuration must exist beforehand; the path must be in the format:
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]107
108`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]109 body: object, The request body.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]110 The object takes the form of:
111
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]112{ # A Waiter resource waits for some end condition within a RuntimeConfig
113 # resource to be met before it returns. For example, assume you have a
114 # distributed system where each node writes to a Variable resource indicating
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]115 # the node&#x27;s readiness as part of the startup process.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]116 #
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]117 # You then configure a Waiter resource with the success condition set to wait
118 # until some number of nodes have checked in. Afterwards, your application
119 # runs some arbitrary code after the condition has been met and the waiter
120 # returns successfully.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]121 #
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]122 # Once created, a Waiter resource is immutable.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]123 #
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]124 # To learn more about using waiters, read the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]125 # [Creating a
126 # Waiter](/deployment-manager/runtime-configurator/creating-a-waiter)
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]127 # documentation.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]128 &quot;name&quot;: &quot;A String&quot;, # The name of the Waiter resource, in the format:
129 #
130 # projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]
131 #
132 # The `[PROJECT_ID]` must be a valid Google Cloud project ID,
133 # the `[CONFIG_NAME]` must be a valid RuntimeConfig resource, the
134 # `[WAITER_NAME]` must match RFC 1035 segment specification, and the length
135 # of `[WAITER_NAME]` must be less than 64 bytes.
136 #
137 # After you create a Waiter resource, you cannot change the resource name.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]138 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # Output only. If the waiter ended due to a failure or timeout, this value
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]139 # will be set.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]140 # different programming environments, including REST APIs and RPC APIs. It is
141 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
142 # three pieces of data: error code, error message, and error details.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]143 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]144 # You can find out more about this error model and how to work with it in the
145 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]146 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
147 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
148 # user-facing error message should be localized and sent in the
149 # google.rpc.Status.details field, or localized by the client.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]150 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]151 # message types for APIs to use.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]152 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]153 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]154 },
155 ],
156 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]157 &quot;done&quot;: True or False, # Output only. If the value is `false`, it means the waiter is still waiting
158 # for one of its conditions to be met.
159 #
160 # If true, the waiter has finished. If the waiter finished due to a timeout
161 # or failure, `error` will be set.
162 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The instant at which this Waiter resource was created. Adding
163 # the value of `timeout` to this instant yields the timeout deadline for the
164 # waiter.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]165 &quot;failure&quot;: { # The condition that a Waiter resource is waiting for. # [Optional] The failure condition of this waiter. If this condition is met,
166 # `done` will be set to `true` and the `error` code will be set to `ABORTED`.
167 # The failure condition takes precedence over the success condition. If both
168 # conditions are met, a failure will be indicated. This value is optional; if
169 # no failure condition is set, the only failure scenario will be a timeout.
170 &quot;cardinality&quot;: { # A Cardinality condition for the Waiter resource. A cardinality condition is # The cardinality of the `EndCondition`.
171 # met when the number of variables under a specified path prefix reaches a
172 # predefined number. For example, if you set a Cardinality condition where
173 # the `path` is set to `/foo` and the number of paths is set to `2`, the
174 # following variables would meet the condition in a RuntimeConfig resource:
175 #
176 # + `/foo/variable1 = &quot;value1&quot;`
177 # + `/foo/variable2 = &quot;value2&quot;`
178 # + `/bar/variable3 = &quot;value3&quot;`
179 #
180 # It would not satisfy the same condition with the `number` set to
181 # `3`, however, because there is only 2 paths that start with `/foo`.
182 # Cardinality conditions are recursive; all subtrees under the specific
183 # path prefix are counted.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]184 &quot;number&quot;: 42, # The number variables under the `path` that must exist to meet this
185 # condition. Defaults to 1 if not specified.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]186 &quot;path&quot;: &quot;A String&quot;, # The root of the variable subtree to monitor. For example, `/foo`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]187 },
188 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]189 &quot;timeout&quot;: &quot;A String&quot;, # [Required] Specifies the timeout of the waiter in seconds, beginning from
190 # the instant that `waiters().create` method is called. If this time elapses
191 # before the success or failure conditions are met, the waiter fails and sets
192 # the `error` code to `DEADLINE_EXCEEDED`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]193 &quot;success&quot;: { # The condition that a Waiter resource is waiting for. # [Required] The success condition. If this condition is met, `done` will be
194 # set to `true` and the `error` value will remain unset. The failure
195 # condition takes precedence over the success condition. If both conditions
196 # are met, a failure will be indicated.
197 &quot;cardinality&quot;: { # A Cardinality condition for the Waiter resource. A cardinality condition is # The cardinality of the `EndCondition`.
198 # met when the number of variables under a specified path prefix reaches a
199 # predefined number. For example, if you set a Cardinality condition where
200 # the `path` is set to `/foo` and the number of paths is set to `2`, the
201 # following variables would meet the condition in a RuntimeConfig resource:
202 #
203 # + `/foo/variable1 = &quot;value1&quot;`
204 # + `/foo/variable2 = &quot;value2&quot;`
205 # + `/bar/variable3 = &quot;value3&quot;`
206 #
207 # It would not satisfy the same condition with the `number` set to
208 # `3`, however, because there is only 2 paths that start with `/foo`.
209 # Cardinality conditions are recursive; all subtrees under the specific
210 # path prefix are counted.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]211 &quot;number&quot;: 42, # The number variables under the `path` that must exist to meet this
212 # condition. Defaults to 1 if not specified.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]213 &quot;path&quot;: &quot;A String&quot;, # The root of the variable subtree to monitor. For example, `/foo`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]214 },
215 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]216 }
217
218 requestId: string, An optional but recommended unique `request_id`. If the server
219receives two `create()` requests with the same
220`request_id`, then the second request will be ignored and the
221first resource created and stored in the backend is returned.
222Empty `request_id` fields are ignored.
223
224It is responsibility of the client to ensure uniqueness of the
225`request_id` strings.
226
227`request_id` strings are limited to 64 characters.
228 x__xgafv: string, V1 error format.
229 Allowed values
230 1 - v1 error format
231 2 - v2 error format
232
233Returns:
234 An object of the form:
235
236 { # This resource represents a long-running operation that is the result of a
237 # network API call.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]238 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
239 # If `true`, the operation is completed, and either `error` or `response` is
240 # available.
241 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
242 # originally returns it. If you use the default HTTP mapping, the
243 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]244 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
245 # contains progress information and common metadata such as create time.
246 # Some services might not provide such metadata. Any method that returns a
247 # long-running operation should document the metadata type, if any.
248 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
249 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]250 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
251 # method returns no data on success, such as `Delete`, the response is
252 # `google.protobuf.Empty`. If the original method is standard
253 # `Get`/`Create`/`Update`, the response should be the resource. For other
254 # methods, the response should have the type `XxxResponse`, where `Xxx`
255 # is the original method name. For example, if the original method name
256 # is `TakeSnapshot()`, the inferred response type is
257 # `TakeSnapshotResponse`.
258 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
259 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]260 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
261 # different programming environments, including REST APIs and RPC APIs. It is
262 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
263 # three pieces of data: error code, error message, and error details.
264 #
265 # You can find out more about this error model and how to work with it in the
266 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]267 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
268 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
269 # user-facing error message should be localized and sent in the
270 # google.rpc.Status.details field, or localized by the client.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]271 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
272 # message types for APIs to use.
273 {
274 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
275 },
276 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]277 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]278 }</pre>
279</div>
280
281<div class="method">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]282 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
283 <pre>Deletes the waiter with the specified name.
284
285Args:
286 name: string, The Waiter resource to delete, in the format:
287
288 `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]` (required)
289 x__xgafv: string, V1 error format.
290 Allowed values
291 1 - v1 error format
292 2 - v2 error format
293
294Returns:
295 An object of the form:
296
297 { # A generic empty message that you can re-use to avoid defining duplicated
298 # empty messages in your APIs. A typical example is to use it as the request
299 # or the response type of an API method. For instance:
300 #
301 # service Foo {
302 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
303 # }
304 #
305 # The JSON representation for `Empty` is empty JSON object `{}`.
306 }</pre>
307</div>
308
309<div class="method">
310 <code class="details" id="get">get(name, x__xgafv=None)</code>
311 <pre>Gets information about a single waiter.
312
313Args:
314 name: string, The fully-qualified name of the Waiter resource object to retrieve, in the
315format:
316
317`projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]` (required)
318 x__xgafv: string, V1 error format.
319 Allowed values
320 1 - v1 error format
321 2 - v2 error format
322
323Returns:
324 An object of the form:
325
326 { # A Waiter resource waits for some end condition within a RuntimeConfig
327 # resource to be met before it returns. For example, assume you have a
328 # distributed system where each node writes to a Variable resource indicating
329 # the node&#x27;s readiness as part of the startup process.
330 #
331 # You then configure a Waiter resource with the success condition set to wait
332 # until some number of nodes have checked in. Afterwards, your application
333 # runs some arbitrary code after the condition has been met and the waiter
334 # returns successfully.
335 #
336 # Once created, a Waiter resource is immutable.
337 #
338 # To learn more about using waiters, read the
339 # [Creating a
340 # Waiter](/deployment-manager/runtime-configurator/creating-a-waiter)
341 # documentation.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]342 &quot;name&quot;: &quot;A String&quot;, # The name of the Waiter resource, in the format:
343 #
344 # projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]
345 #
346 # The `[PROJECT_ID]` must be a valid Google Cloud project ID,
347 # the `[CONFIG_NAME]` must be a valid RuntimeConfig resource, the
348 # `[WAITER_NAME]` must match RFC 1035 segment specification, and the length
349 # of `[WAITER_NAME]` must be less than 64 bytes.
350 #
351 # After you create a Waiter resource, you cannot change the resource name.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]352 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # Output only. If the waiter ended due to a failure or timeout, this value
353 # will be set.
354 # different programming environments, including REST APIs and RPC APIs. It is
355 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
356 # three pieces of data: error code, error message, and error details.
357 #
358 # You can find out more about this error model and how to work with it in the
359 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]360 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
361 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
362 # user-facing error message should be localized and sent in the
363 # google.rpc.Status.details field, or localized by the client.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]364 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
365 # message types for APIs to use.
366 {
367 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
368 },
369 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]370 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]371 &quot;done&quot;: True or False, # Output only. If the value is `false`, it means the waiter is still waiting
372 # for one of its conditions to be met.
373 #
374 # If true, the waiter has finished. If the waiter finished due to a timeout
375 # or failure, `error` will be set.
376 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The instant at which this Waiter resource was created. Adding
377 # the value of `timeout` to this instant yields the timeout deadline for the
378 # waiter.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]379 &quot;failure&quot;: { # The condition that a Waiter resource is waiting for. # [Optional] The failure condition of this waiter. If this condition is met,
380 # `done` will be set to `true` and the `error` code will be set to `ABORTED`.
381 # The failure condition takes precedence over the success condition. If both
382 # conditions are met, a failure will be indicated. This value is optional; if
383 # no failure condition is set, the only failure scenario will be a timeout.
384 &quot;cardinality&quot;: { # A Cardinality condition for the Waiter resource. A cardinality condition is # The cardinality of the `EndCondition`.
385 # met when the number of variables under a specified path prefix reaches a
386 # predefined number. For example, if you set a Cardinality condition where
387 # the `path` is set to `/foo` and the number of paths is set to `2`, the
388 # following variables would meet the condition in a RuntimeConfig resource:
389 #
390 # + `/foo/variable1 = &quot;value1&quot;`
391 # + `/foo/variable2 = &quot;value2&quot;`
392 # + `/bar/variable3 = &quot;value3&quot;`
393 #
394 # It would not satisfy the same condition with the `number` set to
395 # `3`, however, because there is only 2 paths that start with `/foo`.
396 # Cardinality conditions are recursive; all subtrees under the specific
397 # path prefix are counted.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]398 &quot;number&quot;: 42, # The number variables under the `path` that must exist to meet this
399 # condition. Defaults to 1 if not specified.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]400 &quot;path&quot;: &quot;A String&quot;, # The root of the variable subtree to monitor. For example, `/foo`.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]401 },
402 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]403 &quot;timeout&quot;: &quot;A String&quot;, # [Required] Specifies the timeout of the waiter in seconds, beginning from
404 # the instant that `waiters().create` method is called. If this time elapses
405 # before the success or failure conditions are met, the waiter fails and sets
406 # the `error` code to `DEADLINE_EXCEEDED`.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]407 &quot;success&quot;: { # The condition that a Waiter resource is waiting for. # [Required] The success condition. If this condition is met, `done` will be
408 # set to `true` and the `error` value will remain unset. The failure
409 # condition takes precedence over the success condition. If both conditions
410 # are met, a failure will be indicated.
411 &quot;cardinality&quot;: { # A Cardinality condition for the Waiter resource. A cardinality condition is # The cardinality of the `EndCondition`.
412 # met when the number of variables under a specified path prefix reaches a
413 # predefined number. For example, if you set a Cardinality condition where
414 # the `path` is set to `/foo` and the number of paths is set to `2`, the
415 # following variables would meet the condition in a RuntimeConfig resource:
416 #
417 # + `/foo/variable1 = &quot;value1&quot;`
418 # + `/foo/variable2 = &quot;value2&quot;`
419 # + `/bar/variable3 = &quot;value3&quot;`
420 #
421 # It would not satisfy the same condition with the `number` set to
422 # `3`, however, because there is only 2 paths that start with `/foo`.
423 # Cardinality conditions are recursive; all subtrees under the specific
424 # path prefix are counted.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]425 &quot;number&quot;: 42, # The number variables under the `path` that must exist to meet this
426 # condition. Defaults to 1 if not specified.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]427 &quot;path&quot;: &quot;A String&quot;, # The root of the variable subtree to monitor. For example, `/foo`.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]428 },
429 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]430 }</pre>
431</div>
432
433<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]434 <code class="details" id="list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]435 <pre>List waiters within the given configuration.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]436
437Args:
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]438 parent: string, The path to the configuration for which you want to get a list of waiters.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]439The configuration must exist beforehand; the path must be in the format:
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]440
441`projects/[PROJECT_ID]/configs/[CONFIG_NAME]` (required)
442 pageToken: string, Specifies a page token to use. Set `pageToken` to a `nextPageToken`
443returned by a previous list request to get the next page of results.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]444 pageSize: integer, Specifies the number of results to return per page. If there are fewer
445elements than the specified number, returns all elements.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]446 x__xgafv: string, V1 error format.
447 Allowed values
448 1 - v1 error format
449 2 - v2 error format
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]450
451Returns:
452 An object of the form:
453
454 { # Response for the `ListWaiters()` method.
455 # Order of returned waiter objects is arbitrary.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]456 &quot;waiters&quot;: [ # Found waiters in the project.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]457 { # A Waiter resource waits for some end condition within a RuntimeConfig
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]458 # resource to be met before it returns. For example, assume you have a
459 # distributed system where each node writes to a Variable resource indicating
460 # the node&#x27;s readiness as part of the startup process.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]461 #
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]462 # You then configure a Waiter resource with the success condition set to wait
463 # until some number of nodes have checked in. Afterwards, your application
464 # runs some arbitrary code after the condition has been met and the waiter
465 # returns successfully.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]466 #
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]467 # Once created, a Waiter resource is immutable.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]468 #
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]469 # To learn more about using waiters, read the
470 # [Creating a
471 # Waiter](/deployment-manager/runtime-configurator/creating-a-waiter)
472 # documentation.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]473 &quot;name&quot;: &quot;A String&quot;, # The name of the Waiter resource, in the format:
474 #
475 # projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]
476 #
477 # The `[PROJECT_ID]` must be a valid Google Cloud project ID,
478 # the `[CONFIG_NAME]` must be a valid RuntimeConfig resource, the
479 # `[WAITER_NAME]` must match RFC 1035 segment specification, and the length
480 # of `[WAITER_NAME]` must be less than 64 bytes.
481 #
482 # After you create a Waiter resource, you cannot change the resource name.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]483 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # Output only. If the waiter ended due to a failure or timeout, this value
484 # will be set.
485 # different programming environments, including REST APIs and RPC APIs. It is
486 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
487 # three pieces of data: error code, error message, and error details.
488 #
489 # You can find out more about this error model and how to work with it in the
490 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]491 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
492 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
493 # user-facing error message should be localized and sent in the
494 # google.rpc.Status.details field, or localized by the client.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]495 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
496 # message types for APIs to use.
497 {
498 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
499 },
500 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]501 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]502 &quot;done&quot;: True or False, # Output only. If the value is `false`, it means the waiter is still waiting
503 # for one of its conditions to be met.
504 #
505 # If true, the waiter has finished. If the waiter finished due to a timeout
506 # or failure, `error` will be set.
507 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The instant at which this Waiter resource was created. Adding
508 # the value of `timeout` to this instant yields the timeout deadline for the
509 # waiter.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]510 &quot;failure&quot;: { # The condition that a Waiter resource is waiting for. # [Optional] The failure condition of this waiter. If this condition is met,
511 # `done` will be set to `true` and the `error` code will be set to `ABORTED`.
512 # The failure condition takes precedence over the success condition. If both
513 # conditions are met, a failure will be indicated. This value is optional; if
514 # no failure condition is set, the only failure scenario will be a timeout.
515 &quot;cardinality&quot;: { # A Cardinality condition for the Waiter resource. A cardinality condition is # The cardinality of the `EndCondition`.
516 # met when the number of variables under a specified path prefix reaches a
517 # predefined number. For example, if you set a Cardinality condition where
518 # the `path` is set to `/foo` and the number of paths is set to `2`, the
519 # following variables would meet the condition in a RuntimeConfig resource:
520 #
521 # + `/foo/variable1 = &quot;value1&quot;`
522 # + `/foo/variable2 = &quot;value2&quot;`
523 # + `/bar/variable3 = &quot;value3&quot;`
524 #
525 # It would not satisfy the same condition with the `number` set to
526 # `3`, however, because there is only 2 paths that start with `/foo`.
527 # Cardinality conditions are recursive; all subtrees under the specific
528 # path prefix are counted.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]529 &quot;number&quot;: 42, # The number variables under the `path` that must exist to meet this
530 # condition. Defaults to 1 if not specified.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]531 &quot;path&quot;: &quot;A String&quot;, # The root of the variable subtree to monitor. For example, `/foo`.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]532 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]533 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]534 &quot;timeout&quot;: &quot;A String&quot;, # [Required] Specifies the timeout of the waiter in seconds, beginning from
535 # the instant that `waiters().create` method is called. If this time elapses
536 # before the success or failure conditions are met, the waiter fails and sets
537 # the `error` code to `DEADLINE_EXCEEDED`.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]538 &quot;success&quot;: { # The condition that a Waiter resource is waiting for. # [Required] The success condition. If this condition is met, `done` will be
539 # set to `true` and the `error` value will remain unset. The failure
540 # condition takes precedence over the success condition. If both conditions
541 # are met, a failure will be indicated.
542 &quot;cardinality&quot;: { # A Cardinality condition for the Waiter resource. A cardinality condition is # The cardinality of the `EndCondition`.
543 # met when the number of variables under a specified path prefix reaches a
544 # predefined number. For example, if you set a Cardinality condition where
545 # the `path` is set to `/foo` and the number of paths is set to `2`, the
546 # following variables would meet the condition in a RuntimeConfig resource:
547 #
548 # + `/foo/variable1 = &quot;value1&quot;`
549 # + `/foo/variable2 = &quot;value2&quot;`
550 # + `/bar/variable3 = &quot;value3&quot;`
551 #
552 # It would not satisfy the same condition with the `number` set to
553 # `3`, however, because there is only 2 paths that start with `/foo`.
554 # Cardinality conditions are recursive; all subtrees under the specific
555 # path prefix are counted.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]556 &quot;number&quot;: 42, # The number variables under the `path` that must exist to meet this
557 # condition. Defaults to 1 if not specified.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]558 &quot;path&quot;: &quot;A String&quot;, # The root of the variable subtree to monitor. For example, `/foo`.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]559 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]560 },
561 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]562 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]563 &quot;nextPageToken&quot;: &quot;A String&quot;, # This token allows you to get the next page of results for list requests.
564 # If the number of results is larger than `pageSize`, use the `nextPageToken`
565 # as a value for the query parameter `pageToken` in the next list request.
566 # Subsequent list requests will have their own `nextPageToken` to continue
567 # paging through the results
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]568 }</pre>
569</div>
570
571<div class="method">
572 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
573 <pre>Retrieves the next page of results.
574
575Args:
576 previous_request: The request for the previous page. (required)
577 previous_response: The response from the request for the previous page. (required)
578
579Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]580 A request object that you can call &#x27;execute()&#x27; on to request the next
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]581 page. Returns None if there are no more items in the collection.
582 </pre>
583</div>
584
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]585<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]586 <code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]587 <pre>Returns permissions that a caller has on the specified resource.
588If the resource does not exist, this will return an empty set of
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]589permissions, not a `NOT_FOUND` error.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]590
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]591Note: This operation is designed to be used for building permission-aware
592UIs and command-line tools, not for authorization checking. This operation
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]593may &quot;fail open&quot; without warning.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]594
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]595Args:
596 resource: string, REQUIRED: The resource for which the policy detail is being requested.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]597See the operation documentation for the appropriate value for this field. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]598 body: object, The request body.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]599 The object takes the form of:
600
601{ # Request message for `TestIamPermissions` method.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]602 &quot;permissions&quot;: [ # The set of permissions to check for the `resource`. Permissions with
603 # wildcards (such as &#x27;*&#x27; or &#x27;storage.*&#x27;) are not allowed. For more
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]604 # information see
605 # [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]606 &quot;A String&quot;,
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]607 ],
608 }
609
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]610 x__xgafv: string, V1 error format.
611 Allowed values
612 1 - v1 error format
613 2 - v2 error format
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]614
615Returns:
616 An object of the form:
617
618 { # Response message for `TestIamPermissions` method.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]619 &quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]620 # allowed.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]621 &quot;A String&quot;,
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]622 ],
623 }</pre>
624</div>
625
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]626</body></html>