google-gax 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aeba7e008b2cfb90d91a6ac6152f7304e4650e61
-  data.tar.gz: a0acc832fe6182aacb394cb2c44ba6b257122a19
+  metadata.gz: 7ed0b03acfdc65e94f59a9de7d9ef17c82d8de2c
+  data.tar.gz: b49bdf5c29d4abea509227477aebe0ad2242ee5d
 SHA512:
-  metadata.gz: c703f3bc01fb85d6843736a279f072a20bdfa4f47edd54d1ae567ce1ee17538b4c972d15f1502c692fef94a601edc914351994eb2468eadeaa7bad984e6f707c
-  data.tar.gz: 3222c245b93925e212d8a75c27ce8f3bddcae520af1d8509eda226973bb28b435655ff34315fbbe0c2b8a32727ad3eaae1d3ccacd6e0cd7c880f0151c881a107
+  metadata.gz: 8fd2ba9b1d30101302aae49b74160fc00d509dd065b20e2416e962a8a28c42008694f67ec30e6cc13ff7dc526bb34b8b2a879857ea5dd584525b34999e8e0de0
+  data.tar.gz: e632150cec07b9861a0ffe258f3d994cb3f047be303acbcae91844f331afbbc37e311b1c47cd540746b3790efddc4e972fd00ce8dee0af54abac2e11e6ab01ae

data/lib/google/gax.rb

@@ -28,6 +28,7 @@
 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 require 'google/gax/api_callable'
+require 'google/gax/constants'
 require 'google/gax/errors'
 require 'google/gax/path_template'
 require 'google/gax/settings'
@@ -36,279 +37,5 @@ require 'google/gax/version'
 module Google
   # Gax defines Google API extensions
   module Gax
-    # rubocop:disable Metrics/ParameterLists
-
-    # Encapsulates the call settings for an ApiCallable
-    # @!attribute [r] timeout
-    #   @return [Numeric]
-    # @!attribute [r] retry_options
-    #   @return [RetryOptions]
-    # @!attribute [r] page_descriptor
-    #   @return [PageDescriptor]
-    # @!attribute [r] page_token
-    #   @return [Object]
-    # @!attribute [r] bundle_descriptor
-    #   @return [BundleDescriptor]
-    # @!attribute [r] kwargs
-    #   @return [Hash]
-    class CallSettings
-      attr_reader :timeout, :retry_options, :page_descriptor, :page_token,
-                  :bundler, :bundle_descriptor, :kwargs, :errors
-
-      # @param timeout [Numeric] The client-side timeout for API calls. This
-      #   parameter is ignored for retrying calls.
-      # @param retry_options [RetryOptions] The configuration for retrying upon
-      #   transient error. If set to nil, this call will not retry.
-      # @param page_descriptor [PageDescriptor] indicates the structure of page
-      #   streaming to be performed. If set to nil, page streaming is not
-      #   performed.
-      # @param page_token [Object] determines the page token used in the
-      #   page streaming request. If there is no page_descriptor, this has no
-      #   meaning.
-      # @param bundler orchestrates bundling. If nil, bundling is not
-      #   performed.
-      # @param bundle_descriptor [BundleDescriptor] indicates the structure of
-      #   the bundle. If nil, bundling is not performed.
-      # @param kwargs [Hash]
-      #   Additional keyword argments to be passed to the API call.
-      # @param errors [Array<Exception>]
-      #   Configures the exceptions to wrap with GaxError.
-      def initialize(timeout: 30, retry_options: nil, page_descriptor: nil,
-                     page_token: nil, bundler: nil, bundle_descriptor: nil,
-                     kwargs: {}, errors: [])
-        @timeout = timeout
-        @retry_options = retry_options
-        @page_descriptor = page_descriptor
-        @page_token = page_token
-        @bundler = bundler
-        @bundle_descriptor = bundle_descriptor
-        @kwargs = kwargs
-        @errors = errors
-      end
-
-      # @return true when it has retry codes.
-      def retry_codes?
-        @retry_options && @retry_options.retry_codes
-      end
-
-      # @return true when it has valid bundler configuration.
-      def bundler?
-        @bundler && @bundle_descriptor
-      end
-
-      # Creates a new CallSetting instance which is based on this but merged
-      # settings from options.
-      # @param options [CallOptions, nil] The overriding call settings.
-      # @return a new merged call settings.
-      def merge(options)
-        unless options
-          return CallSettings.new(timeout: @timeout,
-                                  retry_options: @retry_options,
-                                  page_descriptor: @page_descriptor,
-                                  page_token: @page_token,
-                                  bundler: @bundler,
-                                  bundle_descriptor: @bundle_descriptor,
-                                  kwargs: @kwargs,
-                                  errors: @errors)
-        end
-
-        timeout = if options.timeout == :OPTION_INHERIT
-                    @timeout
-                  else
-                    options.timeout
-                  end
-        retry_options = if options.retry_options == :OPTION_INHERIT
-                          @retry_options
-                        else
-                          options.retry_options
-                        end
-        page_token = if options.page_token == :OPTION_INHERIT
-                       @page_token
-                     else
-                       options.page_token
-                     end
-
-        kwargs = @kwargs.dup
-        kwargs.update(options.kwargs) if options.kwargs != :OPTION_INHERIT
-
-        CallSettings.new(timeout: timeout,
-                         retry_options: retry_options,
-                         page_descriptor: @page_descriptor,
-                         page_token: page_token,
-                         bundler: @bundler,
-                         bundle_descriptor: @bundle_descriptor,
-                         kwargs: kwargs,
-                         errors: @errors)
-      end
-    end
-
-    private_constant :CallSettings
-
-    # Encapsulates the overridable settings for a particular API call
-    # @!attribute [r] timeout
-    #   @return [Numeric, :OPTION_INHERIT]
-    # @!attribute [r] retry_options
-    #   @return [RetryOptions, :OPTION_INHERIT]
-    # @!attribute [r] page_token
-    #   @return [Object, :OPTION_INHERIT, :INITIAL_PAGE]
-    # @!attribute [r] kwargs
-    #  @return [Hash, :OPTION_INHERIT]
-    class CallOptions
-      attr_reader :timeout, :retry_options, :page_token, :kwargs
-
-      # @param timeout [Numeric, :OPTION_INHERIT]
-      #   The client-side timeout for API calls.
-      # @param retry_options [RetryOptions, :OPTION_INHERIT]
-      #   The configuration for retrying upon transient error.
-      #   If set to nil, this call will not retry.
-      # @param page_token [Object, :OPTION_INHERIT]
-      #   If set and the call is configured for page streaming, page streaming
-      #   is starting with this page_token.
-      # @param kwargs [Hash, :OPTION_INHERIT]
-      #   Additional keyword argments to be passed to the API call.
-      def initialize(timeout: :OPTION_INHERIT,
-                     retry_options: :OPTION_INHERIT,
-                     page_token: :OPTION_INHERIT,
-                     kwargs: :OPTION_INHERIT)
-        @timeout = timeout
-        @retry_options = retry_options
-        @page_token = page_token
-        @kwargs = kwargs
-      end
-    end
-
-    # Describes the structure of a page-streaming call.
-    class PageDescriptor < Struct.new(:request_page_token_field,
-                                      :response_page_token_field,
-                                      :resource_field)
-    end
-
-    # Per-call configurable settings for retrying upon transient failure.
-    class RetryOptions < Struct.new(:retry_codes, :backoff_settings)
-      # @!attribute retry_codes
-      #   @return [Array<Grpc::Code>] a list of exceptions upon which
-      #     a retry should be attempted.
-      # @!attribute backoff_settings
-      #   @return [BackoffSettings] configuring the retry exponential
-      #     backoff algorithm.
-    end
-
-    # Parameters to the exponential backoff algorithm for retrying.
-    class BackoffSettings < Struct.new(
-      :initial_retry_delay_millis,
-      :retry_delay_multiplier,
-      :max_retry_delay_millis,
-      :initial_rpc_timeout_millis,
-      :rpc_timeout_multiplier,
-      :max_rpc_timeout_millis,
-      :total_timeout_millis
-    )
-      # @!attribute initial_retry_delay_millis
-      #   @return [Numeric] the initial delay time, in milliseconds,
-      #     between the completion of the first failed request and the
-      #     initiation of the first retrying request.
-      # @!attribute retry_delay_multiplier
-      #   @return [Numeric] the multiplier by which to increase the
-      #     delay time between the completion of failed requests, and
-      #     the initiation of the subsequent retrying request.
-      # @!attribute max_retry_delay_millis
-      #   @return [Numeric] the maximum delay time, in milliseconds,
-      #     between requests. When this value is reached,
-      #     +retry_delay_multiplier+ will no longer be used to
-      #     increase delay time.
-      # @!attribute initial_rpc_timeout_millis
-      #   @return [Numeric] the initial timeout parameter to the request.
-      # @!attribute rpc_timeout_multiplier
-      #   @return [Numeric] the multiplier by which to increase the
-      #     timeout parameter between failed requests.
-      # @!attribute max_rpc_timeout_millis
-      #   @return [Numeric] the maximum timeout parameter, in
-      #     milliseconds, for a request. When this value is reached,
-      #     +rpc_timeout_multiplier+ will no longer be used to
-      #     increase the timeout.
-      # @!attribute total_timeout_millis
-      #   @return [Numeric] the total time, in milliseconds, starting
-      #     from when the initial request is sent, after which an
-      #     error will be returned, regardless of the retrying
-      #     attempts made meanwhile.
-    end
-
-    # Describes the structure of bundled call.
-    #
-    # request_discriminator_fields may include '.' as a separator, which is
-    # used to indicate object traversal.  This allows fields in nested objects
-    # to be used to determine what requests to bundle.
-    class BundleDescriptor < Struct.new(:bundled_field,
-                                        :request_discriminator_fields,
-                                        :subresponse_field)
-      # @!attribute bundled_field
-      #   @return [String] the repeated field in the request message
-      #     that will have its elements aggregated by bundling.
-      # @!attribute request_discriminator_fields
-      #   @return [Array<String>] a list of fields in the target
-      #     request message class that are used to determine which
-      #     messages should be bundled together.
-      # @!attribute subresponse_field
-      #   @return [String] an optional field, when present it
-      #     indicates the field in the response message that should be
-      #     used to demultiplex the response into multiple response
-      #     messages.
-      def initialize(bundled_field, request_discriminator_fields,
-                     subresponse_field: nil)
-        super(bundled_field, request_discriminator_fields, subresponse_field)
-      end
-    end
-
-    # Holds values used to configure bundling.
-    #
-    # The xxx_threshold attributes are used to configure when the bundled
-    # request should be made.
-    class BundleOptions < Struct.new(:element_count_threshold,
-                                     :element_count_limit,
-                                     :request_byte_threshold,
-                                     :request_byte_limit,
-                                     :delay_threshold_millis)
-      # @!attribute element_count_threshold
-      #   @return [Numeric] the bundled request will be sent once the
-      #     count of outstanding elements in the repeated field
-      #     reaches this value.
-      # @!attribute element_count_limit
-      #   @return [Numeric] represents a hard limit on the number of
-      #     elements in the repeated field of the bundle; if adding a
-      #     request to a bundle would exceed this value, the bundle is
-      #     sent and the new request is added to a fresh bundle. It is
-      #     invalid for a single request to exceed this limit.
-      # @!attribute request_byte_threshold
-      #   @return [Numeric] the bundled request will be sent once the
-      #     count of bytes in the request reaches this value. Note
-      #     that this value is pessimistically approximated by summing
-      #     the bytesizes of the elements in the repeated field, and
-      #     therefore may be an under-approximation.
-      # @!attribute request_byte_limit
-      #   @return [Numeric] represents a hard limit on the size of the
-      #     bundled request; if adding a request to a bundle would
-      #     exceed this value, the bundle is sent and the new request
-      #     is added to a fresh bundle. It is invalid for a single
-      #     request to exceed this limit. Note that this value is
-      #     pessimistically approximated by summing the bytesizes of
-      #     the elements in the repeated field, with a buffer applied
-      #     to correspond to the resulting under-approximation.
-      # @!attribute delay_threshold_millis
-      #   @return [Numeric] the bundled request will be sent this
-      #     amount of time after the first element in the bundle was
-      #     added to it.
-      def initialize(element_count_threshold: 0,
-                     element_count_limit: 0,
-                     request_byte_threshold: 0,
-                     request_byte_limit: 0,
-                     delay_threshold_millis: 0)
-        super(
-          element_count_threshold,
-          element_count_limit,
-          request_byte_threshold,
-          request_byte_limit,
-          delay_threshold_millis)
-      end
-    end
   end
 end

data/lib/google/gax/api_callable.rb

@@ -36,8 +36,6 @@ require 'google/gax/bundling'
 
 module Google
   module Gax
-    MILLIS_PER_SECOND = 1000.0
-
     # A class to provide the Enumerable interface for page-streaming method.
     # PagedEnumerable assumes that the API call returns a message for a page
     # which holds a list of resources and the token to the next page.
@@ -341,7 +339,6 @@ module Google
         result = nil
         now = Time.now
         deadline = now + total_timeout
-
         loop do
           begin
             result = add_timeout_arg(a_func, timeout, kwargs).call(request)

data/lib/google/gax/bundling.rb

@@ -116,7 +116,7 @@ module Google
       # The number of bundled elements in the repeated field.
       # @return [Numeric]
       def element_count
-        @inputs.reduce(0) { |a, e| a + e.count }
+        @inputs.reduce(0) { |acc, elem| acc + elem.count }
       end
 
       # The size of the request in bytes of the bundled field elements.

data/lib/google/gax/constants.rb

@@ -0,0 +1,34 @@
+# Copyright 2016, Google Inc.
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met:
+#
+#     * Redistributions of source code must retain the above copyright
+# notice, this list of conditions and the following disclaimer.
+#     * Redistributions in binary form must reproduce the above
+# copyright notice, this list of conditions and the following disclaimer
+# in the documentation and/or other materials provided with the
+# distribution.
+#     * Neither the name of Google Inc. nor the names of its
+# contributors may be used to endorse or promote products derived from
+# this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+module Google
+  module Gax
+    MILLIS_PER_SECOND = 1000.0
+  end
+end

data/lib/google/gax/operation.rb

@@ -0,0 +1,253 @@
+# Copyright 2016, Google Inc.
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met:
+#
+#     * Redistributions of source code must retain the above copyright
+# notice, this list of conditions and the following disclaimer.
+#     * Redistributions in binary form must reproduce the above
+# copyright notice, this list of conditions and the following disclaimer
+# in the documentation and/or other materials provided with the
+# distribution.
+#     * Neither the name of Google Inc. nor the names of its
+# contributors may be used to endorse or promote products derived from
+# this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+require 'time'
+
+# These must be loaded separate from google/gax to avoid circular dependency.
+require 'google/gax/constants'
+require 'google/gax/settings'
+
+module Google
+  module Gax
+    # A class used to wrap Google::Longrunning::Operation objects. This class
+    # provides helper methods to check the status of an Operation
+    #
+    # @example Checking Operation status
+    #   require 'google/gax/operation'
+    #   require 'google/longrunning/operations_client'
+    #
+    #   operations_client = Google::Longrunning::OperationsClient.new
+    #   op = Google::Gax::Operation.new(
+    #     api.methodThatReturnsOperation(),
+    #     operations_client,
+    #     Google::Example::ResultType,
+    #     Google::Example::MetadataType
+    #   )
+    #
+    #   op.done? # => false
+    #   op.reload! # => operation completed
+    #
+    #   if op.done?
+    #     results = op.results
+    #     handle_error(results) if op.error?
+    #     # Handle results.
+    #   end
+    #
+    # @example Working with callbacks
+    #   require 'google/gax/operation'
+    #   require 'google/longrunning/operations_client'
+    #
+    #   operations_client = Google::Longrunning::OperationsClient.new
+    #   op = Google::Gax::Operation.new(
+    #     api.method_that_returns_operation,
+    #     operations_client,
+    #     Google::Example::ResultType,
+    #     Google::Example::MetadataType
+    #   )
+    #
+    #   # Register a callback to be run when an operation is done.
+    #   op.on_done do |operation|
+    #     raise operation.results.message if operation.error?
+    #     # process(operation.results)
+    #     # process(operation.metadata)
+    #   end
+    #
+    #   # Reload the operation running callbacks if operation completed.
+    #   op.reload!
+    #
+    #   # Or block until the operation completes, passing a block to be called
+    #   # on completion.
+    #   op.wait_until_done do |operation|
+    #     raise operation.results.message if operation.error?
+    #     # process(operation.results)
+    #     # process(operation.rmetadata)
+    #   end
+    #
+    # @attribute [r] grpc_op
+    #   @return [Google::Longrunning::Operation] The wrapped grpc
+    #     operation object.
+    # @attribute [rw] call_options
+    #   @return [Google::Gax::CallOptions] The call options used when reloading
+    #     the operation.
+    class Operation
+      attr_reader :grpc_op
+
+      attr_accessor :call_options
+
+      # @param grpc_op [Google::Longrunning::Operation]
+      #   The inital longrunning operation.
+      # @param client [Google::Longrunning::OperationsClient]
+      #   The client that handles the grpc operations.
+      # @param result_type [Class] The class type to be unpacked from the
+      #   result.
+      # @param metadata_type [Class] The class type to be unpacked from the
+      #   metadata.
+      # @param call_options [Google::Gax::CallOptions]
+      #   The call options that are used when reloading the operation.
+      def initialize(grpc_op, client, result_type, metadata_type,
+                     call_options: nil)
+        @grpc_op = grpc_op
+        @client = client
+        @call_options = call_options
+        @result_type = result_type
+        @metadata_type = metadata_type
+        @callbacks = []
+      end
+
+      # If the operation is done, returns the result, otherwise returns nil.
+      # If the operation response is an error, the error will be returned.
+      # If a type is provided, the response will be unpacked using the type
+      # provided; returning nil if the response is not of the type provided.
+      # If the type is not of provided, the response will be unpacked using
+      # the response's type_url if the type_url is found in the
+      # Google::Protobuf::DescriptorPool.generated_pool.
+      # If the type cannot be found the raw response is retuned.
+      #
+      # @return [Object, Google::Rpc::Status, nil]
+      #   The result of the operation. If it is an error a Google::Rpc::Status
+      #   will be returned.
+      def results
+        return nil unless done?
+        return @grpc_op.error if error?
+        unpack(@grpc_op.response, @result_type)
+      end
+
+      # Returns the metadata of an operation. If a type is provided,
+      # the metadata will be unpacked using the type provided; returning nil
+      # if the metadata is not of the type provided.
+      # If the type is not of provided, the metadata will be unpacked using
+      # the metadata's type_url if the type_url is found in the
+      # Google::Protobuf::DescriptorPool.generated_pool.
+      # If the type cannot be found the raw metadata is retuned.
+      #
+      # @return [Object, nil]
+      #   The metadata of the operation. Can be nil.
+      def metadata
+        return nil if @grpc_op.metadata.nil?
+        unpack(@grpc_op.metadata, @metadata_type)
+      end
+
+      # Checks if the operation is done. This does not send a new api call,
+      # but checks the result of the previous api call to see if done.
+      #
+      # @return [Boolean] Whether the operation is done.
+      def done?
+        @grpc_op.done
+      end
+
+      # Checks if the operation is done and the result is an error.
+      # If the operation is not finished then this will return false.
+      #
+      # @return [Boolean] Whether an error has been returned.
+      def error?
+        done? ? @grpc_op.result == :error : false
+      end
+
+      # Cancels the operation.
+      def cancel
+        @client.cancel_operation(@grpc_op.name)
+      end
+
+      # Reloads the operation object.
+      #
+      # @return [Google::Gax::Operation]
+      #   Since this method changes internal state, it returns itself.
+      def reload!
+        @grpc_op = @client.get_operation(@grpc_op.name, options: @call_options)
+        if done?
+          @callbacks.each { |proc| proc.call(self) }
+          @callbacks.clear
+        end
+        self
+      end
+      alias refresh! reload!
+
+      # Blocking method to wait until the operation has completed or the
+      # maximum timeout has been reached. Upon completion, registered callbacks
+      # will be called, then - if a block is given - the block will be called.
+      #
+      # @param backoff_settings [Google::Gax::BackoffSettings]
+      #   The backoff settings used to manipulate how this method retries
+      #   checking if the operation is done.
+      # @yield operation [Google::Gax::Operation] Yields the finished Operation.
+      def wait_until_done!(backoff_settings: nil)
+        unless backoff_settings
+          backoff_settings = BackoffSettings.new(
+            10 * MILLIS_PER_SECOND,
+            1.3,
+            5 * 60 * MILLIS_PER_SECOND,
+            0,
+            0,
+            0,
+            60 * 60 * MILLIS_PER_SECOND
+          )
+        end
+
+        delay = backoff_settings.initial_retry_delay_millis / MILLIS_PER_SECOND
+        max_delay = backoff_settings.max_retry_delay_millis / MILLIS_PER_SECOND
+        delay_multiplier = backoff_settings.retry_delay_multiplier
+        total_timeout =
+          backoff_settings.total_timeout_millis / MILLIS_PER_SECOND
+        deadline = Time.now + total_timeout
+        until done?
+          sleep(delay)
+          if Time.now >= deadline
+            raise RetryError, 'Retry total timeout exceeded with exception'
+          end
+          delay = [delay * delay_multiplier, max_delay].min
+          reload!
+        end
+        yield(self) if block_given?
+      end
+
+      # Registers a callback to be run when a refreshed operation is marked
+      # as done. If the operation has completed prior to a call to this function
+      # the callback will be called instead of registered.
+      #
+      # @yield operation [Google::Gax::Operation] Yields the finished Operation.
+      def on_done(&block)
+        if done?
+          yield(self)
+        else
+          @callbacks.push(block)
+        end
+      end
+
+      # TODO: This is from google/protobuf/well_known_types.rb.
+      # Using google/protobuf in gax-ruby is currently causing a dependency
+      # conflict with grpc. When grpc depends on google-protobuf v3.1.0
+      # remove this function and use Google::Protobuf::Any#unpack.
+      def unpack(any_pb, klass)
+        type_name = any_pb.type_url.split('/')[-1]
+        return klass.decode(any_pb.value) if type_name == klass.descriptor.name
+      end
+      private :unpack
+    end
+  end
+end