Struct gcp_client::google::cloud::runtimeconfig::v1beta1::Waiter

pub struct Waiter {
    pub name: String,
    pub timeout: Option<Duration>,
    pub failure: Option<EndCondition>,
    pub success: Option<EndCondition>,
    pub create_time: Option<Timestamp>,
    pub done: bool,
    pub error: Option<Status>,
}

A Waiter resource waits for some end condition within a RuntimeConfig resource to be met before it returns. For example, assume you have a distributed system where each node writes to a Variable resource indidicating the node's readiness as part of the startup process.

You then configure a Waiter resource with the success condition set to wait until some number of nodes have checked in. Afterwards, your application runs some arbitrary code after the condition has been met and the waiter returns successfully.

Once created, a Waiter resource is immutable.

To learn more about using waiters, read the Creating a Waiter documentation.

Fields

name: 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.

timeout: Option<Duration>

[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.

failure: Option<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.

success: Option<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.

create_time: Option<Timestamp>

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

done: bool

[Output Only] 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.

error: Option<Status>

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

Trait Implementations

impl Clone for Waiter

fn clone(&self) -> Waiter

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Waiter

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Default for Waiter

fn default() -> Waiter

Returns the "default value" for a type.

impl Message for Waiter

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message to a buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message with a length-delimiter to a buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    B: Buf,
    Self: Default, 

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    B: Buf,
    Self: Default, 

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq<Waiter> for Waiter

fn eq(&self, other: &Waiter) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Waiter) -> bool

This method tests for !=.

impl StructuralPartialEq for Waiter