google-cloud-kms-v1 0.16.0 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88ccb6ea1616c6e3d3e167aaf3d0e81795d897a8f07922ceb7fccfe0be5c1baa
-  data.tar.gz: 2d635e795aef36e90ff5fa04ab772fc982e6ec30d3855a8741d358edbee26809
+  metadata.gz: 5dd007295b6f2ec2dbd524910385762136fa4c92827ae2bf146dea3cd986395b
+  data.tar.gz: dad1b2dd3104df2b1169aaf28b420409be257c25430fb53a94b032f30c1b932e
 SHA512:
-  metadata.gz: ffcdda5aafc0cc3bef3e4b1dba6fea52819d282bf6af6a3d085802e2c447f5116c053d80fbc8978ee2540ed178ae5d9efbbf5316adf06f79ccfa641a30044e05
-  data.tar.gz: c16e58ed43dae8dbdafed46b687864cf1241dbc50ddec764406928cb9e702a30362d2862a63c6419f955f869bc28a8362fa1a1f51770acb79a6a075270927034
+  metadata.gz: 3fcf9e9fedafc0005219bece87a5167fa96968560a659cc2d0ea68b272500933caf80435c665ee54e48c8c5b0551149ba60d98ff4869176067d85b7fc02bc04c
+  data.tar.gz: 6fb8eeb103261677363b217ba3e36e49a9815c64ac9afa0ff82d0b450fa9aeef89f91b24d35bef13333f702786fcdbbf2fb3b89ed338bec9ed5ebf80a909a73e

data/README.md

@@ -1,6 +1,6 @@
 # Ruby Client for the Cloud Key Management Service (KMS) V1 API
 
-API Client library for the Cloud Key Management Service (KMS) V1 API
+Manages keys and performs cryptographic operations in a central cloud service, for direct use by other cloud resources and applications.
 
 Manages keys and performs cryptographic operations in a central cloud service, for direct use by other cloud resources and applications.
 

data/lib/google/cloud/kms/v1/bindings_override.rb

@@ -0,0 +1,231 @@
+# 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 "gapic/config"
+
+module Google
+  module Cloud
+    module Kms
+      ##
+      # @example Loading just the REST part of this package, including all its services, and instantiating a REST client
+      #
+      #     require "google/cloud/kms/v1/rest"
+      #     client = ::Google::Cloud::Kms::V1::EkmService::Rest::Client.new
+      #
+      module V1
+        ##
+        # @private
+        # Initialize the mixin bindings configuration
+        #
+        def self.configure
+          @configure ||= begin
+            namespace = ["Google", "Cloud", "Kms"]
+            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 = Configuration.new parent_config
+            default_config.bindings_override["google.cloud.location.Locations.GetLocation"] = [
+              Gapic::Rest::GrpcTranscoder::HttpBinding.create_with_validation(
+                uri_method: :get,
+                uri_template: "/v1/{name}",
+                matches: [
+                  ["name", %r{^projects/[^/]+/locations/[^/]+/?$}, false]
+                ],
+                body: nil
+              )
+            ]
+            default_config.bindings_override["google.cloud.location.Locations.ListLocations"] = [
+
+              Gapic::Rest::GrpcTranscoder::HttpBinding.create_with_validation(
+                uri_method: :get,
+                uri_template: "/v1/{name}/locations",
+                matches: [
+                  ["name", %r{^projects/[^/]+/?$}, false]
+                ],
+                body: nil
+              )
+            ]
+            default_config.bindings_override["google.iam.v1.IAMPolicy.GetIamPolicy"] = [
+
+              Gapic::Rest::GrpcTranscoder::HttpBinding.create_with_validation(
+                uri_method: :get,
+                uri_template: "/v1/{resource}:getIamPolicy",
+                matches: [
+                  ["resource", %r{^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/?$}, false]
+                ],
+                body: nil
+              ),
+              Gapic::Rest::GrpcTranscoder::HttpBinding.create_with_validation(
+                uri_method: :get,
+                uri_template: "/v1/{resource}:getIamPolicy",
+                matches: [
+                  ["resource", %r{^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/?$}, false]
+                ],
+                body: nil
+              ),
+              Gapic::Rest::GrpcTranscoder::HttpBinding.create_with_validation(
+                uri_method: :get,
+                uri_template: "/v1/{resource}:getIamPolicy",
+                matches: [
+                  ["resource", %r{^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/importJobs/[^/]+/?$}, false]
+                ],
+                body: nil
+              ),
+              Gapic::Rest::GrpcTranscoder::HttpBinding.create_with_validation(
+                uri_method: :get,
+                uri_template: "/v1/{resource}:getIamPolicy",
+                matches: [
+                  ["resource", %r{^projects/[^/]+/locations/[^/]+/ekmConfig/?$}, false]
+                ],
+                body: nil
+              ),
+              Gapic::Rest::GrpcTranscoder::HttpBinding.create_with_validation(
+                uri_method: :get,
+                uri_template: "/v1/{resource}:getIamPolicy",
+                matches: [
+                  ["resource", %r{^projects/[^/]+/locations/[^/]+/ekmConnections/[^/]+/?$}, false]
+                ],
+                body: nil
+              )
+            ]
+            default_config.bindings_override["google.iam.v1.IAMPolicy.SetIamPolicy"] = [
+
+              Gapic::Rest::GrpcTranscoder::HttpBinding.create_with_validation(
+                uri_method: :post,
+                uri_template: "/v1/{resource}:setIamPolicy",
+                matches: [
+                  ["resource", %r{^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/?$}, false]
+                ],
+                body: "*"
+              ),
+              Gapic::Rest::GrpcTranscoder::HttpBinding.create_with_validation(
+                uri_method: :post,
+                uri_template: "/v1/{resource}:setIamPolicy",
+                matches: [
+                  ["resource", %r{^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/?$}, false]
+                ],
+                body: "*"
+              ),
+              Gapic::Rest::GrpcTranscoder::HttpBinding.create_with_validation(
+                uri_method: :post,
+                uri_template: "/v1/{resource}:setIamPolicy",
+                matches: [
+                  ["resource", %r{^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/importJobs/[^/]+/?$}, false]
+                ],
+                body: "*"
+              ),
+              Gapic::Rest::GrpcTranscoder::HttpBinding.create_with_validation(
+                uri_method: :post,
+                uri_template: "/v1/{resource}:setIamPolicy",
+                matches: [
+                  ["resource", %r{^projects/[^/]+/locations/[^/]+/ekmConfig/?$}, false]
+                ],
+                body: "*"
+              ),
+              Gapic::Rest::GrpcTranscoder::HttpBinding.create_with_validation(
+                uri_method: :post,
+                uri_template: "/v1/{resource}:setIamPolicy",
+                matches: [
+                  ["resource", %r{^projects/[^/]+/locations/[^/]+/ekmConnections/[^/]+/?$}, false]
+                ],
+                body: "*"
+              )
+            ]
+            default_config.bindings_override["google.iam.v1.IAMPolicy.TestIamPermissions"] = [
+
+              Gapic::Rest::GrpcTranscoder::HttpBinding.create_with_validation(
+                uri_method: :post,
+                uri_template: "/v1/{resource}:testIamPermissions",
+                matches: [
+                  ["resource", %r{^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/?$}, false]
+                ],
+                body: "*"
+              ),
+              Gapic::Rest::GrpcTranscoder::HttpBinding.create_with_validation(
+                uri_method: :post,
+                uri_template: "/v1/{resource}:testIamPermissions",
+                matches: [
+                  ["resource", %r{^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/?$}, false]
+                ],
+                body: "*"
+              ),
+              Gapic::Rest::GrpcTranscoder::HttpBinding.create_with_validation(
+                uri_method: :post,
+                uri_template: "/v1/{resource}:testIamPermissions",
+                matches: [
+                  ["resource", %r{^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/importJobs/[^/]+/?$}, false]
+                ],
+                body: "*"
+              ),
+              Gapic::Rest::GrpcTranscoder::HttpBinding.create_with_validation(
+                uri_method: :post,
+                uri_template: "/v1/{resource}:testIamPermissions",
+                matches: [
+                  ["resource", %r{^projects/[^/]+/locations/[^/]+/ekmConfig/?$}, false]
+                ],
+                body: "*"
+              ),
+              Gapic::Rest::GrpcTranscoder::HttpBinding.create_with_validation(
+                uri_method: :post,
+                uri_template: "/v1/{resource}:testIamPermissions",
+                matches: [
+                  ["resource", %r{^projects/[^/]+/locations/[^/]+/ekmConnections/[^/]+/?$}, false]
+                ],
+                body: "*"
+              )
+            ]
+            default_config
+          end
+          yield @configure if block_given?
+          @configure
+        end
+
+        ##
+        # @private
+        # Configuration class for the google.cloud.kms.v1 package.
+        #
+        # This class contains common configuration for all services
+        # of the google.cloud.kms.v1 package.
+        #
+        # This configuration is for internal use of the client library classes,
+        # and it is not intended that the end-users will read or change it.
+        #
+        class Configuration
+          extend ::Gapic::Config
+
+          # @private
+          # Overrides for http bindings for the RPC of the mixins for this package.
+          # Services in this package should use these when creating clients for the mixin services.
+          # @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
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/kms/v1/ekm_service/client.rb

@@ -260,13 +260,11 @@ module Google
             #   # Call the list_ekm_connections method.
             #   result = client.list_ekm_connections request
             #
-            #   # The returned object is of type Gapic::PagedEnumerable. You can
-            #   # iterate over all elements by calling #each, and the enumerable
-            #   # will lazily make API calls to fetch subsequent pages. Other
-            #   # methods are also available for managing paging directly.
-            #   result.each do |response|
+            #   # 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::EkmConnection.
-            #     p response
+            #     p item
             #   end
             #
             def list_ekm_connections request, options = nil
@@ -580,6 +578,181 @@ module Google
               raise ::Google::Cloud::Error.from_error(e)
             end
 
+            ##
+            # Returns the {::Google::Cloud::Kms::V1::EkmConfig EkmConfig} singleton resource
+            # for a given project and location.
+            #
+            # @overload get_ekm_config(request, options = nil)
+            #   Pass arguments to `get_ekm_config` via a request object, either of type
+            #   {::Google::Cloud::Kms::V1::GetEkmConfigRequest} or an equivalent Hash.
+            #
+            #   @param request [::Google::Cloud::Kms::V1::GetEkmConfigRequest, ::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_ekm_config(name: nil)
+            #   Pass arguments to `get_ekm_config` 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::EkmConfig#name name} of the
+            #     {::Google::Cloud::Kms::V1::EkmConfig EkmConfig} to get.
+            #
+            # @yield [response, operation] Access the result along with the RPC operation
+            # @yieldparam response [::Google::Cloud::Kms::V1::EkmConfig]
+            # @yieldparam operation [::GRPC::ActiveCall::Operation]
+            #
+            # @return [::Google::Cloud::Kms::V1::EkmConfig]
+            #
+            # @raise [::Google::Cloud::Error] if the RPC 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::EkmService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Kms::V1::GetEkmConfigRequest.new
+            #
+            #   # Call the get_ekm_config method.
+            #   result = client.get_ekm_config request
+            #
+            #   # The returned object is of type Google::Cloud::Kms::V1::EkmConfig.
+            #   p result
+            #
+            def get_ekm_config request, options = nil
+              raise ::ArgumentError, "request must be provided" if request.nil?
+
+              request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Kms::V1::GetEkmConfigRequest
+
+              # 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
+              metadata = @config.rpcs.get_ekm_config.metadata.to_h
+
+              # Set x-goog-api-client and x-goog-user-project headers
+              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
+              metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+              header_params = {}
+              if request.name
+                header_params["name"] = request.name
+              end
+
+              request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
+              metadata[:"x-goog-request-params"] ||= request_params_header
+
+              options.apply_defaults timeout:      @config.rpcs.get_ekm_config.timeout,
+                                     metadata:     metadata,
+                                     retry_policy: @config.rpcs.get_ekm_config.retry_policy
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
+                                     retry_policy: @config.retry_policy
+
+              @ekm_service_stub.call_rpc :get_ekm_config, request, options: options do |response, operation|
+                yield response, operation if block_given?
+                return response
+              end
+            rescue ::GRPC::BadStatus => e
+              raise ::Google::Cloud::Error.from_error(e)
+            end
+
+            ##
+            # Updates the {::Google::Cloud::Kms::V1::EkmConfig EkmConfig} singleton resource
+            # for a given project and location.
+            #
+            # @overload update_ekm_config(request, options = nil)
+            #   Pass arguments to `update_ekm_config` via a request object, either of type
+            #   {::Google::Cloud::Kms::V1::UpdateEkmConfigRequest} or an equivalent Hash.
+            #
+            #   @param request [::Google::Cloud::Kms::V1::UpdateEkmConfigRequest, ::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_ekm_config(ekm_config: nil, update_mask: nil)
+            #   Pass arguments to `update_ekm_config` 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 ekm_config [::Google::Cloud::Kms::V1::EkmConfig, ::Hash]
+            #     Required. {::Google::Cloud::Kms::V1::EkmConfig EkmConfig} with updated values.
+            #   @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
+            #     Required. List of fields to be updated in this request.
+            #
+            # @yield [response, operation] Access the result along with the RPC operation
+            # @yieldparam response [::Google::Cloud::Kms::V1::EkmConfig]
+            # @yieldparam operation [::GRPC::ActiveCall::Operation]
+            #
+            # @return [::Google::Cloud::Kms::V1::EkmConfig]
+            #
+            # @raise [::Google::Cloud::Error] if the RPC 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::EkmService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Kms::V1::UpdateEkmConfigRequest.new
+            #
+            #   # Call the update_ekm_config method.
+            #   result = client.update_ekm_config request
+            #
+            #   # The returned object is of type Google::Cloud::Kms::V1::EkmConfig.
+            #   p result
+            #
+            def update_ekm_config request, options = nil
+              raise ::ArgumentError, "request must be provided" if request.nil?
+
+              request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Kms::V1::UpdateEkmConfigRequest
+
+              # 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
+              metadata = @config.rpcs.update_ekm_config.metadata.to_h
+
+              # Set x-goog-api-client and x-goog-user-project headers
+              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
+              metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+              header_params = {}
+              if request.ekm_config&.name
+                header_params["ekm_config.name"] = request.ekm_config.name
+              end
+
+              request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
+              metadata[:"x-goog-request-params"] ||= request_params_header
+
+              options.apply_defaults timeout:      @config.rpcs.update_ekm_config.timeout,
+                                     metadata:     metadata,
+                                     retry_policy: @config.rpcs.update_ekm_config.retry_policy
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
+                                     retry_policy: @config.retry_policy
+
+              @ekm_service_stub.call_rpc :update_ekm_config, request, options: options do |response, operation|
+                yield response, operation if block_given?
+                return response
+              end
+            rescue ::GRPC::BadStatus => e
+              raise ::Google::Cloud::Error.from_error(e)
+            end
+
             ##
             # Configuration class for the EkmService API.
             #
@@ -735,6 +908,16 @@ module Google
                 # @return [::Gapic::Config::Method]
                 #
                 attr_reader :update_ekm_connection
+                ##
+                # RPC-specific configuration for `get_ekm_config`
+                # @return [::Gapic::Config::Method]
+                #
+                attr_reader :get_ekm_config
+                ##
+                # RPC-specific configuration for `update_ekm_config`
+                # @return [::Gapic::Config::Method]
+                #
+                attr_reader :update_ekm_config
 
                 # @private
                 def initialize parent_rpcs = nil
@@ -746,6 +929,10 @@ module Google
                   @create_ekm_connection = ::Gapic::Config::Method.new create_ekm_connection_config
                   update_ekm_connection_config = parent_rpcs.update_ekm_connection if parent_rpcs.respond_to? :update_ekm_connection
                   @update_ekm_connection = ::Gapic::Config::Method.new update_ekm_connection_config
+                  get_ekm_config_config = parent_rpcs.get_ekm_config if parent_rpcs.respond_to? :get_ekm_config
+                  @get_ekm_config = ::Gapic::Config::Method.new get_ekm_config_config
+                  update_ekm_config_config = parent_rpcs.update_ekm_config if parent_rpcs.respond_to? :update_ekm_config
+                  @update_ekm_config = ::Gapic::Config::Method.new update_ekm_config_config
 
                   yield self if block_given?
                 end

data/lib/google/cloud/kms/v1/ekm_service/paths.rb

@@ -24,6 +24,23 @@ module Google
         module EkmService
           # Path helper methods for the EkmService API.
           module Paths
+            ##
+            # Create a fully-qualified EkmConfig resource string.
+            #
+            # The resource will be in the following format:
+            #
+            # `projects/{project}/locations/{location}/ekmConfig`
+            #
+            # @param project [String]
+            # @param location [String]
+            #
+            # @return [::String]
+            def ekm_config_path project:, location:
+              raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+
+              "projects/#{project}/locations/#{location}/ekmConfig"
+            end
+
             ##
             # Create a fully-qualified EkmConnection resource string.
             #