WaiterArgs

data class WaiterArgs(val configId: Output<String>? = null, val failure: Output<EndConditionArgs>? = null, val name: Output<String>? = null, val project: Output<String>? = null, val requestId: Output<String>? = null, val success: Output<EndConditionArgs>? = null, val timeout: Output<String>? = null) : ConvertibleToJava<WaiterArgs>

Creates a Waiter resource. This operation returns a long-running Operation resource which can be polled for completion. However, a waiter with the given name will exist (and can be retrieved) prior to the operation completing. If the operation fails, the failed Waiter resource will still exist and must be deleted prior to subsequent creation attempts.

Constructors

Link copied to clipboard
fun WaiterArgs(configId: Output<String>? = null, failure: Output<EndConditionArgs>? = null, name: Output<String>? = null, project: Output<String>? = null, requestId: Output<String>? = null, success: Output<EndConditionArgs>? = null, timeout: Output<String>? = null)

Functions

Link copied to clipboard
open override fun toJava(): WaiterArgs

Properties

Link copied to clipboard
val configId: Output<String>? = null
Link copied to clipboard
val failure: Output<EndConditionArgs>? = null

Optional The failure condition of this waiter. If this condition is met, done will be set to true and the error code will be set to ABORTED. The failure condition takes precedence over the success condition. If both conditions are met, a failure will be indicated. This value is optional; if no failure condition is set, the only failure scenario will be a timeout.

Link copied to clipboard
val name: Output<String>? = null

The name of the Waiter resource, in the format: projects/PROJECT_ID/configs/CONFIG_NAME/waiters/WAITER_NAME The [PROJECT_ID] must be a valid Google Cloud project ID, the [CONFIG_NAME] must be a valid RuntimeConfig resource, the [WAITER_NAME] must match RFC 1035 segment specification, and the length of [WAITER_NAME] must be less than 64 bytes. After you create a Waiter resource, you cannot change the resource name.

Link copied to clipboard
val project: Output<String>? = null
Link copied to clipboard
val requestId: Output<String>? = null

An optional but recommended unique request_id. If the server receives two create() requests with the same request_id, then the second request will be ignored and the first resource created and stored in the backend is returned. Empty request_id fields are ignored. It is responsibility of the client to ensure uniqueness of the request_id strings. request_id strings are limited to 64 characters.

Link copied to clipboard
val success: Output<EndConditionArgs>? = null

Required The success condition. If this condition is met, done will be set to true and the error value will remain unset. The failure condition takes precedence over the success condition. If both conditions are met, a failure will be indicated.

Link copied to clipboard
val timeout: Output<String>? = null

Required Specifies the timeout of the waiter in seconds, beginning from the instant that waiters().create method is called. If this time elapses before the success or failure conditions are met, the waiter fails and sets the error code to DEADLINE_EXCEEDED.