gapic-common 0.10.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5962314c78d1864ee6b768003c887d15af76619c8644a96392f0931ad6f2712c
-  data.tar.gz: 89920288c50070f089949eb11ff94010a52b69d1919b5e4ab6eb50cd9a3610ad
+  metadata.gz: 5902b53f0f5a46b4682ff855fb89a6a3162af38523fa273f273abeeeed0d3a3d
+  data.tar.gz: a1e9bb69d31725768f00b152efcaf29042657fbb304c2ba2f25de485831fe187
 SHA512:
-  metadata.gz: 02c0113ca2287b79558c698393b3315b85c4359b15b90bf54929ea7e7f04a5189769559a69d22f35cebcedb99d62d1a02b2a7ca16739ea724565ace848a89279
-  data.tar.gz: cf43e6bedb320bc4f91f22e4b0354c87583b92e5734ea4d5d40d280bd9ffeaf0d272eda97e1e9bae2ce7e507e8a56a76c4a5c26ca5156326e7edd1bc88dfc5d9
+  metadata.gz: 84d77cc3d943714b8a3578ecabf3fea3a321dfe0929ee108233d4dcd8fede90a37be21a81e121142739aa3dca102ffff0826a003906bec16f03749beddf59ab2
+  data.tar.gz: 27e2815be724399a4c01ca1d47c7b2e9291ee4583018251f45a2a0162f1d5cd8298d0ca3b8a4cf90fc4ba6f2e410240439e61a22a66fbeae89c5a3e9dc223879

data/CHANGELOG.md

@@ -1,5 +1,55 @@
 # Release History
 
+### 0.15.0 (2022-11-17)
+
+#### Features
+
+* retry policy now works for REST calls
+
+### 0.14.0 (2022-11-08)
+
+#### Features
+
+* add support for different types of credentials to REST 
+#### Bug Fixes
+
+* deadlock fix ([#845](https://github.com/googleapis/gapic-generator-ruby/issues/845)) 
+
+### 0.13.0 (2022-10-26)
+
+#### Features
+
+* Implement server-side streaming support for REST calls in gapic-common ([#826](https://github.com/googleapis/gapic-generator-ruby/issues/826)) 
+
+### 0.12.0 (2022-09-15)
+
+#### Features
+
+* Support numeric_enums in the ClientStub ([#817](https://github.com/googleapis/gapic-generator-ruby/issues/817)) 
+* parse details information from REST errors  ([#815](https://github.com/googleapis/gapic-generator-ruby/issues/815)) 
+* send protobuf version in headers ([#816](https://github.com/googleapis/gapic-generator-ruby/issues/816)) 
+
+#### Bug Fixes
+
+* rewrap certain grpc errors ([#810](https://github.com/googleapis/gapic-generator-ruby/issues/810)) 
+  This will rewrap some GRPC::Unavailable errors that were caused by authentication failing as Gapic::GRPC::AuthorizationError which inherits from ::GRPC::Unauthenticated
+
+### 0.11.1 (2022-08-03)
+
+#### Bug Fixes
+
+* error code of 0 is not an error, body template field can be nil ([#805](https://github.com/googleapis/gapic-generator-ruby/issues/805)) 
+
+### 0.11.0 (2022-07-27)
+
+#### Features
+
+* Add CallOptions#merge and CallOptions equality checking ([#802](https://github.com/googleapis/gapic-generator-ruby/issues/802)) 
+
+#### Bug Fixes
+
+* transcoder should always preserve slashes ([#795](https://github.com/googleapis/gapic-generator-ruby/issues/795)) 
+
 ### 0.10.0 (2022-06-20)
 
 #### Features

data/lib/gapic/call_options/error_codes.rb

@@ -0,0 +1,71 @@
+# Copyright 2019 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.
+
+module Gapic
+  class CallOptions
+    ##
+    # @private
+    # The gRPC error codes and their HTTP mapping
+    #
+    module ErrorCodes
+      # @private
+      # See https://grpc.github.io/grpc/core/md_doc_statuscodes.html for a
+      # list of error codes.
+      error_code_mapping = [
+        "OK",
+        "CANCELLED",
+        "UNKNOWN",
+        "INVALID_ARGUMENT",
+        "DEADLINE_EXCEEDED",
+        "NOT_FOUND",
+        "ALREADY_EXISTS",
+        "PERMISSION_DENIED",
+        "RESOURCE_EXHAUSTED",
+        "FAILED_PRECONDITION",
+        "ABORTED",
+        "OUT_OF_RANGE",
+        "UNIMPLEMENTED",
+        "INTERNAL",
+        "UNAVAILABLE",
+        "DATA_LOSS",
+        "UNAUTHENTICATED"
+      ].freeze
+
+      # @private
+      ERROR_STRING_MAPPING = error_code_mapping.each_with_index.to_h.freeze
+
+      # @private
+      # Converts http error codes into corresponding gRPC ones
+      def self.grpc_error_for http_error_code
+        return 2 unless http_error_code
+
+        # The http status codes mapped to their error classes.
+        {
+          400 => 3, # InvalidArgumentError
+          401 => 16, # UnauthenticatedError
+          403 => 7, # PermissionDeniedError
+          404 => 5, # NotFoundError
+          409 => 6, # AlreadyExistsError
+          412 => 9, # FailedPreconditionError
+          429 => 8, # ResourceExhaustedError
+          499 => 1, # CanceledError
+          500 => 13, # InternalError
+          501 => 12, # UnimplementedError
+          503 => 14, # UnavailableError
+          504 => 4 # DeadlineExceededError
+        }[http_error_code] || 2 # UnknownError
+      end
+    end
+  end
+end

data/lib/gapic/call_options/retry_policy.rb

@@ -12,6 +12,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require "gapic/call_options/error_codes"
+
 module Gapic
   class CallOptions
     ##
@@ -74,6 +76,7 @@ module Gapic
       #
       # @param retry_policy [Hash] The policy for error retry. keys must match the arguments for
       #   {RpcCall::RetryPolicy.new}.
+      #
       def apply_defaults retry_policy
         return unless retry_policy.is_a? Hash
 
@@ -85,38 +88,27 @@ module Gapic
         self
       end
 
-      # @private
-      # See https://grpc.github.io/grpc/core/md_doc_statuscodes.html for a
-      # list of error codes.
-      ERROR_CODE_MAPPING = [
-        "OK",
-        "CANCELLED",
-        "UNKNOWN",
-        "INVALID_ARGUMENT",
-        "DEADLINE_EXCEEDED",
-        "NOT_FOUND",
-        "ALREADY_EXISTS",
-        "PERMISSION_DENIED",
-        "RESOURCE_EXHAUSTED",
-        "FAILED_PRECONDITION",
-        "ABORTED",
-        "OUT_OF_RANGE",
-        "UNIMPLEMENTED",
-        "INTERNAL",
-        "UNAVAILABLE",
-        "DATA_LOSS",
-        "UNAUTHENTICATED"
-      ].freeze
+      # @private Equality test
+      def eql? other
+        other.is_a?(RetryPolicy) &&
+          other.retry_codes == retry_codes &&
+          other.initial_delay == initial_delay &&
+          other.multiplier == multiplier &&
+          other.max_delay == max_delay
+      end
+      alias == eql?
 
-      # @private
-      ERROR_STRING_MAPPING = ERROR_CODE_MAPPING.each_with_index.each_with_object({}) do |(str, num), hash|
-        hash[str] = num
-      end.freeze
+      # @private Hash code
+      def hash
+        [retry_codes, initial_delay, multiplier, max_delay].hash
+      end
 
       private
 
       def retry? error
-        error.is_a?(GRPC::BadStatus) && retry_codes.include?(error.code)
+        (error.is_a?(::GRPC::BadStatus) && retry_codes.include?(error.code)) ||
+          (error.respond_to?(:response_status) &&
+            retry_codes.include?(ErrorCodes.grpc_error_for(error.response_status)))
       end
 
       def delay!
@@ -129,7 +121,7 @@ module Gapic
         Array(input_codes).map do |obj|
           case obj
           when String
-            ERROR_STRING_MAPPING[obj]
+            ErrorCodes::ERROR_STRING_MAPPING[obj]
           when Integer
             obj
           end

data/lib/gapic/call_options.rb

@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require "gapic/call_options/error_codes"
 require "gapic/call_options/retry_policy"
 
 module Gapic
@@ -61,12 +62,18 @@ module Gapic
     # @param retry_policy [Hash] the policy for error retry.
     # @param retry_policy [Hash] The policy for error retry. keys must match the arguments for
     #   {RetryPolicy.new}.
+    #
     def apply_defaults timeout: nil, metadata: nil, retry_policy: nil
       @timeout ||= timeout
       @metadata = metadata.merge @metadata if metadata
       @retry_policy.apply_defaults retry_policy if @retry_policy.respond_to? :apply_defaults
     end
 
+    ##
+    # Convert to hash form.
+    #
+    # @return [Hash]
+    #
     def to_h
       {
         timeout:      timeout,
@@ -74,5 +81,31 @@ module Gapic
         retry_policy: retry_policy
       }
     end
+
+    ##
+    # Return a new CallOptions with the given modifications. The current object
+    # is not modified.
+    #
+    # @param kwargs [keywords] Updated fields. See {#initialize} for details.
+    # @return [CallOptions] A new CallOptions object.
+    #
+    def merge **kwargs
+      kwargs = to_h.merge kwargs
+      CallOptions.new(**kwargs)
+    end
+
+    # @private Equality test
+    def eql? other
+      other.is_a?(CallOptions) &&
+        other.timeout == timeout &&
+        other.metadata == metadata &&
+        other.retry_policy == retry_policy
+    end
+    alias == eql?
+
+    # @private Hash code
+    def hash
+      to_h.hash
+    end
   end
 end

data/lib/gapic/common/version.rb

@@ -14,6 +14,6 @@
 
 module Gapic
   module Common
-    VERSION = "0.10.0".freeze
+    VERSION = "0.15.0".freeze
   end
 end

data/lib/gapic/generic_lro/operation.rb

@@ -140,7 +140,8 @@ module Gapic
       # @return [Boolean] Whether an error has been returned.
       #
       def error?
-        done? && (!err.nil? || !error_code.nil?)
+        no_error_code = error_code.nil? || error_code.zero?
+        done? && !(err.nil? && no_error_code)
       end
 
       ##

data/lib/gapic/grpc/errors.rb

@@ -0,0 +1,60 @@
+# Copyright 2019 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.
+
+require "googleauth"
+require "gapic/common/error"
+
+module Gapic
+  module GRPC
+    ##
+    # An error class to represent the Authorization Error.
+    # The GRPC layer wraps auth plugin errors in ::GRPC::Unavailable.
+    # This class rewraps those GRPC layer errors, presenting a correct status code.
+    #
+    class AuthorizationError < ::GRPC::Unauthenticated
+    end
+
+    ##
+    # An error class that represents Deadline Exceeded error with an optional
+    # retry root cause.
+    #
+    # The GRPC layer throws ::GRPC::DeadlineExceeded without any context.
+    # If the deadline was exceeded while retrying another exception (e.g.
+    # ::GRPC::Unavailable), that exception could be useful for understanding
+    # the readon for the timeout.
+    #
+    # This exception rewraps ::GRPC::DeadlineExceeded, adding an exception
+    # that was being retried until the deadline was exceeded (if any) as a
+    # `root_cause` attribute.
+    #
+    # @!attribute [r] root_cause
+    #   @return [Object, nil] The exception that was being retried
+    #     when the DeadlineExceeded error occured.
+    #
+    class DeadlineExceededError < ::GRPC::DeadlineExceeded
+      attr_reader :root_cause
+
+      ##
+      # @param message [String] The error message.
+      #
+      # @param root_cause [Object, nil] The exception that was being retried
+      #   when the DeadlineExceeded error occured.
+      #
+      def initialize message, root_cause: nil
+        super message
+        @root_cause = root_cause
+      end
+    end
+  end
+end

data/lib/gapic/grpc/service_stub/rpc_call.rb

@@ -13,6 +13,7 @@
 # limitations under the License.
 
 require "gapic/call_options"
+require "grpc/errors"
 
 module Gapic
   class ServiceStub
@@ -45,7 +46,7 @@ module Gapic
       #
       # @yield [response, operation] Access the response along with the RPC operation.
       # @yieldparam response [Object] The response object.
-      # @yieldparam operation [GRPC::ActiveCall::Operation] The RPC operation for the response.
+      # @yieldparam operation [::GRPC::ActiveCall::Operation] The RPC operation for the response.
       #
       # @return [Object] The response object.
       #
@@ -55,7 +56,7 @@ module Gapic
       #   require "gapic"
       #   require "gapic/grpc"
       #
-      #   echo_channel = GRPC::Core::Channel.new(
+      #   echo_channel = ::GRPC::Core::Channel.new(
       #     "localhost:7469", nil, :this_channel_is_insecure
       #   )
       #   echo_stub = Gapic::ServiceStub.new(
@@ -73,7 +74,7 @@ module Gapic
       #   require "gapic"
       #   require "gapic/grpc"
       #
-      #   echo_channel = GRPC::Core::Channel.new(
+      #   echo_channel = ::GRPC::Core::Channel.new(
       #     "localhost:7469", nil, :this_channel_is_insecure
       #   )
       #   echo_stub = Gapic::ServiceStub.new(
@@ -85,7 +86,7 @@ module Gapic
       #   request = Google::Showcase::V1beta1::EchoRequest.new
       #   options = Gapic::CallOptions.new(
       #     retry_policy = {
-      #       retry_codes: [GRPC::Core::StatusCodes::UNAVAILABLE]
+      #       retry_codes: [::GRPC::Core::StatusCodes::UNAVAILABLE]
       #     }
       #   )
       #   response = echo_call.call request, options: options
@@ -96,7 +97,7 @@ module Gapic
       #   require "gapic"
       #   require "gapic/grpc"
       #
-      #   echo_channel = GRPC::Core::Channel.new(
+      #   echo_channel = ::GRPC::Core::Channel.new(
       #     "localhost:7469", nil, :this_channel_is_insecure
       #   )
       #   echo_stub = Gapic::ServiceStub.new(
@@ -116,13 +117,23 @@ module Gapic
         deadline = calculate_deadline options
         metadata = options.metadata
 
+        retried_exception = nil
         begin
           operation = stub_method.call request, deadline: deadline, metadata: metadata, return_op: true
           response = operation.execute
           yield response, operation if block_given?
           response
+        rescue ::GRPC::DeadlineExceeded => e
+          raise Gapic::GRPC::DeadlineExceededError.new e.message, root_cause: retried_exception
         rescue StandardError => e
-          retry if check_retry?(deadline) && options.retry_policy.call(e)
+          if e.is_a?(::GRPC::Unavailable) && /Signet::AuthorizationError/ =~ e.message
+            e = Gapic::GRPC::AuthorizationError.new e.message.gsub(%r{^\d+:}, "")
+          end
+
+          if check_retry?(deadline) && options.retry_policy.call(e)
+            retried_exception = e
+            retry
+          end
 
           raise e
         end

data/lib/gapic/grpc/service_stub.rb

@@ -34,20 +34,20 @@ module Gapic
     # @param grpc_stub_class [Class] gRPC stub class to create a new instance of.
     # @param endpoint [String] The endpoint of the API.
     # @param credentials [Google::Auth::Credentials, Signet::OAuth2::Client, String, Hash, Proc,
-    #   GRPC::Core::Channel, GRPC::Core::ChannelCredentials] Provides the means for authenticating requests made by
+    #   ::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] Provides the means for authenticating requests made by
     #   the client. This parameter can be many types:
     #
     #   * A `Google::Auth::Credentials` uses a the properties of its represented keyfile for authenticating requests
     #     made by this client.
     #   * A `Signet::OAuth2::Client` object used to apply the OAuth credentials.
-    #   * A `GRPC::Core::Channel` will be used to make calls through.
-    #   * A `GRPC::Core::ChannelCredentials` for the setting up the RPC client. The channel credentials should
-    #     already be composed with a `GRPC::Core::CallCredentials` object.
+    #   * A `::GRPC::Core::Channel` will be used to make calls through.
+    #   * A `::GRPC::Core::ChannelCredentials` for the setting up the RPC client. The channel credentials should
+    #     already be composed with a `::GRPC::Core::CallCredentials` object.
     #   * A `Proc` will be used as an updater_proc for the Grpc channel. The proc transforms the metadata for
     #     requests, generally, to give OAuth credentials.
     # @param channel_args [Hash] The channel arguments. (This argument is ignored when `credentials` is
-    #     provided as a `GRPC::Core::Channel`.)
-    # @param interceptors [Array<GRPC::ClientInterceptor>] An array of {GRPC::ClientInterceptor} objects that will
+    #     provided as a `::GRPC::Core::Channel`.)
+    # @param interceptors [Array<::GRPC::ClientInterceptor>] An array of {::GRPC::ClientInterceptor} objects that will
     #   be used for intercepting calls before they are executed Interceptors are an EXPERIMENTAL API.
     #
     def initialize grpc_stub_class, endpoint:, credentials:, channel_args: nil, interceptors: nil
@@ -59,10 +59,10 @@ module Gapic
       interceptors = Array interceptors
 
       @grpc_stub = case credentials
-                   when GRPC::Core::Channel
+                   when ::GRPC::Core::Channel
                      grpc_stub_class.new endpoint, nil, channel_override: credentials,
                                                         interceptors:     interceptors
-                   when GRPC::Core::ChannelCredentials, Symbol
+                   when ::GRPC::Core::ChannelCredentials, Symbol
                      grpc_stub_class.new endpoint, credentials, channel_args: channel_args,
                                                                 interceptors: interceptors
                    else
@@ -70,8 +70,8 @@ module Gapic
                      updater_proc ||= credentials if credentials.is_a? Proc
                      raise ArgumentError, "invalid credentials (#{credentials.class})" if updater_proc.nil?
 
-                     call_creds = GRPC::Core::CallCredentials.new updater_proc
-                     chan_creds = GRPC::Core::ChannelCredentials.new.compose call_creds
+                     call_creds = ::GRPC::Core::CallCredentials.new updater_proc
+                     chan_creds = ::GRPC::Core::ChannelCredentials.new.compose call_creds
                      grpc_stub_class.new endpoint, chan_creds, channel_args: channel_args,
                                                                interceptors: interceptors
                    end
@@ -88,7 +88,7 @@ module Gapic
     #
     # @yield [response, operation] Access the response along with the RPC operation.
     # @yieldparam response [Object] The response object.
-    # @yieldparam operation [GRPC::ActiveCall::Operation] The RPC operation for the response.
+    # @yieldparam operation [::GRPC::ActiveCall::Operation] The RPC operation for the response.
     #
     # @return [Object] The response object.
     #
@@ -98,7 +98,7 @@ module Gapic
     #   require "gapic"
     #   require "gapic/grpc"
     #
-    #   echo_channel = GRPC::Core::Channel.new(
+    #   echo_channel = ::GRPC::Core::Channel.new(
     #     "localhost:7469", nil, :this_channel_is_insecure
     #   )
     #   echo_stub = Gapic::ServiceStub.new(
@@ -115,7 +115,7 @@ module Gapic
     #   require "gapic"
     #   require "gapic/grpc"
     #
-    #   echo_channel = GRPC::Core::Channel.new(
+    #   echo_channel = ::GRPC::Core::Channel.new(
     #     "localhost:7469", nil, :this_channel_is_insecure
     #   )
     #   echo_stub = Gapic::ServiceStub.new(
@@ -126,7 +126,7 @@ module Gapic
     #   request = Google::Showcase::V1beta1::EchoRequest.new
     #   options = Gapic::CallOptions.new(
     #     retry_policy = {
-    #       retry_codes: [GRPC::Core::StatusCodes::UNAVAILABLE]
+    #       retry_codes: [::GRPC::Core::StatusCodes::UNAVAILABLE]
     #     }
     #   )
     #   response = echo_stub.call_rpc :echo, request
@@ -138,7 +138,7 @@ module Gapic
     #   require "gapic"
     #   require "gapic/grpc"
     #
-    #   echo_channel = GRPC::Core::Channel.new(
+    #   echo_channel = ::GRPC::Core::Channel.new(
     #     "localhost:7469", nil, :this_channel_is_insecure
     #   )
     #   echo_stub = Gapic::ServiceStub.new(

data/lib/gapic/grpc.rb

@@ -13,5 +13,6 @@
 # limitations under the License.
 
 require "grpc"
+require "gapic/grpc/errors"
 require "gapic/grpc/service_stub"
 require "gapic/grpc/status_details"

data/lib/gapic/headers.rb

@@ -25,7 +25,7 @@ module Gapic
     # @param lib_version [String] The client library version.
     # @param gax_version [String] The Gapic version. Defaults to `Gapic::Common::VERSION`.
     # @param gapic_version [String] The Gapic version.
-    # @param grpc_version [String] The GRPC version. Defaults to `GRPC::VERSION`.
+    # @param grpc_version [String] The GRPC version. Defaults to `::GRPC::VERSION`.
     # @param rest_version [String] The Rest Library (Faraday) version. Defaults to `Faraday::VERSION`.
     # @param transports_version_send [Array] Which transports to send versions for.
     #   Allowed values to contain are:
@@ -33,13 +33,14 @@ module Gapic
     #     `:rest` to send the REST library version (if defined)
     #   Defaults to `[:grpc]`
     def self.x_goog_api_client ruby_version: nil, lib_name: nil, lib_version: nil, gax_version: nil,
-                               gapic_version: nil, grpc_version: nil, rest_version: nil,
+                               gapic_version: nil, grpc_version: nil, rest_version: nil, protobuf_version: nil,
                                transports_version_send: [:grpc]
 
       ruby_version ||= ::RUBY_VERSION
       gax_version  ||= ::Gapic::Common::VERSION
       grpc_version ||= ::GRPC::VERSION if defined? ::GRPC::VERSION
-      rest_version ||= ::Faraday::VERSION if defined? ::Faraday
+      rest_version ||= ::Faraday::VERSION if defined? ::Faraday::VERSION
+      protobuf_version ||= Gem.loaded_specs["google-protobuf"].version.to_s if Gem.loaded_specs.key? "google-protobuf"
 
       x_goog_api_client_header = ["gl-ruby/#{ruby_version}"]
       x_goog_api_client_header << "#{lib_name}/#{lib_version}" if lib_name
@@ -47,6 +48,7 @@ module Gapic
       x_goog_api_client_header << "gapic/#{gapic_version}" if gapic_version
       x_goog_api_client_header << "grpc/#{grpc_version}" if grpc_version && transports_version_send.include?(:grpc)
       x_goog_api_client_header << "rest/#{rest_version}" if rest_version && transports_version_send.include?(:rest)
+      x_goog_api_client_header << "pb/#{protobuf_version}" if protobuf_version
       x_goog_api_client_header.join " ".freeze
     end
   end

data/lib/gapic/paged_enumerable.rb

@@ -53,7 +53,7 @@ module Gapic
     # @param method_name [Symbol] The RPC method name.
     # @param request [Object] The request object.
     # @param response [Object] The response object.
-    # @param operation [GRPC::ActiveCall::Operation] The RPC operation for the response.
+    # @param operation [::GRPC::ActiveCall::Operation] The RPC operation for the response.
     # @param options [Gapic::CallOptions] The options for making the RPC call.
     # @param format_resource [Proc] A Proc object to format the resource object. The Proc should accept response as an
     #   argument, and return a formatted resource object. Optional.
@@ -195,7 +195,7 @@ module Gapic
     # @attribute [r] response
     #   @return [Object] the response object for the page.
     # @attribute [r] operation
-    #   @return [GRPC::ActiveCall::Operation] the RPC operation for the page.
+    #   @return [::GRPC::ActiveCall::Operation] the RPC operation for the page.
     class Page
       include Enumerable
       attr_reader :response
@@ -205,7 +205,7 @@ module Gapic
       # @private
       # @param response [Object] The response object for the page.
       # @param resource_field [String] The name of the field in response which holds the resources.
-      # @param operation [GRPC::ActiveCall::Operation] the RPC operation for the page.
+      # @param operation [::GRPC::ActiveCall::Operation] the RPC operation for the page.
       # @param format_resource [Proc] A Proc object to format the resource object. The Proc should accept response as an
       #   argument, and return a formatted resource object. Optional.
       #