google-cloud-dialogflow-v2 1.4.0 → 1.5.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (89) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +30 -20
  3. data/lib/google/cloud/dialogflow/v2/agents/client.rb +33 -10
  4. data/lib/google/cloud/dialogflow/v2/agents/operations.rb +12 -15
  5. data/lib/google/cloud/dialogflow/v2/agents/rest/client.rb +33 -10
  6. data/lib/google/cloud/dialogflow/v2/agents/rest/operations.rb +43 -38
  7. data/lib/google/cloud/dialogflow/v2/agents/rest/service_stub.rb +86 -56
  8. data/lib/google/cloud/dialogflow/v2/answer_records/client.rb +29 -3
  9. data/lib/google/cloud/dialogflow/v2/answer_records/rest/client.rb +29 -3
  10. data/lib/google/cloud/dialogflow/v2/answer_records/rest/service_stub.rb +30 -14
  11. data/lib/google/cloud/dialogflow/v2/contexts/client.rb +29 -7
  12. data/lib/google/cloud/dialogflow/v2/contexts/rest/client.rb +29 -7
  13. data/lib/google/cloud/dialogflow/v2/contexts/rest/service_stub.rb +62 -38
  14. data/lib/google/cloud/dialogflow/v2/conversation_datasets/client.rb +32 -6
  15. data/lib/google/cloud/dialogflow/v2/conversation_datasets/operations.rb +12 -15
  16. data/lib/google/cloud/dialogflow/v2/conversation_datasets/rest/client.rb +32 -6
  17. data/lib/google/cloud/dialogflow/v2/conversation_datasets/rest/operations.rb +43 -38
  18. data/lib/google/cloud/dialogflow/v2/conversation_datasets/rest/service_stub.rb +54 -32
  19. data/lib/google/cloud/dialogflow/v2/conversation_models/client.rb +35 -10
  20. data/lib/google/cloud/dialogflow/v2/conversation_models/operations.rb +12 -15
  21. data/lib/google/cloud/dialogflow/v2/conversation_models/rest/client.rb +35 -10
  22. data/lib/google/cloud/dialogflow/v2/conversation_models/rest/operations.rb +43 -38
  23. data/lib/google/cloud/dialogflow/v2/conversation_models/rest/service_stub.rb +86 -56
  24. data/lib/google/cloud/dialogflow/v2/conversation_profile_services_pb.rb +6 -2
  25. data/lib/google/cloud/dialogflow/v2/conversation_profiles/client.rb +37 -10
  26. data/lib/google/cloud/dialogflow/v2/conversation_profiles/operations.rb +12 -15
  27. data/lib/google/cloud/dialogflow/v2/conversation_profiles/rest/client.rb +37 -10
  28. data/lib/google/cloud/dialogflow/v2/conversation_profiles/rest/operations.rb +43 -38
  29. data/lib/google/cloud/dialogflow/v2/conversation_profiles/rest/service_stub.rb +70 -44
  30. data/lib/google/cloud/dialogflow/v2/conversations/client.rb +30 -10
  31. data/lib/google/cloud/dialogflow/v2/conversations/rest/client.rb +30 -10
  32. data/lib/google/cloud/dialogflow/v2/conversations/rest/service_stub.rb +86 -56
  33. data/lib/google/cloud/dialogflow/v2/documents/client.rb +35 -9
  34. data/lib/google/cloud/dialogflow/v2/documents/operations.rb +12 -15
  35. data/lib/google/cloud/dialogflow/v2/documents/rest/client.rb +35 -9
  36. data/lib/google/cloud/dialogflow/v2/documents/rest/operations.rb +43 -38
  37. data/lib/google/cloud/dialogflow/v2/documents/rest/service_stub.rb +78 -50
  38. data/lib/google/cloud/dialogflow/v2/encryption_spec_service/client.rb +29 -3
  39. data/lib/google/cloud/dialogflow/v2/encryption_spec_service/operations.rb +12 -15
  40. data/lib/google/cloud/dialogflow/v2/encryption_spec_service/rest/client.rb +29 -3
  41. data/lib/google/cloud/dialogflow/v2/encryption_spec_service/rest/operations.rb +43 -38
  42. data/lib/google/cloud/dialogflow/v2/encryption_spec_service/rest/service_stub.rb +30 -14
  43. data/lib/google/cloud/dialogflow/v2/entity_types/client.rb +34 -11
  44. data/lib/google/cloud/dialogflow/v2/entity_types/operations.rb +12 -15
  45. data/lib/google/cloud/dialogflow/v2/entity_types/rest/client.rb +34 -11
  46. data/lib/google/cloud/dialogflow/v2/entity_types/rest/operations.rb +43 -38
  47. data/lib/google/cloud/dialogflow/v2/entity_types/rest/service_stub.rb +94 -62
  48. data/lib/google/cloud/dialogflow/v2/environments/client.rb +30 -7
  49. data/lib/google/cloud/dialogflow/v2/environments/rest/client.rb +30 -7
  50. data/lib/google/cloud/dialogflow/v2/environments/rest/service_stub.rb +62 -38
  51. data/lib/google/cloud/dialogflow/v2/fulfillments/client.rb +28 -3
  52. data/lib/google/cloud/dialogflow/v2/fulfillments/rest/client.rb +28 -3
  53. data/lib/google/cloud/dialogflow/v2/fulfillments/rest/service_stub.rb +30 -14
  54. data/lib/google/cloud/dialogflow/v2/generators/client.rb +29 -6
  55. data/lib/google/cloud/dialogflow/v2/generators/rest/client.rb +29 -6
  56. data/lib/google/cloud/dialogflow/v2/generators/rest/service_stub.rb +54 -32
  57. data/lib/google/cloud/dialogflow/v2/intent_pb.rb +1 -1
  58. data/lib/google/cloud/dialogflow/v2/intents/client.rb +31 -8
  59. data/lib/google/cloud/dialogflow/v2/intents/operations.rb +12 -15
  60. data/lib/google/cloud/dialogflow/v2/intents/rest/client.rb +31 -8
  61. data/lib/google/cloud/dialogflow/v2/intents/rest/operations.rb +43 -38
  62. data/lib/google/cloud/dialogflow/v2/intents/rest/service_stub.rb +70 -44
  63. data/lib/google/cloud/dialogflow/v2/knowledge_bases/client.rb +29 -6
  64. data/lib/google/cloud/dialogflow/v2/knowledge_bases/rest/client.rb +29 -6
  65. data/lib/google/cloud/dialogflow/v2/knowledge_bases/rest/service_stub.rb +54 -32
  66. data/lib/google/cloud/dialogflow/v2/participants/client.rb +29 -11
  67. data/lib/google/cloud/dialogflow/v2/participants/rest/client.rb +29 -10
  68. data/lib/google/cloud/dialogflow/v2/participants/rest/service_stub.rb +86 -56
  69. data/lib/google/cloud/dialogflow/v2/session_entity_types/client.rb +29 -6
  70. data/lib/google/cloud/dialogflow/v2/session_entity_types/rest/client.rb +29 -6
  71. data/lib/google/cloud/dialogflow/v2/session_entity_types/rest/service_stub.rb +54 -32
  72. data/lib/google/cloud/dialogflow/v2/sessions/client.rb +28 -3
  73. data/lib/google/cloud/dialogflow/v2/sessions/rest/client.rb +28 -2
  74. data/lib/google/cloud/dialogflow/v2/sessions/rest/service_stub.rb +22 -8
  75. data/lib/google/cloud/dialogflow/v2/version.rb +1 -1
  76. data/lib/google/cloud/dialogflow/v2/versions/client.rb +29 -6
  77. data/lib/google/cloud/dialogflow/v2/versions/rest/client.rb +29 -6
  78. data/lib/google/cloud/dialogflow/v2/versions/rest/service_stub.rb +54 -32
  79. data/proto_docs/google/api/client.rb +19 -0
  80. data/proto_docs/google/cloud/dialogflow/v2/answer_record.rb +3 -2
  81. data/proto_docs/google/cloud/dialogflow/v2/audio_config.rb +2 -2
  82. data/proto_docs/google/cloud/dialogflow/v2/conversation.rb +10 -6
  83. data/proto_docs/google/cloud/dialogflow/v2/conversation_dataset.rb +2 -2
  84. data/proto_docs/google/cloud/dialogflow/v2/conversation_profile.rb +7 -4
  85. data/proto_docs/google/cloud/dialogflow/v2/intent.rb +1 -1
  86. data/proto_docs/google/cloud/dialogflow/v2/participant.rb +10 -8
  87. data/proto_docs/google/cloud/dialogflow/v2/session.rb +12 -10
  88. data/proto_docs/google/longrunning/operations.rb +19 -14
  89. metadata +5 -5
@@ -115,14 +115,6 @@ module Google
115
115
  # Lists operations that match the specified filter in the request. If the
116
116
  # server doesn't support this method, it returns `UNIMPLEMENTED`.
117
117
  #
118
- # NOTE: the `name` binding allows API services to override the binding
119
- # to use different resource name schemes, such as `users/*/operations`. To
120
- # override the binding, API services can add a binding such as
121
- # `"/v1/{name=users/*}/operations"` to their service configuration.
122
- # For backwards compatibility, the default name includes the operations
123
- # collection id, however overriding users must ensure the name binding
124
- # is the parent resource, without the operations collection id.
125
- #
126
118
  # @overload list_operations(request, options = nil)
127
119
  # Pass arguments to `list_operations` via a request object, either of type
128
120
  # {::Google::Longrunning::ListOperationsRequest} or an equivalent Hash.
@@ -204,7 +196,7 @@ module Google
204
196
  @operations_stub.list_operations request, options do |result, operation|
205
197
  result = ::Gapic::Rest::PagedEnumerable.new @operations_stub, :list_operations, "operations", request, result, options
206
198
  yield result, operation if block_given?
207
- return result
199
+ throw :response, result
208
200
  end
209
201
  rescue ::Gapic::Rest::Error => e
210
202
  raise ::Google::Cloud::Error.from_error(e)
@@ -293,7 +285,7 @@ module Google
293
285
  @operations_stub.get_operation request, options do |result, operation|
294
286
  result = ::Gapic::Operation.new result, @operations_client, options: options
295
287
  yield result, operation if block_given?
296
- return result
288
+ throw :response, result
297
289
  end
298
290
  rescue ::Gapic::Rest::Error => e
299
291
  raise ::Google::Cloud::Error.from_error(e)
@@ -375,7 +367,6 @@ module Google
375
367
 
376
368
  @operations_stub.delete_operation request, options do |result, operation|
377
369
  yield result, operation if block_given?
378
- return result
379
370
  end
380
371
  rescue ::Gapic::Rest::Error => e
381
372
  raise ::Google::Cloud::Error.from_error(e)
@@ -390,8 +381,9 @@ module Google
390
381
  # other methods to check whether the cancellation succeeded or whether the
391
382
  # operation completed despite cancellation. On successful cancellation,
392
383
  # the operation is not deleted; instead, it becomes an operation with
393
- # an {::Google::Longrunning::Operation#error Operation.error} value with a {::Google::Rpc::Status#code google.rpc.Status.code} of 1,
394
- # corresponding to `Code.CANCELLED`.
384
+ # an {::Google::Longrunning::Operation#error Operation.error} value with a
385
+ # {::Google::Rpc::Status#code google.rpc.Status.code} of `1`, corresponding to
386
+ # `Code.CANCELLED`.
395
387
  #
396
388
  # @overload cancel_operation(request, options = nil)
397
389
  # Pass arguments to `cancel_operation` via a request object, either of type
@@ -463,7 +455,6 @@ module Google
463
455
 
464
456
  @operations_stub.cancel_operation request, options do |result, operation|
465
457
  yield result, operation if block_given?
466
- return result
467
458
  end
468
459
  rescue ::Gapic::Rest::Error => e
469
460
  raise ::Google::Cloud::Error.from_error(e)
@@ -543,6 +534,11 @@ module Google
543
534
  # default endpoint URL. The default value of nil uses the environment
544
535
  # universe (usually the default "googleapis.com" universe).
545
536
  # @return [::String,nil]
537
+ # @!attribute [rw] logger
538
+ # A custom logger to use for request/response debug logging, or the value
539
+ # `:default` (the default) to construct a default logger, or `nil` to
540
+ # explicitly disable logging.
541
+ # @return [::Logger,:default,nil]
546
542
  #
547
543
  class Configuration
548
544
  extend ::Gapic::Config
@@ -564,6 +560,7 @@ module Google
564
560
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
565
561
  config_attr :quota_project, nil, ::String, nil
566
562
  config_attr :universe_domain, nil, ::String, nil
563
+ config_attr :logger, :default, ::Logger, nil, :default
567
564
 
568
565
  # @private
569
566
  def initialize parent_config = nil
@@ -683,16 +680,18 @@ module Google
683
680
 
684
681
  response = @client_stub.make_http_request(
685
682
  verb,
686
- uri: uri,
687
- body: body || "",
688
- params: query_string_params,
683
+ uri: uri,
684
+ body: body || "",
685
+ params: query_string_params,
686
+ method_name: "list_operations",
689
687
  options: options
690
688
  )
691
689
  operation = ::Gapic::Rest::TransportOperation.new response
692
690
  result = ::Google::Longrunning::ListOperationsResponse.decode_json response.body, ignore_unknown_fields: true
693
-
694
- yield result, operation if block_given?
695
- result
691
+ catch :response do
692
+ yield result, operation if block_given?
693
+ result
694
+ end
696
695
  end
697
696
 
698
697
  ##
@@ -721,16 +720,18 @@ module Google
721
720
 
722
721
  response = @client_stub.make_http_request(
723
722
  verb,
724
- uri: uri,
725
- body: body || "",
726
- params: query_string_params,
723
+ uri: uri,
724
+ body: body || "",
725
+ params: query_string_params,
726
+ method_name: "get_operation",
727
727
  options: options
728
728
  )
729
729
  operation = ::Gapic::Rest::TransportOperation.new response
730
730
  result = ::Google::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true
731
-
732
- yield result, operation if block_given?
733
- result
731
+ catch :response do
732
+ yield result, operation if block_given?
733
+ result
734
+ end
734
735
  end
735
736
 
736
737
  ##
@@ -759,16 +760,18 @@ module Google
759
760
 
760
761
  response = @client_stub.make_http_request(
761
762
  verb,
762
- uri: uri,
763
- body: body || "",
764
- params: query_string_params,
763
+ uri: uri,
764
+ body: body || "",
765
+ params: query_string_params,
766
+ method_name: "delete_operation",
765
767
  options: options
766
768
  )
767
769
  operation = ::Gapic::Rest::TransportOperation.new response
768
770
  result = ::Google::Protobuf::Empty.decode_json response.body, ignore_unknown_fields: true
769
-
770
- yield result, operation if block_given?
771
- result
771
+ catch :response do
772
+ yield result, operation if block_given?
773
+ result
774
+ end
772
775
  end
773
776
 
774
777
  ##
@@ -797,16 +800,18 @@ module Google
797
800
 
798
801
  response = @client_stub.make_http_request(
799
802
  verb,
800
- uri: uri,
801
- body: body || "",
802
- params: query_string_params,
803
+ uri: uri,
804
+ body: body || "",
805
+ params: query_string_params,
806
+ method_name: "cancel_operation",
803
807
  options: options
804
808
  )
805
809
  operation = ::Gapic::Rest::TransportOperation.new response
806
810
  result = ::Google::Protobuf::Empty.decode_json response.body, ignore_unknown_fields: true
807
-
808
- yield result, operation if block_given?
809
- result
811
+ catch :response do
812
+ yield result, operation if block_given?
813
+ result
814
+ end
810
815
  end
811
816
 
812
817
  ##
@@ -30,7 +30,8 @@ module Google
30
30
  # including transcoding, making the REST call, and deserialing the response.
31
31
  #
32
32
  class ServiceStub
33
- def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
33
+ # @private
34
+ def initialize endpoint:, endpoint_template:, universe_domain:, credentials:, logger:
34
35
  # These require statements are intentionally placed here to initialize
35
36
  # the REST modules only when it's required.
36
37
  require "gapic/rest"
@@ -40,7 +41,9 @@ module Google
40
41
  universe_domain: universe_domain,
41
42
  credentials: credentials,
42
43
  numeric_enums: true,
43
- raise_faraday_errors: false
44
+ service_name: self.class,
45
+ raise_faraday_errors: false,
46
+ logger: logger
44
47
  end
45
48
 
46
49
  ##
@@ -61,6 +64,15 @@ module Google
61
64
  @client_stub.endpoint
62
65
  end
63
66
 
67
+ ##
68
+ # The logger used for request/response debug logging.
69
+ #
70
+ # @return [Logger]
71
+ #
72
+ def logger stub: false
73
+ stub ? @client_stub.stub_logger : @client_stub.logger
74
+ end
75
+
64
76
  ##
65
77
  # Baseline implementation for the get_encryption_spec REST call
66
78
  #
@@ -87,16 +99,18 @@ module Google
87
99
 
88
100
  response = @client_stub.make_http_request(
89
101
  verb,
90
- uri: uri,
91
- body: body || "",
92
- params: query_string_params,
102
+ uri: uri,
103
+ body: body || "",
104
+ params: query_string_params,
105
+ method_name: "get_encryption_spec",
93
106
  options: options
94
107
  )
95
108
  operation = ::Gapic::Rest::TransportOperation.new response
96
109
  result = ::Google::Cloud::Dialogflow::V2::EncryptionSpec.decode_json response.body, ignore_unknown_fields: true
97
-
98
- yield result, operation if block_given?
99
- result
110
+ catch :response do
111
+ yield result, operation if block_given?
112
+ result
113
+ end
100
114
  end
101
115
 
102
116
  ##
@@ -125,16 +139,18 @@ module Google
125
139
 
126
140
  response = @client_stub.make_http_request(
127
141
  verb,
128
- uri: uri,
129
- body: body || "",
130
- params: query_string_params,
142
+ uri: uri,
143
+ body: body || "",
144
+ params: query_string_params,
145
+ method_name: "initialize_encryption_spec",
131
146
  options: options
132
147
  )
133
148
  operation = ::Gapic::Rest::TransportOperation.new response
134
149
  result = ::Google::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true
135
-
136
- yield result, operation if block_given?
137
- result
150
+ catch :response do
151
+ yield result, operation if block_given?
152
+ result
153
+ end
138
154
  end
139
155
 
140
156
  ##
@@ -170,14 +170,26 @@ module Google
170
170
  universe_domain: @config.universe_domain,
171
171
  channel_args: @config.channel_args,
172
172
  interceptors: @config.interceptors,
173
- channel_pool_config: @config.channel_pool
173
+ channel_pool_config: @config.channel_pool,
174
+ logger: @config.logger
174
175
  )
175
176
 
177
+ @entity_types_stub.stub_logger&.info do |entry|
178
+ entry.set_system_name
179
+ entry.set_service
180
+ entry.message = "Created client for #{entry.service}"
181
+ entry.set_credentials_fields credentials
182
+ entry.set "customEndpoint", @config.endpoint if @config.endpoint
183
+ entry.set "defaultTimeout", @config.timeout if @config.timeout
184
+ entry.set "quotaProject", @quota_project_id if @quota_project_id
185
+ end
186
+
176
187
  @location_client = Google::Cloud::Location::Locations::Client.new do |config|
177
188
  config.credentials = credentials
178
189
  config.quota_project = @quota_project_id
179
190
  config.endpoint = @entity_types_stub.endpoint
180
191
  config.universe_domain = @entity_types_stub.universe_domain
192
+ config.logger = @entity_types_stub.logger if config.respond_to? :logger=
181
193
  end
182
194
  end
183
195
 
@@ -195,6 +207,15 @@ module Google
195
207
  #
196
208
  attr_reader :location_client
197
209
 
210
+ ##
211
+ # The logger used for request/response debug logging.
212
+ #
213
+ # @return [Logger]
214
+ #
215
+ def logger
216
+ @entity_types_stub.logger
217
+ end
218
+
198
219
  # Service calls
199
220
 
200
221
  ##
@@ -294,7 +315,7 @@ module Google
294
315
  @entity_types_stub.call_rpc :list_entity_types, request, options: options do |response, operation|
295
316
  response = ::Gapic::PagedEnumerable.new @entity_types_stub, :list_entity_types, request, response, operation, options
296
317
  yield response, operation if block_given?
297
- return response
318
+ throw :response, response
298
319
  end
299
320
  rescue ::GRPC::BadStatus => e
300
321
  raise ::Google::Cloud::Error.from_error(e)
@@ -387,7 +408,6 @@ module Google
387
408
 
388
409
  @entity_types_stub.call_rpc :get_entity_type, request, options: options do |response, operation|
389
410
  yield response, operation if block_given?
390
- return response
391
411
  end
392
412
  rescue ::GRPC::BadStatus => e
393
413
  raise ::Google::Cloud::Error.from_error(e)
@@ -486,7 +506,6 @@ module Google
486
506
 
487
507
  @entity_types_stub.call_rpc :create_entity_type, request, options: options do |response, operation|
488
508
  yield response, operation if block_given?
489
- return response
490
509
  end
491
510
  rescue ::GRPC::BadStatus => e
492
511
  raise ::Google::Cloud::Error.from_error(e)
@@ -584,7 +603,6 @@ module Google
584
603
 
585
604
  @entity_types_stub.call_rpc :update_entity_type, request, options: options do |response, operation|
586
605
  yield response, operation if block_given?
587
- return response
588
606
  end
589
607
  rescue ::GRPC::BadStatus => e
590
608
  raise ::Google::Cloud::Error.from_error(e)
@@ -675,7 +693,6 @@ module Google
675
693
 
676
694
  @entity_types_stub.call_rpc :delete_entity_type, request, options: options do |response, operation|
677
695
  yield response, operation if block_given?
678
- return response
679
696
  end
680
697
  rescue ::GRPC::BadStatus => e
681
698
  raise ::Google::Cloud::Error.from_error(e)
@@ -798,7 +815,7 @@ module Google
798
815
  @entity_types_stub.call_rpc :batch_update_entity_types, request, options: options do |response, operation|
799
816
  response = ::Gapic::Operation.new response, @operations_client, options: options
800
817
  yield response, operation if block_given?
801
- return response
818
+ throw :response, response
802
819
  end
803
820
  rescue ::GRPC::BadStatus => e
804
821
  raise ::Google::Cloud::Error.from_error(e)
@@ -909,7 +926,7 @@ module Google
909
926
  @entity_types_stub.call_rpc :batch_delete_entity_types, request, options: options do |response, operation|
910
927
  response = ::Gapic::Operation.new response, @operations_client, options: options
911
928
  yield response, operation if block_given?
912
- return response
929
+ throw :response, response
913
930
  end
914
931
  rescue ::GRPC::BadStatus => e
915
932
  raise ::Google::Cloud::Error.from_error(e)
@@ -1025,7 +1042,7 @@ module Google
1025
1042
  @entity_types_stub.call_rpc :batch_create_entities, request, options: options do |response, operation|
1026
1043
  response = ::Gapic::Operation.new response, @operations_client, options: options
1027
1044
  yield response, operation if block_given?
1028
- return response
1045
+ throw :response, response
1029
1046
  end
1030
1047
  rescue ::GRPC::BadStatus => e
1031
1048
  raise ::Google::Cloud::Error.from_error(e)
@@ -1145,7 +1162,7 @@ module Google
1145
1162
  @entity_types_stub.call_rpc :batch_update_entities, request, options: options do |response, operation|
1146
1163
  response = ::Gapic::Operation.new response, @operations_client, options: options
1147
1164
  yield response, operation if block_given?
1148
- return response
1165
+ throw :response, response
1149
1166
  end
1150
1167
  rescue ::GRPC::BadStatus => e
1151
1168
  raise ::Google::Cloud::Error.from_error(e)
@@ -1263,7 +1280,7 @@ module Google
1263
1280
  @entity_types_stub.call_rpc :batch_delete_entities, request, options: options do |response, operation|
1264
1281
  response = ::Gapic::Operation.new response, @operations_client, options: options
1265
1282
  yield response, operation if block_given?
1266
- return response
1283
+ throw :response, response
1267
1284
  end
1268
1285
  rescue ::GRPC::BadStatus => e
1269
1286
  raise ::Google::Cloud::Error.from_error(e)
@@ -1352,6 +1369,11 @@ module Google
1352
1369
  # default endpoint URL. The default value of nil uses the environment
1353
1370
  # universe (usually the default "googleapis.com" universe).
1354
1371
  # @return [::String,nil]
1372
+ # @!attribute [rw] logger
1373
+ # A custom logger to use for request/response debug logging, or the value
1374
+ # `:default` (the default) to construct a default logger, or `nil` to
1375
+ # explicitly disable logging.
1376
+ # @return [::Logger,:default,nil]
1355
1377
  #
1356
1378
  class Configuration
1357
1379
  extend ::Gapic::Config
@@ -1376,6 +1398,7 @@ module Google
1376
1398
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
1377
1399
  config_attr :quota_project, nil, ::String, nil
1378
1400
  config_attr :universe_domain, nil, ::String, nil
1401
+ config_attr :logger, :default, ::Logger, nil, :default
1379
1402
 
1380
1403
  # @private
1381
1404
  def initialize parent_config = nil
@@ -124,14 +124,6 @@ module Google
124
124
  # Lists operations that match the specified filter in the request. If the
125
125
  # server doesn't support this method, it returns `UNIMPLEMENTED`.
126
126
  #
127
- # NOTE: the `name` binding allows API services to override the binding
128
- # to use different resource name schemes, such as `users/*/operations`. To
129
- # override the binding, API services can add a binding such as
130
- # `"/v1/{name=users/*}/operations"` to their service configuration.
131
- # For backwards compatibility, the default name includes the operations
132
- # collection id, however overriding users must ensure the name binding
133
- # is the parent resource, without the operations collection id.
134
- #
135
127
  # @overload list_operations(request, options = nil)
136
128
  # Pass arguments to `list_operations` via a request object, either of type
137
129
  # {::Google::Longrunning::ListOperationsRequest} or an equivalent Hash.
@@ -221,7 +213,7 @@ module Google
221
213
  wrap_lro_operation = ->(op_response) { ::Gapic::Operation.new op_response, @operations_client }
222
214
  response = ::Gapic::PagedEnumerable.new @operations_stub, :list_operations, request, response, operation, options, format_resource: wrap_lro_operation
223
215
  yield response, operation if block_given?
224
- return response
216
+ throw :response, response
225
217
  end
226
218
  rescue ::GRPC::BadStatus => e
227
219
  raise ::Google::Cloud::Error.from_error(e)
@@ -317,7 +309,7 @@ module Google
317
309
  @operations_stub.call_rpc :get_operation, request, options: options do |response, operation|
318
310
  response = ::Gapic::Operation.new response, @operations_client, options: options
319
311
  yield response, operation if block_given?
320
- return response
312
+ throw :response, response
321
313
  end
322
314
  rescue ::GRPC::BadStatus => e
323
315
  raise ::Google::Cloud::Error.from_error(e)
@@ -406,7 +398,6 @@ module Google
406
398
 
407
399
  @operations_stub.call_rpc :delete_operation, request, options: options do |response, operation|
408
400
  yield response, operation if block_given?
409
- return response
410
401
  end
411
402
  rescue ::GRPC::BadStatus => e
412
403
  raise ::Google::Cloud::Error.from_error(e)
@@ -421,8 +412,9 @@ module Google
421
412
  # other methods to check whether the cancellation succeeded or whether the
422
413
  # operation completed despite cancellation. On successful cancellation,
423
414
  # the operation is not deleted; instead, it becomes an operation with
424
- # an {::Google::Longrunning::Operation#error Operation.error} value with a {::Google::Rpc::Status#code google.rpc.Status.code} of 1,
425
- # corresponding to `Code.CANCELLED`.
415
+ # an {::Google::Longrunning::Operation#error Operation.error} value with a
416
+ # {::Google::Rpc::Status#code google.rpc.Status.code} of `1`, corresponding to
417
+ # `Code.CANCELLED`.
426
418
  #
427
419
  # @overload cancel_operation(request, options = nil)
428
420
  # Pass arguments to `cancel_operation` via a request object, either of type
@@ -501,7 +493,6 @@ module Google
501
493
 
502
494
  @operations_stub.call_rpc :cancel_operation, request, options: options do |response, operation|
503
495
  yield response, operation if block_given?
504
- return response
505
496
  end
506
497
  rescue ::GRPC::BadStatus => e
507
498
  raise ::Google::Cloud::Error.from_error(e)
@@ -599,7 +590,7 @@ module Google
599
590
  @operations_stub.call_rpc :wait_operation, request, options: options do |response, operation|
600
591
  response = ::Gapic::Operation.new response, @operations_client, options: options
601
592
  yield response, operation if block_given?
602
- return response
593
+ throw :response, response
603
594
  end
604
595
  rescue ::GRPC::BadStatus => e
605
596
  raise ::Google::Cloud::Error.from_error(e)
@@ -688,6 +679,11 @@ module Google
688
679
  # default endpoint URL. The default value of nil uses the environment
689
680
  # universe (usually the default "googleapis.com" universe).
690
681
  # @return [::String,nil]
682
+ # @!attribute [rw] logger
683
+ # A custom logger to use for request/response debug logging, or the value
684
+ # `:default` (the default) to construct a default logger, or `nil` to
685
+ # explicitly disable logging.
686
+ # @return [::Logger,:default,nil]
691
687
  #
692
688
  class Configuration
693
689
  extend ::Gapic::Config
@@ -712,6 +708,7 @@ module Google
712
708
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
713
709
  config_attr :quota_project, nil, ::String, nil
714
710
  config_attr :universe_domain, nil, ::String, nil
711
+ config_attr :logger, :default, ::Logger, nil, :default
715
712
 
716
713
  # @private
717
714
  def initialize parent_config = nil
@@ -163,15 +163,27 @@ module Google
163
163
  endpoint: @config.endpoint,
164
164
  endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
165
165
  universe_domain: @config.universe_domain,
166
- credentials: credentials
166
+ credentials: credentials,
167
+ logger: @config.logger
167
168
  )
168
169
 
170
+ @entity_types_stub.logger(stub: true)&.info do |entry|
171
+ entry.set_system_name
172
+ entry.set_service
173
+ entry.message = "Created client for #{entry.service}"
174
+ entry.set_credentials_fields credentials
175
+ entry.set "customEndpoint", @config.endpoint if @config.endpoint
176
+ entry.set "defaultTimeout", @config.timeout if @config.timeout
177
+ entry.set "quotaProject", @quota_project_id if @quota_project_id
178
+ end
179
+
169
180
  @location_client = Google::Cloud::Location::Locations::Rest::Client.new do |config|
170
181
  config.credentials = credentials
171
182
  config.quota_project = @quota_project_id
172
183
  config.endpoint = @entity_types_stub.endpoint
173
184
  config.universe_domain = @entity_types_stub.universe_domain
174
185
  config.bindings_override = @config.bindings_override
186
+ config.logger = @entity_types_stub.logger if config.respond_to? :logger=
175
187
  end
176
188
  end
177
189
 
@@ -189,6 +201,15 @@ module Google
189
201
  #
190
202
  attr_reader :location_client
191
203
 
204
+ ##
205
+ # The logger used for request/response debug logging.
206
+ #
207
+ # @return [Logger]
208
+ #
209
+ def logger
210
+ @entity_types_stub.logger
211
+ end
212
+
192
213
  # Service calls
193
214
 
194
215
  ##
@@ -281,7 +302,7 @@ module Google
281
302
  @entity_types_stub.list_entity_types request, options do |result, operation|
282
303
  result = ::Gapic::Rest::PagedEnumerable.new @entity_types_stub, :list_entity_types, "entity_types", request, result, options
283
304
  yield result, operation if block_given?
284
- return result
305
+ throw :response, result
285
306
  end
286
307
  rescue ::Gapic::Rest::Error => e
287
308
  raise ::Google::Cloud::Error.from_error(e)
@@ -367,7 +388,6 @@ module Google
367
388
 
368
389
  @entity_types_stub.get_entity_type request, options do |result, operation|
369
390
  yield result, operation if block_given?
370
- return result
371
391
  end
372
392
  rescue ::Gapic::Rest::Error => e
373
393
  raise ::Google::Cloud::Error.from_error(e)
@@ -459,7 +479,6 @@ module Google
459
479
 
460
480
  @entity_types_stub.create_entity_type request, options do |result, operation|
461
481
  yield result, operation if block_given?
462
- return result
463
482
  end
464
483
  rescue ::Gapic::Rest::Error => e
465
484
  raise ::Google::Cloud::Error.from_error(e)
@@ -550,7 +569,6 @@ module Google
550
569
 
551
570
  @entity_types_stub.update_entity_type request, options do |result, operation|
552
571
  yield result, operation if block_given?
553
- return result
554
572
  end
555
573
  rescue ::Gapic::Rest::Error => e
556
574
  raise ::Google::Cloud::Error.from_error(e)
@@ -634,7 +652,6 @@ module Google
634
652
 
635
653
  @entity_types_stub.delete_entity_type request, options do |result, operation|
636
654
  yield result, operation if block_given?
637
- return result
638
655
  end
639
656
  rescue ::Gapic::Rest::Error => e
640
657
  raise ::Google::Cloud::Error.from_error(e)
@@ -750,7 +767,7 @@ module Google
750
767
  @entity_types_stub.batch_update_entity_types request, options do |result, operation|
751
768
  result = ::Gapic::Operation.new result, @operations_client, options: options
752
769
  yield result, operation if block_given?
753
- return result
770
+ throw :response, result
754
771
  end
755
772
  rescue ::Gapic::Rest::Error => e
756
773
  raise ::Google::Cloud::Error.from_error(e)
@@ -854,7 +871,7 @@ module Google
854
871
  @entity_types_stub.batch_delete_entity_types request, options do |result, operation|
855
872
  result = ::Gapic::Operation.new result, @operations_client, options: options
856
873
  yield result, operation if block_given?
857
- return result
874
+ throw :response, result
858
875
  end
859
876
  rescue ::Gapic::Rest::Error => e
860
877
  raise ::Google::Cloud::Error.from_error(e)
@@ -963,7 +980,7 @@ module Google
963
980
  @entity_types_stub.batch_create_entities request, options do |result, operation|
964
981
  result = ::Gapic::Operation.new result, @operations_client, options: options
965
982
  yield result, operation if block_given?
966
- return result
983
+ throw :response, result
967
984
  end
968
985
  rescue ::Gapic::Rest::Error => e
969
986
  raise ::Google::Cloud::Error.from_error(e)
@@ -1076,7 +1093,7 @@ module Google
1076
1093
  @entity_types_stub.batch_update_entities request, options do |result, operation|
1077
1094
  result = ::Gapic::Operation.new result, @operations_client, options: options
1078
1095
  yield result, operation if block_given?
1079
- return result
1096
+ throw :response, result
1080
1097
  end
1081
1098
  rescue ::Gapic::Rest::Error => e
1082
1099
  raise ::Google::Cloud::Error.from_error(e)
@@ -1187,7 +1204,7 @@ module Google
1187
1204
  @entity_types_stub.batch_delete_entities request, options do |result, operation|
1188
1205
  result = ::Gapic::Operation.new result, @operations_client, options: options
1189
1206
  yield result, operation if block_given?
1190
- return result
1207
+ throw :response, result
1191
1208
  end
1192
1209
  rescue ::Gapic::Rest::Error => e
1193
1210
  raise ::Google::Cloud::Error.from_error(e)
@@ -1267,6 +1284,11 @@ module Google
1267
1284
  # default endpoint URL. The default value of nil uses the environment
1268
1285
  # universe (usually the default "googleapis.com" universe).
1269
1286
  # @return [::String,nil]
1287
+ # @!attribute [rw] logger
1288
+ # A custom logger to use for request/response debug logging, or the value
1289
+ # `:default` (the default) to construct a default logger, or `nil` to
1290
+ # explicitly disable logging.
1291
+ # @return [::Logger,:default,nil]
1270
1292
  #
1271
1293
  class Configuration
1272
1294
  extend ::Gapic::Config
@@ -1295,6 +1317,7 @@ module Google
1295
1317
  # by the host service.
1296
1318
  # @return [::Hash{::Symbol=>::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>}]
1297
1319
  config_attr :bindings_override, {}, ::Hash, nil
1320
+ config_attr :logger, :default, ::Logger, nil, :default
1298
1321
 
1299
1322
  # @private
1300
1323
  def initialize parent_config = nil