google-cloud-discovery_engine-v1 1.3.0 → 1.5.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 (86) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +31 -21
  3. data/lib/google/cloud/discovery_engine/v1/completion_service/client.rb +49 -6
  4. data/lib/google/cloud/discovery_engine/v1/completion_service/operations.rb +19 -15
  5. data/lib/google/cloud/discovery_engine/v1/completion_service/rest/client.rb +49 -6
  6. data/lib/google/cloud/discovery_engine/v1/completion_service/rest/operations.rb +50 -38
  7. data/lib/google/cloud/discovery_engine/v1/completion_service/rest/service_stub.rb +54 -32
  8. data/lib/google/cloud/discovery_engine/v1/control_service/client.rb +36 -6
  9. data/lib/google/cloud/discovery_engine/v1/control_service/rest/client.rb +36 -6
  10. data/lib/google/cloud/discovery_engine/v1/control_service/rest/service_stub.rb +54 -32
  11. data/lib/google/cloud/discovery_engine/v1/conversational_search_service/client.rb +37 -14
  12. data/lib/google/cloud/discovery_engine/v1/conversational_search_service/rest/client.rb +37 -14
  13. data/lib/google/cloud/discovery_engine/v1/conversational_search_service/rest/service_stub.rb +118 -80
  14. data/lib/google/cloud/discovery_engine/v1/data_store_service/client.rb +38 -6
  15. data/lib/google/cloud/discovery_engine/v1/data_store_service/operations.rb +19 -15
  16. data/lib/google/cloud/discovery_engine/v1/data_store_service/rest/client.rb +38 -6
  17. data/lib/google/cloud/discovery_engine/v1/data_store_service/rest/operations.rb +50 -38
  18. data/lib/google/cloud/discovery_engine/v1/data_store_service/rest/service_stub.rb +54 -32
  19. data/lib/google/cloud/discovery_engine/v1/document_service/client.rb +60 -9
  20. data/lib/google/cloud/discovery_engine/v1/document_service/operations.rb +19 -15
  21. data/lib/google/cloud/discovery_engine/v1/document_service/rest/client.rb +60 -9
  22. data/lib/google/cloud/discovery_engine/v1/document_service/rest/operations.rb +50 -38
  23. data/lib/google/cloud/discovery_engine/v1/document_service/rest/service_stub.rb +78 -50
  24. data/lib/google/cloud/discovery_engine/v1/engine_service/client.rb +38 -6
  25. data/lib/google/cloud/discovery_engine/v1/engine_service/operations.rb +19 -15
  26. data/lib/google/cloud/discovery_engine/v1/engine_service/rest/client.rb +38 -6
  27. data/lib/google/cloud/discovery_engine/v1/engine_service/rest/operations.rb +50 -38
  28. data/lib/google/cloud/discovery_engine/v1/engine_service/rest/service_stub.rb +54 -32
  29. data/lib/google/cloud/discovery_engine/v1/grounded_generation_service/client.rb +35 -4
  30. data/lib/google/cloud/discovery_engine/v1/grounded_generation_service/rest/client.rb +35 -3
  31. data/lib/google/cloud/discovery_engine/v1/grounded_generation_service/rest/service_stub.rb +30 -14
  32. data/lib/google/cloud/discovery_engine/v1/project_service/client.rb +36 -2
  33. data/lib/google/cloud/discovery_engine/v1/project_service/operations.rb +19 -15
  34. data/lib/google/cloud/discovery_engine/v1/project_service/rest/client.rb +36 -2
  35. data/lib/google/cloud/discovery_engine/v1/project_service/rest/operations.rb +50 -38
  36. data/lib/google/cloud/discovery_engine/v1/project_service/rest/service_stub.rb +22 -8
  37. data/lib/google/cloud/discovery_engine/v1/rank_service/client.rb +35 -2
  38. data/lib/google/cloud/discovery_engine/v1/rank_service/rest/client.rb +35 -2
  39. data/lib/google/cloud/discovery_engine/v1/rank_service/rest/service_stub.rb +22 -8
  40. data/lib/google/cloud/discovery_engine/v1/recommendation_service/client.rb +35 -2
  41. data/lib/google/cloud/discovery_engine/v1/recommendation_service/rest/client.rb +35 -2
  42. data/lib/google/cloud/discovery_engine/v1/recommendation_service/rest/service_stub.rb +22 -8
  43. data/lib/google/cloud/discovery_engine/v1/schema_service/client.rb +39 -6
  44. data/lib/google/cloud/discovery_engine/v1/schema_service/operations.rb +19 -15
  45. data/lib/google/cloud/discovery_engine/v1/schema_service/rest/client.rb +39 -6
  46. data/lib/google/cloud/discovery_engine/v1/schema_service/rest/operations.rb +50 -38
  47. data/lib/google/cloud/discovery_engine/v1/schema_service/rest/service_stub.rb +54 -32
  48. data/lib/google/cloud/discovery_engine/v1/search_service/client.rb +37 -3
  49. data/lib/google/cloud/discovery_engine/v1/search_service/rest/client.rb +35 -3
  50. data/lib/google/cloud/discovery_engine/v1/search_service/rest/service_stub.rb +30 -14
  51. data/lib/google/cloud/discovery_engine/v1/search_tuning_service/client.rb +36 -3
  52. data/lib/google/cloud/discovery_engine/v1/search_tuning_service/operations.rb +19 -15
  53. data/lib/google/cloud/discovery_engine/v1/search_tuning_service/rest/client.rb +36 -3
  54. data/lib/google/cloud/discovery_engine/v1/search_tuning_service/rest/operations.rb +50 -38
  55. data/lib/google/cloud/discovery_engine/v1/search_tuning_service/rest/service_stub.rb +30 -14
  56. data/lib/google/cloud/discovery_engine/v1/site_search_engine_service/client.rb +45 -13
  57. data/lib/google/cloud/discovery_engine/v1/site_search_engine_service/operations.rb +19 -15
  58. data/lib/google/cloud/discovery_engine/v1/site_search_engine_service/rest/client.rb +45 -13
  59. data/lib/google/cloud/discovery_engine/v1/site_search_engine_service/rest/operations.rb +50 -38
  60. data/lib/google/cloud/discovery_engine/v1/site_search_engine_service/rest/service_stub.rb +110 -74
  61. data/lib/google/cloud/discovery_engine/v1/user_event_service/client.rb +43 -5
  62. data/lib/google/cloud/discovery_engine/v1/user_event_service/operations.rb +19 -15
  63. data/lib/google/cloud/discovery_engine/v1/user_event_service/rest/client.rb +43 -5
  64. data/lib/google/cloud/discovery_engine/v1/user_event_service/rest/operations.rb +50 -38
  65. data/lib/google/cloud/discovery_engine/v1/user_event_service/rest/service_stub.rb +46 -26
  66. data/lib/google/cloud/discovery_engine/v1/version.rb +1 -1
  67. data/proto_docs/google/api/client.rb +25 -0
  68. data/proto_docs/google/cloud/discoveryengine/v1/answer.rb +6 -0
  69. data/proto_docs/google/cloud/discoveryengine/v1/common.rb +8 -0
  70. data/proto_docs/google/cloud/discoveryengine/v1/completion.rb +4 -0
  71. data/proto_docs/google/cloud/discoveryengine/v1/control.rb +8 -0
  72. data/proto_docs/google/cloud/discoveryengine/v1/conversation.rb +4 -0
  73. data/proto_docs/google/cloud/discoveryengine/v1/conversational_search_service.rb +8 -0
  74. data/proto_docs/google/cloud/discoveryengine/v1/document.rb +8 -0
  75. data/proto_docs/google/cloud/discoveryengine/v1/document_processing_config.rb +6 -0
  76. data/proto_docs/google/cloud/discoveryengine/v1/document_service.rb +8 -0
  77. data/proto_docs/google/cloud/discoveryengine/v1/engine.rb +4 -0
  78. data/proto_docs/google/cloud/discoveryengine/v1/grounded_generation_service.rb +6 -0
  79. data/proto_docs/google/cloud/discoveryengine/v1/import_config.rb +34 -0
  80. data/proto_docs/google/cloud/discoveryengine/v1/purge_config.rb +4 -0
  81. data/proto_docs/google/cloud/discoveryengine/v1/schema.rb +4 -0
  82. data/proto_docs/google/cloud/discoveryengine/v1/search_service.rb +4 -0
  83. data/proto_docs/google/cloud/discoveryengine/v1/user_event.rb +6 -0
  84. data/proto_docs/google/longrunning/operations.rb +23 -14
  85. data/proto_docs/google/protobuf/struct.rb +12 -0
  86. metadata +6 -9
@@ -168,14 +168,26 @@ module Google
168
168
  endpoint: @config.endpoint,
169
169
  endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
170
170
  universe_domain: @config.universe_domain,
171
- credentials: credentials
171
+ credentials: credentials,
172
+ logger: @config.logger
172
173
  )
173
174
 
175
+ @user_event_service_stub.logger(stub: true)&.info do |entry|
176
+ entry.set_system_name
177
+ entry.set_service
178
+ entry.message = "Created client for #{entry.service}"
179
+ entry.set_credentials_fields credentials
180
+ entry.set "customEndpoint", @config.endpoint if @config.endpoint
181
+ entry.set "defaultTimeout", @config.timeout if @config.timeout
182
+ entry.set "quotaProject", @quota_project_id if @quota_project_id
183
+ end
184
+
174
185
  @location_client = Google::Cloud::Location::Locations::Rest::Client.new do |config|
175
186
  config.credentials = credentials
176
187
  config.quota_project = @quota_project_id
177
188
  config.endpoint = @user_event_service_stub.endpoint
178
189
  config.universe_domain = @user_event_service_stub.universe_domain
190
+ config.logger = @user_event_service_stub.logger if config.respond_to? :logger=
179
191
  end
180
192
  end
181
193
 
@@ -193,6 +205,15 @@ module Google
193
205
  #
194
206
  attr_reader :location_client
195
207
 
208
+ ##
209
+ # The logger used for request/response debug logging.
210
+ #
211
+ # @return [Logger]
212
+ #
213
+ def logger
214
+ @user_event_service_stub.logger
215
+ end
216
+
196
217
  # Service calls
197
218
 
198
219
  ##
@@ -282,7 +303,6 @@ module Google
282
303
 
283
304
  @user_event_service_stub.write_user_event request, options do |result, operation|
284
305
  yield result, operation if block_given?
285
- return result
286
306
  end
287
307
  rescue ::Gapic::Rest::Error => e
288
308
  raise ::Google::Cloud::Error.from_error(e)
@@ -378,7 +398,6 @@ module Google
378
398
 
379
399
  @user_event_service_stub.collect_user_event request, options do |result, operation|
380
400
  yield result, operation if block_given?
381
- return result
382
401
  end
383
402
  rescue ::Gapic::Rest::Error => e
384
403
  raise ::Google::Cloud::Error.from_error(e)
@@ -503,7 +522,7 @@ module Google
503
522
  @user_event_service_stub.purge_user_events request, options do |result, operation|
504
523
  result = ::Gapic::Operation.new result, @operations_client, options: options
505
524
  yield result, operation if block_given?
506
- return result
525
+ throw :response, result
507
526
  end
508
527
  rescue ::Gapic::Rest::Error => e
509
528
  raise ::Google::Cloud::Error.from_error(e)
@@ -535,10 +554,16 @@ module Google
535
554
  #
536
555
  # @param inline_source [::Google::Cloud::DiscoveryEngine::V1::ImportUserEventsRequest::InlineSource, ::Hash]
537
556
  # The Inline source for the input content for UserEvents.
557
+ #
558
+ # Note: The following fields are mutually exclusive: `inline_source`, `gcs_source`, `bigquery_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
538
559
  # @param gcs_source [::Google::Cloud::DiscoveryEngine::V1::GcsSource, ::Hash]
539
560
  # Cloud Storage location for the input content.
561
+ #
562
+ # Note: The following fields are mutually exclusive: `gcs_source`, `inline_source`, `bigquery_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
540
563
  # @param bigquery_source [::Google::Cloud::DiscoveryEngine::V1::BigQuerySource, ::Hash]
541
564
  # BigQuery input source.
565
+ #
566
+ # Note: The following fields are mutually exclusive: `bigquery_source`, `inline_source`, `gcs_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
542
567
  # @param parent [::String]
543
568
  # Required. Parent DataStore resource name, of the form
544
569
  # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`
@@ -606,7 +631,7 @@ module Google
606
631
  @user_event_service_stub.import_user_events request, options do |result, operation|
607
632
  result = ::Gapic::Operation.new result, @operations_client, options: options
608
633
  yield result, operation if block_given?
609
- return result
634
+ throw :response, result
610
635
  end
611
636
  rescue ::Gapic::Rest::Error => e
612
637
  raise ::Google::Cloud::Error.from_error(e)
@@ -654,6 +679,13 @@ module Google
654
679
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
655
680
  # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
656
681
  # * (`nil`) indicating no credentials
682
+ #
683
+ # Warning: If you accept a credential configuration (JSON file or Hash) from an
684
+ # external source for authentication to Google Cloud, you must validate it before
685
+ # providing it to a Google API client library. Providing an unvalidated credential
686
+ # configuration to Google APIs can compromise the security of your systems and data.
687
+ # For more information, refer to [Validate credential configurations from external
688
+ # sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
657
689
  # @return [::Object]
658
690
  # @!attribute [rw] scope
659
691
  # The OAuth scopes
@@ -686,6 +718,11 @@ module Google
686
718
  # default endpoint URL. The default value of nil uses the environment
687
719
  # universe (usually the default "googleapis.com" universe).
688
720
  # @return [::String,nil]
721
+ # @!attribute [rw] logger
722
+ # A custom logger to use for request/response debug logging, or the value
723
+ # `:default` (the default) to construct a default logger, or `nil` to
724
+ # explicitly disable logging.
725
+ # @return [::Logger,:default,nil]
689
726
  #
690
727
  class Configuration
691
728
  extend ::Gapic::Config
@@ -707,6 +744,7 @@ module Google
707
744
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
708
745
  config_attr :quota_project, nil, ::String, nil
709
746
  config_attr :universe_domain, nil, ::String, nil
747
+ config_attr :logger, :default, ::Logger, nil, :default
710
748
 
711
749
  # @private
712
750
  def initialize parent_config = nil
@@ -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)
@@ -511,6 +502,13 @@ module Google
511
502
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
512
503
  # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
513
504
  # * (`nil`) indicating no credentials
505
+ #
506
+ # Warning: If you accept a credential configuration (JSON file or Hash) from an
507
+ # external source for authentication to Google Cloud, you must validate it before
508
+ # providing it to a Google API client library. Providing an unvalidated credential
509
+ # configuration to Google APIs can compromise the security of your systems and data.
510
+ # For more information, refer to [Validate credential configurations from external
511
+ # sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
514
512
  # @return [::Object]
515
513
  # @!attribute [rw] scope
516
514
  # The OAuth scopes
@@ -543,6 +541,11 @@ module Google
543
541
  # default endpoint URL. The default value of nil uses the environment
544
542
  # universe (usually the default "googleapis.com" universe).
545
543
  # @return [::String,nil]
544
+ # @!attribute [rw] logger
545
+ # A custom logger to use for request/response debug logging, or the value
546
+ # `:default` (the default) to construct a default logger, or `nil` to
547
+ # explicitly disable logging.
548
+ # @return [::Logger,:default,nil]
546
549
  #
547
550
  class Configuration
548
551
  extend ::Gapic::Config
@@ -564,6 +567,7 @@ module Google
564
567
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
565
568
  config_attr :quota_project, nil, ::String, nil
566
569
  config_attr :universe_domain, nil, ::String, nil
570
+ config_attr :logger, :default, ::Logger, nil, :default
567
571
 
568
572
  # @private
569
573
  def initialize parent_config = nil
@@ -683,16 +687,18 @@ module Google
683
687
 
684
688
  response = @client_stub.make_http_request(
685
689
  verb,
686
- uri: uri,
687
- body: body || "",
688
- params: query_string_params,
690
+ uri: uri,
691
+ body: body || "",
692
+ params: query_string_params,
693
+ method_name: "list_operations",
689
694
  options: options
690
695
  )
691
696
  operation = ::Gapic::Rest::TransportOperation.new response
692
697
  result = ::Google::Longrunning::ListOperationsResponse.decode_json response.body, ignore_unknown_fields: true
693
-
694
- yield result, operation if block_given?
695
- result
698
+ catch :response do
699
+ yield result, operation if block_given?
700
+ result
701
+ end
696
702
  end
697
703
 
698
704
  ##
@@ -721,16 +727,18 @@ module Google
721
727
 
722
728
  response = @client_stub.make_http_request(
723
729
  verb,
724
- uri: uri,
725
- body: body || "",
726
- params: query_string_params,
730
+ uri: uri,
731
+ body: body || "",
732
+ params: query_string_params,
733
+ method_name: "get_operation",
727
734
  options: options
728
735
  )
729
736
  operation = ::Gapic::Rest::TransportOperation.new response
730
737
  result = ::Google::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true
731
-
732
- yield result, operation if block_given?
733
- result
738
+ catch :response do
739
+ yield result, operation if block_given?
740
+ result
741
+ end
734
742
  end
735
743
 
736
744
  ##
@@ -759,16 +767,18 @@ module Google
759
767
 
760
768
  response = @client_stub.make_http_request(
761
769
  verb,
762
- uri: uri,
763
- body: body || "",
764
- params: query_string_params,
770
+ uri: uri,
771
+ body: body || "",
772
+ params: query_string_params,
773
+ method_name: "delete_operation",
765
774
  options: options
766
775
  )
767
776
  operation = ::Gapic::Rest::TransportOperation.new response
768
777
  result = ::Google::Protobuf::Empty.decode_json response.body, ignore_unknown_fields: true
769
-
770
- yield result, operation if block_given?
771
- result
778
+ catch :response do
779
+ yield result, operation if block_given?
780
+ result
781
+ end
772
782
  end
773
783
 
774
784
  ##
@@ -797,16 +807,18 @@ module Google
797
807
 
798
808
  response = @client_stub.make_http_request(
799
809
  verb,
800
- uri: uri,
801
- body: body || "",
802
- params: query_string_params,
810
+ uri: uri,
811
+ body: body || "",
812
+ params: query_string_params,
813
+ method_name: "cancel_operation",
803
814
  options: options
804
815
  )
805
816
  operation = ::Gapic::Rest::TransportOperation.new response
806
817
  result = ::Google::Protobuf::Empty.decode_json response.body, ignore_unknown_fields: true
807
-
808
- yield result, operation if block_given?
809
- result
818
+ catch :response do
819
+ yield result, operation if block_given?
820
+ result
821
+ end
810
822
  end
811
823
 
812
824
  ##
@@ -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 write_user_event 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: "write_user_event",
93
106
  options: options
94
107
  )
95
108
  operation = ::Gapic::Rest::TransportOperation.new response
96
109
  result = ::Google::Cloud::DiscoveryEngine::V1::UserEvent.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: "collect_user_event",
131
146
  options: options
132
147
  )
133
148
  operation = ::Gapic::Rest::TransportOperation.new response
134
149
  result = ::Google::Api::HttpBody.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: "purge_user_events",
169
186
  options: options
170
187
  )
171
188
  operation = ::Gapic::Rest::TransportOperation.new response
172
189
  result = ::Google::Longrunning::Operation.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
  ##
@@ -201,16 +219,18 @@ module Google
201
219
 
202
220
  response = @client_stub.make_http_request(
203
221
  verb,
204
- uri: uri,
205
- body: body || "",
206
- params: query_string_params,
222
+ uri: uri,
223
+ body: body || "",
224
+ params: query_string_params,
225
+ method_name: "import_user_events",
207
226
  options: options
208
227
  )
209
228
  operation = ::Gapic::Rest::TransportOperation.new response
210
229
  result = ::Google::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true
211
-
212
- yield result, operation if block_given?
213
- result
230
+ catch :response do
231
+ yield result, operation if block_given?
232
+ result
233
+ end
214
234
  end
215
235
 
216
236
  ##
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module DiscoveryEngine
23
23
  module V1
24
- VERSION = "1.3.0"
24
+ VERSION = "1.5.0"
25
25
  end
26
26
  end
27
27
  end
@@ -215,6 +215,12 @@ module Google
215
215
  # enabled. By default, asynchronous REST clients will not be generated.
216
216
  # This feature will be enabled by default 1 month after launching the
217
217
  # feature in preview packages.
218
+ # @!attribute [rw] protobuf_pythonic_types_enabled
219
+ # @return [::Boolean]
220
+ # Enables generation of protobuf code using new types that are more
221
+ # Pythonic which are included in `protobuf>=5.29.x`. This feature will be
222
+ # enabled by default 1 month after launching the feature in preview
223
+ # packages.
218
224
  class ExperimentalFeatures
219
225
  include ::Google::Protobuf::MessageExts
220
226
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -300,9 +306,28 @@ module Google
300
306
  # @!attribute [rw] common
301
307
  # @return [::Google::Api::CommonLanguageSettings]
302
308
  # Some settings.
309
+ # @!attribute [rw] renamed_services
310
+ # @return [::Google::Protobuf::Map{::String => ::String}]
311
+ # Map of service names to renamed services. Keys are the package relative
312
+ # service names and values are the name to be used for the service client
313
+ # and call options.
314
+ #
315
+ # publishing:
316
+ # go_settings:
317
+ # renamed_services:
318
+ # Publisher: TopicAdmin
303
319
  class GoSettings
304
320
  include ::Google::Protobuf::MessageExts
305
321
  extend ::Google::Protobuf::MessageExts::ClassMethods
322
+
323
+ # @!attribute [rw] key
324
+ # @return [::String]
325
+ # @!attribute [rw] value
326
+ # @return [::String]
327
+ class RenamedServicesEntry
328
+ include ::Google::Protobuf::MessageExts
329
+ extend ::Google::Protobuf::MessageExts::ClassMethods
330
+ end
306
331
  end
307
332
 
308
333
  # Describes the generator configuration for a method.
@@ -90,12 +90,18 @@ module Google
90
90
  # @!attribute [rw] unstructured_document_info
91
91
  # @return [::Google::Cloud::DiscoveryEngine::V1::Answer::Reference::UnstructuredDocumentInfo]
92
92
  # Unstructured document information.
93
+ #
94
+ # Note: The following fields are mutually exclusive: `unstructured_document_info`, `chunk_info`, `structured_document_info`. If a field in that set is populated, all other fields in the set will automatically be cleared.
93
95
  # @!attribute [rw] chunk_info
94
96
  # @return [::Google::Cloud::DiscoveryEngine::V1::Answer::Reference::ChunkInfo]
95
97
  # Chunk information.
98
+ #
99
+ # Note: The following fields are mutually exclusive: `chunk_info`, `unstructured_document_info`, `structured_document_info`. If a field in that set is populated, all other fields in the set will automatically be cleared.
96
100
  # @!attribute [rw] structured_document_info
97
101
  # @return [::Google::Cloud::DiscoveryEngine::V1::Answer::Reference::StructuredDocumentInfo]
98
102
  # Structured document information.
103
+ #
104
+ # Note: The following fields are mutually exclusive: `structured_document_info`, `unstructured_document_info`, `chunk_info`. If a field in that set is populated, all other fields in the set will automatically be cleared.
99
105
  class Reference
100
106
  include ::Google::Protobuf::MessageExts
101
107
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -25,15 +25,23 @@ module Google
25
25
  # @!attribute [rw] minimum
26
26
  # @return [::Float]
27
27
  # Inclusive lower bound.
28
+ #
29
+ # Note: The following fields are mutually exclusive: `minimum`, `exclusive_minimum`. If a field in that set is populated, all other fields in the set will automatically be cleared.
28
30
  # @!attribute [rw] exclusive_minimum
29
31
  # @return [::Float]
30
32
  # Exclusive lower bound.
33
+ #
34
+ # Note: The following fields are mutually exclusive: `exclusive_minimum`, `minimum`. If a field in that set is populated, all other fields in the set will automatically be cleared.
31
35
  # @!attribute [rw] maximum
32
36
  # @return [::Float]
33
37
  # Inclusive upper bound.
38
+ #
39
+ # Note: The following fields are mutually exclusive: `maximum`, `exclusive_maximum`. If a field in that set is populated, all other fields in the set will automatically be cleared.
34
40
  # @!attribute [rw] exclusive_maximum
35
41
  # @return [::Float]
36
42
  # Exclusive upper bound.
43
+ #
44
+ # Note: The following fields are mutually exclusive: `exclusive_maximum`, `maximum`. If a field in that set is populated, all other fields in the set will automatically be cleared.
37
45
  class Interval
38
46
  include ::Google::Protobuf::MessageExts
39
47
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -53,10 +53,14 @@ module Google
53
53
  # @return [::Float]
54
54
  # Global score of this suggestion. Control how this suggestion would be
55
55
  # scored / ranked.
56
+ #
57
+ # Note: The following fields are mutually exclusive: `global_score`, `frequency`. If a field in that set is populated, all other fields in the set will automatically be cleared.
56
58
  # @!attribute [rw] frequency
57
59
  # @return [::Integer]
58
60
  # Frequency of this suggestion. Will be used to rank suggestions when score
59
61
  # is not available.
62
+ #
63
+ # Note: The following fields are mutually exclusive: `frequency`, `global_score`. If a field in that set is populated, all other fields in the set will automatically be cleared.
60
64
  # @!attribute [rw] suggestion
61
65
  # @return [::String]
62
66
  # Required. The suggestion text.
@@ -88,16 +88,24 @@ module Google
88
88
  # @!attribute [rw] boost_action
89
89
  # @return [::Google::Cloud::DiscoveryEngine::V1::Control::BoostAction]
90
90
  # Defines a boost-type control
91
+ #
92
+ # Note: The following fields are mutually exclusive: `boost_action`, `filter_action`, `redirect_action`, `synonyms_action`. If a field in that set is populated, all other fields in the set will automatically be cleared.
91
93
  # @!attribute [rw] filter_action
92
94
  # @return [::Google::Cloud::DiscoveryEngine::V1::Control::FilterAction]
93
95
  # Defines a filter-type control
94
96
  # Currently not supported by Recommendation
97
+ #
98
+ # Note: The following fields are mutually exclusive: `filter_action`, `boost_action`, `redirect_action`, `synonyms_action`. If a field in that set is populated, all other fields in the set will automatically be cleared.
95
99
  # @!attribute [rw] redirect_action
96
100
  # @return [::Google::Cloud::DiscoveryEngine::V1::Control::RedirectAction]
97
101
  # Defines a redirect-type control.
102
+ #
103
+ # Note: The following fields are mutually exclusive: `redirect_action`, `boost_action`, `filter_action`, `synonyms_action`. If a field in that set is populated, all other fields in the set will automatically be cleared.
98
104
  # @!attribute [rw] synonyms_action
99
105
  # @return [::Google::Cloud::DiscoveryEngine::V1::Control::SynonymsAction]
100
106
  # Treats a group of terms as synonyms of one another.
107
+ #
108
+ # Note: The following fields are mutually exclusive: `synonyms_action`, `boost_action`, `filter_action`, `redirect_action`. If a field in that set is populated, all other fields in the set will automatically be cleared.
101
109
  # @!attribute [rw] name
102
110
  # @return [::String]
103
111
  # Immutable. Fully qualified name
@@ -99,9 +99,13 @@ module Google
99
99
  # @!attribute [rw] user_input
100
100
  # @return [::Google::Cloud::DiscoveryEngine::V1::TextInput]
101
101
  # User text input.
102
+ #
103
+ # Note: The following fields are mutually exclusive: `user_input`, `reply`. If a field in that set is populated, all other fields in the set will automatically be cleared.
102
104
  # @!attribute [rw] reply
103
105
  # @return [::Google::Cloud::DiscoveryEngine::V1::Reply]
104
106
  # Search reply.
107
+ #
108
+ # Note: The following fields are mutually exclusive: `reply`, `user_input`. If a field in that set is populated, all other fields in the set will automatically be cleared.
105
109
  # @!attribute [r] create_time
106
110
  # @return [::Google::Protobuf::Timestamp]
107
111
  # Output only. Message creation timestamp.
@@ -415,9 +415,13 @@ module Google
415
415
  # @!attribute [rw] search_params
416
416
  # @return [::Google::Cloud::DiscoveryEngine::V1::AnswerQueryRequest::SearchSpec::SearchParams]
417
417
  # Search parameters.
418
+ #
419
+ # Note: The following fields are mutually exclusive: `search_params`, `search_result_list`. If a field in that set is populated, all other fields in the set will automatically be cleared.
418
420
  # @!attribute [rw] search_result_list
419
421
  # @return [::Google::Cloud::DiscoveryEngine::V1::AnswerQueryRequest::SearchSpec::SearchResultList]
420
422
  # Search result list.
423
+ #
424
+ # Note: The following fields are mutually exclusive: `search_result_list`, `search_params`. If a field in that set is populated, all other fields in the set will automatically be cleared.
421
425
  class SearchSpec
422
426
  include ::Google::Protobuf::MessageExts
423
427
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -489,9 +493,13 @@ module Google
489
493
  # @!attribute [rw] unstructured_document_info
490
494
  # @return [::Google::Cloud::DiscoveryEngine::V1::AnswerQueryRequest::SearchSpec::SearchResultList::SearchResult::UnstructuredDocumentInfo]
491
495
  # Unstructured document information.
496
+ #
497
+ # Note: The following fields are mutually exclusive: `unstructured_document_info`, `chunk_info`. If a field in that set is populated, all other fields in the set will automatically be cleared.
492
498
  # @!attribute [rw] chunk_info
493
499
  # @return [::Google::Cloud::DiscoveryEngine::V1::AnswerQueryRequest::SearchSpec::SearchResultList::SearchResult::ChunkInfo]
494
500
  # Chunk information.
501
+ #
502
+ # Note: The following fields are mutually exclusive: `chunk_info`, `unstructured_document_info`. If a field in that set is populated, all other fields in the set will automatically be cleared.
495
503
  class SearchResult
496
504
  include ::Google::Protobuf::MessageExts
497
505
  extend ::Google::Protobuf::MessageExts::ClassMethods