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,959 @@
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/license_config_service_pb"
21
+ require "google/cloud/discovery_engine/v1/license_config_service/rest/service_stub"
22
+ require "google/cloud/location/rest"
23
+
24
+ module Google
25
+ module Cloud
26
+ module DiscoveryEngine
27
+ module V1
28
+ module LicenseConfigService
29
+ module Rest
30
+ ##
31
+ # REST client for the LicenseConfigService service.
32
+ #
33
+ # Service for managing license config related resources.
34
+ #
35
+ class Client
36
+ # @private
37
+ API_VERSION = ""
38
+
39
+ # @private
40
+ DEFAULT_ENDPOINT_TEMPLATE = "discoveryengine.$UNIVERSE_DOMAIN$"
41
+
42
+ include Paths
43
+
44
+ # @private
45
+ attr_reader :license_config_service_stub
46
+
47
+ ##
48
+ # Configure the LicenseConfigService Client class.
49
+ #
50
+ # See {::Google::Cloud::DiscoveryEngine::V1::LicenseConfigService::Rest::Client::Configuration}
51
+ # for a description of the configuration fields.
52
+ #
53
+ # @example
54
+ #
55
+ # # Modify the configuration for all LicenseConfigService clients
56
+ # ::Google::Cloud::DiscoveryEngine::V1::LicenseConfigService::Rest::Client.configure do |config|
57
+ # config.timeout = 10.0
58
+ # end
59
+ #
60
+ # @yield [config] Configure the Client client.
61
+ # @yieldparam config [Client::Configuration]
62
+ #
63
+ # @return [Client::Configuration]
64
+ #
65
+ def self.configure
66
+ @configure ||= begin
67
+ namespace = ["Google", "Cloud", "DiscoveryEngine", "V1"]
68
+ parent_config = while namespace.any?
69
+ parent_name = namespace.join "::"
70
+ parent_const = const_get parent_name
71
+ break parent_const.configure if parent_const.respond_to? :configure
72
+ namespace.pop
73
+ end
74
+ default_config = Client::Configuration.new parent_config
75
+
76
+ default_config
77
+ end
78
+ yield @configure if block_given?
79
+ @configure
80
+ end
81
+
82
+ ##
83
+ # Configure the LicenseConfigService Client instance.
84
+ #
85
+ # The configuration is set to the derived mode, meaning that values can be changed,
86
+ # but structural changes (adding new fields, etc.) are not allowed. Structural changes
87
+ # should be made on {Client.configure}.
88
+ #
89
+ # See {::Google::Cloud::DiscoveryEngine::V1::LicenseConfigService::Rest::Client::Configuration}
90
+ # for a description of the configuration fields.
91
+ #
92
+ # @yield [config] Configure the Client client.
93
+ # @yieldparam config [Client::Configuration]
94
+ #
95
+ # @return [Client::Configuration]
96
+ #
97
+ def configure
98
+ yield @config if block_given?
99
+ @config
100
+ end
101
+
102
+ ##
103
+ # The effective universe domain
104
+ #
105
+ # @return [String]
106
+ #
107
+ def universe_domain
108
+ @license_config_service_stub.universe_domain
109
+ end
110
+
111
+ ##
112
+ # Create a new LicenseConfigService REST client object.
113
+ #
114
+ # @example
115
+ #
116
+ # # Create a client using the default configuration
117
+ # client = ::Google::Cloud::DiscoveryEngine::V1::LicenseConfigService::Rest::Client.new
118
+ #
119
+ # # Create a client using a custom configuration
120
+ # client = ::Google::Cloud::DiscoveryEngine::V1::LicenseConfigService::Rest::Client.new do |config|
121
+ # config.timeout = 10.0
122
+ # end
123
+ #
124
+ # @yield [config] Configure the LicenseConfigService client.
125
+ # @yieldparam config [Client::Configuration]
126
+ #
127
+ def initialize
128
+ # Create the configuration object
129
+ @config = Configuration.new Client.configure
130
+
131
+ # Yield the configuration if needed
132
+ yield @config if block_given?
133
+
134
+ # Create credentials
135
+ credentials = @config.credentials
136
+ # Use self-signed JWT if the endpoint is unchanged from default,
137
+ # but only if the default endpoint does not have a region prefix.
138
+ enable_self_signed_jwt = @config.endpoint.nil? ||
139
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
140
+ !@config.endpoint.split(".").first.include?("-"))
141
+ credentials ||= Credentials.default scope: @config.scope,
142
+ enable_self_signed_jwt: enable_self_signed_jwt
143
+ if credentials.is_a?(::String) || credentials.is_a?(::Hash)
144
+ credentials = Credentials.new credentials, scope: @config.scope
145
+ end
146
+
147
+ @quota_project_id = @config.quota_project
148
+ @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
149
+
150
+ @license_config_service_stub = ::Google::Cloud::DiscoveryEngine::V1::LicenseConfigService::Rest::ServiceStub.new(
151
+ endpoint: @config.endpoint,
152
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
153
+ universe_domain: @config.universe_domain,
154
+ credentials: credentials,
155
+ logger: @config.logger
156
+ )
157
+
158
+ @license_config_service_stub.logger(stub: true)&.info do |entry|
159
+ entry.set_system_name
160
+ entry.set_service
161
+ entry.message = "Created client for #{entry.service}"
162
+ entry.set_credentials_fields credentials
163
+ entry.set "customEndpoint", @config.endpoint if @config.endpoint
164
+ entry.set "defaultTimeout", @config.timeout if @config.timeout
165
+ entry.set "quotaProject", @quota_project_id if @quota_project_id
166
+ end
167
+
168
+ @location_client = Google::Cloud::Location::Locations::Rest::Client.new do |config|
169
+ config.credentials = credentials
170
+ config.quota_project = @quota_project_id
171
+ config.endpoint = @license_config_service_stub.endpoint
172
+ config.universe_domain = @license_config_service_stub.universe_domain
173
+ config.logger = @license_config_service_stub.logger if config.respond_to? :logger=
174
+ end
175
+ end
176
+
177
+ ##
178
+ # Get the associated client for mix-in of the Locations.
179
+ #
180
+ # @return [Google::Cloud::Location::Locations::Rest::Client]
181
+ #
182
+ attr_reader :location_client
183
+
184
+ ##
185
+ # The logger used for request/response debug logging.
186
+ #
187
+ # @return [Logger]
188
+ #
189
+ def logger
190
+ @license_config_service_stub.logger
191
+ end
192
+
193
+ # Service calls
194
+
195
+ ##
196
+ # Creates a {::Google::Cloud::DiscoveryEngine::V1::LicenseConfig LicenseConfig}
197
+ # This method should only be used for creating NotebookLm licenses or Gemini
198
+ # Enterprise free trial licenses.
199
+ #
200
+ # @overload create_license_config(request, options = nil)
201
+ # Pass arguments to `create_license_config` via a request object, either of type
202
+ # {::Google::Cloud::DiscoveryEngine::V1::CreateLicenseConfigRequest} or an equivalent Hash.
203
+ #
204
+ # @param request [::Google::Cloud::DiscoveryEngine::V1::CreateLicenseConfigRequest, ::Hash]
205
+ # A request object representing the call parameters. Required. To specify no
206
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
207
+ # @param options [::Gapic::CallOptions, ::Hash]
208
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
209
+ #
210
+ # @overload create_license_config(parent: nil, license_config: nil, license_config_id: nil)
211
+ # Pass arguments to `create_license_config` via keyword arguments. Note that at
212
+ # least one keyword argument is required. To specify no parameters, or to keep all
213
+ # the default parameter values, pass an empty Hash as a request object (see above).
214
+ #
215
+ # @param parent [::String]
216
+ # Required. The parent resource name, such as
217
+ # `projects/{project}/locations/{location}`.
218
+ # @param license_config [::Google::Cloud::DiscoveryEngine::V1::LicenseConfig, ::Hash]
219
+ # Required. The
220
+ # {::Google::Cloud::DiscoveryEngine::V1::LicenseConfig LicenseConfig} to create.
221
+ # @param license_config_id [::String]
222
+ # Optional. The ID to use for the
223
+ # {::Google::Cloud::DiscoveryEngine::V1::LicenseConfig LicenseConfig}, which will
224
+ # become the final component of the
225
+ # {::Google::Cloud::DiscoveryEngine::V1::LicenseConfig LicenseConfig}'s resource
226
+ # name. We are using the tier (product edition) name as the license config id
227
+ # such as `search` or `search_and_assistant`.
228
+ # @yield [result, operation] Access the result along with the TransportOperation object
229
+ # @yieldparam result [::Google::Cloud::DiscoveryEngine::V1::LicenseConfig]
230
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
231
+ #
232
+ # @return [::Google::Cloud::DiscoveryEngine::V1::LicenseConfig]
233
+ #
234
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
235
+ #
236
+ # @example Basic example
237
+ # require "google/cloud/discovery_engine/v1"
238
+ #
239
+ # # Create a client object. The client can be reused for multiple calls.
240
+ # client = Google::Cloud::DiscoveryEngine::V1::LicenseConfigService::Rest::Client.new
241
+ #
242
+ # # Create a request. To set request fields, pass in keyword arguments.
243
+ # request = Google::Cloud::DiscoveryEngine::V1::CreateLicenseConfigRequest.new
244
+ #
245
+ # # Call the create_license_config method.
246
+ # result = client.create_license_config request
247
+ #
248
+ # # The returned object is of type Google::Cloud::DiscoveryEngine::V1::LicenseConfig.
249
+ # p result
250
+ #
251
+ def create_license_config request, options = nil
252
+ raise ::ArgumentError, "request must be provided" if request.nil?
253
+
254
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DiscoveryEngine::V1::CreateLicenseConfigRequest
255
+
256
+ # Converts hash and nil to an options object
257
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
258
+
259
+ # Customize the options with defaults
260
+ call_metadata = @config.rpcs.create_license_config.metadata.to_h
261
+
262
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
263
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
264
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
265
+ gapic_version: ::Google::Cloud::DiscoveryEngine::V1::VERSION,
266
+ transports_version_send: [:rest]
267
+
268
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
269
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
270
+
271
+ options.apply_defaults timeout: @config.rpcs.create_license_config.timeout,
272
+ metadata: call_metadata,
273
+ retry_policy: @config.rpcs.create_license_config.retry_policy
274
+
275
+ options.apply_defaults timeout: @config.timeout,
276
+ metadata: @config.metadata,
277
+ retry_policy: @config.retry_policy
278
+
279
+ @license_config_service_stub.create_license_config request, options do |result, operation|
280
+ yield result, operation if block_given?
281
+ end
282
+ rescue ::Gapic::Rest::Error => e
283
+ raise ::Google::Cloud::Error.from_error(e)
284
+ end
285
+
286
+ ##
287
+ # Updates the {::Google::Cloud::DiscoveryEngine::V1::LicenseConfig LicenseConfig}
288
+ #
289
+ # @overload update_license_config(request, options = nil)
290
+ # Pass arguments to `update_license_config` via a request object, either of type
291
+ # {::Google::Cloud::DiscoveryEngine::V1::UpdateLicenseConfigRequest} or an equivalent Hash.
292
+ #
293
+ # @param request [::Google::Cloud::DiscoveryEngine::V1::UpdateLicenseConfigRequest, ::Hash]
294
+ # A request object representing the call parameters. Required. To specify no
295
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
296
+ # @param options [::Gapic::CallOptions, ::Hash]
297
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
298
+ #
299
+ # @overload update_license_config(license_config: nil, update_mask: nil)
300
+ # Pass arguments to `update_license_config` via keyword arguments. Note that at
301
+ # least one keyword argument is required. To specify no parameters, or to keep all
302
+ # the default parameter values, pass an empty Hash as a request object (see above).
303
+ #
304
+ # @param license_config [::Google::Cloud::DiscoveryEngine::V1::LicenseConfig, ::Hash]
305
+ # Required. The
306
+ # {::Google::Cloud::DiscoveryEngine::V1::LicenseConfig LicenseConfig} to update.
307
+ # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
308
+ # Optional. Indicates which fields in the provided
309
+ # {::Google::Cloud::DiscoveryEngine::V1::LicenseConfig LicenseConfig} to update.
310
+ #
311
+ # If an unsupported or unknown field is provided, an INVALID_ARGUMENT error
312
+ # is returned.
313
+ # @yield [result, operation] Access the result along with the TransportOperation object
314
+ # @yieldparam result [::Google::Cloud::DiscoveryEngine::V1::LicenseConfig]
315
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
316
+ #
317
+ # @return [::Google::Cloud::DiscoveryEngine::V1::LicenseConfig]
318
+ #
319
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
320
+ #
321
+ # @example Basic example
322
+ # require "google/cloud/discovery_engine/v1"
323
+ #
324
+ # # Create a client object. The client can be reused for multiple calls.
325
+ # client = Google::Cloud::DiscoveryEngine::V1::LicenseConfigService::Rest::Client.new
326
+ #
327
+ # # Create a request. To set request fields, pass in keyword arguments.
328
+ # request = Google::Cloud::DiscoveryEngine::V1::UpdateLicenseConfigRequest.new
329
+ #
330
+ # # Call the update_license_config method.
331
+ # result = client.update_license_config request
332
+ #
333
+ # # The returned object is of type Google::Cloud::DiscoveryEngine::V1::LicenseConfig.
334
+ # p result
335
+ #
336
+ def update_license_config request, options = nil
337
+ raise ::ArgumentError, "request must be provided" if request.nil?
338
+
339
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DiscoveryEngine::V1::UpdateLicenseConfigRequest
340
+
341
+ # Converts hash and nil to an options object
342
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
343
+
344
+ # Customize the options with defaults
345
+ call_metadata = @config.rpcs.update_license_config.metadata.to_h
346
+
347
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
348
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
349
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
350
+ gapic_version: ::Google::Cloud::DiscoveryEngine::V1::VERSION,
351
+ transports_version_send: [:rest]
352
+
353
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
354
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
355
+
356
+ options.apply_defaults timeout: @config.rpcs.update_license_config.timeout,
357
+ metadata: call_metadata,
358
+ retry_policy: @config.rpcs.update_license_config.retry_policy
359
+
360
+ options.apply_defaults timeout: @config.timeout,
361
+ metadata: @config.metadata,
362
+ retry_policy: @config.retry_policy
363
+
364
+ @license_config_service_stub.update_license_config request, options do |result, operation|
365
+ yield result, operation if block_given?
366
+ end
367
+ rescue ::Gapic::Rest::Error => e
368
+ raise ::Google::Cloud::Error.from_error(e)
369
+ end
370
+
371
+ ##
372
+ # Gets a {::Google::Cloud::DiscoveryEngine::V1::LicenseConfig LicenseConfig}.
373
+ #
374
+ # @overload get_license_config(request, options = nil)
375
+ # Pass arguments to `get_license_config` via a request object, either of type
376
+ # {::Google::Cloud::DiscoveryEngine::V1::GetLicenseConfigRequest} or an equivalent Hash.
377
+ #
378
+ # @param request [::Google::Cloud::DiscoveryEngine::V1::GetLicenseConfigRequest, ::Hash]
379
+ # A request object representing the call parameters. Required. To specify no
380
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
381
+ # @param options [::Gapic::CallOptions, ::Hash]
382
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
383
+ #
384
+ # @overload get_license_config(name: nil)
385
+ # Pass arguments to `get_license_config` via keyword arguments. Note that at
386
+ # least one keyword argument is required. To specify no parameters, or to keep all
387
+ # the default parameter values, pass an empty Hash as a request object (see above).
388
+ #
389
+ # @param name [::String]
390
+ # Required. Full resource name of
391
+ # {::Google::Cloud::DiscoveryEngine::V1::LicenseConfig LicenseConfig}, such as
392
+ # `projects/{project}/locations/{location}/licenseConfigs/*`.
393
+ #
394
+ # If the caller does not have permission to access the
395
+ # {::Google::Cloud::DiscoveryEngine::V1::LicenseConfig LicenseConfig}, regardless
396
+ # of whether or not it exists, a PERMISSION_DENIED error is returned.
397
+ #
398
+ # If the requested
399
+ # {::Google::Cloud::DiscoveryEngine::V1::LicenseConfig LicenseConfig} does not
400
+ # exist, a NOT_FOUND error is returned.
401
+ # @yield [result, operation] Access the result along with the TransportOperation object
402
+ # @yieldparam result [::Google::Cloud::DiscoveryEngine::V1::LicenseConfig]
403
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
404
+ #
405
+ # @return [::Google::Cloud::DiscoveryEngine::V1::LicenseConfig]
406
+ #
407
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
408
+ #
409
+ # @example Basic example
410
+ # require "google/cloud/discovery_engine/v1"
411
+ #
412
+ # # Create a client object. The client can be reused for multiple calls.
413
+ # client = Google::Cloud::DiscoveryEngine::V1::LicenseConfigService::Rest::Client.new
414
+ #
415
+ # # Create a request. To set request fields, pass in keyword arguments.
416
+ # request = Google::Cloud::DiscoveryEngine::V1::GetLicenseConfigRequest.new
417
+ #
418
+ # # Call the get_license_config method.
419
+ # result = client.get_license_config request
420
+ #
421
+ # # The returned object is of type Google::Cloud::DiscoveryEngine::V1::LicenseConfig.
422
+ # p result
423
+ #
424
+ def get_license_config request, options = nil
425
+ raise ::ArgumentError, "request must be provided" if request.nil?
426
+
427
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DiscoveryEngine::V1::GetLicenseConfigRequest
428
+
429
+ # Converts hash and nil to an options object
430
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
431
+
432
+ # Customize the options with defaults
433
+ call_metadata = @config.rpcs.get_license_config.metadata.to_h
434
+
435
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
436
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
437
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
438
+ gapic_version: ::Google::Cloud::DiscoveryEngine::V1::VERSION,
439
+ transports_version_send: [:rest]
440
+
441
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
442
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
443
+
444
+ options.apply_defaults timeout: @config.rpcs.get_license_config.timeout,
445
+ metadata: call_metadata,
446
+ retry_policy: @config.rpcs.get_license_config.retry_policy
447
+
448
+ options.apply_defaults timeout: @config.timeout,
449
+ metadata: @config.metadata,
450
+ retry_policy: @config.retry_policy
451
+
452
+ @license_config_service_stub.get_license_config request, options do |result, operation|
453
+ yield result, operation if block_given?
454
+ end
455
+ rescue ::Gapic::Rest::Error => e
456
+ raise ::Google::Cloud::Error.from_error(e)
457
+ end
458
+
459
+ ##
460
+ # Lists all the
461
+ # {::Google::Cloud::DiscoveryEngine::V1::LicenseConfig LicenseConfig}s associated
462
+ # with the project.
463
+ #
464
+ # @overload list_license_configs(request, options = nil)
465
+ # Pass arguments to `list_license_configs` via a request object, either of type
466
+ # {::Google::Cloud::DiscoveryEngine::V1::ListLicenseConfigsRequest} or an equivalent Hash.
467
+ #
468
+ # @param request [::Google::Cloud::DiscoveryEngine::V1::ListLicenseConfigsRequest, ::Hash]
469
+ # A request object representing the call parameters. Required. To specify no
470
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
471
+ # @param options [::Gapic::CallOptions, ::Hash]
472
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
473
+ #
474
+ # @overload list_license_configs(parent: nil, page_size: nil, page_token: nil, filter: nil)
475
+ # Pass arguments to `list_license_configs` via keyword arguments. Note that at
476
+ # least one keyword argument is required. To specify no parameters, or to keep all
477
+ # the default parameter values, pass an empty Hash as a request object (see above).
478
+ #
479
+ # @param parent [::String]
480
+ # Required. The parent branch resource name, such as
481
+ # `projects/{project}/locations/{location}`.
482
+ # @param page_size [::Integer]
483
+ # Optional. Not supported.
484
+ # @param page_token [::String]
485
+ # Optional. Not supported.
486
+ # @param filter [::String]
487
+ # Optional. The filter to apply to the list results.
488
+ #
489
+ # The supported fields are:
490
+ #
491
+ # * `subscription_tier`
492
+ # * `state`
493
+ #
494
+ # Examples:
495
+ #
496
+ # * `subscription_tier=SUBSCRIPTION_TIER_SEARCH,state=ACTIVE` - Lists all
497
+ # active search license configs.
498
+ # * `state=ACTIVE` - Lists all active license configs.
499
+ #
500
+ # The filter string should be a comma-separated list of field=value pairs.
501
+ # @yield [result, operation] Access the result along with the TransportOperation object
502
+ # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::DiscoveryEngine::V1::LicenseConfig>]
503
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
504
+ #
505
+ # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::DiscoveryEngine::V1::LicenseConfig>]
506
+ #
507
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
508
+ #
509
+ # @example Basic example
510
+ # require "google/cloud/discovery_engine/v1"
511
+ #
512
+ # # Create a client object. The client can be reused for multiple calls.
513
+ # client = Google::Cloud::DiscoveryEngine::V1::LicenseConfigService::Rest::Client.new
514
+ #
515
+ # # Create a request. To set request fields, pass in keyword arguments.
516
+ # request = Google::Cloud::DiscoveryEngine::V1::ListLicenseConfigsRequest.new
517
+ #
518
+ # # Call the list_license_configs method.
519
+ # result = client.list_license_configs request
520
+ #
521
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
522
+ # # over elements, and API calls will be issued to fetch pages as needed.
523
+ # result.each do |item|
524
+ # # Each element is of type ::Google::Cloud::DiscoveryEngine::V1::LicenseConfig.
525
+ # p item
526
+ # end
527
+ #
528
+ def list_license_configs request, options = nil
529
+ raise ::ArgumentError, "request must be provided" if request.nil?
530
+
531
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DiscoveryEngine::V1::ListLicenseConfigsRequest
532
+
533
+ # Converts hash and nil to an options object
534
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
535
+
536
+ # Customize the options with defaults
537
+ call_metadata = @config.rpcs.list_license_configs.metadata.to_h
538
+
539
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
540
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
541
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
542
+ gapic_version: ::Google::Cloud::DiscoveryEngine::V1::VERSION,
543
+ transports_version_send: [:rest]
544
+
545
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
546
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
547
+
548
+ options.apply_defaults timeout: @config.rpcs.list_license_configs.timeout,
549
+ metadata: call_metadata,
550
+ retry_policy: @config.rpcs.list_license_configs.retry_policy
551
+
552
+ options.apply_defaults timeout: @config.timeout,
553
+ metadata: @config.metadata,
554
+ retry_policy: @config.retry_policy
555
+
556
+ @license_config_service_stub.list_license_configs request, options do |result, operation|
557
+ result = ::Gapic::Rest::PagedEnumerable.new @license_config_service_stub, :list_license_configs, "license_configs", request, result, options
558
+ yield result, operation if block_given?
559
+ throw :response, result
560
+ end
561
+ rescue ::Gapic::Rest::Error => e
562
+ raise ::Google::Cloud::Error.from_error(e)
563
+ end
564
+
565
+ ##
566
+ # Distributes a
567
+ # {::Google::Cloud::DiscoveryEngine::V1::LicenseConfig LicenseConfig} from billing
568
+ # account level to project level.
569
+ #
570
+ # @overload distribute_license_config(request, options = nil)
571
+ # Pass arguments to `distribute_license_config` via a request object, either of type
572
+ # {::Google::Cloud::DiscoveryEngine::V1::DistributeLicenseConfigRequest} or an equivalent Hash.
573
+ #
574
+ # @param request [::Google::Cloud::DiscoveryEngine::V1::DistributeLicenseConfigRequest, ::Hash]
575
+ # A request object representing the call parameters. Required. To specify no
576
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
577
+ # @param options [::Gapic::CallOptions, ::Hash]
578
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
579
+ #
580
+ # @overload distribute_license_config(billing_account_license_config: nil, project_number: nil, location: nil, license_count: nil, license_config_id: nil)
581
+ # Pass arguments to `distribute_license_config` via keyword arguments. Note that at
582
+ # least one keyword argument is required. To specify no parameters, or to keep all
583
+ # the default parameter values, pass an empty Hash as a request object (see above).
584
+ #
585
+ # @param billing_account_license_config [::String]
586
+ # Required. Full resource name of [BillingAccountLicenseConfig][].
587
+ #
588
+ # Format:
589
+ # `billingAccounts/{billing_account}/billingAccountLicenseConfigs/{billing_account_license_config_id}`.
590
+ # @param project_number [::Integer]
591
+ # Required. The target GCP project number to distribute the license config
592
+ # to.
593
+ # @param location [::String]
594
+ # Required. The target GCP project region to distribute the license config
595
+ # to.
596
+ # @param license_count [::Integer]
597
+ # Required. The number of licenses to distribute.
598
+ # @param license_config_id [::String]
599
+ # Optional. Distribute seats to this license config instead of creating a new
600
+ # one. If not specified, a new license config will be created from the
601
+ # billing account license config.
602
+ # @yield [result, operation] Access the result along with the TransportOperation object
603
+ # @yieldparam result [::Google::Cloud::DiscoveryEngine::V1::DistributeLicenseConfigResponse]
604
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
605
+ #
606
+ # @return [::Google::Cloud::DiscoveryEngine::V1::DistributeLicenseConfigResponse]
607
+ #
608
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
609
+ #
610
+ # @example Basic example
611
+ # require "google/cloud/discovery_engine/v1"
612
+ #
613
+ # # Create a client object. The client can be reused for multiple calls.
614
+ # client = Google::Cloud::DiscoveryEngine::V1::LicenseConfigService::Rest::Client.new
615
+ #
616
+ # # Create a request. To set request fields, pass in keyword arguments.
617
+ # request = Google::Cloud::DiscoveryEngine::V1::DistributeLicenseConfigRequest.new
618
+ #
619
+ # # Call the distribute_license_config method.
620
+ # result = client.distribute_license_config request
621
+ #
622
+ # # The returned object is of type Google::Cloud::DiscoveryEngine::V1::DistributeLicenseConfigResponse.
623
+ # p result
624
+ #
625
+ def distribute_license_config request, options = nil
626
+ raise ::ArgumentError, "request must be provided" if request.nil?
627
+
628
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DiscoveryEngine::V1::DistributeLicenseConfigRequest
629
+
630
+ # Converts hash and nil to an options object
631
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
632
+
633
+ # Customize the options with defaults
634
+ call_metadata = @config.rpcs.distribute_license_config.metadata.to_h
635
+
636
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
637
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
638
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
639
+ gapic_version: ::Google::Cloud::DiscoveryEngine::V1::VERSION,
640
+ transports_version_send: [:rest]
641
+
642
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
643
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
644
+
645
+ options.apply_defaults timeout: @config.rpcs.distribute_license_config.timeout,
646
+ metadata: call_metadata,
647
+ retry_policy: @config.rpcs.distribute_license_config.retry_policy
648
+
649
+ options.apply_defaults timeout: @config.timeout,
650
+ metadata: @config.metadata,
651
+ retry_policy: @config.retry_policy
652
+
653
+ @license_config_service_stub.distribute_license_config request, options do |result, operation|
654
+ yield result, operation if block_given?
655
+ end
656
+ rescue ::Gapic::Rest::Error => e
657
+ raise ::Google::Cloud::Error.from_error(e)
658
+ end
659
+
660
+ ##
661
+ # This method is called from the billing account side to retract the
662
+ # {::Google::Cloud::DiscoveryEngine::V1::LicenseConfig LicenseConfig} from the
663
+ # given project back to the billing account.
664
+ #
665
+ # @overload retract_license_config(request, options = nil)
666
+ # Pass arguments to `retract_license_config` via a request object, either of type
667
+ # {::Google::Cloud::DiscoveryEngine::V1::RetractLicenseConfigRequest} or an equivalent Hash.
668
+ #
669
+ # @param request [::Google::Cloud::DiscoveryEngine::V1::RetractLicenseConfigRequest, ::Hash]
670
+ # A request object representing the call parameters. Required. To specify no
671
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
672
+ # @param options [::Gapic::CallOptions, ::Hash]
673
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
674
+ #
675
+ # @overload retract_license_config(billing_account_license_config: nil, license_config: nil, full_retract: nil, license_count: nil)
676
+ # Pass arguments to `retract_license_config` via keyword arguments. Note that at
677
+ # least one keyword argument is required. To specify no parameters, or to keep all
678
+ # the default parameter values, pass an empty Hash as a request object (see above).
679
+ #
680
+ # @param billing_account_license_config [::String]
681
+ # Required. Full resource name of [BillingAccountLicenseConfig][].
682
+ #
683
+ # Format:
684
+ # `billingAccounts/{billing_account}/billingAccountLicenseConfigs/{billing_account_license_config_id}`.
685
+ # @param license_config [::String]
686
+ # Required. Full resource name of
687
+ # {::Google::Cloud::DiscoveryEngine::V1::LicenseConfig LicenseConfig}.
688
+ #
689
+ # Format:
690
+ # `projects/{project}/locations/{location}/licenseConfigs/{license_config_id}`.
691
+ # @param full_retract [::Boolean]
692
+ # Optional. If set to true, retract the entire license config. Otherwise,
693
+ # retract the specified license count.
694
+ # @param license_count [::Integer]
695
+ # Optional. The number of licenses to retract. Only used when full_retract is
696
+ # false.
697
+ # @yield [result, operation] Access the result along with the TransportOperation object
698
+ # @yieldparam result [::Google::Cloud::DiscoveryEngine::V1::RetractLicenseConfigResponse]
699
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
700
+ #
701
+ # @return [::Google::Cloud::DiscoveryEngine::V1::RetractLicenseConfigResponse]
702
+ #
703
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
704
+ #
705
+ # @example Basic example
706
+ # require "google/cloud/discovery_engine/v1"
707
+ #
708
+ # # Create a client object. The client can be reused for multiple calls.
709
+ # client = Google::Cloud::DiscoveryEngine::V1::LicenseConfigService::Rest::Client.new
710
+ #
711
+ # # Create a request. To set request fields, pass in keyword arguments.
712
+ # request = Google::Cloud::DiscoveryEngine::V1::RetractLicenseConfigRequest.new
713
+ #
714
+ # # Call the retract_license_config method.
715
+ # result = client.retract_license_config request
716
+ #
717
+ # # The returned object is of type Google::Cloud::DiscoveryEngine::V1::RetractLicenseConfigResponse.
718
+ # p result
719
+ #
720
+ def retract_license_config request, options = nil
721
+ raise ::ArgumentError, "request must be provided" if request.nil?
722
+
723
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DiscoveryEngine::V1::RetractLicenseConfigRequest
724
+
725
+ # Converts hash and nil to an options object
726
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
727
+
728
+ # Customize the options with defaults
729
+ call_metadata = @config.rpcs.retract_license_config.metadata.to_h
730
+
731
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
732
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
733
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
734
+ gapic_version: ::Google::Cloud::DiscoveryEngine::V1::VERSION,
735
+ transports_version_send: [:rest]
736
+
737
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
738
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
739
+
740
+ options.apply_defaults timeout: @config.rpcs.retract_license_config.timeout,
741
+ metadata: call_metadata,
742
+ retry_policy: @config.rpcs.retract_license_config.retry_policy
743
+
744
+ options.apply_defaults timeout: @config.timeout,
745
+ metadata: @config.metadata,
746
+ retry_policy: @config.retry_policy
747
+
748
+ @license_config_service_stub.retract_license_config request, options do |result, operation|
749
+ yield result, operation if block_given?
750
+ end
751
+ rescue ::Gapic::Rest::Error => e
752
+ raise ::Google::Cloud::Error.from_error(e)
753
+ end
754
+
755
+ ##
756
+ # Configuration class for the LicenseConfigService REST API.
757
+ #
758
+ # This class represents the configuration for LicenseConfigService REST,
759
+ # providing control over timeouts, retry behavior, logging, transport
760
+ # parameters, and other low-level controls. Certain parameters can also be
761
+ # applied individually to specific RPCs. See
762
+ # {::Google::Cloud::DiscoveryEngine::V1::LicenseConfigService::Rest::Client::Configuration::Rpcs}
763
+ # for a list of RPCs that can be configured independently.
764
+ #
765
+ # Configuration can be applied globally to all clients, or to a single client
766
+ # on construction.
767
+ #
768
+ # @example
769
+ #
770
+ # # Modify the global config, setting the timeout for
771
+ # # create_license_config to 20 seconds,
772
+ # # and all remaining timeouts to 10 seconds.
773
+ # ::Google::Cloud::DiscoveryEngine::V1::LicenseConfigService::Rest::Client.configure do |config|
774
+ # config.timeout = 10.0
775
+ # config.rpcs.create_license_config.timeout = 20.0
776
+ # end
777
+ #
778
+ # # Apply the above configuration only to a new client.
779
+ # client = ::Google::Cloud::DiscoveryEngine::V1::LicenseConfigService::Rest::Client.new do |config|
780
+ # config.timeout = 10.0
781
+ # config.rpcs.create_license_config.timeout = 20.0
782
+ # end
783
+ #
784
+ # @!attribute [rw] endpoint
785
+ # A custom service endpoint, as a hostname or hostname:port. The default is
786
+ # nil, indicating to use the default endpoint in the current universe domain.
787
+ # @return [::String,nil]
788
+ # @!attribute [rw] credentials
789
+ # Credentials to send with calls. You may provide any of the following types:
790
+ # * (`String`) The path to a service account key file in JSON format
791
+ # * (`Hash`) A service account key as a Hash
792
+ # * (`Google::Auth::Credentials`) A googleauth credentials object
793
+ # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
794
+ # * (`Signet::OAuth2::Client`) A signet oauth2 client object
795
+ # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
796
+ # * (`nil`) indicating no credentials
797
+ #
798
+ # Warning: If you accept a credential configuration (JSON file or Hash) from an
799
+ # external source for authentication to Google Cloud, you must validate it before
800
+ # providing it to a Google API client library. Providing an unvalidated credential
801
+ # configuration to Google APIs can compromise the security of your systems and data.
802
+ # For more information, refer to [Validate credential configurations from external
803
+ # sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
804
+ # @return [::Object]
805
+ # @!attribute [rw] scope
806
+ # The OAuth scopes
807
+ # @return [::Array<::String>]
808
+ # @!attribute [rw] lib_name
809
+ # The library name as recorded in instrumentation and logging
810
+ # @return [::String]
811
+ # @!attribute [rw] lib_version
812
+ # The library version as recorded in instrumentation and logging
813
+ # @return [::String]
814
+ # @!attribute [rw] timeout
815
+ # The call timeout in seconds.
816
+ # @return [::Numeric]
817
+ # @!attribute [rw] metadata
818
+ # Additional headers to be sent with the call.
819
+ # @return [::Hash{::Symbol=>::String}]
820
+ # @!attribute [rw] retry_policy
821
+ # The retry policy. The value is a hash with the following keys:
822
+ # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
823
+ # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
824
+ # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
825
+ # * `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
826
+ # * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
827
+ # trigger a retry.
828
+ # @return [::Hash]
829
+ # @!attribute [rw] quota_project
830
+ # A separate project against which to charge quota.
831
+ # @return [::String]
832
+ # @!attribute [rw] universe_domain
833
+ # The universe domain within which to make requests. This determines the
834
+ # default endpoint URL. The default value of nil uses the environment
835
+ # universe (usually the default "googleapis.com" universe).
836
+ # @return [::String,nil]
837
+ # @!attribute [rw] logger
838
+ # A custom logger to use for request/response debug logging, or the value
839
+ # `:default` (the default) to construct a default logger, or `nil` to
840
+ # explicitly disable logging.
841
+ # @return [::Logger,:default,nil]
842
+ #
843
+ class Configuration
844
+ extend ::Gapic::Config
845
+
846
+ # @private
847
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
848
+ DEFAULT_ENDPOINT = "discoveryengine.googleapis.com"
849
+
850
+ config_attr :endpoint, nil, ::String, nil
851
+ config_attr :credentials, nil do |value|
852
+ allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Google::Auth::BaseClient, ::Signet::OAuth2::Client, nil]
853
+ allowed.any? { |klass| klass === value }
854
+ end
855
+ config_attr :scope, nil, ::String, ::Array, nil
856
+ config_attr :lib_name, nil, ::String, nil
857
+ config_attr :lib_version, nil, ::String, nil
858
+ config_attr :timeout, nil, ::Numeric, nil
859
+ config_attr :metadata, nil, ::Hash, nil
860
+ config_attr :retry_policy, nil, ::Hash, ::Proc, nil
861
+ config_attr :quota_project, nil, ::String, nil
862
+ config_attr :universe_domain, nil, ::String, nil
863
+ config_attr :logger, :default, ::Logger, nil, :default
864
+
865
+ # @private
866
+ def initialize parent_config = nil
867
+ @parent_config = parent_config unless parent_config.nil?
868
+
869
+ yield self if block_given?
870
+ end
871
+
872
+ ##
873
+ # Configurations for individual RPCs
874
+ # @return [Rpcs]
875
+ #
876
+ def rpcs
877
+ @rpcs ||= begin
878
+ parent_rpcs = nil
879
+ parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
880
+ Rpcs.new parent_rpcs
881
+ end
882
+ end
883
+
884
+ ##
885
+ # Configuration RPC class for the LicenseConfigService API.
886
+ #
887
+ # Includes fields providing the configuration for each RPC in this service.
888
+ # Each configuration object is of type `Gapic::Config::Method` and includes
889
+ # the following configuration fields:
890
+ #
891
+ # * `timeout` (*type:* `Numeric`) - The call timeout in seconds
892
+ # * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers
893
+ # * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
894
+ # include the following keys:
895
+ # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
896
+ # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
897
+ # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
898
+ # * `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
899
+ # * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
900
+ # trigger a retry.
901
+ #
902
+ class Rpcs
903
+ ##
904
+ # RPC-specific configuration for `create_license_config`
905
+ # @return [::Gapic::Config::Method]
906
+ #
907
+ attr_reader :create_license_config
908
+ ##
909
+ # RPC-specific configuration for `update_license_config`
910
+ # @return [::Gapic::Config::Method]
911
+ #
912
+ attr_reader :update_license_config
913
+ ##
914
+ # RPC-specific configuration for `get_license_config`
915
+ # @return [::Gapic::Config::Method]
916
+ #
917
+ attr_reader :get_license_config
918
+ ##
919
+ # RPC-specific configuration for `list_license_configs`
920
+ # @return [::Gapic::Config::Method]
921
+ #
922
+ attr_reader :list_license_configs
923
+ ##
924
+ # RPC-specific configuration for `distribute_license_config`
925
+ # @return [::Gapic::Config::Method]
926
+ #
927
+ attr_reader :distribute_license_config
928
+ ##
929
+ # RPC-specific configuration for `retract_license_config`
930
+ # @return [::Gapic::Config::Method]
931
+ #
932
+ attr_reader :retract_license_config
933
+
934
+ # @private
935
+ def initialize parent_rpcs = nil
936
+ create_license_config_config = parent_rpcs.create_license_config if parent_rpcs.respond_to? :create_license_config
937
+ @create_license_config = ::Gapic::Config::Method.new create_license_config_config
938
+ update_license_config_config = parent_rpcs.update_license_config if parent_rpcs.respond_to? :update_license_config
939
+ @update_license_config = ::Gapic::Config::Method.new update_license_config_config
940
+ get_license_config_config = parent_rpcs.get_license_config if parent_rpcs.respond_to? :get_license_config
941
+ @get_license_config = ::Gapic::Config::Method.new get_license_config_config
942
+ list_license_configs_config = parent_rpcs.list_license_configs if parent_rpcs.respond_to? :list_license_configs
943
+ @list_license_configs = ::Gapic::Config::Method.new list_license_configs_config
944
+ distribute_license_config_config = parent_rpcs.distribute_license_config if parent_rpcs.respond_to? :distribute_license_config
945
+ @distribute_license_config = ::Gapic::Config::Method.new distribute_license_config_config
946
+ retract_license_config_config = parent_rpcs.retract_license_config if parent_rpcs.respond_to? :retract_license_config
947
+ @retract_license_config = ::Gapic::Config::Method.new retract_license_config_config
948
+
949
+ yield self if block_given?
950
+ end
951
+ end
952
+ end
953
+ end
954
+ end
955
+ end
956
+ end
957
+ end
958
+ end
959
+ end