google-cloud-discovery_engine-v1beta 0.27.0 → 0.28.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 (252) hide show
  1. checksums.yaml +4 -4
  2. data/AUTHENTICATION.md +4 -4
  3. data/README.md +4 -4
  4. data/lib/google/cloud/discovery_engine/v1beta/acl_config_service/client.rb +591 -0
  5. data/lib/google/cloud/discovery_engine/v1beta/acl_config_service/credentials.rb +49 -0
  6. data/lib/google/cloud/discovery_engine/v1beta/acl_config_service/paths.rb +50 -0
  7. data/lib/google/cloud/discovery_engine/v1beta/acl_config_service/rest/client.rb +534 -0
  8. data/lib/google/cloud/discovery_engine/v1beta/acl_config_service/rest/service_stub.rb +204 -0
  9. data/lib/google/cloud/discovery_engine/v1beta/acl_config_service/rest.rb +52 -0
  10. data/lib/google/cloud/discovery_engine/v1beta/acl_config_service.rb +55 -0
  11. data/lib/google/cloud/discovery_engine/v1beta/assistant_service/client.rb +1058 -0
  12. data/lib/google/cloud/discovery_engine/v1beta/assistant_service/credentials.rb +50 -0
  13. data/lib/google/cloud/discovery_engine/v1beta/assistant_service/paths.rb +230 -0
  14. data/lib/google/cloud/discovery_engine/v1beta/assistant_service/rest/client.rb +975 -0
  15. data/lib/google/cloud/discovery_engine/v1beta/assistant_service/rest/service_stub.rb +444 -0
  16. data/lib/google/cloud/discovery_engine/v1beta/assistant_service/rest.rb +52 -0
  17. data/lib/google/cloud/discovery_engine/v1beta/assistant_service.rb +55 -0
  18. data/lib/google/cloud/discovery_engine/v1beta/cmek_config_service/client.rb +823 -0
  19. data/lib/google/cloud/discovery_engine/v1beta/cmek_config_service/credentials.rb +49 -0
  20. data/lib/google/cloud/discovery_engine/v1beta/cmek_config_service/operations.rb +843 -0
  21. data/lib/google/cloud/discovery_engine/v1beta/cmek_config_service/paths.rb +135 -0
  22. data/lib/google/cloud/discovery_engine/v1beta/cmek_config_service/rest/client.rb +752 -0
  23. data/lib/google/cloud/discovery_engine/v1beta/cmek_config_service/rest/operations.rb +1152 -0
  24. data/lib/google/cloud/discovery_engine/v1beta/cmek_config_service/rest/service_stub.rb +341 -0
  25. data/lib/google/cloud/discovery_engine/v1beta/cmek_config_service/rest.rb +53 -0
  26. data/lib/google/cloud/discovery_engine/v1beta/cmek_config_service.rb +56 -0
  27. data/lib/google/cloud/discovery_engine/v1beta/completion_service/client.rb +146 -12
  28. data/lib/google/cloud/discovery_engine/v1beta/completion_service/credentials.rb +5 -1
  29. data/lib/google/cloud/discovery_engine/v1beta/completion_service/rest/client.rb +139 -12
  30. data/lib/google/cloud/discovery_engine/v1beta/completion_service/rest/operations.rb +21 -0
  31. data/lib/google/cloud/discovery_engine/v1beta/completion_service/rest/service_stub.rb +62 -0
  32. data/lib/google/cloud/discovery_engine/v1beta/control_service/credentials.rb +3 -1
  33. data/lib/google/cloud/discovery_engine/v1beta/control_service/paths.rb +53 -0
  34. data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/client.rb +210 -10
  35. data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/credentials.rb +3 -1
  36. data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/paths.rb +46 -0
  37. data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/rest/client.rb +205 -10
  38. data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/rest/service_stub.rb +72 -0
  39. data/lib/google/cloud/discovery_engine/v1beta/data_store_service/client.rb +11 -1
  40. data/lib/google/cloud/discovery_engine/v1beta/data_store_service/credentials.rb +3 -1
  41. data/lib/google/cloud/discovery_engine/v1beta/data_store_service/paths.rb +104 -0
  42. data/lib/google/cloud/discovery_engine/v1beta/data_store_service/rest/client.rb +11 -1
  43. data/lib/google/cloud/discovery_engine/v1beta/data_store_service/rest/operations.rb +21 -0
  44. data/lib/google/cloud/discovery_engine/v1beta/document_service/client.rb +8 -3
  45. data/lib/google/cloud/discovery_engine/v1beta/document_service/credentials.rb +3 -1
  46. data/lib/google/cloud/discovery_engine/v1beta/document_service/rest/client.rb +8 -3
  47. data/lib/google/cloud/discovery_engine/v1beta/document_service/rest/operations.rb +21 -0
  48. data/lib/google/cloud/discovery_engine/v1beta/engine_service/client.rb +224 -6
  49. data/lib/google/cloud/discovery_engine/v1beta/engine_service/credentials.rb +3 -1
  50. data/lib/google/cloud/discovery_engine/v1beta/engine_service/paths.rb +104 -0
  51. data/lib/google/cloud/discovery_engine/v1beta/engine_service/rest/client.rb +210 -6
  52. data/lib/google/cloud/discovery_engine/v1beta/engine_service/rest/operations.rb +21 -0
  53. data/lib/google/cloud/discovery_engine/v1beta/engine_service/rest/service_stub.rb +123 -0
  54. data/lib/google/cloud/discovery_engine/v1beta/evaluation_service/client.rb +11 -9
  55. data/lib/google/cloud/discovery_engine/v1beta/evaluation_service/credentials.rb +4 -1
  56. data/lib/google/cloud/discovery_engine/v1beta/evaluation_service/paths.rb +21 -0
  57. data/lib/google/cloud/discovery_engine/v1beta/evaluation_service/rest/client.rb +11 -9
  58. data/lib/google/cloud/discovery_engine/v1beta/evaluation_service/rest/operations.rb +21 -0
  59. data/lib/google/cloud/discovery_engine/v1beta/grounded_generation_service/credentials.rb +3 -1
  60. data/lib/google/cloud/discovery_engine/v1beta/identity_mapping_store_service/client.rb +1180 -0
  61. data/lib/google/cloud/discovery_engine/v1beta/identity_mapping_store_service/credentials.rb +49 -0
  62. data/lib/google/cloud/discovery_engine/v1beta/identity_mapping_store_service/operations.rb +843 -0
  63. data/lib/google/cloud/discovery_engine/v1beta/identity_mapping_store_service/paths.rb +154 -0
  64. data/lib/google/cloud/discovery_engine/v1beta/identity_mapping_store_service/rest/client.rb +1088 -0
  65. data/lib/google/cloud/discovery_engine/v1beta/identity_mapping_store_service/rest/operations.rb +1152 -0
  66. data/lib/google/cloud/discovery_engine/v1beta/identity_mapping_store_service/rest/service_stub.rb +511 -0
  67. data/lib/google/cloud/discovery_engine/v1beta/identity_mapping_store_service/rest.rb +53 -0
  68. data/lib/google/cloud/discovery_engine/v1beta/identity_mapping_store_service.rb +56 -0
  69. data/lib/google/cloud/discovery_engine/v1beta/license_config_service/client.rb +1050 -0
  70. data/lib/google/cloud/discovery_engine/v1beta/license_config_service/credentials.rb +49 -0
  71. data/lib/google/cloud/discovery_engine/v1beta/license_config_service/paths.rb +86 -0
  72. data/lib/google/cloud/discovery_engine/v1beta/license_config_service/rest/client.rb +965 -0
  73. data/lib/google/cloud/discovery_engine/v1beta/license_config_service/rest/service_stub.rb +451 -0
  74. data/lib/google/cloud/discovery_engine/v1beta/license_config_service/rest.rb +52 -0
  75. data/lib/google/cloud/discovery_engine/v1beta/license_config_service.rb +55 -0
  76. data/lib/google/cloud/discovery_engine/v1beta/project_service/client.rb +3 -1
  77. data/lib/google/cloud/discovery_engine/v1beta/project_service/credentials.rb +3 -1
  78. data/lib/google/cloud/discovery_engine/v1beta/project_service/rest/client.rb +3 -1
  79. data/lib/google/cloud/discovery_engine/v1beta/project_service/rest/operations.rb +21 -0
  80. data/lib/google/cloud/discovery_engine/v1beta/rank_service/client.rb +2 -2
  81. data/lib/google/cloud/discovery_engine/v1beta/rank_service/credentials.rb +3 -1
  82. data/lib/google/cloud/discovery_engine/v1beta/rank_service/rest/client.rb +2 -2
  83. data/lib/google/cloud/discovery_engine/v1beta/recommendation_service/client.rb +2 -2
  84. data/lib/google/cloud/discovery_engine/v1beta/recommendation_service/credentials.rb +3 -1
  85. data/lib/google/cloud/discovery_engine/v1beta/recommendation_service/rest/client.rb +2 -2
  86. data/lib/google/cloud/discovery_engine/v1beta/rest.rb +10 -3
  87. data/lib/google/cloud/discovery_engine/v1beta/sample_query_service/credentials.rb +3 -1
  88. data/lib/google/cloud/discovery_engine/v1beta/sample_query_service/rest/operations.rb +21 -0
  89. data/lib/google/cloud/discovery_engine/v1beta/sample_query_set_service/credentials.rb +3 -1
  90. data/lib/google/cloud/discovery_engine/v1beta/schema_service/credentials.rb +3 -1
  91. data/lib/google/cloud/discovery_engine/v1beta/schema_service/rest/operations.rb +21 -0
  92. data/lib/google/cloud/discovery_engine/v1beta/search_service/client.rb +194 -38
  93. data/lib/google/cloud/discovery_engine/v1beta/search_service/credentials.rb +4 -1
  94. data/lib/google/cloud/discovery_engine/v1beta/search_service/paths.rb +21 -0
  95. data/lib/google/cloud/discovery_engine/v1beta/search_service/rest/client.rb +194 -38
  96. data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/credentials.rb +3 -1
  97. data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/rest/operations.rb +21 -0
  98. data/lib/google/cloud/discovery_engine/v1beta/serving_config_service/client.rb +207 -3
  99. data/lib/google/cloud/discovery_engine/v1beta/serving_config_service/credentials.rb +3 -1
  100. data/lib/google/cloud/discovery_engine/v1beta/serving_config_service/rest/client.rb +193 -3
  101. data/lib/google/cloud/discovery_engine/v1beta/serving_config_service/rest/service_stub.rb +153 -0
  102. data/lib/google/cloud/discovery_engine/v1beta/session_service/client.rb +25 -9
  103. data/lib/google/cloud/discovery_engine/v1beta/session_service/credentials.rb +4 -1
  104. data/lib/google/cloud/discovery_engine/v1beta/session_service/paths.rb +46 -0
  105. data/lib/google/cloud/discovery_engine/v1beta/session_service/rest/client.rb +25 -9
  106. data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/client.rb +1 -3
  107. data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/credentials.rb +3 -1
  108. data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/rest/client.rb +1 -3
  109. data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/rest/operations.rb +21 -0
  110. data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/rest/service_stub.rb +7 -0
  111. data/lib/google/cloud/discovery_engine/v1beta/user_event_service/client.rb +23 -11
  112. data/lib/google/cloud/discovery_engine/v1beta/user_event_service/credentials.rb +4 -1
  113. data/lib/google/cloud/discovery_engine/v1beta/user_event_service/rest/client.rb +23 -11
  114. data/lib/google/cloud/discovery_engine/v1beta/user_event_service/rest/operations.rb +21 -0
  115. data/lib/google/cloud/discovery_engine/v1beta/user_event_service/rest/service_stub.rb +8 -0
  116. data/lib/google/cloud/discovery_engine/v1beta/user_license_service/client.rb +768 -0
  117. data/lib/google/cloud/discovery_engine/v1beta/user_license_service/credentials.rb +49 -0
  118. data/lib/google/cloud/discovery_engine/v1beta/user_license_service/operations.rb +843 -0
  119. data/lib/google/cloud/discovery_engine/v1beta/user_license_service/paths.rb +71 -0
  120. data/lib/google/cloud/discovery_engine/v1beta/user_license_service/rest/client.rb +704 -0
  121. data/lib/google/cloud/discovery_engine/v1beta/user_license_service/rest/operations.rb +1152 -0
  122. data/lib/google/cloud/discovery_engine/v1beta/user_license_service/rest/service_stub.rb +265 -0
  123. data/lib/google/cloud/discovery_engine/v1beta/user_license_service/rest.rb +53 -0
  124. data/lib/google/cloud/discovery_engine/v1beta/user_license_service.rb +56 -0
  125. data/lib/google/cloud/discovery_engine/v1beta/user_store_service/client.rb +590 -0
  126. data/lib/google/cloud/discovery_engine/v1beta/user_store_service/credentials.rb +49 -0
  127. data/lib/google/cloud/discovery_engine/v1beta/user_store_service/paths.rb +71 -0
  128. data/lib/google/cloud/discovery_engine/v1beta/user_store_service/rest/client.rb +533 -0
  129. data/lib/google/cloud/discovery_engine/v1beta/user_store_service/rest/service_stub.rb +204 -0
  130. data/lib/google/cloud/discovery_engine/v1beta/user_store_service/rest.rb +52 -0
  131. data/lib/google/cloud/discovery_engine/v1beta/user_store_service.rb +55 -0
  132. data/lib/google/cloud/discovery_engine/v1beta/version.rb +1 -1
  133. data/lib/google/cloud/discovery_engine/v1beta.rb +11 -4
  134. data/lib/google/cloud/discoveryengine/v1beta/acl_config_pb.rb +25 -0
  135. data/lib/google/cloud/discoveryengine/v1beta/acl_config_service_pb.rb +28 -0
  136. data/lib/google/cloud/discoveryengine/v1beta/acl_config_service_services_pb.rb +49 -0
  137. data/lib/google/cloud/discoveryengine/v1beta/agent_gateway_setting_pb.rb +25 -0
  138. data/lib/google/cloud/discoveryengine/v1beta/answer_pb.rb +6 -1
  139. data/lib/google/cloud/discoveryengine/v1beta/assist_answer_pb.rb +48 -0
  140. data/lib/google/cloud/discoveryengine/v1beta/assistant_pb.rb +35 -0
  141. data/lib/google/cloud/discoveryengine/v1beta/assistant_service_pb.rb +48 -0
  142. data/lib/google/cloud/discoveryengine/v1beta/assistant_service_services_pb.rb +56 -0
  143. data/lib/google/cloud/discoveryengine/v1beta/chunk_pb.rb +4 -1
  144. data/lib/google/cloud/discoveryengine/v1beta/cmek_config_service_pb.rb +39 -0
  145. data/lib/google/cloud/discoveryengine/v1beta/cmek_config_service_services_pb.rb +55 -0
  146. data/lib/google/cloud/discoveryengine/v1beta/common_pb.rb +12 -1
  147. data/lib/google/cloud/discoveryengine/v1beta/completion_service_pb.rb +4 -1
  148. data/lib/google/cloud/discoveryengine/v1beta/completion_service_services_pb.rb +6 -0
  149. data/lib/google/cloud/discoveryengine/v1beta/control_pb.rb +6 -1
  150. data/lib/google/cloud/discoveryengine/v1beta/control_service_pb.rb +1 -1
  151. data/lib/google/cloud/discoveryengine/v1beta/conversational_search_service_pb.rb +12 -1
  152. data/lib/google/cloud/discoveryengine/v1beta/conversational_search_service_services_pb.rb +8 -0
  153. data/lib/google/cloud/discoveryengine/v1beta/data_store_pb.rb +11 -1
  154. data/lib/google/cloud/discoveryengine/v1beta/data_store_service_pb.rb +1 -1
  155. data/lib/google/cloud/discoveryengine/v1beta/document_pb.rb +4 -1
  156. data/lib/google/cloud/discoveryengine/v1beta/document_processing_config_pb.rb +1 -1
  157. data/lib/google/cloud/discoveryengine/v1beta/document_service_pb.rb +1 -1
  158. data/lib/google/cloud/discoveryengine/v1beta/engine_pb.rb +17 -1
  159. data/lib/google/cloud/discoveryengine/v1beta/engine_service_pb.rb +3 -1
  160. data/lib/google/cloud/discoveryengine/v1beta/engine_service_services_pb.rb +28 -6
  161. data/lib/google/cloud/discoveryengine/v1beta/evaluation_pb.rb +1 -1
  162. data/lib/google/cloud/discoveryengine/v1beta/evaluation_service_pb.rb +1 -1
  163. data/lib/google/cloud/discoveryengine/v1beta/feedback_pb.rb +28 -0
  164. data/lib/google/cloud/discoveryengine/v1beta/grounded_generation_service_pb.rb +11 -1
  165. data/lib/google/cloud/discoveryengine/v1beta/grounding_pb.rb +1 -1
  166. data/lib/google/cloud/discoveryengine/v1beta/identity_mapping_store_pb.rb +26 -0
  167. data/lib/google/cloud/discoveryengine/v1beta/identity_mapping_store_service_pb.rb +44 -0
  168. data/lib/google/cloud/discoveryengine/v1beta/identity_mapping_store_service_services_pb.rb +58 -0
  169. data/lib/google/cloud/discoveryengine/v1beta/import_config_pb.rb +1 -1
  170. data/lib/google/cloud/discoveryengine/v1beta/license_config_pb.rb +27 -0
  171. data/lib/google/cloud/discoveryengine/v1beta/license_config_service_pb.rb +36 -0
  172. data/lib/google/cloud/discoveryengine/v1beta/license_config_service_services_pb.rb +65 -0
  173. data/lib/google/cloud/discoveryengine/v1beta/logging_pb.rb +24 -0
  174. data/lib/google/cloud/discoveryengine/v1beta/project_pb.rb +10 -1
  175. data/lib/google/cloud/discoveryengine/v1beta/project_service_pb.rb +2 -1
  176. data/lib/google/cloud/discoveryengine/v1beta/rank_service_pb.rb +1 -1
  177. data/lib/google/cloud/discoveryengine/v1beta/recommendation_service_pb.rb +1 -1
  178. data/lib/google/cloud/discoveryengine/v1beta/safety_pb.rb +26 -0
  179. data/lib/google/cloud/discoveryengine/v1beta/sample_query_service_pb.rb +1 -1
  180. data/lib/google/cloud/discoveryengine/v1beta/sample_query_set_service_pb.rb +1 -1
  181. data/lib/google/cloud/discoveryengine/v1beta/schema_service_pb.rb +1 -1
  182. data/lib/google/cloud/discoveryengine/v1beta/search_service_pb.rb +18 -2
  183. data/lib/google/cloud/discoveryengine/v1beta/search_tuning_service_pb.rb +1 -1
  184. data/lib/google/cloud/discoveryengine/v1beta/serving_config_pb.rb +3 -1
  185. data/lib/google/cloud/discoveryengine/v1beta/serving_config_service_pb.rb +4 -1
  186. data/lib/google/cloud/discoveryengine/v1beta/serving_config_service_services_pb.rb +14 -0
  187. data/lib/google/cloud/discoveryengine/v1beta/session_pb.rb +2 -1
  188. data/lib/google/cloud/discoveryengine/v1beta/session_service_pb.rb +1 -1
  189. data/lib/google/cloud/discoveryengine/v1beta/site_search_engine_pb.rb +1 -1
  190. data/lib/google/cloud/discoveryengine/v1beta/site_search_engine_service_pb.rb +1 -1
  191. data/lib/google/cloud/discoveryengine/v1beta/user_event_pb.rb +2 -1
  192. data/lib/google/cloud/discoveryengine/v1beta/user_event_service_pb.rb +1 -1
  193. data/lib/google/cloud/discoveryengine/v1beta/user_license_pb.rb +27 -0
  194. data/lib/google/cloud/discoveryengine/v1beta/user_license_service_pb.rb +38 -0
  195. data/lib/google/cloud/discoveryengine/v1beta/user_license_service_services_pb.rb +52 -0
  196. data/lib/google/cloud/discoveryengine/v1beta/user_store_pb.rb +24 -0
  197. data/lib/google/cloud/discoveryengine/v1beta/user_store_service_pb.rb +29 -0
  198. data/lib/google/cloud/discoveryengine/v1beta/user_store_service_services_pb.rb +47 -0
  199. data/proto_docs/google/cloud/discoveryengine/v1beta/acl_config.rb +43 -0
  200. data/proto_docs/google/cloud/discoveryengine/v1beta/acl_config_service.rb +49 -0
  201. data/proto_docs/google/cloud/discoveryengine/v1beta/agent_gateway_setting.rb +53 -0
  202. data/proto_docs/google/cloud/discoveryengine/v1beta/answer.rb +117 -2
  203. data/proto_docs/google/cloud/discoveryengine/v1beta/assist_answer.rb +401 -0
  204. data/proto_docs/google/cloud/discoveryengine/v1beta/assistant.rb +253 -0
  205. data/proto_docs/google/cloud/discoveryengine/v1beta/assistant_service.rb +368 -0
  206. data/proto_docs/google/cloud/discoveryengine/v1beta/chunk.rb +60 -1
  207. data/proto_docs/google/cloud/discoveryengine/v1beta/cmek_config_service.rb +228 -0
  208. data/proto_docs/google/cloud/discoveryengine/v1beta/common.rb +223 -0
  209. data/proto_docs/google/cloud/discoveryengine/v1beta/completion_service.rb +115 -13
  210. data/proto_docs/google/cloud/discoveryengine/v1beta/control.rb +119 -6
  211. data/proto_docs/google/cloud/discoveryengine/v1beta/conversational_search_service.rb +178 -8
  212. data/proto_docs/google/cloud/discoveryengine/v1beta/data_store.rb +218 -9
  213. data/proto_docs/google/cloud/discoveryengine/v1beta/data_store_service.rb +12 -0
  214. data/proto_docs/google/cloud/discoveryengine/v1beta/document.rb +115 -10
  215. data/proto_docs/google/cloud/discoveryengine/v1beta/document_processing_config.rb +30 -0
  216. data/proto_docs/google/cloud/discoveryengine/v1beta/document_service.rb +1 -1
  217. data/proto_docs/google/cloud/discoveryengine/v1beta/engine.rb +388 -8
  218. data/proto_docs/google/cloud/discoveryengine/v1beta/evaluation.rb +2 -2
  219. data/proto_docs/google/cloud/discoveryengine/v1beta/evaluation_service.rb +13 -11
  220. data/proto_docs/google/cloud/discoveryengine/v1beta/feedback.rb +147 -0
  221. data/proto_docs/google/cloud/discoveryengine/v1beta/grounded_generation_service.rb +190 -9
  222. data/proto_docs/google/cloud/discoveryengine/v1beta/grounding.rb +9 -0
  223. data/proto_docs/google/cloud/discoveryengine/v1beta/identity_mapping_store.rb +84 -0
  224. data/proto_docs/google/cloud/discoveryengine/v1beta/identity_mapping_store_service.rb +280 -0
  225. data/proto_docs/google/cloud/discoveryengine/v1beta/import_config.rb +25 -5
  226. data/proto_docs/google/cloud/discoveryengine/v1beta/license_config.rb +101 -0
  227. data/proto_docs/google/cloud/discoveryengine/v1beta/license_config_service.rb +224 -0
  228. data/proto_docs/google/cloud/discoveryengine/v1beta/logging.rb +40 -0
  229. data/proto_docs/google/cloud/discoveryengine/v1beta/project.rb +214 -0
  230. data/proto_docs/google/cloud/discoveryengine/v1beta/project_service.rb +18 -0
  231. data/proto_docs/google/cloud/discoveryengine/v1beta/purge_config.rb +9 -5
  232. data/proto_docs/google/cloud/discoveryengine/v1beta/rank_service.rb +4 -2
  233. data/proto_docs/google/cloud/discoveryengine/v1beta/recommendation_service.rb +2 -2
  234. data/proto_docs/google/cloud/discoveryengine/v1beta/safety.rb +108 -0
  235. data/proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb +461 -69
  236. data/proto_docs/google/cloud/discoveryengine/v1beta/serving_config.rb +50 -3
  237. data/proto_docs/google/cloud/discoveryengine/v1beta/serving_config_service.rb +30 -0
  238. data/proto_docs/google/cloud/discoveryengine/v1beta/session.rb +21 -0
  239. data/proto_docs/google/cloud/discoveryengine/v1beta/site_search_engine.rb +8 -2
  240. data/proto_docs/google/cloud/discoveryengine/v1beta/site_search_engine_service.rb +7 -3
  241. data/proto_docs/google/cloud/discoveryengine/v1beta/user_event.rb +39 -3
  242. data/proto_docs/google/cloud/discoveryengine/v1beta/user_event_service.rb +14 -6
  243. data/proto_docs/google/cloud/discoveryengine/v1beta/user_license.rb +100 -0
  244. data/proto_docs/google/cloud/discoveryengine/v1beta/user_license_service.rb +202 -0
  245. data/proto_docs/google/cloud/discoveryengine/v1beta/user_store.rb +67 -0
  246. data/proto_docs/google/cloud/discoveryengine/v1beta/user_store_service.rb +54 -0
  247. data/proto_docs/google/iam/v1/iam_policy.rb +87 -0
  248. data/proto_docs/google/iam/v1/options.rb +50 -0
  249. data/proto_docs/google/iam/v1/policy.rb +426 -0
  250. data/proto_docs/google/type/expr.rb +75 -0
  251. data/proto_docs/google/type/latlng.rb +38 -0
  252. metadata +118 -1
@@ -91,9 +91,8 @@ module Google
91
91
  # The ranking expression controls the customized ranking on retrieval
92
92
  # documents. To leverage this, document embedding is required. The ranking
93
93
  # expression setting in ServingConfig applies to all search requests served
94
- # by the serving config. However, if
95
- # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#ranking_expression SearchRequest.ranking_expression}
96
- # is specified, it overrides the ServingConfig ranking expression.
94
+ # by the serving config. However, if `SearchRequest.ranking_expression` is
95
+ # specified, it overrides the ServingConfig ranking expression.
97
96
  #
98
97
  # The ranking expression is a single function or multiple functions that are
99
98
  # joined by "+".
@@ -191,6 +190,11 @@ module Google
191
190
  # execute.
192
191
  # Order does not matter.
193
192
  # Maximum number of specifications is 100.
193
+ # @!attribute [rw] promote_control_ids
194
+ # @return [::Array<::String>]
195
+ # Condition promote specifications.
196
+ #
197
+ # Maximum number of specifications is 100.
194
198
  # @!attribute [rw] personalization_spec
195
199
  # @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::PersonalizationSpec]
196
200
  # The specification for personalization spec.
@@ -203,6 +207,9 @@ module Google
203
207
  # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#personalization_spec SearchRequest.personalization_spec}
204
208
  # overrides
205
209
  # {::Google::Cloud::DiscoveryEngine::V1beta::ServingConfig#personalization_spec ServingConfig.personalization_spec}.
210
+ # @!attribute [rw] answer_generation_spec
211
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::AnswerGenerationSpec]
212
+ # Optional. The specification for answer generation.
206
213
  class ServingConfig
207
214
  include ::Google::Protobuf::MessageExts
208
215
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -272,6 +279,46 @@ module Google
272
279
  extend ::Google::Protobuf::MessageExts::ClassMethods
273
280
  end
274
281
  end
282
+
283
+ # The specification for answer generation.
284
+ # @!attribute [rw] user_defined_classifier_spec
285
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::AnswerGenerationSpec::UserDefinedClassifierSpec]
286
+ # Optional. The specification for user specified classifier spec.
287
+ class AnswerGenerationSpec
288
+ include ::Google::Protobuf::MessageExts
289
+ extend ::Google::Protobuf::MessageExts::ClassMethods
290
+
291
+ # The specification for user defined classifier.
292
+ # @!attribute [rw] enable_user_defined_classifier
293
+ # @return [::Boolean]
294
+ # Optional. Whether or not to enable and include user defined classifier.
295
+ # @!attribute [rw] preamble
296
+ # @return [::String]
297
+ # Optional. The preamble to be used for the user defined classifier.
298
+ # @!attribute [rw] model_id
299
+ # @return [::String]
300
+ # Optional. The model id to be used for the user defined classifier.
301
+ # @!attribute [rw] task_marker
302
+ # @return [::String]
303
+ # Optional. The task marker to be used for the user defined classifier.
304
+ # @!attribute [rw] top_p
305
+ # @return [::Float]
306
+ # Optional. The top-p value to be used for the user defined classifier.
307
+ # @!attribute [rw] top_k
308
+ # @return [::Integer]
309
+ # Optional. The top-k value to be used for the user defined classifier.
310
+ # @!attribute [rw] temperature
311
+ # @return [::Float]
312
+ # Optional. The temperature value to be used for the user defined
313
+ # classifier.
314
+ # @!attribute [rw] seed
315
+ # @return [::Integer]
316
+ # Optional. The seed value to be used for the user defined classifier.
317
+ class UserDefinedClassifierSpec
318
+ include ::Google::Protobuf::MessageExts
319
+ extend ::Google::Protobuf::MessageExts::ClassMethods
320
+ end
321
+ end
275
322
  end
276
323
  end
277
324
  end
@@ -21,6 +21,26 @@ module Google
21
21
  module Cloud
22
22
  module DiscoveryEngine
23
23
  module V1beta
24
+ # Request for CreateServingConfig method.
25
+ # @!attribute [rw] parent
26
+ # @return [::String]
27
+ # Required. Full resource name of parent. Format:
28
+ # `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
29
+ # @!attribute [rw] serving_config
30
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::ServingConfig]
31
+ # Required. The ServingConfig to create.
32
+ # @!attribute [rw] serving_config_id
33
+ # @return [::String]
34
+ # Required. The ID to use for the ServingConfig, which will become the final
35
+ # component of the ServingConfig's resource name.
36
+ #
37
+ # This value should be 4-63 characters, and valid characters
38
+ # are /[a-zA-Z0-9][a-zA-Z0-9_-]+/.
39
+ class CreateServingConfigRequest
40
+ include ::Google::Protobuf::MessageExts
41
+ extend ::Google::Protobuf::MessageExts::ClassMethods
42
+ end
43
+
24
44
  # Request for UpdateServingConfig method.
25
45
  # @!attribute [rw] serving_config
26
46
  # @return [::Google::Cloud::DiscoveryEngine::V1beta::ServingConfig]
@@ -39,6 +59,16 @@ module Google
39
59
  extend ::Google::Protobuf::MessageExts::ClassMethods
40
60
  end
41
61
 
62
+ # Request for DeleteServingConfig method.
63
+ # @!attribute [rw] name
64
+ # @return [::String]
65
+ # Required. The resource name of the ServingConfig to delete. Format:
66
+ # `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}`
67
+ class DeleteServingConfigRequest
68
+ include ::Google::Protobuf::MessageExts
69
+ extend ::Google::Protobuf::MessageExts::ClassMethods
70
+ end
71
+
42
72
  # Request for GetServingConfig method.
43
73
  # @!attribute [rw] name
44
74
  # @return [::String]
@@ -41,6 +41,10 @@ module Google
41
41
  # @!attribute [rw] turns
42
42
  # @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::Session::Turn>]
43
43
  # Turns.
44
+ # @!attribute [rw] labels
45
+ # @return [::Array<::String>]
46
+ # Optional. The labels for the session.
47
+ # Can be set as filter in ListSessionsRequest.
44
48
  # @!attribute [r] start_time
45
49
  # @return [::Google::Protobuf::Timestamp]
46
50
  # Output only. The time the session started.
@@ -51,6 +55,12 @@ module Google
51
55
  # @return [::Boolean]
52
56
  # Optional. Whether the session is pinned, pinned session will be displayed
53
57
  # on the top of the session list.
58
+ # @!attribute [r] pending_async_assist_operation_id
59
+ # @return [::String]
60
+ # Output only. Full resource name of an in-progress AsyncAssist operation for
61
+ # this session, e.g.
62
+ # `projects/*/locations/*/collections/*/engines/*/sessions/*/operations/*`.
63
+ # Set when the operation starts and cleared when it finishes.
54
64
  class Session
55
65
  include ::Google::Protobuf::MessageExts
56
66
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -75,12 +85,23 @@ module Google
75
85
  # {::Google::Cloud::DiscoveryEngine::V1beta::GetSessionRequest#include_answer_details GetSessionRequest.include_answer_details}
76
86
  # is set to true, this field will be populated when getting answer query
77
87
  # session.
88
+ # @!attribute [r] detailed_assist_answer
89
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::AssistAnswer]
90
+ # Output only. In
91
+ # {::Google::Cloud::DiscoveryEngine::V1beta::ConversationalSearchService::Client#get_session ConversationalSearchService.GetSession}
92
+ # API, if
93
+ # {::Google::Cloud::DiscoveryEngine::V1beta::GetSessionRequest#include_answer_details GetSessionRequest.include_answer_details}
94
+ # is set to true, this field will be populated when getting assistant
95
+ # session.
78
96
  # @!attribute [rw] query_config
79
97
  # @return [::Google::Protobuf::Map{::String => ::String}]
80
98
  # Optional. Represents metadata related to the query config, for example
81
99
  # LLM model and version used, model parameters (temperature, grounding
82
100
  # parameters, etc.). The prefix "google." is reserved for Google-developed
83
101
  # functionality.
102
+ # @!attribute [rw] live
103
+ # @return [::Boolean]
104
+ # Optional. Indicates whether this turn is a live turn.
84
105
  class Turn
85
106
  include ::Google::Protobuf::MessageExts
86
107
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -48,8 +48,8 @@ module Google
48
48
  # excluded.
49
49
  # @!attribute [rw] exact_match
50
50
  # @return [::Boolean]
51
- # Input only. If set to false, a uri_pattern is generated to include all
52
- # pages whose address contains the provided_uri_pattern. If set to true, an
51
+ # Immutable. If set to false, a uri_pattern is generated to include all pages
52
+ # whose address contains the provided_uri_pattern. If set to true, an
53
53
  # uri_pattern is generated to try to be an exact match of the
54
54
  # provided_uri_pattern or just the specific page if the provided_uri_pattern
55
55
  # is a specific one. provided_uri_pattern is always normalized to
@@ -128,6 +128,12 @@ module Google
128
128
  # 1. target site deleted if unindexing is successful;
129
129
  # 2. state reverts to SUCCEEDED if the unindexing fails.
130
130
  DELETING = 4
131
+
132
+ # The target site change is pending but cancellable.
133
+ CANCELLABLE = 5
134
+
135
+ # The target site change is cancelled.
136
+ CANCELLED = 6
131
137
  end
132
138
  end
133
139
 
@@ -482,9 +482,7 @@ module Google
482
482
  # `site_search_engine`.
483
483
  # @!attribute [rw] site_credential
484
484
  # @return [::String]
485
- # Optional. Full resource name of the [SiteCredential][], such as
486
- # `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/siteCredentials/*`.
487
- # Only set to crawl private URIs.
485
+ # Optional. Credential id to use for crawling.
488
486
  class RecrawlUrisRequest
489
487
  include ::Google::Protobuf::MessageExts
490
488
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -560,6 +558,12 @@ module Google
560
558
  # @!attribute [rw] invalid_uris_count
561
559
  # @return [::Integer]
562
560
  # Total number of unique URIs in the request that have invalid format.
561
+ # @!attribute [rw] noindex_uris
562
+ # @return [::Array<::String>]
563
+ # URIs that have no index meta tag. Sample limited to 1000.
564
+ # @!attribute [rw] noindex_uris_count
565
+ # @return [::Integer]
566
+ # Total number of URIs that have no index meta tag.
563
567
  # @!attribute [rw] uris_not_matching_target_sites
564
568
  # @return [::Array<::String>]
565
569
  # Unique URIs in the request that don't match any TargetSite in the
@@ -34,7 +34,6 @@ module Google
34
34
  # * `view-item-list`: View of a panel or ordered list of Documents.
35
35
  # * `view-home-page`: View of the home page.
36
36
  # * `view-category-page`: View of a category page, e.g. Home > Men > Jeans
37
- # * `add-feedback`: Add a user feedback.
38
37
  #
39
38
  # Retail-related values:
40
39
  #
@@ -45,6 +44,23 @@ module Google
45
44
  #
46
45
  # * `media-play`: Start/resume watching a video, playing a song, etc.
47
46
  # * `media-complete`: Finished or stopped midway through a video, song, etc.
47
+ #
48
+ # Custom conversion value:
49
+ #
50
+ # * `conversion`: Customer defined conversion event.
51
+ # @!attribute [rw] conversion_type
52
+ # @return [::String]
53
+ # Optional. Conversion type.
54
+ #
55
+ # Required if
56
+ # {::Google::Cloud::DiscoveryEngine::V1beta::UserEvent#event_type UserEvent.event_type}
57
+ # is `conversion`. This is a customer-defined conversion name in lowercase
58
+ # letters or numbers separated by "-", such as "watch", "good-visit" etc.
59
+ #
60
+ # Do not set the field if
61
+ # {::Google::Cloud::DiscoveryEngine::V1beta::UserEvent#event_type UserEvent.event_type}
62
+ # is not `conversion`. This mixes the custom conversion event with predefined
63
+ # events like `search`, `view-item` etc.
48
64
  # @!attribute [rw] user_pseudo_id
49
65
  # @return [::String]
50
66
  # Required. A unique identifier for tracking visitors.
@@ -149,8 +165,9 @@ module Google
149
165
  # to this field.
150
166
  # @!attribute [rw] filter
151
167
  # @return [::String]
152
- # The filter syntax consists of an expression language for constructing a
153
- # predicate from one or more fields of the documents being filtered.
168
+ # Optional. The filter syntax consists of an expression language for
169
+ # constructing a predicate from one or more fields of the documents being
170
+ # filtered.
154
171
  #
155
172
  # One example is for `search` events, the associated
156
173
  # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest SearchRequest} may
@@ -249,6 +266,16 @@ module Google
249
266
  # @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::PanelInfo>]
250
267
  # Optional. List of panels associated with this event.
251
268
  # Used for page-level impression data.
269
+ # @!attribute [rw] feedback
270
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::Feedback]
271
+ # Optional. This field is optional except for the `add-feedback` event types.
272
+ # @!attribute [rw] entity
273
+ # @return [::String]
274
+ # Optional. Represents the entity for customers that may run multiple
275
+ # different entities, domains, sites or regions, for example, `Google US`,
276
+ # `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. We recommend that
277
+ # you set `entity` to get better per-entity search, completion, and
278
+ # prediction results.
252
279
  class UserEvent
253
280
  include ::Google::Protobuf::MessageExts
254
281
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -465,6 +492,15 @@ module Google
465
492
  # @return [::Boolean]
466
493
  # Output only. Whether the referenced Document can be found in the data
467
494
  # store.
495
+ # @!attribute [rw] conversion_value
496
+ # @return [::Float]
497
+ # Optional. The conversion value associated with this Document.
498
+ # Must be set if
499
+ # {::Google::Cloud::DiscoveryEngine::V1beta::UserEvent#event_type UserEvent.event_type}
500
+ # is "conversion".
501
+ #
502
+ # For example, a value of 1000 signifies that 1000 seconds were spent viewing
503
+ # a Document for the `watch` conversion type.
468
504
  class DocumentInfo
469
505
  include ::Google::Protobuf::MessageExts
470
506
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -29,11 +29,11 @@ module Google
29
29
  # {::Google::Cloud::DiscoveryEngine::V1beta::DataStore DataStore} level, the
30
30
  # format is:
31
31
  # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
32
- # If the write user event action is applied in [Location][] level, for
33
- # example, the event with
34
- # {::Google::Cloud::DiscoveryEngine::V1beta::Document Document} across multiple
35
- # {::Google::Cloud::DiscoveryEngine::V1beta::DataStore DataStore}, the format is:
36
- # `projects/{project}/locations/{location}`.
32
+ # If the write user event action is applied in
33
+ # [Location][google.cloud.location.Location] level, for example, the event
34
+ # with {::Google::Cloud::DiscoveryEngine::V1beta::Document Document} across
35
+ # multiple {::Google::Cloud::DiscoveryEngine::V1beta::DataStore DataStore}, the
36
+ # format is: `projects/{project}/locations/{location}`.
37
37
  # @!attribute [rw] user_event
38
38
  # @return [::Google::Cloud::DiscoveryEngine::V1beta::UserEvent]
39
39
  # Required. User event to write.
@@ -49,8 +49,16 @@ module Google
49
49
  # Request message for CollectUserEvent method.
50
50
  # @!attribute [rw] parent
51
51
  # @return [::String]
52
- # Required. The parent DataStore resource name, such as
52
+ # Required. The parent resource name.
53
+ # If the collect user event action is applied in
54
+ # {::Google::Cloud::DiscoveryEngine::V1beta::DataStore DataStore} level, the
55
+ # format is:
53
56
  # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
57
+ # If the collect user event action is applied in
58
+ # [Location][google.cloud.location.Location] level, for example, the event
59
+ # with {::Google::Cloud::DiscoveryEngine::V1beta::Document Document} across
60
+ # multiple {::Google::Cloud::DiscoveryEngine::V1beta::DataStore DataStore}, the
61
+ # format is: `projects/{project}/locations/{location}`.
54
62
  # @!attribute [rw] user_event
55
63
  # @return [::String]
56
64
  # Required. URL encoded UserEvent proto with a length limit of 2,000,000
@@ -0,0 +1,100 @@
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
+
20
+ module Google
21
+ module Cloud
22
+ module DiscoveryEngine
23
+ module V1beta
24
+ # User License information assigned by the admin.
25
+ # @!attribute [rw] user_principal
26
+ # @return [::String]
27
+ # Required. Immutable. The user principal of the User, could be email address
28
+ # or other prinical identifier. This field is immutable. Admin assign
29
+ # licenses based on the user principal.
30
+ # @!attribute [rw] user_profile
31
+ # @return [::String]
32
+ # Optional. The user profile.
33
+ # We user user full name(First name + Last name) as user profile.
34
+ # @!attribute [r] license_assignment_state
35
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::UserLicense::LicenseAssignmentState]
36
+ # Output only. License assignment state of the user.
37
+ # If the user is assigned with a license config, the user login will be
38
+ # assigned with the license;
39
+ # If the user's license assignment state is unassigned or unspecified, no
40
+ # license config will be associated to the user;
41
+ # @!attribute [rw] license_config
42
+ # @return [::String]
43
+ # Optional. The full resource name of the Subscription(LicenseConfig)
44
+ # assigned to the user.
45
+ # @!attribute [r] create_time
46
+ # @return [::Google::Protobuf::Timestamp]
47
+ # Output only. User created timestamp.
48
+ # @!attribute [r] update_time
49
+ # @return [::Google::Protobuf::Timestamp]
50
+ # Output only. User update timestamp.
51
+ # @!attribute [r] last_login_time
52
+ # @return [::Google::Protobuf::Timestamp]
53
+ # Output only. User last logged in time.
54
+ # If the user has not logged in yet, this field will be empty.
55
+ class UserLicense
56
+ include ::Google::Protobuf::MessageExts
57
+ extend ::Google::Protobuf::MessageExts::ClassMethods
58
+
59
+ # License assignment state enumeration.
60
+ module LicenseAssignmentState
61
+ # Default value.
62
+ LICENSE_ASSIGNMENT_STATE_UNSPECIFIED = 0
63
+
64
+ # License assigned to the user.
65
+ ASSIGNED = 1
66
+
67
+ # No license assigned to the user.
68
+ # Deprecated, translated to NO_LICENSE.
69
+ UNASSIGNED = 2
70
+
71
+ # No license assigned to the user.
72
+ NO_LICENSE = 3
73
+
74
+ # User attempted to login but no license assigned to the user.
75
+ # This state is only used for no user first time login attempt but cannot
76
+ # get license assigned.
77
+ # Users already logged in but cannot get license assigned will be assigned
78
+ # NO_LICENSE state(License could be unassigned by admin).
79
+ NO_LICENSE_ATTEMPTED_LOGIN = 4
80
+
81
+ # User is blocked from assigning a license.
82
+ BLOCKED = 5
83
+ end
84
+ end
85
+
86
+ # Stats about users' licenses.
87
+ # @!attribute [rw] license_config
88
+ # @return [::String]
89
+ # Required. The LicenseConfig name.
90
+ # @!attribute [rw] used_license_count
91
+ # @return [::Integer]
92
+ # Required. The number of licenses used.
93
+ class LicenseConfigUsageStats
94
+ include ::Google::Protobuf::MessageExts
95
+ extend ::Google::Protobuf::MessageExts::ClassMethods
96
+ end
97
+ end
98
+ end
99
+ end
100
+ end
@@ -0,0 +1,202 @@
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
+
20
+ module Google
21
+ module Cloud
22
+ module DiscoveryEngine
23
+ module V1beta
24
+ # Request message for
25
+ # {::Google::Cloud::DiscoveryEngine::V1beta::UserLicenseService::Client#list_user_licenses UserLicenseService.ListUserLicenses}.
26
+ # @!attribute [rw] parent
27
+ # @return [::String]
28
+ # Required. The parent
29
+ # {::Google::Cloud::DiscoveryEngine::V1beta::UserStore UserStore} resource name,
30
+ # format:
31
+ # `projects/{project}/locations/{location}/userStores/{user_store_id}`.
32
+ # @!attribute [rw] page_size
33
+ # @return [::Integer]
34
+ # Optional. Requested page size. Server may return fewer items than
35
+ # requested. If unspecified, defaults to 10. The maximum value is 50; values
36
+ # above 50 will be coerced to 50.
37
+ #
38
+ # If this field is negative, an INVALID_ARGUMENT error is returned.
39
+ # @!attribute [rw] page_token
40
+ # @return [::String]
41
+ # Optional. A page token, received from a previous `ListUserLicenses` call.
42
+ # Provide this to retrieve the subsequent page.
43
+ #
44
+ # When paginating, all other parameters provided to `ListUserLicenses`
45
+ # must match the call that provided the page token.
46
+ # @!attribute [rw] filter
47
+ # @return [::String]
48
+ # Optional. Filter for the list request.
49
+ #
50
+ # Supported fields:
51
+ #
52
+ # * `license_assignment_state`
53
+ # * `user_principal`
54
+ # *
55
+ # Examples:
56
+ #
57
+ # * `license_assignment_state = ASSIGNED` to list assigned user licenses.
58
+ # * `license_assignment_state = NO_LICENSE` to list not licensed users.
59
+ # * `license_assignment_state = NO_LICENSE_ATTEMPTED_LOGIN` to list users
60
+ # who attempted login but no license assigned.
61
+ # * `license_assignment_state != NO_LICENSE_ATTEMPTED_LOGIN` to filter
62
+ # out users who attempted login but no license assigned.
63
+ # * `user_principal = user1@example.com` to list user license for
64
+ # `user1@example.com`.
65
+ # @!attribute [rw] order_by
66
+ # @return [::String]
67
+ # Optional. The order in which the
68
+ # {::Google::Cloud::DiscoveryEngine::V1beta::UserLicense UserLicense}s are listed.
69
+ # The value must be a comma-separated list of fields. Default sorting order
70
+ # is ascending. To specify descending order for a field, append a " desc"
71
+ # suffix. Redundant space characters in the syntax are insignificant.
72
+ #
73
+ # Supported fields (only `user_principal` is supported for now):
74
+ #
75
+ # * `user_principal`
76
+ #
77
+ # If not set, the default ordering is by `user_principal`.
78
+ #
79
+ # Examples:
80
+ #
81
+ # * `user_principal` to order by `user_principal` in ascending order.
82
+ # * `user_principal desc` to order by `user_principal` in descending order.
83
+ class ListUserLicensesRequest
84
+ include ::Google::Protobuf::MessageExts
85
+ extend ::Google::Protobuf::MessageExts::ClassMethods
86
+ end
87
+
88
+ # Response message for
89
+ # {::Google::Cloud::DiscoveryEngine::V1beta::UserLicenseService::Client#list_user_licenses UserLicenseService.ListUserLicenses}.
90
+ # @!attribute [rw] user_licenses
91
+ # @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::UserLicense>]
92
+ # All the customer's
93
+ # {::Google::Cloud::DiscoveryEngine::V1beta::UserLicense UserLicense}s.
94
+ # @!attribute [rw] next_page_token
95
+ # @return [::String]
96
+ # A token, which can be sent as `page_token` to retrieve the next page. If
97
+ # this field is omitted, there are no subsequent pages.
98
+ class ListUserLicensesResponse
99
+ include ::Google::Protobuf::MessageExts
100
+ extend ::Google::Protobuf::MessageExts::ClassMethods
101
+ end
102
+
103
+ # Request message for
104
+ # {::Google::Cloud::DiscoveryEngine::V1beta::UserLicenseService::Client#list_license_configs_usage_stats UserLicenseService.ListLicenseConfigsUsageStats}
105
+ # method.
106
+ # @!attribute [rw] parent
107
+ # @return [::String]
108
+ # Required. The parent branch resource name, such as
109
+ # `projects/{project}/locations/{location}/userStores/{user_store_id}`.
110
+ class ListLicenseConfigsUsageStatsRequest
111
+ include ::Google::Protobuf::MessageExts
112
+ extend ::Google::Protobuf::MessageExts::ClassMethods
113
+ end
114
+
115
+ # Response message for
116
+ # {::Google::Cloud::DiscoveryEngine::V1beta::UserLicenseService::Client#list_license_configs_usage_stats UserLicenseService.ListLicenseConfigsUsageStats}
117
+ # method.
118
+ # @!attribute [rw] license_config_usage_stats
119
+ # @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::LicenseConfigUsageStats>]
120
+ # All the customer's
121
+ # {::Google::Cloud::DiscoveryEngine::V1beta::LicenseConfigUsageStats LicenseConfigUsageStats}.
122
+ class ListLicenseConfigsUsageStatsResponse
123
+ include ::Google::Protobuf::MessageExts
124
+ extend ::Google::Protobuf::MessageExts::ClassMethods
125
+ end
126
+
127
+ # Request message for
128
+ # {::Google::Cloud::DiscoveryEngine::V1beta::UserLicenseService::Client#batch_update_user_licenses UserLicenseService.BatchUpdateUserLicenses}
129
+ # method.
130
+ # @!attribute [rw] inline_source
131
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::BatchUpdateUserLicensesRequest::InlineSource]
132
+ # The inline source for the input content for document embeddings.
133
+ # @!attribute [rw] parent
134
+ # @return [::String]
135
+ # Required. The parent
136
+ # {::Google::Cloud::DiscoveryEngine::V1beta::UserStore UserStore} resource name,
137
+ # format:
138
+ # `projects/{project}/locations/{location}/userStores/{user_store_id}`.
139
+ # @!attribute [rw] delete_unassigned_user_licenses
140
+ # @return [::Boolean]
141
+ # Optional. If true, if user licenses removed associated license config, the
142
+ # user license will be deleted. By default which is false, the user license
143
+ # will be updated to unassigned state.
144
+ class BatchUpdateUserLicensesRequest
145
+ include ::Google::Protobuf::MessageExts
146
+ extend ::Google::Protobuf::MessageExts::ClassMethods
147
+
148
+ # The inline source for the input config for BatchUpdateUserLicenses
149
+ # method.
150
+ # @!attribute [rw] user_licenses
151
+ # @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::UserLicense>]
152
+ # Required. A list of user licenses to update. Each user license
153
+ # must have a valid
154
+ # {::Google::Cloud::DiscoveryEngine::V1beta::UserLicense#user_principal UserLicense.user_principal}.
155
+ # @!attribute [rw] update_mask
156
+ # @return [::Google::Protobuf::FieldMask]
157
+ # Optional. The list of fields to update.
158
+ class InlineSource
159
+ include ::Google::Protobuf::MessageExts
160
+ extend ::Google::Protobuf::MessageExts::ClassMethods
161
+ end
162
+ end
163
+
164
+ # Metadata related to the progress of the
165
+ # {::Google::Cloud::DiscoveryEngine::V1beta::UserLicenseService::Client#batch_update_user_licenses UserLicenseService.BatchUpdateUserLicenses}
166
+ # operation. This will be returned by the google.longrunning.Operation.metadata
167
+ # field.
168
+ # @!attribute [rw] create_time
169
+ # @return [::Google::Protobuf::Timestamp]
170
+ # Operation create time.
171
+ # @!attribute [rw] update_time
172
+ # @return [::Google::Protobuf::Timestamp]
173
+ # Operation last update time. If the operation is done, this is also the
174
+ # finish time.
175
+ # @!attribute [rw] success_count
176
+ # @return [::Integer]
177
+ # Count of user licenses successfully updated.
178
+ # @!attribute [rw] failure_count
179
+ # @return [::Integer]
180
+ # Count of user licenses that failed to be updated.
181
+ class BatchUpdateUserLicensesMetadata
182
+ include ::Google::Protobuf::MessageExts
183
+ extend ::Google::Protobuf::MessageExts::ClassMethods
184
+ end
185
+
186
+ # Response message for
187
+ # {::Google::Cloud::DiscoveryEngine::V1beta::UserLicenseService::Client#batch_update_user_licenses UserLicenseService.BatchUpdateUserLicenses}
188
+ # method.
189
+ # @!attribute [rw] user_licenses
190
+ # @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::UserLicense>]
191
+ # UserLicenses successfully updated.
192
+ # @!attribute [rw] error_samples
193
+ # @return [::Array<::Google::Rpc::Status>]
194
+ # A sample of errors encountered while processing the request.
195
+ class BatchUpdateUserLicensesResponse
196
+ include ::Google::Protobuf::MessageExts
197
+ extend ::Google::Protobuf::MessageExts::ClassMethods
198
+ end
199
+ end
200
+ end
201
+ end
202
+ end