Docs Packages
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. runtimeconfig
  5. runtimeconfig/v1beta1
  6. getWaiter

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.runtimeconfig/v1beta1.getWaiter

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

    Gets information about a single waiter.

    Using getWaiter

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getWaiter(args: GetWaiterArgs, opts?: InvokeOptions): Promise<GetWaiterResult>
function getWaiterOutput(args: GetWaiterOutputArgs, opts?: InvokeOptions): Output<GetWaiterResult>
    def get_waiter(config_id: Optional[str] = None,
               project: Optional[str] = None,
               waiter_id: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetWaiterResult
def get_waiter_output(config_id: Optional[pulumi.Input[str]] = None,
               project: Optional[pulumi.Input[str]] = None,
               waiter_id: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetWaiterResult]
    func LookupWaiter(ctx *Context, args *LookupWaiterArgs, opts ...InvokeOption) (*LookupWaiterResult, error)
func LookupWaiterOutput(ctx *Context, args *LookupWaiterOutputArgs, opts ...InvokeOption) LookupWaiterResultOutput

    > Note: This function is named LookupWaiter in the Go SDK.

    public static class GetWaiter 
{
    public static Task<GetWaiterResult> InvokeAsync(GetWaiterArgs args, InvokeOptions? opts = null)
    public static Output<GetWaiterResult> Invoke(GetWaiterInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetWaiterResult> getWaiter(GetWaiterArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: google-native:runtimeconfig/v1beta1:getWaiter
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ConfigId string
    WaiterId string
    Project string
    ConfigId string
    WaiterId string
    Project string
    configId String
    waiterId String
    project String
    configId string
    waiterId string
    project string
    configId String
    waiterId String
    project String

    getWaiter Result

    The following output properties are available:

    CreateTime string
    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
    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 Pulumi.GoogleNative.RuntimeConfig.V1Beta1.Outputs.StatusResponse
    If the waiter ended due to a failure or timeout, this value will be set.
    Failure Pulumi.GoogleNative.RuntimeConfig.V1Beta1.Outputs.EndConditionResponse
    [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 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.
    Success Pulumi.GoogleNative.RuntimeConfig.V1Beta1.Outputs.EndConditionResponse
    [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 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.
    CreateTime string
    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
    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 StatusResponse
    If the waiter ended due to a failure or timeout, this value will be set.
    Failure EndConditionResponse
    [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 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.
    Success EndConditionResponse
    [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 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.
    createTime String
    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 Boolean
    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 StatusResponse
    If the waiter ended due to a failure or timeout, this value will be set.
    failure EndConditionResponse
    [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 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.
    success EndConditionResponse
    [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 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.
    createTime string
    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 boolean
    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 StatusResponse
    If the waiter ended due to a failure or timeout, this value will be set.
    failure EndConditionResponse
    [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 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.
    success EndConditionResponse
    [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 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.
    create_time str
    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
    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 StatusResponse
    If the waiter ended due to a failure or timeout, this value will be set.
    failure EndConditionResponse
    [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 str
    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.
    success EndConditionResponse
    [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 str
    [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.
    createTime String
    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 Boolean
    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 Property Map
    If the waiter ended due to a failure or timeout, this value will be set.
    failure Property Map
    [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 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.
    success Property Map
    [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 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.

    Supporting Types

    CardinalityResponse

    Number int
    The number variables under the path that must exist to meet this condition. Defaults to 1 if not specified.
    Path string
    The root of the variable subtree to monitor. For example, /foo.
    Number int
    The number variables under the path that must exist to meet this condition. Defaults to 1 if not specified.
    Path string
    The root of the variable subtree to monitor. For example, /foo.
    number Integer
    The number variables under the path that must exist to meet this condition. Defaults to 1 if not specified.
    path String
    The root of the variable subtree to monitor. For example, /foo.
    number number
    The number variables under the path that must exist to meet this condition. Defaults to 1 if not specified.
    path string
    The root of the variable subtree to monitor. For example, /foo.
    number int
    The number variables under the path that must exist to meet this condition. Defaults to 1 if not specified.
    path str
    The root of the variable subtree to monitor. For example, /foo.
    number Number
    The number variables under the path that must exist to meet this condition. Defaults to 1 if not specified.
    path String
    The root of the variable subtree to monitor. For example, /foo.

    EndConditionResponse

    Cardinality CardinalityResponse
    The cardinality of the EndCondition.
    cardinality CardinalityResponse
    The cardinality of the EndCondition.
    cardinality CardinalityResponse
    The cardinality of the EndCondition.
    cardinality CardinalityResponse
    The cardinality of the EndCondition.
    cardinality Property Map
    The cardinality of the EndCondition.

    StatusResponse

    Code int
    The status code, which should be an enum value of google.rpc.Code.
    Details List<ImmutableDictionary<string, string>>
    A list of messages that carry the error details. There is a common set of message types for APIs to use.
    Message string
    A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
    Code int
    The status code, which should be an enum value of google.rpc.Code.
    Details []map[string]string
    A list of messages that carry the error details. There is a common set of message types for APIs to use.
    Message string
    A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
    code Integer
    The status code, which should be an enum value of google.rpc.Code.
    details List<Map<String,String>>
    A list of messages that carry the error details. There is a common set of message types for APIs to use.
    message String
    A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
    code number
    The status code, which should be an enum value of google.rpc.Code.
    details {[key: string]: string}[]
    A list of messages that carry the error details. There is a common set of message types for APIs to use.
    message string
    A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
    code int
    The status code, which should be an enum value of google.rpc.Code.
    details Sequence[Mapping[str, str]]
    A list of messages that carry the error details. There is a common set of message types for APIs to use.
    message str
    A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
    code Number
    The status code, which should be an enum value of google.rpc.Code.
    details List<Map<String>>
    A list of messages that carry the error details. There is a common set of message types for APIs to use.
    message String
    A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
    pulumi/pulumi-google-native