GetWaiterResult

data class GetWaiterResult(val createTime: String, val done: Boolean, val error: StatusResponse, val failure: EndConditionResponse, val name: String, val success: EndConditionResponse, val timeout: String)

Constructors

Link copied to clipboard
constructor(createTime: String, done: Boolean, error: StatusResponse, failure: EndConditionResponse, name: String, success: EndConditionResponse, timeout: String)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

The instant at which this Waiter resource was created. Adding the value of timeout to this instant yields the timeout deadline for the waiter.

Link copied to clipboard

If the value is false, it means the waiter is still waiting for one of its conditions to be met. If true, the waiter has finished. If the waiter finished due to a timeout or failure, error will be set.

Link copied to clipboard

If the waiter ended due to a failure or timeout, this value will be set.

Link copied to clipboard

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

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

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

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.