Class: Google::Cloud::Dialogflow::V2::ConversationProfiles::Rest::Client
- Inherits:
-
Object
- Object
- Google::Cloud::Dialogflow::V2::ConversationProfiles::Rest::Client
- Includes:
- Paths
- Defined in:
- lib/google/cloud/dialogflow/v2/conversation_profiles/rest/client.rb
Overview
REST client for the ConversationProfiles service.
Service for managing ConversationProfiles.
Defined Under Namespace
Classes: Configuration
Instance Attribute Summary collapse
-
#location_client ⇒ Google::Cloud::Location::Locations::Rest::Client
readonly
Get the associated client for mix-in of the Locations.
-
#operations_client ⇒ ::Google::Cloud::Dialogflow::V2::ConversationProfiles::Rest::Operations
readonly
Get the associated client for long-running operations.
Class Method Summary collapse
-
.configure {|config| ... } ⇒ Client::Configuration
Configure the ConversationProfiles Client class.
Instance Method Summary collapse
-
#clear_suggestion_feature_config(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::Operation
Clears a suggestion feature from a conversation profile for the given participant role.
-
#configure {|config| ... } ⇒ Client::Configuration
Configure the ConversationProfiles Client instance.
-
#create_conversation_profile(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Dialogflow::V2::ConversationProfile
Creates a conversation profile in the specified project.
-
#delete_conversation_profile(request, options = nil) {|result, operation| ... } ⇒ ::Google::Protobuf::Empty
Deletes the specified conversation profile.
-
#get_conversation_profile(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Dialogflow::V2::ConversationProfile
Retrieves the specified conversation profile.
-
#initialize {|config| ... } ⇒ Client
constructor
Create a new ConversationProfiles REST client object.
-
#list_conversation_profiles(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dialogflow::V2::ConversationProfile>
Returns the list of all conversation profiles in the specified project.
-
#set_suggestion_feature_config(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::Operation
Adds or updates a suggestion feature in a conversation profile.
-
#update_conversation_profile(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Dialogflow::V2::ConversationProfile
Updates the specified conversation profile.
Methods included from Paths
#agent_path, #conversation_model_path, #conversation_profile_path, #cx_security_settings_path, #document_path, #knowledge_base_path, #location_path, #project_path
Constructor Details
#initialize {|config| ... } ⇒ Client
Create a new ConversationProfiles REST client object.
118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 |
# File 'lib/google/cloud/dialogflow/v2/conversation_profiles/rest/client.rb', line 118 def initialize # Create the configuration object @config = Configuration.new Client.configure # Yield the configuration if needed yield @config if block_given? # Create credentials credentials = @config.credentials # Use self-signed JWT if the endpoint is unchanged from default, # but only if the default endpoint does not have a region prefix. enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT && !@config.endpoint.split(".").first.include?("-") credentials ||= Credentials.default scope: @config.scope, enable_self_signed_jwt: enable_self_signed_jwt if credentials.is_a?(::String) || credentials.is_a?(::Hash) credentials = Credentials.new credentials, scope: @config.scope end @quota_project_id = @config.quota_project @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id @operations_client = ::Google::Cloud::Dialogflow::V2::ConversationProfiles::Rest::Operations.new do |config| config.credentials = credentials config.quota_project = @quota_project_id config.endpoint = @config.endpoint end @location_client = Google::Cloud::Location::Locations::Rest::Client.new do |config| config.credentials = credentials config.quota_project = @quota_project_id config.endpoint = @config.endpoint config.bindings_override = @config.bindings_override end @conversation_profiles_stub = ::Google::Cloud::Dialogflow::V2::ConversationProfiles::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials end |
Instance Attribute Details
#location_client ⇒ Google::Cloud::Location::Locations::Rest::Client (readonly)
Get the associated client for mix-in of the Locations.
168 169 170 |
# File 'lib/google/cloud/dialogflow/v2/conversation_profiles/rest/client.rb', line 168 def location_client @location_client end |
#operations_client ⇒ ::Google::Cloud::Dialogflow::V2::ConversationProfiles::Rest::Operations (readonly)
Get the associated client for long-running operations.
161 162 163 |
# File 'lib/google/cloud/dialogflow/v2/conversation_profiles/rest/client.rb', line 161 def operations_client @operations_client end |
Class Method Details
.configure {|config| ... } ⇒ Client::Configuration
Configure the ConversationProfiles Client class.
See Configuration for a description of the configuration fields.
60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 |
# File 'lib/google/cloud/dialogflow/v2/conversation_profiles/rest/client.rb', line 60 def self.configure @configure ||= begin namespace = ["Google", "Cloud", "Dialogflow", "V2"] parent_config = while namespace.any? parent_name = namespace.join "::" parent_const = const_get parent_name break parent_const.configure if parent_const.respond_to? :configure namespace.pop end default_config = Client::Configuration.new parent_config default_config.timeout = 60.0 default_config.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14] } default_config end yield @configure if block_given? @configure end |
Instance Method Details
#clear_suggestion_feature_config(request, options = nil) ⇒ ::Gapic::Operation #clear_suggestion_feature_config(conversation_profile: nil, participant_role: nil, suggestion_feature_type: nil) ⇒ ::Gapic::Operation
Clears a suggestion feature from a conversation profile for the given participant role.
This method is a long-running
operation.
The returned Operation type has the following method-specific fields:
metadata: ClearSuggestionFeatureConfigOperationMetadataresponse: ConversationProfile
639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 |
# File 'lib/google/cloud/dialogflow/v2/conversation_profiles/rest/client.rb', line 639 def clear_suggestion_feature_config request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::V2::ClearSuggestionFeatureConfigRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.clear_suggestion_feature_config..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION, transports_version_send: [:rest] [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.clear_suggestion_feature_config.timeout, metadata: , retry_policy: @config.rpcs.clear_suggestion_feature_config.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @conversation_profiles_stub.clear_suggestion_feature_config request, do |result, operation| result = ::Gapic::Operation.new result, @operations_client, options: yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end |
#configure {|config| ... } ⇒ Client::Configuration
Configure the ConversationProfiles Client instance.
The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on configure.
See Configuration for a description of the configuration fields.
97 98 99 100 |
# File 'lib/google/cloud/dialogflow/v2/conversation_profiles/rest/client.rb', line 97 def configure yield @config if block_given? @config end |
#create_conversation_profile(request, options = nil) ⇒ ::Google::Cloud::Dialogflow::V2::ConversationProfile #create_conversation_profile(parent: nil, conversation_profile: nil) ⇒ ::Google::Cloud::Dialogflow::V2::ConversationProfile
Creates a conversation profile in the specified project.
[ConversationProfile.CreateTime][] and [ConversationProfile.UpdateTime][] aren't populated in the response. You can retrieve them via GetConversationProfile API.
340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 |
# File 'lib/google/cloud/dialogflow/v2/conversation_profiles/rest/client.rb', line 340 def create_conversation_profile request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::V2::CreateConversationProfileRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.create_conversation_profile..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION, transports_version_send: [:rest] [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.create_conversation_profile.timeout, metadata: , retry_policy: @config.rpcs.create_conversation_profile.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @conversation_profiles_stub.create_conversation_profile request, do |result, operation| yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end |
#delete_conversation_profile(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_conversation_profile(name: nil) ⇒ ::Google::Protobuf::Empty
Deletes the specified conversation profile.
473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 |
# File 'lib/google/cloud/dialogflow/v2/conversation_profiles/rest/client.rb', line 473 def delete_conversation_profile request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::V2::DeleteConversationProfileRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.delete_conversation_profile..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION, transports_version_send: [:rest] [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.delete_conversation_profile.timeout, metadata: , retry_policy: @config.rpcs.delete_conversation_profile.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @conversation_profiles_stub.delete_conversation_profile request, do |result, operation| yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end |
#get_conversation_profile(request, options = nil) ⇒ ::Google::Cloud::Dialogflow::V2::ConversationProfile #get_conversation_profile(name: nil) ⇒ ::Google::Cloud::Dialogflow::V2::ConversationProfile
Retrieves the specified conversation profile.
270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 |
# File 'lib/google/cloud/dialogflow/v2/conversation_profiles/rest/client.rb', line 270 def get_conversation_profile request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::V2::GetConversationProfileRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.get_conversation_profile..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION, transports_version_send: [:rest] [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.get_conversation_profile.timeout, metadata: , retry_policy: @config.rpcs.get_conversation_profile.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @conversation_profiles_stub.get_conversation_profile request, do |result, operation| yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end |
#list_conversation_profiles(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dialogflow::V2::ConversationProfile> #list_conversation_profiles(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dialogflow::V2::ConversationProfile>
Returns the list of all conversation profiles in the specified project.
205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 |
# File 'lib/google/cloud/dialogflow/v2/conversation_profiles/rest/client.rb', line 205 def list_conversation_profiles request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::V2::ListConversationProfilesRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.list_conversation_profiles..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION, transports_version_send: [:rest] [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.list_conversation_profiles.timeout, metadata: , retry_policy: @config.rpcs.list_conversation_profiles.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @conversation_profiles_stub.list_conversation_profiles request, do |result, operation| result = ::Gapic::Rest::PagedEnumerable.new @conversation_profiles_stub, :list_conversation_profiles, "conversation_profiles", request, result, yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end |
#set_suggestion_feature_config(request, options = nil) ⇒ ::Gapic::Operation #set_suggestion_feature_config(conversation_profile: nil, participant_role: nil, suggestion_feature_config: nil) ⇒ ::Gapic::Operation
Adds or updates a suggestion feature in a conversation profile. If the conversation profile contains the type of suggestion feature for the participant role, it will update it. Otherwise it will insert the suggestion feature.
This method is a long-running
operation.
The returned Operation type has the following method-specific fields:
metadata: SetSuggestionFeatureConfigOperationMetadataresponse: ConversationProfile
If a long running operation to add or update suggestion feature config for the same conversation profile, participant role and suggestion feature type exists, please cancel the existing long running operation before sending such request, otherwise the request will be rejected.
559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 |
# File 'lib/google/cloud/dialogflow/v2/conversation_profiles/rest/client.rb', line 559 def set_suggestion_feature_config request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::V2::SetSuggestionFeatureConfigRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.set_suggestion_feature_config..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION, transports_version_send: [:rest] [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.set_suggestion_feature_config.timeout, metadata: , retry_policy: @config.rpcs.set_suggestion_feature_config.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @conversation_profiles_stub.set_suggestion_feature_config request, do |result, operation| result = ::Gapic::Operation.new result, @operations_client, options: yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end |
#update_conversation_profile(request, options = nil) ⇒ ::Google::Cloud::Dialogflow::V2::ConversationProfile #update_conversation_profile(conversation_profile: nil, update_mask: nil) ⇒ ::Google::Cloud::Dialogflow::V2::ConversationProfile
Updates the specified conversation profile.
[ConversationProfile.CreateTime][] and [ConversationProfile.UpdateTime][] aren't populated in the response. You can retrieve them via GetConversationProfile API.
409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 |
# File 'lib/google/cloud/dialogflow/v2/conversation_profiles/rest/client.rb', line 409 def update_conversation_profile request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::V2::UpdateConversationProfileRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.update_conversation_profile..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION, transports_version_send: [:rest] [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.update_conversation_profile.timeout, metadata: , retry_policy: @config.rpcs.update_conversation_profile.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @conversation_profiles_stub.update_conversation_profile request, do |result, operation| yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end |