google-cloud-dialogflow-cx-v3 0.1.1 → 0.4.0

data/lib/google/cloud/dialogflow/cx/v3/environments/operations.rb

@@ -144,6 +144,27 @@ module Google
               #
               # @raise [::Google::Cloud::Error] if the RPC is aborted.
               #
+              # @example Basic example
+              #   require "google/longrunning"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Longrunning::Operations::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Longrunning::ListOperationsRequest.new
+              #
+              #   # Call the list_operations method.
+              #   result = client.list_operations request
+              #
+              #   # The returned object is of type Gapic::PagedEnumerable. You can
+              #   # iterate over all elements by calling #each, and the enumerable
+              #   # will lazily make API calls to fetch subsequent pages. Other
+              #   # methods are also available for managing paging directly.
+              #   result.each do |response|
+              #     # Each element is of type ::Google::Longrunning::Operation.
+              #     p response
+              #   end
+              #
               def list_operations request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -161,9 +182,11 @@ module Google
                   gapic_version: ::Google::Cloud::Dialogflow::CX::V3::VERSION
                 metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-                header_params = {
-                  "name" => request.name
-                }
+                header_params = {}
+                if request.name
+                  header_params["name"] = request.name
+                end
+
                 request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
                 metadata[:"x-goog-request-params"] ||= request_params_header
 
@@ -216,6 +239,28 @@ module Google
               #
               # @raise [::Google::Cloud::Error] if the RPC is aborted.
               #
+              # @example Basic example
+              #   require "google/longrunning"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Longrunning::Operations::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Longrunning::GetOperationRequest.new
+              #
+              #   # Call the get_operation method.
+              #   result = client.get_operation request
+              #
+              #   # The returned object is of type Gapic::Operation. You can use this
+              #   # object to check the status of an operation, cancel it, or wait
+              #   # for results. Here is how to block until completion:
+              #   result.wait_until_done! timeout: 60
+              #   if result.response?
+              #     p result.response
+              #   else
+              #     puts "Error!"
+              #   end
+              #
               def get_operation request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -233,9 +278,11 @@ module Google
                   gapic_version: ::Google::Cloud::Dialogflow::CX::V3::VERSION
                 metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-                header_params = {
-                  "name" => request.name
-                }
+                header_params = {}
+                if request.name
+                  header_params["name"] = request.name
+                end
+
                 request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
                 metadata[:"x-goog-request-params"] ||= request_params_header
 
@@ -288,6 +335,21 @@ module Google
               #
               # @raise [::Google::Cloud::Error] if the RPC is aborted.
               #
+              # @example Basic example
+              #   require "google/longrunning"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Longrunning::Operations::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Longrunning::DeleteOperationRequest.new
+              #
+              #   # Call the delete_operation method.
+              #   result = client.delete_operation request
+              #
+              #   # The returned object is of type Google::Protobuf::Empty.
+              #   p result
+              #
               def delete_operation request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -305,9 +367,11 @@ module Google
                   gapic_version: ::Google::Cloud::Dialogflow::CX::V3::VERSION
                 metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-                header_params = {
-                  "name" => request.name
-                }
+                header_params = {}
+                if request.name
+                  header_params["name"] = request.name
+                end
+
                 request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
                 metadata[:"x-goog-request-params"] ||= request_params_header
 
@@ -365,6 +429,21 @@ module Google
               #
               # @raise [::Google::Cloud::Error] if the RPC is aborted.
               #
+              # @example Basic example
+              #   require "google/longrunning"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Longrunning::Operations::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Longrunning::CancelOperationRequest.new
+              #
+              #   # Call the cancel_operation method.
+              #   result = client.cancel_operation request
+              #
+              #   # The returned object is of type Google::Protobuf::Empty.
+              #   p result
+              #
               def cancel_operation request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -382,9 +461,11 @@ module Google
                   gapic_version: ::Google::Cloud::Dialogflow::CX::V3::VERSION
                 metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-                header_params = {
-                  "name" => request.name
-                }
+                header_params = {}
+                if request.name
+                  header_params["name"] = request.name
+                end
+
                 request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
                 metadata[:"x-goog-request-params"] ||= request_params_header
 
@@ -445,6 +526,28 @@ module Google
               #
               # @raise [::Google::Cloud::Error] if the RPC is aborted.
               #
+              # @example Basic example
+              #   require "google/longrunning"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Longrunning::Operations::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Longrunning::WaitOperationRequest.new
+              #
+              #   # Call the wait_operation method.
+              #   result = client.wait_operation request
+              #
+              #   # The returned object is of type Gapic::Operation. You can use this
+              #   # object to check the status of an operation, cancel it, or wait
+              #   # for results. Here is how to block until completion:
+              #   result.wait_until_done! timeout: 60
+              #   if result.response?
+              #     p result.response
+              #   else
+              #     puts "Error!"
+              #   end
+              #
               def wait_operation request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 

data/lib/google/cloud/dialogflow/cx/v3/environments/paths.rb

@@ -65,6 +65,27 @@ module Google
                 "projects/#{project}/locations/#{location}/agents/#{agent}/environments/#{environment}"
               end
 
+              ##
+              # Create a fully-qualified TestCase resource string.
+              #
+              # The resource will be in the following format:
+              #
+              # `projects/{project}/locations/{location}/agents/{agent}/testCases/{test_case}`
+              #
+              # @param project [String]
+              # @param location [String]
+              # @param agent [String]
+              # @param test_case [String]
+              #
+              # @return [::String]
+              def test_case_path project:, location:, agent:, test_case:
+                raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+                raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
+                raise ::ArgumentError, "agent cannot contain /" if agent.to_s.include? "/"
+
+                "projects/#{project}/locations/#{location}/agents/#{agent}/testCases/#{test_case}"
+              end
+
               ##
               # Create a fully-qualified Version resource string.
               #

data/lib/google/cloud/dialogflow/cx/v3/experiment_pb.rb

@@ -1,8 +1,6 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/dialogflow/cx/v3/experiment.proto
 
-require 'google/protobuf'
-
 require 'google/api/annotations_pb'
 require 'google/api/client_pb'
 require 'google/api/field_behavior_pb'
@@ -11,6 +9,8 @@ require 'google/protobuf/duration_pb'
 require 'google/protobuf/empty_pb'
 require 'google/protobuf/field_mask_pb'
 require 'google/protobuf/timestamp_pb'
+require 'google/protobuf'
+
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/cloud/dialogflow/cx/v3/experiment.proto", :syntax => :proto3) do
     add_message "google.cloud.dialogflow.cx.v3.Experiment" do

data/lib/google/cloud/dialogflow/cx/v3/experiment_services_pb.rb

@@ -28,7 +28,7 @@ module Google
             # Service for managing [Experiments][google.cloud.dialogflow.cx.v3.Experiment].
             class Service
 
-              include GRPC::GenericService
+              include ::GRPC::GenericService
 
               self.marshal_class_method = :encode
               self.unmarshal_class_method = :decode

data/lib/google/cloud/dialogflow/cx/v3/experiments/client.rb

@@ -186,6 +186,27 @@ module Google
               #
               # @raise [::Google::Cloud::Error] if the RPC is aborted.
               #
+              # @example Basic example
+              #   require "google/cloud/dialogflow/cx/v3"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Dialogflow::CX::V3::Experiments::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Dialogflow::CX::V3::ListExperimentsRequest.new
+              #
+              #   # Call the list_experiments method.
+              #   result = client.list_experiments request
+              #
+              #   # The returned object is of type Gapic::PagedEnumerable. You can
+              #   # iterate over all elements by calling #each, and the enumerable
+              #   # will lazily make API calls to fetch subsequent pages. Other
+              #   # methods are also available for managing paging directly.
+              #   result.each do |response|
+              #     # Each element is of type ::Google::Cloud::Dialogflow::CX::V3::Experiment.
+              #     p response
+              #   end
+              #
               def list_experiments request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -203,9 +224,11 @@ module Google
                   gapic_version: ::Google::Cloud::Dialogflow::CX::V3::VERSION
                 metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-                header_params = {
-                  "parent" => request.parent
-                }
+                header_params = {}
+                if request.parent
+                  header_params["parent"] = request.parent
+                end
+
                 request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
                 metadata[:"x-goog-request-params"] ||= request_params_header
 
@@ -257,6 +280,21 @@ module Google
               #
               # @raise [::Google::Cloud::Error] if the RPC is aborted.
               #
+              # @example Basic example
+              #   require "google/cloud/dialogflow/cx/v3"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Dialogflow::CX::V3::Experiments::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Dialogflow::CX::V3::GetExperimentRequest.new
+              #
+              #   # Call the get_experiment method.
+              #   result = client.get_experiment request
+              #
+              #   # The returned object is of type Google::Cloud::Dialogflow::CX::V3::Experiment.
+              #   p result
+              #
               def get_experiment request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -274,9 +312,11 @@ module Google
                   gapic_version: ::Google::Cloud::Dialogflow::CX::V3::VERSION
                 metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-                header_params = {
-                  "name" => request.name
-                }
+                header_params = {}
+                if request.name
+                  header_params["name"] = request.name
+                end
+
                 request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
                 metadata[:"x-goog-request-params"] ||= request_params_header
 
@@ -329,6 +369,21 @@ module Google
               #
               # @raise [::Google::Cloud::Error] if the RPC is aborted.
               #
+              # @example Basic example
+              #   require "google/cloud/dialogflow/cx/v3"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Dialogflow::CX::V3::Experiments::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Dialogflow::CX::V3::CreateExperimentRequest.new
+              #
+              #   # Call the create_experiment method.
+              #   result = client.create_experiment request
+              #
+              #   # The returned object is of type Google::Cloud::Dialogflow::CX::V3::Experiment.
+              #   p result
+              #
               def create_experiment request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -346,9 +401,11 @@ module Google
                   gapic_version: ::Google::Cloud::Dialogflow::CX::V3::VERSION
                 metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-                header_params = {
-                  "parent" => request.parent
-                }
+                header_params = {}
+                if request.parent
+                  header_params["parent"] = request.parent
+                end
+
                 request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
                 metadata[:"x-goog-request-params"] ||= request_params_header
 
@@ -399,6 +456,21 @@ module Google
               #
               # @raise [::Google::Cloud::Error] if the RPC is aborted.
               #
+              # @example Basic example
+              #   require "google/cloud/dialogflow/cx/v3"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Dialogflow::CX::V3::Experiments::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Dialogflow::CX::V3::UpdateExperimentRequest.new
+              #
+              #   # Call the update_experiment method.
+              #   result = client.update_experiment request
+              #
+              #   # The returned object is of type Google::Cloud::Dialogflow::CX::V3::Experiment.
+              #   p result
+              #
               def update_experiment request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -416,9 +488,11 @@ module Google
                   gapic_version: ::Google::Cloud::Dialogflow::CX::V3::VERSION
                 metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-                header_params = {
-                  "experiment.name" => request.experiment.name
-                }
+                header_params = {}
+                if request.experiment&.name
+                  header_params["experiment.name"] = request.experiment.name
+                end
+
                 request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
                 metadata[:"x-goog-request-params"] ||= request_params_header
 
@@ -469,6 +543,21 @@ module Google
               #
               # @raise [::Google::Cloud::Error] if the RPC is aborted.
               #
+              # @example Basic example
+              #   require "google/cloud/dialogflow/cx/v3"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Dialogflow::CX::V3::Experiments::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Dialogflow::CX::V3::DeleteExperimentRequest.new
+              #
+              #   # Call the delete_experiment method.
+              #   result = client.delete_experiment request
+              #
+              #   # The returned object is of type Google::Protobuf::Empty.
+              #   p result
+              #
               def delete_experiment request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -486,9 +575,11 @@ module Google
                   gapic_version: ::Google::Cloud::Dialogflow::CX::V3::VERSION
                 metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-                header_params = {
-                  "name" => request.name
-                }
+                header_params = {}
+                if request.name
+                  header_params["name"] = request.name
+                end
+
                 request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
                 metadata[:"x-goog-request-params"] ||= request_params_header
 
@@ -540,6 +631,21 @@ module Google
               #
               # @raise [::Google::Cloud::Error] if the RPC is aborted.
               #
+              # @example Basic example
+              #   require "google/cloud/dialogflow/cx/v3"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Dialogflow::CX::V3::Experiments::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Dialogflow::CX::V3::StartExperimentRequest.new
+              #
+              #   # Call the start_experiment method.
+              #   result = client.start_experiment request
+              #
+              #   # The returned object is of type Google::Cloud::Dialogflow::CX::V3::Experiment.
+              #   p result
+              #
               def start_experiment request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -557,9 +663,11 @@ module Google
                   gapic_version: ::Google::Cloud::Dialogflow::CX::V3::VERSION
                 metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-                header_params = {
-                  "name" => request.name
-                }
+                header_params = {}
+                if request.name
+                  header_params["name"] = request.name
+                end
+
                 request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
                 metadata[:"x-goog-request-params"] ||= request_params_header
 
@@ -611,6 +719,21 @@ module Google
               #
               # @raise [::Google::Cloud::Error] if the RPC is aborted.
               #
+              # @example Basic example
+              #   require "google/cloud/dialogflow/cx/v3"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Dialogflow::CX::V3::Experiments::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Dialogflow::CX::V3::StopExperimentRequest.new
+              #
+              #   # Call the stop_experiment method.
+              #   result = client.stop_experiment request
+              #
+              #   # The returned object is of type Google::Cloud::Dialogflow::CX::V3::Experiment.
+              #   p result
+              #
               def stop_experiment request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -628,9 +751,11 @@ module Google
                   gapic_version: ::Google::Cloud::Dialogflow::CX::V3::VERSION
                 metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-                header_params = {
-                  "name" => request.name
-                }
+                header_params = {}
+                if request.name
+                  header_params["name"] = request.name
+                end
+
                 request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
                 metadata[:"x-goog-request-params"] ||= request_params_header
 

data/lib/google/cloud/dialogflow/cx/v3/flow_pb.rb

@@ -1,8 +1,6 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/dialogflow/cx/v3/flow.proto
 
-require 'google/protobuf'
-
 require 'google/api/annotations_pb'
 require 'google/api/client_pb'
 require 'google/api/field_behavior_pb'
@@ -14,6 +12,8 @@ require 'google/longrunning/operations_pb'
 require 'google/protobuf/empty_pb'
 require 'google/protobuf/field_mask_pb'
 require 'google/protobuf/timestamp_pb'
+require 'google/protobuf'
+
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/cloud/dialogflow/cx/v3/flow.proto", :syntax => :proto3) do
     add_message "google.cloud.dialogflow.cx.v3.NluSettings" do

data/lib/google/cloud/dialogflow/cx/v3/flow_services_pb.rb

@@ -28,7 +28,7 @@ module Google
             # Service for managing [Flows][google.cloud.dialogflow.cx.v3.Flow].
             class Service
 
-              include GRPC::GenericService
+              include ::GRPC::GenericService
 
               self.marshal_class_method = :encode
               self.unmarshal_class_method = :decode
@@ -55,6 +55,15 @@ module Google
               # Trains the specified flow. Note that only the flow in 'draft' environment
               # is trained.
               #
+              # This method is a [long-running
+              # operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
+              # The returned `Operation` type has the following method-specific fields:
+              #
+              # - `metadata`: An empty [Struct
+              #   message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
+              # - `response`: An [Empty
+              #   message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
+              #
               # Note: You should always train a flow prior to sending it queries. See the
               # [training
               # documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
@@ -68,12 +77,28 @@ module Google
               rpc :GetFlowValidationResult, ::Google::Cloud::Dialogflow::CX::V3::GetFlowValidationResultRequest, ::Google::Cloud::Dialogflow::CX::V3::FlowValidationResult
               # Imports the specified flow to the specified agent from a binary file.
               #
+              # This method is a [long-running
+              # operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
+              # The returned `Operation` type has the following method-specific fields:
+              #
+              # - `metadata`: An empty [Struct
+              #   message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
+              # - `response`: [ImportFlowResponse][google.cloud.dialogflow.cx.v3.ImportFlowResponse]
+              #
               # Note: You should always train a flow prior to sending it queries. See the
               # [training
               # documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
               rpc :ImportFlow, ::Google::Cloud::Dialogflow::CX::V3::ImportFlowRequest, ::Google::Longrunning::Operation
               # Exports the specified flow to a binary file.
               #
+              # This method is a [long-running
+              # operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
+              # The returned `Operation` type has the following method-specific fields:
+              #
+              # - `metadata`: An empty [Struct
+              #   message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
+              # - `response`: [ExportFlowResponse][google.cloud.dialogflow.cx.v3.ExportFlowResponse]
+              #
               # Note that resources (e.g. intents, entities, webhooks) that the flow
               # references will also be exported.
               rpc :ExportFlow, ::Google::Cloud::Dialogflow::CX::V3::ExportFlowRequest, ::Google::Longrunning::Operation