google-cloud-dialogflow-v2 0.3.0 → 0.4.0

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

@@ -16,11 +16,7 @@
 
 # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
 
-require "gapic/common"
 require "gapic/operation"
-
-require "google/cloud/dialogflow/v2/version"
-require "google/cloud/dialogflow/v2/agents/client"
 require "google/longrunning/operations_pb"
 
 module Google
@@ -109,16 +105,20 @@ module Google
             # to use different resource name schemes, such as `users/*/operations`.
             #
             # @overload list_operations(request, options = nil)
-            #   @param request [Google::Longrunning::ListOperationsRequest | Hash]
-            #     Lists operations that match the specified filter in the request. If the
-            #     server doesn't support this method, it returns `UNIMPLEMENTED`.
+            #   Pass arguments to `list_operations` via a request object, either of type
+            #   {Google::Longrunning::ListOperationsRequest} or an equivalent Hash.
             #
-            #     NOTE: the `name` binding below allows API services to override the binding
-            #     to use different resource name schemes, such as `users/*/operations`.
+            #   @param request [Google::Longrunning::ListOperationsRequest, 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 list_operations(name: nil, filter: nil, page_size: nil, page_token: nil)
+            #   Pass arguments to `list_operations` 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 collection.
             #   @param filter [String]
@@ -128,7 +128,6 @@ module Google
             #   @param page_token [String]
             #     The standard list page token.
             #
-            #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [Gapic::PagedEnumerable<Gapic::Operation>]
             # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -182,18 +181,23 @@ module Google
             # service.
             #
             # @overload get_operation(request, options = nil)
-            #   @param request [Google::Longrunning::GetOperationRequest | Hash]
-            #     Gets the latest state of a long-running operation.  Clients can use this
-            #     method to poll the operation result at intervals as recommended by the API
-            #     service.
+            #   Pass arguments to `get_operation` via a request object, either of type
+            #   {Google::Longrunning::GetOperationRequest} or an equivalent Hash.
+            #
+            #   @param request [Google::Longrunning::GetOperationRequest, 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 get_operation(name: nil)
+            #   Pass arguments to `get_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.
             #
-            #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [Gapic::Operation]
             # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -247,19 +251,23 @@ module Google
             # `google.rpc.Code.UNIMPLEMENTED`.
             #
             # @overload delete_operation(request, options = nil)
-            #   @param request [Google::Longrunning::DeleteOperationRequest | Hash]
-            #     Deletes a long-running operation. This method indicates that the client is
-            #     no longer interested in the operation result. It does not cancel the
-            #     operation. If the server doesn't support this method, it returns
-            #     `google.rpc.Code.UNIMPLEMENTED`.
+            #   Pass arguments to `delete_operation` via a request object, either of type
+            #   {Google::Longrunning::DeleteOperationRequest} or an equivalent Hash.
+            #
+            #   @param request [Google::Longrunning::DeleteOperationRequest, 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 delete_operation(name: nil)
+            #   Pass arguments to `delete_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 be deleted.
             #
-            #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [Google::Protobuf::Empty]
             # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -318,25 +326,23 @@ module Google
             # corresponding to `Code.CANCELLED`.
             #
             # @overload cancel_operation(request, options = nil)
-            #   @param request [Google::Longrunning::CancelOperationRequest | Hash]
-            #     Starts asynchronous cancellation on a long-running operation.  The server
-            #     makes a best effort to cancel the operation, but success is not
-            #     guaranteed.  If the server doesn't support this method, it returns
-            #     `google.rpc.Code.UNIMPLEMENTED`.  Clients can use
-            #     Operations.GetOperation or
-            #     other methods to check whether the cancellation succeeded or whether the
-            #     operation completed despite cancellation. On successful cancellation,
-            #     the operation is not deleted; instead, it becomes an operation with
-            #     an {Google::Longrunning::Operation#error Operation.error} value with a {Google::Rpc::Status#code google.rpc.Status.code} of 1,
-            #     corresponding to `Code.CANCELLED`.
+            #   Pass arguments to `cancel_operation` via a request object, either of type
+            #   {Google::Longrunning::CancelOperationRequest} or an equivalent Hash.
+            #
+            #   @param request [Google::Longrunning::CancelOperationRequest, 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 cancel_operation(name: nil)
+            #   Pass arguments to `cancel_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 be cancelled.
             #
-            #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [Google::Protobuf::Empty]
             # @yieldparam operation [GRPC::ActiveCall::Operation]

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

@@ -16,5 +16,51 @@
 
 # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
 
-require "google/cloud/dialogflow/v2/contexts/client"
+require "gapic/common"
+require "gapic/config"
+require "gapic/config/method"
+
+require "google/cloud/dialogflow/v2/version"
+
 require "google/cloud/dialogflow/v2/contexts/credentials"
+require "google/cloud/dialogflow/v2/contexts/paths"
+require "google/cloud/dialogflow/v2/contexts/client"
+
+module Google
+  module Cloud
+    module Dialogflow
+      module V2
+        ##
+        # A context represents additional information included with user input or with
+        # an intent returned by the Dialogflow API. Contexts are helpful for
+        # differentiating user input which may be vague or have a different meaning
+        # depending on additional details from your application such as user setting
+        # and preferences, previous user input, where the user is in your application,
+        # geographic location, and so on.
+        #
+        # You can include contexts as input parameters of a
+        # {Google::Cloud::Dialogflow::V2::Sessions::Client#detect_intent DetectIntent} (or
+        # {Google::Cloud::Dialogflow::V2::Sessions::Client#streaming_detect_intent StreamingDetectIntent}) request,
+        # or as output contexts included in the returned intent.
+        # Contexts expire when an intent is matched, after the number of `DetectIntent`
+        # requests specified by the `lifespan_count` parameter, or after 20 minutes
+        # if no intents are matched for a `DetectIntent` request.
+        #
+        # For more information about contexts, see the
+        # [Dialogflow
+        # documentation](https://cloud.google.com/dialogflow/docs/contexts-overview).
+        #
+        # To load this service and instantiate a client:
+        #
+        #     require "google/cloud/dialogflow/v2/contexts"
+        #     client = Google::Cloud::Dialogflow::V2::Contexts::Client.new
+        #
+        module Contexts
+        end
+      end
+    end
+  end
+end
+
+helper_path = ::File.join __dir__, "contexts", "helpers.rb"
+require "google/cloud/dialogflow/v2/contexts/helpers" if ::File.file? helper_path

data/lib/google/cloud/dialogflow/v2/contexts/client.rb

@@ -16,15 +16,8 @@
 
 # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
 
-require "gapic/common"
-require "gapic/config"
-require "gapic/config/method"
-
 require "google/cloud/errors"
-require "google/cloud/dialogflow/v2/version"
 require "google/cloud/dialogflow/v2/context_pb"
-require "google/cloud/dialogflow/v2/contexts/credentials"
-require "google/cloud/dialogflow/v2/contexts/paths"
 
 module Google
   module Cloud
@@ -207,12 +200,20 @@ module Google
             # Returns the list of all contexts in the specified session.
             #
             # @overload list_contexts(request, options = nil)
-            #   @param request [Google::Cloud::Dialogflow::V2::ListContextsRequest | Hash]
-            #     Returns the list of all contexts in the specified session.
+            #   Pass arguments to `list_contexts` via a request object, either of type
+            #   {Google::Cloud::Dialogflow::V2::ListContextsRequest} or an equivalent Hash.
+            #
+            #   @param request [Google::Cloud::Dialogflow::V2::ListContextsRequest, 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 list_contexts(parent: nil, page_size: nil, page_token: nil)
+            #   Pass arguments to `list_contexts` 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 parent [String]
             #     Required. The session to list all contexts from.
             #     Format: `projects/<Project ID>/agent/sessions/<Session ID>` or
@@ -226,7 +227,6 @@ module Google
             #   @param page_token [String]
             #     Optional. The next_page_token value returned from a previous list request.
             #
-            #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [Gapic::PagedEnumerable<Google::Cloud::Dialogflow::V2::Context>]
             # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -277,12 +277,20 @@ module Google
             # Retrieves the specified context.
             #
             # @overload get_context(request, options = nil)
-            #   @param request [Google::Cloud::Dialogflow::V2::GetContextRequest | Hash]
-            #     Retrieves the specified context.
+            #   Pass arguments to `get_context` via a request object, either of type
+            #   {Google::Cloud::Dialogflow::V2::GetContextRequest} or an equivalent Hash.
+            #
+            #   @param request [Google::Cloud::Dialogflow::V2::GetContextRequest, 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 get_context(name: nil)
+            #   Pass arguments to `get_context` 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]
             #     Required. The name of the context. Format:
             #     `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`
@@ -291,7 +299,6 @@ module Google
             #     If `Environment ID` is not specified, we assume default 'draft'
             #     environment. If `User ID` is not specified, we assume default '-' user.
             #
-            #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [Google::Cloud::Dialogflow::V2::Context]
             # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -343,14 +350,20 @@ module Google
             # If the specified context already exists, overrides the context.
             #
             # @overload create_context(request, options = nil)
-            #   @param request [Google::Cloud::Dialogflow::V2::CreateContextRequest | Hash]
-            #     Creates a context.
+            #   Pass arguments to `create_context` via a request object, either of type
+            #   {Google::Cloud::Dialogflow::V2::CreateContextRequest} or an equivalent Hash.
             #
-            #     If the specified context already exists, overrides the context.
+            #   @param request [Google::Cloud::Dialogflow::V2::CreateContextRequest, 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 create_context(parent: nil, context: nil)
+            #   Pass arguments to `create_context` 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 parent [String]
             #     Required. The session to create a context for.
             #     Format: `projects/<Project ID>/agent/sessions/<Session ID>` or
@@ -358,10 +371,9 @@ module Google
             #     ID>/sessions/<Session ID>`.
             #     If `Environment ID` is not specified, we assume default 'draft'
             #     environment. If `User ID` is not specified, we assume default '-' user.
-            #   @param context [Google::Cloud::Dialogflow::V2::Context | Hash]
+            #   @param context [Google::Cloud::Dialogflow::V2::Context, Hash]
             #     Required. The context to create.
             #
-            #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [Google::Cloud::Dialogflow::V2::Context]
             # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -411,18 +423,25 @@ module Google
             # Updates the specified context.
             #
             # @overload update_context(request, options = nil)
-            #   @param request [Google::Cloud::Dialogflow::V2::UpdateContextRequest | Hash]
-            #     Updates the specified context.
+            #   Pass arguments to `update_context` via a request object, either of type
+            #   {Google::Cloud::Dialogflow::V2::UpdateContextRequest} or an equivalent Hash.
+            #
+            #   @param request [Google::Cloud::Dialogflow::V2::UpdateContextRequest, 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 update_context(context: nil, update_mask: nil)
-            #   @param context [Google::Cloud::Dialogflow::V2::Context | Hash]
+            #   Pass arguments to `update_context` 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 context [Google::Cloud::Dialogflow::V2::Context, Hash]
             #     Required. The context to update.
-            #   @param update_mask [Google::Protobuf::FieldMask | Hash]
+            #   @param update_mask [Google::Protobuf::FieldMask, Hash]
             #     Optional. The mask to control which fields get updated.
             #
-            #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [Google::Cloud::Dialogflow::V2::Context]
             # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -472,12 +491,20 @@ module Google
             # Deletes the specified context.
             #
             # @overload delete_context(request, options = nil)
-            #   @param request [Google::Cloud::Dialogflow::V2::DeleteContextRequest | Hash]
-            #     Deletes the specified context.
+            #   Pass arguments to `delete_context` via a request object, either of type
+            #   {Google::Cloud::Dialogflow::V2::DeleteContextRequest} or an equivalent Hash.
+            #
+            #   @param request [Google::Cloud::Dialogflow::V2::DeleteContextRequest, 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 delete_context(name: nil)
+            #   Pass arguments to `delete_context` 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]
             #     Required. The name of the context to delete. Format:
             #     `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`
@@ -486,7 +513,6 @@ module Google
             #     If `Environment ID` is not specified, we assume default 'draft'
             #     environment. If `User ID` is not specified, we assume default '-' user.
             #
-            #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [Google::Protobuf::Empty]
             # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -536,12 +562,20 @@ module Google
             # Deletes all active contexts in the specified session.
             #
             # @overload delete_all_contexts(request, options = nil)
-            #   @param request [Google::Cloud::Dialogflow::V2::DeleteAllContextsRequest | Hash]
-            #     Deletes all active contexts in the specified session.
+            #   Pass arguments to `delete_all_contexts` via a request object, either of type
+            #   {Google::Cloud::Dialogflow::V2::DeleteAllContextsRequest} or an equivalent Hash.
+            #
+            #   @param request [Google::Cloud::Dialogflow::V2::DeleteAllContextsRequest, 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 delete_all_contexts(parent: nil)
+            #   Pass arguments to `delete_all_contexts` 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 parent [String]
             #     Required. The name of the session to delete all contexts from. Format:
             #     `projects/<Project ID>/agent/sessions/<Session ID>` or `projects/<Project
@@ -550,7 +584,6 @@ module Google
             #     If `Environment ID` is not specified we assume default 'draft' environment.
             #     If `User ID` is not specified, we assume default '-' user.
             #
-            #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [Google::Protobuf::Empty]
             # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -784,13 +817,3 @@ module Google
     end
   end
 end
-
-# rubocop:disable Lint/HandleExceptions
-
-# Once client is loaded, load helpers.rb if it exists.
-begin
-  require "google/cloud/dialogflow/v2/contexts/helpers"
-rescue LoadError
-end
-
-# rubocop:enable Lint/HandleExceptions

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

@@ -71,6 +71,49 @@ module Google
               resource.call(**args)
             end
 
+            ##
+            # Create a fully-qualified Session resource string.
+            #
+            # @overload session_path(project:, session:)
+            #   The resource will be in the following format:
+            #
+            #   `projects/{project}/agent/sessions/{session}`
+            #
+            #   @param project [String]
+            #   @param session [String]
+            #
+            # @overload session_path(project:, environment:, user:, session:)
+            #   The resource will be in the following format:
+            #
+            #   `projects/{project}/agent/environments/{environment}/users/{user}/sessions/{session}`
+            #
+            #   @param project [String]
+            #   @param environment [String]
+            #   @param user [String]
+            #   @param session [String]
+            #
+            # @return [String]
+            def session_path **args
+              resources = {
+                "project:session"                  => (proc do |project:, session:|
+                  raise ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+
+                  "projects/#{project}/agent/sessions/#{session}"
+                end),
+                "environment:project:session:user" => (proc do |project:, environment:, user:, session:|
+                  raise ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+                  raise ArgumentError, "environment cannot contain /" if environment.to_s.include? "/"
+                  raise ArgumentError, "user cannot contain /" if user.to_s.include? "/"
+
+                  "projects/#{project}/agent/environments/#{environment}/users/#{user}/sessions/#{session}"
+                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
           end
         end