google-cloud-dialogflow-cx-v3 0.2.0 → 0.5.0

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

@@ -182,6 +182,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::SecuritySettingsService::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Dialogflow::CX::V3::CreateSecuritySettingsRequest.new
+              #
+              #   # Call the create_security_settings method.
+              #   result = client.create_security_settings request
+              #
+              #   # The returned object is of type Google::Cloud::Dialogflow::CX::V3::SecuritySettings.
+              #   p result
+              #
               def create_security_settings request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -199,9 +214,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
 
@@ -253,6 +270,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::SecuritySettingsService::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Dialogflow::CX::V3::GetSecuritySettingsRequest.new
+              #
+              #   # Call the get_security_settings method.
+              #   result = client.get_security_settings request
+              #
+              #   # The returned object is of type Google::Cloud::Dialogflow::CX::V3::SecuritySettings.
+              #   p result
+              #
               def get_security_settings request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -270,9 +302,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
 
@@ -325,6 +359,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::SecuritySettingsService::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Dialogflow::CX::V3::UpdateSecuritySettingsRequest.new
+              #
+              #   # Call the update_security_settings method.
+              #   result = client.update_security_settings request
+              #
+              #   # The returned object is of type Google::Cloud::Dialogflow::CX::V3::SecuritySettings.
+              #   p result
+              #
               def update_security_settings request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -342,9 +391,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 = {
-                  "security_settings.name" => request.security_settings.name
-                }
+                header_params = {}
+                if request.security_settings&.name
+                  header_params["security_settings.name"] = request.security_settings.name
+                end
+
                 request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
                 metadata[:"x-goog-request-params"] ||= request_params_header
 
@@ -399,6 +450,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::SecuritySettingsService::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Dialogflow::CX::V3::ListSecuritySettingsRequest.new
+              #
+              #   # Call the list_security_settings method.
+              #   result = client.list_security_settings 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::SecuritySettings.
+              #     p response
+              #   end
+              #
               def list_security_settings 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 = {
-                  "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
 
@@ -470,6 +544,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::SecuritySettingsService::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Dialogflow::CX::V3::DeleteSecuritySettingsRequest.new
+              #
+              #   # Call the delete_security_settings method.
+              #   result = client.delete_security_settings request
+              #
+              #   # The returned object is of type Google::Protobuf::Empty.
+              #   p result
+              #
               def delete_security_settings request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -487,9 +576,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/session_entity_types/client.rb

@@ -189,6 +189,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::SessionEntityTypes::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Dialogflow::CX::V3::ListSessionEntityTypesRequest.new
+              #
+              #   # Call the list_session_entity_types method.
+              #   result = client.list_session_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::SessionEntityType.
+              #     p response
+              #   end
+              #
               def list_session_entity_types request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -206,9 +227,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
 
@@ -264,6 +287,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::SessionEntityTypes::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Dialogflow::CX::V3::GetSessionEntityTypeRequest.new
+              #
+              #   # Call the get_session_entity_type method.
+              #   result = client.get_session_entity_type request
+              #
+              #   # The returned object is of type Google::Cloud::Dialogflow::CX::V3::SessionEntityType.
+              #   p result
+              #
               def get_session_entity_type request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -281,9 +319,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
 
@@ -339,6 +379,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::SessionEntityTypes::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Dialogflow::CX::V3::CreateSessionEntityTypeRequest.new
+              #
+              #   # Call the create_session_entity_type method.
+              #   result = client.create_session_entity_type request
+              #
+              #   # The returned object is of type Google::Cloud::Dialogflow::CX::V3::SessionEntityType.
+              #   p result
+              #
               def create_session_entity_type request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -356,9 +411,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
 
@@ -415,6 +472,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::SessionEntityTypes::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Dialogflow::CX::V3::UpdateSessionEntityTypeRequest.new
+              #
+              #   # Call the update_session_entity_type method.
+              #   result = client.update_session_entity_type request
+              #
+              #   # The returned object is of type Google::Cloud::Dialogflow::CX::V3::SessionEntityType.
+              #   p result
+              #
               def update_session_entity_type request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -432,9 +504,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 = {
-                  "session_entity_type.name" => request.session_entity_type.name
-                }
+                header_params = {}
+                if request.session_entity_type&.name
+                  header_params["session_entity_type.name"] = request.session_entity_type.name
+                end
+
                 request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
                 metadata[:"x-goog-request-params"] ||= request_params_header
 
@@ -489,6 +563,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::SessionEntityTypes::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Dialogflow::CX::V3::DeleteSessionEntityTypeRequest.new
+              #
+              #   # Call the delete_session_entity_type method.
+              #   result = client.delete_session_entity_type request
+              #
+              #   # The returned object is of type Google::Protobuf::Empty.
+              #   p result
+              #
               def delete_session_entity_type request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -506,9 +595,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/sessions/client.rb

@@ -216,6 +216,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::Sessions::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Dialogflow::CX::V3::DetectIntentRequest.new
+              #
+              #   # Call the detect_intent method.
+              #   result = client.detect_intent request
+              #
+              #   # The returned object is of type Google::Cloud::Dialogflow::CX::V3::DetectIntentResponse.
+              #   p result
+              #
               def detect_intent request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -233,9 +248,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 = {
-                  "session" => request.session
-                }
+                header_params = {}
+                if request.session
+                  header_params["session"] = request.session
+                end
+
                 request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
                 metadata[:"x-goog-request-params"] ||= request_params_header
 
@@ -277,6 +294,30 @@ 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::Sessions::Client.new
+              #
+              #   # Create an input stream
+              #   input = Gapic::StreamInput.new
+              #
+              #   # Call the streaming_detect_intent method to start streaming.
+              #   output = client.streaming_detect_intent input
+              #
+              #   # Send requests on the stream. For each request, pass in keyword
+              #   # arguments to set fields. Be sure to close the stream when done.
+              #   input << Google::Cloud::Dialogflow::CX::V3::StreamingDetectIntentRequest.new
+              #   input << Google::Cloud::Dialogflow::CX::V3::StreamingDetectIntentRequest.new
+              #   input.close
+              #
+              #   # Handle streamed responses. These may be interleaved with inputs.
+              #   # Each response is of type ::Google::Cloud::Dialogflow::CX::V3::StreamingDetectIntentResponse.
+              #   output.each do |response|
+              #     p response
+              #   end
+              #
               def streaming_detect_intent request, options = nil
                 unless request.is_a? ::Enumerable
                   raise ::ArgumentError, "request must be an Enumerable" unless request.respond_to? :to_enum
@@ -360,6 +401,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::Sessions::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Dialogflow::CX::V3::MatchIntentRequest.new
+              #
+              #   # Call the match_intent method.
+              #   result = client.match_intent request
+              #
+              #   # The returned object is of type Google::Cloud::Dialogflow::CX::V3::MatchIntentResponse.
+              #   p result
+              #
               def match_intent request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -377,9 +433,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 = {
-                  "session" => request.session
-                }
+                header_params = {}
+                if request.session
+                  header_params["session"] = request.session
+                end
+
                 request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
                 metadata[:"x-goog-request-params"] ||= request_params_header
 
@@ -435,6 +493,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::Sessions::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Dialogflow::CX::V3::FulfillIntentRequest.new
+              #
+              #   # Call the fulfill_intent method.
+              #   result = client.fulfill_intent request
+              #
+              #   # The returned object is of type Google::Cloud::Dialogflow::CX::V3::FulfillIntentResponse.
+              #   p result
+              #
               def fulfill_intent request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -452,9 +525,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 = {
-                  "match_intent_request.session" => request.match_intent_request.session
-                }
+                header_params = {}
+                if request.match_intent_request&.session
+                  header_params["match_intent_request.session"] = request.match_intent_request.session
+                end
+
                 request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
                 metadata[:"x-goog-request-params"] ||= request_params_header