google-cloud-dialogflow-cx-v3 0.20.0 → 0.21.0

data/lib/google/cloud/dialogflow/cx/v3/versions/rest/client.rb

@@ -204,6 +204,26 @@ module Google
                 # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dialogflow::CX::V3::Version>]
                 #
                 # @raise [::Google::Cloud::Error] if the REST call 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::Versions::Rest::Client.new
+                #
+                #   # Create a request. To set request fields, pass in keyword arguments.
+                #   request = Google::Cloud::Dialogflow::CX::V3::ListVersionsRequest.new
+                #
+                #   # Call the list_versions method.
+                #   result = client.list_versions request
+                #
+                #   # The returned object is of type Gapic::PagedEnumerable. You can iterate
+                #   # over elements, and API calls will be issued to fetch pages as needed.
+                #   result.each do |item|
+                #     # Each element is of type ::Google::Cloud::Dialogflow::CX::V3::Version.
+                #     p item
+                #   end
+                #
                 def list_versions request, options = nil
                   raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -269,6 +289,22 @@ module Google
                 # @return [::Google::Cloud::Dialogflow::CX::V3::Version]
                 #
                 # @raise [::Google::Cloud::Error] if the REST call 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::Versions::Rest::Client.new
+                #
+                #   # Create a request. To set request fields, pass in keyword arguments.
+                #   request = Google::Cloud::Dialogflow::CX::V3::GetVersionRequest.new
+                #
+                #   # Call the get_version method.
+                #   result = client.get_version request
+                #
+                #   # The returned object is of type Google::Cloud::Dialogflow::CX::V3::Version.
+                #   p result
+                #
                 def get_version request, options = nil
                   raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -345,6 +381,29 @@ module Google
                 # @return [::Gapic::Operation]
                 #
                 # @raise [::Google::Cloud::Error] if the REST call 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::Versions::Rest::Client.new
+                #
+                #   # Create a request. To set request fields, pass in keyword arguments.
+                #   request = Google::Cloud::Dialogflow::CX::V3::CreateVersionRequest.new
+                #
+                #   # Call the create_version method.
+                #   result = client.create_version request
+                #
+                #   # The returned object is of type Gapic::Operation. You can use it to
+                #   # check the status of an operation, cancel it, or wait for results.
+                #   # Here is how to wait for a response.
+                #   result.wait_until_done! timeout: 60
+                #   if result.response?
+                #     p result.response
+                #   else
+                #     puts "No response received."
+                #   end
+                #
                 def create_version request, options = nil
                   raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -411,6 +470,22 @@ module Google
                 # @return [::Google::Cloud::Dialogflow::CX::V3::Version]
                 #
                 # @raise [::Google::Cloud::Error] if the REST call 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::Versions::Rest::Client.new
+                #
+                #   # Create a request. To set request fields, pass in keyword arguments.
+                #   request = Google::Cloud::Dialogflow::CX::V3::UpdateVersionRequest.new
+                #
+                #   # Call the update_version method.
+                #   result = client.update_version request
+                #
+                #   # The returned object is of type Google::Cloud::Dialogflow::CX::V3::Version.
+                #   p result
+                #
                 def update_version request, options = nil
                   raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -475,6 +550,22 @@ module Google
                 # @return [::Google::Protobuf::Empty]
                 #
                 # @raise [::Google::Cloud::Error] if the REST call 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::Versions::Rest::Client.new
+                #
+                #   # Create a request. To set request fields, pass in keyword arguments.
+                #   request = Google::Cloud::Dialogflow::CX::V3::DeleteVersionRequest.new
+                #
+                #   # Call the delete_version method.
+                #   result = client.delete_version request
+                #
+                #   # The returned object is of type Google::Protobuf::Empty.
+                #   p result
+                #
                 def delete_version request, options = nil
                   raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -553,6 +644,29 @@ module Google
                 # @return [::Gapic::Operation]
                 #
                 # @raise [::Google::Cloud::Error] if the REST call 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::Versions::Rest::Client.new
+                #
+                #   # Create a request. To set request fields, pass in keyword arguments.
+                #   request = Google::Cloud::Dialogflow::CX::V3::LoadVersionRequest.new
+                #
+                #   # Call the load_version method.
+                #   result = client.load_version request
+                #
+                #   # The returned object is of type Gapic::Operation. You can use it to
+                #   # check the status of an operation, cancel it, or wait for results.
+                #   # Here is how to wait for a response.
+                #   result.wait_until_done! timeout: 60
+                #   if result.response?
+                #     p result.response
+                #   else
+                #     puts "No response received."
+                #   end
+                #
                 def load_version request, options = nil
                   raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -633,6 +747,22 @@ module Google
                 # @return [::Google::Cloud::Dialogflow::CX::V3::CompareVersionsResponse]
                 #
                 # @raise [::Google::Cloud::Error] if the REST call 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::Versions::Rest::Client.new
+                #
+                #   # Create a request. To set request fields, pass in keyword arguments.
+                #   request = Google::Cloud::Dialogflow::CX::V3::CompareVersionsRequest.new
+                #
+                #   # Call the compare_versions method.
+                #   result = client.compare_versions request
+                #
+                #   # The returned object is of type Google::Cloud::Dialogflow::CX::V3::CompareVersionsResponse.
+                #   p result
+                #
                 def compare_versions request, options = nil
                   raise ::ArgumentError, "request must be provided" if request.nil?
 

data/lib/google/cloud/dialogflow/cx/v3/versions/rest/operations.rb

@@ -137,6 +137,26 @@ module Google
                 # @return [::Gapic::Operation]
                 #
                 # @raise [::Google::Cloud::Error] if the REST call is aborted.
+                #
+                # @example Basic example
+                #   require "google/longrunning"
+                #
+                #   # Create a client object. The client can be reused for multiple calls.
+                #   client = Google::Longrunning::Operations::Rest::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 elements, and API calls will be issued to fetch pages as needed.
+                #   result.each do |item|
+                #     # Each element is of type ::Google::Longrunning::Operation.
+                #     p item
+                #   end
+                #
                 def list_operations request, options = nil
                   raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -202,6 +222,29 @@ module Google
                 # @return [::Gapic::Operation]
                 #
                 # @raise [::Google::Cloud::Error] if the REST call is aborted.
+                #
+                # @example Basic example
+                #   require "google/longrunning"
+                #
+                #   # Create a client object. The client can be reused for multiple calls.
+                #   client = Google::Longrunning::Operations::Rest::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 it to
+                #   # check the status of an operation, cancel it, or wait for results.
+                #   # Here is how to wait for a response.
+                #   result.wait_until_done! timeout: 60
+                #   if result.response?
+                #     p result.response
+                #   else
+                #     puts "No response received."
+                #   end
+                #
                 def get_operation request, options = nil
                   raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -268,6 +311,22 @@ module Google
                 # @return [::Google::Protobuf::Empty]
                 #
                 # @raise [::Google::Cloud::Error] if the REST call is aborted.
+                #
+                # @example Basic example
+                #   require "google/longrunning"
+                #
+                #   # Create a client object. The client can be reused for multiple calls.
+                #   client = Google::Longrunning::Operations::Rest::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?
 
@@ -339,6 +398,22 @@ module Google
                 # @return [::Google::Protobuf::Empty]
                 #
                 # @raise [::Google::Cloud::Error] if the REST call is aborted.
+                #
+                # @example Basic example
+                #   require "google/longrunning"
+                #
+                #   # Create a client object. The client can be reused for multiple calls.
+                #   client = Google::Longrunning::Operations::Rest::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?
 

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

@@ -151,7 +151,8 @@ module Google
                   credentials:  credentials,
                   endpoint:     @config.endpoint,
                   channel_args: @config.channel_args,
-                  interceptors: @config.interceptors
+                  interceptors: @config.interceptors,
+                  channel_pool_config: @config.channel_pool
                 )
               end
 
@@ -740,6 +741,14 @@ module Google
                   end
                 end
 
+                ##
+                # Configuration for the channel pool
+                # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
+                #
+                def channel_pool
+                  @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
+                end
+
                 ##
                 # Configuration RPC class for the Webhooks API.
                 #

data/lib/google/cloud/dialogflow/cx/v3/webhooks/rest/client.rb

@@ -189,6 +189,26 @@ module Google
                 # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dialogflow::CX::V3::Webhook>]
                 #
                 # @raise [::Google::Cloud::Error] if the REST call 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::Webhooks::Rest::Client.new
+                #
+                #   # Create a request. To set request fields, pass in keyword arguments.
+                #   request = Google::Cloud::Dialogflow::CX::V3::ListWebhooksRequest.new
+                #
+                #   # Call the list_webhooks method.
+                #   result = client.list_webhooks request
+                #
+                #   # The returned object is of type Gapic::PagedEnumerable. You can iterate
+                #   # over elements, and API calls will be issued to fetch pages as needed.
+                #   result.each do |item|
+                #     # Each element is of type ::Google::Cloud::Dialogflow::CX::V3::Webhook.
+                #     p item
+                #   end
+                #
                 def list_webhooks request, options = nil
                   raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -254,6 +274,22 @@ module Google
                 # @return [::Google::Cloud::Dialogflow::CX::V3::Webhook]
                 #
                 # @raise [::Google::Cloud::Error] if the REST call 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::Webhooks::Rest::Client.new
+                #
+                #   # Create a request. To set request fields, pass in keyword arguments.
+                #   request = Google::Cloud::Dialogflow::CX::V3::GetWebhookRequest.new
+                #
+                #   # Call the get_webhook method.
+                #   result = client.get_webhook request
+                #
+                #   # The returned object is of type Google::Cloud::Dialogflow::CX::V3::Webhook.
+                #   p result
+                #
                 def get_webhook request, options = nil
                   raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -319,6 +355,22 @@ module Google
                 # @return [::Google::Cloud::Dialogflow::CX::V3::Webhook]
                 #
                 # @raise [::Google::Cloud::Error] if the REST call 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::Webhooks::Rest::Client.new
+                #
+                #   # Create a request. To set request fields, pass in keyword arguments.
+                #   request = Google::Cloud::Dialogflow::CX::V3::CreateWebhookRequest.new
+                #
+                #   # Call the create_webhook method.
+                #   result = client.create_webhook request
+                #
+                #   # The returned object is of type Google::Cloud::Dialogflow::CX::V3::Webhook.
+                #   p result
+                #
                 def create_webhook request, options = nil
                   raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -384,6 +436,22 @@ module Google
                 # @return [::Google::Cloud::Dialogflow::CX::V3::Webhook]
                 #
                 # @raise [::Google::Cloud::Error] if the REST call 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::Webhooks::Rest::Client.new
+                #
+                #   # Create a request. To set request fields, pass in keyword arguments.
+                #   request = Google::Cloud::Dialogflow::CX::V3::UpdateWebhookRequest.new
+                #
+                #   # Call the update_webhook method.
+                #   result = client.update_webhook request
+                #
+                #   # The returned object is of type Google::Cloud::Dialogflow::CX::V3::Webhook.
+                #   p result
+                #
                 def update_webhook request, options = nil
                   raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -459,6 +527,22 @@ module Google
                 # @return [::Google::Protobuf::Empty]
                 #
                 # @raise [::Google::Cloud::Error] if the REST call 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::Webhooks::Rest::Client.new
+                #
+                #   # Create a request. To set request fields, pass in keyword arguments.
+                #   request = Google::Cloud::Dialogflow::CX::V3::DeleteWebhookRequest.new
+                #
+                #   # Call the delete_webhook method.
+                #   result = client.delete_webhook request
+                #
+                #   # The returned object is of type Google::Protobuf::Empty.
+                #   p result
+                #
                 def delete_webhook request, options = nil
                   raise ::ArgumentError, "request must be provided" if request.nil?
 

data/proto_docs/google/api/field_behavior.rb

@@ -66,6 +66,20 @@ module Google
       # a non-empty value will be returned. The user will not be aware of what
       # non-empty value to expect.
       NON_EMPTY_DEFAULT = 7
+
+      # Denotes that the field in a resource (a message annotated with
+      # google.api.resource) is used in the resource name to uniquely identify the
+      # resource. For AIP-compliant APIs, this should only be applied to the
+      # `name` field on the resource.
+      #
+      # This behavior should not be applied to references to other resources within
+      # the message.
+      #
+      # The identifier field of resources often have different field behavior
+      # depending on the request it is embedded in (e.g. for Create methods name
+      # is optional and unused, while for Update methods it is required). Instead
+      # of method-specific annotations, only `IDENTIFIER` is required.
+      IDENTIFIER = 8
     end
   end
 end

data/proto_docs/google/cloud/dialogflow/cx/v3/agent.rb

@@ -124,6 +124,9 @@ module Google
           #   @return [::Google::Cloud::Dialogflow::CX::V3::TextToSpeechSettings]
           #     Settings on instructing the speech synthesizer on how to generate the
           #     output audio content.
+          # @!attribute [rw] gen_app_builder_settings
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::Agent::GenAppBuilderSettings]
+          #     Gen App Builder-related agent-level settings.
           class Agent
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -158,6 +161,17 @@ module Google
                 extend ::Google::Protobuf::MessageExts::ClassMethods
               end
             end
+
+            # Settings for Gen App Builder.
+            # @!attribute [rw] engine
+            #   @return [::String]
+            #     Required. The full name of the Gen App Builder engine related to this
+            #     agent if there is one. Format: `projects/{Project ID}/locations/{Location
+            #     ID}/collections/\\{Collection ID}/engines/\\{Engine ID}`
+            class GenAppBuilderSettings
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
           end
 
           # The request message for
@@ -425,6 +439,36 @@ module Google
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
+
+          # Request for
+          # {::Google::Cloud::Dialogflow::CX::V3::Agents::Client#get_generative_settings GetGenerativeSettings}
+          # RPC.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Required. Format: `projects/<Project ID>/locations/<Location
+          #     ID>/agents/<Agent ID>/generativeSettings`.
+          # @!attribute [rw] language_code
+          #   @return [::String]
+          #     Required. Language code of the generative settings.
+          class GetGenerativeSettingsRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Request for
+          # {::Google::Cloud::Dialogflow::CX::V3::Agents::Client#update_generative_settings UpdateGenerativeSettings}
+          # RPC.
+          # @!attribute [rw] generative_settings
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::GenerativeSettings]
+          #     Required. Generative settings to update.
+          # @!attribute [rw] update_mask
+          #   @return [::Google::Protobuf::FieldMask]
+          #     Optional. The mask to control which fields get updated. If the mask is not
+          #     present, all fields will be updated.
+          class UpdateGenerativeSettingsRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
         end
       end
     end

data/proto_docs/google/cloud/dialogflow/cx/v3/data_store_connection.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+# Copyright 2023 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!
+
+
+module Google
+  module Cloud
+    module Dialogflow
+      module CX
+        module V3
+          # A data store connection. It represents a data store in Discovery Engine and
+          # the type of the contents it contains.
+          # @!attribute [rw] data_store_type
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::DataStoreType]
+          #     The type of the connected data store.
+          # @!attribute [rw] data_store
+          #   @return [::String]
+          #     The full name of the referenced data store.
+          #     Formats:
+          #     `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`
+          #     `projects/{project}/locations/{location}/dataStores/{data_store}`
+          class DataStoreConnection
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Type of a data store.
+          # Determines how search is performed in the data store.
+          module DataStoreType
+            # Not specified. This value indicates that the data store type is not
+            # specified, so it will not be used during search.
+            DATA_STORE_TYPE_UNSPECIFIED = 0
+
+            # A data store that contains public web content.
+            PUBLIC_WEB = 1
+
+            # A data store that contains unstructured private data.
+            UNSTRUCTURED = 2
+
+            # A data store that contains structured data (for example FAQ).
+            STRUCTURED = 3
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/dialogflow/cx/v3/flow.rb

@@ -145,6 +145,9 @@ module Google
           # @!attribute [rw] nlu_settings
           #   @return [::Google::Cloud::Dialogflow::CX::V3::NluSettings]
           #     NLU related settings of the flow.
+          # @!attribute [rw] knowledge_connector_settings
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::KnowledgeConnectorSettings]
+          #     Optional. Knowledge connector configuration.
           class Flow
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods