# frozen_string_literal: true # Copyright 2023 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 # # https://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. # Auto-generated by gapic-generator-ruby. DO NOT EDIT! require "google/cloud/errors" require "google/cloud/config/v1/config_pb" require "google/cloud/config_service/v1/config/rest/service_stub" require "google/cloud/location/rest" require "google/iam/v1/rest" module Google module Cloud module ConfigService module V1 module Config module Rest ## # REST client for the Config service. # # Infrastructure Manager is a managed service that automates the deployment and # management of Google Cloud infrastructure resources. # class Client include Paths # @private attr_reader :config_stub ## # Configure the Config Client class. # # See {::Google::Cloud::ConfigService::V1::Config::Rest::Client::Configuration} # for a description of the configuration fields. # # @example # # # Modify the configuration for all Config clients # ::Google::Cloud::ConfigService::V1::Config::Rest::Client.configure do |config| # config.timeout = 10.0 # end # # @yield [config] Configure the Client client. # @yieldparam config [Client::Configuration] # # @return [Client::Configuration] # def self.configure @configure ||= begin namespace = ["Google", "Cloud", "ConfigService", "V1"] parent_config = while namespace.any? parent_name = namespace.join "::" parent_const = const_get parent_name break parent_const.configure if parent_const.respond_to? :configure namespace.pop end default_config = Client::Configuration.new parent_config default_config end yield @configure if block_given? @configure end ## # Configure the Config Client instance. # # The configuration is set to the derived mode, meaning that values can be changed, # but structural changes (adding new fields, etc.) are not allowed. Structural changes # should be made on {Client.configure}. # # See {::Google::Cloud::ConfigService::V1::Config::Rest::Client::Configuration} # for a description of the configuration fields. # # @yield [config] Configure the Client client. # @yieldparam config [Client::Configuration] # # @return [Client::Configuration] # def configure yield @config if block_given? @config end ## # Create a new Config REST client object. # # @example # # # Create a client using the default configuration # client = ::Google::Cloud::ConfigService::V1::Config::Rest::Client.new # # # Create a client using a custom configuration # client = ::Google::Cloud::ConfigService::V1::Config::Rest::Client.new do |config| # config.timeout = 10.0 # end # # @yield [config] Configure the Config client. # @yieldparam config [Client::Configuration] # def initialize # Create the configuration object @config = Configuration.new Client.configure # Yield the configuration if needed yield @config if block_given? # Create credentials credentials = @config.credentials # Use self-signed JWT if the endpoint is unchanged from default, # but only if the default endpoint does not have a region prefix. enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT && !@config.endpoint.split(".").first.include?("-") credentials ||= Credentials.default scope: @config.scope, enable_self_signed_jwt: enable_self_signed_jwt if credentials.is_a?(::String) || credentials.is_a?(::Hash) credentials = Credentials.new credentials, scope: @config.scope end @quota_project_id = @config.quota_project @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id @operations_client = ::Google::Cloud::ConfigService::V1::Config::Rest::Operations.new do |config| config.credentials = credentials config.quota_project = @quota_project_id config.endpoint = @config.endpoint end @location_client = Google::Cloud::Location::Locations::Rest::Client.new do |config| config.credentials = credentials config.quota_project = @quota_project_id config.endpoint = @config.endpoint config.bindings_override = @config.bindings_override end @iam_policy_client = Google::Iam::V1::IAMPolicy::Rest::Client.new do |config| config.credentials = credentials config.quota_project = @quota_project_id config.endpoint = @config.endpoint config.bindings_override = @config.bindings_override end @config_stub = ::Google::Cloud::ConfigService::V1::Config::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials end ## # Get the associated client for long-running operations. # # @return [::Google::Cloud::ConfigService::V1::Config::Rest::Operations] # attr_reader :operations_client ## # Get the associated client for mix-in of the Locations. # # @return [Google::Cloud::Location::Locations::Rest::Client] # attr_reader :location_client ## # Get the associated client for mix-in of the IAMPolicy. # # @return [Google::Iam::V1::IAMPolicy::Rest::Client] # attr_reader :iam_policy_client # Service calls ## # Lists {::Google::Cloud::ConfigService::V1::Deployment Deployment}s in a given project # and location. # # @overload list_deployments(request, options = nil) # Pass arguments to `list_deployments` via a request object, either of type # {::Google::Cloud::ConfigService::V1::ListDeploymentsRequest} or an equivalent Hash. # # @param request [::Google::Cloud::ConfigService::V1::ListDeploymentsRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries etc. Optional. # # @overload list_deployments(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) # Pass arguments to `list_deployments` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param parent [::String] # Required. The parent in whose context the Deployments are listed. The # parent value is in the format: # 'projects/\\{project_id}/locations/\\{location}'. # @param page_size [::Integer] # When requesting a page of resources, 'page_size' specifies number of # resources to return. If unspecified or set to 0, all resources will be # returned. # @param page_token [::String] # Token returned by previous call to 'ListDeployments' which specifies the # position in the list from where to continue listing the resources. # @param filter [::String] # Lists the Deployments that match the filter expression. A filter # expression filters the resources listed in the response. The expression # must be of the form '\\{field} \\{operator} \\{value}' where operators: '<', '>', # '<=', '>=', '!=', '=', ':' are supported (colon ':' represents a HAS # operator which is roughly synonymous with equality). \\{field} can refer to a # proto or JSON field, or a synthetic field. Field names can be camelCase or # snake_case. # # Examples: # - Filter by name: # name = "projects/foo/locations/us-central1/deployments/bar # # - Filter by labels: # - Resources that have a key called 'foo' # labels.foo:* # - Resources that have a key called 'foo' whose value is 'bar' # labels.foo = bar # # - Filter by state: # - Deployments in CREATING state. # state=CREATING # @param order_by [::String] # Field to use to sort the list. # @yield [result, operation] Access the result along with the TransportOperation object # @yieldparam result [::Google::Cloud::ConfigService::V1::ListDeploymentsResponse] # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Google::Cloud::ConfigService::V1::ListDeploymentsResponse] # # @raise [::Google::Cloud::Error] if the REST call is aborted. # # @example Basic example # require "google/cloud/config_service/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::ConfigService::V1::Config::Rest::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::ConfigService::V1::ListDeploymentsRequest.new # # # Call the list_deployments method. # result = client.list_deployments request # # # The returned object is of type Gapic::PagedEnumerable. You can iterate # # over elements, and API calls will be issued to fetch pages as needed. # result.each do |item| # # Each element is of type ::Google::Cloud::ConfigService::V1::Deployment. # p item # end # def list_deployments request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ConfigService::V1::ListDeploymentsRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.list_deployments.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::ConfigService::V1::VERSION, transports_version_send: [:rest] call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.list_deployments.timeout, metadata: call_metadata, retry_policy: @config.rpcs.list_deployments.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @config_stub.list_deployments request, options do |result, operation| yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end ## # Gets details about a {::Google::Cloud::ConfigService::V1::Deployment Deployment}. # # @overload get_deployment(request, options = nil) # Pass arguments to `get_deployment` via a request object, either of type # {::Google::Cloud::ConfigService::V1::GetDeploymentRequest} or an equivalent Hash. # # @param request [::Google::Cloud::ConfigService::V1::GetDeploymentRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries etc. Optional. # # @overload get_deployment(name: nil) # Pass arguments to `get_deployment` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param name [::String] # Required. The name of the deployment. Format: # 'projects/\\{project_id}/locations/\\{location}/deployments/\\{deployment}'. # @yield [result, operation] Access the result along with the TransportOperation object # @yieldparam result [::Google::Cloud::ConfigService::V1::Deployment] # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Google::Cloud::ConfigService::V1::Deployment] # # @raise [::Google::Cloud::Error] if the REST call is aborted. # # @example Basic example # require "google/cloud/config_service/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::ConfigService::V1::Config::Rest::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::ConfigService::V1::GetDeploymentRequest.new # # # Call the get_deployment method. # result = client.get_deployment request # # # The returned object is of type Google::Cloud::ConfigService::V1::Deployment. # p result # def get_deployment request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ConfigService::V1::GetDeploymentRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.get_deployment.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::ConfigService::V1::VERSION, transports_version_send: [:rest] call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.get_deployment.timeout, metadata: call_metadata, retry_policy: @config.rpcs.get_deployment.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @config_stub.get_deployment request, options do |result, operation| yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end ## # Creates a {::Google::Cloud::ConfigService::V1::Deployment Deployment}. # # @overload create_deployment(request, options = nil) # Pass arguments to `create_deployment` via a request object, either of type # {::Google::Cloud::ConfigService::V1::CreateDeploymentRequest} or an equivalent Hash. # # @param request [::Google::Cloud::ConfigService::V1::CreateDeploymentRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries etc. Optional. # # @overload create_deployment(parent: nil, deployment_id: nil, deployment: nil, request_id: nil) # Pass arguments to `create_deployment` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param parent [::String] # Required. The parent in whose context the Deployment is created. The parent # value is in the format: 'projects/\\{project_id}/locations/\\{location}'. # @param deployment_id [::String] # Required. The Deployment ID. # @param deployment [::Google::Cloud::ConfigService::V1::Deployment, ::Hash] # Required. {::Google::Cloud::ConfigService::V1::Deployment Deployment} resource to be # created. # @param request_id [::String] # Optional. An optional request ID to identify requests. Specify a unique # request ID so that if you must retry your request, the server will know to # ignore the request if it has already been completed. The server will # guarantee that for at least 60 minutes since the first request. # # For example, consider a situation where you make an initial request and the # request times out. If you make the request again with the same request ID, # the server can check if original operation with the same request ID was # received, and if so, will ignore the second request. This prevents clients # from accidentally creating duplicate commitments. # # The request ID must be a valid UUID with the exception that zero UUID is # not supported (00000000-0000-0000-0000-000000000000). # @yield [result, operation] Access the result along with the TransportOperation object # @yieldparam result [::Gapic::Operation] # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Gapic::Operation] # # @raise [::Google::Cloud::Error] if the REST call is aborted. # # @example Basic example # require "google/cloud/config_service/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::ConfigService::V1::Config::Rest::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::ConfigService::V1::CreateDeploymentRequest.new # # # Call the create_deployment method. # result = client.create_deployment request # # # The returned object is of type Gapic::Operation. You can use it to # # check the status of an operation, cancel it, or wait for results. # # Here is how to wait for a response. # result.wait_until_done! timeout: 60 # if result.response? # p result.response # else # puts "No response received." # end # def create_deployment request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ConfigService::V1::CreateDeploymentRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.create_deployment.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::ConfigService::V1::VERSION, transports_version_send: [:rest] call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.create_deployment.timeout, metadata: call_metadata, retry_policy: @config.rpcs.create_deployment.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @config_stub.create_deployment request, options do |result, operation| result = ::Gapic::Operation.new result, @operations_client, options: options yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end ## # Updates a {::Google::Cloud::ConfigService::V1::Deployment Deployment}. # # @overload update_deployment(request, options = nil) # Pass arguments to `update_deployment` via a request object, either of type # {::Google::Cloud::ConfigService::V1::UpdateDeploymentRequest} or an equivalent Hash. # # @param request [::Google::Cloud::ConfigService::V1::UpdateDeploymentRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries etc. Optional. # # @overload update_deployment(update_mask: nil, deployment: nil, request_id: nil) # Pass arguments to `update_deployment` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param update_mask [::Google::Protobuf::FieldMask, ::Hash] # Optional. Field mask used to specify the fields to be overwritten in the # Deployment resource by the update. # # The fields specified in the update_mask are relative to the resource, not # the full request. A field will be overwritten if it is in the mask. If the # user does not provide a mask then all fields will be overwritten. # @param deployment [::Google::Cloud::ConfigService::V1::Deployment, ::Hash] # Required. {::Google::Cloud::ConfigService::V1::Deployment Deployment} to update. # # The deployment's `name` field is used to identify the resource to be # updated. Format: # `projects/{project}/locations/{location}/deployments/{deployment}` # @param request_id [::String] # Optional. An optional request ID to identify requests. Specify a unique # request ID so that if you must retry your request, the server will know to # ignore the request if it has already been completed. The server will # guarantee that for at least 60 minutes since the first request. # # For example, consider a situation where you make an initial request and the # request times out. If you make the request again with the same request ID, # the server can check if original operation with the same request ID was # received, and if so, will ignore the second request. This prevents clients # from accidentally creating duplicate commitments. # # The request ID must be a valid UUID with the exception that zero UUID is # not supported (00000000-0000-0000-0000-000000000000). # @yield [result, operation] Access the result along with the TransportOperation object # @yieldparam result [::Gapic::Operation] # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Gapic::Operation] # # @raise [::Google::Cloud::Error] if the REST call is aborted. # # @example Basic example # require "google/cloud/config_service/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::ConfigService::V1::Config::Rest::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::ConfigService::V1::UpdateDeploymentRequest.new # # # Call the update_deployment method. # result = client.update_deployment request # # # The returned object is of type Gapic::Operation. You can use it to # # check the status of an operation, cancel it, or wait for results. # # Here is how to wait for a response. # result.wait_until_done! timeout: 60 # if result.response? # p result.response # else # puts "No response received." # end # def update_deployment request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ConfigService::V1::UpdateDeploymentRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.update_deployment.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::ConfigService::V1::VERSION, transports_version_send: [:rest] call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.update_deployment.timeout, metadata: call_metadata, retry_policy: @config.rpcs.update_deployment.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @config_stub.update_deployment request, options do |result, operation| result = ::Gapic::Operation.new result, @operations_client, options: options yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end ## # Deletes a {::Google::Cloud::ConfigService::V1::Deployment Deployment}. # # @overload delete_deployment(request, options = nil) # Pass arguments to `delete_deployment` via a request object, either of type # {::Google::Cloud::ConfigService::V1::DeleteDeploymentRequest} or an equivalent Hash. # # @param request [::Google::Cloud::ConfigService::V1::DeleteDeploymentRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries etc. Optional. # # @overload delete_deployment(name: nil, request_id: nil, force: nil, delete_policy: nil) # Pass arguments to `delete_deployment` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param name [::String] # Required. The name of the Deployment in the format: # 'projects/\\{project_id}/locations/\\{location}/deployments/\\{deployment}'. # @param request_id [::String] # Optional. An optional request ID to identify requests. Specify a unique # request ID so that if you must retry your request, the server will know to # ignore the request if it has already been completed. The server will # guarantee that for at least 60 minutes after the first request. # # For example, consider a situation where you make an initial request and the # request times out. If you make the request again with the same request ID, # the server can check if original operation with the same request ID was # received, and if so, will ignore the second request. This prevents clients # from accidentally creating duplicate commitments. # # The request ID must be a valid UUID with the exception that zero UUID is # not supported (00000000-0000-0000-0000-000000000000). # @param force [::Boolean] # Optional. If set to true, any revisions for this deployment will also be # deleted. (Otherwise, the request will only work if the deployment has no # revisions.) # @param delete_policy [::Google::Cloud::ConfigService::V1::DeleteDeploymentRequest::DeletePolicy] # Optional. Policy on how resources actuated by the deployment should be # deleted. If unspecified, the default behavior is to delete the underlying # resources. # @yield [result, operation] Access the result along with the TransportOperation object # @yieldparam result [::Gapic::Operation] # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Gapic::Operation] # # @raise [::Google::Cloud::Error] if the REST call is aborted. # # @example Basic example # require "google/cloud/config_service/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::ConfigService::V1::Config::Rest::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::ConfigService::V1::DeleteDeploymentRequest.new # # # Call the delete_deployment method. # result = client.delete_deployment request # # # The returned object is of type Gapic::Operation. You can use it to # # check the status of an operation, cancel it, or wait for results. # # Here is how to wait for a response. # result.wait_until_done! timeout: 60 # if result.response? # p result.response # else # puts "No response received." # end # def delete_deployment request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ConfigService::V1::DeleteDeploymentRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.delete_deployment.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::ConfigService::V1::VERSION, transports_version_send: [:rest] call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.delete_deployment.timeout, metadata: call_metadata, retry_policy: @config.rpcs.delete_deployment.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @config_stub.delete_deployment request, options do |result, operation| result = ::Gapic::Operation.new result, @operations_client, options: options yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end ## # Lists {::Google::Cloud::ConfigService::V1::Revision Revision}s of a deployment. # # @overload list_revisions(request, options = nil) # Pass arguments to `list_revisions` via a request object, either of type # {::Google::Cloud::ConfigService::V1::ListRevisionsRequest} or an equivalent Hash. # # @param request [::Google::Cloud::ConfigService::V1::ListRevisionsRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries etc. Optional. # # @overload list_revisions(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) # Pass arguments to `list_revisions` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param parent [::String] # Required. The parent in whose context the Revisions are listed. The parent # value is in the format: # 'projects/\\{project_id}/locations/\\{location}/deployments/\\{deployment}'. # @param page_size [::Integer] # When requesting a page of resources, `page_size` specifies number of # resources to return. If unspecified or set to 0, all resources will be # returned. # @param page_token [::String] # Token returned by previous call to 'ListRevisions' which specifies the # position in the list from where to continue listing the resources. # @param filter [::String] # Lists the Revisions that match the filter expression. A filter # expression filters the resources listed in the response. The expression # must be of the form '\\{field} \\{operator} \\{value}' where operators: '<', '>', # '<=', '>=', '!=', '=', ':' are supported (colon ':' represents a HAS # operator which is roughly synonymous with equality). \\{field} can refer to a # proto or JSON field, or a synthetic field. Field names can be camelCase or # snake_case. # # Examples: # - Filter by name: # name = "projects/foo/locations/us-central1/deployments/dep/revisions/bar # # - Filter by labels: # - Resources that have a key called 'foo' # labels.foo:* # - Resources that have a key called 'foo' whose value is 'bar' # labels.foo = bar # # - Filter by state: # - Revisions in CREATING state. # state=CREATING # @param order_by [::String] # Field to use to sort the list. # @yield [result, operation] Access the result along with the TransportOperation object # @yieldparam result [::Google::Cloud::ConfigService::V1::ListRevisionsResponse] # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Google::Cloud::ConfigService::V1::ListRevisionsResponse] # # @raise [::Google::Cloud::Error] if the REST call is aborted. # # @example Basic example # require "google/cloud/config_service/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::ConfigService::V1::Config::Rest::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::ConfigService::V1::ListRevisionsRequest.new # # # Call the list_revisions method. # result = client.list_revisions request # # # The returned object is of type Gapic::PagedEnumerable. You can iterate # # over elements, and API calls will be issued to fetch pages as needed. # result.each do |item| # # Each element is of type ::Google::Cloud::ConfigService::V1::Revision. # p item # end # def list_revisions request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ConfigService::V1::ListRevisionsRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.list_revisions.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::ConfigService::V1::VERSION, transports_version_send: [:rest] call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.list_revisions.timeout, metadata: call_metadata, retry_policy: @config.rpcs.list_revisions.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @config_stub.list_revisions request, options do |result, operation| yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end ## # Gets details about a {::Google::Cloud::ConfigService::V1::Revision Revision}. # # @overload get_revision(request, options = nil) # Pass arguments to `get_revision` via a request object, either of type # {::Google::Cloud::ConfigService::V1::GetRevisionRequest} or an equivalent Hash. # # @param request [::Google::Cloud::ConfigService::V1::GetRevisionRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries etc. Optional. # # @overload get_revision(name: nil) # Pass arguments to `get_revision` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param name [::String] # Required. The name of the Revision in the format: # 'projects/\\{project_id}/locations/\\{location}/deployments/\\{deployment}/revisions/\\{revision}'. # @yield [result, operation] Access the result along with the TransportOperation object # @yieldparam result [::Google::Cloud::ConfigService::V1::Revision] # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Google::Cloud::ConfigService::V1::Revision] # # @raise [::Google::Cloud::Error] if the REST call is aborted. # # @example Basic example # require "google/cloud/config_service/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::ConfigService::V1::Config::Rest::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::ConfigService::V1::GetRevisionRequest.new # # # Call the get_revision method. # result = client.get_revision request # # # The returned object is of type Google::Cloud::ConfigService::V1::Revision. # p result # def get_revision request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ConfigService::V1::GetRevisionRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.get_revision.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::ConfigService::V1::VERSION, transports_version_send: [:rest] call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.get_revision.timeout, metadata: call_metadata, retry_policy: @config.rpcs.get_revision.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @config_stub.get_revision request, options do |result, operation| yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end ## # Gets details about a {::Google::Cloud::ConfigService::V1::Resource Resource} deployed # by Infra Manager. # # @overload get_resource(request, options = nil) # Pass arguments to `get_resource` via a request object, either of type # {::Google::Cloud::ConfigService::V1::GetResourceRequest} or an equivalent Hash. # # @param request [::Google::Cloud::ConfigService::V1::GetResourceRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries etc. Optional. # # @overload get_resource(name: nil) # Pass arguments to `get_resource` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param name [::String] # Required. The name of the Resource in the format: # 'projects/\\{project_id}/locations/\\{location}/deployments/\\{deployment}/revisions/\\{revision}/resource/\\{resource}'. # @yield [result, operation] Access the result along with the TransportOperation object # @yieldparam result [::Google::Cloud::ConfigService::V1::Resource] # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Google::Cloud::ConfigService::V1::Resource] # # @raise [::Google::Cloud::Error] if the REST call is aborted. # # @example Basic example # require "google/cloud/config_service/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::ConfigService::V1::Config::Rest::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::ConfigService::V1::GetResourceRequest.new # # # Call the get_resource method. # result = client.get_resource request # # # The returned object is of type Google::Cloud::ConfigService::V1::Resource. # p result # def get_resource request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ConfigService::V1::GetResourceRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.get_resource.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::ConfigService::V1::VERSION, transports_version_send: [:rest] call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.get_resource.timeout, metadata: call_metadata, retry_policy: @config.rpcs.get_resource.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @config_stub.get_resource request, options do |result, operation| yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end ## # Lists {::Google::Cloud::ConfigService::V1::Resource Resource}s in a given revision. # # @overload list_resources(request, options = nil) # Pass arguments to `list_resources` via a request object, either of type # {::Google::Cloud::ConfigService::V1::ListResourcesRequest} or an equivalent Hash. # # @param request [::Google::Cloud::ConfigService::V1::ListResourcesRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries etc. Optional. # # @overload list_resources(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) # Pass arguments to `list_resources` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param parent [::String] # Required. The parent in whose context the Resources are listed. The parent # value is in the format: # 'projects/\\{project_id}/locations/\\{location}/deployments/\\{deployment}/revisions/\\{revision}'. # @param page_size [::Integer] # When requesting a page of resources, 'page_size' specifies number of # resources to return. If unspecified or set to 0, all resources will be # returned. # @param page_token [::String] # Token returned by previous call to 'ListResources' which specifies the # position in the list from where to continue listing the resources. # @param filter [::String] # Lists the Resources that match the filter expression. A filter # expression filters the resources listed in the response. The expression # must be of the form '\\{field} \\{operator} \\{value}' where operators: '<', '>', # '<=', # '>=', # '!=', '=', ':' are supported (colon ':' represents a HAS operator which is # roughly synonymous with equality). \\{field} can refer to a proto or JSON # field, or a synthetic field. Field names can be camelCase or snake_case. # # Examples: # - Filter by name: # name = # "projects/foo/locations/us-central1/deployments/dep/revisions/bar/resources/baz # @param order_by [::String] # Field to use to sort the list. # @yield [result, operation] Access the result along with the TransportOperation object # @yieldparam result [::Google::Cloud::ConfigService::V1::ListResourcesResponse] # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Google::Cloud::ConfigService::V1::ListResourcesResponse] # # @raise [::Google::Cloud::Error] if the REST call is aborted. # # @example Basic example # require "google/cloud/config_service/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::ConfigService::V1::Config::Rest::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::ConfigService::V1::ListResourcesRequest.new # # # Call the list_resources method. # result = client.list_resources request # # # The returned object is of type Gapic::PagedEnumerable. You can iterate # # over elements, and API calls will be issued to fetch pages as needed. # result.each do |item| # # Each element is of type ::Google::Cloud::ConfigService::V1::Resource. # p item # end # def list_resources request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ConfigService::V1::ListResourcesRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.list_resources.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::ConfigService::V1::VERSION, transports_version_send: [:rest] call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.list_resources.timeout, metadata: call_metadata, retry_policy: @config.rpcs.list_resources.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @config_stub.list_resources request, options do |result, operation| yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end ## # Exports Terraform state file from a given deployment. # # @overload export_deployment_statefile(request, options = nil) # Pass arguments to `export_deployment_statefile` via a request object, either of type # {::Google::Cloud::ConfigService::V1::ExportDeploymentStatefileRequest} or an equivalent Hash. # # @param request [::Google::Cloud::ConfigService::V1::ExportDeploymentStatefileRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries etc. Optional. # # @overload export_deployment_statefile(parent: nil, draft: nil) # Pass arguments to `export_deployment_statefile` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param parent [::String] # Required. The parent in whose context the statefile is listed. The parent # value is in the format: # 'projects/\\{project_id}/locations/\\{location}/deployments/\\{deployment}'. # @param draft [::Boolean] # Optional. If this flag is set to true, the exported deployment state file # will be the draft state. This will enable the draft file to be validated # before copying it over to the working state on unlock. # @yield [result, operation] Access the result along with the TransportOperation object # @yieldparam result [::Google::Cloud::ConfigService::V1::Statefile] # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Google::Cloud::ConfigService::V1::Statefile] # # @raise [::Google::Cloud::Error] if the REST call is aborted. # # @example Basic example # require "google/cloud/config_service/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::ConfigService::V1::Config::Rest::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::ConfigService::V1::ExportDeploymentStatefileRequest.new # # # Call the export_deployment_statefile method. # result = client.export_deployment_statefile request # # # The returned object is of type Google::Cloud::ConfigService::V1::Statefile. # p result # def export_deployment_statefile request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ConfigService::V1::ExportDeploymentStatefileRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.export_deployment_statefile.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::ConfigService::V1::VERSION, transports_version_send: [:rest] call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.export_deployment_statefile.timeout, metadata: call_metadata, retry_policy: @config.rpcs.export_deployment_statefile.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @config_stub.export_deployment_statefile request, options do |result, operation| yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end ## # Exports Terraform state file from a given revision. # # @overload export_revision_statefile(request, options = nil) # Pass arguments to `export_revision_statefile` via a request object, either of type # {::Google::Cloud::ConfigService::V1::ExportRevisionStatefileRequest} or an equivalent Hash. # # @param request [::Google::Cloud::ConfigService::V1::ExportRevisionStatefileRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries etc. Optional. # # @overload export_revision_statefile(parent: nil) # Pass arguments to `export_revision_statefile` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param parent [::String] # Required. The parent in whose context the statefile is listed. The parent # value is in the format: # 'projects/\\{project_id}/locations/\\{location}/deployments/\\{deployment}/revisions/\\{revision}'. # @yield [result, operation] Access the result along with the TransportOperation object # @yieldparam result [::Google::Cloud::ConfigService::V1::Statefile] # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Google::Cloud::ConfigService::V1::Statefile] # # @raise [::Google::Cloud::Error] if the REST call is aborted. # # @example Basic example # require "google/cloud/config_service/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::ConfigService::V1::Config::Rest::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::ConfigService::V1::ExportRevisionStatefileRequest.new # # # Call the export_revision_statefile method. # result = client.export_revision_statefile request # # # The returned object is of type Google::Cloud::ConfigService::V1::Statefile. # p result # def export_revision_statefile request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ConfigService::V1::ExportRevisionStatefileRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.export_revision_statefile.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::ConfigService::V1::VERSION, transports_version_send: [:rest] call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.export_revision_statefile.timeout, metadata: call_metadata, retry_policy: @config.rpcs.export_revision_statefile.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @config_stub.export_revision_statefile request, options do |result, operation| yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end ## # Imports Terraform state file in a given deployment. The state file does not # take effect until the Deployment has been unlocked. # # @overload import_statefile(request, options = nil) # Pass arguments to `import_statefile` via a request object, either of type # {::Google::Cloud::ConfigService::V1::ImportStatefileRequest} or an equivalent Hash. # # @param request [::Google::Cloud::ConfigService::V1::ImportStatefileRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries etc. Optional. # # @overload import_statefile(parent: nil, lock_id: nil, skip_draft: nil) # Pass arguments to `import_statefile` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param parent [::String] # Required. The parent in whose context the statefile is listed. The parent # value is in the format: # 'projects/\\{project_id}/locations/\\{location}/deployments/\\{deployment}'. # @param lock_id [::Integer] # Required. Lock ID of the lock file to verify that the user who is importing # the state file previously locked the Deployment. # @param skip_draft [::Boolean] # Optional. # @yield [result, operation] Access the result along with the TransportOperation object # @yieldparam result [::Google::Cloud::ConfigService::V1::Statefile] # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Google::Cloud::ConfigService::V1::Statefile] # # @raise [::Google::Cloud::Error] if the REST call is aborted. # # @example Basic example # require "google/cloud/config_service/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::ConfigService::V1::Config::Rest::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::ConfigService::V1::ImportStatefileRequest.new # # # Call the import_statefile method. # result = client.import_statefile request # # # The returned object is of type Google::Cloud::ConfigService::V1::Statefile. # p result # def import_statefile request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ConfigService::V1::ImportStatefileRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.import_statefile.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::ConfigService::V1::VERSION, transports_version_send: [:rest] call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.import_statefile.timeout, metadata: call_metadata, retry_policy: @config.rpcs.import_statefile.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @config_stub.import_statefile request, options do |result, operation| yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end ## # Deletes Terraform state file in a given deployment. # # @overload delete_statefile(request, options = nil) # Pass arguments to `delete_statefile` via a request object, either of type # {::Google::Cloud::ConfigService::V1::DeleteStatefileRequest} or an equivalent Hash. # # @param request [::Google::Cloud::ConfigService::V1::DeleteStatefileRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries etc. Optional. # # @overload delete_statefile(name: nil, lock_id: nil) # Pass arguments to `delete_statefile` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param name [::String] # Required. The name of the deployment in the format: # 'projects/\\{project_id}/locations/\\{location}/deployments/\\{deployment}'. # @param lock_id [::Integer] # Required. Lock ID of the lock file to verify that the user who is deleting # the state file previously locked the Deployment. # @yield [result, operation] Access the result along with the TransportOperation object # @yieldparam result [::Google::Protobuf::Empty] # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Google::Protobuf::Empty] # # @raise [::Google::Cloud::Error] if the REST call is aborted. # # @example Basic example # require "google/cloud/config_service/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::ConfigService::V1::Config::Rest::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::ConfigService::V1::DeleteStatefileRequest.new # # # Call the delete_statefile method. # result = client.delete_statefile request # # # The returned object is of type Google::Protobuf::Empty. # p result # def delete_statefile request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ConfigService::V1::DeleteStatefileRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.delete_statefile.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::ConfigService::V1::VERSION, transports_version_send: [:rest] call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.delete_statefile.timeout, metadata: call_metadata, retry_policy: @config.rpcs.delete_statefile.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @config_stub.delete_statefile request, options do |result, operation| yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end ## # Locks a deployment. # # @overload lock_deployment(request, options = nil) # Pass arguments to `lock_deployment` via a request object, either of type # {::Google::Cloud::ConfigService::V1::LockDeploymentRequest} or an equivalent Hash. # # @param request [::Google::Cloud::ConfigService::V1::LockDeploymentRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries etc. Optional. # # @overload lock_deployment(name: nil) # Pass arguments to `lock_deployment` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param name [::String] # Required. The name of the deployment in the format: # 'projects/\\{project_id}/locations/\\{location}/deployments/\\{deployment}'. # @yield [result, operation] Access the result along with the TransportOperation object # @yieldparam result [::Gapic::Operation] # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Gapic::Operation] # # @raise [::Google::Cloud::Error] if the REST call is aborted. # # @example Basic example # require "google/cloud/config_service/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::ConfigService::V1::Config::Rest::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::ConfigService::V1::LockDeploymentRequest.new # # # Call the lock_deployment method. # result = client.lock_deployment request # # # The returned object is of type Gapic::Operation. You can use it to # # check the status of an operation, cancel it, or wait for results. # # Here is how to wait for a response. # result.wait_until_done! timeout: 60 # if result.response? # p result.response # else # puts "No response received." # end # def lock_deployment request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ConfigService::V1::LockDeploymentRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.lock_deployment.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::ConfigService::V1::VERSION, transports_version_send: [:rest] call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.lock_deployment.timeout, metadata: call_metadata, retry_policy: @config.rpcs.lock_deployment.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @config_stub.lock_deployment request, options do |result, operation| result = ::Gapic::Operation.new result, @operations_client, options: options yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end ## # Unlocks a locked deployment. # # @overload unlock_deployment(request, options = nil) # Pass arguments to `unlock_deployment` via a request object, either of type # {::Google::Cloud::ConfigService::V1::UnlockDeploymentRequest} or an equivalent Hash. # # @param request [::Google::Cloud::ConfigService::V1::UnlockDeploymentRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries etc. Optional. # # @overload unlock_deployment(name: nil, lock_id: nil) # Pass arguments to `unlock_deployment` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param name [::String] # Required. The name of the deployment in the format: # 'projects/\\{project_id}/locations/\\{location}/deployments/\\{deployment}'. # @param lock_id [::Integer] # Required. Lock ID of the lock file to be unlocked. # @yield [result, operation] Access the result along with the TransportOperation object # @yieldparam result [::Gapic::Operation] # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Gapic::Operation] # # @raise [::Google::Cloud::Error] if the REST call is aborted. # # @example Basic example # require "google/cloud/config_service/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::ConfigService::V1::Config::Rest::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::ConfigService::V1::UnlockDeploymentRequest.new # # # Call the unlock_deployment method. # result = client.unlock_deployment request # # # The returned object is of type Gapic::Operation. You can use it to # # check the status of an operation, cancel it, or wait for results. # # Here is how to wait for a response. # result.wait_until_done! timeout: 60 # if result.response? # p result.response # else # puts "No response received." # end # def unlock_deployment request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ConfigService::V1::UnlockDeploymentRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.unlock_deployment.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::ConfigService::V1::VERSION, transports_version_send: [:rest] call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.unlock_deployment.timeout, metadata: call_metadata, retry_policy: @config.rpcs.unlock_deployment.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @config_stub.unlock_deployment request, options do |result, operation| result = ::Gapic::Operation.new result, @operations_client, options: options yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end ## # Exports the lock info on a locked deployment. # # @overload export_lock_info(request, options = nil) # Pass arguments to `export_lock_info` via a request object, either of type # {::Google::Cloud::ConfigService::V1::ExportLockInfoRequest} or an equivalent Hash. # # @param request [::Google::Cloud::ConfigService::V1::ExportLockInfoRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries etc. Optional. # # @overload export_lock_info(name: nil) # Pass arguments to `export_lock_info` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param name [::String] # Required. The name of the deployment in the format: # 'projects/\\{project_id}/locations/\\{location}/deployments/\\{deployment}'. # @yield [result, operation] Access the result along with the TransportOperation object # @yieldparam result [::Google::Cloud::ConfigService::V1::LockInfo] # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Google::Cloud::ConfigService::V1::LockInfo] # # @raise [::Google::Cloud::Error] if the REST call is aborted. # # @example Basic example # require "google/cloud/config_service/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::ConfigService::V1::Config::Rest::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::ConfigService::V1::ExportLockInfoRequest.new # # # Call the export_lock_info method. # result = client.export_lock_info request # # # The returned object is of type Google::Cloud::ConfigService::V1::LockInfo. # p result # def export_lock_info request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ConfigService::V1::ExportLockInfoRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.export_lock_info.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::ConfigService::V1::VERSION, transports_version_send: [:rest] call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.export_lock_info.timeout, metadata: call_metadata, retry_policy: @config.rpcs.export_lock_info.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @config_stub.export_lock_info request, options do |result, operation| yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end ## # Configuration class for the Config REST API. # # This class represents the configuration for Config REST, # providing control over timeouts, retry behavior, logging, transport # parameters, and other low-level controls. Certain parameters can also be # applied individually to specific RPCs. See # {::Google::Cloud::ConfigService::V1::Config::Rest::Client::Configuration::Rpcs} # for a list of RPCs that can be configured independently. # # Configuration can be applied globally to all clients, or to a single client # on construction. # # @example # # # Modify the global config, setting the timeout for # # list_deployments to 20 seconds, # # and all remaining timeouts to 10 seconds. # ::Google::Cloud::ConfigService::V1::Config::Rest::Client.configure do |config| # config.timeout = 10.0 # config.rpcs.list_deployments.timeout = 20.0 # end # # # Apply the above configuration only to a new client. # client = ::Google::Cloud::ConfigService::V1::Config::Rest::Client.new do |config| # config.timeout = 10.0 # config.rpcs.list_deployments.timeout = 20.0 # end # # @!attribute [rw] endpoint # The hostname or hostname:port of the service endpoint. # Defaults to `"config.googleapis.com"`. # @return [::String] # @!attribute [rw] credentials # Credentials to send with calls. You may provide any of the following types: # * (`String`) The path to a service account key file in JSON format # * (`Hash`) A service account key as a Hash # * (`Google::Auth::Credentials`) A googleauth credentials object # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials)) # * (`Signet::OAuth2::Client`) A signet oauth2 client object # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client)) # * (`nil`) indicating no credentials # @return [::Object] # @!attribute [rw] scope # The OAuth scopes # @return [::Array<::String>] # @!attribute [rw] lib_name # The library name as recorded in instrumentation and logging # @return [::String] # @!attribute [rw] lib_version # The library version as recorded in instrumentation and logging # @return [::String] # @!attribute [rw] timeout # The call timeout in seconds. # @return [::Numeric] # @!attribute [rw] metadata # Additional headers to be sent with the call. # @return [::Hash{::Symbol=>::String}] # @!attribute [rw] retry_policy # The retry policy. The value is a hash with the following keys: # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds. # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds. # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier. # * `:retry_codes` (*type:* `Array`) - The error codes that should # trigger a retry. # @return [::Hash] # @!attribute [rw] quota_project # A separate project against which to charge quota. # @return [::String] # class Configuration extend ::Gapic::Config DEFAULT_ENDPOINT = "config.googleapis.com" config_attr :endpoint, DEFAULT_ENDPOINT, ::String config_attr :credentials, nil do |value| allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil] allowed.any? { |klass| klass === value } end config_attr :scope, nil, ::String, ::Array, nil config_attr :lib_name, nil, ::String, nil config_attr :lib_version, nil, ::String, nil config_attr :timeout, nil, ::Numeric, nil config_attr :metadata, nil, ::Hash, nil config_attr :retry_policy, nil, ::Hash, ::Proc, nil config_attr :quota_project, nil, ::String, nil # @private # Overrides for http bindings for the RPCs of this service # are only used when this service is used as mixin, and only # by the host service. # @return [::Hash{::Symbol=>::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>}] config_attr :bindings_override, {}, ::Hash, nil # @private def initialize parent_config = nil @parent_config = parent_config unless parent_config.nil? yield self if block_given? end ## # Configurations for individual RPCs # @return [Rpcs] # def rpcs @rpcs ||= begin parent_rpcs = nil parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs) Rpcs.new parent_rpcs end end ## # Configuration RPC class for the Config API. # # Includes fields providing the configuration for each RPC in this service. # Each configuration object is of type `Gapic::Config::Method` and includes # the following configuration fields: # # * `timeout` (*type:* `Numeric`) - The call timeout in seconds # * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers # * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields # include the following keys: # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds. # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds. # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier. # * `:retry_codes` (*type:* `Array`) - The error codes that should # trigger a retry. # class Rpcs ## # RPC-specific configuration for `list_deployments` # @return [::Gapic::Config::Method] # attr_reader :list_deployments ## # RPC-specific configuration for `get_deployment` # @return [::Gapic::Config::Method] # attr_reader :get_deployment ## # RPC-specific configuration for `create_deployment` # @return [::Gapic::Config::Method] # attr_reader :create_deployment ## # RPC-specific configuration for `update_deployment` # @return [::Gapic::Config::Method] # attr_reader :update_deployment ## # RPC-specific configuration for `delete_deployment` # @return [::Gapic::Config::Method] # attr_reader :delete_deployment ## # RPC-specific configuration for `list_revisions` # @return [::Gapic::Config::Method] # attr_reader :list_revisions ## # RPC-specific configuration for `get_revision` # @return [::Gapic::Config::Method] # attr_reader :get_revision ## # RPC-specific configuration for `get_resource` # @return [::Gapic::Config::Method] # attr_reader :get_resource ## # RPC-specific configuration for `list_resources` # @return [::Gapic::Config::Method] # attr_reader :list_resources ## # RPC-specific configuration for `export_deployment_statefile` # @return [::Gapic::Config::Method] # attr_reader :export_deployment_statefile ## # RPC-specific configuration for `export_revision_statefile` # @return [::Gapic::Config::Method] # attr_reader :export_revision_statefile ## # RPC-specific configuration for `import_statefile` # @return [::Gapic::Config::Method] # attr_reader :import_statefile ## # RPC-specific configuration for `delete_statefile` # @return [::Gapic::Config::Method] # attr_reader :delete_statefile ## # RPC-specific configuration for `lock_deployment` # @return [::Gapic::Config::Method] # attr_reader :lock_deployment ## # RPC-specific configuration for `unlock_deployment` # @return [::Gapic::Config::Method] # attr_reader :unlock_deployment ## # RPC-specific configuration for `export_lock_info` # @return [::Gapic::Config::Method] # attr_reader :export_lock_info # @private def initialize parent_rpcs = nil list_deployments_config = parent_rpcs.list_deployments if parent_rpcs.respond_to? :list_deployments @list_deployments = ::Gapic::Config::Method.new list_deployments_config get_deployment_config = parent_rpcs.get_deployment if parent_rpcs.respond_to? :get_deployment @get_deployment = ::Gapic::Config::Method.new get_deployment_config create_deployment_config = parent_rpcs.create_deployment if parent_rpcs.respond_to? :create_deployment @create_deployment = ::Gapic::Config::Method.new create_deployment_config update_deployment_config = parent_rpcs.update_deployment if parent_rpcs.respond_to? :update_deployment @update_deployment = ::Gapic::Config::Method.new update_deployment_config delete_deployment_config = parent_rpcs.delete_deployment if parent_rpcs.respond_to? :delete_deployment @delete_deployment = ::Gapic::Config::Method.new delete_deployment_config list_revisions_config = parent_rpcs.list_revisions if parent_rpcs.respond_to? :list_revisions @list_revisions = ::Gapic::Config::Method.new list_revisions_config get_revision_config = parent_rpcs.get_revision if parent_rpcs.respond_to? :get_revision @get_revision = ::Gapic::Config::Method.new get_revision_config get_resource_config = parent_rpcs.get_resource if parent_rpcs.respond_to? :get_resource @get_resource = ::Gapic::Config::Method.new get_resource_config list_resources_config = parent_rpcs.list_resources if parent_rpcs.respond_to? :list_resources @list_resources = ::Gapic::Config::Method.new list_resources_config export_deployment_statefile_config = parent_rpcs.export_deployment_statefile if parent_rpcs.respond_to? :export_deployment_statefile @export_deployment_statefile = ::Gapic::Config::Method.new export_deployment_statefile_config export_revision_statefile_config = parent_rpcs.export_revision_statefile if parent_rpcs.respond_to? :export_revision_statefile @export_revision_statefile = ::Gapic::Config::Method.new export_revision_statefile_config import_statefile_config = parent_rpcs.import_statefile if parent_rpcs.respond_to? :import_statefile @import_statefile = ::Gapic::Config::Method.new import_statefile_config delete_statefile_config = parent_rpcs.delete_statefile if parent_rpcs.respond_to? :delete_statefile @delete_statefile = ::Gapic::Config::Method.new delete_statefile_config lock_deployment_config = parent_rpcs.lock_deployment if parent_rpcs.respond_to? :lock_deployment @lock_deployment = ::Gapic::Config::Method.new lock_deployment_config unlock_deployment_config = parent_rpcs.unlock_deployment if parent_rpcs.respond_to? :unlock_deployment @unlock_deployment = ::Gapic::Config::Method.new unlock_deployment_config export_lock_info_config = parent_rpcs.export_lock_info if parent_rpcs.respond_to? :export_lock_info @export_lock_info = ::Gapic::Config::Method.new export_lock_info_config yield self if block_given? end end end end end end end end end end