# Copyright 2020 Google LLC # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. require 'date' require 'google/apis/core/base_service' require 'google/apis/core/json_representation' require 'google/apis/core/hashable' require 'google/apis/errors' module Google module Apis module RuntimeconfigV1beta1 # Associates `members`, or principals, with a `role`. class Binding include Google::Apis::Core::Hashable # Represents a textual expression in the Common Expression Language (CEL) syntax. # CEL is a C-like expression language. The syntax and semantics of CEL are # documented at https://github.com/google/cel-spec. Example (Comparison): title: # "Summary size limit" description: "Determines if a summary is less than 100 # chars" expression: "document.summary.size() < 100" Example (Equality): title: " # Requestor is owner" description: "Determines if requestor is the document # owner" expression: "document.owner == request.auth.claims.email" Example ( # Logic): title: "Public documents" description: "Determine whether the document # should be publicly visible" expression: "document.type != 'private' && # document.type != 'internal'" Example (Data Manipulation): title: "Notification # string" description: "Create a notification string with a timestamp." # expression: "'New message received at ' + string(document.create_time)" The # exact variables and functions that may be referenced within an expression are # determined by the service that evaluates it. See the service documentation for # additional information. # Corresponds to the JSON property `condition` # @return [Google::Apis::RuntimeconfigV1beta1::Expr] attr_accessor :condition # Specifies the principals requesting access for a Cloud Platform resource. ` # members` can have the following values: * `allUsers`: A special identifier # that represents anyone who is on the internet; with or without a Google # account. * `allAuthenticatedUsers`: A special identifier that represents # anyone who is authenticated with a Google account or a service account. * ` # user:`emailid``: An email address that represents a specific Google account. # For example, `alice@example.com` . * `serviceAccount:`emailid``: An email # address that represents a service account. For example, `my-other-app@appspot. # gserviceaccount.com`. * `group:`emailid``: An email address that represents a # Google group. For example, `admins@example.com`. * `deleted:user:`emailid`?uid= # `uniqueid``: An email address (plus unique identifier) representing a user # that has been recently deleted. For example, `alice@example.com?uid= # 123456789012345678901`. If the user is recovered, this value reverts to `user:` # emailid`` and the recovered user retains the role in the binding. * `deleted: # serviceAccount:`emailid`?uid=`uniqueid``: An email address (plus unique # identifier) representing a service account that has been recently deleted. For # example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. # If the service account is undeleted, this value reverts to `serviceAccount:` # emailid`` and the undeleted service account retains the role in the binding. * # `deleted:group:`emailid`?uid=`uniqueid``: An email address (plus unique # identifier) representing a Google group that has been recently deleted. For # example, `admins@example.com?uid=123456789012345678901`. If the group is # recovered, this value reverts to `group:`emailid`` and the recovered group # retains the role in the binding. * `domain:`domain``: The G Suite domain ( # primary) that represents all the users of that domain. For example, `google. # com` or `example.com`. # Corresponds to the JSON property `members` # @return [Array] attr_accessor :members # Role that is assigned to the list of `members`, or principals. For example, ` # roles/viewer`, `roles/editor`, or `roles/owner`. # Corresponds to the JSON property `role` # @return [String] attr_accessor :role def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @condition = args[:condition] if args.key?(:condition) @members = args[:members] if args.key?(:members) @role = args[:role] if args.key?(:role) end end # A Cardinality condition for the Waiter resource. A cardinality condition is # met when the number of variables under a specified path prefix reaches a # predefined number. For example, if you set a Cardinality condition where the ` # path` is set to `/foo` and the number of paths is set to `2`, the following # variables would meet the condition in a RuntimeConfig resource: + `/foo/ # variable1 = "value1"` + `/foo/variable2 = "value2"` + `/bar/variable3 = " # value3"` It would not satisfy the same condition with the `number` set to `3`, # however, because there is only 2 paths that start with `/foo`. Cardinality # conditions are recursive; all subtrees under the specific path prefix are # counted. class Cardinality include Google::Apis::Core::Hashable # The number variables under the `path` that must exist to meet this condition. # Defaults to 1 if not specified. # Corresponds to the JSON property `number` # @return [Fixnum] attr_accessor :number # The root of the variable subtree to monitor. For example, `/foo`. # Corresponds to the JSON property `path` # @return [String] attr_accessor :path def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @number = args[:number] if args.key?(:number) @path = args[:path] if args.key?(:path) end end # A generic empty message that you can re-use to avoid defining duplicated empty # messages in your APIs. A typical example is to use it as the request or the # response type of an API method. For instance: service Foo ` rpc Bar(google. # protobuf.Empty) returns (google.protobuf.Empty); ` class Empty include Google::Apis::Core::Hashable def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) end end # The condition that a Waiter resource is waiting for. class EndCondition include Google::Apis::Core::Hashable # A Cardinality condition for the Waiter resource. A cardinality condition is # met when the number of variables under a specified path prefix reaches a # predefined number. For example, if you set a Cardinality condition where the ` # path` is set to `/foo` and the number of paths is set to `2`, the following # variables would meet the condition in a RuntimeConfig resource: + `/foo/ # variable1 = "value1"` + `/foo/variable2 = "value2"` + `/bar/variable3 = " # value3"` It would not satisfy the same condition with the `number` set to `3`, # however, because there is only 2 paths that start with `/foo`. Cardinality # conditions are recursive; all subtrees under the specific path prefix are # counted. # Corresponds to the JSON property `cardinality` # @return [Google::Apis::RuntimeconfigV1beta1::Cardinality] attr_accessor :cardinality def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @cardinality = args[:cardinality] if args.key?(:cardinality) end end # Represents a textual expression in the Common Expression Language (CEL) syntax. # CEL is a C-like expression language. The syntax and semantics of CEL are # documented at https://github.com/google/cel-spec. Example (Comparison): title: # "Summary size limit" description: "Determines if a summary is less than 100 # chars" expression: "document.summary.size() < 100" Example (Equality): title: " # Requestor is owner" description: "Determines if requestor is the document # owner" expression: "document.owner == request.auth.claims.email" Example ( # Logic): title: "Public documents" description: "Determine whether the document # should be publicly visible" expression: "document.type != 'private' && # document.type != 'internal'" Example (Data Manipulation): title: "Notification # string" description: "Create a notification string with a timestamp." # expression: "'New message received at ' + string(document.create_time)" The # exact variables and functions that may be referenced within an expression are # determined by the service that evaluates it. See the service documentation for # additional information. class Expr include Google::Apis::Core::Hashable # Optional. Description of the expression. This is a longer text which describes # the expression, e.g. when hovered over it in a UI. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # Textual representation of an expression in Common Expression Language syntax. # Corresponds to the JSON property `expression` # @return [String] attr_accessor :expression # Optional. String indicating the location of the expression for error reporting, # e.g. a file name and a position in the file. # Corresponds to the JSON property `location` # @return [String] attr_accessor :location # Optional. Title for the expression, i.e. a short string describing its purpose. # This can be used e.g. in UIs which allow to enter the expression. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @description = args[:description] if args.key?(:description) @expression = args[:expression] if args.key?(:expression) @location = args[:location] if args.key?(:location) @title = args[:title] if args.key?(:title) end end # `ListConfigs()` returns the following response. The order of returned objects # is arbitrary; that is, it is not ordered in any particular way. class ListConfigsResponse include Google::Apis::Core::Hashable # A list of the configurations in the project. The order of returned objects is # arbitrary; that is, it is not ordered in any particular way. # Corresponds to the JSON property `configs` # @return [Array] attr_accessor :configs # This token allows you to get the next page of results for list requests. If # the number of results is larger than `pageSize`, use the `nextPageToken` as a # value for the query parameter `pageToken` in the next list request. Subsequent # list requests will have their own `nextPageToken` to continue paging through # the results # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @configs = args[:configs] if args.key?(:configs) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # Response for the `ListVariables()` method. class ListVariablesResponse include Google::Apis::Core::Hashable # This token allows you to get the next page of results for list requests. If # the number of results is larger than `pageSize`, use the `nextPageToken` as a # value for the query parameter `pageToken` in the next list request. Subsequent # list requests will have their own `nextPageToken` to continue paging through # the results # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # A list of variables and their values. The order of returned variable objects # is arbitrary. # Corresponds to the JSON property `variables` # @return [Array] attr_accessor :variables def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) @variables = args[:variables] if args.key?(:variables) end end # Response for the `ListWaiters()` method. Order of returned waiter objects is # arbitrary. class ListWaitersResponse include Google::Apis::Core::Hashable # This token allows you to get the next page of results for list requests. If # the number of results is larger than `pageSize`, use the `nextPageToken` as a # value for the query parameter `pageToken` in the next list request. Subsequent # list requests will have their own `nextPageToken` to continue paging through # the results # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # Found waiters in the project. # Corresponds to the JSON property `waiters` # @return [Array] attr_accessor :waiters def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) @waiters = args[:waiters] if args.key?(:waiters) end end # This resource represents a long-running operation that is the result of a # network API call. class Operation include Google::Apis::Core::Hashable # If the value is `false`, it means the operation is still in progress. If `true` # , the operation is completed, and either `error` or `response` is available. # Corresponds to the JSON property `done` # @return [Boolean] attr_accessor :done alias_method :done?, :done # 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](https://github.com/grpc). Each `Status` message contains three pieces of # data: error code, error message, and error details. You can find out more # about this error model and how to work with it in the [API Design Guide](https: # //cloud.google.com/apis/design/errors). # Corresponds to the JSON property `error` # @return [Google::Apis::RuntimeconfigV1beta1::Status] attr_accessor :error # Service-specific metadata associated with the operation. It typically contains # progress information and common metadata such as create time. Some services # might not provide such metadata. Any method that returns a long-running # operation should document the metadata type, if any. # Corresponds to the JSON property `metadata` # @return [Hash] attr_accessor :metadata # The server-assigned name, which is only unique within the same service that # originally returns it. If you use the default HTTP mapping, the `name` should # be a resource name ending with `operations/`unique_id``. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The normal response of the operation in case of success. If the original # method returns no data on success, such as `Delete`, the response is `google. # protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, # the response should be the resource. For other methods, the response should # have the type `XxxResponse`, where `Xxx` is the original method name. For # example, if the original method name is `TakeSnapshot()`, the inferred # response type is `TakeSnapshotResponse`. # Corresponds to the JSON property `response` # @return [Hash] attr_accessor :response def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @done = args[:done] if args.key?(:done) @error = args[:error] if args.key?(:error) @metadata = args[:metadata] if args.key?(:metadata) @name = args[:name] if args.key?(:name) @response = args[:response] if args.key?(:response) end end # An Identity and Access Management (IAM) policy, which specifies access # controls for Google Cloud resources. A `Policy` is a collection of `bindings`. # A `binding` binds one or more `members`, or principals, to a single `role`. # Principals can be user accounts, service accounts, Google groups, and domains ( # such as G Suite). A `role` is a named list of permissions; each `role` can be # an IAM predefined role or a user-created custom role. For some types of Google # Cloud resources, a `binding` can also specify a `condition`, which is a # logical expression that allows access to a resource only if the expression # evaluates to `true`. A condition can add constraints based on attributes of # the request, the resource, or both. To learn which resources support # conditions in their IAM policies, see the [IAM documentation](https://cloud. # google.com/iam/help/conditions/resource-policies). **JSON example:** ` " # bindings": [ ` "role": "roles/resourcemanager.organizationAdmin", "members": [ # "user:mike@example.com", "group:admins@example.com", "domain:google.com", " # serviceAccount:my-project-id@appspot.gserviceaccount.com" ] `, ` "role": " # roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" # ], "condition": ` "title": "expirable access", "description": "Does not grant # access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00: # 00:00.000Z')", ` ` ], "etag": "BwWWja0YfJA=", "version": 3 ` **YAML example:** # bindings: - members: - user:mike@example.com - group:admins@example.com - # domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com # role: roles/resourcemanager.organizationAdmin - members: - user:eve@example. # com role: roles/resourcemanager.organizationViewer condition: title: expirable # access description: Does not grant access after Sep 2020 expression: request. # time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For # a description of IAM and its features, see the [IAM documentation](https:// # cloud.google.com/iam/docs/). class Policy include Google::Apis::Core::Hashable # Associates a list of `members`, or principals, with a `role`. Optionally, may # specify a `condition` that determines how and when the `bindings` are applied. # Each of the `bindings` must contain at least one principal. The `bindings` in # a `Policy` can refer to up to 1,500 principals; up to 250 of these principals # can be Google groups. Each occurrence of a principal counts towards these # limits. For example, if the `bindings` grant 50 different roles to `user:alice@ # example.com`, and not to any other principal, then you can add another 1,450 # principals to the `bindings` in the `Policy`. # Corresponds to the JSON property `bindings` # @return [Array] attr_accessor :bindings # `etag` is used for optimistic concurrency control as a way to help prevent # simultaneous updates of a policy from overwriting each other. It is strongly # suggested that systems make use of the `etag` in the read-modify-write cycle # to perform policy updates in order to avoid race conditions: An `etag` is # returned in the response to `getIamPolicy`, and systems are expected to put # that etag in the request to `setIamPolicy` to ensure that their change will be # applied to the same version of the policy. **Important:** If you use IAM # Conditions, you must include the `etag` field whenever you call `setIamPolicy`. # If you omit this field, then IAM allows you to overwrite a version `3` policy # with a version `1` policy, and all of the conditions in the version `3` policy # are lost. # Corresponds to the JSON property `etag` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :etag # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. # Requests that specify an invalid value are rejected. Any operation that # affects conditional role bindings must specify version `3`. This requirement # applies to the following operations: * Getting a policy that includes a # conditional role binding * Adding a conditional role binding to a policy * # Changing a conditional role binding in a policy * Removing any role binding, # with or without a condition, from a policy that includes conditions ** # Important:** If you use IAM Conditions, you must include the `etag` field # whenever you call `setIamPolicy`. If you omit this field, then IAM allows you # to overwrite a version `3` policy with a version `1` policy, and all of the # conditions in the version `3` policy are lost. If a policy does not include # any conditions, operations on that policy may specify any valid version or # leave the field unset. To learn which resources support conditions in their # IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/ # conditions/resource-policies). # Corresponds to the JSON property `version` # @return [Fixnum] attr_accessor :version def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @bindings = args[:bindings] if args.key?(:bindings) @etag = args[:etag] if args.key?(:etag) @version = args[:version] if args.key?(:version) end end # A RuntimeConfig resource is the primary resource in the Cloud RuntimeConfig # service. A RuntimeConfig resource consists of metadata and a hierarchy of # variables. class RuntimeConfig include Google::Apis::Core::Hashable # An optional description of the RuntimeConfig object. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # The resource name of a runtime config. The name must have the format: projects/ # [PROJECT_ID]/configs/[CONFIG_NAME] The `[PROJECT_ID]` must be a valid project # ID, and `[CONFIG_NAME]` is an arbitrary name that matches the `[0-9A-Za-z](?:[ # _.A-Za-z0-9-]`0,62`[_.A-Za-z0-9])?` regular expression. The length of `[ # CONFIG_NAME]` must be less than 64 characters. You pick the RuntimeConfig # resource name, but the server will validate that the name adheres to this # format. After you create the resource, you cannot change the resource's name. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @description = args[:description] if args.key?(:description) @name = args[:name] if args.key?(:name) end end # Request message for `SetIamPolicy` method. class SetIamPolicyRequest include Google::Apis::Core::Hashable # An Identity and Access Management (IAM) policy, which specifies access # controls for Google Cloud resources. A `Policy` is a collection of `bindings`. # A `binding` binds one or more `members`, or principals, to a single `role`. # Principals can be user accounts, service accounts, Google groups, and domains ( # such as G Suite). A `role` is a named list of permissions; each `role` can be # an IAM predefined role or a user-created custom role. For some types of Google # Cloud resources, a `binding` can also specify a `condition`, which is a # logical expression that allows access to a resource only if the expression # evaluates to `true`. A condition can add constraints based on attributes of # the request, the resource, or both. To learn which resources support # conditions in their IAM policies, see the [IAM documentation](https://cloud. # google.com/iam/help/conditions/resource-policies). **JSON example:** ` " # bindings": [ ` "role": "roles/resourcemanager.organizationAdmin", "members": [ # "user:mike@example.com", "group:admins@example.com", "domain:google.com", " # serviceAccount:my-project-id@appspot.gserviceaccount.com" ] `, ` "role": " # roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" # ], "condition": ` "title": "expirable access", "description": "Does not grant # access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00: # 00:00.000Z')", ` ` ], "etag": "BwWWja0YfJA=", "version": 3 ` **YAML example:** # bindings: - members: - user:mike@example.com - group:admins@example.com - # domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com # role: roles/resourcemanager.organizationAdmin - members: - user:eve@example. # com role: roles/resourcemanager.organizationViewer condition: title: expirable # access description: Does not grant access after Sep 2020 expression: request. # time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For # a description of IAM and its features, see the [IAM documentation](https:// # cloud.google.com/iam/docs/). # Corresponds to the JSON property `policy` # @return [Google::Apis::RuntimeconfigV1beta1::Policy] attr_accessor :policy def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @policy = args[:policy] if args.key?(:policy) end end # 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](https://github.com/grpc). Each `Status` message contains three pieces of # data: error code, error message, and error details. You can find out more # about this error model and how to work with it in the [API Design Guide](https: # //cloud.google.com/apis/design/errors). class Status include Google::Apis::Core::Hashable # The status code, which should be an enum value of google.rpc.Code. # Corresponds to the JSON property `code` # @return [Fixnum] attr_accessor :code # A list of messages that carry the error details. There is a common set of # message types for APIs to use. # Corresponds to the JSON property `details` # @return [Array>] attr_accessor :details # 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. # Corresponds to the JSON property `message` # @return [String] attr_accessor :message def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @code = args[:code] if args.key?(:code) @details = args[:details] if args.key?(:details) @message = args[:message] if args.key?(:message) end end # Request message for `TestIamPermissions` method. class TestIamPermissionsRequest include Google::Apis::Core::Hashable # The set of permissions to check for the `resource`. Permissions with wildcards # (such as '*' or 'storage.*') are not allowed. For more information see [IAM # Overview](https://cloud.google.com/iam/docs/overview#permissions). # Corresponds to the JSON property `permissions` # @return [Array] attr_accessor :permissions def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @permissions = args[:permissions] if args.key?(:permissions) end end # Response message for `TestIamPermissions` method. class TestIamPermissionsResponse include Google::Apis::Core::Hashable # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. # Corresponds to the JSON property `permissions` # @return [Array] attr_accessor :permissions def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @permissions = args[:permissions] if args.key?(:permissions) end end # Describes a single variable within a RuntimeConfig resource. The name denotes # the hierarchical variable name. For example, `ports/serving_port` is a valid # variable name. The variable value is an opaque string and only leaf variables # can have values (that is, variables that do not have any child variables). class Variable include Google::Apis::Core::Hashable # The name of the variable resource, in the format: projects/[PROJECT_ID]/ # configs/[CONFIG_NAME]/variables/[VARIABLE_NAME] The `[PROJECT_ID]` must be a # valid project ID, `[CONFIG_NAME]` must be a valid RuntimeConfig resource and `[ # VARIABLE_NAME]` follows Unix file system file path naming. The `[VARIABLE_NAME] # ` can contain ASCII letters, numbers, slashes and dashes. Slashes are used as # path element separators and are not part of the `[VARIABLE_NAME]` itself, so `[ # VARIABLE_NAME]` must contain at least one non-slash character. Multiple # slashes are coalesced into single slash character. Each path segment should # match [0-9A-Za-z](?:[_.A-Za-z0-9-]`0,62`[_.A-Za-z0-9])? regular expression. # The length of a `[VARIABLE_NAME]` must be less than 256 characters. Once you # create a variable, you cannot change the variable name. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Output only. The current state of the variable. The variable state indicates # the outcome of the `variables().watch` call and is visible through the `get` # and `list` calls. # Corresponds to the JSON property `state` # @return [String] attr_accessor :state # The string value of the variable. The length of the value must be less than # 4096 bytes. Empty values are also accepted. For example, `text: "my text value" # `. The string must be valid UTF-8. # Corresponds to the JSON property `text` # @return [String] attr_accessor :text # Output only. The time of the last variable update. Timestamp will be UTC # timestamp. # Corresponds to the JSON property `updateTime` # @return [String] attr_accessor :update_time # The binary value of the variable. The length of the value must be less than # 4096 bytes. Empty values are also accepted. The value must be base64 encoded, # and must comply with IETF RFC4648 (https://www.ietf.org/rfc/rfc4648.txt). Only # one of `value` or `text` can be set. # Corresponds to the JSON property `value` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :value def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @name = args[:name] if args.key?(:name) @state = args[:state] if args.key?(:state) @text = args[:text] if args.key?(:text) @update_time = args[:update_time] if args.key?(:update_time) @value = args[:value] if args.key?(:value) end end # 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 indicating 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. class Waiter include Google::Apis::Core::Hashable # 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] attr_accessor :create_time # 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] attr_accessor :done alias_method :done?, :done # 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](https://github.com/grpc). Each `Status` message contains three pieces of # data: error code, error message, and error details. You can find out more # about this error model and how to work with it in the [API Design Guide](https: # //cloud.google.com/apis/design/errors). # Corresponds to the JSON property `error` # @return [Google::Apis::RuntimeconfigV1beta1::Status] attr_accessor :error # The condition that a Waiter resource is waiting for. # Corresponds to the JSON property `failure` # @return [Google::Apis::RuntimeconfigV1beta1::EndCondition] attr_accessor :failure # 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. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The condition that a Waiter resource is waiting for. # Corresponds to the JSON property `success` # @return [Google::Apis::RuntimeconfigV1beta1::EndCondition] attr_accessor :success # [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] attr_accessor :timeout def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @create_time = args[:create_time] if args.key?(:create_time) @done = args[:done] if args.key?(:done) @error = args[:error] if args.key?(:error) @failure = args[:failure] if args.key?(:failure) @name = args[:name] if args.key?(:name) @success = args[:success] if args.key?(:success) @timeout = args[:timeout] if args.key?(:timeout) end end # Request for the `WatchVariable()` method. class WatchVariableRequest include Google::Apis::Core::Hashable # If specified, checks the current timestamp of the variable and if the current # timestamp is newer than `newerThan` timestamp, the method returns immediately. # If not specified or the variable has an older timestamp, the watcher waits for # a the value to change before returning. # Corresponds to the JSON property `newerThan` # @return [String] attr_accessor :newer_than def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @newer_than = args[:newer_than] if args.key?(:newer_than) end end end end end