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

Sign up to get free protection for your applications and to get access to all the features.
Files changed (77) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/google/cloud/dialogflow/cx/v3/advanced_settings_pb.rb +2 -2
  4. data/lib/google/cloud/dialogflow/cx/v3/agent_pb.rb +2 -2
  5. data/lib/google/cloud/dialogflow/cx/v3/agent_services_pb.rb +17 -1
  6. data/lib/google/cloud/dialogflow/cx/v3/agents/client.rb +216 -27
  7. data/lib/google/cloud/dialogflow/cx/v3/agents/operations.rb +115 -12
  8. data/lib/google/cloud/dialogflow/cx/v3/audio_config_pb.rb +3 -2
  9. data/lib/google/cloud/dialogflow/cx/v3/changelog_pb.rb +52 -0
  10. data/lib/google/cloud/dialogflow/cx/v3/changelog_services_pb.rb +49 -0
  11. data/lib/google/cloud/dialogflow/cx/v3/changelogs/client.rb +522 -0
  12. data/lib/google/cloud/dialogflow/cx/v3/changelogs/credentials.rb +54 -0
  13. data/lib/google/cloud/dialogflow/cx/v3/changelogs/paths.rb +75 -0
  14. data/lib/google/cloud/dialogflow/cx/v3/changelogs.rb +51 -0
  15. data/lib/google/cloud/dialogflow/cx/v3/deployment_pb.rb +63 -0
  16. data/lib/google/cloud/dialogflow/cx/v3/deployment_services_pb.rb +49 -0
  17. data/lib/google/cloud/dialogflow/cx/v3/deployments/client.rb +502 -0
  18. data/lib/google/cloud/dialogflow/cx/v3/deployments/credentials.rb +54 -0
  19. data/lib/google/cloud/dialogflow/cx/v3/deployments/paths.rb +79 -0
  20. data/lib/google/cloud/dialogflow/cx/v3/deployments.rb +51 -0
  21. data/lib/google/cloud/dialogflow/cx/v3/entity_type_pb.rb +2 -2
  22. data/lib/google/cloud/dialogflow/cx/v3/entity_type_services_pb.rb +1 -1
  23. data/lib/google/cloud/dialogflow/cx/v3/entity_types/client.rb +106 -15
  24. data/lib/google/cloud/dialogflow/cx/v3/environment_pb.rb +23 -2
  25. data/lib/google/cloud/dialogflow/cx/v3/environment_services_pb.rb +33 -1
  26. data/lib/google/cloud/dialogflow/cx/v3/environments/client.rb +335 -24
  27. data/lib/google/cloud/dialogflow/cx/v3/environments/operations.rb +115 -12
  28. data/lib/google/cloud/dialogflow/cx/v3/environments/paths.rb +21 -0
  29. data/lib/google/cloud/dialogflow/cx/v3/experiment_pb.rb +2 -2
  30. data/lib/google/cloud/dialogflow/cx/v3/experiment_services_pb.rb +1 -1
  31. data/lib/google/cloud/dialogflow/cx/v3/experiments/client.rb +146 -21
  32. data/lib/google/cloud/dialogflow/cx/v3/flow_pb.rb +2 -2
  33. data/lib/google/cloud/dialogflow/cx/v3/flow_services_pb.rb +26 -1
  34. data/lib/google/cloud/dialogflow/cx/v3/flows/client.rb +254 -32
  35. data/lib/google/cloud/dialogflow/cx/v3/flows/operations.rb +115 -12
  36. data/lib/google/cloud/dialogflow/cx/v3/fulfillment_pb.rb +2 -2
  37. data/lib/google/cloud/dialogflow/cx/v3/intent_pb.rb +2 -2
  38. data/lib/google/cloud/dialogflow/cx/v3/intent_services_pb.rb +1 -1
  39. data/lib/google/cloud/dialogflow/cx/v3/intents/client.rb +106 -15
  40. data/lib/google/cloud/dialogflow/cx/v3/page_pb.rb +2 -2
  41. data/lib/google/cloud/dialogflow/cx/v3/page_services_pb.rb +1 -1
  42. data/lib/google/cloud/dialogflow/cx/v3/pages/client.rb +106 -15
  43. data/lib/google/cloud/dialogflow/cx/v3/response_message_pb.rb +2 -2
  44. data/lib/google/cloud/dialogflow/cx/v3/security_settings_pb.rb +2 -2
  45. data/lib/google/cloud/dialogflow/cx/v3/security_settings_service/client.rb +106 -15
  46. data/lib/google/cloud/dialogflow/cx/v3/security_settings_services_pb.rb +1 -1
  47. data/lib/google/cloud/dialogflow/cx/v3/session_entity_type_pb.rb +2 -2
  48. data/lib/google/cloud/dialogflow/cx/v3/session_entity_type_services_pb.rb +1 -1
  49. data/lib/google/cloud/dialogflow/cx/v3/session_entity_types/client.rb +106 -15
  50. data/lib/google/cloud/dialogflow/cx/v3/session_pb.rb +3 -2
  51. data/lib/google/cloud/dialogflow/cx/v3/session_services_pb.rb +1 -1
  52. data/lib/google/cloud/dialogflow/cx/v3/sessions/client.rb +84 -9
  53. data/lib/google/cloud/dialogflow/cx/v3/test_case_pb.rb +2 -2
  54. data/lib/google/cloud/dialogflow/cx/v3/test_case_services_pb.rb +29 -1
  55. data/lib/google/cloud/dialogflow/cx/v3/test_cases/client.rb +308 -36
  56. data/lib/google/cloud/dialogflow/cx/v3/test_cases/operations.rb +115 -12
  57. data/lib/google/cloud/dialogflow/cx/v3/transition_route_group_pb.rb +2 -2
  58. data/lib/google/cloud/dialogflow/cx/v3/transition_route_group_services_pb.rb +1 -1
  59. data/lib/google/cloud/dialogflow/cx/v3/transition_route_groups/client.rb +106 -15
  60. data/lib/google/cloud/dialogflow/cx/v3/validation_message_pb.rb +2 -2
  61. data/lib/google/cloud/dialogflow/cx/v3/version.rb +1 -1
  62. data/lib/google/cloud/dialogflow/cx/v3/version_pb.rb +2 -2
  63. data/lib/google/cloud/dialogflow/cx/v3/version_services_pb.rb +17 -1
  64. data/lib/google/cloud/dialogflow/cx/v3/versions/client.rb +156 -18
  65. data/lib/google/cloud/dialogflow/cx/v3/versions/operations.rb +115 -12
  66. data/lib/google/cloud/dialogflow/cx/v3/webhook_pb.rb +2 -2
  67. data/lib/google/cloud/dialogflow/cx/v3/webhook_services_pb.rb +1 -1
  68. data/lib/google/cloud/dialogflow/cx/v3/webhooks/client.rb +106 -15
  69. data/lib/google/cloud/dialogflow/cx/v3.rb +2 -0
  70. data/proto_docs/google/cloud/dialogflow/cx/v3/changelog.rb +122 -0
  71. data/proto_docs/google/cloud/dialogflow/cx/v3/deployment.rb +135 -0
  72. data/proto_docs/google/cloud/dialogflow/cx/v3/environment.rb +62 -0
  73. data/proto_docs/google/cloud/dialogflow/cx/v3/flow.rb +2 -2
  74. data/proto_docs/google/cloud/dialogflow/cx/v3/security_settings.rb +4 -1
  75. data/proto_docs/google/cloud/dialogflow/cx/v3/session.rb +58 -42
  76. data/proto_docs/google/cloud/dialogflow/cx/v3/test_case.rb +3 -1
  77. metadata +21 -5
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: a60099bd7d5e7f03ef506fb531423a898b8a0414425e4da6285d2fcf8b700b9f
4
- data.tar.gz: 6d555decd058b86ca4e14a908d22ff36d6a81a82d85a640cb199a1c1cecaa91f
3
+ metadata.gz: 647a465151383c26f0ae739d549df516a5c440724d8d85d06a70dc39c59e5b1a
4
+ data.tar.gz: bdd0a39f3c07d4989b5a65fabc54e29ff5cf4a0591a15ff2bd883c82257139aa
5
5
  SHA512:
6
- metadata.gz: afe66e2d92cee8fa60c9ab872451d153a42c2980281f34c214f16b286c626fb0b40aa417d99dde9b0d5034bd056edfb70aa903bb4f34499cd75d1e98ba6ade4a
7
- data.tar.gz: 6170db52cd88e0256f0666d68f3545a0305d8d4145b4e468664d63d91245fbb6483d7f1f1690fcb63a72aa5ace822c157adf93c197e795743c87ac140261d7a3
6
+ metadata.gz: 76fd6117cdd2bfb8b4d9a9c776667f34c9fe219e59fa0f625ba6735287338d997f1409ce86017b08e0cbaf17cf2be3b3c931b8cd97bd222c0c1c1b975bb903f9
7
+ data.tar.gz: 6c88d1b99a86141f1cde52e35b33c1d9fb6a3c56349d8cb2452feaf129ca07af748c9a51bee3fd552397c68b385fb683c649952fdf382450c50bf06826e16d9c
data/README.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  API Client library for the Dialogflow CX V3 API
4
4
 
5
- Dialogflow is an end-to-end, build-once deploy-everywhere development suite for creating conversational interfaces for websites, mobile applications, popular messaging platforms, and IoT devices. You can use it to build interfaces (such as chatbots and conversational IVR) that enable natural and rich interactions between your users and your business.
5
+ Dialogflow is an end-to-end, build-once deploy-everywhere development suite for creating conversational interfaces for websites, mobile applications, popular messaging platforms, and IoT devices. You can use it to build interfaces (such as chatbots and conversational IVR) that enable natural and rich interactions between your users and your business. This client is for Dialogflow CX, providing an advanced agent type suitable for large or very complex agents.
6
6
 
7
7
  https://github.com/googleapis/google-cloud-ruby
8
8
 
@@ -1,11 +1,11 @@
1
1
  # Generated by the protocol buffer compiler. DO NOT EDIT!
2
2
  # source: google/cloud/dialogflow/cx/v3/advanced_settings.proto
3
3
 
4
- require 'google/protobuf'
5
-
6
4
  require 'google/api/field_behavior_pb'
7
5
  require 'google/protobuf/duration_pb'
8
6
  require 'google/api/annotations_pb'
7
+ require 'google/protobuf'
8
+
9
9
  Google::Protobuf::DescriptorPool.generated_pool.build do
10
10
  add_file("google/cloud/dialogflow/cx/v3/advanced_settings.proto", :syntax => :proto3) do
11
11
  add_message "google.cloud.dialogflow.cx.v3.AdvancedSettings" do
@@ -1,8 +1,6 @@
1
1
  # Generated by the protocol buffer compiler. DO NOT EDIT!
2
2
  # source: google/cloud/dialogflow/cx/v3/agent.proto
3
3
 
4
- require 'google/protobuf'
5
-
6
4
  require 'google/api/annotations_pb'
7
5
  require 'google/api/client_pb'
8
6
  require 'google/api/field_behavior_pb'
@@ -13,6 +11,8 @@ require 'google/cloud/dialogflow/cx/v3/security_settings_pb'
13
11
  require 'google/longrunning/operations_pb'
14
12
  require 'google/protobuf/empty_pb'
15
13
  require 'google/protobuf/field_mask_pb'
14
+ require 'google/protobuf'
15
+
16
16
  Google::Protobuf::DescriptorPool.generated_pool.build do
17
17
  add_file("google/cloud/dialogflow/cx/v3/agent.proto", :syntax => :proto3) do
18
18
  add_message "google.cloud.dialogflow.cx.v3.SpeechToTextSettings" do
@@ -28,7 +28,7 @@ module Google
28
28
  # Service for managing [Agents][google.cloud.dialogflow.cx.v3.Agent].
29
29
  class Service
30
30
 
31
- include GRPC::GenericService
31
+ include ::GRPC::GenericService
32
32
 
33
33
  self.marshal_class_method = :encode
34
34
  self.unmarshal_class_method = :decode
@@ -53,12 +53,28 @@ module Google
53
53
  # Deletes the specified agent.
54
54
  rpc :DeleteAgent, ::Google::Cloud::Dialogflow::CX::V3::DeleteAgentRequest, ::Google::Protobuf::Empty
55
55
  # Exports the specified agent to a binary file.
56
+ #
57
+ # This method is a [long-running
58
+ # operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
59
+ # The returned `Operation` type has the following method-specific fields:
60
+ #
61
+ # - `metadata`: An empty [Struct
62
+ # message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
63
+ # - `response`: [ExportAgentResponse][google.cloud.dialogflow.cx.v3.ExportAgentResponse]
56
64
  rpc :ExportAgent, ::Google::Cloud::Dialogflow::CX::V3::ExportAgentRequest, ::Google::Longrunning::Operation
57
65
  # Restores the specified agent from a binary file.
58
66
  #
59
67
  # Replaces the current agent with a new one. Note that all existing resources
60
68
  # in agent (e.g. intents, entity types, flows) will be removed.
61
69
  #
70
+ # This method is a [long-running
71
+ # operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
72
+ # The returned `Operation` type has the following method-specific fields:
73
+ #
74
+ # - `metadata`: An empty [Struct
75
+ # message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
76
+ # - `response`: An [Empty
77
+ # message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
62
78
  #
63
79
  # Note: You should always train flows prior to sending them queries. See the
64
80
  # [training
@@ -197,6 +197,27 @@ module Google
197
197
  #
198
198
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
199
199
  #
200
+ # @example Basic example
201
+ # require "google/cloud/dialogflow/cx/v3"
202
+ #
203
+ # # Create a client object. The client can be reused for multiple calls.
204
+ # client = Google::Cloud::Dialogflow::CX::V3::Agents::Client.new
205
+ #
206
+ # # Create a request. To set request fields, pass in keyword arguments.
207
+ # request = Google::Cloud::Dialogflow::CX::V3::ListAgentsRequest.new
208
+ #
209
+ # # Call the list_agents method.
210
+ # result = client.list_agents request
211
+ #
212
+ # # The returned object is of type Gapic::PagedEnumerable. You can
213
+ # # iterate over all elements by calling #each, and the enumerable
214
+ # # will lazily make API calls to fetch subsequent pages. Other
215
+ # # methods are also available for managing paging directly.
216
+ # result.each do |response|
217
+ # # Each element is of type ::Google::Cloud::Dialogflow::CX::V3::Agent.
218
+ # p response
219
+ # end
220
+ #
200
221
  def list_agents request, options = nil
201
222
  raise ::ArgumentError, "request must be provided" if request.nil?
202
223
 
@@ -214,9 +235,11 @@ module Google
214
235
  gapic_version: ::Google::Cloud::Dialogflow::CX::V3::VERSION
215
236
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
216
237
 
217
- header_params = {
218
- "parent" => request.parent
219
- }
238
+ header_params = {}
239
+ if request.parent
240
+ header_params["parent"] = request.parent
241
+ end
242
+
220
243
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
221
244
  metadata[:"x-goog-request-params"] ||= request_params_header
222
245
 
@@ -267,6 +290,21 @@ module Google
267
290
  #
268
291
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
269
292
  #
293
+ # @example Basic example
294
+ # require "google/cloud/dialogflow/cx/v3"
295
+ #
296
+ # # Create a client object. The client can be reused for multiple calls.
297
+ # client = Google::Cloud::Dialogflow::CX::V3::Agents::Client.new
298
+ #
299
+ # # Create a request. To set request fields, pass in keyword arguments.
300
+ # request = Google::Cloud::Dialogflow::CX::V3::GetAgentRequest.new
301
+ #
302
+ # # Call the get_agent method.
303
+ # result = client.get_agent request
304
+ #
305
+ # # The returned object is of type Google::Cloud::Dialogflow::CX::V3::Agent.
306
+ # p result
307
+ #
270
308
  def get_agent request, options = nil
271
309
  raise ::ArgumentError, "request must be provided" if request.nil?
272
310
 
@@ -284,9 +322,11 @@ module Google
284
322
  gapic_version: ::Google::Cloud::Dialogflow::CX::V3::VERSION
285
323
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
286
324
 
287
- header_params = {
288
- "name" => request.name
289
- }
325
+ header_params = {}
326
+ if request.name
327
+ header_params["name"] = request.name
328
+ end
329
+
290
330
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
291
331
  metadata[:"x-goog-request-params"] ||= request_params_header
292
332
 
@@ -342,6 +382,21 @@ module Google
342
382
  #
343
383
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
344
384
  #
385
+ # @example Basic example
386
+ # require "google/cloud/dialogflow/cx/v3"
387
+ #
388
+ # # Create a client object. The client can be reused for multiple calls.
389
+ # client = Google::Cloud::Dialogflow::CX::V3::Agents::Client.new
390
+ #
391
+ # # Create a request. To set request fields, pass in keyword arguments.
392
+ # request = Google::Cloud::Dialogflow::CX::V3::CreateAgentRequest.new
393
+ #
394
+ # # Call the create_agent method.
395
+ # result = client.create_agent request
396
+ #
397
+ # # The returned object is of type Google::Cloud::Dialogflow::CX::V3::Agent.
398
+ # p result
399
+ #
345
400
  def create_agent request, options = nil
346
401
  raise ::ArgumentError, "request must be provided" if request.nil?
347
402
 
@@ -359,9 +414,11 @@ module Google
359
414
  gapic_version: ::Google::Cloud::Dialogflow::CX::V3::VERSION
360
415
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
361
416
 
362
- header_params = {
363
- "parent" => request.parent
364
- }
417
+ header_params = {}
418
+ if request.parent
419
+ header_params["parent"] = request.parent
420
+ end
421
+
365
422
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
366
423
  metadata[:"x-goog-request-params"] ||= request_params_header
367
424
 
@@ -417,6 +474,21 @@ module Google
417
474
  #
418
475
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
419
476
  #
477
+ # @example Basic example
478
+ # require "google/cloud/dialogflow/cx/v3"
479
+ #
480
+ # # Create a client object. The client can be reused for multiple calls.
481
+ # client = Google::Cloud::Dialogflow::CX::V3::Agents::Client.new
482
+ #
483
+ # # Create a request. To set request fields, pass in keyword arguments.
484
+ # request = Google::Cloud::Dialogflow::CX::V3::UpdateAgentRequest.new
485
+ #
486
+ # # Call the update_agent method.
487
+ # result = client.update_agent request
488
+ #
489
+ # # The returned object is of type Google::Cloud::Dialogflow::CX::V3::Agent.
490
+ # p result
491
+ #
420
492
  def update_agent request, options = nil
421
493
  raise ::ArgumentError, "request must be provided" if request.nil?
422
494
 
@@ -434,9 +506,11 @@ module Google
434
506
  gapic_version: ::Google::Cloud::Dialogflow::CX::V3::VERSION
435
507
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
436
508
 
437
- header_params = {
438
- "agent.name" => request.agent.name
439
- }
509
+ header_params = {}
510
+ if request.agent&.name
511
+ header_params["agent.name"] = request.agent.name
512
+ end
513
+
440
514
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
441
515
  metadata[:"x-goog-request-params"] ||= request_params_header
442
516
 
@@ -486,6 +560,21 @@ module Google
486
560
  #
487
561
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
488
562
  #
563
+ # @example Basic example
564
+ # require "google/cloud/dialogflow/cx/v3"
565
+ #
566
+ # # Create a client object. The client can be reused for multiple calls.
567
+ # client = Google::Cloud::Dialogflow::CX::V3::Agents::Client.new
568
+ #
569
+ # # Create a request. To set request fields, pass in keyword arguments.
570
+ # request = Google::Cloud::Dialogflow::CX::V3::DeleteAgentRequest.new
571
+ #
572
+ # # Call the delete_agent method.
573
+ # result = client.delete_agent request
574
+ #
575
+ # # The returned object is of type Google::Protobuf::Empty.
576
+ # p result
577
+ #
489
578
  def delete_agent request, options = nil
490
579
  raise ::ArgumentError, "request must be provided" if request.nil?
491
580
 
@@ -503,9 +592,11 @@ module Google
503
592
  gapic_version: ::Google::Cloud::Dialogflow::CX::V3::VERSION
504
593
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
505
594
 
506
- header_params = {
507
- "name" => request.name
508
- }
595
+ header_params = {}
596
+ if request.name
597
+ header_params["name"] = request.name
598
+ end
599
+
509
600
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
510
601
  metadata[:"x-goog-request-params"] ||= request_params_header
511
602
 
@@ -528,6 +619,14 @@ module Google
528
619
  ##
529
620
  # Exports the specified agent to a binary file.
530
621
  #
622
+ # This method is a [long-running
623
+ # operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
624
+ # The returned `Operation` type has the following method-specific fields:
625
+ #
626
+ # - `metadata`: An empty [Struct
627
+ # message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
628
+ # - `response`: {::Google::Cloud::Dialogflow::CX::V3::ExportAgentResponse ExportAgentResponse}
629
+ #
531
630
  # @overload export_agent(request, options = nil)
532
631
  # Pass arguments to `export_agent` via a request object, either of type
533
632
  # {::Google::Cloud::Dialogflow::CX::V3::ExportAgentRequest} or an equivalent Hash.
@@ -564,6 +663,28 @@ module Google
564
663
  #
565
664
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
566
665
  #
666
+ # @example Basic example
667
+ # require "google/cloud/dialogflow/cx/v3"
668
+ #
669
+ # # Create a client object. The client can be reused for multiple calls.
670
+ # client = Google::Cloud::Dialogflow::CX::V3::Agents::Client.new
671
+ #
672
+ # # Create a request. To set request fields, pass in keyword arguments.
673
+ # request = Google::Cloud::Dialogflow::CX::V3::ExportAgentRequest.new
674
+ #
675
+ # # Call the export_agent method.
676
+ # result = client.export_agent request
677
+ #
678
+ # # The returned object is of type Gapic::Operation. You can use this
679
+ # # object to check the status of an operation, cancel it, or wait
680
+ # # for results. Here is how to block until completion:
681
+ # result.wait_until_done! timeout: 60
682
+ # if result.response?
683
+ # p result.response
684
+ # else
685
+ # puts "Error!"
686
+ # end
687
+ #
567
688
  def export_agent request, options = nil
568
689
  raise ::ArgumentError, "request must be provided" if request.nil?
569
690
 
@@ -581,9 +702,11 @@ module Google
581
702
  gapic_version: ::Google::Cloud::Dialogflow::CX::V3::VERSION
582
703
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
583
704
 
584
- header_params = {
585
- "name" => request.name
586
- }
705
+ header_params = {}
706
+ if request.name
707
+ header_params["name"] = request.name
708
+ end
709
+
587
710
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
588
711
  metadata[:"x-goog-request-params"] ||= request_params_header
589
712
 
@@ -610,6 +733,14 @@ module Google
610
733
  # Replaces the current agent with a new one. Note that all existing resources
611
734
  # in agent (e.g. intents, entity types, flows) will be removed.
612
735
  #
736
+ # This method is a [long-running
737
+ # operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
738
+ # The returned `Operation` type has the following method-specific fields:
739
+ #
740
+ # - `metadata`: An empty [Struct
741
+ # message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
742
+ # - `response`: An [Empty
743
+ # message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
613
744
  #
614
745
  # Note: You should always train flows prior to sending them queries. See the
615
746
  # [training
@@ -650,6 +781,28 @@ module Google
650
781
  #
651
782
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
652
783
  #
784
+ # @example Basic example
785
+ # require "google/cloud/dialogflow/cx/v3"
786
+ #
787
+ # # Create a client object. The client can be reused for multiple calls.
788
+ # client = Google::Cloud::Dialogflow::CX::V3::Agents::Client.new
789
+ #
790
+ # # Create a request. To set request fields, pass in keyword arguments.
791
+ # request = Google::Cloud::Dialogflow::CX::V3::RestoreAgentRequest.new
792
+ #
793
+ # # Call the restore_agent method.
794
+ # result = client.restore_agent request
795
+ #
796
+ # # The returned object is of type Gapic::Operation. You can use this
797
+ # # object to check the status of an operation, cancel it, or wait
798
+ # # for results. Here is how to block until completion:
799
+ # result.wait_until_done! timeout: 60
800
+ # if result.response?
801
+ # p result.response
802
+ # else
803
+ # puts "Error!"
804
+ # end
805
+ #
653
806
  def restore_agent request, options = nil
654
807
  raise ::ArgumentError, "request must be provided" if request.nil?
655
808
 
@@ -667,9 +820,11 @@ module Google
667
820
  gapic_version: ::Google::Cloud::Dialogflow::CX::V3::VERSION
668
821
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
669
822
 
670
- header_params = {
671
- "name" => request.name
672
- }
823
+ header_params = {}
824
+ if request.name
825
+ header_params["name"] = request.name
826
+ end
827
+
673
828
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
674
829
  metadata[:"x-goog-request-params"] ||= request_params_header
675
830
 
@@ -724,6 +879,21 @@ module Google
724
879
  #
725
880
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
726
881
  #
882
+ # @example Basic example
883
+ # require "google/cloud/dialogflow/cx/v3"
884
+ #
885
+ # # Create a client object. The client can be reused for multiple calls.
886
+ # client = Google::Cloud::Dialogflow::CX::V3::Agents::Client.new
887
+ #
888
+ # # Create a request. To set request fields, pass in keyword arguments.
889
+ # request = Google::Cloud::Dialogflow::CX::V3::ValidateAgentRequest.new
890
+ #
891
+ # # Call the validate_agent method.
892
+ # result = client.validate_agent request
893
+ #
894
+ # # The returned object is of type Google::Cloud::Dialogflow::CX::V3::AgentValidationResult.
895
+ # p result
896
+ #
727
897
  def validate_agent request, options = nil
728
898
  raise ::ArgumentError, "request must be provided" if request.nil?
729
899
 
@@ -741,9 +911,11 @@ module Google
741
911
  gapic_version: ::Google::Cloud::Dialogflow::CX::V3::VERSION
742
912
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
743
913
 
744
- header_params = {
745
- "name" => request.name
746
- }
914
+ header_params = {}
915
+ if request.name
916
+ header_params["name"] = request.name
917
+ end
918
+
747
919
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
748
920
  metadata[:"x-goog-request-params"] ||= request_params_header
749
921
 
@@ -797,6 +969,21 @@ module Google
797
969
  #
798
970
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
799
971
  #
972
+ # @example Basic example
973
+ # require "google/cloud/dialogflow/cx/v3"
974
+ #
975
+ # # Create a client object. The client can be reused for multiple calls.
976
+ # client = Google::Cloud::Dialogflow::CX::V3::Agents::Client.new
977
+ #
978
+ # # Create a request. To set request fields, pass in keyword arguments.
979
+ # request = Google::Cloud::Dialogflow::CX::V3::GetAgentValidationResultRequest.new
980
+ #
981
+ # # Call the get_agent_validation_result method.
982
+ # result = client.get_agent_validation_result request
983
+ #
984
+ # # The returned object is of type Google::Cloud::Dialogflow::CX::V3::AgentValidationResult.
985
+ # p result
986
+ #
800
987
  def get_agent_validation_result request, options = nil
801
988
  raise ::ArgumentError, "request must be provided" if request.nil?
802
989
 
@@ -814,9 +1001,11 @@ module Google
814
1001
  gapic_version: ::Google::Cloud::Dialogflow::CX::V3::VERSION
815
1002
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
816
1003
 
817
- header_params = {
818
- "name" => request.name
819
- }
1004
+ header_params = {}
1005
+ if request.name
1006
+ header_params["name"] = request.name
1007
+ end
1008
+
820
1009
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
821
1010
  metadata[:"x-goog-request-params"] ||= request_params_header
822
1011
 
@@ -144,6 +144,27 @@ module Google
144
144
  #
145
145
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
146
146
  #
147
+ # @example Basic example
148
+ # require "google/longrunning"
149
+ #
150
+ # # Create a client object. The client can be reused for multiple calls.
151
+ # client = Google::Longrunning::Operations::Client.new
152
+ #
153
+ # # Create a request. To set request fields, pass in keyword arguments.
154
+ # request = Google::Longrunning::ListOperationsRequest.new
155
+ #
156
+ # # Call the list_operations method.
157
+ # result = client.list_operations request
158
+ #
159
+ # # The returned object is of type Gapic::PagedEnumerable. You can
160
+ # # iterate over all elements by calling #each, and the enumerable
161
+ # # will lazily make API calls to fetch subsequent pages. Other
162
+ # # methods are also available for managing paging directly.
163
+ # result.each do |response|
164
+ # # Each element is of type ::Google::Longrunning::Operation.
165
+ # p response
166
+ # end
167
+ #
147
168
  def list_operations request, options = nil
148
169
  raise ::ArgumentError, "request must be provided" if request.nil?
149
170
 
@@ -161,9 +182,11 @@ module Google
161
182
  gapic_version: ::Google::Cloud::Dialogflow::CX::V3::VERSION
162
183
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
163
184
 
164
- header_params = {
165
- "name" => request.name
166
- }
185
+ header_params = {}
186
+ if request.name
187
+ header_params["name"] = request.name
188
+ end
189
+
167
190
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
168
191
  metadata[:"x-goog-request-params"] ||= request_params_header
169
192
 
@@ -216,6 +239,28 @@ module Google
216
239
  #
217
240
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
218
241
  #
242
+ # @example Basic example
243
+ # require "google/longrunning"
244
+ #
245
+ # # Create a client object. The client can be reused for multiple calls.
246
+ # client = Google::Longrunning::Operations::Client.new
247
+ #
248
+ # # Create a request. To set request fields, pass in keyword arguments.
249
+ # request = Google::Longrunning::GetOperationRequest.new
250
+ #
251
+ # # Call the get_operation method.
252
+ # result = client.get_operation request
253
+ #
254
+ # # The returned object is of type Gapic::Operation. You can use this
255
+ # # object to check the status of an operation, cancel it, or wait
256
+ # # for results. Here is how to block until completion:
257
+ # result.wait_until_done! timeout: 60
258
+ # if result.response?
259
+ # p result.response
260
+ # else
261
+ # puts "Error!"
262
+ # end
263
+ #
219
264
  def get_operation request, options = nil
220
265
  raise ::ArgumentError, "request must be provided" if request.nil?
221
266
 
@@ -233,9 +278,11 @@ module Google
233
278
  gapic_version: ::Google::Cloud::Dialogflow::CX::V3::VERSION
234
279
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
235
280
 
236
- header_params = {
237
- "name" => request.name
238
- }
281
+ header_params = {}
282
+ if request.name
283
+ header_params["name"] = request.name
284
+ end
285
+
239
286
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
240
287
  metadata[:"x-goog-request-params"] ||= request_params_header
241
288
 
@@ -288,6 +335,21 @@ module Google
288
335
  #
289
336
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
290
337
  #
338
+ # @example Basic example
339
+ # require "google/longrunning"
340
+ #
341
+ # # Create a client object. The client can be reused for multiple calls.
342
+ # client = Google::Longrunning::Operations::Client.new
343
+ #
344
+ # # Create a request. To set request fields, pass in keyword arguments.
345
+ # request = Google::Longrunning::DeleteOperationRequest.new
346
+ #
347
+ # # Call the delete_operation method.
348
+ # result = client.delete_operation request
349
+ #
350
+ # # The returned object is of type Google::Protobuf::Empty.
351
+ # p result
352
+ #
291
353
  def delete_operation request, options = nil
292
354
  raise ::ArgumentError, "request must be provided" if request.nil?
293
355
 
@@ -305,9 +367,11 @@ module Google
305
367
  gapic_version: ::Google::Cloud::Dialogflow::CX::V3::VERSION
306
368
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
307
369
 
308
- header_params = {
309
- "name" => request.name
310
- }
370
+ header_params = {}
371
+ if request.name
372
+ header_params["name"] = request.name
373
+ end
374
+
311
375
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
312
376
  metadata[:"x-goog-request-params"] ||= request_params_header
313
377
 
@@ -365,6 +429,21 @@ module Google
365
429
  #
366
430
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
367
431
  #
432
+ # @example Basic example
433
+ # require "google/longrunning"
434
+ #
435
+ # # Create a client object. The client can be reused for multiple calls.
436
+ # client = Google::Longrunning::Operations::Client.new
437
+ #
438
+ # # Create a request. To set request fields, pass in keyword arguments.
439
+ # request = Google::Longrunning::CancelOperationRequest.new
440
+ #
441
+ # # Call the cancel_operation method.
442
+ # result = client.cancel_operation request
443
+ #
444
+ # # The returned object is of type Google::Protobuf::Empty.
445
+ # p result
446
+ #
368
447
  def cancel_operation request, options = nil
369
448
  raise ::ArgumentError, "request must be provided" if request.nil?
370
449
 
@@ -382,9 +461,11 @@ module Google
382
461
  gapic_version: ::Google::Cloud::Dialogflow::CX::V3::VERSION
383
462
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
384
463
 
385
- header_params = {
386
- "name" => request.name
387
- }
464
+ header_params = {}
465
+ if request.name
466
+ header_params["name"] = request.name
467
+ end
468
+
388
469
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
389
470
  metadata[:"x-goog-request-params"] ||= request_params_header
390
471
 
@@ -445,6 +526,28 @@ module Google
445
526
  #
446
527
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
447
528
  #
529
+ # @example Basic example
530
+ # require "google/longrunning"
531
+ #
532
+ # # Create a client object. The client can be reused for multiple calls.
533
+ # client = Google::Longrunning::Operations::Client.new
534
+ #
535
+ # # Create a request. To set request fields, pass in keyword arguments.
536
+ # request = Google::Longrunning::WaitOperationRequest.new
537
+ #
538
+ # # Call the wait_operation method.
539
+ # result = client.wait_operation request
540
+ #
541
+ # # The returned object is of type Gapic::Operation. You can use this
542
+ # # object to check the status of an operation, cancel it, or wait
543
+ # # for results. Here is how to block until completion:
544
+ # result.wait_until_done! timeout: 60
545
+ # if result.response?
546
+ # p result.response
547
+ # else
548
+ # puts "Error!"
549
+ # end
550
+ #
448
551
  def wait_operation request, options = nil
449
552
  raise ::ArgumentError, "request must be provided" if request.nil?
450
553