google-cloud-kms-v1 1.9.1 → 1.10.0

data/lib/google/cloud/kms/v1/hsm_management/rest/client.rb

@@ -0,0 +1,1380 @@
+# frozen_string_literal: true
+
+# Copyright 2026 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/kms/v1/hsm_management_pb"
+require "google/cloud/kms/v1/hsm_management/rest/service_stub"
+require "google/cloud/location/rest"
+require "google/iam/v1/rest"
+
+module Google
+  module Cloud
+    module Kms
+      module V1
+        module HsmManagement
+          module Rest
+            ##
+            # REST client for the HsmManagement service.
+            #
+            # Google Cloud HSM Management Service
+            #
+            # Provides interfaces for managing HSM instances.
+            #
+            # Implements a REST model with the following objects:
+            # * {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}
+            # * {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
+            #
+            class Client
+              # @private
+              API_VERSION = ""
+
+              # @private
+              DEFAULT_ENDPOINT_TEMPLATE = "cloudkms.$UNIVERSE_DOMAIN$"
+
+              include Paths
+
+              # @private
+              attr_reader :hsm_management_stub
+
+              ##
+              # Configure the HsmManagement Client class.
+              #
+              # See {::Google::Cloud::Kms::V1::HsmManagement::Rest::Client::Configuration}
+              # for a description of the configuration fields.
+              #
+              # @example
+              #
+              #   # Modify the configuration for all HsmManagement clients
+              #   ::Google::Cloud::Kms::V1::HsmManagement::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", "Kms", "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.rpcs.list_single_tenant_hsm_instances.timeout = 60.0
+                  default_config.rpcs.list_single_tenant_hsm_instances.retry_policy = {
+                    initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
+                  }
+
+                  default_config.rpcs.get_single_tenant_hsm_instance.timeout = 60.0
+                  default_config.rpcs.get_single_tenant_hsm_instance.retry_policy = {
+                    initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
+                  }
+
+                  default_config.rpcs.create_single_tenant_hsm_instance.timeout = 60.0
+                  default_config.rpcs.create_single_tenant_hsm_instance.retry_policy = {
+                    initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
+                  }
+
+                  default_config.rpcs.create_single_tenant_hsm_instance_proposal.timeout = 60.0
+                  default_config.rpcs.create_single_tenant_hsm_instance_proposal.retry_policy = {
+                    initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
+                  }
+
+                  default_config.rpcs.approve_single_tenant_hsm_instance_proposal.timeout = 60.0
+                  default_config.rpcs.approve_single_tenant_hsm_instance_proposal.retry_policy = {
+                    initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
+                  }
+
+                  default_config.rpcs.execute_single_tenant_hsm_instance_proposal.timeout = 60.0
+                  default_config.rpcs.execute_single_tenant_hsm_instance_proposal.retry_policy = {
+                    initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
+                  }
+
+                  default_config.rpcs.get_single_tenant_hsm_instance_proposal.timeout = 60.0
+                  default_config.rpcs.get_single_tenant_hsm_instance_proposal.retry_policy = {
+                    initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
+                  }
+
+                  default_config.rpcs.list_single_tenant_hsm_instance_proposals.timeout = 60.0
+                  default_config.rpcs.list_single_tenant_hsm_instance_proposals.retry_policy = {
+                    initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
+                  }
+
+                  default_config.rpcs.delete_single_tenant_hsm_instance_proposal.timeout = 60.0
+                  default_config.rpcs.delete_single_tenant_hsm_instance_proposal.retry_policy = {
+                    initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
+                  }
+
+                  default_config
+                end
+                yield @configure if block_given?
+                @configure
+              end
+
+              ##
+              # Configure the HsmManagement 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::Kms::V1::HsmManagement::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
+
+              ##
+              # The effective universe domain
+              #
+              # @return [String]
+              #
+              def universe_domain
+                @hsm_management_stub.universe_domain
+              end
+
+              ##
+              # Create a new HsmManagement REST client object.
+              #
+              # @example
+              #
+              #   # Create a client using the default configuration
+              #   client = ::Google::Cloud::Kms::V1::HsmManagement::Rest::Client.new
+              #
+              #   # Create a client using a custom configuration
+              #   client = ::Google::Cloud::Kms::V1::HsmManagement::Rest::Client.new do |config|
+              #     config.timeout = 10.0
+              #   end
+              #
+              # @yield [config] Configure the HsmManagement 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.nil? ||
+                                         (@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::Kms::V1::HsmManagement::Rest::Operations.new do |config|
+                  config.credentials = credentials
+                  config.quota_project = @quota_project_id
+                  config.endpoint = @config.endpoint
+                  config.universe_domain = @config.universe_domain
+                end
+
+                @hsm_management_stub = ::Google::Cloud::Kms::V1::HsmManagement::Rest::ServiceStub.new(
+                  endpoint: @config.endpoint,
+                  endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
+                  universe_domain: @config.universe_domain,
+                  credentials: credentials,
+                  logger: @config.logger
+                )
+
+                @hsm_management_stub.logger(stub: true)&.info do |entry|
+                  entry.set_system_name
+                  entry.set_service
+                  entry.message = "Created client for #{entry.service}"
+                  entry.set_credentials_fields credentials
+                  entry.set "customEndpoint", @config.endpoint if @config.endpoint
+                  entry.set "defaultTimeout", @config.timeout if @config.timeout
+                  entry.set "quotaProject", @quota_project_id if @quota_project_id
+                end
+
+                @location_client = Google::Cloud::Location::Locations::Rest::Client.new do |config|
+                  config.credentials = credentials
+                  config.quota_project = @quota_project_id
+                  config.endpoint = @hsm_management_stub.endpoint
+                  config.universe_domain = @hsm_management_stub.universe_domain
+                  config.bindings_override = @config.bindings_override
+                  config.logger = @hsm_management_stub.logger if config.respond_to? :logger=
+                end
+
+                @iam_policy_client = Google::Iam::V1::IAMPolicy::Rest::Client.new do |config|
+                  config.credentials = credentials
+                  config.quota_project = @quota_project_id
+                  config.endpoint = @hsm_management_stub.endpoint
+                  config.universe_domain = @hsm_management_stub.universe_domain
+                  config.bindings_override = @config.bindings_override
+                  config.logger = @hsm_management_stub.logger if config.respond_to? :logger=
+                end
+              end
+
+              ##
+              # Get the associated client for long-running operations.
+              #
+              # @return [::Google::Cloud::Kms::V1::HsmManagement::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
+
+              ##
+              # The logger used for request/response debug logging.
+              #
+              # @return [Logger]
+              #
+              def logger
+                @hsm_management_stub.logger
+              end
+
+              # Service calls
+
+              ##
+              # Lists
+              # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstances}.
+              #
+              # @overload list_single_tenant_hsm_instances(request, options = nil)
+              #   Pass arguments to `list_single_tenant_hsm_instances` via a request object, either of type
+              #   {::Google::Cloud::Kms::V1::ListSingleTenantHsmInstancesRequest} or an equivalent Hash.
+              #
+              #   @param request [::Google::Cloud::Kms::V1::ListSingleTenantHsmInstancesRequest, ::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_single_tenant_hsm_instances(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil, show_deleted: nil)
+              #   Pass arguments to `list_single_tenant_hsm_instances` 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 resource name of the location associated with the
+              #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstances} to
+              #     list, in the format `projects/*/locations/*`.
+              #   @param page_size [::Integer]
+              #     Optional. Optional limit on the number of
+              #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstances} to
+              #     include in the response. Further
+              #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstances} can
+              #     subsequently be
+              #     obtained by including the
+              #     {::Google::Cloud::Kms::V1::ListSingleTenantHsmInstancesResponse#next_page_token ListSingleTenantHsmInstancesResponse.next_page_token}
+              #     in a subsequent request. If unspecified, the server will pick an
+              #     appropriate default.
+              #   @param page_token [::String]
+              #     Optional. Optional pagination token, returned earlier via
+              #     {::Google::Cloud::Kms::V1::ListSingleTenantHsmInstancesResponse#next_page_token ListSingleTenantHsmInstancesResponse.next_page_token}.
+              #   @param filter [::String]
+              #     Optional. Only include resources that match the filter in the response. For
+              #     more information, see
+              #     [Sorting and filtering list
+              #     results](https://cloud.google.com/kms/docs/sorting-and-filtering).
+              #   @param order_by [::String]
+              #     Optional. Specify how the results should be sorted. If not specified, the
+              #     results will be sorted in the default order.  For more information, see
+              #     [Sorting and filtering list
+              #     results](https://cloud.google.com/kms/docs/sorting-and-filtering).
+              #   @param show_deleted [::Boolean]
+              #     Optional. If set to true,
+              #     {::Google::Cloud::Kms::V1::HsmManagement::Rest::Client#list_single_tenant_hsm_instances HsmManagement.ListSingleTenantHsmInstances}
+              #     will also return
+              #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstances} in
+              #     DELETED state.
+              # @yield [result, operation] Access the result along with the TransportOperation object
+              # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Kms::V1::SingleTenantHsmInstance>]
+              # @yieldparam operation [::Gapic::Rest::TransportOperation]
+              #
+              # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Kms::V1::SingleTenantHsmInstance>]
+              #
+              # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/kms/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Kms::V1::HsmManagement::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Kms::V1::ListSingleTenantHsmInstancesRequest.new
+              #
+              #   # Call the list_single_tenant_hsm_instances method.
+              #   result = client.list_single_tenant_hsm_instances 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::Kms::V1::SingleTenantHsmInstance.
+              #     p item
+              #   end
+              #
+              def list_single_tenant_hsm_instances request, options = nil
+                raise ::ArgumentError, "request must be provided" if request.nil?
+
+                request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Kms::V1::ListSingleTenantHsmInstancesRequest
+
+                # 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_single_tenant_hsm_instances.metadata.to_h
+
+                # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::Kms::V1::VERSION,
+                  transports_version_send: [:rest]
+
+                call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
+                call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+                options.apply_defaults timeout:      @config.rpcs.list_single_tenant_hsm_instances.timeout,
+                                       metadata:     call_metadata,
+                                       retry_policy: @config.rpcs.list_single_tenant_hsm_instances.retry_policy
+
+                options.apply_defaults timeout:      @config.timeout,
+                                       metadata:     @config.metadata,
+                                       retry_policy: @config.retry_policy
+
+                @hsm_management_stub.list_single_tenant_hsm_instances request, options do |result, operation|
+                  result = ::Gapic::Rest::PagedEnumerable.new @hsm_management_stub, :list_single_tenant_hsm_instances, "single_tenant_hsm_instances", request, result, options
+                  yield result, operation if block_given?
+                  throw :response, result
+                end
+              rescue ::Gapic::Rest::Error => e
+                raise ::Google::Cloud::Error.from_error(e)
+              end
+
+              ##
+              # Returns metadata for a given
+              # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
+              #
+              # @overload get_single_tenant_hsm_instance(request, options = nil)
+              #   Pass arguments to `get_single_tenant_hsm_instance` via a request object, either of type
+              #   {::Google::Cloud::Kms::V1::GetSingleTenantHsmInstanceRequest} or an equivalent Hash.
+              #
+              #   @param request [::Google::Cloud::Kms::V1::GetSingleTenantHsmInstanceRequest, ::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_single_tenant_hsm_instance(name: nil)
+              #   Pass arguments to `get_single_tenant_hsm_instance` 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 {::Google::Cloud::Kms::V1::SingleTenantHsmInstance#name name} of
+              #     the {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}
+              #     to get.
+              # @yield [result, operation] Access the result along with the TransportOperation object
+              # @yieldparam result [::Google::Cloud::Kms::V1::SingleTenantHsmInstance]
+              # @yieldparam operation [::Gapic::Rest::TransportOperation]
+              #
+              # @return [::Google::Cloud::Kms::V1::SingleTenantHsmInstance]
+              #
+              # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/kms/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Kms::V1::HsmManagement::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Kms::V1::GetSingleTenantHsmInstanceRequest.new
+              #
+              #   # Call the get_single_tenant_hsm_instance method.
+              #   result = client.get_single_tenant_hsm_instance request
+              #
+              #   # The returned object is of type Google::Cloud::Kms::V1::SingleTenantHsmInstance.
+              #   p result
+              #
+              def get_single_tenant_hsm_instance request, options = nil
+                raise ::ArgumentError, "request must be provided" if request.nil?
+
+                request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Kms::V1::GetSingleTenantHsmInstanceRequest
+
+                # 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_single_tenant_hsm_instance.metadata.to_h
+
+                # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::Kms::V1::VERSION,
+                  transports_version_send: [:rest]
+
+                call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
+                call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+                options.apply_defaults timeout:      @config.rpcs.get_single_tenant_hsm_instance.timeout,
+                                       metadata:     call_metadata,
+                                       retry_policy: @config.rpcs.get_single_tenant_hsm_instance.retry_policy
+
+                options.apply_defaults timeout:      @config.timeout,
+                                       metadata:     @config.metadata,
+                                       retry_policy: @config.retry_policy
+
+                @hsm_management_stub.get_single_tenant_hsm_instance request, options do |result, operation|
+                  yield result, operation if block_given?
+                end
+              rescue ::Gapic::Rest::Error => e
+                raise ::Google::Cloud::Error.from_error(e)
+              end
+
+              ##
+              # Creates a new
+              # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} in a
+              # given Project and Location. User must create a RegisterTwoFactorAuthKeys
+              # proposal with this single-tenant HSM instance to finish setup of the
+              # instance.
+              #
+              # @overload create_single_tenant_hsm_instance(request, options = nil)
+              #   Pass arguments to `create_single_tenant_hsm_instance` via a request object, either of type
+              #   {::Google::Cloud::Kms::V1::CreateSingleTenantHsmInstanceRequest} or an equivalent Hash.
+              #
+              #   @param request [::Google::Cloud::Kms::V1::CreateSingleTenantHsmInstanceRequest, ::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_single_tenant_hsm_instance(parent: nil, single_tenant_hsm_instance_id: nil, single_tenant_hsm_instance: nil)
+              #   Pass arguments to `create_single_tenant_hsm_instance` 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 resource name of the location associated with the
+              #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}, in
+              #     the format `projects/*/locations/*`.
+              #   @param single_tenant_hsm_instance_id [::String]
+              #     Optional. It must be unique within a location and match the regular
+              #     expression `[a-zA-Z0-9_-]{1,63}`.
+              #   @param single_tenant_hsm_instance [::Google::Cloud::Kms::V1::SingleTenantHsmInstance, ::Hash]
+              #     Required. An
+              #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} with
+              #     initial field values.
+              # @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/kms/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Kms::V1::HsmManagement::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Kms::V1::CreateSingleTenantHsmInstanceRequest.new
+              #
+              #   # Call the create_single_tenant_hsm_instance method.
+              #   result = client.create_single_tenant_hsm_instance 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_single_tenant_hsm_instance request, options = nil
+                raise ::ArgumentError, "request must be provided" if request.nil?
+
+                request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Kms::V1::CreateSingleTenantHsmInstanceRequest
+
+                # 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_single_tenant_hsm_instance.metadata.to_h
+
+                # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::Kms::V1::VERSION,
+                  transports_version_send: [:rest]
+
+                call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
+                call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+                options.apply_defaults timeout:      @config.rpcs.create_single_tenant_hsm_instance.timeout,
+                                       metadata:     call_metadata,
+                                       retry_policy: @config.rpcs.create_single_tenant_hsm_instance.retry_policy
+
+                options.apply_defaults timeout:      @config.timeout,
+                                       metadata:     @config.metadata,
+                                       retry_policy: @config.retry_policy
+
+                @hsm_management_stub.create_single_tenant_hsm_instance request, options do |result, operation|
+                  result = ::Gapic::Operation.new result, @operations_client, options: options
+                  yield result, operation if block_given?
+                  throw :response, result
+                end
+              rescue ::Gapic::Rest::Error => e
+                raise ::Google::Cloud::Error.from_error(e)
+              end
+
+              ##
+              # Creates a new
+              # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
+              # for a given
+              # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
+              #
+              # @overload create_single_tenant_hsm_instance_proposal(request, options = nil)
+              #   Pass arguments to `create_single_tenant_hsm_instance_proposal` via a request object, either of type
+              #   {::Google::Cloud::Kms::V1::CreateSingleTenantHsmInstanceProposalRequest} or an equivalent Hash.
+              #
+              #   @param request [::Google::Cloud::Kms::V1::CreateSingleTenantHsmInstanceProposalRequest, ::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_single_tenant_hsm_instance_proposal(parent: nil, single_tenant_hsm_instance_proposal_id: nil, single_tenant_hsm_instance_proposal: nil)
+              #   Pass arguments to `create_single_tenant_hsm_instance_proposal` 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 {::Google::Cloud::Kms::V1::SingleTenantHsmInstance#name name} of
+              #     the {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}
+              #     associated with the
+              #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposals}.
+              #   @param single_tenant_hsm_instance_proposal_id [::String]
+              #     Optional. It must be unique within a location and match the regular
+              #     expression `[a-zA-Z0-9_-]{1,63}`.
+              #   @param single_tenant_hsm_instance_proposal [::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal, ::Hash]
+              #     Required. The
+              #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
+              #     to create.
+              # @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/kms/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Kms::V1::HsmManagement::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Kms::V1::CreateSingleTenantHsmInstanceProposalRequest.new
+              #
+              #   # Call the create_single_tenant_hsm_instance_proposal method.
+              #   result = client.create_single_tenant_hsm_instance_proposal 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_single_tenant_hsm_instance_proposal request, options = nil
+                raise ::ArgumentError, "request must be provided" if request.nil?
+
+                request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Kms::V1::CreateSingleTenantHsmInstanceProposalRequest
+
+                # 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_single_tenant_hsm_instance_proposal.metadata.to_h
+
+                # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::Kms::V1::VERSION,
+                  transports_version_send: [:rest]
+
+                call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
+                call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+                options.apply_defaults timeout:      @config.rpcs.create_single_tenant_hsm_instance_proposal.timeout,
+                                       metadata:     call_metadata,
+                                       retry_policy: @config.rpcs.create_single_tenant_hsm_instance_proposal.retry_policy
+
+                options.apply_defaults timeout:      @config.timeout,
+                                       metadata:     @config.metadata,
+                                       retry_policy: @config.retry_policy
+
+                @hsm_management_stub.create_single_tenant_hsm_instance_proposal request, options do |result, operation|
+                  result = ::Gapic::Operation.new result, @operations_client, options: options
+                  yield result, operation if block_given?
+                  throw :response, result
+                end
+              rescue ::Gapic::Rest::Error => e
+                raise ::Google::Cloud::Error.from_error(e)
+              end
+
+              ##
+              # Approves a
+              # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
+              # for a given
+              # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}. The
+              # proposal must be in the
+              # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal::State::PENDING PENDING}
+              # state.
+              #
+              # @overload approve_single_tenant_hsm_instance_proposal(request, options = nil)
+              #   Pass arguments to `approve_single_tenant_hsm_instance_proposal` via a request object, either of type
+              #   {::Google::Cloud::Kms::V1::ApproveSingleTenantHsmInstanceProposalRequest} or an equivalent Hash.
+              #
+              #   @param request [::Google::Cloud::Kms::V1::ApproveSingleTenantHsmInstanceProposalRequest, ::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 approve_single_tenant_hsm_instance_proposal(name: nil, quorum_reply: nil, required_action_quorum_reply: nil)
+              #   Pass arguments to `approve_single_tenant_hsm_instance_proposal` 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
+              #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal#name name} of the
+              #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
+              #     to approve.
+              #   @param quorum_reply [::Google::Cloud::Kms::V1::ApproveSingleTenantHsmInstanceProposalRequest::QuorumReply, ::Hash]
+              #     Required. The reply to
+              #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal::QuorumParameters QuorumParameters}
+              #     for approving the proposal.
+              #
+              #     Note: The following parameters are mutually exclusive: `quorum_reply`, `required_action_quorum_reply`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
+              #   @param required_action_quorum_reply [::Google::Cloud::Kms::V1::ApproveSingleTenantHsmInstanceProposalRequest::RequiredActionQuorumReply, ::Hash]
+              #     Required. The reply to
+              #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal::RequiredActionQuorumParameters RequiredActionQuorumParameters}
+              #     for approving the proposal.
+              #
+              #     Note: The following parameters are mutually exclusive: `required_action_quorum_reply`, `quorum_reply`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
+              # @yield [result, operation] Access the result along with the TransportOperation object
+              # @yieldparam result [::Google::Cloud::Kms::V1::ApproveSingleTenantHsmInstanceProposalResponse]
+              # @yieldparam operation [::Gapic::Rest::TransportOperation]
+              #
+              # @return [::Google::Cloud::Kms::V1::ApproveSingleTenantHsmInstanceProposalResponse]
+              #
+              # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/kms/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Kms::V1::HsmManagement::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Kms::V1::ApproveSingleTenantHsmInstanceProposalRequest.new
+              #
+              #   # Call the approve_single_tenant_hsm_instance_proposal method.
+              #   result = client.approve_single_tenant_hsm_instance_proposal request
+              #
+              #   # The returned object is of type Google::Cloud::Kms::V1::ApproveSingleTenantHsmInstanceProposalResponse.
+              #   p result
+              #
+              def approve_single_tenant_hsm_instance_proposal request, options = nil
+                raise ::ArgumentError, "request must be provided" if request.nil?
+
+                request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Kms::V1::ApproveSingleTenantHsmInstanceProposalRequest
+
+                # 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.approve_single_tenant_hsm_instance_proposal.metadata.to_h
+
+                # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::Kms::V1::VERSION,
+                  transports_version_send: [:rest]
+
+                call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
+                call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+                options.apply_defaults timeout:      @config.rpcs.approve_single_tenant_hsm_instance_proposal.timeout,
+                                       metadata:     call_metadata,
+                                       retry_policy: @config.rpcs.approve_single_tenant_hsm_instance_proposal.retry_policy
+
+                options.apply_defaults timeout:      @config.timeout,
+                                       metadata:     @config.metadata,
+                                       retry_policy: @config.retry_policy
+
+                @hsm_management_stub.approve_single_tenant_hsm_instance_proposal request, options do |result, operation|
+                  yield result, operation if block_given?
+                end
+              rescue ::Gapic::Rest::Error => e
+                raise ::Google::Cloud::Error.from_error(e)
+              end
+
+              ##
+              # Executes a
+              # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
+              # for a given
+              # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}. The
+              # proposal must be in the
+              # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal::State::APPROVED APPROVED}
+              # state.
+              #
+              # @overload execute_single_tenant_hsm_instance_proposal(request, options = nil)
+              #   Pass arguments to `execute_single_tenant_hsm_instance_proposal` via a request object, either of type
+              #   {::Google::Cloud::Kms::V1::ExecuteSingleTenantHsmInstanceProposalRequest} or an equivalent Hash.
+              #
+              #   @param request [::Google::Cloud::Kms::V1::ExecuteSingleTenantHsmInstanceProposalRequest, ::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 execute_single_tenant_hsm_instance_proposal(name: nil)
+              #   Pass arguments to `execute_single_tenant_hsm_instance_proposal` 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
+              #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal#name name} of the
+              #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
+              #     to execute.
+              # @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/kms/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Kms::V1::HsmManagement::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Kms::V1::ExecuteSingleTenantHsmInstanceProposalRequest.new
+              #
+              #   # Call the execute_single_tenant_hsm_instance_proposal method.
+              #   result = client.execute_single_tenant_hsm_instance_proposal 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 execute_single_tenant_hsm_instance_proposal request, options = nil
+                raise ::ArgumentError, "request must be provided" if request.nil?
+
+                request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Kms::V1::ExecuteSingleTenantHsmInstanceProposalRequest
+
+                # 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.execute_single_tenant_hsm_instance_proposal.metadata.to_h
+
+                # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::Kms::V1::VERSION,
+                  transports_version_send: [:rest]
+
+                call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
+                call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+                options.apply_defaults timeout:      @config.rpcs.execute_single_tenant_hsm_instance_proposal.timeout,
+                                       metadata:     call_metadata,
+                                       retry_policy: @config.rpcs.execute_single_tenant_hsm_instance_proposal.retry_policy
+
+                options.apply_defaults timeout:      @config.timeout,
+                                       metadata:     @config.metadata,
+                                       retry_policy: @config.retry_policy
+
+                @hsm_management_stub.execute_single_tenant_hsm_instance_proposal request, options do |result, operation|
+                  result = ::Gapic::Operation.new result, @operations_client, options: options
+                  yield result, operation if block_given?
+                  throw :response, result
+                end
+              rescue ::Gapic::Rest::Error => e
+                raise ::Google::Cloud::Error.from_error(e)
+              end
+
+              ##
+              # Returns metadata for a given
+              # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}.
+              #
+              # @overload get_single_tenant_hsm_instance_proposal(request, options = nil)
+              #   Pass arguments to `get_single_tenant_hsm_instance_proposal` via a request object, either of type
+              #   {::Google::Cloud::Kms::V1::GetSingleTenantHsmInstanceProposalRequest} or an equivalent Hash.
+              #
+              #   @param request [::Google::Cloud::Kms::V1::GetSingleTenantHsmInstanceProposalRequest, ::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_single_tenant_hsm_instance_proposal(name: nil)
+              #   Pass arguments to `get_single_tenant_hsm_instance_proposal` 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
+              #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal#name name} of the
+              #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
+              #     to get.
+              # @yield [result, operation] Access the result along with the TransportOperation object
+              # @yieldparam result [::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal]
+              # @yieldparam operation [::Gapic::Rest::TransportOperation]
+              #
+              # @return [::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal]
+              #
+              # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/kms/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Kms::V1::HsmManagement::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Kms::V1::GetSingleTenantHsmInstanceProposalRequest.new
+              #
+              #   # Call the get_single_tenant_hsm_instance_proposal method.
+              #   result = client.get_single_tenant_hsm_instance_proposal request
+              #
+              #   # The returned object is of type Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal.
+              #   p result
+              #
+              def get_single_tenant_hsm_instance_proposal request, options = nil
+                raise ::ArgumentError, "request must be provided" if request.nil?
+
+                request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Kms::V1::GetSingleTenantHsmInstanceProposalRequest
+
+                # 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_single_tenant_hsm_instance_proposal.metadata.to_h
+
+                # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::Kms::V1::VERSION,
+                  transports_version_send: [:rest]
+
+                call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
+                call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+                options.apply_defaults timeout:      @config.rpcs.get_single_tenant_hsm_instance_proposal.timeout,
+                                       metadata:     call_metadata,
+                                       retry_policy: @config.rpcs.get_single_tenant_hsm_instance_proposal.retry_policy
+
+                options.apply_defaults timeout:      @config.timeout,
+                                       metadata:     @config.metadata,
+                                       retry_policy: @config.retry_policy
+
+                @hsm_management_stub.get_single_tenant_hsm_instance_proposal request, options do |result, operation|
+                  yield result, operation if block_given?
+                end
+              rescue ::Gapic::Rest::Error => e
+                raise ::Google::Cloud::Error.from_error(e)
+              end
+
+              ##
+              # Lists
+              # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposals}.
+              #
+              # @overload list_single_tenant_hsm_instance_proposals(request, options = nil)
+              #   Pass arguments to `list_single_tenant_hsm_instance_proposals` via a request object, either of type
+              #   {::Google::Cloud::Kms::V1::ListSingleTenantHsmInstanceProposalsRequest} or an equivalent Hash.
+              #
+              #   @param request [::Google::Cloud::Kms::V1::ListSingleTenantHsmInstanceProposalsRequest, ::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_single_tenant_hsm_instance_proposals(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil, show_deleted: nil)
+              #   Pass arguments to `list_single_tenant_hsm_instance_proposals` 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 resource name of the single tenant HSM instance associated
+              #     with the
+              #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposals}
+              #     to list, in the format `projects/*/locations/*/singleTenantHsmInstances/*`.
+              #   @param page_size [::Integer]
+              #     Optional. Optional limit on the number of
+              #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposals}
+              #     to include in the response. Further
+              #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposals}
+              #     can subsequently be obtained by including the
+              #     {::Google::Cloud::Kms::V1::ListSingleTenantHsmInstanceProposalsResponse#next_page_token ListSingleTenantHsmInstanceProposalsResponse.next_page_token}
+              #     in a subsequent request. If unspecified, the server will pick an
+              #     appropriate default.
+              #   @param page_token [::String]
+              #     Optional. Optional pagination token, returned earlier via
+              #     {::Google::Cloud::Kms::V1::ListSingleTenantHsmInstanceProposalsResponse#next_page_token ListSingleTenantHsmInstanceProposalsResponse.next_page_token}.
+              #   @param filter [::String]
+              #     Optional. Only include resources that match the filter in the response. For
+              #     more information, see
+              #     [Sorting and filtering list
+              #     results](https://cloud.google.com/kms/docs/sorting-and-filtering).
+              #   @param order_by [::String]
+              #     Optional. Specify how the results should be sorted. If not specified, the
+              #     results will be sorted in the default order.  For more information, see
+              #     [Sorting and filtering list
+              #     results](https://cloud.google.com/kms/docs/sorting-and-filtering).
+              #   @param show_deleted [::Boolean]
+              #     Optional. If set to true,
+              #     {::Google::Cloud::Kms::V1::HsmManagement::Rest::Client#list_single_tenant_hsm_instance_proposals HsmManagement.ListSingleTenantHsmInstanceProposals}
+              #     will also return
+              #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposals}
+              #     in DELETED state.
+              # @yield [result, operation] Access the result along with the TransportOperation object
+              # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal>]
+              # @yieldparam operation [::Gapic::Rest::TransportOperation]
+              #
+              # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal>]
+              #
+              # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/kms/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Kms::V1::HsmManagement::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Kms::V1::ListSingleTenantHsmInstanceProposalsRequest.new
+              #
+              #   # Call the list_single_tenant_hsm_instance_proposals method.
+              #   result = client.list_single_tenant_hsm_instance_proposals 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::Kms::V1::SingleTenantHsmInstanceProposal.
+              #     p item
+              #   end
+              #
+              def list_single_tenant_hsm_instance_proposals request, options = nil
+                raise ::ArgumentError, "request must be provided" if request.nil?
+
+                request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Kms::V1::ListSingleTenantHsmInstanceProposalsRequest
+
+                # 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_single_tenant_hsm_instance_proposals.metadata.to_h
+
+                # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::Kms::V1::VERSION,
+                  transports_version_send: [:rest]
+
+                call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
+                call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+                options.apply_defaults timeout:      @config.rpcs.list_single_tenant_hsm_instance_proposals.timeout,
+                                       metadata:     call_metadata,
+                                       retry_policy: @config.rpcs.list_single_tenant_hsm_instance_proposals.retry_policy
+
+                options.apply_defaults timeout:      @config.timeout,
+                                       metadata:     @config.metadata,
+                                       retry_policy: @config.retry_policy
+
+                @hsm_management_stub.list_single_tenant_hsm_instance_proposals request, options do |result, operation|
+                  result = ::Gapic::Rest::PagedEnumerable.new @hsm_management_stub, :list_single_tenant_hsm_instance_proposals, "single_tenant_hsm_instance_proposals", request, result, options
+                  yield result, operation if block_given?
+                  throw :response, result
+                end
+              rescue ::Gapic::Rest::Error => e
+                raise ::Google::Cloud::Error.from_error(e)
+              end
+
+              ##
+              # Deletes a
+              # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}.
+              #
+              # @overload delete_single_tenant_hsm_instance_proposal(request, options = nil)
+              #   Pass arguments to `delete_single_tenant_hsm_instance_proposal` via a request object, either of type
+              #   {::Google::Cloud::Kms::V1::DeleteSingleTenantHsmInstanceProposalRequest} or an equivalent Hash.
+              #
+              #   @param request [::Google::Cloud::Kms::V1::DeleteSingleTenantHsmInstanceProposalRequest, ::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_single_tenant_hsm_instance_proposal(name: nil)
+              #   Pass arguments to `delete_single_tenant_hsm_instance_proposal` 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
+              #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal#name name} of the
+              #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
+              #     to delete.
+              # @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/kms/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Kms::V1::HsmManagement::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Kms::V1::DeleteSingleTenantHsmInstanceProposalRequest.new
+              #
+              #   # Call the delete_single_tenant_hsm_instance_proposal method.
+              #   result = client.delete_single_tenant_hsm_instance_proposal request
+              #
+              #   # The returned object is of type Google::Protobuf::Empty.
+              #   p result
+              #
+              def delete_single_tenant_hsm_instance_proposal request, options = nil
+                raise ::ArgumentError, "request must be provided" if request.nil?
+
+                request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Kms::V1::DeleteSingleTenantHsmInstanceProposalRequest
+
+                # 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_single_tenant_hsm_instance_proposal.metadata.to_h
+
+                # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::Kms::V1::VERSION,
+                  transports_version_send: [:rest]
+
+                call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
+                call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+                options.apply_defaults timeout:      @config.rpcs.delete_single_tenant_hsm_instance_proposal.timeout,
+                                       metadata:     call_metadata,
+                                       retry_policy: @config.rpcs.delete_single_tenant_hsm_instance_proposal.retry_policy
+
+                options.apply_defaults timeout:      @config.timeout,
+                                       metadata:     @config.metadata,
+                                       retry_policy: @config.retry_policy
+
+                @hsm_management_stub.delete_single_tenant_hsm_instance_proposal request, options do |result, operation|
+                  yield result, operation if block_given?
+                end
+              rescue ::Gapic::Rest::Error => e
+                raise ::Google::Cloud::Error.from_error(e)
+              end
+
+              ##
+              # Configuration class for the HsmManagement REST API.
+              #
+              # This class represents the configuration for HsmManagement 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::Kms::V1::HsmManagement::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_single_tenant_hsm_instances to 20 seconds,
+              #   # and all remaining timeouts to 10 seconds.
+              #   ::Google::Cloud::Kms::V1::HsmManagement::Rest::Client.configure do |config|
+              #     config.timeout = 10.0
+              #     config.rpcs.list_single_tenant_hsm_instances.timeout = 20.0
+              #   end
+              #
+              #   # Apply the above configuration only to a new client.
+              #   client = ::Google::Cloud::Kms::V1::HsmManagement::Rest::Client.new do |config|
+              #     config.timeout = 10.0
+              #     config.rpcs.list_single_tenant_hsm_instances.timeout = 20.0
+              #   end
+              #
+              # @!attribute [rw] endpoint
+              #   A custom service endpoint, as a hostname or hostname:port. The default is
+              #   nil, indicating to use the default endpoint in the current universe domain.
+              #   @return [::String,nil]
+              # @!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
+              #
+              #   Warning: If you accept a credential configuration (JSON file or Hash) from an
+              #   external source for authentication to Google Cloud, you must validate it before
+              #   providing it to a Google API client library. Providing an unvalidated credential
+              #   configuration to Google APIs can compromise the security of your systems and data.
+              #   For more information, refer to [Validate credential configurations from external
+              #   sources](https://cloud.google.com/docs/authentication/external/externally-sourced-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<String>`) - The error codes that should
+              #       trigger a retry.
+              #   @return [::Hash]
+              # @!attribute [rw] quota_project
+              #   A separate project against which to charge quota.
+              #   @return [::String]
+              # @!attribute [rw] universe_domain
+              #   The universe domain within which to make requests. This determines the
+              #   default endpoint URL. The default value of nil uses the environment
+              #   universe (usually the default "googleapis.com" universe).
+              #   @return [::String,nil]
+              # @!attribute [rw] logger
+              #   A custom logger to use for request/response debug logging, or the value
+              #   `:default` (the default) to construct a default logger, or `nil` to
+              #   explicitly disable logging.
+              #   @return [::Logger,:default,nil]
+              #
+              class Configuration
+                extend ::Gapic::Config
+
+                # @private
+                # The endpoint specific to the default "googleapis.com" universe. Deprecated.
+                DEFAULT_ENDPOINT = "cloudkms.googleapis.com"
+
+                config_attr :endpoint,      nil, ::String, nil
+                config_attr :credentials,   nil do |value|
+                  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Google::Auth::BaseClient, ::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
+                config_attr :universe_domain, 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
+                config_attr :logger, :default, ::Logger, nil, :default
+
+                # @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 HsmManagement 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<String>`) - The error codes that should
+                #         trigger a retry.
+                #
+                class Rpcs
+                  ##
+                  # RPC-specific configuration for `list_single_tenant_hsm_instances`
+                  # @return [::Gapic::Config::Method]
+                  #
+                  attr_reader :list_single_tenant_hsm_instances
+                  ##
+                  # RPC-specific configuration for `get_single_tenant_hsm_instance`
+                  # @return [::Gapic::Config::Method]
+                  #
+                  attr_reader :get_single_tenant_hsm_instance
+                  ##
+                  # RPC-specific configuration for `create_single_tenant_hsm_instance`
+                  # @return [::Gapic::Config::Method]
+                  #
+                  attr_reader :create_single_tenant_hsm_instance
+                  ##
+                  # RPC-specific configuration for `create_single_tenant_hsm_instance_proposal`
+                  # @return [::Gapic::Config::Method]
+                  #
+                  attr_reader :create_single_tenant_hsm_instance_proposal
+                  ##
+                  # RPC-specific configuration for `approve_single_tenant_hsm_instance_proposal`
+                  # @return [::Gapic::Config::Method]
+                  #
+                  attr_reader :approve_single_tenant_hsm_instance_proposal
+                  ##
+                  # RPC-specific configuration for `execute_single_tenant_hsm_instance_proposal`
+                  # @return [::Gapic::Config::Method]
+                  #
+                  attr_reader :execute_single_tenant_hsm_instance_proposal
+                  ##
+                  # RPC-specific configuration for `get_single_tenant_hsm_instance_proposal`
+                  # @return [::Gapic::Config::Method]
+                  #
+                  attr_reader :get_single_tenant_hsm_instance_proposal
+                  ##
+                  # RPC-specific configuration for `list_single_tenant_hsm_instance_proposals`
+                  # @return [::Gapic::Config::Method]
+                  #
+                  attr_reader :list_single_tenant_hsm_instance_proposals
+                  ##
+                  # RPC-specific configuration for `delete_single_tenant_hsm_instance_proposal`
+                  # @return [::Gapic::Config::Method]
+                  #
+                  attr_reader :delete_single_tenant_hsm_instance_proposal
+
+                  # @private
+                  def initialize parent_rpcs = nil
+                    list_single_tenant_hsm_instances_config = parent_rpcs.list_single_tenant_hsm_instances if parent_rpcs.respond_to? :list_single_tenant_hsm_instances
+                    @list_single_tenant_hsm_instances = ::Gapic::Config::Method.new list_single_tenant_hsm_instances_config
+                    get_single_tenant_hsm_instance_config = parent_rpcs.get_single_tenant_hsm_instance if parent_rpcs.respond_to? :get_single_tenant_hsm_instance
+                    @get_single_tenant_hsm_instance = ::Gapic::Config::Method.new get_single_tenant_hsm_instance_config
+                    create_single_tenant_hsm_instance_config = parent_rpcs.create_single_tenant_hsm_instance if parent_rpcs.respond_to? :create_single_tenant_hsm_instance
+                    @create_single_tenant_hsm_instance = ::Gapic::Config::Method.new create_single_tenant_hsm_instance_config
+                    create_single_tenant_hsm_instance_proposal_config = parent_rpcs.create_single_tenant_hsm_instance_proposal if parent_rpcs.respond_to? :create_single_tenant_hsm_instance_proposal
+                    @create_single_tenant_hsm_instance_proposal = ::Gapic::Config::Method.new create_single_tenant_hsm_instance_proposal_config
+                    approve_single_tenant_hsm_instance_proposal_config = parent_rpcs.approve_single_tenant_hsm_instance_proposal if parent_rpcs.respond_to? :approve_single_tenant_hsm_instance_proposal
+                    @approve_single_tenant_hsm_instance_proposal = ::Gapic::Config::Method.new approve_single_tenant_hsm_instance_proposal_config
+                    execute_single_tenant_hsm_instance_proposal_config = parent_rpcs.execute_single_tenant_hsm_instance_proposal if parent_rpcs.respond_to? :execute_single_tenant_hsm_instance_proposal
+                    @execute_single_tenant_hsm_instance_proposal = ::Gapic::Config::Method.new execute_single_tenant_hsm_instance_proposal_config
+                    get_single_tenant_hsm_instance_proposal_config = parent_rpcs.get_single_tenant_hsm_instance_proposal if parent_rpcs.respond_to? :get_single_tenant_hsm_instance_proposal
+                    @get_single_tenant_hsm_instance_proposal = ::Gapic::Config::Method.new get_single_tenant_hsm_instance_proposal_config
+                    list_single_tenant_hsm_instance_proposals_config = parent_rpcs.list_single_tenant_hsm_instance_proposals if parent_rpcs.respond_to? :list_single_tenant_hsm_instance_proposals
+                    @list_single_tenant_hsm_instance_proposals = ::Gapic::Config::Method.new list_single_tenant_hsm_instance_proposals_config
+                    delete_single_tenant_hsm_instance_proposal_config = parent_rpcs.delete_single_tenant_hsm_instance_proposal if parent_rpcs.respond_to? :delete_single_tenant_hsm_instance_proposal
+                    @delete_single_tenant_hsm_instance_proposal = ::Gapic::Config::Method.new delete_single_tenant_hsm_instance_proposal_config
+
+                    yield self if block_given?
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end