WaiterArgs class

The set of arguments for Waiter. The set of arguments for Waiter.

Constructors

WaiterArgs({required Input<String> configId, Input<EndCondition>? failure, Input<String>? name, Input<String>? project, Input<String>? requestId, Input<EndCondition>? success, Input<String>? timeout})

Creates a new WaiterArgs. configId Required. failure 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. name 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. project Optional. requestId 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. success 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. timeout 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.

const

WaiterArgs.fromMap(Map<String, dynamic> map)

factory

Properties

configId → Input<String>

final

failure → Input<EndCondition>?

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.

final

hashCode → int

The hash code for this object.

no setter, inherited

name → Input<String>?

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.

final

project → Input<String>?

final

requestId → Input<String>?

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.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

success → Input<EndCondition>?

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.

final

timeout → Input<String>?

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.

final

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toMap() → Map<String, dynamic>

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited