google-cloud-discovery_engine-v1beta 0.10.0 → 0.12.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (140) hide show
  1. checksums.yaml +4 -4
  2. data/lib/google/cloud/discovery_engine/v1beta/completion_service/client.rb +9 -3
  3. data/lib/google/cloud/discovery_engine/v1beta/completion_service/operations.rb +13 -5
  4. data/lib/google/cloud/discovery_engine/v1beta/completion_service/rest/client.rb +9 -3
  5. data/lib/google/cloud/discovery_engine/v1beta/completion_service/rest/operations.rb +21 -6
  6. data/lib/google/cloud/discovery_engine/v1beta/control_service/client.rb +875 -0
  7. data/lib/google/cloud/discovery_engine/v1beta/control_service/credentials.rb +47 -0
  8. data/lib/google/cloud/discovery_engine/v1beta/control_service/paths.rb +167 -0
  9. data/lib/google/cloud/discovery_engine/v1beta/control_service/rest/client.rb +814 -0
  10. data/lib/google/cloud/discovery_engine/v1beta/control_service/rest/service_stub.rb +440 -0
  11. data/lib/google/cloud/discovery_engine/v1beta/control_service/rest.rb +55 -0
  12. data/lib/google/cloud/discovery_engine/v1beta/control_service.rb +58 -0
  13. data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/client.rb +764 -6
  14. data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/paths.rb +199 -0
  15. data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/rest/client.rb +715 -6
  16. data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/rest/service_stub.rb +520 -0
  17. data/lib/google/cloud/discovery_engine/v1beta/data_store_service/client.rb +15 -7
  18. data/lib/google/cloud/discovery_engine/v1beta/data_store_service/operations.rb +13 -5
  19. data/lib/google/cloud/discovery_engine/v1beta/data_store_service/rest/client.rb +15 -7
  20. data/lib/google/cloud/discovery_engine/v1beta/data_store_service/rest/operations.rb +21 -6
  21. data/lib/google/cloud/discovery_engine/v1beta/document_service/client.rb +71 -37
  22. data/lib/google/cloud/discovery_engine/v1beta/document_service/operations.rb +13 -5
  23. data/lib/google/cloud/discovery_engine/v1beta/document_service/paths.rb +21 -0
  24. data/lib/google/cloud/discovery_engine/v1beta/document_service/rest/client.rb +71 -37
  25. data/lib/google/cloud/discovery_engine/v1beta/document_service/rest/operations.rb +21 -6
  26. data/lib/google/cloud/discovery_engine/v1beta/engine_service/client.rb +312 -5
  27. data/lib/google/cloud/discovery_engine/v1beta/engine_service/operations.rb +13 -5
  28. data/lib/google/cloud/discovery_engine/v1beta/engine_service/rest/client.rb +291 -5
  29. data/lib/google/cloud/discovery_engine/v1beta/engine_service/rest/operations.rb +21 -6
  30. data/lib/google/cloud/discovery_engine/v1beta/engine_service/rest/service_stub.rb +180 -0
  31. data/lib/google/cloud/discovery_engine/v1beta/grounded_generation_service/client.rb +471 -0
  32. data/lib/google/cloud/discovery_engine/v1beta/grounded_generation_service/credentials.rb +47 -0
  33. data/lib/google/cloud/discovery_engine/v1beta/grounded_generation_service/paths.rb +52 -0
  34. data/lib/google/cloud/discovery_engine/v1beta/grounded_generation_service/rest/client.rb +438 -0
  35. data/lib/google/cloud/discovery_engine/v1beta/grounded_generation_service/rest/service_stub.rb +129 -0
  36. data/lib/google/cloud/discovery_engine/v1beta/grounded_generation_service/rest.rb +52 -0
  37. data/lib/google/cloud/discovery_engine/v1beta/grounded_generation_service.rb +55 -0
  38. data/lib/google/cloud/discovery_engine/v1beta/project_service/client.rb +485 -0
  39. data/lib/google/cloud/discovery_engine/v1beta/project_service/credentials.rb +47 -0
  40. data/lib/google/cloud/discovery_engine/v1beta/project_service/operations.rb +809 -0
  41. data/lib/google/cloud/discovery_engine/v1beta/project_service/paths.rb +47 -0
  42. data/lib/google/cloud/discovery_engine/v1beta/project_service/rest/client.rb +452 -0
  43. data/lib/google/cloud/discovery_engine/v1beta/project_service/rest/operations.rb +1092 -0
  44. data/lib/google/cloud/discovery_engine/v1beta/project_service/rest/service_stub.rb +129 -0
  45. data/lib/google/cloud/discovery_engine/v1beta/project_service/rest.rb +54 -0
  46. data/lib/google/cloud/discovery_engine/v1beta/project_service.rb +57 -0
  47. data/lib/google/cloud/discovery_engine/v1beta/rank_service/client.rb +481 -0
  48. data/lib/google/cloud/discovery_engine/v1beta/rank_service/credentials.rb +47 -0
  49. data/lib/google/cloud/discovery_engine/v1beta/rank_service/paths.rb +52 -0
  50. data/lib/google/cloud/discovery_engine/v1beta/rank_service/rest/client.rb +448 -0
  51. data/lib/google/cloud/discovery_engine/v1beta/rank_service/rest/service_stub.rb +129 -0
  52. data/lib/google/cloud/discovery_engine/v1beta/rank_service/rest.rb +52 -0
  53. data/lib/google/cloud/discovery_engine/v1beta/rank_service.rb +55 -0
  54. data/lib/google/cloud/discovery_engine/v1beta/recommendation_service/client.rb +24 -19
  55. data/lib/google/cloud/discovery_engine/v1beta/recommendation_service/paths.rb +66 -0
  56. data/lib/google/cloud/discovery_engine/v1beta/recommendation_service/rest/client.rb +24 -19
  57. data/lib/google/cloud/discovery_engine/v1beta/rest.rb +4 -0
  58. data/lib/google/cloud/discovery_engine/v1beta/schema_service/client.rb +18 -10
  59. data/lib/google/cloud/discovery_engine/v1beta/schema_service/operations.rb +13 -5
  60. data/lib/google/cloud/discovery_engine/v1beta/schema_service/rest/client.rb +18 -10
  61. data/lib/google/cloud/discovery_engine/v1beta/schema_service/rest/operations.rb +21 -6
  62. data/lib/google/cloud/discovery_engine/v1beta/search_service/client.rb +26 -14
  63. data/lib/google/cloud/discovery_engine/v1beta/search_service/rest/client.rb +26 -14
  64. data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/client.rb +104 -2
  65. data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/operations.rb +13 -5
  66. data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/rest/client.rb +97 -2
  67. data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/rest/operations.rb +21 -6
  68. data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/rest/service_stub.rb +59 -0
  69. data/lib/google/cloud/discovery_engine/v1beta/serving_config_service/client.rb +9 -3
  70. data/lib/google/cloud/discovery_engine/v1beta/serving_config_service/rest/client.rb +9 -3
  71. data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/client.rb +27 -12
  72. data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/operations.rb +13 -5
  73. data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/rest/client.rb +27 -12
  74. data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/rest/operations.rb +21 -6
  75. data/lib/google/cloud/discovery_engine/v1beta/user_event_service/client.rb +23 -6
  76. data/lib/google/cloud/discovery_engine/v1beta/user_event_service/operations.rb +13 -5
  77. data/lib/google/cloud/discovery_engine/v1beta/user_event_service/paths.rb +21 -0
  78. data/lib/google/cloud/discovery_engine/v1beta/user_event_service/rest/client.rb +23 -6
  79. data/lib/google/cloud/discovery_engine/v1beta/user_event_service/rest/operations.rb +21 -6
  80. data/lib/google/cloud/discovery_engine/v1beta/user_event_service/rest/service_stub.rb +8 -0
  81. data/lib/google/cloud/discovery_engine/v1beta/version.rb +1 -1
  82. data/lib/google/cloud/discovery_engine/v1beta.rb +4 -0
  83. data/lib/google/cloud/discoveryengine/v1beta/answer_pb.rb +69 -0
  84. data/lib/google/cloud/discoveryengine/v1beta/common_pb.rb +2 -1
  85. data/lib/google/cloud/discoveryengine/v1beta/control_pb.rb +55 -0
  86. data/lib/google/cloud/discoveryengine/v1beta/control_service_pb.rb +57 -0
  87. data/lib/google/cloud/discoveryengine/v1beta/control_service_services_pb.rb +69 -0
  88. data/lib/google/cloud/discoveryengine/v1beta/conversational_search_service_pb.rb +32 -1
  89. data/lib/google/cloud/discoveryengine/v1beta/conversational_search_service_services_pb.rb +25 -0
  90. data/lib/google/cloud/discoveryengine/v1beta/custom_tuning_model_pb.rb +48 -0
  91. data/lib/google/cloud/discoveryengine/v1beta/document_processing_config_pb.rb +1 -1
  92. data/lib/google/cloud/discoveryengine/v1beta/document_service_pb.rb +3 -1
  93. data/lib/google/cloud/discoveryengine/v1beta/document_service_services_pb.rb +1 -1
  94. data/lib/google/cloud/discoveryengine/v1beta/engine_pb.rb +1 -1
  95. data/lib/google/cloud/discoveryengine/v1beta/engine_service_pb.rb +6 -1
  96. data/lib/google/cloud/discoveryengine/v1beta/engine_service_services_pb.rb +12 -0
  97. data/lib/google/cloud/discoveryengine/v1beta/grounded_generation_service_pb.rb +52 -0
  98. data/lib/google/cloud/discoveryengine/v1beta/grounded_generation_service_services_pb.rb +45 -0
  99. data/lib/google/cloud/discoveryengine/v1beta/grounding_pb.rb +46 -0
  100. data/lib/google/cloud/discoveryengine/v1beta/import_config_pb.rb +13 -1
  101. data/lib/google/cloud/discoveryengine/v1beta/project_pb.rb +49 -0
  102. data/lib/google/cloud/discoveryengine/v1beta/project_service_pb.rb +50 -0
  103. data/lib/google/cloud/discoveryengine/v1beta/project_service_services_pb.rb +51 -0
  104. data/lib/google/cloud/discoveryengine/v1beta/rank_service_pb.rb +49 -0
  105. data/lib/google/cloud/discoveryengine/v1beta/rank_service_services_pb.rb +45 -0
  106. data/lib/google/cloud/discoveryengine/v1beta/search_service_pb.rb +7 -1
  107. data/lib/google/cloud/discoveryengine/v1beta/search_tuning_service_pb.rb +5 -1
  108. data/lib/google/cloud/discoveryengine/v1beta/search_tuning_service_services_pb.rb +2 -0
  109. data/lib/google/cloud/discoveryengine/v1beta/session_pb.rb +50 -0
  110. data/lib/google/cloud/discoveryengine/v1beta/site_search_engine_pb.rb +1 -1
  111. data/lib/google/cloud/discoveryengine/v1beta/user_event_pb.rb +1 -1
  112. data/lib/google/cloud/discoveryengine/v1beta/user_event_service_pb.rb +1 -1
  113. data/lib/google/cloud/discoveryengine/v1beta/user_event_service_services_pb.rb +1 -1
  114. data/proto_docs/google/cloud/discoveryengine/v1beta/answer.rb +362 -0
  115. data/proto_docs/google/cloud/discoveryengine/v1beta/common.rb +25 -1
  116. data/proto_docs/google/cloud/discoveryengine/v1beta/control.rb +209 -0
  117. data/proto_docs/google/cloud/discoveryengine/v1beta/control_service.rb +126 -0
  118. data/proto_docs/google/cloud/discoveryengine/v1beta/conversation.rb +2 -2
  119. data/proto_docs/google/cloud/discoveryengine/v1beta/conversational_search_service.rb +491 -0
  120. data/proto_docs/google/cloud/discoveryengine/v1beta/custom_tuning_model.rb +75 -0
  121. data/proto_docs/google/cloud/discoveryengine/v1beta/data_store_service.rb +2 -2
  122. data/proto_docs/google/cloud/discoveryengine/v1beta/document_processing_config.rb +4 -5
  123. data/proto_docs/google/cloud/discoveryengine/v1beta/document_service.rb +9 -6
  124. data/proto_docs/google/cloud/discoveryengine/v1beta/engine.rb +5 -5
  125. data/proto_docs/google/cloud/discoveryengine/v1beta/engine_service.rb +51 -0
  126. data/proto_docs/google/cloud/discoveryengine/v1beta/grounded_generation_service.rb +144 -0
  127. data/proto_docs/google/cloud/discoveryengine/v1beta/grounding.rb +79 -0
  128. data/proto_docs/google/cloud/discoveryengine/v1beta/import_config.rb +312 -26
  129. data/proto_docs/google/cloud/discoveryengine/v1beta/project.rb +106 -0
  130. data/proto_docs/google/cloud/discoveryengine/v1beta/project_service.rb +57 -0
  131. data/proto_docs/google/cloud/discoveryengine/v1beta/rank_service.rb +127 -0
  132. data/proto_docs/google/cloud/discoveryengine/v1beta/recommendation_service.rb +20 -19
  133. data/proto_docs/google/cloud/discoveryengine/v1beta/schema_service.rb +5 -5
  134. data/proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb +181 -43
  135. data/proto_docs/google/cloud/discoveryengine/v1beta/search_tuning_service.rb +47 -1
  136. data/proto_docs/google/cloud/discoveryengine/v1beta/session.rb +88 -0
  137. data/proto_docs/google/cloud/discoveryengine/v1beta/site_search_engine.rb +3 -0
  138. data/proto_docs/google/cloud/discoveryengine/v1beta/user_event.rb +25 -4
  139. data/proto_docs/google/cloud/discoveryengine/v1beta/user_event_service.rb +13 -1
  140. metadata +56 -2
@@ -34,6 +34,9 @@ module Google
34
34
  # configuration.
35
35
  #
36
36
  class Client
37
+ # @private
38
+ API_VERSION = ""
39
+
37
40
  # @private
38
41
  DEFAULT_ENDPOINT_TEMPLATE = "discoveryengine.$UNIVERSE_DOMAIN$"
39
42
 
@@ -257,12 +260,13 @@ module Google
257
260
  # Customize the options with defaults
258
261
  call_metadata = @config.rpcs.create_engine.metadata.to_h
259
262
 
260
- # Set x-goog-api-client and x-goog-user-project headers
263
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
261
264
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
262
265
  lib_name: @config.lib_name, lib_version: @config.lib_version,
263
266
  gapic_version: ::Google::Cloud::DiscoveryEngine::V1beta::VERSION,
264
267
  transports_version_send: [:rest]
265
268
 
269
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
266
270
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
267
271
 
268
272
  options.apply_defaults timeout: @config.rpcs.create_engine.timeout,
@@ -352,12 +356,13 @@ module Google
352
356
  # Customize the options with defaults
353
357
  call_metadata = @config.rpcs.delete_engine.metadata.to_h
354
358
 
355
- # Set x-goog-api-client and x-goog-user-project headers
359
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
356
360
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
357
361
  lib_name: @config.lib_name, lib_version: @config.lib_version,
358
362
  gapic_version: ::Google::Cloud::DiscoveryEngine::V1beta::VERSION,
359
363
  transports_version_send: [:rest]
360
364
 
365
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
361
366
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
362
367
 
363
368
  options.apply_defaults timeout: @config.rpcs.delete_engine.timeout,
@@ -445,12 +450,13 @@ module Google
445
450
  # Customize the options with defaults
446
451
  call_metadata = @config.rpcs.update_engine.metadata.to_h
447
452
 
448
- # Set x-goog-api-client and x-goog-user-project headers
453
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
449
454
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
450
455
  lib_name: @config.lib_name, lib_version: @config.lib_version,
451
456
  gapic_version: ::Google::Cloud::DiscoveryEngine::V1beta::VERSION,
452
457
  transports_version_send: [:rest]
453
458
 
459
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
454
460
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
455
461
 
456
462
  options.apply_defaults timeout: @config.rpcs.update_engine.timeout,
@@ -525,12 +531,13 @@ module Google
525
531
  # Customize the options with defaults
526
532
  call_metadata = @config.rpcs.get_engine.metadata.to_h
527
533
 
528
- # Set x-goog-api-client and x-goog-user-project headers
534
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
529
535
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
530
536
  lib_name: @config.lib_name, lib_version: @config.lib_version,
531
537
  gapic_version: ::Google::Cloud::DiscoveryEngine::V1beta::VERSION,
532
538
  transports_version_send: [:rest]
533
539
 
540
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
534
541
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
535
542
 
536
543
  options.apply_defaults timeout: @config.rpcs.get_engine.timeout,
@@ -616,12 +623,13 @@ module Google
616
623
  # Customize the options with defaults
617
624
  call_metadata = @config.rpcs.list_engines.metadata.to_h
618
625
 
619
- # Set x-goog-api-client and x-goog-user-project headers
626
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
620
627
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
621
628
  lib_name: @config.lib_name, lib_version: @config.lib_version,
622
629
  gapic_version: ::Google::Cloud::DiscoveryEngine::V1beta::VERSION,
623
630
  transports_version_send: [:rest]
624
631
 
632
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
625
633
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
626
634
 
627
635
  options.apply_defaults timeout: @config.rpcs.list_engines.timeout,
@@ -641,6 +649,263 @@ module Google
641
649
  raise ::Google::Cloud::Error.from_error(e)
642
650
  end
643
651
 
652
+ ##
653
+ # Pauses the training of an existing engine. Only applicable if
654
+ # {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType SolutionType} is
655
+ # {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType::SOLUTION_TYPE_RECOMMENDATION SOLUTION_TYPE_RECOMMENDATION}.
656
+ #
657
+ # @overload pause_engine(request, options = nil)
658
+ # Pass arguments to `pause_engine` via a request object, either of type
659
+ # {::Google::Cloud::DiscoveryEngine::V1beta::PauseEngineRequest} or an equivalent Hash.
660
+ #
661
+ # @param request [::Google::Cloud::DiscoveryEngine::V1beta::PauseEngineRequest, ::Hash]
662
+ # A request object representing the call parameters. Required. To specify no
663
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
664
+ # @param options [::Gapic::CallOptions, ::Hash]
665
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
666
+ #
667
+ # @overload pause_engine(name: nil)
668
+ # Pass arguments to `pause_engine` via keyword arguments. Note that at
669
+ # least one keyword argument is required. To specify no parameters, or to keep all
670
+ # the default parameter values, pass an empty Hash as a request object (see above).
671
+ #
672
+ # @param name [::String]
673
+ # Required. The name of the engine to pause.
674
+ # Format:
675
+ # `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`
676
+ # @yield [result, operation] Access the result along with the TransportOperation object
677
+ # @yieldparam result [::Google::Cloud::DiscoveryEngine::V1beta::Engine]
678
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
679
+ #
680
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine]
681
+ #
682
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
683
+ #
684
+ # @example Basic example
685
+ # require "google/cloud/discovery_engine/v1beta"
686
+ #
687
+ # # Create a client object. The client can be reused for multiple calls.
688
+ # client = Google::Cloud::DiscoveryEngine::V1beta::EngineService::Rest::Client.new
689
+ #
690
+ # # Create a request. To set request fields, pass in keyword arguments.
691
+ # request = Google::Cloud::DiscoveryEngine::V1beta::PauseEngineRequest.new
692
+ #
693
+ # # Call the pause_engine method.
694
+ # result = client.pause_engine request
695
+ #
696
+ # # The returned object is of type Google::Cloud::DiscoveryEngine::V1beta::Engine.
697
+ # p result
698
+ #
699
+ def pause_engine request, options = nil
700
+ raise ::ArgumentError, "request must be provided" if request.nil?
701
+
702
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DiscoveryEngine::V1beta::PauseEngineRequest
703
+
704
+ # Converts hash and nil to an options object
705
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
706
+
707
+ # Customize the options with defaults
708
+ call_metadata = @config.rpcs.pause_engine.metadata.to_h
709
+
710
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
711
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
712
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
713
+ gapic_version: ::Google::Cloud::DiscoveryEngine::V1beta::VERSION,
714
+ transports_version_send: [:rest]
715
+
716
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
717
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
718
+
719
+ options.apply_defaults timeout: @config.rpcs.pause_engine.timeout,
720
+ metadata: call_metadata,
721
+ retry_policy: @config.rpcs.pause_engine.retry_policy
722
+
723
+ options.apply_defaults timeout: @config.timeout,
724
+ metadata: @config.metadata,
725
+ retry_policy: @config.retry_policy
726
+
727
+ @engine_service_stub.pause_engine request, options do |result, operation|
728
+ yield result, operation if block_given?
729
+ return result
730
+ end
731
+ rescue ::Gapic::Rest::Error => e
732
+ raise ::Google::Cloud::Error.from_error(e)
733
+ end
734
+
735
+ ##
736
+ # Resumes the training of an existing engine. Only applicable if
737
+ # {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType SolutionType} is
738
+ # {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType::SOLUTION_TYPE_RECOMMENDATION SOLUTION_TYPE_RECOMMENDATION}.
739
+ #
740
+ # @overload resume_engine(request, options = nil)
741
+ # Pass arguments to `resume_engine` via a request object, either of type
742
+ # {::Google::Cloud::DiscoveryEngine::V1beta::ResumeEngineRequest} or an equivalent Hash.
743
+ #
744
+ # @param request [::Google::Cloud::DiscoveryEngine::V1beta::ResumeEngineRequest, ::Hash]
745
+ # A request object representing the call parameters. Required. To specify no
746
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
747
+ # @param options [::Gapic::CallOptions, ::Hash]
748
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
749
+ #
750
+ # @overload resume_engine(name: nil)
751
+ # Pass arguments to `resume_engine` via keyword arguments. Note that at
752
+ # least one keyword argument is required. To specify no parameters, or to keep all
753
+ # the default parameter values, pass an empty Hash as a request object (see above).
754
+ #
755
+ # @param name [::String]
756
+ # Required. The name of the engine to resume.
757
+ # Format:
758
+ # `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`
759
+ # @yield [result, operation] Access the result along with the TransportOperation object
760
+ # @yieldparam result [::Google::Cloud::DiscoveryEngine::V1beta::Engine]
761
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
762
+ #
763
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine]
764
+ #
765
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
766
+ #
767
+ # @example Basic example
768
+ # require "google/cloud/discovery_engine/v1beta"
769
+ #
770
+ # # Create a client object. The client can be reused for multiple calls.
771
+ # client = Google::Cloud::DiscoveryEngine::V1beta::EngineService::Rest::Client.new
772
+ #
773
+ # # Create a request. To set request fields, pass in keyword arguments.
774
+ # request = Google::Cloud::DiscoveryEngine::V1beta::ResumeEngineRequest.new
775
+ #
776
+ # # Call the resume_engine method.
777
+ # result = client.resume_engine request
778
+ #
779
+ # # The returned object is of type Google::Cloud::DiscoveryEngine::V1beta::Engine.
780
+ # p result
781
+ #
782
+ def resume_engine request, options = nil
783
+ raise ::ArgumentError, "request must be provided" if request.nil?
784
+
785
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DiscoveryEngine::V1beta::ResumeEngineRequest
786
+
787
+ # Converts hash and nil to an options object
788
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
789
+
790
+ # Customize the options with defaults
791
+ call_metadata = @config.rpcs.resume_engine.metadata.to_h
792
+
793
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
794
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
795
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
796
+ gapic_version: ::Google::Cloud::DiscoveryEngine::V1beta::VERSION,
797
+ transports_version_send: [:rest]
798
+
799
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
800
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
801
+
802
+ options.apply_defaults timeout: @config.rpcs.resume_engine.timeout,
803
+ metadata: call_metadata,
804
+ retry_policy: @config.rpcs.resume_engine.retry_policy
805
+
806
+ options.apply_defaults timeout: @config.timeout,
807
+ metadata: @config.metadata,
808
+ retry_policy: @config.retry_policy
809
+
810
+ @engine_service_stub.resume_engine request, options do |result, operation|
811
+ yield result, operation if block_given?
812
+ return result
813
+ end
814
+ rescue ::Gapic::Rest::Error => e
815
+ raise ::Google::Cloud::Error.from_error(e)
816
+ end
817
+
818
+ ##
819
+ # Tunes an existing engine. Only applicable if
820
+ # {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType SolutionType} is
821
+ # {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType::SOLUTION_TYPE_RECOMMENDATION SOLUTION_TYPE_RECOMMENDATION}.
822
+ #
823
+ # @overload tune_engine(request, options = nil)
824
+ # Pass arguments to `tune_engine` via a request object, either of type
825
+ # {::Google::Cloud::DiscoveryEngine::V1beta::TuneEngineRequest} or an equivalent Hash.
826
+ #
827
+ # @param request [::Google::Cloud::DiscoveryEngine::V1beta::TuneEngineRequest, ::Hash]
828
+ # A request object representing the call parameters. Required. To specify no
829
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
830
+ # @param options [::Gapic::CallOptions, ::Hash]
831
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
832
+ #
833
+ # @overload tune_engine(name: nil)
834
+ # Pass arguments to `tune_engine` via keyword arguments. Note that at
835
+ # least one keyword argument is required. To specify no parameters, or to keep all
836
+ # the default parameter values, pass an empty Hash as a request object (see above).
837
+ #
838
+ # @param name [::String]
839
+ # Required. The resource name of the engine to tune.
840
+ # Format:
841
+ # `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`
842
+ # @yield [result, operation] Access the result along with the TransportOperation object
843
+ # @yieldparam result [::Gapic::Operation]
844
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
845
+ #
846
+ # @return [::Gapic::Operation]
847
+ #
848
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
849
+ #
850
+ # @example Basic example
851
+ # require "google/cloud/discovery_engine/v1beta"
852
+ #
853
+ # # Create a client object. The client can be reused for multiple calls.
854
+ # client = Google::Cloud::DiscoveryEngine::V1beta::EngineService::Rest::Client.new
855
+ #
856
+ # # Create a request. To set request fields, pass in keyword arguments.
857
+ # request = Google::Cloud::DiscoveryEngine::V1beta::TuneEngineRequest.new
858
+ #
859
+ # # Call the tune_engine method.
860
+ # result = client.tune_engine request
861
+ #
862
+ # # The returned object is of type Gapic::Operation. You can use it to
863
+ # # check the status of an operation, cancel it, or wait for results.
864
+ # # Here is how to wait for a response.
865
+ # result.wait_until_done! timeout: 60
866
+ # if result.response?
867
+ # p result.response
868
+ # else
869
+ # puts "No response received."
870
+ # end
871
+ #
872
+ def tune_engine request, options = nil
873
+ raise ::ArgumentError, "request must be provided" if request.nil?
874
+
875
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DiscoveryEngine::V1beta::TuneEngineRequest
876
+
877
+ # Converts hash and nil to an options object
878
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
879
+
880
+ # Customize the options with defaults
881
+ call_metadata = @config.rpcs.tune_engine.metadata.to_h
882
+
883
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
884
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
885
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
886
+ gapic_version: ::Google::Cloud::DiscoveryEngine::V1beta::VERSION,
887
+ transports_version_send: [:rest]
888
+
889
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
890
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
891
+
892
+ options.apply_defaults timeout: @config.rpcs.tune_engine.timeout,
893
+ metadata: call_metadata,
894
+ retry_policy: @config.rpcs.tune_engine.retry_policy
895
+
896
+ options.apply_defaults timeout: @config.timeout,
897
+ metadata: @config.metadata,
898
+ retry_policy: @config.retry_policy
899
+
900
+ @engine_service_stub.tune_engine request, options do |result, operation|
901
+ result = ::Gapic::Operation.new result, @operations_client, options: options
902
+ yield result, operation if block_given?
903
+ return result
904
+ end
905
+ rescue ::Gapic::Rest::Error => e
906
+ raise ::Google::Cloud::Error.from_error(e)
907
+ end
908
+
644
909
  ##
645
910
  # Configuration class for the EngineService REST API.
646
911
  #
@@ -799,6 +1064,21 @@ module Google
799
1064
  # @return [::Gapic::Config::Method]
800
1065
  #
801
1066
  attr_reader :list_engines
1067
+ ##
1068
+ # RPC-specific configuration for `pause_engine`
1069
+ # @return [::Gapic::Config::Method]
1070
+ #
1071
+ attr_reader :pause_engine
1072
+ ##
1073
+ # RPC-specific configuration for `resume_engine`
1074
+ # @return [::Gapic::Config::Method]
1075
+ #
1076
+ attr_reader :resume_engine
1077
+ ##
1078
+ # RPC-specific configuration for `tune_engine`
1079
+ # @return [::Gapic::Config::Method]
1080
+ #
1081
+ attr_reader :tune_engine
802
1082
 
803
1083
  # @private
804
1084
  def initialize parent_rpcs = nil
@@ -812,6 +1092,12 @@ module Google
812
1092
  @get_engine = ::Gapic::Config::Method.new get_engine_config
813
1093
  list_engines_config = parent_rpcs.list_engines if parent_rpcs.respond_to? :list_engines
814
1094
  @list_engines = ::Gapic::Config::Method.new list_engines_config
1095
+ pause_engine_config = parent_rpcs.pause_engine if parent_rpcs.respond_to? :pause_engine
1096
+ @pause_engine = ::Gapic::Config::Method.new pause_engine_config
1097
+ resume_engine_config = parent_rpcs.resume_engine if parent_rpcs.respond_to? :resume_engine
1098
+ @resume_engine = ::Gapic::Config::Method.new resume_engine_config
1099
+ tune_engine_config = parent_rpcs.tune_engine if parent_rpcs.respond_to? :tune_engine
1100
+ @tune_engine = ::Gapic::Config::Method.new tune_engine_config
815
1101
 
816
1102
  yield self if block_given?
817
1103
  end
@@ -26,6 +26,9 @@ module Google
26
26
  module Rest
27
27
  # Service that implements Longrunning Operations API.
28
28
  class Operations
29
+ # @private
30
+ API_VERSION = ""
31
+
29
32
  # @private
30
33
  DEFAULT_ENDPOINT_TEMPLATE = "discoveryengine.$UNIVERSE_DOMAIN$"
31
34
 
@@ -181,12 +184,13 @@ module Google
181
184
  # Customize the options with defaults
182
185
  call_metadata = @config.rpcs.list_operations.metadata.to_h
183
186
 
184
- # Set x-goog-api-client and x-goog-user-project headers
187
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
185
188
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
186
189
  lib_name: @config.lib_name, lib_version: @config.lib_version,
187
190
  gapic_version: ::Google::Cloud::DiscoveryEngine::V1beta::VERSION,
188
191
  transports_version_send: [:rest]
189
192
 
193
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
190
194
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
191
195
 
192
196
  options.apply_defaults timeout: @config.rpcs.list_operations.timeout,
@@ -269,12 +273,13 @@ module Google
269
273
  # Customize the options with defaults
270
274
  call_metadata = @config.rpcs.get_operation.metadata.to_h
271
275
 
272
- # Set x-goog-api-client and x-goog-user-project headers
276
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
273
277
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
274
278
  lib_name: @config.lib_name, lib_version: @config.lib_version,
275
279
  gapic_version: ::Google::Cloud::DiscoveryEngine::V1beta::VERSION,
276
280
  transports_version_send: [:rest]
277
281
 
282
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
278
283
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
279
284
 
280
285
  options.apply_defaults timeout: @config.rpcs.get_operation.timeout,
@@ -351,12 +356,13 @@ module Google
351
356
  # Customize the options with defaults
352
357
  call_metadata = @config.rpcs.delete_operation.metadata.to_h
353
358
 
354
- # Set x-goog-api-client and x-goog-user-project headers
359
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
355
360
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
356
361
  lib_name: @config.lib_name, lib_version: @config.lib_version,
357
362
  gapic_version: ::Google::Cloud::DiscoveryEngine::V1beta::VERSION,
358
363
  transports_version_send: [:rest]
359
364
 
365
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
360
366
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
361
367
 
362
368
  options.apply_defaults timeout: @config.rpcs.delete_operation.timeout,
@@ -438,12 +444,13 @@ module Google
438
444
  # Customize the options with defaults
439
445
  call_metadata = @config.rpcs.cancel_operation.metadata.to_h
440
446
 
441
- # Set x-goog-api-client and x-goog-user-project headers
447
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
442
448
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
443
449
  lib_name: @config.lib_name, lib_version: @config.lib_version,
444
450
  gapic_version: ::Google::Cloud::DiscoveryEngine::V1beta::VERSION,
445
451
  transports_version_send: [:rest]
446
452
 
453
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
447
454
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
448
455
 
449
456
  options.apply_defaults timeout: @config.rpcs.cancel_operation.timeout,
@@ -1060,10 +1067,18 @@ module Google
1060
1067
  transcoder = Gapic::Rest::GrpcTranscoder.new
1061
1068
  .with_bindings(
1062
1069
  uri_method: :post,
1063
- uri_template: "/v1/{name}:cancel",
1070
+ uri_template: "/v1beta/{name}:cancel",
1064
1071
  body: "*",
1065
1072
  matches: [
1066
- ["name", %r{^operations(?:/.*)?$}, true]
1073
+ ["name", %r{^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+/operations/[^/]+/?$}, false]
1074
+ ]
1075
+ )
1076
+ .with_bindings(
1077
+ uri_method: :post,
1078
+ uri_template: "/v1beta/{name}:cancel",
1079
+ body: "*",
1080
+ matches: [
1081
+ ["name", %r{^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+/operations/[^/]+/?$}, false]
1067
1082
  ]
1068
1083
  )
1069
1084
  transcoder.transcode request_pb
@@ -251,6 +251,120 @@ module Google
251
251
  result
252
252
  end
253
253
 
254
+ ##
255
+ # Baseline implementation for the pause_engine REST call
256
+ #
257
+ # @param request_pb [::Google::Cloud::DiscoveryEngine::V1beta::PauseEngineRequest]
258
+ # A request object representing the call parameters. Required.
259
+ # @param options [::Gapic::CallOptions]
260
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
261
+ #
262
+ # @yield [result, operation] Access the result along with the TransportOperation object
263
+ # @yieldparam result [::Google::Cloud::DiscoveryEngine::V1beta::Engine]
264
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
265
+ #
266
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine]
267
+ # A result object deserialized from the server's reply
268
+ def pause_engine request_pb, options = nil
269
+ raise ::ArgumentError, "request must be provided" if request_pb.nil?
270
+
271
+ verb, uri, query_string_params, body = ServiceStub.transcode_pause_engine_request request_pb
272
+ query_string_params = if query_string_params.any?
273
+ query_string_params.to_h { |p| p.split "=", 2 }
274
+ else
275
+ {}
276
+ end
277
+
278
+ response = @client_stub.make_http_request(
279
+ verb,
280
+ uri: uri,
281
+ body: body || "",
282
+ params: query_string_params,
283
+ options: options
284
+ )
285
+ operation = ::Gapic::Rest::TransportOperation.new response
286
+ result = ::Google::Cloud::DiscoveryEngine::V1beta::Engine.decode_json response.body, ignore_unknown_fields: true
287
+
288
+ yield result, operation if block_given?
289
+ result
290
+ end
291
+
292
+ ##
293
+ # Baseline implementation for the resume_engine REST call
294
+ #
295
+ # @param request_pb [::Google::Cloud::DiscoveryEngine::V1beta::ResumeEngineRequest]
296
+ # A request object representing the call parameters. Required.
297
+ # @param options [::Gapic::CallOptions]
298
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
299
+ #
300
+ # @yield [result, operation] Access the result along with the TransportOperation object
301
+ # @yieldparam result [::Google::Cloud::DiscoveryEngine::V1beta::Engine]
302
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
303
+ #
304
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine]
305
+ # A result object deserialized from the server's reply
306
+ def resume_engine request_pb, options = nil
307
+ raise ::ArgumentError, "request must be provided" if request_pb.nil?
308
+
309
+ verb, uri, query_string_params, body = ServiceStub.transcode_resume_engine_request request_pb
310
+ query_string_params = if query_string_params.any?
311
+ query_string_params.to_h { |p| p.split "=", 2 }
312
+ else
313
+ {}
314
+ end
315
+
316
+ response = @client_stub.make_http_request(
317
+ verb,
318
+ uri: uri,
319
+ body: body || "",
320
+ params: query_string_params,
321
+ options: options
322
+ )
323
+ operation = ::Gapic::Rest::TransportOperation.new response
324
+ result = ::Google::Cloud::DiscoveryEngine::V1beta::Engine.decode_json response.body, ignore_unknown_fields: true
325
+
326
+ yield result, operation if block_given?
327
+ result
328
+ end
329
+
330
+ ##
331
+ # Baseline implementation for the tune_engine REST call
332
+ #
333
+ # @param request_pb [::Google::Cloud::DiscoveryEngine::V1beta::TuneEngineRequest]
334
+ # A request object representing the call parameters. Required.
335
+ # @param options [::Gapic::CallOptions]
336
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
337
+ #
338
+ # @yield [result, operation] Access the result along with the TransportOperation object
339
+ # @yieldparam result [::Google::Longrunning::Operation]
340
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
341
+ #
342
+ # @return [::Google::Longrunning::Operation]
343
+ # A result object deserialized from the server's reply
344
+ def tune_engine request_pb, options = nil
345
+ raise ::ArgumentError, "request must be provided" if request_pb.nil?
346
+
347
+ verb, uri, query_string_params, body = ServiceStub.transcode_tune_engine_request request_pb
348
+ query_string_params = if query_string_params.any?
349
+ query_string_params.to_h { |p| p.split "=", 2 }
350
+ else
351
+ {}
352
+ end
353
+
354
+ response = @client_stub.make_http_request(
355
+ verb,
356
+ uri: uri,
357
+ body: body || "",
358
+ params: query_string_params,
359
+ options: options
360
+ )
361
+ operation = ::Gapic::Rest::TransportOperation.new response
362
+ result = ::Google::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true
363
+
364
+ yield result, operation if block_given?
365
+ result
366
+ end
367
+
254
368
  ##
255
369
  # @private
256
370
  #
@@ -357,6 +471,72 @@ module Google
357
471
  )
358
472
  transcoder.transcode request_pb
359
473
  end
474
+
475
+ ##
476
+ # @private
477
+ #
478
+ # GRPC transcoding helper method for the pause_engine REST call
479
+ #
480
+ # @param request_pb [::Google::Cloud::DiscoveryEngine::V1beta::PauseEngineRequest]
481
+ # A request object representing the call parameters. Required.
482
+ # @return [Array(String, [String, nil], Hash{String => String})]
483
+ # Uri, Body, Query string parameters
484
+ def self.transcode_pause_engine_request request_pb
485
+ transcoder = Gapic::Rest::GrpcTranscoder.new
486
+ .with_bindings(
487
+ uri_method: :post,
488
+ uri_template: "/v1beta/{name}:pause",
489
+ body: "*",
490
+ matches: [
491
+ ["name", %r{^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/?$}, false]
492
+ ]
493
+ )
494
+ transcoder.transcode request_pb
495
+ end
496
+
497
+ ##
498
+ # @private
499
+ #
500
+ # GRPC transcoding helper method for the resume_engine REST call
501
+ #
502
+ # @param request_pb [::Google::Cloud::DiscoveryEngine::V1beta::ResumeEngineRequest]
503
+ # A request object representing the call parameters. Required.
504
+ # @return [Array(String, [String, nil], Hash{String => String})]
505
+ # Uri, Body, Query string parameters
506
+ def self.transcode_resume_engine_request request_pb
507
+ transcoder = Gapic::Rest::GrpcTranscoder.new
508
+ .with_bindings(
509
+ uri_method: :post,
510
+ uri_template: "/v1beta/{name}:resume",
511
+ body: "*",
512
+ matches: [
513
+ ["name", %r{^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/?$}, false]
514
+ ]
515
+ )
516
+ transcoder.transcode request_pb
517
+ end
518
+
519
+ ##
520
+ # @private
521
+ #
522
+ # GRPC transcoding helper method for the tune_engine REST call
523
+ #
524
+ # @param request_pb [::Google::Cloud::DiscoveryEngine::V1beta::TuneEngineRequest]
525
+ # A request object representing the call parameters. Required.
526
+ # @return [Array(String, [String, nil], Hash{String => String})]
527
+ # Uri, Body, Query string parameters
528
+ def self.transcode_tune_engine_request request_pb
529
+ transcoder = Gapic::Rest::GrpcTranscoder.new
530
+ .with_bindings(
531
+ uri_method: :post,
532
+ uri_template: "/v1beta/{name}:tune",
533
+ body: "*",
534
+ matches: [
535
+ ["name", %r{^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/?$}, false]
536
+ ]
537
+ )
538
+ transcoder.transcode request_pb
539
+ end
360
540
  end
361
541
  end
362
542
  end