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

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

google-native.runtimeconfig/v1beta1.Waiter

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

    Creates a Waiter resource. This operation returns a long-running Operation resource which can be polled for completion. However, a waiter with the given name will exist (and can be retrieved) prior to the operation completing. If the operation fails, the failed Waiter resource will still exist and must be deleted prior to subsequent creation attempts.

    Create Waiter Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Waiter(name: string, args: WaiterArgs, opts?: CustomResourceOptions);
    @overload
    def Waiter(resource_name: str,
               args: WaiterArgs,
               opts: Optional[ResourceOptions] = None)
    
    @overload
    def Waiter(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               config_id: Optional[str] = None,
               failure: Optional[EndConditionArgs] = None,
               name: Optional[str] = None,
               project: Optional[str] = None,
               request_id: Optional[str] = None,
               success: Optional[EndConditionArgs] = None,
               timeout: Optional[str] = None)
    func NewWaiter(ctx *Context, name string, args WaiterArgs, opts ...ResourceOption) (*Waiter, error)
    public Waiter(string name, WaiterArgs args, CustomResourceOptions? opts = null)
    public Waiter(String name, WaiterArgs args)
    public Waiter(String name, WaiterArgs args, CustomResourceOptions options)
    
    type: google-native:runtimeconfig/v1beta1:Waiter
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args WaiterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args WaiterArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args WaiterArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WaiterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WaiterArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var waiterResource = new GoogleNative.RuntimeConfig.V1Beta1.Waiter("waiterResource", new()
    {
        ConfigId = "string",
        Failure = new GoogleNative.RuntimeConfig.V1Beta1.Inputs.EndConditionArgs
        {
            Cardinality = new GoogleNative.RuntimeConfig.V1Beta1.Inputs.CardinalityArgs
            {
                Number = 0,
                Path = "string",
            },
        },
        Name = "string",
        Project = "string",
        RequestId = "string",
        Success = new GoogleNative.RuntimeConfig.V1Beta1.Inputs.EndConditionArgs
        {
            Cardinality = new GoogleNative.RuntimeConfig.V1Beta1.Inputs.CardinalityArgs
            {
                Number = 0,
                Path = "string",
            },
        },
        Timeout = "string",
    });
    
    example, err := runtimeconfig.NewWaiter(ctx, "waiterResource", &runtimeconfig.WaiterArgs{
    ConfigId: pulumi.String("string"),
    Failure: &runtimeconfig.EndConditionArgs{
    Cardinality: &runtimeconfig.CardinalityArgs{
    Number: pulumi.Int(0),
    Path: pulumi.String("string"),
    },
    },
    Name: pulumi.String("string"),
    Project: pulumi.String("string"),
    RequestId: pulumi.String("string"),
    Success: &runtimeconfig.EndConditionArgs{
    Cardinality: &runtimeconfig.CardinalityArgs{
    Number: pulumi.Int(0),
    Path: pulumi.String("string"),
    },
    },
    Timeout: pulumi.String("string"),
    })
    
    var waiterResource = new Waiter("waiterResource", WaiterArgs.builder()
        .configId("string")
        .failure(EndConditionArgs.builder()
            .cardinality(CardinalityArgs.builder()
                .number(0)
                .path("string")
                .build())
            .build())
        .name("string")
        .project("string")
        .requestId("string")
        .success(EndConditionArgs.builder()
            .cardinality(CardinalityArgs.builder()
                .number(0)
                .path("string")
                .build())
            .build())
        .timeout("string")
        .build());
    
    waiter_resource = google_native.runtimeconfig.v1beta1.Waiter("waiterResource",
        config_id="string",
        failure=google_native.runtimeconfig.v1beta1.EndConditionArgs(
            cardinality=google_native.runtimeconfig.v1beta1.CardinalityArgs(
                number=0,
                path="string",
            ),
        ),
        name="string",
        project="string",
        request_id="string",
        success=google_native.runtimeconfig.v1beta1.EndConditionArgs(
            cardinality=google_native.runtimeconfig.v1beta1.CardinalityArgs(
                number=0,
                path="string",
            ),
        ),
        timeout="string")
    
    const waiterResource = new google_native.runtimeconfig.v1beta1.Waiter("waiterResource", {
        configId: "string",
        failure: {
            cardinality: {
                number: 0,
                path: "string",
            },
        },
        name: "string",
        project: "string",
        requestId: "string",
        success: {
            cardinality: {
                number: 0,
                path: "string",
            },
        },
        timeout: "string",
    });
    
    type: google-native:runtimeconfig/v1beta1:Waiter
    properties:
        configId: string
        failure:
            cardinality:
                number: 0
                path: string
        name: string
        project: string
        requestId: string
        success:
            cardinality:
                number: 0
                path: string
        timeout: string
    

    Waiter Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Waiter resource accepts the following input properties:

    ConfigId string
    Failure Pulumi.GoogleNative.RuntimeConfig.V1Beta1.Inputs.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.
    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.
    Project string
    RequestId 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.
    Success Pulumi.GoogleNative.RuntimeConfig.V1Beta1.Inputs.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.
    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.
    ConfigId string
    Failure EndConditionArgs
    [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.
    Project string
    RequestId 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.
    Success EndConditionArgs
    [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.
    configId String
    failure 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.
    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.
    project String
    requestId 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.
    success 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.
    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.
    configId string
    failure 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.
    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.
    project string
    requestId 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.
    success 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.
    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.
    config_id str
    failure EndConditionArgs
    [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.
    project str
    request_id str
    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 EndConditionArgs
    [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.
    configId String
    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.
    project String
    requestId 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.
    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.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Waiter resource produces the following output properties:

    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.
    Id string
    The provider-assigned unique ID for this managed resource.
    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.
    Id string
    The provider-assigned unique ID for this managed resource.
    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.
    id String
    The provider-assigned unique ID for this managed resource.
    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.
    id string
    The provider-assigned unique ID for this managed resource.
    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.
    id str
    The provider-assigned unique ID for this managed resource.
    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.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    Cardinality, CardinalityArgs

    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.

    CardinalityResponse, CardinalityResponseArgs

    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.

    EndCondition, EndConditionArgs

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

    EndConditionResponse, EndConditionResponseArgs

    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, StatusResponseArgs

    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