google-cloud-discovery_engine-v1 2.13.0 → 2.14.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 (250) hide show
  1. checksums.yaml +4 -4
  2. data/AUTHENTICATION.md +4 -4
  3. data/README.md +8 -10
  4. data/lib/google/cloud/discovery_engine/v1/acl_config_service/client.rb +591 -0
  5. data/lib/google/cloud/discovery_engine/v1/acl_config_service/credentials.rb +49 -0
  6. data/lib/google/cloud/discovery_engine/v1/acl_config_service/paths.rb +50 -0
  7. data/lib/google/cloud/discovery_engine/v1/acl_config_service/rest/client.rb +534 -0
  8. data/lib/google/cloud/discovery_engine/v1/acl_config_service/rest/service_stub.rb +204 -0
  9. data/lib/google/cloud/discovery_engine/v1/acl_config_service/rest.rb +52 -0
  10. data/lib/google/cloud/discovery_engine/v1/acl_config_service.rb +55 -0
  11. data/lib/google/cloud/discovery_engine/v1/assistant_service/client.rb +528 -0
  12. data/lib/google/cloud/discovery_engine/v1/assistant_service/credentials.rb +4 -1
  13. data/lib/google/cloud/discovery_engine/v1/assistant_service/paths.rb +104 -0
  14. data/lib/google/cloud/discovery_engine/v1/assistant_service/rest/client.rb +493 -0
  15. data/lib/google/cloud/discovery_engine/v1/assistant_service/rest/service_stub.rb +307 -0
  16. data/lib/google/cloud/discovery_engine/v1/cmek_config_service/credentials.rb +3 -1
  17. data/lib/google/cloud/discovery_engine/v1/cmek_config_service/rest/operations.rb +7 -0
  18. data/lib/google/cloud/discovery_engine/v1/collection_service/client.rb +732 -0
  19. data/lib/google/cloud/discovery_engine/v1/collection_service/credentials.rb +49 -0
  20. data/lib/google/cloud/discovery_engine/v1/collection_service/operations.rb +843 -0
  21. data/lib/google/cloud/discovery_engine/v1/collection_service/paths.rb +52 -0
  22. data/lib/google/cloud/discovery_engine/v1/collection_service/rest/client.rb +668 -0
  23. data/lib/google/cloud/discovery_engine/v1/collection_service/rest/operations.rb +1168 -0
  24. data/lib/google/cloud/discovery_engine/v1/collection_service/rest/service_stub.rb +265 -0
  25. data/lib/google/cloud/discovery_engine/v1/collection_service/rest.rb +54 -0
  26. data/lib/google/cloud/discovery_engine/v1/collection_service.rb +57 -0
  27. data/lib/google/cloud/discovery_engine/v1/completion_service/client.rb +162 -4
  28. data/lib/google/cloud/discovery_engine/v1/completion_service/credentials.rb +5 -1
  29. data/lib/google/cloud/discovery_engine/v1/completion_service/paths.rb +62 -0
  30. data/lib/google/cloud/discovery_engine/v1/completion_service/rest/client.rb +155 -4
  31. data/lib/google/cloud/discovery_engine/v1/completion_service/rest/operations.rb +7 -0
  32. data/lib/google/cloud/discovery_engine/v1/completion_service/rest/service_stub.rb +78 -0
  33. data/lib/google/cloud/discovery_engine/v1/control_service/credentials.rb +3 -1
  34. data/lib/google/cloud/discovery_engine/v1/conversational_search_service/client.rb +37 -9
  35. data/lib/google/cloud/discovery_engine/v1/conversational_search_service/credentials.rb +3 -1
  36. data/lib/google/cloud/discovery_engine/v1/conversational_search_service/paths.rb +21 -0
  37. data/lib/google/cloud/discovery_engine/v1/conversational_search_service/rest/client.rb +37 -9
  38. data/lib/google/cloud/discovery_engine/v1/data_connector_service/client.rb +779 -0
  39. data/lib/google/cloud/discovery_engine/v1/data_connector_service/credentials.rb +50 -0
  40. data/lib/google/cloud/discovery_engine/v1/data_connector_service/operations.rb +843 -0
  41. data/lib/google/cloud/discovery_engine/v1/data_connector_service/paths.rb +227 -0
  42. data/lib/google/cloud/discovery_engine/v1/data_connector_service/rest/client.rb +715 -0
  43. data/lib/google/cloud/discovery_engine/v1/data_connector_service/rest/operations.rb +1168 -0
  44. data/lib/google/cloud/discovery_engine/v1/data_connector_service/rest/service_stub.rb +274 -0
  45. data/lib/google/cloud/discovery_engine/v1/data_connector_service/rest.rb +53 -0
  46. data/lib/google/cloud/discovery_engine/v1/data_connector_service.rb +56 -0
  47. data/lib/google/cloud/discovery_engine/v1/data_store_service/client.rb +215 -0
  48. data/lib/google/cloud/discovery_engine/v1/data_store_service/credentials.rb +3 -1
  49. data/lib/google/cloud/discovery_engine/v1/data_store_service/paths.rb +62 -0
  50. data/lib/google/cloud/discovery_engine/v1/data_store_service/rest/client.rb +201 -0
  51. data/lib/google/cloud/discovery_engine/v1/data_store_service/rest/operations.rb +7 -0
  52. data/lib/google/cloud/discovery_engine/v1/data_store_service/rest/service_stub.rb +138 -0
  53. data/lib/google/cloud/discovery_engine/v1/document_service/client.rb +0 -1
  54. data/lib/google/cloud/discovery_engine/v1/document_service/credentials.rb +3 -1
  55. data/lib/google/cloud/discovery_engine/v1/document_service/rest/client.rb +0 -1
  56. data/lib/google/cloud/discovery_engine/v1/document_service/rest/operations.rb +7 -0
  57. data/lib/google/cloud/discovery_engine/v1/engine_service/client.rb +218 -3
  58. data/lib/google/cloud/discovery_engine/v1/engine_service/credentials.rb +3 -1
  59. data/lib/google/cloud/discovery_engine/v1/engine_service/paths.rb +104 -0
  60. data/lib/google/cloud/discovery_engine/v1/engine_service/rest/client.rb +204 -3
  61. data/lib/google/cloud/discovery_engine/v1/engine_service/rest/operations.rb +7 -0
  62. data/lib/google/cloud/discovery_engine/v1/engine_service/rest/service_stub.rb +123 -0
  63. data/lib/google/cloud/discovery_engine/v1/grounded_generation_service/credentials.rb +3 -1
  64. data/lib/google/cloud/discovery_engine/v1/identity_mapping_store_service/client.rb +1 -0
  65. data/lib/google/cloud/discovery_engine/v1/identity_mapping_store_service/credentials.rb +3 -1
  66. data/lib/google/cloud/discovery_engine/v1/identity_mapping_store_service/rest/client.rb +1 -0
  67. data/lib/google/cloud/discovery_engine/v1/identity_mapping_store_service/rest/operations.rb +7 -0
  68. data/lib/google/cloud/discovery_engine/v1/license_config_service/client.rb +1044 -0
  69. data/lib/google/cloud/discovery_engine/v1/license_config_service/credentials.rb +49 -0
  70. data/lib/google/cloud/discovery_engine/v1/license_config_service/paths.rb +86 -0
  71. data/lib/google/cloud/discovery_engine/v1/license_config_service/rest/client.rb +959 -0
  72. data/lib/google/cloud/discovery_engine/v1/license_config_service/rest/service_stub.rb +451 -0
  73. data/lib/google/cloud/discovery_engine/v1/license_config_service/rest.rb +52 -0
  74. data/lib/google/cloud/discovery_engine/v1/license_config_service.rb +55 -0
  75. data/lib/google/cloud/discovery_engine/v1/project_service/client.rb +3 -1
  76. data/lib/google/cloud/discovery_engine/v1/project_service/credentials.rb +3 -1
  77. data/lib/google/cloud/discovery_engine/v1/project_service/rest/client.rb +3 -1
  78. data/lib/google/cloud/discovery_engine/v1/project_service/rest/operations.rb +7 -0
  79. data/lib/google/cloud/discovery_engine/v1/project_service/rest/service_stub.rb +8 -0
  80. data/lib/google/cloud/discovery_engine/v1/rank_service/client.rb +1 -1
  81. data/lib/google/cloud/discovery_engine/v1/rank_service/credentials.rb +3 -1
  82. data/lib/google/cloud/discovery_engine/v1/rank_service/rest/client.rb +1 -1
  83. data/lib/google/cloud/discovery_engine/v1/recommendation_service/credentials.rb +3 -1
  84. data/lib/google/cloud/discovery_engine/v1/rest.rb +8 -2
  85. data/lib/google/cloud/discovery_engine/v1/schema_service/credentials.rb +3 -1
  86. data/lib/google/cloud/discovery_engine/v1/schema_service/rest/operations.rb +7 -0
  87. data/lib/google/cloud/discovery_engine/v1/search_service/client.rb +14 -2
  88. data/lib/google/cloud/discovery_engine/v1/search_service/paths.rb +21 -0
  89. data/lib/google/cloud/discovery_engine/v1/search_service/rest/client.rb +14 -2
  90. data/lib/google/cloud/discovery_engine/v1/search_tuning_service/credentials.rb +3 -1
  91. data/lib/google/cloud/discovery_engine/v1/search_tuning_service/rest/operations.rb +7 -0
  92. data/lib/google/cloud/discovery_engine/v1/serving_config_service/client.rb +408 -3
  93. data/lib/google/cloud/discovery_engine/v1/serving_config_service/credentials.rb +3 -1
  94. data/lib/google/cloud/discovery_engine/v1/serving_config_service/paths.rb +66 -0
  95. data/lib/google/cloud/discovery_engine/v1/serving_config_service/rest/client.rb +380 -3
  96. data/lib/google/cloud/discovery_engine/v1/serving_config_service/rest/service_stub.rb +303 -0
  97. data/lib/google/cloud/discovery_engine/v1/session_service/client.rb +25 -9
  98. data/lib/google/cloud/discovery_engine/v1/session_service/credentials.rb +4 -1
  99. data/lib/google/cloud/discovery_engine/v1/session_service/paths.rb +21 -0
  100. data/lib/google/cloud/discovery_engine/v1/session_service/rest/client.rb +25 -9
  101. data/lib/google/cloud/discovery_engine/v1/site_search_engine_service/credentials.rb +3 -1
  102. data/lib/google/cloud/discovery_engine/v1/site_search_engine_service/rest/operations.rb +7 -0
  103. data/lib/google/cloud/discovery_engine/v1/user_event_service/credentials.rb +4 -1
  104. data/lib/google/cloud/discovery_engine/v1/user_event_service/rest/operations.rb +7 -0
  105. data/lib/google/cloud/discovery_engine/v1/user_license_service/client.rb +124 -7
  106. data/lib/google/cloud/discovery_engine/v1/user_license_service/credentials.rb +3 -1
  107. data/lib/google/cloud/discovery_engine/v1/user_license_service/rest/client.rb +117 -7
  108. data/lib/google/cloud/discovery_engine/v1/user_license_service/rest/operations.rb +7 -0
  109. data/lib/google/cloud/discovery_engine/v1/user_license_service/rest/service_stub.rb +61 -0
  110. data/lib/google/cloud/discovery_engine/v1/user_store_service/client.rb +590 -0
  111. data/lib/google/cloud/discovery_engine/v1/user_store_service/credentials.rb +49 -0
  112. data/lib/google/cloud/discovery_engine/v1/user_store_service/paths.rb +71 -0
  113. data/lib/google/cloud/discovery_engine/v1/user_store_service/rest/client.rb +533 -0
  114. data/lib/google/cloud/discovery_engine/v1/user_store_service/rest/service_stub.rb +204 -0
  115. data/lib/google/cloud/discovery_engine/v1/user_store_service/rest.rb +52 -0
  116. data/lib/google/cloud/discovery_engine/v1/user_store_service.rb +55 -0
  117. data/lib/google/cloud/discovery_engine/v1/version.rb +1 -1
  118. data/lib/google/cloud/discovery_engine/v1/widget_config_service/client.rb +624 -0
  119. data/lib/google/cloud/discovery_engine/v1/widget_config_service/credentials.rb +50 -0
  120. data/lib/google/cloud/discovery_engine/v1/widget_config_service/paths.rb +101 -0
  121. data/lib/google/cloud/discovery_engine/v1/widget_config_service/rest/client.rb +567 -0
  122. data/lib/google/cloud/discovery_engine/v1/widget_config_service/rest/service_stub.rb +234 -0
  123. data/lib/google/cloud/discovery_engine/v1/widget_config_service/rest.rb +53 -0
  124. data/lib/google/cloud/discovery_engine/v1/widget_config_service.rb +56 -0
  125. data/lib/google/cloud/discovery_engine/v1.rb +9 -3
  126. data/lib/google/cloud/discoveryengine/v1/acl_config_pb.rb +25 -0
  127. data/lib/google/cloud/discoveryengine/v1/acl_config_service_pb.rb +28 -0
  128. data/lib/google/cloud/discoveryengine/v1/acl_config_service_services_pb.rb +49 -0
  129. data/lib/google/cloud/discoveryengine/v1/agent_gateway_setting_pb.rb +25 -0
  130. data/lib/google/cloud/discoveryengine/v1/assist_answer_pb.rb +13 -1
  131. data/lib/google/cloud/discoveryengine/v1/assistant_pb.rb +13 -1
  132. data/lib/google/cloud/discoveryengine/v1/assistant_service_pb.rb +12 -1
  133. data/lib/google/cloud/discoveryengine/v1/assistant_service_services_pb.rb +12 -1
  134. data/lib/google/cloud/discoveryengine/v1/chunk_pb.rb +1 -1
  135. data/lib/google/cloud/discoveryengine/v1/cmek_config_service_pb.rb +1 -1
  136. data/lib/google/cloud/discoveryengine/v1/cmek_config_service_services_pb.rb +1 -1
  137. data/lib/google/cloud/discoveryengine/v1/collection_pb.rb +25 -0
  138. data/lib/google/cloud/discoveryengine/v1/collection_service_pb.rb +32 -0
  139. data/lib/google/cloud/discoveryengine/v1/collection_service_services_pb.rb +65 -0
  140. data/lib/google/cloud/discoveryengine/v1/common_pb.rb +13 -1
  141. data/lib/google/cloud/discoveryengine/v1/completion_service_pb.rb +16 -1
  142. data/lib/google/cloud/discoveryengine/v1/completion_service_services_pb.rb +3 -1
  143. data/lib/google/cloud/discoveryengine/v1/control_service_pb.rb +1 -1
  144. data/lib/google/cloud/discoveryengine/v1/control_service_services_pb.rb +1 -1
  145. data/lib/google/cloud/discoveryengine/v1/conversational_search_service_pb.rb +1 -1
  146. data/lib/google/cloud/discoveryengine/v1/conversational_search_service_services_pb.rb +1 -1
  147. data/lib/google/cloud/discoveryengine/v1/data_connector_pb.rb +57 -0
  148. data/lib/google/cloud/discoveryengine/v1/data_connector_service_pb.rb +32 -0
  149. data/lib/google/cloud/discoveryengine/v1/data_connector_service_services_pb.rb +58 -0
  150. data/lib/google/cloud/discoveryengine/v1/data_store_pb.rb +10 -1
  151. data/lib/google/cloud/discoveryengine/v1/data_store_service_pb.rb +3 -1
  152. data/lib/google/cloud/discoveryengine/v1/data_store_service_services_pb.rb +20 -1
  153. data/lib/google/cloud/discoveryengine/v1/document_processing_config_pb.rb +1 -1
  154. data/lib/google/cloud/discoveryengine/v1/document_service_pb.rb +1 -1
  155. data/lib/google/cloud/discoveryengine/v1/document_service_services_pb.rb +1 -1
  156. data/lib/google/cloud/discoveryengine/v1/engine_pb.rb +11 -1
  157. data/lib/google/cloud/discoveryengine/v1/engine_service_pb.rb +3 -1
  158. data/lib/google/cloud/discoveryengine/v1/engine_service_services_pb.rb +23 -4
  159. data/lib/google/cloud/discoveryengine/v1/feedback_pb.rb +28 -0
  160. data/lib/google/cloud/discoveryengine/v1/grounded_generation_service_pb.rb +7 -1
  161. data/lib/google/cloud/discoveryengine/v1/grounded_generation_service_services_pb.rb +1 -1
  162. data/lib/google/cloud/discoveryengine/v1/identity_mapping_store_pb.rb +1 -1
  163. data/lib/google/cloud/discoveryengine/v1/identity_mapping_store_service_pb.rb +1 -1
  164. data/lib/google/cloud/discoveryengine/v1/identity_mapping_store_service_services_pb.rb +1 -1
  165. data/lib/google/cloud/discoveryengine/v1/import_config_pb.rb +1 -1
  166. data/lib/google/cloud/discoveryengine/v1/license_config_pb.rb +28 -0
  167. data/lib/google/cloud/discoveryengine/v1/license_config_service_pb.rb +36 -0
  168. data/lib/google/cloud/discoveryengine/v1/license_config_service_services_pb.rb +63 -0
  169. data/lib/google/cloud/discoveryengine/v1/logging_pb.rb +24 -0
  170. data/lib/google/cloud/discoveryengine/v1/project_pb.rb +11 -1
  171. data/lib/google/cloud/discoveryengine/v1/project_service_pb.rb +2 -1
  172. data/lib/google/cloud/discoveryengine/v1/project_service_services_pb.rb +1 -1
  173. data/lib/google/cloud/discoveryengine/v1/rank_service_pb.rb +1 -1
  174. data/lib/google/cloud/discoveryengine/v1/rank_service_services_pb.rb +1 -1
  175. data/lib/google/cloud/discoveryengine/v1/recommendation_service_pb.rb +1 -1
  176. data/lib/google/cloud/discoveryengine/v1/recommendation_service_services_pb.rb +1 -1
  177. data/lib/google/cloud/discoveryengine/v1/schema_service_pb.rb +1 -1
  178. data/lib/google/cloud/discoveryengine/v1/schema_service_services_pb.rb +1 -1
  179. data/lib/google/cloud/discoveryengine/v1/search_tuning_service_pb.rb +1 -1
  180. data/lib/google/cloud/discoveryengine/v1/search_tuning_service_services_pb.rb +1 -1
  181. data/lib/google/cloud/discoveryengine/v1/serving_config_pb.rb +3 -1
  182. data/lib/google/cloud/discoveryengine/v1/serving_config_service_pb.rb +7 -1
  183. data/lib/google/cloud/discoveryengine/v1/serving_config_service_services_pb.rb +21 -1
  184. data/lib/google/cloud/discoveryengine/v1/session_pb.rb +1 -1
  185. data/lib/google/cloud/discoveryengine/v1/session_service_pb.rb +1 -1
  186. data/lib/google/cloud/discoveryengine/v1/session_service_services_pb.rb +1 -1
  187. data/lib/google/cloud/discoveryengine/v1/site_search_engine_service_pb.rb +1 -1
  188. data/lib/google/cloud/discoveryengine/v1/site_search_engine_service_services_pb.rb +1 -1
  189. data/lib/google/cloud/discoveryengine/v1/user_event_pb.rb +2 -1
  190. data/lib/google/cloud/discoveryengine/v1/user_event_service_pb.rb +1 -1
  191. data/lib/google/cloud/discoveryengine/v1/user_event_service_services_pb.rb +1 -1
  192. data/lib/google/cloud/discoveryengine/v1/user_license_pb.rb +2 -1
  193. data/lib/google/cloud/discoveryengine/v1/user_license_service_pb.rb +3 -1
  194. data/lib/google/cloud/discoveryengine/v1/user_license_service_services_pb.rb +5 -1
  195. data/lib/google/cloud/discoveryengine/v1/user_store_pb.rb +24 -0
  196. data/lib/google/cloud/discoveryengine/v1/user_store_service_pb.rb +29 -0
  197. data/lib/google/cloud/discoveryengine/v1/user_store_service_services_pb.rb +47 -0
  198. data/lib/google/cloud/discoveryengine/v1/widget_config_pb.rb +63 -0
  199. data/lib/google/cloud/discoveryengine/v1/widget_config_service_pb.rb +30 -0
  200. data/lib/google/cloud/discoveryengine/v1/widget_config_service_services_pb.rb +48 -0
  201. data/proto_docs/google/cloud/discoveryengine/v1/acl_config.rb +43 -0
  202. data/proto_docs/google/cloud/discoveryengine/v1/acl_config_service.rb +49 -0
  203. data/proto_docs/google/cloud/discoveryengine/v1/agent_gateway_setting.rb +53 -0
  204. data/proto_docs/google/cloud/discoveryengine/v1/assist_answer.rb +164 -1
  205. data/proto_docs/google/cloud/discoveryengine/v1/assistant.rb +217 -0
  206. data/proto_docs/google/cloud/discoveryengine/v1/assistant_service.rb +179 -6
  207. data/proto_docs/google/cloud/discoveryengine/v1/chunk.rb +4 -0
  208. data/proto_docs/google/cloud/discoveryengine/v1/cmek_config_service.rb +7 -2
  209. data/proto_docs/google/cloud/discoveryengine/v1/collection.rb +51 -0
  210. data/proto_docs/google/cloud/discoveryengine/v1/collection_service.rb +53 -0
  211. data/proto_docs/google/cloud/discoveryengine/v1/common.rb +201 -0
  212. data/proto_docs/google/cloud/discoveryengine/v1/completion_service.rb +320 -4
  213. data/proto_docs/google/cloud/discoveryengine/v1/conversational_search_service.rb +31 -8
  214. data/proto_docs/google/cloud/discoveryengine/v1/data_connector.rb +875 -0
  215. data/proto_docs/google/cloud/discoveryengine/v1/data_connector_service.rb +142 -0
  216. data/proto_docs/google/cloud/discoveryengine/v1/data_store.rb +179 -2
  217. data/proto_docs/google/cloud/discoveryengine/v1/document.rb +9 -4
  218. data/proto_docs/google/cloud/discoveryengine/v1/document_processing_config.rb +7 -0
  219. data/proto_docs/google/cloud/discoveryengine/v1/engine.rb +251 -1
  220. data/proto_docs/google/cloud/discoveryengine/v1/feedback.rb +165 -0
  221. data/proto_docs/google/cloud/discoveryengine/v1/grounded_generation_service.rb +107 -0
  222. data/proto_docs/google/cloud/discoveryengine/v1/identity_mapping_store.rb +3 -0
  223. data/proto_docs/google/cloud/discoveryengine/v1/identity_mapping_store_service.rb +1 -0
  224. data/proto_docs/google/cloud/discoveryengine/v1/import_config.rb +6 -4
  225. data/proto_docs/google/cloud/discoveryengine/v1/license_config.rb +107 -0
  226. data/proto_docs/google/cloud/discoveryengine/v1/license_config_service.rb +220 -0
  227. data/proto_docs/google/cloud/discoveryengine/v1/logging.rb +40 -0
  228. data/proto_docs/google/cloud/discoveryengine/v1/project.rb +229 -0
  229. data/proto_docs/google/cloud/discoveryengine/v1/project_service.rb +18 -0
  230. data/proto_docs/google/cloud/discoveryengine/v1/purge_config.rb +2 -1
  231. data/proto_docs/google/cloud/discoveryengine/v1/rank_service.rb +3 -3
  232. data/proto_docs/google/cloud/discoveryengine/v1/search_service.rb +7 -1
  233. data/proto_docs/google/cloud/discoveryengine/v1/serving_config.rb +43 -0
  234. data/proto_docs/google/cloud/discoveryengine/v1/serving_config_service.rb +71 -0
  235. data/proto_docs/google/cloud/discoveryengine/v1/session.rb +9 -0
  236. data/proto_docs/google/cloud/discoveryengine/v1/user_event.rb +16 -6
  237. data/proto_docs/google/cloud/discoveryengine/v1/user_license.rb +16 -1
  238. data/proto_docs/google/cloud/discoveryengine/v1/user_license_service.rb +53 -6
  239. data/proto_docs/google/cloud/discoveryengine/v1/user_store.rb +66 -0
  240. data/proto_docs/google/cloud/discoveryengine/v1/user_store_service.rb +54 -0
  241. data/proto_docs/google/cloud/discoveryengine/v1/widget_config.rb +1082 -0
  242. data/proto_docs/google/cloud/discoveryengine/v1/widget_config_service.rb +102 -0
  243. data/proto_docs/google/iam/v1/iam_policy.rb +87 -0
  244. data/proto_docs/google/iam/v1/options.rb +50 -0
  245. data/proto_docs/google/iam/v1/policy.rb +426 -0
  246. data/proto_docs/google/type/date.rb +1 -1
  247. data/proto_docs/google/type/datetime.rb +104 -0
  248. data/proto_docs/google/type/expr.rb +75 -0
  249. data/proto_docs/google/type/latlng.rb +38 -0
  250. metadata +103 -1
@@ -0,0 +1,732 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2026 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+ require "google/cloud/errors"
20
+ require "google/cloud/discoveryengine/v1/collection_service_pb"
21
+ require "google/cloud/location"
22
+
23
+ module Google
24
+ module Cloud
25
+ module DiscoveryEngine
26
+ module V1
27
+ module CollectionService
28
+ ##
29
+ # Client for the CollectionService service.
30
+ #
31
+ # Service for managing
32
+ # {::Google::Cloud::DiscoveryEngine::V1::Collection Collection}s.
33
+ #
34
+ class Client
35
+ # @private
36
+ API_VERSION = ""
37
+
38
+ # @private
39
+ DEFAULT_ENDPOINT_TEMPLATE = "discoveryengine.$UNIVERSE_DOMAIN$"
40
+
41
+ include Paths
42
+
43
+ # @private
44
+ attr_reader :collection_service_stub
45
+
46
+ ##
47
+ # Configure the CollectionService Client class.
48
+ #
49
+ # See {::Google::Cloud::DiscoveryEngine::V1::CollectionService::Client::Configuration}
50
+ # for a description of the configuration fields.
51
+ #
52
+ # @example
53
+ #
54
+ # # Modify the configuration for all CollectionService clients
55
+ # ::Google::Cloud::DiscoveryEngine::V1::CollectionService::Client.configure do |config|
56
+ # config.timeout = 10.0
57
+ # end
58
+ #
59
+ # @yield [config] Configure the Client client.
60
+ # @yieldparam config [Client::Configuration]
61
+ #
62
+ # @return [Client::Configuration]
63
+ #
64
+ def self.configure
65
+ @configure ||= begin
66
+ namespace = ["Google", "Cloud", "DiscoveryEngine", "V1"]
67
+ parent_config = while namespace.any?
68
+ parent_name = namespace.join "::"
69
+ parent_const = const_get parent_name
70
+ break parent_const.configure if parent_const.respond_to? :configure
71
+ namespace.pop
72
+ end
73
+ default_config = Client::Configuration.new parent_config
74
+
75
+ default_config
76
+ end
77
+ yield @configure if block_given?
78
+ @configure
79
+ end
80
+
81
+ ##
82
+ # Configure the CollectionService Client instance.
83
+ #
84
+ # The configuration is set to the derived mode, meaning that values can be changed,
85
+ # but structural changes (adding new fields, etc.) are not allowed. Structural changes
86
+ # should be made on {Client.configure}.
87
+ #
88
+ # See {::Google::Cloud::DiscoveryEngine::V1::CollectionService::Client::Configuration}
89
+ # for a description of the configuration fields.
90
+ #
91
+ # @yield [config] Configure the Client client.
92
+ # @yieldparam config [Client::Configuration]
93
+ #
94
+ # @return [Client::Configuration]
95
+ #
96
+ def configure
97
+ yield @config if block_given?
98
+ @config
99
+ end
100
+
101
+ ##
102
+ # The effective universe domain
103
+ #
104
+ # @return [String]
105
+ #
106
+ def universe_domain
107
+ @collection_service_stub.universe_domain
108
+ end
109
+
110
+ ##
111
+ # Create a new CollectionService client object.
112
+ #
113
+ # @example
114
+ #
115
+ # # Create a client using the default configuration
116
+ # client = ::Google::Cloud::DiscoveryEngine::V1::CollectionService::Client.new
117
+ #
118
+ # # Create a client using a custom configuration
119
+ # client = ::Google::Cloud::DiscoveryEngine::V1::CollectionService::Client.new do |config|
120
+ # config.timeout = 10.0
121
+ # end
122
+ #
123
+ # @yield [config] Configure the CollectionService client.
124
+ # @yieldparam config [Client::Configuration]
125
+ #
126
+ def initialize
127
+ # These require statements are intentionally placed here to initialize
128
+ # the gRPC module only when it's required.
129
+ # See https://github.com/googleapis/toolkit/issues/446
130
+ require "gapic/grpc"
131
+ require "google/cloud/discoveryengine/v1/collection_service_services_pb"
132
+
133
+ # Create the configuration object
134
+ @config = Configuration.new Client.configure
135
+
136
+ # Yield the configuration if needed
137
+ yield @config if block_given?
138
+
139
+ # Create credentials
140
+ credentials = @config.credentials
141
+ # Use self-signed JWT if the endpoint is unchanged from default,
142
+ # but only if the default endpoint does not have a region prefix.
143
+ enable_self_signed_jwt = @config.endpoint.nil? ||
144
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
145
+ !@config.endpoint.split(".").first.include?("-"))
146
+ credentials ||= Credentials.default scope: @config.scope,
147
+ enable_self_signed_jwt: enable_self_signed_jwt
148
+ if credentials.is_a?(::String) || credentials.is_a?(::Hash)
149
+ credentials = Credentials.new credentials, scope: @config.scope
150
+ end
151
+ @quota_project_id = @config.quota_project
152
+ @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
153
+
154
+ @operations_client = Operations.new do |config|
155
+ config.credentials = credentials
156
+ config.quota_project = @quota_project_id
157
+ config.endpoint = @config.endpoint
158
+ config.universe_domain = @config.universe_domain
159
+ end
160
+
161
+ @collection_service_stub = ::Gapic::ServiceStub.new(
162
+ ::Google::Cloud::DiscoveryEngine::V1::CollectionService::Stub,
163
+ credentials: credentials,
164
+ endpoint: @config.endpoint,
165
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
166
+ universe_domain: @config.universe_domain,
167
+ channel_args: @config.channel_args,
168
+ interceptors: @config.interceptors,
169
+ channel_pool_config: @config.channel_pool,
170
+ logger: @config.logger
171
+ )
172
+
173
+ @collection_service_stub.stub_logger&.info do |entry|
174
+ entry.set_system_name
175
+ entry.set_service
176
+ entry.message = "Created client for #{entry.service}"
177
+ entry.set_credentials_fields credentials
178
+ entry.set "customEndpoint", @config.endpoint if @config.endpoint
179
+ entry.set "defaultTimeout", @config.timeout if @config.timeout
180
+ entry.set "quotaProject", @quota_project_id if @quota_project_id
181
+ end
182
+
183
+ @location_client = Google::Cloud::Location::Locations::Client.new do |config|
184
+ config.credentials = credentials
185
+ config.quota_project = @quota_project_id
186
+ config.endpoint = @collection_service_stub.endpoint
187
+ config.universe_domain = @collection_service_stub.universe_domain
188
+ config.logger = @collection_service_stub.logger if config.respond_to? :logger=
189
+ end
190
+ end
191
+
192
+ ##
193
+ # Get the associated client for long-running operations.
194
+ #
195
+ # @return [::Google::Cloud::DiscoveryEngine::V1::CollectionService::Operations]
196
+ #
197
+ attr_reader :operations_client
198
+
199
+ ##
200
+ # Get the associated client for mix-in of the Locations.
201
+ #
202
+ # @return [Google::Cloud::Location::Locations::Client]
203
+ #
204
+ attr_reader :location_client
205
+
206
+ ##
207
+ # The logger used for request/response debug logging.
208
+ #
209
+ # @return [Logger]
210
+ #
211
+ def logger
212
+ @collection_service_stub.logger
213
+ end
214
+
215
+ # Service calls
216
+
217
+ ##
218
+ # Deletes a {::Google::Cloud::DiscoveryEngine::V1::Collection Collection}.
219
+ #
220
+ # @overload delete_collection(request, options = nil)
221
+ # Pass arguments to `delete_collection` via a request object, either of type
222
+ # {::Google::Cloud::DiscoveryEngine::V1::DeleteCollectionRequest} or an equivalent Hash.
223
+ #
224
+ # @param request [::Google::Cloud::DiscoveryEngine::V1::DeleteCollectionRequest, ::Hash]
225
+ # A request object representing the call parameters. Required. To specify no
226
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
227
+ # @param options [::Gapic::CallOptions, ::Hash]
228
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
229
+ #
230
+ # @overload delete_collection(name: nil)
231
+ # Pass arguments to `delete_collection` via keyword arguments. Note that at
232
+ # least one keyword argument is required. To specify no parameters, or to keep all
233
+ # the default parameter values, pass an empty Hash as a request object (see above).
234
+ #
235
+ # @param name [::String]
236
+ # Required. The full resource name of the Collection, in the format of
237
+ # `projects/{project}/locations/{location}/collections/{collection}`.
238
+ #
239
+ # @yield [response, operation] Access the result along with the RPC operation
240
+ # @yieldparam response [::Gapic::Operation]
241
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
242
+ #
243
+ # @return [::Gapic::Operation]
244
+ #
245
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
246
+ #
247
+ # @example Basic example
248
+ # require "google/cloud/discovery_engine/v1"
249
+ #
250
+ # # Create a client object. The client can be reused for multiple calls.
251
+ # client = Google::Cloud::DiscoveryEngine::V1::CollectionService::Client.new
252
+ #
253
+ # # Create a request. To set request fields, pass in keyword arguments.
254
+ # request = Google::Cloud::DiscoveryEngine::V1::DeleteCollectionRequest.new
255
+ #
256
+ # # Call the delete_collection method.
257
+ # result = client.delete_collection request
258
+ #
259
+ # # The returned object is of type Gapic::Operation. You can use it to
260
+ # # check the status of an operation, cancel it, or wait for results.
261
+ # # Here is how to wait for a response.
262
+ # result.wait_until_done! timeout: 60
263
+ # if result.response?
264
+ # p result.response
265
+ # else
266
+ # puts "No response received."
267
+ # end
268
+ #
269
+ def delete_collection request, options = nil
270
+ raise ::ArgumentError, "request must be provided" if request.nil?
271
+
272
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DiscoveryEngine::V1::DeleteCollectionRequest
273
+
274
+ # Converts hash and nil to an options object
275
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
276
+
277
+ # Customize the options with defaults
278
+ metadata = @config.rpcs.delete_collection.metadata.to_h
279
+
280
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
281
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
282
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
283
+ gapic_version: ::Google::Cloud::DiscoveryEngine::V1::VERSION
284
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
285
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
286
+
287
+ header_params = {}
288
+ if request.name
289
+ header_params["name"] = request.name
290
+ end
291
+
292
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
293
+ metadata[:"x-goog-request-params"] ||= request_params_header
294
+
295
+ options.apply_defaults timeout: @config.rpcs.delete_collection.timeout,
296
+ metadata: metadata,
297
+ retry_policy: @config.rpcs.delete_collection.retry_policy
298
+
299
+ options.apply_defaults timeout: @config.timeout,
300
+ metadata: @config.metadata,
301
+ retry_policy: @config.retry_policy
302
+
303
+ @collection_service_stub.call_rpc :delete_collection, request, options: options do |response, operation|
304
+ response = ::Gapic::Operation.new response, @operations_client, options: options
305
+ yield response, operation if block_given?
306
+ throw :response, response
307
+ end
308
+ rescue ::GRPC::BadStatus => e
309
+ raise ::Google::Cloud::Error.from_error(e)
310
+ end
311
+
312
+ ##
313
+ # Gets the IAM access control policy for a
314
+ # {::Google::Cloud::DiscoveryEngine::V1::Collection Collection}. A `NOT_FOUND`
315
+ # error is returned if the resource does not exist. An empty policy is
316
+ # returned if the resource exists but does not have a policy set on it.
317
+ #
318
+ # @overload get_iam_policy(request, options = nil)
319
+ # Pass arguments to `get_iam_policy` via a request object, either of type
320
+ # {::Google::Iam::V1::GetIamPolicyRequest} or an equivalent Hash.
321
+ #
322
+ # @param request [::Google::Iam::V1::GetIamPolicyRequest, ::Hash]
323
+ # A request object representing the call parameters. Required. To specify no
324
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
325
+ # @param options [::Gapic::CallOptions, ::Hash]
326
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
327
+ #
328
+ # @overload get_iam_policy(resource: nil, options: nil)
329
+ # Pass arguments to `get_iam_policy` via keyword arguments. Note that at
330
+ # least one keyword argument is required. To specify no parameters, or to keep all
331
+ # the default parameter values, pass an empty Hash as a request object (see above).
332
+ #
333
+ # @param resource [::String]
334
+ # REQUIRED: The resource for which the policy is being requested.
335
+ # See the operation documentation for the appropriate value for this field.
336
+ # @param options [::Google::Iam::V1::GetPolicyOptions, ::Hash]
337
+ # OPTIONAL: A `GetPolicyOptions` object for specifying options to
338
+ # `GetIamPolicy`.
339
+ #
340
+ # @yield [response, operation] Access the result along with the RPC operation
341
+ # @yieldparam response [::Google::Iam::V1::Policy]
342
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
343
+ #
344
+ # @return [::Google::Iam::V1::Policy]
345
+ #
346
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
347
+ #
348
+ # @example Basic example
349
+ # require "google/cloud/discovery_engine/v1"
350
+ #
351
+ # # Create a client object. The client can be reused for multiple calls.
352
+ # client = Google::Cloud::DiscoveryEngine::V1::CollectionService::Client.new
353
+ #
354
+ # # Create a request. To set request fields, pass in keyword arguments.
355
+ # request = Google::Iam::V1::GetIamPolicyRequest.new
356
+ #
357
+ # # Call the get_iam_policy method.
358
+ # result = client.get_iam_policy request
359
+ #
360
+ # # The returned object is of type Google::Iam::V1::Policy.
361
+ # p result
362
+ #
363
+ def get_iam_policy request, options = nil
364
+ raise ::ArgumentError, "request must be provided" if request.nil?
365
+
366
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Iam::V1::GetIamPolicyRequest
367
+
368
+ # Converts hash and nil to an options object
369
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
370
+
371
+ # Customize the options with defaults
372
+ metadata = @config.rpcs.get_iam_policy.metadata.to_h
373
+
374
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
375
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
376
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
377
+ gapic_version: ::Google::Cloud::DiscoveryEngine::V1::VERSION
378
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
379
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
380
+
381
+ header_params = {}
382
+ if request.resource
383
+ header_params["resource"] = request.resource
384
+ end
385
+
386
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
387
+ metadata[:"x-goog-request-params"] ||= request_params_header
388
+
389
+ options.apply_defaults timeout: @config.rpcs.get_iam_policy.timeout,
390
+ metadata: metadata,
391
+ retry_policy: @config.rpcs.get_iam_policy.retry_policy
392
+
393
+ options.apply_defaults timeout: @config.timeout,
394
+ metadata: @config.metadata,
395
+ retry_policy: @config.retry_policy
396
+
397
+ @collection_service_stub.call_rpc :get_iam_policy, request, options: options do |response, operation|
398
+ yield response, operation if block_given?
399
+ end
400
+ rescue ::GRPC::BadStatus => e
401
+ raise ::Google::Cloud::Error.from_error(e)
402
+ end
403
+
404
+ ##
405
+ # Sets the IAM access control policy for a
406
+ # {::Google::Cloud::DiscoveryEngine::V1::Collection Collection}. A `NOT_FOUND`
407
+ # error is returned if the resource does not exist.
408
+ #
409
+ # **Important:** When setting a policy directly on a Collection resource,
410
+ # the only recommended roles in the bindings are:
411
+ # `roles/discoveryengine.admin`
412
+ # `roles/discoveryengine.agentspaceAdmin`
413
+ # `roles/discoveryengine.viewer`
414
+ # `roles/discoveryengine.agentspaceViewer`
415
+ # `roles/discoveryengine.user`
416
+ # `roles/discoveryengine.agentspaceUser`
417
+ # Attempting to grant any other role will result in a warning in logging.
418
+ #
419
+ # @overload set_iam_policy(request, options = nil)
420
+ # Pass arguments to `set_iam_policy` via a request object, either of type
421
+ # {::Google::Iam::V1::SetIamPolicyRequest} or an equivalent Hash.
422
+ #
423
+ # @param request [::Google::Iam::V1::SetIamPolicyRequest, ::Hash]
424
+ # A request object representing the call parameters. Required. To specify no
425
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
426
+ # @param options [::Gapic::CallOptions, ::Hash]
427
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
428
+ #
429
+ # @overload set_iam_policy(resource: nil, policy: nil, update_mask: nil)
430
+ # Pass arguments to `set_iam_policy` via keyword arguments. Note that at
431
+ # least one keyword argument is required. To specify no parameters, or to keep all
432
+ # the default parameter values, pass an empty Hash as a request object (see above).
433
+ #
434
+ # @param resource [::String]
435
+ # REQUIRED: The resource for which the policy is being specified.
436
+ # See the operation documentation for the appropriate value for this field.
437
+ # @param policy [::Google::Iam::V1::Policy, ::Hash]
438
+ # REQUIRED: The complete policy to be applied to the `resource`. The size of
439
+ # the policy is limited to a few 10s of KB. An empty policy is a
440
+ # valid policy but certain Cloud Platform services (such as Projects)
441
+ # might reject them.
442
+ # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
443
+ # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only
444
+ # the fields in the mask will be modified. If no mask is provided, the
445
+ # following default mask is used:
446
+ #
447
+ # `paths: "bindings, etag"`
448
+ #
449
+ # @yield [response, operation] Access the result along with the RPC operation
450
+ # @yieldparam response [::Google::Iam::V1::Policy]
451
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
452
+ #
453
+ # @return [::Google::Iam::V1::Policy]
454
+ #
455
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
456
+ #
457
+ # @example Basic example
458
+ # require "google/cloud/discovery_engine/v1"
459
+ #
460
+ # # Create a client object. The client can be reused for multiple calls.
461
+ # client = Google::Cloud::DiscoveryEngine::V1::CollectionService::Client.new
462
+ #
463
+ # # Create a request. To set request fields, pass in keyword arguments.
464
+ # request = Google::Iam::V1::SetIamPolicyRequest.new
465
+ #
466
+ # # Call the set_iam_policy method.
467
+ # result = client.set_iam_policy request
468
+ #
469
+ # # The returned object is of type Google::Iam::V1::Policy.
470
+ # p result
471
+ #
472
+ def set_iam_policy request, options = nil
473
+ raise ::ArgumentError, "request must be provided" if request.nil?
474
+
475
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Iam::V1::SetIamPolicyRequest
476
+
477
+ # Converts hash and nil to an options object
478
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
479
+
480
+ # Customize the options with defaults
481
+ metadata = @config.rpcs.set_iam_policy.metadata.to_h
482
+
483
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
484
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
485
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
486
+ gapic_version: ::Google::Cloud::DiscoveryEngine::V1::VERSION
487
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
488
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
489
+
490
+ header_params = {}
491
+ if request.resource
492
+ header_params["resource"] = request.resource
493
+ end
494
+
495
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
496
+ metadata[:"x-goog-request-params"] ||= request_params_header
497
+
498
+ options.apply_defaults timeout: @config.rpcs.set_iam_policy.timeout,
499
+ metadata: metadata,
500
+ retry_policy: @config.rpcs.set_iam_policy.retry_policy
501
+
502
+ options.apply_defaults timeout: @config.timeout,
503
+ metadata: @config.metadata,
504
+ retry_policy: @config.retry_policy
505
+
506
+ @collection_service_stub.call_rpc :set_iam_policy, request, options: options do |response, operation|
507
+ yield response, operation if block_given?
508
+ end
509
+ rescue ::GRPC::BadStatus => e
510
+ raise ::Google::Cloud::Error.from_error(e)
511
+ end
512
+
513
+ ##
514
+ # Configuration class for the CollectionService API.
515
+ #
516
+ # This class represents the configuration for CollectionService,
517
+ # providing control over timeouts, retry behavior, logging, transport
518
+ # parameters, and other low-level controls. Certain parameters can also be
519
+ # applied individually to specific RPCs. See
520
+ # {::Google::Cloud::DiscoveryEngine::V1::CollectionService::Client::Configuration::Rpcs}
521
+ # for a list of RPCs that can be configured independently.
522
+ #
523
+ # Configuration can be applied globally to all clients, or to a single client
524
+ # on construction.
525
+ #
526
+ # @example
527
+ #
528
+ # # Modify the global config, setting the timeout for
529
+ # # delete_collection to 20 seconds,
530
+ # # and all remaining timeouts to 10 seconds.
531
+ # ::Google::Cloud::DiscoveryEngine::V1::CollectionService::Client.configure do |config|
532
+ # config.timeout = 10.0
533
+ # config.rpcs.delete_collection.timeout = 20.0
534
+ # end
535
+ #
536
+ # # Apply the above configuration only to a new client.
537
+ # client = ::Google::Cloud::DiscoveryEngine::V1::CollectionService::Client.new do |config|
538
+ # config.timeout = 10.0
539
+ # config.rpcs.delete_collection.timeout = 20.0
540
+ # end
541
+ #
542
+ # @!attribute [rw] endpoint
543
+ # A custom service endpoint, as a hostname or hostname:port. The default is
544
+ # nil, indicating to use the default endpoint in the current universe domain.
545
+ # @return [::String,nil]
546
+ # @!attribute [rw] credentials
547
+ # Credentials to send with calls. You may provide any of the following types:
548
+ # * (`Google::Auth::Credentials`) A googleauth credentials object
549
+ # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
550
+ # * (`Signet::OAuth2::Client`) A signet oauth2 client object
551
+ # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
552
+ # * (`GRPC::Core::Channel`) a gRPC channel with included credentials
553
+ # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
554
+ # * (`nil`) indicating no credentials
555
+ #
556
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
557
+ # is deprecated. Providing an unvalidated credential configuration to
558
+ # Google APIs can compromise the security of your systems and data.
559
+ #
560
+ # @example
561
+ #
562
+ # # The recommended way to provide credentials is to use the `make_creds` method
563
+ # # on the appropriate credentials class for your environment.
564
+ #
565
+ # require "googleauth"
566
+ #
567
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
568
+ # json_key_io: ::File.open("/path/to/keyfile.json")
569
+ # )
570
+ #
571
+ # client = ::Google::Cloud::DiscoveryEngine::V1::CollectionService::Client.new do |config|
572
+ # config.credentials = credentials
573
+ # end
574
+ #
575
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
576
+ # external source for authentication to Google Cloud, you must validate it before
577
+ # providing it to a Google API client library. Providing an unvalidated credential
578
+ # configuration to Google APIs can compromise the security of your systems and data.
579
+ # For more information, refer to [Validate credential configurations from external
580
+ # sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
581
+ # @return [::Object]
582
+ # @!attribute [rw] scope
583
+ # The OAuth scopes
584
+ # @return [::Array<::String>]
585
+ # @!attribute [rw] lib_name
586
+ # The library name as recorded in instrumentation and logging
587
+ # @return [::String]
588
+ # @!attribute [rw] lib_version
589
+ # The library version as recorded in instrumentation and logging
590
+ # @return [::String]
591
+ # @!attribute [rw] channel_args
592
+ # Extra parameters passed to the gRPC channel. Note: this is ignored if a
593
+ # `GRPC::Core::Channel` object is provided as the credential.
594
+ # @return [::Hash]
595
+ # @!attribute [rw] interceptors
596
+ # An array of interceptors that are run before calls are executed.
597
+ # @return [::Array<::GRPC::ClientInterceptor>]
598
+ # @!attribute [rw] timeout
599
+ # The call timeout in seconds.
600
+ # @return [::Numeric]
601
+ # @!attribute [rw] metadata
602
+ # Additional gRPC headers to be sent with the call.
603
+ # @return [::Hash{::Symbol=>::String}]
604
+ # @!attribute [rw] retry_policy
605
+ # The retry policy. The value is a hash with the following keys:
606
+ # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
607
+ # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
608
+ # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
609
+ # * `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
610
+ # * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
611
+ # trigger a retry.
612
+ # @return [::Hash]
613
+ # @!attribute [rw] quota_project
614
+ # A separate project against which to charge quota.
615
+ # @return [::String]
616
+ # @!attribute [rw] universe_domain
617
+ # The universe domain within which to make requests. This determines the
618
+ # default endpoint URL. The default value of nil uses the environment
619
+ # universe (usually the default "googleapis.com" universe).
620
+ # @return [::String,nil]
621
+ # @!attribute [rw] logger
622
+ # A custom logger to use for request/response debug logging, or the value
623
+ # `:default` (the default) to construct a default logger, or `nil` to
624
+ # explicitly disable logging.
625
+ # @return [::Logger,:default,nil]
626
+ #
627
+ class Configuration
628
+ extend ::Gapic::Config
629
+
630
+ # @private
631
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
632
+ DEFAULT_ENDPOINT = "discoveryengine.googleapis.com"
633
+
634
+ config_attr :endpoint, nil, ::String, nil
635
+ config_attr :credentials, nil do |value|
636
+ allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Google::Auth::BaseClient, ::Signet::OAuth2::Client, nil]
637
+ allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC::Core::Channel
638
+ allowed.any? { |klass| klass === value }
639
+ end
640
+ config_attr :scope, nil, ::String, ::Array, nil
641
+ config_attr :lib_name, nil, ::String, nil
642
+ config_attr :lib_version, nil, ::String, nil
643
+ config_attr(:channel_args, { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
644
+ config_attr :interceptors, nil, ::Array, nil
645
+ config_attr :timeout, nil, ::Numeric, nil
646
+ config_attr :metadata, nil, ::Hash, nil
647
+ config_attr :retry_policy, nil, ::Hash, ::Proc, nil
648
+ config_attr :quota_project, nil, ::String, nil
649
+ config_attr :universe_domain, nil, ::String, nil
650
+ config_attr :logger, :default, ::Logger, nil, :default
651
+
652
+ # @private
653
+ def initialize parent_config = nil
654
+ @parent_config = parent_config unless parent_config.nil?
655
+
656
+ yield self if block_given?
657
+ end
658
+
659
+ ##
660
+ # Configurations for individual RPCs
661
+ # @return [Rpcs]
662
+ #
663
+ def rpcs
664
+ @rpcs ||= begin
665
+ parent_rpcs = nil
666
+ parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
667
+ Rpcs.new parent_rpcs
668
+ end
669
+ end
670
+
671
+ ##
672
+ # Configuration for the channel pool
673
+ # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
674
+ #
675
+ def channel_pool
676
+ @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
677
+ end
678
+
679
+ ##
680
+ # Configuration RPC class for the CollectionService API.
681
+ #
682
+ # Includes fields providing the configuration for each RPC in this service.
683
+ # Each configuration object is of type `Gapic::Config::Method` and includes
684
+ # the following configuration fields:
685
+ #
686
+ # * `timeout` (*type:* `Numeric`) - The call timeout in seconds
687
+ # * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
688
+ # * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
689
+ # include the following keys:
690
+ # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
691
+ # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
692
+ # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
693
+ # * `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
694
+ # * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
695
+ # trigger a retry.
696
+ #
697
+ class Rpcs
698
+ ##
699
+ # RPC-specific configuration for `delete_collection`
700
+ # @return [::Gapic::Config::Method]
701
+ #
702
+ attr_reader :delete_collection
703
+ ##
704
+ # RPC-specific configuration for `get_iam_policy`
705
+ # @return [::Gapic::Config::Method]
706
+ #
707
+ attr_reader :get_iam_policy
708
+ ##
709
+ # RPC-specific configuration for `set_iam_policy`
710
+ # @return [::Gapic::Config::Method]
711
+ #
712
+ attr_reader :set_iam_policy
713
+
714
+ # @private
715
+ def initialize parent_rpcs = nil
716
+ delete_collection_config = parent_rpcs.delete_collection if parent_rpcs.respond_to? :delete_collection
717
+ @delete_collection = ::Gapic::Config::Method.new delete_collection_config
718
+ get_iam_policy_config = parent_rpcs.get_iam_policy if parent_rpcs.respond_to? :get_iam_policy
719
+ @get_iam_policy = ::Gapic::Config::Method.new get_iam_policy_config
720
+ set_iam_policy_config = parent_rpcs.set_iam_policy if parent_rpcs.respond_to? :set_iam_policy
721
+ @set_iam_policy = ::Gapic::Config::Method.new set_iam_policy_config
722
+
723
+ yield self if block_given?
724
+ end
725
+ end
726
+ end
727
+ end
728
+ end
729
+ end
730
+ end
731
+ end
732
+ end