google-cloud-app_engine 1.4.0 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d4560ae4525fb24c49795b1d689334dad32812977399815d5d94067b40d0142
-  data.tar.gz: af29ff03625786ff63cc3b63575c3dfe4b933a0c30ecd4af22417e04a09f1fa0
+  metadata.gz: cd77c66f4bff1f4ff3a3ed600fcd3c467ad038c68944fd3aec69c18d67cfb118
+  data.tar.gz: a8d1f834187a50e346db2043b906dea304002d4a09cebaafdd7ff1db0acccf0f
 SHA512:
-  metadata.gz: cee49eceb2df59c5f0a062544941a6b91376e0ceda107e27ded40da324a37b7a1c7972b4bf35c67b2eb175a438c3881edb8fd5a6dedc7349915506acadcf0c5a
-  data.tar.gz: fd3fd0d776e1b1dad872efeea1e1a9aee9e5e69432c4e53b0cdb445b35c087314ac9379e44fb48d9cfd7dfca33d479768464ef386b63b1a3944fcd6a5aac134e
+  metadata.gz: 3dbb2a4c42c949070eae8ca0b8d5f2407e146fbe140f7846181ff85a7bf4f4c881b03b4f6310bde8acb7a7f5e453eed8283e7efb3de3febfc8ad0cc5ceed4a0e
+  data.tar.gz: e2ea302c797f82a74b49c2345a6680634463feede38f63223764a183107b345710b95b2766fb0db0a625b707c1bd7a88b6179d409a7dccdd48e55ac43f10b16a

data/README.md

@@ -7,7 +7,7 @@ The App Engine Admin API provisions and manages your App Engine applications.
 Actual client classes for the various versions of this API are defined in
 _versioned_ client gems, with names of the form `google-cloud-app_engine-v*`.
 The gem `google-cloud-app_engine` is the main client library that brings the
-verisoned gems in as dependencies, and provides high-level methods for
+versioned gems in as dependencies, and provides high-level methods for
 constructing clients. More information on versioned clients can be found below
 in the section titled *Which client should I use?*.
 
@@ -34,9 +34,39 @@ In order to use this library, you first need to go through the following steps:
 1. [Enable the API.](https://console.cloud.google.com/apis/library/appengine.googleapis.com)
 1. {file:AUTHENTICATION.md Set up authentication.}
 
+## Debug Logging
+
+This library comes with opt-in Debug Logging that can help you troubleshoot
+your application's integration with the API. When logging is activated, key
+events such as requests and responses, along with data payloads and metadata
+such as headers and client configuration, are logged to the standard error
+stream.
+
+**WARNING:** Client Library Debug Logging includes your data payloads in
+plaintext, which could include sensitive data such as PII for yourself or your
+customers, private keys, or other security data that could be compromising if
+leaked. Always practice good data hygiene with your application logs, and follow
+the principle of least access. Google also recommends that Client Library Debug
+Logging be enabled only temporarily during active debugging, and not used
+permanently in production.
+
+To enable logging, set the environment variable `GOOGLE_SDK_RUBY_LOGGING_GEMS`
+to the value `all`. Alternatively, you can set the value to a comma-delimited
+list of client library gem names. This will select the default logging behavior,
+which writes logs to the standard error stream. On a local workstation, this may
+result in logs appearing on the console. When running on a Google Cloud hosting
+service such as [Google Cloud Run](https://cloud.google.com/run), this generally
+results in logs appearing alongside your application logs in the
+[Google Cloud Logging](https://cloud.google.com/logging/) service.
+
+Debug logging also requires that the versioned clients for this service be
+sufficiently recent, released after about Dec 10, 2024. If logging is not
+working, try updating the versioned clients in your bundle or installed gems:
+[google-cloud-app_engine-v1](https://cloud.google.com/ruby/docs/reference/google-cloud-app_engine-v1/latest).
+
 ## Supported Ruby Versions
 
-This library is supported on Ruby 2.7+.
+This library is supported on Ruby 3.0+.
 
 Google provides official support for Ruby versions that are actively supported
 by Ruby Core—that is, Ruby versions that are either in normal maintenance or

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

@@ -20,7 +20,7 @@
 module Google
   module Cloud
     module AppEngine
-      VERSION = "1.4.0"
+      VERSION = "1.5.1"
     end
   end
 end

data/lib/google/cloud/app_engine.rb

@@ -58,6 +58,11 @@ module Google
       # You can also specify a different transport by passing `:rest` or `:grpc` in
       # the `transport` parameter.
       #
+      # Raises an exception if the currently installed versioned client gem for the
+      # given API version does not support the given transport of the Applications service.
+      # You can determine whether the method will succeed by calling
+      # {Google::Cloud::AppEngine.applications_available?}.
+      #
       # ## About Applications
       #
       # Manages App Engine applications.
@@ -79,6 +84,37 @@ module Google
         service_module.const_get(:Client).new(&block)
       end
 
+      ##
+      # Determines whether the Applications service is supported by the current client.
+      # If true, you can retrieve a client object by calling {Google::Cloud::AppEngine.applications}.
+      # If false, that method will raise an exception. This could happen if the given
+      # API version does not exist or does not support the Applications service,
+      # or if the versioned client gem needs an update to support the Applications service.
+      #
+      # @param version [::String, ::Symbol] The API version to connect to. Optional.
+      #   Defaults to `:v1`.
+      # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
+      # @return [boolean] Whether the service is available.
+      #
+      def self.applications_available? version: :v1, transport: :grpc
+        require "google/cloud/app_engine/#{version.to_s.downcase}"
+        package_name = Google::Cloud::AppEngine
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        return false unless package_name
+        service_module = Google::Cloud::AppEngine.const_get package_name
+        return false unless service_module.const_defined? :Applications
+        service_module = service_module.const_get :Applications
+        if transport == :rest
+          return false unless service_module.const_defined? :Rest
+          service_module = service_module.const_get :Rest
+        end
+        service_module.const_defined? :Client
+      rescue ::LoadError
+        false
+      end
+
       ##
       # Create a new client object for Services.
       #
@@ -92,6 +128,11 @@ module Google
       # You can also specify a different transport by passing `:rest` or `:grpc` in
       # the `transport` parameter.
       #
+      # Raises an exception if the currently installed versioned client gem for the
+      # given API version does not support the given transport of the Services service.
+      # You can determine whether the method will succeed by calling
+      # {Google::Cloud::AppEngine.services_available?}.
+      #
       # ## About Services
       #
       # Manages services of an application.
@@ -113,6 +154,37 @@ module Google
         service_module.const_get(:Client).new(&block)
       end
 
+      ##
+      # Determines whether the Services service is supported by the current client.
+      # If true, you can retrieve a client object by calling {Google::Cloud::AppEngine.services}.
+      # If false, that method will raise an exception. This could happen if the given
+      # API version does not exist or does not support the Services service,
+      # or if the versioned client gem needs an update to support the Services service.
+      #
+      # @param version [::String, ::Symbol] The API version to connect to. Optional.
+      #   Defaults to `:v1`.
+      # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
+      # @return [boolean] Whether the service is available.
+      #
+      def self.services_available? version: :v1, transport: :grpc
+        require "google/cloud/app_engine/#{version.to_s.downcase}"
+        package_name = Google::Cloud::AppEngine
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        return false unless package_name
+        service_module = Google::Cloud::AppEngine.const_get package_name
+        return false unless service_module.const_defined? :Services
+        service_module = service_module.const_get :Services
+        if transport == :rest
+          return false unless service_module.const_defined? :Rest
+          service_module = service_module.const_get :Rest
+        end
+        service_module.const_defined? :Client
+      rescue ::LoadError
+        false
+      end
+
       ##
       # Create a new client object for Versions.
       #
@@ -126,6 +198,11 @@ module Google
       # You can also specify a different transport by passing `:rest` or `:grpc` in
       # the `transport` parameter.
       #
+      # Raises an exception if the currently installed versioned client gem for the
+      # given API version does not support the given transport of the Versions service.
+      # You can determine whether the method will succeed by calling
+      # {Google::Cloud::AppEngine.versions_available?}.
+      #
       # ## About Versions
       #
       # Manages versions of a service.
@@ -147,6 +224,37 @@ module Google
         service_module.const_get(:Client).new(&block)
       end
 
+      ##
+      # Determines whether the Versions service is supported by the current client.
+      # If true, you can retrieve a client object by calling {Google::Cloud::AppEngine.versions}.
+      # If false, that method will raise an exception. This could happen if the given
+      # API version does not exist or does not support the Versions service,
+      # or if the versioned client gem needs an update to support the Versions service.
+      #
+      # @param version [::String, ::Symbol] The API version to connect to. Optional.
+      #   Defaults to `:v1`.
+      # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
+      # @return [boolean] Whether the service is available.
+      #
+      def self.versions_available? version: :v1, transport: :grpc
+        require "google/cloud/app_engine/#{version.to_s.downcase}"
+        package_name = Google::Cloud::AppEngine
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        return false unless package_name
+        service_module = Google::Cloud::AppEngine.const_get package_name
+        return false unless service_module.const_defined? :Versions
+        service_module = service_module.const_get :Versions
+        if transport == :rest
+          return false unless service_module.const_defined? :Rest
+          service_module = service_module.const_get :Rest
+        end
+        service_module.const_defined? :Client
+      rescue ::LoadError
+        false
+      end
+
       ##
       # Create a new client object for Instances.
       #
@@ -160,6 +268,11 @@ module Google
       # You can also specify a different transport by passing `:rest` or `:grpc` in
       # the `transport` parameter.
       #
+      # Raises an exception if the currently installed versioned client gem for the
+      # given API version does not support the given transport of the Instances service.
+      # You can determine whether the method will succeed by calling
+      # {Google::Cloud::AppEngine.instances_available?}.
+      #
       # ## About Instances
       #
       # Manages instances of a version.
@@ -181,6 +294,37 @@ module Google
         service_module.const_get(:Client).new(&block)
       end
 
+      ##
+      # Determines whether the Instances service is supported by the current client.
+      # If true, you can retrieve a client object by calling {Google::Cloud::AppEngine.instances}.
+      # If false, that method will raise an exception. This could happen if the given
+      # API version does not exist or does not support the Instances service,
+      # or if the versioned client gem needs an update to support the Instances service.
+      #
+      # @param version [::String, ::Symbol] The API version to connect to. Optional.
+      #   Defaults to `:v1`.
+      # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
+      # @return [boolean] Whether the service is available.
+      #
+      def self.instances_available? version: :v1, transport: :grpc
+        require "google/cloud/app_engine/#{version.to_s.downcase}"
+        package_name = Google::Cloud::AppEngine
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        return false unless package_name
+        service_module = Google::Cloud::AppEngine.const_get package_name
+        return false unless service_module.const_defined? :Instances
+        service_module = service_module.const_get :Instances
+        if transport == :rest
+          return false unless service_module.const_defined? :Rest
+          service_module = service_module.const_get :Rest
+        end
+        service_module.const_defined? :Client
+      rescue ::LoadError
+        false
+      end
+
       ##
       # Create a new client object for Firewall.
       #
@@ -194,6 +338,11 @@ module Google
       # You can also specify a different transport by passing `:rest` or `:grpc` in
       # the `transport` parameter.
       #
+      # Raises an exception if the currently installed versioned client gem for the
+      # given API version does not support the given transport of the Firewall service.
+      # You can determine whether the method will succeed by calling
+      # {Google::Cloud::AppEngine.firewall_available?}.
+      #
       # ## About Firewall
       #
       # Firewall resources are used to define a collection of access control rules
@@ -224,6 +373,37 @@ module Google
         service_module.const_get(:Client).new(&block)
       end
 
+      ##
+      # Determines whether the Firewall service is supported by the current client.
+      # If true, you can retrieve a client object by calling {Google::Cloud::AppEngine.firewall}.
+      # If false, that method will raise an exception. This could happen if the given
+      # API version does not exist or does not support the Firewall service,
+      # or if the versioned client gem needs an update to support the Firewall service.
+      #
+      # @param version [::String, ::Symbol] The API version to connect to. Optional.
+      #   Defaults to `:v1`.
+      # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
+      # @return [boolean] Whether the service is available.
+      #
+      def self.firewall_available? version: :v1, transport: :grpc
+        require "google/cloud/app_engine/#{version.to_s.downcase}"
+        package_name = Google::Cloud::AppEngine
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        return false unless package_name
+        service_module = Google::Cloud::AppEngine.const_get package_name
+        return false unless service_module.const_defined? :Firewall
+        service_module = service_module.const_get :Firewall
+        if transport == :rest
+          return false unless service_module.const_defined? :Rest
+          service_module = service_module.const_get :Rest
+        end
+        service_module.const_defined? :Client
+      rescue ::LoadError
+        false
+      end
+
       ##
       # Create a new client object for AuthorizedDomains.
       #
@@ -237,6 +417,11 @@ module Google
       # You can also specify a different transport by passing `:rest` or `:grpc` in
       # the `transport` parameter.
       #
+      # Raises an exception if the currently installed versioned client gem for the
+      # given API version does not support the given transport of the AuthorizedDomains service.
+      # You can determine whether the method will succeed by calling
+      # {Google::Cloud::AppEngine.authorized_domains_available?}.
+      #
       # ## About AuthorizedDomains
       #
       # Manages domains a user is authorized to administer. To authorize use of a
@@ -260,6 +445,37 @@ module Google
         service_module.const_get(:Client).new(&block)
       end
 
+      ##
+      # Determines whether the AuthorizedDomains service is supported by the current client.
+      # If true, you can retrieve a client object by calling {Google::Cloud::AppEngine.authorized_domains}.
+      # If false, that method will raise an exception. This could happen if the given
+      # API version does not exist or does not support the AuthorizedDomains service,
+      # or if the versioned client gem needs an update to support the AuthorizedDomains service.
+      #
+      # @param version [::String, ::Symbol] The API version to connect to. Optional.
+      #   Defaults to `:v1`.
+      # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
+      # @return [boolean] Whether the service is available.
+      #
+      def self.authorized_domains_available? version: :v1, transport: :grpc
+        require "google/cloud/app_engine/#{version.to_s.downcase}"
+        package_name = Google::Cloud::AppEngine
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        return false unless package_name
+        service_module = Google::Cloud::AppEngine.const_get package_name
+        return false unless service_module.const_defined? :AuthorizedDomains
+        service_module = service_module.const_get :AuthorizedDomains
+        if transport == :rest
+          return false unless service_module.const_defined? :Rest
+          service_module = service_module.const_get :Rest
+        end
+        service_module.const_defined? :Client
+      rescue ::LoadError
+        false
+      end
+
       ##
       # Create a new client object for AuthorizedCertificates.
       #
@@ -273,6 +489,11 @@ module Google
       # You can also specify a different transport by passing `:rest` or `:grpc` in
       # the `transport` parameter.
       #
+      # Raises an exception if the currently installed versioned client gem for the
+      # given API version does not support the given transport of the AuthorizedCertificates service.
+      # You can determine whether the method will succeed by calling
+      # {Google::Cloud::AppEngine.authorized_certificates_available?}.
+      #
       # ## About AuthorizedCertificates
       #
       # Manages SSL certificates a user is authorized to administer. A user can
@@ -295,6 +516,37 @@ module Google
         service_module.const_get(:Client).new(&block)
       end
 
+      ##
+      # Determines whether the AuthorizedCertificates service is supported by the current client.
+      # If true, you can retrieve a client object by calling {Google::Cloud::AppEngine.authorized_certificates}.
+      # If false, that method will raise an exception. This could happen if the given
+      # API version does not exist or does not support the AuthorizedCertificates service,
+      # or if the versioned client gem needs an update to support the AuthorizedCertificates service.
+      #
+      # @param version [::String, ::Symbol] The API version to connect to. Optional.
+      #   Defaults to `:v1`.
+      # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
+      # @return [boolean] Whether the service is available.
+      #
+      def self.authorized_certificates_available? version: :v1, transport: :grpc
+        require "google/cloud/app_engine/#{version.to_s.downcase}"
+        package_name = Google::Cloud::AppEngine
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        return false unless package_name
+        service_module = Google::Cloud::AppEngine.const_get package_name
+        return false unless service_module.const_defined? :AuthorizedCertificates
+        service_module = service_module.const_get :AuthorizedCertificates
+        if transport == :rest
+          return false unless service_module.const_defined? :Rest
+          service_module = service_module.const_get :Rest
+        end
+        service_module.const_defined? :Client
+      rescue ::LoadError
+        false
+      end
+
       ##
       # Create a new client object for DomainMappings.
       #
@@ -308,6 +560,11 @@ module Google
       # You can also specify a different transport by passing `:rest` or `:grpc` in
       # the `transport` parameter.
       #
+      # Raises an exception if the currently installed versioned client gem for the
+      # given API version does not support the given transport of the DomainMappings service.
+      # You can determine whether the method will succeed by calling
+      # {Google::Cloud::AppEngine.domain_mappings_available?}.
+      #
       # ## About DomainMappings
       #
       # Manages domains serving an application.
@@ -329,6 +586,37 @@ module Google
         service_module.const_get(:Client).new(&block)
       end
 
+      ##
+      # Determines whether the DomainMappings service is supported by the current client.
+      # If true, you can retrieve a client object by calling {Google::Cloud::AppEngine.domain_mappings}.
+      # If false, that method will raise an exception. This could happen if the given
+      # API version does not exist or does not support the DomainMappings service,
+      # or if the versioned client gem needs an update to support the DomainMappings service.
+      #
+      # @param version [::String, ::Symbol] The API version to connect to. Optional.
+      #   Defaults to `:v1`.
+      # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
+      # @return [boolean] Whether the service is available.
+      #
+      def self.domain_mappings_available? version: :v1, transport: :grpc
+        require "google/cloud/app_engine/#{version.to_s.downcase}"
+        package_name = Google::Cloud::AppEngine
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        return false unless package_name
+        service_module = Google::Cloud::AppEngine.const_get package_name
+        return false unless service_module.const_defined? :DomainMappings
+        service_module = service_module.const_get :DomainMappings
+        if transport == :rest
+          return false unless service_module.const_defined? :Rest
+          service_module = service_module.const_get :Rest
+        end
+        service_module.const_defined? :Client
+      rescue ::LoadError
+        false
+      end
+
       ##
       # Configure the google-cloud-app_engine library.
       #

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-app_engine
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.1
 platform: ruby
 authors:
 - Google LLC
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-02-26 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-app_engine-v1
@@ -61,7 +60,6 @@ homepage: https://github.com/googleapis/google-cloud-ruby
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -69,15 +67,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.8
 specification_version: 4
 summary: API Client library for the App Engine Admin API
 test_files: []