google-cloud-location 0.8.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d97ad697437690ae39fcaa3a4515b009e2e4047a5bc98099a6fbd304ee3ca86
-  data.tar.gz: d5d0b06a117818414b66f64daa979972fd25e16dd5ff9273587f34a99e193528
+  metadata.gz: 89a307988299ddb69732c9944f95b495c9ba113638d454ae4398570aa1b68ddb
+  data.tar.gz: 49f1a1072b944c2dc03483e7c62d58d6bb826e359941f41ad13bcd45e47d7b92
 SHA512:
-  metadata.gz: 305210ff36703c6f5cc5f3589bd343d7f4848f6f95e0705b7e86dcf0537644d23e25e98cff7adc5d0de9302a77662f637d83b81c7b7f8b20b22f7813c9d77404
-  data.tar.gz: 92293ad1ec2f461e30657232a529347dfebf4d2c406e74f50d3815506a842eac4fca8abc71c936db243cc4d1c7a48e3539298f1bdb517a3f7664b52975458a60
+  metadata.gz: 1ba82b65f2ec1010c923cefe10ed325ce1641e18edd1f8b3ba38eee177dab96f33a18716785a919a33dea74ebaf331a3bb772ac1072fc6479f865c31c9f091cf
+  data.tar.gz: c3f3ef8f29ed1e8d9abdc1290a6a9eb4e13c620ae702609a11732620ac552edaf0009ee2687256b02fb9c74478236ac7c1db11f3a26d23dcc497c3abe3b3505e

data/lib/google/cloud/location/locations/client.rb

@@ -31,6 +31,9 @@ module Google
         # {::Google::Cloud::Location::Location#metadata Location.metadata} field.
         #
         class Client
+          # @private
+          API_VERSION = ""
+
           # @private
           DEFAULT_ENDPOINT_TEMPLATE = "cloud.$UNIVERSE_DOMAIN$"
 
@@ -153,8 +156,28 @@ module Google
               universe_domain: @config.universe_domain,
               channel_args: @config.channel_args,
               interceptors: @config.interceptors,
-              channel_pool_config: @config.channel_pool
+              channel_pool_config: @config.channel_pool,
+              logger: @config.logger
             )
+
+            @locations_stub.stub_logger&.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
+          end
+
+          ##
+          # The logger used for request/response debug logging.
+          #
+          # @return [Logger]
+          #
+          def logger
+            @locations_stub.logger
           end
 
           # Service calls
@@ -224,10 +247,11 @@ module Google
             # Customize the options with defaults
             metadata = @config.rpcs.list_locations.metadata.to_h
 
-            # Set x-goog-api-client and x-goog-user-project headers
+            # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::Location::VERSION
+            metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
             metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
             header_params = {}
@@ -249,7 +273,7 @@ module Google
             @locations_stub.call_rpc :list_locations, request, options: options do |response, operation|
               response = ::Gapic::PagedEnumerable.new @locations_stub, :list_locations, request, response, operation, options
               yield response, operation if block_given?
-              return response
+              throw :response, response
             end
           rescue ::GRPC::BadStatus => e
             raise ::Google::Cloud::Error.from_error(e)
@@ -310,10 +334,11 @@ module Google
             # Customize the options with defaults
             metadata = @config.rpcs.get_location.metadata.to_h
 
-            # Set x-goog-api-client and x-goog-user-project headers
+            # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::Location::VERSION
+            metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
             metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
             header_params = {}
@@ -334,7 +359,6 @@ module Google
 
             @locations_stub.call_rpc :get_location, 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)
@@ -384,6 +408,13 @@ module Google
           #    *  (`GRPC::Core::Channel`) a gRPC channel with included credentials
           #    *  (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
           #    *  (`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
@@ -423,6 +454,11 @@ module Google
           #   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
@@ -447,6 +483,7 @@ module Google
             config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
             config_attr :quota_project, nil, ::String, nil
             config_attr :universe_domain, nil, ::String, nil
+            config_attr :logger, :default, ::Logger, nil, :default
 
             # @private
             def initialize parent_config = nil

data/lib/google/cloud/location/locations/rest/client.rb

@@ -33,6 +33,9 @@ module Google
           # {::Google::Cloud::Location::Location#metadata Location.metadata} field.
           #
           class Client
+            # @private
+            API_VERSION = ""
+
             # @private
             DEFAULT_ENDPOINT_TEMPLATE = "cloud.$UNIVERSE_DOMAIN$"
 
@@ -146,8 +149,28 @@ module Google
                 endpoint: @config.endpoint,
                 endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
                 universe_domain: @config.universe_domain,
-                credentials: credentials
+                credentials: credentials,
+                logger: @config.logger
               )
+
+              @locations_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
+            end
+
+            ##
+            # The logger used for request/response debug logging.
+            #
+            # @return [Logger]
+            #
+            def logger
+              @locations_stub.logger
             end
 
             # Service calls
@@ -216,12 +239,13 @@ module Google
               # Customize the options with defaults
               call_metadata = @config.rpcs.list_locations.metadata.to_h
 
-              # Set x-goog-api-client and x-goog-user-project headers
+              # 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::Location::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_locations.timeout,
@@ -237,7 +261,7 @@ module Google
               @locations_stub.list_locations request, options, bindings_override: bindings_override do |result, operation|
                 result = ::Gapic::Rest::PagedEnumerable.new @locations_stub, :list_locations, "locations", request, result, options
                 yield result, operation if block_given?
-                return result
+                throw :response, result
               end
             rescue ::Gapic::Rest::Error => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -297,12 +321,13 @@ module Google
               # Customize the options with defaults
               call_metadata = @config.rpcs.get_location.metadata.to_h
 
-              # Set x-goog-api-client and x-goog-user-project headers
+              # 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::Location::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_location.timeout,
@@ -317,7 +342,6 @@ module Google
 
               @locations_stub.get_location request, options, bindings_override: bindings_override do |result, operation|
                 yield result, operation if block_given?
-                return result
               end
             rescue ::Gapic::Rest::Error => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -365,6 +389,13 @@ module Google
             #    *  (`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
@@ -397,6 +428,11 @@ module Google
             #   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
@@ -425,6 +461,7 @@ module Google
               # 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

data/lib/google/cloud/location/locations/rest/service_stub.rb

@@ -29,7 +29,8 @@ module Google
           # including transcoding, making the REST call, and deserialing the response.
           #
           class ServiceStub
-            def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
+            # @private
+            def initialize endpoint:, endpoint_template:, universe_domain:, credentials:, logger:
               # These require statements are intentionally placed here to initialize
               # the REST modules only when it's required.
               require "gapic/rest"
@@ -39,7 +40,9 @@ module Google
                                                            universe_domain: universe_domain,
                                                            credentials: credentials,
                                                            numeric_enums: true,
-                                                           raise_faraday_errors: false
+                                                           service_name: self.class,
+                                                           raise_faraday_errors: false,
+                                                           logger: logger
             end
 
             ##
@@ -60,6 +63,15 @@ module Google
               @client_stub.endpoint
             end
 
+            ##
+            # The logger used for request/response debug logging.
+            #
+            # @return [Logger]
+            #
+            def logger stub: false
+              stub ? @client_stub.stub_logger : @client_stub.logger
+            end
+
             ##
             # Baseline implementation for the list_locations REST call
             #
@@ -88,16 +100,18 @@ module Google
 
               response = @client_stub.make_http_request(
                 verb,
-                uri:     uri,
-                body:    body || "",
-                params:  query_string_params,
+                uri: uri,
+                body: body || "",
+                params: query_string_params,
+                method_name: "list_locations",
                 options: options
               )
               operation = ::Gapic::Rest::TransportOperation.new response
               result = ::Google::Cloud::Location::ListLocationsResponse.decode_json response.body, ignore_unknown_fields: true
-
-              yield result, operation if block_given?
-              result
+              catch :response do
+                yield result, operation if block_given?
+                result
+              end
             end
 
             ##
@@ -128,16 +142,18 @@ module Google
 
               response = @client_stub.make_http_request(
                 verb,
-                uri:     uri,
-                body:    body || "",
-                params:  query_string_params,
+                uri: uri,
+                body: body || "",
+                params: query_string_params,
+                method_name: "get_location",
                 options: options
               )
               operation = ::Gapic::Rest::TransportOperation.new response
               result = ::Google::Cloud::Location::Location.decode_json response.body, ignore_unknown_fields: true
-
-              yield result, operation if block_given?
-              result
+              catch :response do
+                yield result, operation if block_given?
+                result
+              end
             end
 
             ##

data/lib/google/cloud/location/version.rb

@@ -20,7 +20,7 @@
 module Google
   module Cloud
     module Location
-      VERSION = "0.8.0"
+      VERSION = "0.10.0"
     end
   end
 end

data/proto_docs/google/api/client.rb

@@ -28,6 +28,9 @@ module Google
     # @!attribute [rw] destinations
     #   @return [::Array<::Google::Api::ClientLibraryDestination>]
     #     The destination where API teams want this client library to be published.
+    # @!attribute [rw] selective_gapic_generation
+    #   @return [::Google::Api::SelectiveGapicGeneration]
+    #     Configuration for which RPCs should be generated in the GAPIC client.
     class CommonLanguageSettings
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -118,6 +121,10 @@ module Google
     #   @return [::String]
     #     Optional link to proto reference documentation.  Example:
     #     https://cloud.google.com/pubsub/lite/docs/reference/rpc
+    # @!attribute [rw] rest_reference_documentation_uri
+    #   @return [::String]
+    #     Optional link to REST reference documentation.  Example:
+    #     https://cloud.google.com/pubsub/lite/docs/reference/rest
     class Publishing
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -192,9 +199,32 @@ module Google
     # @!attribute [rw] common
     #   @return [::Google::Api::CommonLanguageSettings]
     #     Some settings.
+    # @!attribute [rw] experimental_features
+    #   @return [::Google::Api::PythonSettings::ExperimentalFeatures]
+    #     Experimental features to be included during client library generation.
     class PythonSettings
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods
+
+      # Experimental features to be included during client library generation.
+      # These fields will be deprecated once the feature graduates and is enabled
+      # by default.
+      # @!attribute [rw] rest_async_io_enabled
+      #   @return [::Boolean]
+      #     Enables generation of asynchronous REST clients if `rest` transport is
+      #     enabled. By default, asynchronous REST clients will not be generated.
+      #     This feature will be enabled by default 1 month after launching the
+      #     feature in preview packages.
+      # @!attribute [rw] protobuf_pythonic_types_enabled
+      #   @return [::Boolean]
+      #     Enables generation of protobuf code using new types that are more
+      #     Pythonic which are included in `protobuf>=5.29.x`. This feature will be
+      #     enabled by default 1 month after launching the feature in preview
+      #     packages.
+      class ExperimentalFeatures
+        include ::Google::Protobuf::MessageExts
+        extend ::Google::Protobuf::MessageExts::ClassMethods
+      end
     end
 
     # Settings for Node client libraries.
@@ -276,9 +306,28 @@ module Google
     # @!attribute [rw] common
     #   @return [::Google::Api::CommonLanguageSettings]
     #     Some settings.
+    # @!attribute [rw] renamed_services
+    #   @return [::Google::Protobuf::Map{::String => ::String}]
+    #     Map of service names to renamed services. Keys are the package relative
+    #     service names and values are the name to be used for the service client
+    #     and call options.
+    #
+    #     publishing:
+    #       go_settings:
+    #         renamed_services:
+    #           Publisher: TopicAdmin
     class GoSettings
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods
+
+      # @!attribute [rw] key
+      #   @return [::String]
+      # @!attribute [rw] value
+      #   @return [::String]
+      class RenamedServicesEntry
+        include ::Google::Protobuf::MessageExts
+        extend ::Google::Protobuf::MessageExts::ClassMethods
+      end
     end
 
     # Describes the generator configuration for a method.
@@ -286,6 +335,13 @@ module Google
     #   @return [::String]
     #     The fully qualified name of the method, for which the options below apply.
     #     This is used to find the method to apply the options.
+    #
+    #     Example:
+    #
+    #        publishing:
+    #          method_settings:
+    #          - selector: google.storage.control.v2.StorageControl.CreateFolder
+    #            # method settings for CreateFolder...
     # @!attribute [rw] long_running
     #   @return [::Google::Api::MethodSettings::LongRunning]
     #     Describes settings to use for long-running operations when generating
@@ -294,17 +350,14 @@ module Google
     #
     #     Example of a YAML configuration::
     #
-    #      publishing:
-    #        method_settings:
+    #        publishing:
+    #          method_settings:
     #          - selector: google.cloud.speech.v2.Speech.BatchRecognize
     #            long_running:
-    #              initial_poll_delay:
-    #                seconds: 60 # 1 minute
+    #              initial_poll_delay: 60s # 1 minute
     #              poll_delay_multiplier: 1.5
-    #              max_poll_delay:
-    #                seconds: 360 # 6 minutes
-    #              total_poll_timeout:
-    #                 seconds: 54000 # 90 minutes
+    #              max_poll_delay: 360s # 6 minutes
+    #              total_poll_timeout: 54000s # 90 minutes
     # @!attribute [rw] auto_populated_fields
     #   @return [::Array<::String>]
     #     List of top-level fields of the request message, that should be
@@ -313,8 +366,8 @@ module Google
     #
     #     Example of a YAML configuration:
     #
-    #      publishing:
-    #        method_settings:
+    #        publishing:
+    #          method_settings:
     #          - selector: google.example.v1.ExampleService.CreateExample
     #            auto_populated_fields:
     #            - request_id
@@ -350,6 +403,17 @@ module Google
       end
     end
 
+    # This message is used to configure the generation of a subset of the RPCs in
+    # a service for client libraries.
+    # @!attribute [rw] methods
+    #   @return [::Array<::String>]
+    #     An allowlist of the fully qualified names of RPCs that should be included
+    #     on public client surfaces.
+    class SelectiveGapicGeneration
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
     # The organization for which the client libraries are being published.
     # Affects the url where generated docs are published, etc.
     module ClientLibraryOrganization

data/proto_docs/google/api/resource.rb

@@ -124,8 +124,13 @@ module Google
     #   @return [::String]
     #     The plural name used in the resource name and permission names, such as
     #     'projects' for the resource name of 'projects/\\{project}' and the permission
-    #     name of 'cloudresourcemanager.googleapis.com/projects.get'. It is the same
-    #     concept of the `plural` field in k8s CRD spec
+    #     name of 'cloudresourcemanager.googleapis.com/projects.get'. One exception
+    #     to this is for Nested Collections that have stuttering names, as defined
+    #     in [AIP-122](https://google.aip.dev/122#nested-collections), where the
+    #     collection ID in the resource name pattern does not necessarily directly
+    #     match the `plural` value.
+    #
+    #     It is the same concept of the `plural` field in k8s CRD spec
     #     https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
     #
     #     Note: The plural form is required even for singleton resources. See

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-location
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Google LLC
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-02-26 00:00:00.000000000 Z
+date: 2025-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -16,7 +15,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.21.1
+        version: 0.25.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -26,7 +25,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.21.1
+        version: 0.25.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -78,7 +77,6 @@ homepage: https://github.com/googleapis/google-cloud-ruby
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -86,15 +84,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
-signing_key: 
+rubygems_version: 3.6.2
 specification_version: 4
 summary: API Client library for the Locations API
 test_files: []