google-cloud-dialogflow-cx-v3 0.1.0 → 0.3.1

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

@@ -0,0 +1,51 @@
+# 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/cx/v3/version"
+
+require "google/cloud/dialogflow/cx/v3/deployments/credentials"
+require "google/cloud/dialogflow/cx/v3/deployments/paths"
+require "google/cloud/dialogflow/cx/v3/deployments/client"
+
+module Google
+  module Cloud
+    module Dialogflow
+      module CX
+        module V3
+          ##
+          # Service for managing {::Google::Cloud::Dialogflow::CX::V3::Deployment Deployments}.
+          #
+          # To load this service and instantiate a client:
+          #
+          #     require "google/cloud/dialogflow/cx/v3/deployments"
+          #     client = ::Google::Cloud::Dialogflow::CX::V3::Deployments::Client.new
+          #
+          module Deployments
+          end
+        end
+      end
+    end
+  end
+end
+
+helper_path = ::File.join __dir__, "deployments", "helpers.rb"
+require "google/cloud/dialogflow/cx/v3/deployments/helpers" if ::File.file? helper_path

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

@@ -1,14 +1,14 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/dialogflow/cx/v3/entity_type.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'
+require 'google/protobuf'
+
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/cloud/dialogflow/cx/v3/entity_type.proto", :syntax => :proto3) do
     add_message "google.cloud.dialogflow.cx.v3.EntityType" do

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

@@ -28,7 +28,7 @@ module Google
             # Service for managing [EntityTypes][google.cloud.dialogflow.cx.v3.EntityType].
             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/entity_types/client.rb

@@ -198,6 +198,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::EntityTypes::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Dialogflow::CX::V3::ListEntityTypesRequest.new
+              #
+              #   # Call the list_entity_types method.
+              #   result = client.list_entity_types 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::EntityType.
+              #     p response
+              #   end
+              #
               def list_entity_types request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -215,9 +236,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
 
@@ -282,6 +305,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::EntityTypes::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Dialogflow::CX::V3::GetEntityTypeRequest.new
+              #
+              #   # Call the get_entity_type method.
+              #   result = client.get_entity_type request
+              #
+              #   # The returned object is of type Google::Cloud::Dialogflow::CX::V3::EntityType.
+              #   p result
+              #
               def get_entity_type request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -299,9 +337,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
 
@@ -369,6 +409,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::EntityTypes::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Dialogflow::CX::V3::CreateEntityTypeRequest.new
+              #
+              #   # Call the create_entity_type method.
+              #   result = client.create_entity_type request
+              #
+              #   # The returned object is of type Google::Cloud::Dialogflow::CX::V3::EntityType.
+              #   p result
+              #
               def create_entity_type request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -386,9 +441,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
 
@@ -455,6 +512,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::EntityTypes::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Dialogflow::CX::V3::UpdateEntityTypeRequest.new
+              #
+              #   # Call the update_entity_type method.
+              #   result = client.update_entity_type request
+              #
+              #   # The returned object is of type Google::Cloud::Dialogflow::CX::V3::EntityType.
+              #   p result
+              #
               def update_entity_type request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -472,9 +544,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 = {
-                  "entity_type.name" => request.entity_type.name
-                }
+                header_params = {}
+                if request.entity_type&.name
+                  header_params["entity_type.name"] = request.entity_type.name
+                end
+
                 request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
                 metadata[:"x-goog-request-params"] ||= request_params_header
 
@@ -540,6 +614,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::EntityTypes::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Dialogflow::CX::V3::DeleteEntityTypeRequest.new
+              #
+              #   # Call the delete_entity_type method.
+              #   result = client.delete_entity_type request
+              #
+              #   # The returned object is of type Google::Protobuf::Empty.
+              #   p result
+              #
               def delete_entity_type request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -557,9 +646,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/environment_pb.rb

@@ -1,8 +1,6 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/dialogflow/cx/v3/environment.proto
 
-require 'google/protobuf'
-
 require 'google/api/annotations_pb'
 require 'google/api/client_pb'
 require 'google/api/field_behavior_pb'
@@ -12,6 +10,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/environment.proto", :syntax => :proto3) do
     add_message "google.cloud.dialogflow.cx.v3.Environment" do
@@ -20,10 +20,16 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :description, :string, 3
       repeated :version_configs, :message, 6, "google.cloud.dialogflow.cx.v3.Environment.VersionConfig"
       optional :update_time, :message, 5, "google.protobuf.Timestamp"
+      optional :test_cases_config, :message, 7, "google.cloud.dialogflow.cx.v3.Environment.TestCasesConfig"
     end
     add_message "google.cloud.dialogflow.cx.v3.Environment.VersionConfig" do
       optional :version, :string, 1
     end
+    add_message "google.cloud.dialogflow.cx.v3.Environment.TestCasesConfig" do
+      repeated :test_cases, :string, 1
+      optional :enable_continuous_run, :bool, 2
+      optional :enable_predeployment_run, :bool, 3
+    end
     add_message "google.cloud.dialogflow.cx.v3.ListEnvironmentsRequest" do
       optional :parent, :string, 1
       optional :page_size, :int32, 2
@@ -85,6 +91,17 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       repeated :continuous_test_results, :message, 1, "google.cloud.dialogflow.cx.v3.ContinuousTestResult"
       optional :next_page_token, :string, 2
     end
+    add_message "google.cloud.dialogflow.cx.v3.DeployFlowRequest" do
+      optional :environment, :string, 1
+      optional :flow_version, :string, 2
+    end
+    add_message "google.cloud.dialogflow.cx.v3.DeployFlowResponse" do
+      optional :environment, :message, 1, "google.cloud.dialogflow.cx.v3.Environment"
+      optional :deployment, :string, 2
+    end
+    add_message "google.cloud.dialogflow.cx.v3.DeployFlowMetadata" do
+      repeated :test_errors, :message, 1, "google.cloud.dialogflow.cx.v3.TestError"
+    end
   end
 end
 
@@ -95,6 +112,7 @@ module Google
         module V3
           Environment = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.cx.v3.Environment").msgclass
           Environment::VersionConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.cx.v3.Environment.VersionConfig").msgclass
+          Environment::TestCasesConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.cx.v3.Environment.TestCasesConfig").msgclass
           ListEnvironmentsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.cx.v3.ListEnvironmentsRequest").msgclass
           ListEnvironmentsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.cx.v3.ListEnvironmentsResponse").msgclass
           GetEnvironmentRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.cx.v3.GetEnvironmentRequest").msgclass
@@ -110,6 +128,9 @@ module Google
           RunContinuousTestMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.cx.v3.RunContinuousTestMetadata").msgclass
           ListContinuousTestResultsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.cx.v3.ListContinuousTestResultsRequest").msgclass
           ListContinuousTestResultsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.cx.v3.ListContinuousTestResultsResponse").msgclass
+          DeployFlowRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.cx.v3.DeployFlowRequest").msgclass
+          DeployFlowResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.cx.v3.DeployFlowResponse").msgclass
+          DeployFlowMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.cx.v3.DeployFlowMetadata").msgclass
         end
       end
     end

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

@@ -28,7 +28,7 @@ module Google
             # Service for managing [Environments][google.cloud.dialogflow.cx.v3.Environment].
             class Service
 
-              include GRPC::GenericService
+              include ::GRPC::GenericService
 
               self.marshal_class_method = :encode
               self.unmarshal_class_method = :decode
@@ -39,17 +39,49 @@ module Google
               # Retrieves the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].
               rpc :GetEnvironment, ::Google::Cloud::Dialogflow::CX::V3::GetEnvironmentRequest, ::Google::Cloud::Dialogflow::CX::V3::Environment
               # Creates an [Environment][google.cloud.dialogflow.cx.v3.Environment] in the specified [Agent][google.cloud.dialogflow.cx.v3.Agent].
+              #
+              # 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`: [Environment][google.cloud.dialogflow.cx.v3.Environment]
               rpc :CreateEnvironment, ::Google::Cloud::Dialogflow::CX::V3::CreateEnvironmentRequest, ::Google::Longrunning::Operation
               # Updates the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].
+              #
+              # 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`: [Environment][google.cloud.dialogflow.cx.v3.Environment]
               rpc :UpdateEnvironment, ::Google::Cloud::Dialogflow::CX::V3::UpdateEnvironmentRequest, ::Google::Longrunning::Operation
               # Deletes the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].
               rpc :DeleteEnvironment, ::Google::Cloud::Dialogflow::CX::V3::DeleteEnvironmentRequest, ::Google::Protobuf::Empty
               # Looks up the history of the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].
               rpc :LookupEnvironmentHistory, ::Google::Cloud::Dialogflow::CX::V3::LookupEnvironmentHistoryRequest, ::Google::Cloud::Dialogflow::CX::V3::LookupEnvironmentHistoryResponse
               # Kicks off a continuous test under the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].
+              #
+              # 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`: [RunContinuousTestMetadata][google.cloud.dialogflow.cx.v3.RunContinuousTestMetadata]
+              # - `response`: [RunContinuousTestResponse][google.cloud.dialogflow.cx.v3.RunContinuousTestResponse]
               rpc :RunContinuousTest, ::Google::Cloud::Dialogflow::CX::V3::RunContinuousTestRequest, ::Google::Longrunning::Operation
               # Fetches a list of continuous test results for a given environment.
               rpc :ListContinuousTestResults, ::Google::Cloud::Dialogflow::CX::V3::ListContinuousTestResultsRequest, ::Google::Cloud::Dialogflow::CX::V3::ListContinuousTestResultsResponse
+              # Deploys a flow to the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].
+              #
+              # 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`: [DeployFlowMetadata][google.cloud.dialogflow.cx.v3.DeployFlowMetadata]
+              # - `response`: [DeployFlowResponse][google.cloud.dialogflow.cx.v3.DeployFlowResponse]
+              rpc :DeployFlow, ::Google::Cloud::Dialogflow::CX::V3::DeployFlowRequest, ::Google::Longrunning::Operation
             end
 
             Stub = Service.rpc_stub_class