Class: Google::Cloud::Dialogflow::V2::KnowledgeBases::Rest::Client
- Inherits:
-
Object
- Object
- Google::Cloud::Dialogflow::V2::KnowledgeBases::Rest::Client
- Includes:
- Paths
- Defined in:
- lib/google/cloud/dialogflow/v2/knowledge_bases/rest/client.rb
Overview
REST client for the KnowledgeBases service.
Service for managing KnowledgeBases.
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.
Class Method Summary collapse
-
.configure {|config| ... } ⇒ Client::Configuration
Configure the KnowledgeBases Client class.
Instance Method Summary collapse
-
#configure {|config| ... } ⇒ Client::Configuration
Configure the KnowledgeBases Client instance.
-
#create_knowledge_base(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Dialogflow::V2::KnowledgeBase
Creates a knowledge base.
-
#delete_knowledge_base(request, options = nil) {|result, operation| ... } ⇒ ::Google::Protobuf::Empty
Deletes the specified knowledge base.
-
#get_knowledge_base(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Dialogflow::V2::KnowledgeBase
Retrieves the specified knowledge base.
-
#initialize {|config| ... } ⇒ Client
constructor
Create a new KnowledgeBases REST client object.
-
#list_knowledge_bases(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dialogflow::V2::KnowledgeBase>
Returns the list of all knowledge bases of the specified agent.
-
#update_knowledge_base(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Dialogflow::V2::KnowledgeBase
Updates the specified knowledge base.
Methods included from Paths
#knowledge_base_path, #location_path, #project_path
Constructor Details
#initialize {|config| ... } ⇒ Client
Create a new KnowledgeBases 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 |
# File 'lib/google/cloud/dialogflow/v2/knowledge_bases/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 @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 @knowledge_bases_stub = ::Google::Cloud::Dialogflow::V2::KnowledgeBases::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.
155 156 157 |
# File 'lib/google/cloud/dialogflow/v2/knowledge_bases/rest/client.rb', line 155 def location_client @location_client end |
Class Method Details
.configure {|config| ... } ⇒ Client::Configuration
Configure the KnowledgeBases 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/knowledge_bases/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
#configure {|config| ... } ⇒ Client::Configuration
Configure the KnowledgeBases 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/knowledge_bases/rest/client.rb', line 97 def configure yield @config if block_given? @config end |
#create_knowledge_base(request, options = nil) ⇒ ::Google::Cloud::Dialogflow::V2::KnowledgeBase #create_knowledge_base(parent: nil, knowledge_base: nil) ⇒ ::Google::Cloud::Dialogflow::V2::KnowledgeBase
Creates a knowledge base.
401 402 403 404 405 406 407 408 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 |
# File 'lib/google/cloud/dialogflow/v2/knowledge_bases/rest/client.rb', line 401 def create_knowledge_base request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::V2::CreateKnowledgeBaseRequest # 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_knowledge_base..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_knowledge_base.timeout, metadata: , retry_policy: @config.rpcs.create_knowledge_base.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @knowledge_bases_stub.create_knowledge_base 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_knowledge_base(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_knowledge_base(name: nil, force: nil) ⇒ ::Google::Protobuf::Empty
Deletes the specified knowledge base.
484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 |
# File 'lib/google/cloud/dialogflow/v2/knowledge_bases/rest/client.rb', line 484 def delete_knowledge_base request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::V2::DeleteKnowledgeBaseRequest # 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_knowledge_base..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_knowledge_base.timeout, metadata: , retry_policy: @config.rpcs.delete_knowledge_base.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @knowledge_bases_stub.delete_knowledge_base 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_knowledge_base(request, options = nil) ⇒ ::Google::Cloud::Dialogflow::V2::KnowledgeBase #get_knowledge_base(name: nil) ⇒ ::Google::Cloud::Dialogflow::V2::KnowledgeBase
Retrieves the specified knowledge base.
320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 |
# File 'lib/google/cloud/dialogflow/v2/knowledge_bases/rest/client.rb', line 320 def get_knowledge_base request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::V2::GetKnowledgeBaseRequest # 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_knowledge_base..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_knowledge_base.timeout, metadata: , retry_policy: @config.rpcs.get_knowledge_base.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @knowledge_bases_stub.get_knowledge_base 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_knowledge_bases(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dialogflow::V2::KnowledgeBase> #list_knowledge_bases(parent: nil, page_size: nil, page_token: nil, filter: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dialogflow::V2::KnowledgeBase>
Returns the list of all knowledge bases of the specified agent.
239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 |
# File 'lib/google/cloud/dialogflow/v2/knowledge_bases/rest/client.rb', line 239 def list_knowledge_bases request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::V2::ListKnowledgeBasesRequest # 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_knowledge_bases..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_knowledge_bases.timeout, metadata: , retry_policy: @config.rpcs.list_knowledge_bases.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @knowledge_bases_stub.list_knowledge_bases request, do |result, operation| result = ::Gapic::Rest::PagedEnumerable.new @knowledge_bases_stub, :list_knowledge_bases, "knowledge_bases", request, result, yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end |
#update_knowledge_base(request, options = nil) ⇒ ::Google::Cloud::Dialogflow::V2::KnowledgeBase #update_knowledge_base(knowledge_base: nil, update_mask: nil) ⇒ ::Google::Cloud::Dialogflow::V2::KnowledgeBase
Updates the specified knowledge base.
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 594 595 596 597 598 599 |
# File 'lib/google/cloud/dialogflow/v2/knowledge_bases/rest/client.rb', line 566 def update_knowledge_base request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::V2::UpdateKnowledgeBaseRequest # 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_knowledge_base..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_knowledge_base.timeout, metadata: , retry_policy: @config.rpcs.update_knowledge_base.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @knowledge_bases_stub.update_knowledge_base 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 |