class Google::Apis::RuntimeconfigV1beta1::Waiter
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](/deployment-manager/runtime-configurator/creating-a-waiter) documentation.
Attributes
- 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. Corresponds to the JSON property `createTime` @return [String]
- 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. Corresponds to the JSON property `done` @return [Boolean]
- 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. Corresponds to the JSON property `done` @return [Boolean]
The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](github.com/grpc). The error model is designed to be:
-
Simple to use and understand for most users
-
Flexible enough to meet unexpected needs
# Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include:
-
Partial errors. If a service needs to return partial errors to the client,
it may embed the `Status` in the normal response to indicate the partial errors.
-
Workflow errors. A typical workflow has multiple steps. Each step may
have a `Status` message for error reporting.
-
Batch operations. If a client uses batch request and batch response, the
`Status` message should be used directly inside batch response, one for each error sub-response.
-
Asynchronous operations. If an API call embeds asynchronous operation
results in its response, the status of those operations should be represented directly using the `Status` message.
-
Logging. If some API errors are stored in logs, the message `Status` could
be used directly after any stripping needed for security/privacy reasons. Corresponds to the JSON property `error` @return [Google::Apis::RuntimeconfigV1beta1::Status]
The condition that a Waiter
resource is waiting for. Corresponds to the JSON property `failure` @return [Google::Apis::RuntimeconfigV1beta1::EndCondition]
The name of the Waiter
resource, in the format: projects//configs//waiters/ 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. Corresponds to the JSON property `name` @return [String]
The condition that a Waiter
resource is waiting for. Corresponds to the JSON property `success` @return [Google::Apis::RuntimeconfigV1beta1::EndCondition]
- 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`. Corresponds to the JSON property `timeout` @return [String]
Public Class Methods
# File lib/rcloadenv/google/apis/runtimeconfig_v1beta1/classes.rb, line 560 def initialize(**args) update!(**args) end
Public Instance Methods
Update properties of this object
# File lib/rcloadenv/google/apis/runtimeconfig_v1beta1/classes.rb, line 565 def update!(**args) @error = args[:error] if args.key?(:error) @failure = args[:failure] if args.key?(:failure) @success = args[:success] if args.key?(:success) @done = args[:done] if args.key?(:done) @create_time = args[:create_time] if args.key?(:create_time) @timeout = args[:timeout] if args.key?(:timeout) @name = args[:name] if args.key?(:name) end