google-cloud-kms-v1 0.18.1 → 0.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 59b86de14b63de4677b18bf0f2bd000fd989942c71966e4fc934e6402e42e0ee
-  data.tar.gz: 2b93be85406e63ca4f5f316a3704be88f32fb47ec5a7daf76133a3bcf4a48afb
+  metadata.gz: 69001e1b6b9a0e268ff0e9ddaf3ef9535c8e25428334d9d58fc59fdc3b21fb8c
+  data.tar.gz: 11fc0213ab299c96b8636a164e9ad5ffe536d9f3fa43b6d60d892d5f91005f01
 SHA512:
-  metadata.gz: b5476742317b44f7715d20116b165bbd1827b02b837d3b2c65c2c606c5bebe4a1a42cf129896dc8f2ce35aeed907e87d1b8cbc927d71a7e702bab73260da6e21
-  data.tar.gz: e615bc561491044d5e42d26754fac81a63f781a249c6f061f58006ec0644508dedb84101528e62bd34232bd76b8b667d82b0e936d7e6d583ec26d2b11a55bb72
+  metadata.gz: 4ba06d5d132693b236e02f44d4d752c742e336668f19fb0b8381af3e8931278ddeb0572cb4586d0c47249768ed6e3847b14bce5c0281862ac2425f57d0f801f1
+  data.tar.gz: 3005fd1d7e72bad8c8877453764a8974cc27538615958eb74b12ef4aac502b1dff059b355313558658144bd43486aa2e4a3435c9f4f03672ca84d15c37c1548a

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

@@ -753,6 +753,96 @@ module Google
               raise ::Google::Cloud::Error.from_error(e)
             end
 
+            ##
+            # Verifies that Cloud KMS can successfully connect to the external key
+            # manager specified by an {::Google::Cloud::Kms::V1::EkmConnection EkmConnection}.
+            # If there is an error connecting to the EKM, this method returns a
+            # FAILED_PRECONDITION status containing structured information as described
+            # at https://cloud.google.com/kms/docs/reference/ekm_errors.
+            #
+            # @overload verify_connectivity(request, options = nil)
+            #   Pass arguments to `verify_connectivity` via a request object, either of type
+            #   {::Google::Cloud::Kms::V1::VerifyConnectivityRequest} or an equivalent Hash.
+            #
+            #   @param request [::Google::Cloud::Kms::V1::VerifyConnectivityRequest, ::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 verify_connectivity(name: nil)
+            #   Pass arguments to `verify_connectivity` 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::EkmConnection#name name} of the
+            #     {::Google::Cloud::Kms::V1::EkmConnection EkmConnection} to verify.
+            #
+            # @yield [response, operation] Access the result along with the RPC operation
+            # @yieldparam response [::Google::Cloud::Kms::V1::VerifyConnectivityResponse]
+            # @yieldparam operation [::GRPC::ActiveCall::Operation]
+            #
+            # @return [::Google::Cloud::Kms::V1::VerifyConnectivityResponse]
+            #
+            # @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::VerifyConnectivityRequest.new
+            #
+            #   # Call the verify_connectivity method.
+            #   result = client.verify_connectivity request
+            #
+            #   # The returned object is of type Google::Cloud::Kms::V1::VerifyConnectivityResponse.
+            #   p result
+            #
+            def verify_connectivity request, options = nil
+              raise ::ArgumentError, "request must be provided" if request.nil?
+
+              request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Kms::V1::VerifyConnectivityRequest
+
+              # 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.verify_connectivity.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.verify_connectivity.timeout,
+                                     metadata:     metadata,
+                                     retry_policy: @config.rpcs.verify_connectivity.retry_policy
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
+                                     retry_policy: @config.retry_policy
+
+              @ekm_service_stub.call_rpc :verify_connectivity, 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.
             #
@@ -918,6 +1008,11 @@ module Google
                 # @return [::Gapic::Config::Method]
                 #
                 attr_reader :update_ekm_config
+                ##
+                # RPC-specific configuration for `verify_connectivity`
+                # @return [::Gapic::Config::Method]
+                #
+                attr_reader :verify_connectivity
 
                 # @private
                 def initialize parent_rpcs = nil
@@ -933,6 +1028,8 @@ module Google
                   @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
+                  verify_connectivity_config = parent_rpcs.verify_connectivity if parent_rpcs.respond_to? :verify_connectivity
+                  @verify_connectivity = ::Gapic::Config::Method.new verify_connectivity_config
 
                   yield self if block_given?
                 end

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

@@ -604,6 +604,73 @@ module Google
                 raise ::Google::Cloud::Error.from_error(e)
               end
 
+              ##
+              # Verifies that Cloud KMS can successfully connect to the external key
+              # manager specified by an {::Google::Cloud::Kms::V1::EkmConnection EkmConnection}.
+              # If there is an error connecting to the EKM, this method returns a
+              # FAILED_PRECONDITION status containing structured information as described
+              # at https://cloud.google.com/kms/docs/reference/ekm_errors.
+              #
+              # @overload verify_connectivity(request, options = nil)
+              #   Pass arguments to `verify_connectivity` via a request object, either of type
+              #   {::Google::Cloud::Kms::V1::VerifyConnectivityRequest} or an equivalent Hash.
+              #
+              #   @param request [::Google::Cloud::Kms::V1::VerifyConnectivityRequest, ::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 verify_connectivity(name: nil)
+              #   Pass arguments to `verify_connectivity` 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::EkmConnection#name name} of the
+              #     {::Google::Cloud::Kms::V1::EkmConnection EkmConnection} to verify.
+              # @yield [result, operation] Access the result along with the TransportOperation object
+              # @yieldparam result [::Google::Cloud::Kms::V1::VerifyConnectivityResponse]
+              # @yieldparam operation [::Gapic::Rest::TransportOperation]
+              #
+              # @return [::Google::Cloud::Kms::V1::VerifyConnectivityResponse]
+              #
+              # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              def verify_connectivity request, options = nil
+                raise ::ArgumentError, "request must be provided" if request.nil?
+
+                request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Kms::V1::VerifyConnectivityRequest
+
+                # 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.verify_connectivity.metadata.to_h
+
+                # Set x-goog-api-client and x-goog-user-project headers
+                call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+                  lib_name: @config.lib_name, lib_version: @config.lib_version,
+                  gapic_version: ::Google::Cloud::Kms::V1::VERSION,
+                  transports_version_send: [:rest]
+
+                call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+                options.apply_defaults timeout:      @config.rpcs.verify_connectivity.timeout,
+                                       metadata:     call_metadata,
+                                       retry_policy: @config.rpcs.verify_connectivity.retry_policy
+
+                options.apply_defaults timeout:      @config.timeout,
+                                       metadata:     @config.metadata,
+                                       retry_policy: @config.retry_policy
+
+                @ekm_service_stub.verify_connectivity request, options do |result, operation|
+                  yield result, operation if block_given?
+                  return result
+                end
+              rescue ::Gapic::Rest::Error => e
+                raise ::Google::Cloud::Error.from_error(e)
+              end
+
               ##
               # Configuration class for the EkmService REST API.
               #
@@ -764,6 +831,11 @@ module Google
                   # @return [::Gapic::Config::Method]
                   #
                   attr_reader :update_ekm_config
+                  ##
+                  # RPC-specific configuration for `verify_connectivity`
+                  # @return [::Gapic::Config::Method]
+                  #
+                  attr_reader :verify_connectivity
 
                   # @private
                   def initialize parent_rpcs = nil
@@ -779,6 +851,8 @@ module Google
                     @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
+                    verify_connectivity_config = parent_rpcs.verify_connectivity if parent_rpcs.respond_to? :verify_connectivity
+                    @verify_connectivity = ::Gapic::Config::Method.new verify_connectivity_config
 
                     yield self if block_given?
                   end

data/lib/google/cloud/kms/v1/ekm_service/rest/service_stub.rb

@@ -268,6 +268,44 @@ module Google
                 result
               end
 
+              ##
+              # Baseline implementation for the verify_connectivity REST call
+              #
+              # @param request_pb [::Google::Cloud::Kms::V1::VerifyConnectivityRequest]
+              #   A request object representing the call parameters. Required.
+              # @param options [::Gapic::CallOptions]
+              #   Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
+              #
+              # @yield [result, operation] Access the result along with the TransportOperation object
+              # @yieldparam result [::Google::Cloud::Kms::V1::VerifyConnectivityResponse]
+              # @yieldparam operation [::Gapic::Rest::TransportOperation]
+              #
+              # @return [::Google::Cloud::Kms::V1::VerifyConnectivityResponse]
+              #   A result object deserialized from the server's reply
+              def verify_connectivity request_pb, options = nil
+                raise ::ArgumentError, "request must be provided" if request_pb.nil?
+
+                verb, uri, query_string_params, body = ServiceStub.transcode_verify_connectivity_request request_pb
+                query_string_params = if query_string_params.any?
+                                        query_string_params.to_h { |p| p.split("=", 2) }
+                                      else
+                                        {}
+                                      end
+
+                response = @client_stub.make_http_request(
+                  verb,
+                  uri:     uri,
+                  body:    body || "",
+                  params:  query_string_params,
+                  options: options
+                )
+                operation = ::Gapic::Rest::TransportOperation.new response
+                result = ::Google::Cloud::Kms::V1::VerifyConnectivityResponse.decode_json response.body, ignore_unknown_fields: true
+
+                yield result, operation if block_given?
+                result
+              end
+
               ##
               # @private
               #
@@ -396,6 +434,27 @@ module Google
                                                         )
                 transcoder.transcode request_pb
               end
+
+              ##
+              # @private
+              #
+              # GRPC transcoding helper method for the verify_connectivity REST call
+              #
+              # @param request_pb [::Google::Cloud::Kms::V1::VerifyConnectivityRequest]
+              #   A request object representing the call parameters. Required.
+              # @return [Array(String, [String, nil], Hash{String => String})]
+              #   Uri, Body, Query string parameters
+              def self.transcode_verify_connectivity_request request_pb
+                transcoder = Gapic::Rest::GrpcTranscoder.new
+                                                        .with_bindings(
+                                                          uri_method: :get,
+                                                          uri_template: "/v1/{name}:verifyConnectivity",
+                                                          matches: [
+                                                            ["name", %r{^projects/[^/]+/locations/[^/]+/ekmConnections/[^/]+/?$}, false]
+                                                          ]
+                                                        )
+                transcoder.transcode request_pb
+              end
             end
           end
         end

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

@@ -77,6 +77,11 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :name, :string, 1
       optional :default_ekm_connection, :string, 2
     end
+    add_message "google.cloud.kms.v1.VerifyConnectivityRequest" do
+      optional :name, :string, 1
+    end
+    add_message "google.cloud.kms.v1.VerifyConnectivityResponse" do
+    end
   end
 end
 
@@ -96,6 +101,8 @@ module Google
         EkmConnection::ServiceResolver = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.kms.v1.EkmConnection.ServiceResolver").msgclass
         EkmConnection::KeyManagementMode = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.kms.v1.EkmConnection.KeyManagementMode").enummodule
         EkmConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.kms.v1.EkmConfig").msgclass
+        VerifyConnectivityRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.kms.v1.VerifyConnectivityRequest").msgclass
+        VerifyConnectivityResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.kms.v1.VerifyConnectivityResponse").msgclass
       end
     end
   end

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

@@ -53,6 +53,12 @@ module Google
             # Updates the [EkmConfig][google.cloud.kms.v1.EkmConfig] singleton resource
             # for a given project and location.
             rpc :UpdateEkmConfig, ::Google::Cloud::Kms::V1::UpdateEkmConfigRequest, ::Google::Cloud::Kms::V1::EkmConfig
+            # Verifies that Cloud KMS can successfully connect to the external key
+            # manager specified by an [EkmConnection][google.cloud.kms.v1.EkmConnection].
+            # If there is an error connecting to the EKM, this method returns a
+            # FAILED_PRECONDITION status containing structured information as described
+            # at https://cloud.google.com/kms/docs/reference/ekm_errors.
+            rpc :VerifyConnectivity, ::Google::Cloud::Kms::V1::VerifyConnectivityRequest, ::Google::Cloud::Kms::V1::VerifyConnectivityResponse
           end
 
           Stub = Service.rpc_stub_class

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

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module Kms
       module V1
-        VERSION = "0.18.1"
+        VERSION = "0.19.0"
       end
     end
   end

data/proto_docs/google/api/client.rb

@@ -83,7 +83,7 @@ module Google
     #     long-running operation pattern.
     # @!attribute [rw] new_issue_uri
     #   @return [::String]
-    #     Link to a place that API users can report issues.  Example:
+    #     Link to a *public* URI where users can report issues.  Example:
     #     https://issuetracker.google.com/issues/new?component=190865&template=1161103
     # @!attribute [rw] documentation_uri
     #   @return [::String]
@@ -353,6 +353,15 @@ module Google
 
       # Street View Org.
       STREET_VIEW = 4
+
+      # Shopping Org.
+      SHOPPING = 5
+
+      # Geo Org.
+      GEO = 6
+
+      # Generative AI - https://developers.generativeai.google
+      GENERATIVE_AI = 7
     end
 
     # To where should client libraries be published?

data/proto_docs/google/cloud/kms/v1/ekm_service.rb

@@ -321,6 +321,24 @@ module Google
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
+
+        # Request message for
+        # {::Google::Cloud::Kms::V1::EkmService::Client#verify_connectivity EkmService.VerifyConnectivity}.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The {::Google::Cloud::Kms::V1::EkmConnection#name name} of the
+        #     {::Google::Cloud::Kms::V1::EkmConnection EkmConnection} to verify.
+        class VerifyConnectivityRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for
+        # {::Google::Cloud::Kms::V1::EkmService::Client#verify_connectivity EkmService.VerifyConnectivity}.
+        class VerifyConnectivityResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-kms-v1
 version: !ruby/object:Gem::Version
-  version: 0.18.1
+  version: 0.19.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-29 00:00:00.000000000 Z
+date: 2023-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common