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