google-cloud-discovery_engine-v1beta 0.16.0 → 0.18.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (103) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +31 -21
  3. data/lib/google/cloud/discovery_engine/v1beta/completion_service/client.rb +49 -7
  4. data/lib/google/cloud/discovery_engine/v1beta/completion_service/operations.rb +19 -15
  5. data/lib/google/cloud/discovery_engine/v1beta/completion_service/rest/client.rb +49 -7
  6. data/lib/google/cloud/discovery_engine/v1beta/completion_service/rest/operations.rb +50 -38
  7. data/lib/google/cloud/discovery_engine/v1beta/completion_service/rest/service_stub.rb +62 -38
  8. data/lib/google/cloud/discovery_engine/v1beta/control_service/client.rb +36 -6
  9. data/lib/google/cloud/discovery_engine/v1beta/control_service/rest/client.rb +36 -6
  10. data/lib/google/cloud/discovery_engine/v1beta/control_service/rest/service_stub.rb +54 -32
  11. data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/client.rb +37 -14
  12. data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/rest/client.rb +37 -14
  13. data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/rest/service_stub.rb +118 -80
  14. data/lib/google/cloud/discovery_engine/v1beta/data_store_service/client.rb +38 -6
  15. data/lib/google/cloud/discovery_engine/v1beta/data_store_service/operations.rb +19 -15
  16. data/lib/google/cloud/discovery_engine/v1beta/data_store_service/rest/client.rb +38 -6
  17. data/lib/google/cloud/discovery_engine/v1beta/data_store_service/rest/operations.rb +50 -38
  18. data/lib/google/cloud/discovery_engine/v1beta/data_store_service/rest/service_stub.rb +54 -32
  19. data/lib/google/cloud/discovery_engine/v1beta/document_service/client.rb +60 -9
  20. data/lib/google/cloud/discovery_engine/v1beta/document_service/operations.rb +19 -15
  21. data/lib/google/cloud/discovery_engine/v1beta/document_service/rest/client.rb +60 -9
  22. data/lib/google/cloud/discovery_engine/v1beta/document_service/rest/operations.rb +50 -38
  23. data/lib/google/cloud/discovery_engine/v1beta/document_service/rest/service_stub.rb +78 -50
  24. data/lib/google/cloud/discovery_engine/v1beta/engine_service/client.rb +39 -9
  25. data/lib/google/cloud/discovery_engine/v1beta/engine_service/operations.rb +19 -15
  26. data/lib/google/cloud/discovery_engine/v1beta/engine_service/rest/client.rb +39 -9
  27. data/lib/google/cloud/discovery_engine/v1beta/engine_service/rest/operations.rb +50 -38
  28. data/lib/google/cloud/discovery_engine/v1beta/engine_service/rest/service_stub.rb +78 -50
  29. data/lib/google/cloud/discovery_engine/v1beta/evaluation_service/client.rb +38 -5
  30. data/lib/google/cloud/discovery_engine/v1beta/evaluation_service/operations.rb +19 -15
  31. data/lib/google/cloud/discovery_engine/v1beta/evaluation_service/rest/client.rb +38 -5
  32. data/lib/google/cloud/discovery_engine/v1beta/evaluation_service/rest/operations.rb +50 -38
  33. data/lib/google/cloud/discovery_engine/v1beta/evaluation_service/rest/service_stub.rb +46 -26
  34. data/lib/google/cloud/discovery_engine/v1beta/grounded_generation_service/client.rb +35 -4
  35. data/lib/google/cloud/discovery_engine/v1beta/grounded_generation_service/rest/client.rb +35 -3
  36. data/lib/google/cloud/discovery_engine/v1beta/grounded_generation_service/rest/service_stub.rb +30 -14
  37. data/lib/google/cloud/discovery_engine/v1beta/project_service/client.rb +36 -2
  38. data/lib/google/cloud/discovery_engine/v1beta/project_service/operations.rb +19 -15
  39. data/lib/google/cloud/discovery_engine/v1beta/project_service/rest/client.rb +36 -2
  40. data/lib/google/cloud/discovery_engine/v1beta/project_service/rest/operations.rb +50 -38
  41. data/lib/google/cloud/discovery_engine/v1beta/project_service/rest/service_stub.rb +22 -8
  42. data/lib/google/cloud/discovery_engine/v1beta/rank_service/client.rb +35 -2
  43. data/lib/google/cloud/discovery_engine/v1beta/rank_service/rest/client.rb +35 -2
  44. data/lib/google/cloud/discovery_engine/v1beta/rank_service/rest/service_stub.rb +22 -8
  45. data/lib/google/cloud/discovery_engine/v1beta/recommendation_service/client.rb +35 -2
  46. data/lib/google/cloud/discovery_engine/v1beta/recommendation_service/rest/client.rb +35 -2
  47. data/lib/google/cloud/discovery_engine/v1beta/recommendation_service/rest/service_stub.rb +22 -8
  48. data/lib/google/cloud/discovery_engine/v1beta/sample_query_service/client.rb +43 -7
  49. data/lib/google/cloud/discovery_engine/v1beta/sample_query_service/operations.rb +19 -15
  50. data/lib/google/cloud/discovery_engine/v1beta/sample_query_service/rest/client.rb +43 -7
  51. data/lib/google/cloud/discovery_engine/v1beta/sample_query_service/rest/operations.rb +50 -38
  52. data/lib/google/cloud/discovery_engine/v1beta/sample_query_service/rest/service_stub.rb +62 -38
  53. data/lib/google/cloud/discovery_engine/v1beta/sample_query_set_service/client.rb +36 -6
  54. data/lib/google/cloud/discovery_engine/v1beta/sample_query_set_service/rest/client.rb +36 -6
  55. data/lib/google/cloud/discovery_engine/v1beta/sample_query_set_service/rest/service_stub.rb +54 -32
  56. data/lib/google/cloud/discovery_engine/v1beta/schema_service/client.rb +39 -6
  57. data/lib/google/cloud/discovery_engine/v1beta/schema_service/operations.rb +19 -15
  58. data/lib/google/cloud/discovery_engine/v1beta/schema_service/rest/client.rb +39 -6
  59. data/lib/google/cloud/discovery_engine/v1beta/schema_service/rest/operations.rb +50 -38
  60. data/lib/google/cloud/discovery_engine/v1beta/schema_service/rest/service_stub.rb +54 -32
  61. data/lib/google/cloud/discovery_engine/v1beta/search_service/client.rb +37 -3
  62. data/lib/google/cloud/discovery_engine/v1beta/search_service/rest/client.rb +35 -3
  63. data/lib/google/cloud/discovery_engine/v1beta/search_service/rest/service_stub.rb +30 -14
  64. data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/client.rb +36 -3
  65. data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/operations.rb +19 -15
  66. data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/rest/client.rb +36 -3
  67. data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/rest/operations.rb +50 -38
  68. data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/rest/service_stub.rb +30 -14
  69. data/lib/google/cloud/discovery_engine/v1beta/serving_config_service/client.rb +36 -4
  70. data/lib/google/cloud/discovery_engine/v1beta/serving_config_service/rest/client.rb +36 -4
  71. data/lib/google/cloud/discovery_engine/v1beta/serving_config_service/rest/service_stub.rb +38 -20
  72. data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/client.rb +47 -16
  73. data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/operations.rb +19 -15
  74. data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/rest/client.rb +47 -16
  75. data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/rest/operations.rb +50 -38
  76. data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/rest/service_stub.rb +134 -92
  77. data/lib/google/cloud/discovery_engine/v1beta/user_event_service/client.rb +43 -5
  78. data/lib/google/cloud/discovery_engine/v1beta/user_event_service/operations.rb +19 -15
  79. data/lib/google/cloud/discovery_engine/v1beta/user_event_service/rest/client.rb +43 -5
  80. data/lib/google/cloud/discovery_engine/v1beta/user_event_service/rest/operations.rb +50 -38
  81. data/lib/google/cloud/discovery_engine/v1beta/user_event_service/rest/service_stub.rb +46 -26
  82. data/lib/google/cloud/discovery_engine/v1beta/version.rb +1 -1
  83. data/proto_docs/google/api/client.rb +19 -0
  84. data/proto_docs/google/cloud/discoveryengine/v1beta/answer.rb +6 -0
  85. data/proto_docs/google/cloud/discoveryengine/v1beta/common.rb +8 -0
  86. data/proto_docs/google/cloud/discoveryengine/v1beta/completion.rb +4 -0
  87. data/proto_docs/google/cloud/discoveryengine/v1beta/control.rb +8 -0
  88. data/proto_docs/google/cloud/discoveryengine/v1beta/conversation.rb +4 -0
  89. data/proto_docs/google/cloud/discoveryengine/v1beta/conversational_search_service.rb +8 -0
  90. data/proto_docs/google/cloud/discoveryengine/v1beta/document.rb +8 -0
  91. data/proto_docs/google/cloud/discoveryengine/v1beta/document_processing_config.rb +6 -0
  92. data/proto_docs/google/cloud/discoveryengine/v1beta/document_service.rb +8 -0
  93. data/proto_docs/google/cloud/discoveryengine/v1beta/engine.rb +4 -0
  94. data/proto_docs/google/cloud/discoveryengine/v1beta/grounded_generation_service.rb +6 -0
  95. data/proto_docs/google/cloud/discoveryengine/v1beta/import_config.rb +40 -0
  96. data/proto_docs/google/cloud/discoveryengine/v1beta/purge_config.rb +4 -0
  97. data/proto_docs/google/cloud/discoveryengine/v1beta/schema.rb +4 -0
  98. data/proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb +14 -0
  99. data/proto_docs/google/cloud/discoveryengine/v1beta/serving_config.rb +8 -0
  100. data/proto_docs/google/cloud/discoveryengine/v1beta/user_event.rb +6 -0
  101. data/proto_docs/google/longrunning/operations.rb +23 -14
  102. data/proto_docs/google/protobuf/struct.rb +12 -0
  103. metadata +6 -9
@@ -159,14 +159,26 @@ module Google
159
159
  universe_domain: @config.universe_domain,
160
160
  channel_args: @config.channel_args,
161
161
  interceptors: @config.interceptors,
162
- channel_pool_config: @config.channel_pool
162
+ channel_pool_config: @config.channel_pool,
163
+ logger: @config.logger
163
164
  )
164
165
 
166
+ @serving_config_service_stub.stub_logger&.info do |entry|
167
+ entry.set_system_name
168
+ entry.set_service
169
+ entry.message = "Created client for #{entry.service}"
170
+ entry.set_credentials_fields credentials
171
+ entry.set "customEndpoint", @config.endpoint if @config.endpoint
172
+ entry.set "defaultTimeout", @config.timeout if @config.timeout
173
+ entry.set "quotaProject", @quota_project_id if @quota_project_id
174
+ end
175
+
165
176
  @location_client = Google::Cloud::Location::Locations::Client.new do |config|
166
177
  config.credentials = credentials
167
178
  config.quota_project = @quota_project_id
168
179
  config.endpoint = @serving_config_service_stub.endpoint
169
180
  config.universe_domain = @serving_config_service_stub.universe_domain
181
+ config.logger = @serving_config_service_stub.logger if config.respond_to? :logger=
170
182
  end
171
183
  end
172
184
 
@@ -177,6 +189,15 @@ module Google
177
189
  #
178
190
  attr_reader :location_client
179
191
 
192
+ ##
193
+ # The logger used for request/response debug logging.
194
+ #
195
+ # @return [Logger]
196
+ #
197
+ def logger
198
+ @serving_config_service_stub.logger
199
+ end
200
+
180
201
  # Service calls
181
202
 
182
203
  ##
@@ -269,7 +290,6 @@ module Google
269
290
 
270
291
  @serving_config_service_stub.call_rpc :update_serving_config, request, options: options do |response, operation|
271
292
  yield response, operation if block_given?
272
- return response
273
293
  end
274
294
  rescue ::GRPC::BadStatus => e
275
295
  raise ::Google::Cloud::Error.from_error(e)
@@ -358,7 +378,6 @@ module Google
358
378
 
359
379
  @serving_config_service_stub.call_rpc :get_serving_config, request, options: options do |response, operation|
360
380
  yield response, operation if block_given?
361
- return response
362
381
  end
363
382
  rescue ::GRPC::BadStatus => e
364
383
  raise ::Google::Cloud::Error.from_error(e)
@@ -457,7 +476,7 @@ module Google
457
476
  @serving_config_service_stub.call_rpc :list_serving_configs, request, options: options do |response, operation|
458
477
  response = ::Gapic::PagedEnumerable.new @serving_config_service_stub, :list_serving_configs, request, response, operation, options
459
478
  yield response, operation if block_given?
460
- return response
479
+ throw :response, response
461
480
  end
462
481
  rescue ::GRPC::BadStatus => e
463
482
  raise ::Google::Cloud::Error.from_error(e)
@@ -507,6 +526,13 @@ module Google
507
526
  # * (`GRPC::Core::Channel`) a gRPC channel with included credentials
508
527
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
509
528
  # * (`nil`) indicating no credentials
529
+ #
530
+ # Warning: If you accept a credential configuration (JSON file or Hash) from an
531
+ # external source for authentication to Google Cloud, you must validate it before
532
+ # providing it to a Google API client library. Providing an unvalidated credential
533
+ # configuration to Google APIs can compromise the security of your systems and data.
534
+ # For more information, refer to [Validate credential configurations from external
535
+ # sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
510
536
  # @return [::Object]
511
537
  # @!attribute [rw] scope
512
538
  # The OAuth scopes
@@ -546,6 +572,11 @@ module Google
546
572
  # default endpoint URL. The default value of nil uses the environment
547
573
  # universe (usually the default "googleapis.com" universe).
548
574
  # @return [::String,nil]
575
+ # @!attribute [rw] logger
576
+ # A custom logger to use for request/response debug logging, or the value
577
+ # `:default` (the default) to construct a default logger, or `nil` to
578
+ # explicitly disable logging.
579
+ # @return [::Logger,:default,nil]
549
580
  #
550
581
  class Configuration
551
582
  extend ::Gapic::Config
@@ -570,6 +601,7 @@ module Google
570
601
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
571
602
  config_attr :quota_project, nil, ::String, nil
572
603
  config_attr :universe_domain, nil, ::String, nil
604
+ config_attr :logger, :default, ::Logger, nil, :default
573
605
 
574
606
  # @private
575
607
  def initialize parent_config = nil
@@ -152,14 +152,26 @@ module Google
152
152
  endpoint: @config.endpoint,
153
153
  endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
154
154
  universe_domain: @config.universe_domain,
155
- credentials: credentials
155
+ credentials: credentials,
156
+ logger: @config.logger
156
157
  )
157
158
 
159
+ @serving_config_service_stub.logger(stub: true)&.info do |entry|
160
+ entry.set_system_name
161
+ entry.set_service
162
+ entry.message = "Created client for #{entry.service}"
163
+ entry.set_credentials_fields credentials
164
+ entry.set "customEndpoint", @config.endpoint if @config.endpoint
165
+ entry.set "defaultTimeout", @config.timeout if @config.timeout
166
+ entry.set "quotaProject", @quota_project_id if @quota_project_id
167
+ end
168
+
158
169
  @location_client = Google::Cloud::Location::Locations::Rest::Client.new do |config|
159
170
  config.credentials = credentials
160
171
  config.quota_project = @quota_project_id
161
172
  config.endpoint = @serving_config_service_stub.endpoint
162
173
  config.universe_domain = @serving_config_service_stub.universe_domain
174
+ config.logger = @serving_config_service_stub.logger if config.respond_to? :logger=
163
175
  end
164
176
  end
165
177
 
@@ -170,6 +182,15 @@ module Google
170
182
  #
171
183
  attr_reader :location_client
172
184
 
185
+ ##
186
+ # The logger used for request/response debug logging.
187
+ #
188
+ # @return [Logger]
189
+ #
190
+ def logger
191
+ @serving_config_service_stub.logger
192
+ end
193
+
173
194
  # Service calls
174
195
 
175
196
  ##
@@ -255,7 +276,6 @@ module Google
255
276
 
256
277
  @serving_config_service_stub.update_serving_config request, options do |result, operation|
257
278
  yield result, operation if block_given?
258
- return result
259
279
  end
260
280
  rescue ::Gapic::Rest::Error => e
261
281
  raise ::Google::Cloud::Error.from_error(e)
@@ -337,7 +357,6 @@ module Google
337
357
 
338
358
  @serving_config_service_stub.get_serving_config request, options do |result, operation|
339
359
  yield result, operation if block_given?
340
- return result
341
360
  end
342
361
  rescue ::Gapic::Rest::Error => e
343
362
  raise ::Google::Cloud::Error.from_error(e)
@@ -429,7 +448,7 @@ module Google
429
448
  @serving_config_service_stub.list_serving_configs request, options do |result, operation|
430
449
  result = ::Gapic::Rest::PagedEnumerable.new @serving_config_service_stub, :list_serving_configs, "serving_configs", request, result, options
431
450
  yield result, operation if block_given?
432
- return result
451
+ throw :response, result
433
452
  end
434
453
  rescue ::Gapic::Rest::Error => e
435
454
  raise ::Google::Cloud::Error.from_error(e)
@@ -477,6 +496,13 @@ module Google
477
496
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
478
497
  # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
479
498
  # * (`nil`) indicating no credentials
499
+ #
500
+ # Warning: If you accept a credential configuration (JSON file or Hash) from an
501
+ # external source for authentication to Google Cloud, you must validate it before
502
+ # providing it to a Google API client library. Providing an unvalidated credential
503
+ # configuration to Google APIs can compromise the security of your systems and data.
504
+ # For more information, refer to [Validate credential configurations from external
505
+ # sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
480
506
  # @return [::Object]
481
507
  # @!attribute [rw] scope
482
508
  # The OAuth scopes
@@ -509,6 +535,11 @@ module Google
509
535
  # default endpoint URL. The default value of nil uses the environment
510
536
  # universe (usually the default "googleapis.com" universe).
511
537
  # @return [::String,nil]
538
+ # @!attribute [rw] logger
539
+ # A custom logger to use for request/response debug logging, or the value
540
+ # `:default` (the default) to construct a default logger, or `nil` to
541
+ # explicitly disable logging.
542
+ # @return [::Logger,:default,nil]
512
543
  #
513
544
  class Configuration
514
545
  extend ::Gapic::Config
@@ -530,6 +561,7 @@ module Google
530
561
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
531
562
  config_attr :quota_project, nil, ::String, nil
532
563
  config_attr :universe_domain, nil, ::String, nil
564
+ config_attr :logger, :default, ::Logger, nil, :default
533
565
 
534
566
  # @private
535
567
  def initialize parent_config = nil
@@ -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 update_serving_config 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: "update_serving_config",
93
106
  options: options
94
107
  )
95
108
  operation = ::Gapic::Rest::TransportOperation.new response
96
109
  result = ::Google::Cloud::DiscoveryEngine::V1beta::ServingConfig.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: "get_serving_config",
131
146
  options: options
132
147
  )
133
148
  operation = ::Gapic::Rest::TransportOperation.new response
134
149
  result = ::Google::Cloud::DiscoveryEngine::V1beta::ServingConfig.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
  ##
@@ -163,16 +179,18 @@ module Google
163
179
 
164
180
  response = @client_stub.make_http_request(
165
181
  verb,
166
- uri: uri,
167
- body: body || "",
168
- params: query_string_params,
182
+ uri: uri,
183
+ body: body || "",
184
+ params: query_string_params,
185
+ method_name: "list_serving_configs",
169
186
  options: options
170
187
  )
171
188
  operation = ::Gapic::Rest::TransportOperation.new response
172
189
  result = ::Google::Cloud::DiscoveryEngine::V1beta::ListServingConfigsResponse.decode_json response.body, ignore_unknown_fields: true
173
-
174
- yield result, operation if block_given?
175
- result
190
+ catch :response do
191
+ yield result, operation if block_given?
192
+ result
193
+ end
176
194
  end
177
195
 
178
196
  ##
@@ -165,14 +165,26 @@ module Google
165
165
  universe_domain: @config.universe_domain,
166
166
  channel_args: @config.channel_args,
167
167
  interceptors: @config.interceptors,
168
- channel_pool_config: @config.channel_pool
168
+ channel_pool_config: @config.channel_pool,
169
+ logger: @config.logger
169
170
  )
170
171
 
172
+ @site_search_engine_service_stub.stub_logger&.info do |entry|
173
+ entry.set_system_name
174
+ entry.set_service
175
+ entry.message = "Created client for #{entry.service}"
176
+ entry.set_credentials_fields credentials
177
+ entry.set "customEndpoint", @config.endpoint if @config.endpoint
178
+ entry.set "defaultTimeout", @config.timeout if @config.timeout
179
+ entry.set "quotaProject", @quota_project_id if @quota_project_id
180
+ end
181
+
171
182
  @location_client = Google::Cloud::Location::Locations::Client.new do |config|
172
183
  config.credentials = credentials
173
184
  config.quota_project = @quota_project_id
174
185
  config.endpoint = @site_search_engine_service_stub.endpoint
175
186
  config.universe_domain = @site_search_engine_service_stub.universe_domain
187
+ config.logger = @site_search_engine_service_stub.logger if config.respond_to? :logger=
176
188
  end
177
189
  end
178
190
 
@@ -190,6 +202,15 @@ module Google
190
202
  #
191
203
  attr_reader :location_client
192
204
 
205
+ ##
206
+ # The logger used for request/response debug logging.
207
+ #
208
+ # @return [Logger]
209
+ #
210
+ def logger
211
+ @site_search_engine_service_stub.logger
212
+ end
213
+
193
214
  # Service calls
194
215
 
195
216
  ##
@@ -280,7 +301,6 @@ module Google
280
301
 
281
302
  @site_search_engine_service_stub.call_rpc :get_site_search_engine, request, options: options do |response, operation|
282
303
  yield response, operation if block_given?
283
- return response
284
304
  end
285
305
  rescue ::GRPC::BadStatus => e
286
306
  raise ::Google::Cloud::Error.from_error(e)
@@ -379,7 +399,7 @@ module Google
379
399
  @site_search_engine_service_stub.call_rpc :create_target_site, request, options: options do |response, operation|
380
400
  response = ::Gapic::Operation.new response, @operations_client, options: options
381
401
  yield response, operation if block_given?
382
- return response
402
+ throw :response, response
383
403
  end
384
404
  rescue ::GRPC::BadStatus => e
385
405
  raise ::Google::Cloud::Error.from_error(e)
@@ -480,7 +500,7 @@ module Google
480
500
  @site_search_engine_service_stub.call_rpc :batch_create_target_sites, request, options: options do |response, operation|
481
501
  response = ::Gapic::Operation.new response, @operations_client, options: options
482
502
  yield response, operation if block_given?
483
- return response
503
+ throw :response, response
484
504
  end
485
505
  rescue ::GRPC::BadStatus => e
486
506
  raise ::Google::Cloud::Error.from_error(e)
@@ -576,7 +596,6 @@ module Google
576
596
 
577
597
  @site_search_engine_service_stub.call_rpc :get_target_site, request, options: options do |response, operation|
578
598
  yield response, operation if block_given?
579
- return response
580
599
  end
581
600
  rescue ::GRPC::BadStatus => e
582
601
  raise ::Google::Cloud::Error.from_error(e)
@@ -676,7 +695,7 @@ module Google
676
695
  @site_search_engine_service_stub.call_rpc :update_target_site, request, options: options do |response, operation|
677
696
  response = ::Gapic::Operation.new response, @operations_client, options: options
678
697
  yield response, operation if block_given?
679
- return response
698
+ throw :response, response
680
699
  end
681
700
  rescue ::GRPC::BadStatus => e
682
701
  raise ::Google::Cloud::Error.from_error(e)
@@ -780,7 +799,7 @@ module Google
780
799
  @site_search_engine_service_stub.call_rpc :delete_target_site, request, options: options do |response, operation|
781
800
  response = ::Gapic::Operation.new response, @operations_client, options: options
782
801
  yield response, operation if block_given?
783
- return response
802
+ throw :response, response
784
803
  end
785
804
  rescue ::GRPC::BadStatus => e
786
805
  raise ::Google::Cloud::Error.from_error(e)
@@ -890,7 +909,7 @@ module Google
890
909
  @site_search_engine_service_stub.call_rpc :list_target_sites, request, options: options do |response, operation|
891
910
  response = ::Gapic::PagedEnumerable.new @site_search_engine_service_stub, :list_target_sites, request, response, operation, options
892
911
  yield response, operation if block_given?
893
- return response
912
+ throw :response, response
894
913
  end
895
914
  rescue ::GRPC::BadStatus => e
896
915
  raise ::Google::Cloud::Error.from_error(e)
@@ -990,7 +1009,7 @@ module Google
990
1009
  @site_search_engine_service_stub.call_rpc :create_sitemap, request, options: options do |response, operation|
991
1010
  response = ::Gapic::Operation.new response, @operations_client, options: options
992
1011
  yield response, operation if block_given?
993
- return response
1012
+ throw :response, response
994
1013
  end
995
1014
  rescue ::GRPC::BadStatus => e
996
1015
  raise ::Google::Cloud::Error.from_error(e)
@@ -1093,7 +1112,7 @@ module Google
1093
1112
  @site_search_engine_service_stub.call_rpc :delete_sitemap, request, options: options do |response, operation|
1094
1113
  response = ::Gapic::Operation.new response, @operations_client, options: options
1095
1114
  yield response, operation if block_given?
1096
- return response
1115
+ throw :response, response
1097
1116
  end
1098
1117
  rescue ::GRPC::BadStatus => e
1099
1118
  raise ::Google::Cloud::Error.from_error(e)
@@ -1188,7 +1207,6 @@ module Google
1188
1207
 
1189
1208
  @site_search_engine_service_stub.call_rpc :fetch_sitemaps, request, options: options do |response, operation|
1190
1209
  yield response, operation if block_given?
1191
- return response
1192
1210
  end
1193
1211
  rescue ::GRPC::BadStatus => e
1194
1212
  raise ::Google::Cloud::Error.from_error(e)
@@ -1285,7 +1303,7 @@ module Google
1285
1303
  @site_search_engine_service_stub.call_rpc :enable_advanced_site_search, request, options: options do |response, operation|
1286
1304
  response = ::Gapic::Operation.new response, @operations_client, options: options
1287
1305
  yield response, operation if block_given?
1288
- return response
1306
+ throw :response, response
1289
1307
  end
1290
1308
  rescue ::GRPC::BadStatus => e
1291
1309
  raise ::Google::Cloud::Error.from_error(e)
@@ -1382,7 +1400,7 @@ module Google
1382
1400
  @site_search_engine_service_stub.call_rpc :disable_advanced_site_search, request, options: options do |response, operation|
1383
1401
  response = ::Gapic::Operation.new response, @operations_client, options: options
1384
1402
  yield response, operation if block_given?
1385
- return response
1403
+ throw :response, response
1386
1404
  end
1387
1405
  rescue ::GRPC::BadStatus => e
1388
1406
  raise ::Google::Cloud::Error.from_error(e)
@@ -1488,7 +1506,7 @@ module Google
1488
1506
  @site_search_engine_service_stub.call_rpc :recrawl_uris, request, options: options do |response, operation|
1489
1507
  response = ::Gapic::Operation.new response, @operations_client, options: options
1490
1508
  yield response, operation if block_given?
1491
- return response
1509
+ throw :response, response
1492
1510
  end
1493
1511
  rescue ::GRPC::BadStatus => e
1494
1512
  raise ::Google::Cloud::Error.from_error(e)
@@ -1585,7 +1603,7 @@ module Google
1585
1603
  @site_search_engine_service_stub.call_rpc :batch_verify_target_sites, request, options: options do |response, operation|
1586
1604
  response = ::Gapic::Operation.new response, @operations_client, options: options
1587
1605
  yield response, operation if block_given?
1588
- return response
1606
+ throw :response, response
1589
1607
  end
1590
1608
  rescue ::GRPC::BadStatus => e
1591
1609
  raise ::Google::Cloud::Error.from_error(e)
@@ -1693,7 +1711,7 @@ module Google
1693
1711
  @site_search_engine_service_stub.call_rpc :fetch_domain_verification_status, request, options: options do |response, operation|
1694
1712
  response = ::Gapic::PagedEnumerable.new @site_search_engine_service_stub, :fetch_domain_verification_status, request, response, operation, options
1695
1713
  yield response, operation if block_given?
1696
- return response
1714
+ throw :response, response
1697
1715
  end
1698
1716
  rescue ::GRPC::BadStatus => e
1699
1717
  raise ::Google::Cloud::Error.from_error(e)
@@ -1743,6 +1761,13 @@ module Google
1743
1761
  # * (`GRPC::Core::Channel`) a gRPC channel with included credentials
1744
1762
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
1745
1763
  # * (`nil`) indicating no credentials
1764
+ #
1765
+ # Warning: If you accept a credential configuration (JSON file or Hash) from an
1766
+ # external source for authentication to Google Cloud, you must validate it before
1767
+ # providing it to a Google API client library. Providing an unvalidated credential
1768
+ # configuration to Google APIs can compromise the security of your systems and data.
1769
+ # For more information, refer to [Validate credential configurations from external
1770
+ # sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
1746
1771
  # @return [::Object]
1747
1772
  # @!attribute [rw] scope
1748
1773
  # The OAuth scopes
@@ -1782,6 +1807,11 @@ module Google
1782
1807
  # default endpoint URL. The default value of nil uses the environment
1783
1808
  # universe (usually the default "googleapis.com" universe).
1784
1809
  # @return [::String,nil]
1810
+ # @!attribute [rw] logger
1811
+ # A custom logger to use for request/response debug logging, or the value
1812
+ # `:default` (the default) to construct a default logger, or `nil` to
1813
+ # explicitly disable logging.
1814
+ # @return [::Logger,:default,nil]
1785
1815
  #
1786
1816
  class Configuration
1787
1817
  extend ::Gapic::Config
@@ -1806,6 +1836,7 @@ module Google
1806
1836
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
1807
1837
  config_attr :quota_project, nil, ::String, nil
1808
1838
  config_attr :universe_domain, nil, ::String, nil
1839
+ config_attr :logger, :default, ::Logger, nil, :default
1809
1840
 
1810
1841
  # @private
1811
1842
  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)
@@ -649,6 +640,13 @@ module Google
649
640
  # * (`GRPC::Core::Channel`) a gRPC channel with included credentials
650
641
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
651
642
  # * (`nil`) indicating no credentials
643
+ #
644
+ # Warning: If you accept a credential configuration (JSON file or Hash) from an
645
+ # external source for authentication to Google Cloud, you must validate it before
646
+ # providing it to a Google API client library. Providing an unvalidated credential
647
+ # configuration to Google APIs can compromise the security of your systems and data.
648
+ # For more information, refer to [Validate credential configurations from external
649
+ # sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
652
650
  # @return [::Object]
653
651
  # @!attribute [rw] scope
654
652
  # The OAuth scopes
@@ -688,6 +686,11 @@ module Google
688
686
  # default endpoint URL. The default value of nil uses the environment
689
687
  # universe (usually the default "googleapis.com" universe).
690
688
  # @return [::String,nil]
689
+ # @!attribute [rw] logger
690
+ # A custom logger to use for request/response debug logging, or the value
691
+ # `:default` (the default) to construct a default logger, or `nil` to
692
+ # explicitly disable logging.
693
+ # @return [::Logger,:default,nil]
691
694
  #
692
695
  class Configuration
693
696
  extend ::Gapic::Config
@@ -712,6 +715,7 @@ module Google
712
715
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
713
716
  config_attr :quota_project, nil, ::String, nil
714
717
  config_attr :universe_domain, nil, ::String, nil
718
+ config_attr :logger, :default, ::Logger, nil, :default
715
719
 
716
720
  # @private
717
721
  def initialize parent_config = nil