google-cloud-dialogflow-v2 0.3.0 → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (28) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +48 -1
  3. data/lib/google-cloud-dialogflow-v2.rb +21 -1
  4. data/lib/google/cloud/dialogflow/v2.rb +16 -0
  5. data/lib/google/cloud/dialogflow/v2/agents.rb +58 -2
  6. data/lib/google/cloud/dialogflow/v2/agents/client.rb +88 -65
  7. data/lib/google/cloud/dialogflow/v2/agents/operations.rb +39 -33
  8. data/lib/google/cloud/dialogflow/v2/contexts.rb +47 -1
  9. data/lib/google/cloud/dialogflow/v2/contexts/client.rb +62 -39
  10. data/lib/google/cloud/dialogflow/v2/contexts/paths.rb +43 -0
  11. data/lib/google/cloud/dialogflow/v2/entity_types.rb +58 -2
  12. data/lib/google/cloud/dialogflow/v2/entity_types/client.rb +103 -65
  13. data/lib/google/cloud/dialogflow/v2/entity_types/operations.rb +39 -33
  14. data/lib/google/cloud/dialogflow/v2/entity_types/paths.rb +14 -0
  15. data/lib/google/cloud/dialogflow/v2/intents.rb +62 -2
  16. data/lib/google/cloud/dialogflow/v2/intents/client.rb +74 -47
  17. data/lib/google/cloud/dialogflow/v2/intents/operations.rb +39 -33
  18. data/lib/google/cloud/dialogflow/v2/intents/paths.rb +14 -0
  19. data/lib/google/cloud/dialogflow/v2/session_entity_types.rb +46 -1
  20. data/lib/google/cloud/dialogflow/v2/session_entity_types/client.rb +48 -53
  21. data/lib/google/cloud/dialogflow/v2/session_entity_types/paths.rb +43 -0
  22. data/lib/google/cloud/dialogflow/v2/sessions.rb +33 -1
  23. data/lib/google/cloud/dialogflow/v2/sessions/client.rb +15 -28
  24. data/lib/google/cloud/dialogflow/v2/version.rb +1 -1
  25. data/proto_docs/google/cloud/dialogflow/v2/agent.rb +0 -2
  26. data/proto_docs/google/cloud/dialogflow/v2/context.rb +1 -1
  27. data/proto_docs/google/cloud/dialogflow/v2/session.rb +28 -1
  28. metadata +2 -2
@@ -24,6 +24,20 @@ module Google
24
24
  module EntityTypes
25
25
  # Path helper methods for the EntityTypes API.
26
26
  module Paths
27
+ ##
28
+ # Create a fully-qualified Agent resource string.
29
+ #
30
+ # The resource will be in the following format:
31
+ #
32
+ # `projects/{project}/agent`
33
+ #
34
+ # @param project [String]
35
+ #
36
+ # @return [String]
37
+ def agent_path project:
38
+ "projects/#{project}/agent"
39
+ end
40
+
27
41
  ##
28
42
  # Create a fully-qualified EntityType resource string.
29
43
  #
@@ -16,6 +16,66 @@
16
16
 
17
17
  # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
18
 
19
- require "google/cloud/dialogflow/v2/intents/client"
20
- require "google/cloud/dialogflow/v2/intents/operations"
19
+ require "gapic/common"
20
+ require "gapic/config"
21
+ require "gapic/config/method"
22
+
23
+ require "google/cloud/dialogflow/v2/version"
24
+
21
25
  require "google/cloud/dialogflow/v2/intents/credentials"
26
+ require "google/cloud/dialogflow/v2/intents/paths"
27
+ require "google/cloud/dialogflow/v2/intents/operations"
28
+ require "google/cloud/dialogflow/v2/intents/client"
29
+
30
+ module Google
31
+ module Cloud
32
+ module Dialogflow
33
+ module V2
34
+ ##
35
+ # An intent represents a mapping between input from a user and an action to
36
+ # be taken by your application. When you pass user input to the
37
+ # {Google::Cloud::Dialogflow::V2::Sessions::Client#detect_intent DetectIntent} (or
38
+ # {Google::Cloud::Dialogflow::V2::Sessions::Client#streaming_detect_intent StreamingDetectIntent}) method, the
39
+ # Dialogflow API analyzes the input and searches
40
+ # for a matching intent. If no match is found, the Dialogflow API returns a
41
+ # fallback intent (`is_fallback` = true).
42
+ #
43
+ # You can provide additional information for the Dialogflow API to use to
44
+ # match user input to an intent by adding the following to your intent.
45
+ #
46
+ # * **Contexts** - provide additional context for intent analysis. For
47
+ # example, if an intent is related to an object in your application that
48
+ # plays music, you can provide a context to determine when to match the
49
+ # intent if the user input is "turn it off". You can include a context
50
+ # that matches the intent when there is previous user input of
51
+ # "play music", and not when there is previous user input of
52
+ # "turn on the light".
53
+ #
54
+ # * **Events** - allow for matching an intent by using an event name
55
+ # instead of user input. Your application can provide an event name and
56
+ # related parameters to the Dialogflow API to match an intent. For
57
+ # example, when your application starts, you can send a welcome event
58
+ # with a user name parameter to the Dialogflow API to match an intent with
59
+ # a personalized welcome message for the user.
60
+ #
61
+ # * **Training phrases** - provide examples of user input to train the
62
+ # Dialogflow API agent to better match intents.
63
+ #
64
+ # For more information about intents, see the
65
+ # [Dialogflow
66
+ # documentation](https://cloud.google.com/dialogflow/docs/intents-overview).
67
+ #
68
+ # To load this service and instantiate a client:
69
+ #
70
+ # require "google/cloud/dialogflow/v2/intents"
71
+ # client = Google::Cloud::Dialogflow::V2::Intents::Client.new
72
+ #
73
+ module Intents
74
+ end
75
+ end
76
+ end
77
+ end
78
+ end
79
+
80
+ helper_path = ::File.join __dir__, "intents", "helpers.rb"
81
+ require "google/cloud/dialogflow/v2/intents/helpers" if ::File.file? helper_path
@@ -16,16 +16,8 @@
16
16
 
17
17
  # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
18
 
19
- require "gapic/common"
20
- require "gapic/config"
21
- require "gapic/config/method"
22
-
23
19
  require "google/cloud/errors"
24
- require "google/cloud/dialogflow/v2/version"
25
20
  require "google/cloud/dialogflow/v2/intent_pb"
26
- require "google/cloud/dialogflow/v2/intents/credentials"
27
- require "google/cloud/dialogflow/v2/intents/paths"
28
- require "google/cloud/dialogflow/v2/intents/operations"
29
21
 
30
22
  module Google
31
23
  module Cloud
@@ -228,12 +220,20 @@ module Google
228
220
  # Returns the list of all intents in the specified agent.
229
221
  #
230
222
  # @overload list_intents(request, options = nil)
231
- # @param request [Google::Cloud::Dialogflow::V2::ListIntentsRequest | Hash]
232
- # Returns the list of all intents in the specified agent.
223
+ # Pass arguments to `list_intents` via a request object, either of type
224
+ # {Google::Cloud::Dialogflow::V2::ListIntentsRequest} or an equivalent Hash.
225
+ #
226
+ # @param request [Google::Cloud::Dialogflow::V2::ListIntentsRequest, Hash]
227
+ # A request object representing the call parameters. Required. To specify no
228
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
233
229
  # @param options [Gapic::CallOptions, Hash]
234
230
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
235
231
  #
236
232
  # @overload list_intents(parent: nil, language_code: nil, intent_view: nil, page_size: nil, page_token: nil)
233
+ # Pass arguments to `list_intents` via keyword arguments. Note that at
234
+ # least one keyword argument is required. To specify no parameters, or to keep all
235
+ # the default parameter values, pass an empty Hash as a request object (see above).
236
+ #
237
237
  # @param parent [String]
238
238
  # Required. The agent to list all intents from.
239
239
  # Format: `projects/<Project ID>/agent`.
@@ -251,7 +251,6 @@ module Google
251
251
  # @param page_token [String]
252
252
  # Optional. The next_page_token value returned from a previous list request.
253
253
  #
254
- #
255
254
  # @yield [response, operation] Access the result along with the RPC operation
256
255
  # @yieldparam response [Gapic::PagedEnumerable<Google::Cloud::Dialogflow::V2::Intent>]
257
256
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -302,12 +301,20 @@ module Google
302
301
  # Retrieves the specified intent.
303
302
  #
304
303
  # @overload get_intent(request, options = nil)
305
- # @param request [Google::Cloud::Dialogflow::V2::GetIntentRequest | Hash]
306
- # Retrieves the specified intent.
304
+ # Pass arguments to `get_intent` via a request object, either of type
305
+ # {Google::Cloud::Dialogflow::V2::GetIntentRequest} or an equivalent Hash.
306
+ #
307
+ # @param request [Google::Cloud::Dialogflow::V2::GetIntentRequest, Hash]
308
+ # A request object representing the call parameters. Required. To specify no
309
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
307
310
  # @param options [Gapic::CallOptions, Hash]
308
311
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
309
312
  #
310
313
  # @overload get_intent(name: nil, language_code: nil, intent_view: nil)
314
+ # Pass arguments to `get_intent` via keyword arguments. Note that at
315
+ # least one keyword argument is required. To specify no parameters, or to keep all
316
+ # the default parameter values, pass an empty Hash as a request object (see above).
317
+ #
311
318
  # @param name [String]
312
319
  # Required. The name of the intent.
313
320
  # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
@@ -320,7 +327,6 @@ module Google
320
327
  # @param intent_view [Google::Cloud::Dialogflow::V2::IntentView]
321
328
  # Optional. The resource view to apply to the returned intent.
322
329
  #
323
- #
324
330
  # @yield [response, operation] Access the result along with the RPC operation
325
331
  # @yieldparam response [Google::Cloud::Dialogflow::V2::Intent]
326
332
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -370,16 +376,24 @@ module Google
370
376
  # Creates an intent in the specified agent.
371
377
  #
372
378
  # @overload create_intent(request, options = nil)
373
- # @param request [Google::Cloud::Dialogflow::V2::CreateIntentRequest | Hash]
374
- # Creates an intent in the specified agent.
379
+ # Pass arguments to `create_intent` via a request object, either of type
380
+ # {Google::Cloud::Dialogflow::V2::CreateIntentRequest} or an equivalent Hash.
381
+ #
382
+ # @param request [Google::Cloud::Dialogflow::V2::CreateIntentRequest, Hash]
383
+ # A request object representing the call parameters. Required. To specify no
384
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
375
385
  # @param options [Gapic::CallOptions, Hash]
376
386
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
377
387
  #
378
388
  # @overload create_intent(parent: nil, intent: nil, language_code: nil, intent_view: nil)
389
+ # Pass arguments to `create_intent` via keyword arguments. Note that at
390
+ # least one keyword argument is required. To specify no parameters, or to keep all
391
+ # the default parameter values, pass an empty Hash as a request object (see above).
392
+ #
379
393
  # @param parent [String]
380
394
  # Required. The agent to create a intent for.
381
395
  # Format: `projects/<Project ID>/agent`.
382
- # @param intent [Google::Cloud::Dialogflow::V2::Intent | Hash]
396
+ # @param intent [Google::Cloud::Dialogflow::V2::Intent, Hash]
383
397
  # Required. The intent to create.
384
398
  # @param language_code [String]
385
399
  # Optional. The language used to access language-specific data.
@@ -390,7 +404,6 @@ module Google
390
404
  # @param intent_view [Google::Cloud::Dialogflow::V2::IntentView]
391
405
  # Optional. The resource view to apply to the returned intent.
392
406
  #
393
- #
394
407
  # @yield [response, operation] Access the result along with the RPC operation
395
408
  # @yieldparam response [Google::Cloud::Dialogflow::V2::Intent]
396
409
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -440,13 +453,21 @@ module Google
440
453
  # Updates the specified intent.
441
454
  #
442
455
  # @overload update_intent(request, options = nil)
443
- # @param request [Google::Cloud::Dialogflow::V2::UpdateIntentRequest | Hash]
444
- # Updates the specified intent.
456
+ # Pass arguments to `update_intent` via a request object, either of type
457
+ # {Google::Cloud::Dialogflow::V2::UpdateIntentRequest} or an equivalent Hash.
458
+ #
459
+ # @param request [Google::Cloud::Dialogflow::V2::UpdateIntentRequest, Hash]
460
+ # A request object representing the call parameters. Required. To specify no
461
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
445
462
  # @param options [Gapic::CallOptions, Hash]
446
463
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
447
464
  #
448
465
  # @overload update_intent(intent: nil, language_code: nil, update_mask: nil, intent_view: nil)
449
- # @param intent [Google::Cloud::Dialogflow::V2::Intent | Hash]
466
+ # Pass arguments to `update_intent` via keyword arguments. Note that at
467
+ # least one keyword argument is required. To specify no parameters, or to keep all
468
+ # the default parameter values, pass an empty Hash as a request object (see above).
469
+ #
470
+ # @param intent [Google::Cloud::Dialogflow::V2::Intent, Hash]
450
471
  # Required. The intent to update.
451
472
  # @param language_code [String]
452
473
  # Optional. The language used to access language-specific data.
@@ -454,12 +475,11 @@ module Google
454
475
  # For more information, see
455
476
  # [Multilingual intent and entity
456
477
  # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).
457
- # @param update_mask [Google::Protobuf::FieldMask | Hash]
478
+ # @param update_mask [Google::Protobuf::FieldMask, Hash]
458
479
  # Optional. The mask to control which fields get updated.
459
480
  # @param intent_view [Google::Cloud::Dialogflow::V2::IntentView]
460
481
  # Optional. The resource view to apply to the returned intent.
461
482
  #
462
- #
463
483
  # @yield [response, operation] Access the result along with the RPC operation
464
484
  # @yieldparam response [Google::Cloud::Dialogflow::V2::Intent]
465
485
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -509,18 +529,25 @@ module Google
509
529
  # Deletes the specified intent and its direct or indirect followup intents.
510
530
  #
511
531
  # @overload delete_intent(request, options = nil)
512
- # @param request [Google::Cloud::Dialogflow::V2::DeleteIntentRequest | Hash]
513
- # Deletes the specified intent and its direct or indirect followup intents.
532
+ # Pass arguments to `delete_intent` via a request object, either of type
533
+ # {Google::Cloud::Dialogflow::V2::DeleteIntentRequest} or an equivalent Hash.
534
+ #
535
+ # @param request [Google::Cloud::Dialogflow::V2::DeleteIntentRequest, Hash]
536
+ # A request object representing the call parameters. Required. To specify no
537
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
514
538
  # @param options [Gapic::CallOptions, Hash]
515
539
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
516
540
  #
517
541
  # @overload delete_intent(name: nil)
542
+ # Pass arguments to `delete_intent` via keyword arguments. Note that at
543
+ # least one keyword argument is required. To specify no parameters, or to keep all
544
+ # the default parameter values, pass an empty Hash as a request object (see above).
545
+ #
518
546
  # @param name [String]
519
547
  # Required. The name of the intent to delete. If this intent has direct or
520
548
  # indirect followup intents, we also delete them.
521
549
  # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
522
550
  #
523
- #
524
551
  # @yield [response, operation] Access the result along with the RPC operation
525
552
  # @yieldparam response [Google::Protobuf::Empty]
526
553
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -572,14 +599,20 @@ module Google
572
599
  # Operation <response: {Google::Cloud::Dialogflow::V2::BatchUpdateIntentsResponse BatchUpdateIntentsResponse}>
573
600
  #
574
601
  # @overload batch_update_intents(request, options = nil)
575
- # @param request [Google::Cloud::Dialogflow::V2::BatchUpdateIntentsRequest | Hash]
576
- # Updates/Creates multiple intents in the specified agent.
602
+ # Pass arguments to `batch_update_intents` via a request object, either of type
603
+ # {Google::Cloud::Dialogflow::V2::BatchUpdateIntentsRequest} or an equivalent Hash.
577
604
  #
578
- # Operation <response: {Google::Cloud::Dialogflow::V2::BatchUpdateIntentsResponse BatchUpdateIntentsResponse}>
605
+ # @param request [Google::Cloud::Dialogflow::V2::BatchUpdateIntentsRequest, Hash]
606
+ # A request object representing the call parameters. Required. To specify no
607
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
579
608
  # @param options [Gapic::CallOptions, Hash]
580
609
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
581
610
  #
582
611
  # @overload batch_update_intents(parent: nil, intent_batch_uri: nil, intent_batch_inline: nil, language_code: nil, update_mask: nil, intent_view: nil)
612
+ # Pass arguments to `batch_update_intents` via keyword arguments. Note that at
613
+ # least one keyword argument is required. To specify no parameters, or to keep all
614
+ # the default parameter values, pass an empty Hash as a request object (see above).
615
+ #
583
616
  # @param parent [String]
584
617
  # Required. The name of the agent to update or create intents in.
585
618
  # Format: `projects/<Project ID>/agent`.
@@ -587,7 +620,7 @@ module Google
587
620
  # The URI to a Google Cloud Storage file containing intents to update or
588
621
  # create. The file format can either be a serialized proto (of IntentBatch
589
622
  # type) or JSON object. Note: The URI must start with "gs://".
590
- # @param intent_batch_inline [Google::Cloud::Dialogflow::V2::IntentBatch | Hash]
623
+ # @param intent_batch_inline [Google::Cloud::Dialogflow::V2::IntentBatch, Hash]
591
624
  # The collection of intents to update or create.
592
625
  # @param language_code [String]
593
626
  # Optional. The language used to access language-specific data.
@@ -595,12 +628,11 @@ module Google
595
628
  # For more information, see
596
629
  # [Multilingual intent and entity
597
630
  # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).
598
- # @param update_mask [Google::Protobuf::FieldMask | Hash]
631
+ # @param update_mask [Google::Protobuf::FieldMask, Hash]
599
632
  # Optional. The mask to control which fields get updated.
600
633
  # @param intent_view [Google::Cloud::Dialogflow::V2::IntentView]
601
634
  # Optional. The resource view to apply to the returned intent.
602
635
  #
603
- #
604
636
  # @yield [response, operation] Access the result along with the RPC operation
605
637
  # @yieldparam response [Gapic::Operation]
606
638
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -653,22 +685,27 @@ module Google
653
685
  # Operation <response: {Google::Protobuf::Empty google.protobuf.Empty}>
654
686
  #
655
687
  # @overload batch_delete_intents(request, options = nil)
656
- # @param request [Google::Cloud::Dialogflow::V2::BatchDeleteIntentsRequest | Hash]
657
- # Deletes intents in the specified agent.
688
+ # Pass arguments to `batch_delete_intents` via a request object, either of type
689
+ # {Google::Cloud::Dialogflow::V2::BatchDeleteIntentsRequest} or an equivalent Hash.
658
690
  #
659
- # Operation <response: {Google::Protobuf::Empty google.protobuf.Empty}>
691
+ # @param request [Google::Cloud::Dialogflow::V2::BatchDeleteIntentsRequest, Hash]
692
+ # A request object representing the call parameters. Required. To specify no
693
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
660
694
  # @param options [Gapic::CallOptions, Hash]
661
695
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
662
696
  #
663
697
  # @overload batch_delete_intents(parent: nil, intents: nil)
698
+ # Pass arguments to `batch_delete_intents` via keyword arguments. Note that at
699
+ # least one keyword argument is required. To specify no parameters, or to keep all
700
+ # the default parameter values, pass an empty Hash as a request object (see above).
701
+ #
664
702
  # @param parent [String]
665
703
  # Required. The name of the agent to delete all entities types for. Format:
666
704
  # `projects/<Project ID>/agent`.
667
- # @param intents [Array<Google::Cloud::Dialogflow::V2::Intent | Hash>]
705
+ # @param intents [Array<Google::Cloud::Dialogflow::V2::Intent, Hash>]
668
706
  # Required. The collection of intents to delete. Only intent `name` must be
669
707
  # filled in.
670
708
  #
671
- #
672
709
  # @yield [response, operation] Access the result along with the RPC operation
673
710
  # @yieldparam response [Gapic::Operation]
674
711
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -910,13 +947,3 @@ module Google
910
947
  end
911
948
  end
912
949
  end
913
-
914
- # rubocop:disable Lint/HandleExceptions
915
-
916
- # Once client is loaded, load helpers.rb if it exists.
917
- begin
918
- require "google/cloud/dialogflow/v2/intents/helpers"
919
- rescue LoadError
920
- end
921
-
922
- # rubocop:enable Lint/HandleExceptions
@@ -16,11 +16,7 @@
16
16
 
17
17
  # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
18
 
19
- require "gapic/common"
20
19
  require "gapic/operation"
21
-
22
- require "google/cloud/dialogflow/v2/version"
23
- require "google/cloud/dialogflow/v2/intents/client"
24
20
  require "google/longrunning/operations_pb"
25
21
 
26
22
  module Google
@@ -109,16 +105,20 @@ module Google
109
105
  # to use different resource name schemes, such as `users/*/operations`.
110
106
  #
111
107
  # @overload list_operations(request, options = nil)
112
- # @param request [Google::Longrunning::ListOperationsRequest | Hash]
113
- # Lists operations that match the specified filter in the request. If the
114
- # server doesn't support this method, it returns `UNIMPLEMENTED`.
108
+ # Pass arguments to `list_operations` via a request object, either of type
109
+ # {Google::Longrunning::ListOperationsRequest} or an equivalent Hash.
115
110
  #
116
- # NOTE: the `name` binding below allows API services to override the binding
117
- # to use different resource name schemes, such as `users/*/operations`.
111
+ # @param request [Google::Longrunning::ListOperationsRequest, Hash]
112
+ # A request object representing the call parameters. Required. To specify no
113
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
118
114
  # @param options [Gapic::CallOptions, Hash]
119
115
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
120
116
  #
121
117
  # @overload list_operations(name: nil, filter: nil, page_size: nil, page_token: nil)
118
+ # Pass arguments to `list_operations` via keyword arguments. Note that at
119
+ # least one keyword argument is required. To specify no parameters, or to keep all
120
+ # the default parameter values, pass an empty Hash as a request object (see above).
121
+ #
122
122
  # @param name [String]
123
123
  # The name of the operation collection.
124
124
  # @param filter [String]
@@ -128,7 +128,6 @@ module Google
128
128
  # @param page_token [String]
129
129
  # The standard list page token.
130
130
  #
131
- #
132
131
  # @yield [response, operation] Access the result along with the RPC operation
133
132
  # @yieldparam response [Gapic::PagedEnumerable<Gapic::Operation>]
134
133
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -182,18 +181,23 @@ module Google
182
181
  # service.
183
182
  #
184
183
  # @overload get_operation(request, options = nil)
185
- # @param request [Google::Longrunning::GetOperationRequest | Hash]
186
- # Gets the latest state of a long-running operation. Clients can use this
187
- # method to poll the operation result at intervals as recommended by the API
188
- # service.
184
+ # Pass arguments to `get_operation` via a request object, either of type
185
+ # {Google::Longrunning::GetOperationRequest} or an equivalent Hash.
186
+ #
187
+ # @param request [Google::Longrunning::GetOperationRequest, Hash]
188
+ # A request object representing the call parameters. Required. To specify no
189
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
189
190
  # @param options [Gapic::CallOptions, Hash]
190
191
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
191
192
  #
192
193
  # @overload get_operation(name: nil)
194
+ # Pass arguments to `get_operation` via keyword arguments. Note that at
195
+ # least one keyword argument is required. To specify no parameters, or to keep all
196
+ # the default parameter values, pass an empty Hash as a request object (see above).
197
+ #
193
198
  # @param name [String]
194
199
  # The name of the operation resource.
195
200
  #
196
- #
197
201
  # @yield [response, operation] Access the result along with the RPC operation
198
202
  # @yieldparam response [Gapic::Operation]
199
203
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -247,19 +251,23 @@ module Google
247
251
  # `google.rpc.Code.UNIMPLEMENTED`.
248
252
  #
249
253
  # @overload delete_operation(request, options = nil)
250
- # @param request [Google::Longrunning::DeleteOperationRequest | Hash]
251
- # Deletes a long-running operation. This method indicates that the client is
252
- # no longer interested in the operation result. It does not cancel the
253
- # operation. If the server doesn't support this method, it returns
254
- # `google.rpc.Code.UNIMPLEMENTED`.
254
+ # Pass arguments to `delete_operation` via a request object, either of type
255
+ # {Google::Longrunning::DeleteOperationRequest} or an equivalent Hash.
256
+ #
257
+ # @param request [Google::Longrunning::DeleteOperationRequest, Hash]
258
+ # A request object representing the call parameters. Required. To specify no
259
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
255
260
  # @param options [Gapic::CallOptions, Hash]
256
261
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
257
262
  #
258
263
  # @overload delete_operation(name: nil)
264
+ # Pass arguments to `delete_operation` via keyword arguments. Note that at
265
+ # least one keyword argument is required. To specify no parameters, or to keep all
266
+ # the default parameter values, pass an empty Hash as a request object (see above).
267
+ #
259
268
  # @param name [String]
260
269
  # The name of the operation resource to be deleted.
261
270
  #
262
- #
263
271
  # @yield [response, operation] Access the result along with the RPC operation
264
272
  # @yieldparam response [Google::Protobuf::Empty]
265
273
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -318,25 +326,23 @@ module Google
318
326
  # corresponding to `Code.CANCELLED`.
319
327
  #
320
328
  # @overload cancel_operation(request, options = nil)
321
- # @param request [Google::Longrunning::CancelOperationRequest | Hash]
322
- # Starts asynchronous cancellation on a long-running operation. The server
323
- # makes a best effort to cancel the operation, but success is not
324
- # guaranteed. If the server doesn't support this method, it returns
325
- # `google.rpc.Code.UNIMPLEMENTED`. Clients can use
326
- # Operations.GetOperation or
327
- # other methods to check whether the cancellation succeeded or whether the
328
- # operation completed despite cancellation. On successful cancellation,
329
- # the operation is not deleted; instead, it becomes an operation with
330
- # an {Google::Longrunning::Operation#error Operation.error} value with a {Google::Rpc::Status#code google.rpc.Status.code} of 1,
331
- # corresponding to `Code.CANCELLED`.
329
+ # Pass arguments to `cancel_operation` via a request object, either of type
330
+ # {Google::Longrunning::CancelOperationRequest} or an equivalent Hash.
331
+ #
332
+ # @param request [Google::Longrunning::CancelOperationRequest, Hash]
333
+ # A request object representing the call parameters. Required. To specify no
334
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
332
335
  # @param options [Gapic::CallOptions, Hash]
333
336
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
334
337
  #
335
338
  # @overload cancel_operation(name: nil)
339
+ # Pass arguments to `cancel_operation` via keyword arguments. Note that at
340
+ # least one keyword argument is required. To specify no parameters, or to keep all
341
+ # the default parameter values, pass an empty Hash as a request object (see above).
342
+ #
336
343
  # @param name [String]
337
344
  # The name of the operation resource to be cancelled.
338
345
  #
339
- #
340
346
  # @yield [response, operation] Access the result along with the RPC operation
341
347
  # @yieldparam response [Google::Protobuf::Empty]
342
348
  # @yieldparam operation [GRPC::ActiveCall::Operation]