Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 715bd7f9ca9a324a05ee05a6476af383e54930f9 / . / docs / dyn / runtimeconfig_v1beta1.projects.configs.waiters.html
blob: 103ba2d0e68fc52f6dc4b04f1e8c514d55094b11 [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">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]78 <code><a href="#create">create(parent, 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">
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">
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]87 <code><a href="#list">list(parent, 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>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]92<p class="toc_element">
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]93 <code><a href="#testIamPermissions">testIamPermissions(resource, body, 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">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]97 <code class="details" id="create">create(parent, body, 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)
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]109 body: object, The request body. (required)
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
115 # the node's readiness as part of the startup process.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]116 #
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.
121 #
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]122 # Once created, a Waiter resource is immutable.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]123 #
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.
128 "name": "A String", # 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.
138 "success": { # The condition that a Waiter resource is waiting for. # [Required] The success condition. If this condition is met, `done` will be
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]139 # set to `true` and the `error` value will remain unset. The failure
140 # condition takes precedence over the success condition. If both conditions
141 # are met, a failure will be indicated.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]142 "cardinality": { # A Cardinality condition for the Waiter resource. A cardinality condition is # The cardinality of the `EndCondition`.
143 # met when the number of variables under a specified path prefix reaches a
144 # predefined number. For example, if you set a Cardinality condition where
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]145 # the `path` is set to `/foo` and the number of paths is set to `2`, the
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]146 # following variables would meet the condition in a RuntimeConfig resource:
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]147 #
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]148 # + `/foo/variable1 = "value1"`
149 # + `/foo/variable2 = "value2"`
150 # + `/bar/variable3 = "value3"`
151 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]152 # It would not satisfy the same condition with the `number` set to
153 # `3`, however, because there is only 2 paths that start with `/foo`.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]154 # Cardinality conditions are recursive; all subtrees under the specific
155 # path prefix are counted.
156 "path": "A String", # The root of the variable subtree to monitor. For example, `/foo`.
157 "number": 42, # The number variables under the `path` that must exist to meet this
158 # condition. Defaults to 1 if not specified.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]159 },
160 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]161 "failure": { # The condition that a Waiter resource is waiting for. # [Optional] The failure condition of this waiter. If this condition is met,
162 # `done` will be set to `true` and the `error` code will be set to `ABORTED`.
163 # The failure condition takes precedence over the success condition. If both
164 # conditions are met, a failure will be indicated. This value is optional; if
165 # no failure condition is set, the only failure scenario will be a timeout.
166 "cardinality": { # A Cardinality condition for the Waiter resource. A cardinality condition is # The cardinality of the `EndCondition`.
167 # met when the number of variables under a specified path prefix reaches a
168 # predefined number. For example, if you set a Cardinality condition where
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]169 # the `path` is set to `/foo` and the number of paths is set to `2`, the
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]170 # following variables would meet the condition in a RuntimeConfig resource:
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]171 #
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]172 # + `/foo/variable1 = "value1"`
173 # + `/foo/variable2 = "value2"`
174 # + `/bar/variable3 = "value3"`
175 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]176 # It would not satisfy the same condition with the `number` set to
177 # `3`, however, because there is only 2 paths that start with `/foo`.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]178 # Cardinality conditions are recursive; all subtrees under the specific
179 # path prefix are counted.
180 "path": "A String", # The root of the variable subtree to monitor. For example, `/foo`.
181 "number": 42, # The number variables under the `path` that must exist to meet this
182 # condition. Defaults to 1 if not specified.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]183 },
184 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]185 "done": True or False, # Output only. If the value is `false`, it means the waiter is still waiting
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]186 # for one of its conditions to be met.
187 #
188 # If true, the waiter has finished. If the waiter finished due to a timeout
189 # or failure, `error` will be set.
190 "timeout": "A String", # [Required] Specifies the timeout of the waiter in seconds, beginning from
191 # the instant that `waiters().create` method is called. If this time elapses
192 # before the success or failure conditions are met, the waiter fails and sets
193 # the `error` code to `DEADLINE_EXCEEDED`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]194 "error": { # 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]195 # will be set.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]196 # different programming environments, including REST APIs and RPC APIs. It is
197 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
198 # three pieces of data: error code, error message, and error details.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]199 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]200 # You can find out more about this error model and how to work with it in the
201 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]202 "message": "A String", # A developer-facing error message, which should be in English. Any
203 # user-facing error message should be localized and sent in the
204 # google.rpc.Status.details field, or localized by the client.
205 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]206 "details": [ # A list of messages that carry the error details. There is a common set of
207 # message types for APIs to use.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]208 {
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]209 "a_key": "", # Properties of the object. Contains field @type with type URL.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]210 },
211 ],
212 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]213 "createTime": "A String", # Output only. The instant at which this Waiter resource was created. Adding
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]214 # the value of `timeout` to this instant yields the timeout deadline for the
215 # waiter.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]216 }
217
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]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
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]221first resource created and stored in the backend is returned.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]222Empty `request_id` fields are ignored.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]223
224It is responsibility of the client to ensure uniqueness of the
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]225`request_id` strings.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]226
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]227`request_id` strings are limited to 64 characters.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]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.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]238 "response": { # The normal response of the operation in case of success. If the original
239 # method returns no data on success, such as `Delete`, the response is
240 # `google.protobuf.Empty`. If the original method is standard
241 # `Get`/`Create`/`Update`, the response should be the resource. For other
242 # methods, the response should have the type `XxxResponse`, where `Xxx`
243 # is the original method name. For example, if the original method name
244 # is `TakeSnapshot()`, the inferred response type is
245 # `TakeSnapshotResponse`.
246 "a_key": "", # Properties of the object. Contains field @type with type URL.
247 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]248 "metadata": { # Service-specific metadata associated with the operation. It typically
249 # contains progress information and common metadata such as create time.
250 # Some services might not provide such metadata. Any method that returns a
251 # long-running operation should document the metadata type, if any.
252 "a_key": "", # Properties of the object. Contains field @type with type URL.
253 },
254 "done": True or False, # If the value is `false`, it means the operation is still in progress.
255 # If `true`, the operation is completed, and either `error` or `response` is
256 # available.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]257 "name": "A String", # The server-assigned name, which is only unique within the same service that
258 # originally returns it. If you use the default HTTP mapping, the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]259 # `name` should be a resource name ending with `operations/{unique_id}`.
260 "error": { # 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.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]264 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]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).
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]267 "message": "A String", # A developer-facing error message, which should be in English. Any
268 # user-facing error message should be localized and sent in the
269 # google.rpc.Status.details field, or localized by the client.
270 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]271 "details": [ # A list of messages that carry the error details. There is a common set of
272 # message types for APIs to use.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]273 {
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]274 "a_key": "", # Properties of the object. Contains field @type with type URL.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]275 },
276 ],
277 },
278 }</pre>
279</div>
280
281<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]282 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]283 <pre>Deletes the waiter with the specified name.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]284
285Args:
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]286 name: string, The Waiter resource to delete, in the format:
287
288 `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]` (required)
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]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">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]310 <code class="details" id="get">get(name, x__xgafv=None)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]311 <pre>Gets information about a single waiter.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]312
313Args:
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]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)
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]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
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]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's readiness as part of the startup process.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]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 #
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]336 # Once created, a Waiter resource is immutable.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]337 #
338 # To learn more about using waiters, read the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]339 # [Creating a
340 # Waiter](/deployment-manager/runtime-configurator/creating-a-waiter)
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]341 # documentation.
342 "name": "A String", # 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.
352 "success": { # The condition that a Waiter resource is waiting for. # [Required] The success condition. If this condition is met, `done` will be
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]353 # set to `true` and the `error` value will remain unset. The failure
354 # condition takes precedence over the success condition. If both conditions
355 # are met, a failure will be indicated.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]356 "cardinality": { # A Cardinality condition for the Waiter resource. A cardinality condition is # The cardinality of the `EndCondition`.
357 # met when the number of variables under a specified path prefix reaches a
358 # predefined number. For example, if you set a Cardinality condition where
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]359 # the `path` is set to `/foo` and the number of paths is set to `2`, the
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]360 # following variables would meet the condition in a RuntimeConfig resource:
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]361 #
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]362 # + `/foo/variable1 = "value1"`
363 # + `/foo/variable2 = "value2"`
364 # + `/bar/variable3 = "value3"`
365 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]366 # It would not satisfy the same condition with the `number` set to
367 # `3`, however, because there is only 2 paths that start with `/foo`.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]368 # Cardinality conditions are recursive; all subtrees under the specific
369 # path prefix are counted.
370 "path": "A String", # The root of the variable subtree to monitor. For example, `/foo`.
371 "number": 42, # The number variables under the `path` that must exist to meet this
372 # condition. Defaults to 1 if not specified.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]373 },
374 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]375 "failure": { # The condition that a Waiter resource is waiting for. # [Optional] The failure condition of this waiter. If this condition is met,
376 # `done` will be set to `true` and the `error` code will be set to `ABORTED`.
377 # The failure condition takes precedence over the success condition. If both
378 # conditions are met, a failure will be indicated. This value is optional; if
379 # no failure condition is set, the only failure scenario will be a timeout.
380 "cardinality": { # A Cardinality condition for the Waiter resource. A cardinality condition is # The cardinality of the `EndCondition`.
381 # met when the number of variables under a specified path prefix reaches a
382 # predefined number. For example, if you set a Cardinality condition where
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]383 # the `path` is set to `/foo` and the number of paths is set to `2`, the
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]384 # following variables would meet the condition in a RuntimeConfig resource:
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]385 #
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]386 # + `/foo/variable1 = "value1"`
387 # + `/foo/variable2 = "value2"`
388 # + `/bar/variable3 = "value3"`
389 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]390 # It would not satisfy the same condition with the `number` set to
391 # `3`, however, because there is only 2 paths that start with `/foo`.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]392 # Cardinality conditions are recursive; all subtrees under the specific
393 # path prefix are counted.
394 "path": "A String", # The root of the variable subtree to monitor. For example, `/foo`.
395 "number": 42, # The number variables under the `path` that must exist to meet this
396 # condition. Defaults to 1 if not specified.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]397 },
398 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]399 "done": True or False, # Output only. If the value is `false`, it means the waiter is still waiting
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]400 # for one of its conditions to be met.
401 #
402 # If true, the waiter has finished. If the waiter finished due to a timeout
403 # or failure, `error` will be set.
404 "timeout": "A String", # [Required] Specifies the timeout of the waiter in seconds, beginning from
405 # the instant that `waiters().create` method is called. If this time elapses
406 # before the success or failure conditions are met, the waiter fails and sets
407 # the `error` code to `DEADLINE_EXCEEDED`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]408 "error": { # 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]409 # will be set.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]410 # different programming environments, including REST APIs and RPC APIs. It is
411 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
412 # three pieces of data: error code, error message, and error details.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]413 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]414 # You can find out more about this error model and how to work with it in the
415 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]416 "message": "A String", # A developer-facing error message, which should be in English. Any
417 # user-facing error message should be localized and sent in the
418 # google.rpc.Status.details field, or localized by the client.
419 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]420 "details": [ # A list of messages that carry the error details. There is a common set of
421 # message types for APIs to use.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]422 {
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]423 "a_key": "", # Properties of the object. Contains field @type with type URL.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]424 },
425 ],
426 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]427 "createTime": "A String", # Output only. The instant at which this Waiter resource was created. Adding
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]428 # the value of `timeout` to this instant yields the timeout deadline for the
429 # waiter.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]430 }</pre>
431</div>
432
433<div class="method">
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]434 <code class="details" id="list">list(parent, pageToken=None, x__xgafv=None, pageSize=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.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]444 x__xgafv: string, V1 error format.
445 Allowed values
446 1 - v1 error format
447 2 - v2 error format
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]448 pageSize: integer, Specifies the number of results to return per page. If there are fewer
449elements than the specified number, returns all elements.
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.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]456 "nextPageToken": "A String", # This token allows you to get the next page of results for list requests.
457 # If the number of results is larger than `pageSize`, use the `nextPageToken`
458 # as a value for the query parameter `pageToken` in the next list request.
459 # Subsequent list requests will have their own `nextPageToken` to continue
460 # paging through the results
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]461 "waiters": [ # Found waiters in the project.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]462 { # A Waiter resource waits for some end condition within a RuntimeConfig
463 # resource to be met before it returns. For example, assume you have a
464 # distributed system where each node writes to a Variable resource indicating
465 # the node's readiness as part of the startup process.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]466 #
467 # You then configure a Waiter resource with the success condition set to wait
468 # until some number of nodes have checked in. Afterwards, your application
469 # runs some arbitrary code after the condition has been met and the waiter
470 # returns successfully.
471 #
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]472 # Once created, a Waiter resource is immutable.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]473 #
474 # To learn more about using waiters, read the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]475 # [Creating a
476 # Waiter](/deployment-manager/runtime-configurator/creating-a-waiter)
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]477 # documentation.
478 "name": "A String", # The name of the Waiter resource, in the format:
479 #
480 # projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]
481 #
482 # The `[PROJECT_ID]` must be a valid Google Cloud project ID,
483 # the `[CONFIG_NAME]` must be a valid RuntimeConfig resource, the
484 # `[WAITER_NAME]` must match RFC 1035 segment specification, and the length
485 # of `[WAITER_NAME]` must be less than 64 bytes.
486 #
487 # After you create a Waiter resource, you cannot change the resource name.
488 "success": { # The condition that a Waiter resource is waiting for. # [Required] The success condition. If this condition is met, `done` will be
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]489 # set to `true` and the `error` value will remain unset. The failure
490 # condition takes precedence over the success condition. If both conditions
491 # are met, a failure will be indicated.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]492 "cardinality": { # A Cardinality condition for the Waiter resource. A cardinality condition is # The cardinality of the `EndCondition`.
493 # met when the number of variables under a specified path prefix reaches a
494 # predefined number. For example, if you set a Cardinality condition where
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]495 # the `path` is set to `/foo` and the number of paths is set to `2`, the
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]496 # following variables would meet the condition in a RuntimeConfig resource:
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]497 #
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]498 # + `/foo/variable1 = "value1"`
499 # + `/foo/variable2 = "value2"`
500 # + `/bar/variable3 = "value3"`
501 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]502 # It would not satisfy the same condition with the `number` set to
503 # `3`, however, because there is only 2 paths that start with `/foo`.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]504 # Cardinality conditions are recursive; all subtrees under the specific
505 # path prefix are counted.
506 "path": "A String", # The root of the variable subtree to monitor. For example, `/foo`.
507 "number": 42, # The number variables under the `path` that must exist to meet this
508 # condition. Defaults to 1 if not specified.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]509 },
510 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]511 "failure": { # The condition that a Waiter resource is waiting for. # [Optional] The failure condition of this waiter. If this condition is met,
512 # `done` will be set to `true` and the `error` code will be set to `ABORTED`.
513 # The failure condition takes precedence over the success condition. If both
514 # conditions are met, a failure will be indicated. This value is optional; if
515 # no failure condition is set, the only failure scenario will be a timeout.
516 "cardinality": { # A Cardinality condition for the Waiter resource. A cardinality condition is # The cardinality of the `EndCondition`.
517 # met when the number of variables under a specified path prefix reaches a
518 # predefined number. For example, if you set a Cardinality condition where
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]519 # the `path` is set to `/foo` and the number of paths is set to `2`, the
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]520 # following variables would meet the condition in a RuntimeConfig resource:
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]521 #
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]522 # + `/foo/variable1 = "value1"`
523 # + `/foo/variable2 = "value2"`
524 # + `/bar/variable3 = "value3"`
525 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]526 # It would not satisfy the same condition with the `number` set to
527 # `3`, however, because there is only 2 paths that start with `/foo`.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]528 # Cardinality conditions are recursive; all subtrees under the specific
529 # path prefix are counted.
530 "path": "A String", # The root of the variable subtree to monitor. For example, `/foo`.
531 "number": 42, # The number variables under the `path` that must exist to meet this
532 # condition. Defaults to 1 if not specified.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]533 },
534 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]535 "done": True or False, # Output only. If the value is `false`, it means the waiter is still waiting
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]536 # for one of its conditions to be met.
537 #
538 # If true, the waiter has finished. If the waiter finished due to a timeout
539 # or failure, `error` will be set.
540 "timeout": "A String", # [Required] Specifies the timeout of the waiter in seconds, beginning from
541 # the instant that `waiters().create` method is called. If this time elapses
542 # before the success or failure conditions are met, the waiter fails and sets
543 # the `error` code to `DEADLINE_EXCEEDED`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]544 "error": { # 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]545 # will be set.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]546 # different programming environments, including REST APIs and RPC APIs. It is
547 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
548 # three pieces of data: error code, error message, and error details.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]549 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]550 # You can find out more about this error model and how to work with it in the
551 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]552 "message": "A String", # A developer-facing error message, which should be in English. Any
553 # user-facing error message should be localized and sent in the
554 # google.rpc.Status.details field, or localized by the client.
555 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]556 "details": [ # A list of messages that carry the error details. There is a common set of
557 # message types for APIs to use.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]558 {
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]559 "a_key": "", # Properties of the object. Contains field @type with type URL.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]560 },
561 ],
562 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]563 "createTime": "A String", # Output only. The instant at which this Waiter resource was created. Adding
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]564 # the value of `timeout` to this instant yields the timeout deadline for the
565 # waiter.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]566 },
567 ],
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:
580 A request object that you can call 'execute()' on to request the next
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">
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]586 <code class="details" id="testIamPermissions">testIamPermissions(resource, body, 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
589permissions, not a NOT_FOUND error.
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
593may "fail open" without warning.
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)
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]598 body: object, The request body. (required)
599 The object takes the form of:
600
601{ # Request message for `TestIamPermissions` method.
602 "permissions": [ # The set of permissions to check for the `resource`. Permissions with
603 # wildcards (such as '*' or 'storage.*') are not allowed. For more
604 # information see
605 # [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
606 "A String",
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.
619 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is
620 # allowed.
621 "A String",
622 ],
623 }</pre>
624</div>
625
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]626</body></html>