google-cloud-functions-v2 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d6b6e6359bf56a99485078111cc1ee38d6412d7ef0ae3aeb4cd683254b6d998
-  data.tar.gz: d87b48663959f691ae3f9ea496f045a2081beb09c5cfacf7f91f50bc8fc4cf2a
+  metadata.gz: 60a81c1d07f91c14470579fea2f02c13b9cdc460546439a3fe7e8bf431bc5795
+  data.tar.gz: 6e832526b2b135a129c99ce511f39317faf39d3cfffb1f3fc82c239fcc844027
 SHA512:
-  metadata.gz: 9bd6cdf8df9ee900afb2de7e9dfce20d520acb8dcccd8d9a21024c46575d5d1845c2ce63cfa21076927300bd45789b4d93851907b97254ea7abcbfb74ebde82f
-  data.tar.gz: aef1bb6e4653a7e1b6b3916e29a33cde4e753d8b2e6e8661dc5c1a0d1324465192ee7ee6a82aea5b8fcd2d7b74caacd9d1cf2543230fdc2cbca6d545798eb986
+  metadata.gz: 0e6df6babde60d6e014dc9b40982cddd2f076be628e4474f3093727fd151940b3fe6a0facc29e450a3c52532bd82fafc15598e3d1d1f643647f8d34a3cc02c10
+  data.tar.gz: f5275ce31e58401c21b165779200dfe86f0e37d2357f076550a1ba18c75cf73a973caec3cebef92e91b41e8c05a2fbfbc66773c040033454f8f7c4df96bb59eb

data/AUTHENTICATION.md

@@ -114,7 +114,7 @@ credentials are discovered.
 To configure your system for this, simply:
 
 1. [Download and install the Cloud SDK](https://cloud.google.com/sdk)
-2. Authenticate using OAuth 2.0 `$ gcloud auth login`
+2. Authenticate using OAuth 2.0 `$ gcloud auth application-default login`
 3. Write code as if already authenticated.
 
 **NOTE:** This is _not_ recommended for running in production. The Cloud SDK

data/README.md

@@ -1,6 +1,6 @@
 # Ruby Client for the Cloud Functions V2 API
 
-API Client library for the Cloud Functions V2 API
+Manages lightweight user-provided functions executed in response to events.
 
 The Cloud Functions API manages lightweight user-provided functions executed in response to events.
 
@@ -46,8 +46,8 @@ for general usage information.
 ## Enabling Logging
 
 To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
-The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib/libdoc/logger/rdoc/Logger.html) as shown below,
-or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
+The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/current/stdlibs/logger/Logger.html) as shown below,
+or a [`Google::Cloud::Logging::Logger`](https://cloud.google.com/ruby/docs/reference/google-cloud-logging/latest)
 that will write logs to [Cloud Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
 and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
 

data/lib/google/cloud/functions/v2/bindings_override.rb

@@ -0,0 +1,124 @@
+# 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 Functions
+      ##
+      # @example Loading just the REST part of this package, including all its services, and instantiating a REST client
+      #
+      #     require "google/cloud/functions/v2/rest"
+      #     client = ::Google::Cloud::Functions::V2::FunctionService::Rest::Client.new
+      #
+      module V2
+        ##
+        # @private
+        # Initialize the mixin bindings configuration
+        #
+        def self.configure
+          @configure ||= begin
+            namespace = ["Google", "Cloud", "Functions"]
+            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.ListLocations"] = [
+              Gapic::Rest::GrpcTranscoder::HttpBinding.create_with_validation(
+                uri_method: :get,
+                uri_template: "/v2/{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: "/v2/{resource}:getIamPolicy",
+                matches: [
+                  ["resource", %r{^projects/[^/]+/locations/[^/]+/functions/[^/]+/?$}, false]
+                ],
+                body: nil
+              )
+            ]
+            default_config.bindings_override["google.iam.v1.IAMPolicy.SetIamPolicy"] = [
+
+              Gapic::Rest::GrpcTranscoder::HttpBinding.create_with_validation(
+                uri_method: :post,
+                uri_template: "/v2/{resource}:setIamPolicy",
+                matches: [
+                  ["resource", %r{^projects/[^/]+/locations/[^/]+/functions/[^/]+/?$}, false]
+                ],
+                body: "*"
+              )
+            ]
+            default_config.bindings_override["google.iam.v1.IAMPolicy.TestIamPermissions"] = [
+
+              Gapic::Rest::GrpcTranscoder::HttpBinding.create_with_validation(
+                uri_method: :post,
+                uri_template: "/v2/{resource}:testIamPermissions",
+                matches: [
+                  ["resource", %r{^projects/[^/]+/locations/[^/]+/functions/[^/]+/?$}, false]
+                ],
+                body: "*"
+              )
+            ]
+            default_config
+          end
+          yield @configure if block_given?
+          @configure
+        end
+
+        ##
+        # @private
+        # Configuration class for the google.cloud.functions.v2 package.
+        #
+        # This class contains common configuration for all services
+        # of the google.cloud.functions.v2 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/functions/v2/function_service/client.rb

@@ -294,14 +294,17 @@ module Google
             #   the default parameter values, pass an empty Hash as a request object (see above).
             #
             #   @param parent [::String]
-            #     Required. The project and location from which the function should be listed,
-            #     specified in the format `projects/*/locations/*`
-            #     If you want to list functions in all locations, use "-" in place of a
-            #     location. When listing functions in all locations, if one or more
-            #     location(s) are unreachable, the response will contain functions from all
-            #     reachable locations along with the names of any unreachable locations.
+            #     Required. The project and location from which the function should be
+            #     listed, specified in the format `projects/*/locations/*` If you want to
+            #     list functions in all locations, use "-" in place of a location. When
+            #     listing functions in all locations, if one or more location(s) are
+            #     unreachable, the response will contain functions from all reachable
+            #     locations along with the names of any unreachable locations.
             #   @param page_size [::Integer]
-            #     Maximum number of functions to return per call.
+            #     Maximum number of functions to return per call. The largest allowed
+            #     page_size is 1,000, if the page_size is omitted or specified as greater
+            #     than 1,000 then it will be replaced as 1,000. The size of the list
+            #     response can be less than specified when used with filters.
             #   @param page_token [::String]
             #     The value returned by the last
             #     `ListFunctionsResponse`; indicates that
@@ -335,13 +338,11 @@ module Google
             #   # Call the list_functions method.
             #   result = client.list_functions 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::Functions::V2::Function.
-            #     p response
+            #     p item
             #   end
             #
             def list_functions request, options = nil
@@ -407,8 +408,8 @@ module Google
             #   the default parameter values, pass an empty Hash as a request object (see above).
             #
             #   @param parent [::String]
-            #     Required. The project and location in which the function should be created, specified
-            #     in the format `projects/*/locations/*`
+            #     Required. The project and location in which the function should be created,
+            #     specified in the format `projects/*/locations/*`
             #   @param function [::Google::Cloud::Functions::V2::Function, ::Hash]
             #     Required. Function to be created.
             #   @param function_id [::String]
@@ -438,14 +439,14 @@ module Google
             #   # Call the create_function method.
             #   result = client.create_function request
             #
-            #   # The returned object is of type Gapic::Operation. You can use this
-            #   # object to check the status of an operation, cancel it, or wait
-            #   # for results. Here is how to block until completion:
+            #   # 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 "Error!"
+            #     puts "No response received."
             #   end
             #
             def create_function request, options = nil
@@ -535,14 +536,14 @@ module Google
             #   # Call the update_function method.
             #   result = client.update_function request
             #
-            #   # The returned object is of type Gapic::Operation. You can use this
-            #   # object to check the status of an operation, cancel it, or wait
-            #   # for results. Here is how to block until completion:
+            #   # 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 "Error!"
+            #     puts "No response received."
             #   end
             #
             def update_function request, options = nil
@@ -630,14 +631,14 @@ module Google
             #   # Call the delete_function method.
             #   result = client.delete_function request
             #
-            #   # The returned object is of type Gapic::Operation. You can use this
-            #   # object to check the status of an operation, cancel it, or wait
-            #   # for results. Here is how to block until completion:
+            #   # 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 "Error!"
+            #     puts "No response received."
             #   end
             #
             def delete_function request, options = nil
@@ -717,14 +718,30 @@ module Google
             #   @param options [::Gapic::CallOptions, ::Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
-            # @overload generate_upload_url(parent: nil)
+            # @overload generate_upload_url(parent: nil, kms_key_name: nil)
             #   Pass arguments to `generate_upload_url` 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 project and location in which the Google Cloud Storage signed URL
-            #     should be generated, specified in the format `projects/*/locations/*`.
+            #     Required. The project and location in which the Google Cloud Storage signed
+            #     URL should be generated, specified in the format `projects/*/locations/*`.
+            #   @param kms_key_name [::String]
+            #     Resource name of a KMS crypto key (managed by the user) used to
+            #     encrypt/decrypt function source code objects in intermediate Cloud Storage
+            #     buckets. When you generate an upload url and upload your source code, it
+            #     gets copied to an intermediate Cloud Storage bucket. The source code is
+            #     then copied to a versioned directory in the sources bucket in the consumer
+            #     project during the function deployment.
+            #
+            #     It must match the pattern
+            #     `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
+            #
+            #     The Google Cloud Functions service account
+            #     (service-\\{project_number}@gcf-admin-robot.iam.gserviceaccount.com) must be
+            #     granted the role 'Cloud KMS CryptoKey Encrypter/Decrypter
+            #     (roles/cloudkms.cryptoKeyEncrypterDecrypter)' on the
+            #     Key/KeyRing/Project/Organization (least access preferred).
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Cloud::Functions::V2::GenerateUploadUrlResponse]
@@ -813,8 +830,8 @@ module Google
             #   the default parameter values, pass an empty Hash as a request object (see above).
             #
             #   @param name [::String]
-            #     Required. The name of function for which source code Google Cloud Storage signed
-            #     URL should be generated.
+            #     Required. The name of function for which source code Google Cloud Storage
+            #     signed URL should be generated.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Cloud::Functions::V2::GenerateDownloadUrlResponse]
@@ -899,8 +916,8 @@ module Google
             #   the default parameter values, pass an empty Hash as a request object (see above).
             #
             #   @param parent [::String]
-            #     Required. The project and location from which the runtimes should be listed,
-            #     specified in the format `projects/*/locations/*`
+            #     Required. The project and location from which the runtimes should be
+            #     listed, specified in the format `projects/*/locations/*`
             #   @param filter [::String]
             #     The filter for Runtimes that match the filter expression,
             #     following the syntax outlined in https://google.aip.dev/160.
@@ -1007,9 +1024,9 @@ module Google
             #    *  (`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://googleapis.dev/ruby/googleauth/latest/index.html))
+            #       (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://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
+            #       (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
             #    *  (`GRPC::Core::Channel`) a gRPC channel with included credentials
             #    *  (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
             #    *  (`nil`) indicating no credentials

data/lib/google/cloud/functions/v2/function_service/operations.rb

@@ -158,13 +158,11 @@ module Google
             #   # Call the list_operations method.
             #   result = client.list_operations 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::Longrunning::Operation.
-            #     p response
+            #     p item
             #   end
             #
             def list_operations request, options = nil
@@ -253,14 +251,14 @@ module Google
             #   # Call the get_operation method.
             #   result = client.get_operation request
             #
-            #   # The returned object is of type Gapic::Operation. You can use this
-            #   # object to check the status of an operation, cancel it, or wait
-            #   # for results. Here is how to block until completion:
+            #   # 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 "Error!"
+            #     puts "No response received."
             #   end
             #
             def get_operation request, options = nil
@@ -540,14 +538,14 @@ module Google
             #   # Call the wait_operation method.
             #   result = client.wait_operation request
             #
-            #   # The returned object is of type Gapic::Operation. You can use this
-            #   # object to check the status of an operation, cancel it, or wait
-            #   # for results. Here is how to block until completion:
+            #   # 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 "Error!"
+            #     puts "No response received."
             #   end
             #
             def wait_operation request, options = nil
@@ -622,9 +620,9 @@ module Google
             #    *  (`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://googleapis.dev/ruby/googleauth/latest/index.html))
+            #       (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://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
+            #       (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
             #    *  (`GRPC::Core::Channel`) a gRPC channel with included credentials
             #    *  (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
             #    *  (`nil`) indicating no credentials

data/lib/google/cloud/functions/v2/function_service/paths.rb

@@ -81,6 +81,27 @@ module Google
               "projects/#{project}/locations/#{location}/connectors/#{connector}"
             end
 
+            ##
+            # Create a fully-qualified CryptoKey resource string.
+            #
+            # The resource will be in the following format:
+            #
+            # `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`
+            #
+            # @param project [String]
+            # @param location [String]
+            # @param key_ring [String]
+            # @param crypto_key [String]
+            #
+            # @return [::String]
+            def crypto_key_path project:, location:, key_ring:, crypto_key:
+              raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+              raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
+              raise ::ArgumentError, "key_ring cannot contain /" if key_ring.to_s.include? "/"
+
+              "projects/#{project}/locations/#{location}/keyRings/#{key_ring}/cryptoKeys/#{crypto_key}"
+            end
+
             ##
             # Create a fully-qualified Function resource string.
             #