google-cloud-dialogflow-v2 0.6.2 → 0.8.1

data/lib/google/cloud/dialogflow/v2/intents/operations.rb

@@ -103,8 +103,13 @@ module Google
             # Lists operations that match the specified filter in the request. If the
             # server doesn't support this method, it returns `UNIMPLEMENTED`.
             #
-            # NOTE: the `name` binding below allows API services to override the binding
-            # to use different resource name schemes, such as `users/*/operations`.
+            # NOTE: the `name` binding allows API services to override the binding
+            # to use different resource name schemes, such as `users/*/operations`. To
+            # override the binding, API services can add a binding such as
+            # `"/v1/{name=users/*}/operations"` to their service configuration.
+            # For backwards compatibility, the default name includes the operations
+            # collection id, however overriding users must ensure the name binding
+            # is the parent resource, without the operations collection id.
             #
             # @overload list_operations(request, options = nil)
             #   Pass arguments to `list_operations` via a request object, either of type
@@ -122,7 +127,7 @@ module Google
             #   the default parameter values, pass an empty Hash as a request object (see above).
             #
             #   @param name [::String]
-            #     The name of the operation collection.
+            #     The name of the operation's parent resource.
             #   @param filter [::String]
             #     The standard list filter.
             #   @param page_size [::Integer]
@@ -390,6 +395,79 @@ module Google
               raise ::Google::Cloud::Error.from_error(e)
             end
 
+            ##
+            # Waits for the specified long-running operation until it is done or reaches
+            # at most a specified timeout, returning the latest state.  If the operation
+            # is already done, the latest state is immediately returned.  If the timeout
+            # specified is greater than the default HTTP/RPC timeout, the HTTP/RPC
+            # timeout is used.  If the server does not support this method, it returns
+            # `google.rpc.Code.UNIMPLEMENTED`.
+            # Note that this method is on a best-effort basis.  It may return the latest
+            # state before the specified timeout (including immediately), meaning even an
+            # immediate response is no guarantee that the operation is done.
+            #
+            # @overload wait_operation(request, options = nil)
+            #   Pass arguments to `wait_operation` via a request object, either of type
+            #   {::Google::Longrunning::WaitOperationRequest} or an equivalent Hash.
+            #
+            #   @param request [::Google::Longrunning::WaitOperationRequest, ::Hash]
+            #     A request object representing the call parameters. Required. To specify no
+            #     parameters, or to keep all the default parameter values, pass an empty Hash.
+            #   @param options [::Gapic::CallOptions, ::Hash]
+            #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
+            #
+            # @overload wait_operation(name: nil, timeout: nil)
+            #   Pass arguments to `wait_operation` via keyword arguments. Note that at
+            #   least one keyword argument is required. To specify no parameters, or to keep all
+            #   the default parameter values, pass an empty Hash as a request object (see above).
+            #
+            #   @param name [::String]
+            #     The name of the operation resource to wait on.
+            #   @param timeout [::Google::Protobuf::Duration, ::Hash]
+            #     The maximum duration to wait before timing out. If left blank, the wait
+            #     will be at most the time permitted by the underlying HTTP/RPC protocol.
+            #     If RPC context deadline is also specified, the shorter one will be used.
+            #
+            # @yield [response, operation] Access the result along with the RPC operation
+            # @yieldparam response [::Gapic::Operation]
+            # @yieldparam operation [::GRPC::ActiveCall::Operation]
+            #
+            # @return [::Gapic::Operation]
+            #
+            # @raise [::Google::Cloud::Error] if the RPC is aborted.
+            #
+            def wait_operation request, options = nil
+              raise ::ArgumentError, "request must be provided" if request.nil?
+
+              request = ::Gapic::Protobuf.coerce request, to: ::Google::Longrunning::WaitOperationRequest
+
+              # Converts hash and nil to an options object
+              options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+
+              # Customize the options with defaults
+              metadata = @config.rpcs.wait_operation.metadata.to_h
+
+              # Set x-goog-api-client and x-goog-user-project 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::Dialogflow::V2::VERSION
+              metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+              options.apply_defaults timeout:      @config.rpcs.wait_operation.timeout,
+                                     metadata:     metadata,
+                                     retry_policy: @config.rpcs.wait_operation.retry_policy
+              options.apply_defaults metadata:     @config.metadata,
+                                     retry_policy: @config.retry_policy
+
+              @operations_stub.call_rpc :wait_operation, request, options: options do |response, operation|
+                response = ::Gapic::Operation.new response, @operations_client, options: options
+                yield response, operation if block_given?
+                return response
+              end
+            rescue ::GRPC::BadStatus => e
+              raise ::Google::Cloud::Error.from_error(e)
+            end
+
             ##
             # Configuration class for the Operations API.
             #
@@ -475,14 +553,14 @@ module Google
 
               config_attr :endpoint,      "dialogflow.googleapis.com", ::String
               config_attr :credentials,   nil do |value|
-                allowed = [::String, ::Hash, ::Proc, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
+                allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
                 allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
                 allowed.any? { |klass| klass === value }
               end
               config_attr :scope,         nil, ::String, ::Array, nil
               config_attr :lib_name,      nil, ::String, nil
               config_attr :lib_version,   nil, ::String, nil
-              config_attr(:channel_args,  { "grpc.service_config_disable_resolution"=>1 }, ::Hash, nil)
+              config_attr(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
               config_attr :interceptors,  nil, ::Array, nil
               config_attr :timeout,       nil, ::Numeric, nil
               config_attr :metadata,      nil, ::Hash, nil
@@ -503,7 +581,7 @@ module Google
               def rpcs
                 @rpcs ||= begin
                   parent_rpcs = nil
-                  parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config&.respond_to?(:rpcs)
+                  parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
                   Rpcs.new parent_rpcs
                 end
               end
@@ -515,7 +593,7 @@ module Google
               # Each configuration object is of type `Gapic::Config::Method` and includes
               # the following configuration fields:
               #
-              #  *  `timeout` (*type:* `Numeric`) - The call timeout in milliseconds
+              #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
               #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
               #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
               #     include the following keys:
@@ -546,17 +624,24 @@ module Google
                 # @return [::Gapic::Config::Method]
                 #
                 attr_reader :cancel_operation
+                ##
+                # RPC-specific configuration for `wait_operation`
+                # @return [::Gapic::Config::Method]
+                #
+                attr_reader :wait_operation
 
                 # @private
                 def initialize parent_rpcs = nil
-                  list_operations_config = parent_rpcs&.list_operations if parent_rpcs&.respond_to? :list_operations
+                  list_operations_config = parent_rpcs.list_operations if parent_rpcs.respond_to? :list_operations
                   @list_operations = ::Gapic::Config::Method.new list_operations_config
-                  get_operation_config = parent_rpcs&.get_operation if parent_rpcs&.respond_to? :get_operation
+                  get_operation_config = parent_rpcs.get_operation if parent_rpcs.respond_to? :get_operation
                   @get_operation = ::Gapic::Config::Method.new get_operation_config
-                  delete_operation_config = parent_rpcs&.delete_operation if parent_rpcs&.respond_to? :delete_operation
+                  delete_operation_config = parent_rpcs.delete_operation if parent_rpcs.respond_to? :delete_operation
                   @delete_operation = ::Gapic::Config::Method.new delete_operation_config
-                  cancel_operation_config = parent_rpcs&.cancel_operation if parent_rpcs&.respond_to? :cancel_operation
+                  cancel_operation_config = parent_rpcs.cancel_operation if parent_rpcs.respond_to? :cancel_operation
                   @cancel_operation = ::Gapic::Config::Method.new cancel_operation_config
+                  wait_operation_config = parent_rpcs.wait_operation if parent_rpcs.respond_to? :wait_operation
+                  @wait_operation = ::Gapic::Config::Method.new wait_operation_config
 
                   yield self if block_given?
                 end

data/lib/google/cloud/dialogflow/v2/intents/paths.rb

@@ -27,15 +27,37 @@ module Google
             ##
             # Create a fully-qualified Agent resource string.
             #
-            # The resource will be in the following format:
+            # @overload agent_path(project:)
+            #   The resource will be in the following format:
+            #
+            #   `projects/{project}/agent`
+            #
+            #   @param project [String]
             #
-            # `projects/{project}/agent`
+            # @overload agent_path(project:, location:)
+            #   The resource will be in the following format:
+            #
+            #   `projects/{project}/locations/{location}/agent`
             #
-            # @param project [String]
+            #   @param project [String]
+            #   @param location [String]
             #
             # @return [::String]
-            def agent_path project:
-              "projects/#{project}/agent"
+            def agent_path **args
+              resources = {
+                "project" => (proc do |project:|
+                  "projects/#{project}/agent"
+                end),
+                "location:project" => (proc do |project:, location:|
+                  raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+
+                  "projects/#{project}/locations/#{location}/agent"
+                end)
+              }
+
+              resource = resources[args.keys.sort.join(":")]
+              raise ::ArgumentError, "no resource found for values #{args.keys}" if resource.nil?
+              resource.call(**args)
             end
 
             ##
@@ -61,10 +83,32 @@ module Google
             #   @param session [String]
             #   @param context [String]
             #
+            # @overload context_path(project:, location:, session:, context:)
+            #   The resource will be in the following format:
+            #
+            #   `projects/{project}/locations/{location}/agent/sessions/{session}/contexts/{context}`
+            #
+            #   @param project [String]
+            #   @param location [String]
+            #   @param session [String]
+            #   @param context [String]
+            #
+            # @overload context_path(project:, location:, environment:, user:, session:, context:)
+            #   The resource will be in the following format:
+            #
+            #   `projects/{project}/locations/{location}/agent/environments/{environment}/users/{user}/sessions/{session}/contexts/{context}`
+            #
+            #   @param project [String]
+            #   @param location [String]
+            #   @param environment [String]
+            #   @param user [String]
+            #   @param session [String]
+            #   @param context [String]
+            #
             # @return [::String]
             def context_path **args
               resources = {
-                "context:project:session"                  => (proc do |project:, session:, context:|
+                "context:project:session" => (proc do |project:, session:, context:|
                   raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
                   raise ::ArgumentError, "session cannot contain /" if session.to_s.include? "/"
 
@@ -77,6 +121,22 @@ module Google
                   raise ::ArgumentError, "session cannot contain /" if session.to_s.include? "/"
 
                   "projects/#{project}/agent/environments/#{environment}/users/#{user}/sessions/#{session}/contexts/#{context}"
+                end),
+                "context:location:project:session" => (proc do |project:, location:, session:, context:|
+                  raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+                  raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
+                  raise ::ArgumentError, "session cannot contain /" if session.to_s.include? "/"
+
+                  "projects/#{project}/locations/#{location}/agent/sessions/#{session}/contexts/#{context}"
+                end),
+                "context:environment:location:project:session:user" => (proc do |project:, location:, environment:, user:, session:, context:|
+                  raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+                  raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
+                  raise ::ArgumentError, "environment cannot contain /" if environment.to_s.include? "/"
+                  raise ::ArgumentError, "user cannot contain /" if user.to_s.include? "/"
+                  raise ::ArgumentError, "session cannot contain /" if session.to_s.include? "/"
+
+                  "projects/#{project}/locations/#{location}/agent/environments/#{environment}/users/#{user}/sessions/#{session}/contexts/#{context}"
                 end)
               }
 
@@ -88,18 +148,42 @@ module Google
             ##
             # Create a fully-qualified Intent resource string.
             #
-            # The resource will be in the following format:
+            # @overload intent_path(project:, intent:)
+            #   The resource will be in the following format:
+            #
+            #   `projects/{project}/agent/intents/{intent}`
+            #
+            #   @param project [String]
+            #   @param intent [String]
+            #
+            # @overload intent_path(project:, location:, intent:)
+            #   The resource will be in the following format:
             #
-            # `projects/{project}/agent/intents/{intent}`
+            #   `projects/{project}/locations/{location}/agent/intents/{intent}`
             #
-            # @param project [String]
-            # @param intent [String]
+            #   @param project [String]
+            #   @param location [String]
+            #   @param intent [String]
             #
             # @return [::String]
-            def intent_path project:, intent:
-              raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+            def intent_path **args
+              resources = {
+                "intent:project" => (proc do |project:, intent:|
+                  raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
 
-              "projects/#{project}/agent/intents/#{intent}"
+                  "projects/#{project}/agent/intents/#{intent}"
+                end),
+                "intent:location:project" => (proc do |project:, location:, intent:|
+                  raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+                  raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
+
+                  "projects/#{project}/locations/#{location}/agent/intents/#{intent}"
+                end)
+              }
+
+              resource = resources[args.keys.sort.join(":")]
+              raise ::ArgumentError, "no resource found for values #{args.keys}" if resource.nil?
+              resource.call(**args)
             end
 
             extend self

data/lib/google/cloud/dialogflow/v2/knowledge_base_pb.rb

@@ -0,0 +1,60 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/cloud/dialogflow/v2/knowledge_base.proto
+
+require 'google/protobuf'
+
+require 'google/api/annotations_pb'
+require 'google/api/client_pb'
+require 'google/api/field_behavior_pb'
+require 'google/api/resource_pb'
+require 'google/protobuf/empty_pb'
+require 'google/protobuf/field_mask_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("google/cloud/dialogflow/v2/knowledge_base.proto", :syntax => :proto3) do
+    add_message "google.cloud.dialogflow.v2.KnowledgeBase" do
+      optional :name, :string, 1
+      optional :display_name, :string, 2
+      optional :language_code, :string, 4
+    end
+    add_message "google.cloud.dialogflow.v2.ListKnowledgeBasesRequest" do
+      optional :parent, :string, 1
+      optional :page_size, :int32, 2
+      optional :page_token, :string, 3
+    end
+    add_message "google.cloud.dialogflow.v2.ListKnowledgeBasesResponse" do
+      repeated :knowledge_bases, :message, 1, "google.cloud.dialogflow.v2.KnowledgeBase"
+      optional :next_page_token, :string, 2
+    end
+    add_message "google.cloud.dialogflow.v2.GetKnowledgeBaseRequest" do
+      optional :name, :string, 1
+    end
+    add_message "google.cloud.dialogflow.v2.CreateKnowledgeBaseRequest" do
+      optional :parent, :string, 1
+      optional :knowledge_base, :message, 2, "google.cloud.dialogflow.v2.KnowledgeBase"
+    end
+    add_message "google.cloud.dialogflow.v2.DeleteKnowledgeBaseRequest" do
+      optional :name, :string, 1
+      optional :force, :bool, 2
+    end
+    add_message "google.cloud.dialogflow.v2.UpdateKnowledgeBaseRequest" do
+      optional :knowledge_base, :message, 1, "google.cloud.dialogflow.v2.KnowledgeBase"
+      optional :update_mask, :message, 2, "google.protobuf.FieldMask"
+    end
+  end
+end
+
+module Google
+  module Cloud
+    module Dialogflow
+      module V2
+        KnowledgeBase = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.KnowledgeBase").msgclass
+        ListKnowledgeBasesRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.ListKnowledgeBasesRequest").msgclass
+        ListKnowledgeBasesResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.ListKnowledgeBasesResponse").msgclass
+        GetKnowledgeBaseRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.GetKnowledgeBaseRequest").msgclass
+        CreateKnowledgeBaseRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.CreateKnowledgeBaseRequest").msgclass
+        DeleteKnowledgeBaseRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.DeleteKnowledgeBaseRequest").msgclass
+        UpdateKnowledgeBaseRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.UpdateKnowledgeBaseRequest").msgclass
+      end
+    end
+  end
+end

data/lib/google/cloud/dialogflow/v2/knowledge_base_services_pb.rb

@@ -0,0 +1,53 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# Source: google/cloud/dialogflow/v2/knowledge_base.proto for package 'google.cloud.dialogflow.v2'
+# Original file comments:
+# Copyright 2021 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
+#
+#     http://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 'grpc'
+require 'google/cloud/dialogflow/v2/knowledge_base_pb'
+
+module Google
+  module Cloud
+    module Dialogflow
+      module V2
+        module KnowledgeBases
+          # Service for managing [KnowledgeBases][google.cloud.dialogflow.v2.KnowledgeBase].
+          class Service
+
+            include ::GRPC::GenericService
+
+            self.marshal_class_method = :encode
+            self.unmarshal_class_method = :decode
+            self.service_name = 'google.cloud.dialogflow.v2.KnowledgeBases'
+
+            # Returns the list of all knowledge bases of the specified agent.
+            rpc :ListKnowledgeBases, ::Google::Cloud::Dialogflow::V2::ListKnowledgeBasesRequest, ::Google::Cloud::Dialogflow::V2::ListKnowledgeBasesResponse
+            # Retrieves the specified knowledge base.
+            rpc :GetKnowledgeBase, ::Google::Cloud::Dialogflow::V2::GetKnowledgeBaseRequest, ::Google::Cloud::Dialogflow::V2::KnowledgeBase
+            # Creates a knowledge base.
+            rpc :CreateKnowledgeBase, ::Google::Cloud::Dialogflow::V2::CreateKnowledgeBaseRequest, ::Google::Cloud::Dialogflow::V2::KnowledgeBase
+            # Deletes the specified knowledge base.
+            rpc :DeleteKnowledgeBase, ::Google::Cloud::Dialogflow::V2::DeleteKnowledgeBaseRequest, ::Google::Protobuf::Empty
+            # Updates the specified knowledge base.
+            rpc :UpdateKnowledgeBase, ::Google::Cloud::Dialogflow::V2::UpdateKnowledgeBaseRequest, ::Google::Cloud::Dialogflow::V2::KnowledgeBase
+          end
+
+          Stub = Service.rpc_stub_class
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/dialogflow/v2/knowledge_bases.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+require "gapic/common"
+require "gapic/config"
+require "gapic/config/method"
+
+require "google/cloud/dialogflow/v2/version"
+
+require "google/cloud/dialogflow/v2/knowledge_bases/credentials"
+require "google/cloud/dialogflow/v2/knowledge_bases/paths"
+require "google/cloud/dialogflow/v2/knowledge_bases/client"
+
+module Google
+  module Cloud
+    module Dialogflow
+      module V2
+        ##
+        # Service for managing {::Google::Cloud::Dialogflow::V2::KnowledgeBase KnowledgeBases}.
+        #
+        # To load this service and instantiate a client:
+        #
+        #     require "google/cloud/dialogflow/v2/knowledge_bases"
+        #     client = ::Google::Cloud::Dialogflow::V2::KnowledgeBases::Client.new
+        #
+        module KnowledgeBases
+        end
+      end
+    end
+  end
+end
+
+helper_path = ::File.join __dir__, "knowledge_bases", "helpers.rb"
+require "google/cloud/dialogflow/v2/knowledge_bases/helpers" if ::File.file? helper_path