google-cloud-sql 0.1.1__py3-none-any.whl

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 (274) hide show
  1. google/cloud/sqladmin/__init__.py +605 -0
  2. google/cloud/sqladmin/gapic_version.py +16 -0
  3. google/cloud/sqladmin/py.typed +2 -0
  4. google/cloud/sqladmin_v1/__init__.py +616 -0
  5. google/cloud/sqladmin_v1/_compat.py +262 -0
  6. google/cloud/sqladmin_v1/gapic_metadata.json +959 -0
  7. google/cloud/sqladmin_v1/gapic_version.py +16 -0
  8. google/cloud/sqladmin_v1/py.typed +2 -0
  9. google/cloud/sqladmin_v1/services/__init__.py +15 -0
  10. google/cloud/sqladmin_v1/services/sql_available_database_versions_service/__init__.py +22 -0
  11. google/cloud/sqladmin_v1/services/sql_available_database_versions_service/async_client.py +336 -0
  12. google/cloud/sqladmin_v1/services/sql_available_database_versions_service/client.py +613 -0
  13. google/cloud/sqladmin_v1/services/sql_available_database_versions_service/transports/__init__.py +34 -0
  14. google/cloud/sqladmin_v1/services/sql_available_database_versions_service/transports/base.py +159 -0
  15. google/cloud/sqladmin_v1/services/sql_available_database_versions_service/transports/grpc.py +339 -0
  16. google/cloud/sqladmin_v1/services/sql_available_database_versions_service/transports/grpc_asyncio.py +356 -0
  17. google/cloud/sqladmin_v1/services/sql_backup_runs_service/__init__.py +22 -0
  18. google/cloud/sqladmin_v1/services/sql_backup_runs_service/async_client.py +697 -0
  19. google/cloud/sqladmin_v1/services/sql_backup_runs_service/client.py +977 -0
  20. google/cloud/sqladmin_v1/services/sql_backup_runs_service/pagers.py +199 -0
  21. google/cloud/sqladmin_v1/services/sql_backup_runs_service/transports/__init__.py +32 -0
  22. google/cloud/sqladmin_v1/services/sql_backup_runs_service/transports/base.py +225 -0
  23. google/cloud/sqladmin_v1/services/sql_backup_runs_service/transports/grpc.py +456 -0
  24. google/cloud/sqladmin_v1/services/sql_backup_runs_service/transports/grpc_asyncio.py +495 -0
  25. google/cloud/sqladmin_v1/services/sql_backups_service/__init__.py +22 -0
  26. google/cloud/sqladmin_v1/services/sql_backups_service/async_client.py +946 -0
  27. google/cloud/sqladmin_v1/services/sql_backups_service/client.py +1244 -0
  28. google/cloud/sqladmin_v1/services/sql_backups_service/pagers.py +197 -0
  29. google/cloud/sqladmin_v1/services/sql_backups_service/transports/__init__.py +32 -0
  30. google/cloud/sqladmin_v1/services/sql_backups_service/transports/base.py +237 -0
  31. google/cloud/sqladmin_v1/services/sql_backups_service/transports/grpc.py +478 -0
  32. google/cloud/sqladmin_v1/services/sql_backups_service/transports/grpc_asyncio.py +527 -0
  33. google/cloud/sqladmin_v1/services/sql_connect_service/__init__.py +22 -0
  34. google/cloud/sqladmin_v1/services/sql_connect_service/async_client.py +591 -0
  35. google/cloud/sqladmin_v1/services/sql_connect_service/client.py +867 -0
  36. google/cloud/sqladmin_v1/services/sql_connect_service/transports/__init__.py +32 -0
  37. google/cloud/sqladmin_v1/services/sql_connect_service/transports/base.py +215 -0
  38. google/cloud/sqladmin_v1/services/sql_connect_service/transports/grpc.py +430 -0
  39. google/cloud/sqladmin_v1/services/sql_connect_service/transports/grpc_asyncio.py +464 -0
  40. google/cloud/sqladmin_v1/services/sql_databases_service/__init__.py +22 -0
  41. google/cloud/sqladmin_v1/services/sql_databases_service/async_client.py +872 -0
  42. google/cloud/sqladmin_v1/services/sql_databases_service/client.py +1152 -0
  43. google/cloud/sqladmin_v1/services/sql_databases_service/transports/__init__.py +32 -0
  44. google/cloud/sqladmin_v1/services/sql_databases_service/transports/base.py +251 -0
  45. google/cloud/sqladmin_v1/services/sql_databases_service/transports/grpc.py +515 -0
  46. google/cloud/sqladmin_v1/services/sql_databases_service/transports/grpc_asyncio.py +568 -0
  47. google/cloud/sqladmin_v1/services/sql_events_service/__init__.py +22 -0
  48. google/cloud/sqladmin_v1/services/sql_events_service/async_client.py +311 -0
  49. google/cloud/sqladmin_v1/services/sql_events_service/client.py +593 -0
  50. google/cloud/sqladmin_v1/services/sql_events_service/transports/__init__.py +32 -0
  51. google/cloud/sqladmin_v1/services/sql_events_service/transports/base.py +159 -0
  52. google/cloud/sqladmin_v1/services/sql_events_service/transports/grpc.py +337 -0
  53. google/cloud/sqladmin_v1/services/sql_events_service/transports/grpc_asyncio.py +354 -0
  54. google/cloud/sqladmin_v1/services/sql_feature_eligibility_service/__init__.py +22 -0
  55. google/cloud/sqladmin_v1/services/sql_feature_eligibility_service/async_client.py +327 -0
  56. google/cloud/sqladmin_v1/services/sql_feature_eligibility_service/client.py +605 -0
  57. google/cloud/sqladmin_v1/services/sql_feature_eligibility_service/transports/__init__.py +32 -0
  58. google/cloud/sqladmin_v1/services/sql_feature_eligibility_service/transports/base.py +159 -0
  59. google/cloud/sqladmin_v1/services/sql_feature_eligibility_service/transports/grpc.py +337 -0
  60. google/cloud/sqladmin_v1/services/sql_feature_eligibility_service/transports/grpc_asyncio.py +356 -0
  61. google/cloud/sqladmin_v1/services/sql_flags_service/__init__.py +22 -0
  62. google/cloud/sqladmin_v1/services/sql_flags_service/async_client.py +386 -0
  63. google/cloud/sqladmin_v1/services/sql_flags_service/client.py +667 -0
  64. google/cloud/sqladmin_v1/services/sql_flags_service/transports/__init__.py +32 -0
  65. google/cloud/sqladmin_v1/services/sql_flags_service/transports/base.py +181 -0
  66. google/cloud/sqladmin_v1/services/sql_flags_service/transports/grpc.py +367 -0
  67. google/cloud/sqladmin_v1/services/sql_flags_service/transports/grpc_asyncio.py +391 -0
  68. google/cloud/sqladmin_v1/services/sql_iam_policies_service/__init__.py +22 -0
  69. google/cloud/sqladmin_v1/services/sql_iam_policies_service/async_client.py +315 -0
  70. google/cloud/sqladmin_v1/services/sql_iam_policies_service/client.py +593 -0
  71. google/cloud/sqladmin_v1/services/sql_iam_policies_service/transports/__init__.py +32 -0
  72. google/cloud/sqladmin_v1/services/sql_iam_policies_service/transports/base.py +159 -0
  73. google/cloud/sqladmin_v1/services/sql_iam_policies_service/transports/grpc.py +336 -0
  74. google/cloud/sqladmin_v1/services/sql_iam_policies_service/transports/grpc_asyncio.py +353 -0
  75. google/cloud/sqladmin_v1/services/sql_instance_names_service/__init__.py +22 -0
  76. google/cloud/sqladmin_v1/services/sql_instance_names_service/async_client.py +321 -0
  77. google/cloud/sqladmin_v1/services/sql_instance_names_service/client.py +595 -0
  78. google/cloud/sqladmin_v1/services/sql_instance_names_service/transports/__init__.py +32 -0
  79. google/cloud/sqladmin_v1/services/sql_instance_names_service/transports/base.py +159 -0
  80. google/cloud/sqladmin_v1/services/sql_instance_names_service/transports/grpc.py +336 -0
  81. google/cloud/sqladmin_v1/services/sql_instance_names_service/transports/grpc_asyncio.py +353 -0
  82. google/cloud/sqladmin_v1/services/sql_instances_service/__init__.py +22 -0
  83. google/cloud/sqladmin_v1/services/sql_instances_service/async_client.py +4519 -0
  84. google/cloud/sqladmin_v1/services/sql_instances_service/client.py +4833 -0
  85. google/cloud/sqladmin_v1/services/sql_instances_service/pagers.py +197 -0
  86. google/cloud/sqladmin_v1/services/sql_instances_service/transports/__init__.py +32 -0
  87. google/cloud/sqladmin_v1/services/sql_instances_service/transports/base.py +801 -0
  88. google/cloud/sqladmin_v1/services/sql_instances_service/transports/grpc.py +1661 -0
  89. google/cloud/sqladmin_v1/services/sql_instances_service/transports/grpc_asyncio.py +1904 -0
  90. google/cloud/sqladmin_v1/services/sql_operations_service/__init__.py +22 -0
  91. google/cloud/sqladmin_v1/services/sql_operations_service/async_client.py +591 -0
  92. google/cloud/sqladmin_v1/services/sql_operations_service/client.py +871 -0
  93. google/cloud/sqladmin_v1/services/sql_operations_service/pagers.py +197 -0
  94. google/cloud/sqladmin_v1/services/sql_operations_service/transports/__init__.py +32 -0
  95. google/cloud/sqladmin_v1/services/sql_operations_service/transports/base.py +210 -0
  96. google/cloud/sqladmin_v1/services/sql_operations_service/transports/grpc.py +426 -0
  97. google/cloud/sqladmin_v1/services/sql_operations_service/transports/grpc_asyncio.py +462 -0
  98. google/cloud/sqladmin_v1/services/sql_regions_service/__init__.py +22 -0
  99. google/cloud/sqladmin_v1/services/sql_regions_service/async_client.py +314 -0
  100. google/cloud/sqladmin_v1/services/sql_regions_service/client.py +596 -0
  101. google/cloud/sqladmin_v1/services/sql_regions_service/transports/__init__.py +32 -0
  102. google/cloud/sqladmin_v1/services/sql_regions_service/transports/base.py +159 -0
  103. google/cloud/sqladmin_v1/services/sql_regions_service/transports/grpc.py +338 -0
  104. google/cloud/sqladmin_v1/services/sql_regions_service/transports/grpc_asyncio.py +355 -0
  105. google/cloud/sqladmin_v1/services/sql_ssl_certs_service/__init__.py +22 -0
  106. google/cloud/sqladmin_v1/services/sql_ssl_certs_service/async_client.py +680 -0
  107. google/cloud/sqladmin_v1/services/sql_ssl_certs_service/client.py +960 -0
  108. google/cloud/sqladmin_v1/services/sql_ssl_certs_service/transports/__init__.py +32 -0
  109. google/cloud/sqladmin_v1/services/sql_ssl_certs_service/transports/base.py +226 -0
  110. google/cloud/sqladmin_v1/services/sql_ssl_certs_service/transports/grpc.py +461 -0
  111. google/cloud/sqladmin_v1/services/sql_ssl_certs_service/transports/grpc_asyncio.py +501 -0
  112. google/cloud/sqladmin_v1/services/sql_tiers_service/__init__.py +22 -0
  113. google/cloud/sqladmin_v1/services/sql_tiers_service/async_client.py +395 -0
  114. google/cloud/sqladmin_v1/services/sql_tiers_service/client.py +676 -0
  115. google/cloud/sqladmin_v1/services/sql_tiers_service/transports/__init__.py +32 -0
  116. google/cloud/sqladmin_v1/services/sql_tiers_service/transports/base.py +181 -0
  117. google/cloud/sqladmin_v1/services/sql_tiers_service/transports/grpc.py +369 -0
  118. google/cloud/sqladmin_v1/services/sql_tiers_service/transports/grpc_asyncio.py +393 -0
  119. google/cloud/sqladmin_v1/services/sql_users_service/__init__.py +22 -0
  120. google/cloud/sqladmin_v1/services/sql_users_service/async_client.py +754 -0
  121. google/cloud/sqladmin_v1/services/sql_users_service/client.py +1035 -0
  122. google/cloud/sqladmin_v1/services/sql_users_service/transports/__init__.py +32 -0
  123. google/cloud/sqladmin_v1/services/sql_users_service/transports/base.py +237 -0
  124. google/cloud/sqladmin_v1/services/sql_users_service/transports/grpc.py +477 -0
  125. google/cloud/sqladmin_v1/services/sql_users_service/transports/grpc_asyncio.py +526 -0
  126. google/cloud/sqladmin_v1/types/__init__.py +472 -0
  127. google/cloud/sqladmin_v1/types/cloud_sql_available_database_versions.py +24 -0
  128. google/cloud/sqladmin_v1/types/cloud_sql_backup_runs.py +438 -0
  129. google/cloud/sqladmin_v1/types/cloud_sql_backups.py +467 -0
  130. google/cloud/sqladmin_v1/types/cloud_sql_connect.py +385 -0
  131. google/cloud/sqladmin_v1/types/cloud_sql_databases.py +202 -0
  132. google/cloud/sqladmin_v1/types/cloud_sql_events.py +24 -0
  133. google/cloud/sqladmin_v1/types/cloud_sql_feature_eligibility.py +24 -0
  134. google/cloud/sqladmin_v1/types/cloud_sql_flags.py +272 -0
  135. google/cloud/sqladmin_v1/types/cloud_sql_iam_policies.py +24 -0
  136. google/cloud/sqladmin_v1/types/cloud_sql_instance_names.py +24 -0
  137. google/cloud/sqladmin_v1/types/cloud_sql_instances.py +4514 -0
  138. google/cloud/sqladmin_v1/types/cloud_sql_operations.py +164 -0
  139. google/cloud/sqladmin_v1/types/cloud_sql_regions.py +24 -0
  140. google/cloud/sqladmin_v1/types/cloud_sql_resources.py +4678 -0
  141. google/cloud/sqladmin_v1/types/cloud_sql_ssl_certs.py +220 -0
  142. google/cloud/sqladmin_v1/types/cloud_sql_tiers.py +108 -0
  143. google/cloud/sqladmin_v1/types/cloud_sql_users.py +571 -0
  144. google/cloud/sqladmin_v1beta4/__init__.py +583 -0
  145. google/cloud/sqladmin_v1beta4/_compat.py +262 -0
  146. google/cloud/sqladmin_v1beta4/gapic_metadata.json +1371 -0
  147. google/cloud/sqladmin_v1beta4/gapic_version.py +16 -0
  148. google/cloud/sqladmin_v1beta4/py.typed +2 -0
  149. google/cloud/sqladmin_v1beta4/services/__init__.py +15 -0
  150. google/cloud/sqladmin_v1beta4/services/sql_backup_runs_service/__init__.py +22 -0
  151. google/cloud/sqladmin_v1beta4/services/sql_backup_runs_service/async_client.py +689 -0
  152. google/cloud/sqladmin_v1beta4/services/sql_backup_runs_service/client.py +971 -0
  153. google/cloud/sqladmin_v1beta4/services/sql_backup_runs_service/pagers.py +197 -0
  154. google/cloud/sqladmin_v1beta4/services/sql_backup_runs_service/transports/__init__.py +36 -0
  155. google/cloud/sqladmin_v1beta4/services/sql_backup_runs_service/transports/base.py +223 -0
  156. google/cloud/sqladmin_v1beta4/services/sql_backup_runs_service/transports/grpc.py +449 -0
  157. google/cloud/sqladmin_v1beta4/services/sql_backup_runs_service/transports/grpc_asyncio.py +490 -0
  158. google/cloud/sqladmin_v1beta4/services/sql_backup_runs_service/transports/rest.py +1038 -0
  159. google/cloud/sqladmin_v1beta4/services/sql_backup_runs_service/transports/rest_base.py +150 -0
  160. google/cloud/sqladmin_v1beta4/services/sql_backups_service/__init__.py +22 -0
  161. google/cloud/sqladmin_v1beta4/services/sql_backups_service/async_client.py +941 -0
  162. google/cloud/sqladmin_v1beta4/services/sql_backups_service/client.py +1241 -0
  163. google/cloud/sqladmin_v1beta4/services/sql_backups_service/pagers.py +197 -0
  164. google/cloud/sqladmin_v1beta4/services/sql_backups_service/transports/__init__.py +36 -0
  165. google/cloud/sqladmin_v1beta4/services/sql_backups_service/transports/base.py +234 -0
  166. google/cloud/sqladmin_v1beta4/services/sql_backups_service/transports/grpc.py +470 -0
  167. google/cloud/sqladmin_v1beta4/services/sql_backups_service/transports/grpc_asyncio.py +521 -0
  168. google/cloud/sqladmin_v1beta4/services/sql_backups_service/transports/rest.py +1238 -0
  169. google/cloud/sqladmin_v1beta4/services/sql_backups_service/transports/rest_base.py +175 -0
  170. google/cloud/sqladmin_v1beta4/services/sql_connect_service/__init__.py +22 -0
  171. google/cloud/sqladmin_v1beta4/services/sql_connect_service/async_client.py +591 -0
  172. google/cloud/sqladmin_v1beta4/services/sql_connect_service/client.py +869 -0
  173. google/cloud/sqladmin_v1beta4/services/sql_connect_service/transports/__init__.py +36 -0
  174. google/cloud/sqladmin_v1beta4/services/sql_connect_service/transports/base.py +215 -0
  175. google/cloud/sqladmin_v1beta4/services/sql_connect_service/transports/grpc.py +430 -0
  176. google/cloud/sqladmin_v1beta4/services/sql_connect_service/transports/grpc_asyncio.py +464 -0
  177. google/cloud/sqladmin_v1beta4/services/sql_connect_service/transports/rest.py +852 -0
  178. google/cloud/sqladmin_v1beta4/services/sql_connect_service/transports/rest_base.py +138 -0
  179. google/cloud/sqladmin_v1beta4/services/sql_data_service/__init__.py +22 -0
  180. google/cloud/sqladmin_v1beta4/services/sql_data_service/async_client.py +444 -0
  181. google/cloud/sqladmin_v1beta4/services/sql_data_service/client.py +739 -0
  182. google/cloud/sqladmin_v1beta4/services/sql_data_service/transports/__init__.py +36 -0
  183. google/cloud/sqladmin_v1beta4/services/sql_data_service/transports/base.py +181 -0
  184. google/cloud/sqladmin_v1beta4/services/sql_data_service/transports/grpc.py +407 -0
  185. google/cloud/sqladmin_v1beta4/services/sql_data_service/transports/grpc_asyncio.py +431 -0
  186. google/cloud/sqladmin_v1beta4/services/sql_data_service/transports/rest.py +213 -0
  187. google/cloud/sqladmin_v1beta4/services/sql_data_service/transports/rest_base.py +97 -0
  188. google/cloud/sqladmin_v1beta4/services/sql_databases_service/__init__.py +22 -0
  189. google/cloud/sqladmin_v1beta4/services/sql_databases_service/async_client.py +860 -0
  190. google/cloud/sqladmin_v1beta4/services/sql_databases_service/client.py +1142 -0
  191. google/cloud/sqladmin_v1beta4/services/sql_databases_service/transports/__init__.py +36 -0
  192. google/cloud/sqladmin_v1beta4/services/sql_databases_service/transports/base.py +251 -0
  193. google/cloud/sqladmin_v1beta4/services/sql_databases_service/transports/grpc.py +502 -0
  194. google/cloud/sqladmin_v1beta4/services/sql_databases_service/transports/grpc_asyncio.py +561 -0
  195. google/cloud/sqladmin_v1beta4/services/sql_databases_service/transports/rest.py +1468 -0
  196. google/cloud/sqladmin_v1beta4/services/sql_databases_service/transports/rest_base.py +180 -0
  197. google/cloud/sqladmin_v1beta4/services/sql_flags_service/__init__.py +22 -0
  198. google/cloud/sqladmin_v1beta4/services/sql_flags_service/async_client.py +386 -0
  199. google/cloud/sqladmin_v1beta4/services/sql_flags_service/client.py +669 -0
  200. google/cloud/sqladmin_v1beta4/services/sql_flags_service/transports/__init__.py +36 -0
  201. google/cloud/sqladmin_v1beta4/services/sql_flags_service/transports/base.py +181 -0
  202. google/cloud/sqladmin_v1beta4/services/sql_flags_service/transports/grpc.py +365 -0
  203. google/cloud/sqladmin_v1beta4/services/sql_flags_service/transports/grpc_asyncio.py +389 -0
  204. google/cloud/sqladmin_v1beta4/services/sql_flags_service/transports/rest.py +392 -0
  205. google/cloud/sqladmin_v1beta4/services/sql_flags_service/transports/rest_base.py +107 -0
  206. google/cloud/sqladmin_v1beta4/services/sql_iam_policies_service/__init__.py +22 -0
  207. google/cloud/sqladmin_v1beta4/services/sql_iam_policies_service/async_client.py +315 -0
  208. google/cloud/sqladmin_v1beta4/services/sql_iam_policies_service/client.py +595 -0
  209. google/cloud/sqladmin_v1beta4/services/sql_iam_policies_service/transports/__init__.py +39 -0
  210. google/cloud/sqladmin_v1beta4/services/sql_iam_policies_service/transports/base.py +159 -0
  211. google/cloud/sqladmin_v1beta4/services/sql_iam_policies_service/transports/grpc.py +336 -0
  212. google/cloud/sqladmin_v1beta4/services/sql_iam_policies_service/transports/grpc_asyncio.py +353 -0
  213. google/cloud/sqladmin_v1beta4/services/sql_iam_policies_service/transports/rest.py +184 -0
  214. google/cloud/sqladmin_v1beta4/services/sql_iam_policies_service/transports/rest_base.py +91 -0
  215. google/cloud/sqladmin_v1beta4/services/sql_instances_service/__init__.py +22 -0
  216. google/cloud/sqladmin_v1beta4/services/sql_instances_service/async_client.py +4399 -0
  217. google/cloud/sqladmin_v1beta4/services/sql_instances_service/client.py +4715 -0
  218. google/cloud/sqladmin_v1beta4/services/sql_instances_service/pagers.py +197 -0
  219. google/cloud/sqladmin_v1beta4/services/sql_instances_service/transports/__init__.py +36 -0
  220. google/cloud/sqladmin_v1beta4/services/sql_instances_service/transports/base.py +801 -0
  221. google/cloud/sqladmin_v1beta4/services/sql_instances_service/transports/grpc.py +1627 -0
  222. google/cloud/sqladmin_v1beta4/services/sql_instances_service/transports/grpc_asyncio.py +1895 -0
  223. google/cloud/sqladmin_v1beta4/services/sql_instances_service/transports/rest.py +9625 -0
  224. google/cloud/sqladmin_v1beta4/services/sql_instances_service/transports/rest_base.py +744 -0
  225. google/cloud/sqladmin_v1beta4/services/sql_operations_service/__init__.py +22 -0
  226. google/cloud/sqladmin_v1beta4/services/sql_operations_service/async_client.py +585 -0
  227. google/cloud/sqladmin_v1beta4/services/sql_operations_service/client.py +867 -0
  228. google/cloud/sqladmin_v1beta4/services/sql_operations_service/pagers.py +197 -0
  229. google/cloud/sqladmin_v1beta4/services/sql_operations_service/transports/__init__.py +36 -0
  230. google/cloud/sqladmin_v1beta4/services/sql_operations_service/transports/base.py +210 -0
  231. google/cloud/sqladmin_v1beta4/services/sql_operations_service/transports/grpc.py +422 -0
  232. google/cloud/sqladmin_v1beta4/services/sql_operations_service/transports/grpc_asyncio.py +458 -0
  233. google/cloud/sqladmin_v1beta4/services/sql_operations_service/transports/rest.py +744 -0
  234. google/cloud/sqladmin_v1beta4/services/sql_operations_service/transports/rest_base.py +136 -0
  235. google/cloud/sqladmin_v1beta4/services/sql_ssl_certs_service/__init__.py +22 -0
  236. google/cloud/sqladmin_v1beta4/services/sql_ssl_certs_service/async_client.py +672 -0
  237. google/cloud/sqladmin_v1beta4/services/sql_ssl_certs_service/client.py +954 -0
  238. google/cloud/sqladmin_v1beta4/services/sql_ssl_certs_service/transports/__init__.py +36 -0
  239. google/cloud/sqladmin_v1beta4/services/sql_ssl_certs_service/transports/base.py +226 -0
  240. google/cloud/sqladmin_v1beta4/services/sql_ssl_certs_service/transports/grpc.py +453 -0
  241. google/cloud/sqladmin_v1beta4/services/sql_ssl_certs_service/transports/grpc_asyncio.py +497 -0
  242. google/cloud/sqladmin_v1beta4/services/sql_ssl_certs_service/transports/rest.py +1036 -0
  243. google/cloud/sqladmin_v1beta4/services/sql_ssl_certs_service/transports/rest_base.py +150 -0
  244. google/cloud/sqladmin_v1beta4/services/sql_tiers_service/__init__.py +22 -0
  245. google/cloud/sqladmin_v1beta4/services/sql_tiers_service/async_client.py +393 -0
  246. google/cloud/sqladmin_v1beta4/services/sql_tiers_service/client.py +676 -0
  247. google/cloud/sqladmin_v1beta4/services/sql_tiers_service/transports/__init__.py +36 -0
  248. google/cloud/sqladmin_v1beta4/services/sql_tiers_service/transports/base.py +181 -0
  249. google/cloud/sqladmin_v1beta4/services/sql_tiers_service/transports/grpc.py +368 -0
  250. google/cloud/sqladmin_v1beta4/services/sql_tiers_service/transports/grpc_asyncio.py +392 -0
  251. google/cloud/sqladmin_v1beta4/services/sql_tiers_service/transports/rest.py +396 -0
  252. google/cloud/sqladmin_v1beta4/services/sql_tiers_service/transports/rest_base.py +107 -0
  253. google/cloud/sqladmin_v1beta4/services/sql_users_service/__init__.py +22 -0
  254. google/cloud/sqladmin_v1beta4/services/sql_users_service/async_client.py +754 -0
  255. google/cloud/sqladmin_v1beta4/services/sql_users_service/client.py +1037 -0
  256. google/cloud/sqladmin_v1beta4/services/sql_users_service/transports/__init__.py +36 -0
  257. google/cloud/sqladmin_v1beta4/services/sql_users_service/transports/base.py +237 -0
  258. google/cloud/sqladmin_v1beta4/services/sql_users_service/transports/grpc.py +475 -0
  259. google/cloud/sqladmin_v1beta4/services/sql_users_service/transports/grpc_asyncio.py +524 -0
  260. google/cloud/sqladmin_v1beta4/services/sql_users_service/transports/rest.py +1249 -0
  261. google/cloud/sqladmin_v1beta4/services/sql_users_service/transports/rest_base.py +165 -0
  262. google/cloud/sqladmin_v1beta4/types/__init__.py +480 -0
  263. google/cloud/sqladmin_v1beta4/types/cloud_sql.py +2666 -0
  264. google/cloud/sqladmin_v1beta4/types/cloud_sql_connect.py +386 -0
  265. google/cloud/sqladmin_v1beta4/types/cloud_sql_data.py +339 -0
  266. google/cloud/sqladmin_v1beta4/types/cloud_sql_iam_policies.py +24 -0
  267. google/cloud/sqladmin_v1beta4/types/cloud_sql_resources.py +8111 -0
  268. google/cloud/sqladmin_v1beta4/types/cloud_sql_tiers.py +108 -0
  269. google/cloud/sqladmin_v1beta4/types/cloud_sql_users.py +573 -0
  270. google_cloud_sql-0.1.1.dist-info/METADATA +239 -0
  271. google_cloud_sql-0.1.1.dist-info/RECORD +274 -0
  272. google_cloud_sql-0.1.1.dist-info/WHEEL +5 -0
  273. google_cloud_sql-0.1.1.dist-info/licenses/LICENSE +202 -0
  274. google_cloud_sql-0.1.1.dist-info/top_level.txt +1 -0
@@ -0,0 +1,4678 @@
1
+ # -*- coding: utf-8 -*-
2
+ # Copyright 2026 Google LLC
3
+ #
4
+ # Licensed under the Apache License, Version 2.0 (the "License");
5
+ # you may not use this file except in compliance with the License.
6
+ # You may obtain a copy of the License at
7
+ #
8
+ # http://www.apache.org/licenses/LICENSE-2.0
9
+ #
10
+ # Unless required by applicable law or agreed to in writing, software
11
+ # distributed under the License is distributed on an "AS IS" BASIS,
12
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
+ # See the License for the specific language governing permissions and
14
+ # limitations under the License.
15
+ #
16
+ from __future__ import annotations
17
+
18
+ from typing import MutableMapping, MutableSequence
19
+
20
+ import google.protobuf.duration_pb2 as duration_pb2 # type: ignore
21
+ import google.protobuf.timestamp_pb2 as timestamp_pb2 # type: ignore
22
+ import google.protobuf.wrappers_pb2 as wrappers_pb2 # type: ignore
23
+ import proto # type: ignore
24
+
25
+ __protobuf__ = proto.module(
26
+ package="google.cloud.sql.v1",
27
+ manifest={
28
+ "SqlFileType",
29
+ "BakType",
30
+ "SqlMaintenanceType",
31
+ "SqlBackendType",
32
+ "SqlIpAddressType",
33
+ "SqlDatabaseVersion",
34
+ "SqlPricingPlan",
35
+ "SqlReplicationType",
36
+ "SqlDataDiskType",
37
+ "SqlAvailabilityType",
38
+ "SqlUpdateTrack",
39
+ "AutoDnsStatus",
40
+ "AclEntry",
41
+ "ApiWarning",
42
+ "BackupRetentionSettings",
43
+ "BackupConfiguration",
44
+ "PerformDiskShrinkContext",
45
+ "PreCheckResponse",
46
+ "PreCheckMajorVersionUpgradeContext",
47
+ "BackupContext",
48
+ "Database",
49
+ "SqlServerDatabaseDetails",
50
+ "DatabaseFlags",
51
+ "MySqlSyncConfig",
52
+ "SyncFlags",
53
+ "InstanceReference",
54
+ "DemoteMasterConfiguration",
55
+ "DemoteMasterMySqlReplicaConfiguration",
56
+ "ExportContext",
57
+ "ImportContext",
58
+ "IpConfiguration",
59
+ "PscConfig",
60
+ "PscAutoConnectionConfig",
61
+ "LocationPreference",
62
+ "MaintenanceWindow",
63
+ "DenyMaintenancePeriod",
64
+ "InsightsConfig",
65
+ "MySqlReplicaConfiguration",
66
+ "DiskEncryptionConfiguration",
67
+ "DiskEncryptionStatus",
68
+ "IpMapping",
69
+ "SqlSubOperationType",
70
+ "Operation",
71
+ "OperationError",
72
+ "OperationErrors",
73
+ "PasswordValidationPolicy",
74
+ "DataCacheConfig",
75
+ "FinalBackupConfig",
76
+ "Settings",
77
+ "PerformanceCaptureConfig",
78
+ "ConnectionPoolFlags",
79
+ "ConnectionPoolConfig",
80
+ "ReadPoolAutoScaleConfig",
81
+ "AdvancedMachineFeatures",
82
+ "SslCert",
83
+ "SslCertDetail",
84
+ "SqlActiveDirectoryConfig",
85
+ "SqlServerAuditConfig",
86
+ "SqlServerEntraIdConfig",
87
+ "AcquireSsrsLeaseContext",
88
+ "DnsNameMapping",
89
+ },
90
+ )
91
+
92
+
93
+ class SqlFileType(proto.Enum):
94
+ r"""
95
+
96
+ Values:
97
+ SQL_FILE_TYPE_UNSPECIFIED (0):
98
+ Unknown file type.
99
+ SQL (1):
100
+ File containing SQL statements.
101
+ CSV (2):
102
+ File in CSV format.
103
+ BAK (4):
104
+ No description available.
105
+ TDE (8):
106
+ TDE certificate.
107
+ """
108
+
109
+ SQL_FILE_TYPE_UNSPECIFIED = 0
110
+ SQL = 1
111
+ CSV = 2
112
+ BAK = 4
113
+ TDE = 8
114
+
115
+
116
+ class BakType(proto.Enum):
117
+ r"""
118
+
119
+ Values:
120
+ BAK_TYPE_UNSPECIFIED (0):
121
+ Default type.
122
+ FULL (1):
123
+ Full backup.
124
+ DIFF (2):
125
+ Differential backup.
126
+ TLOG (3):
127
+ Transaction Log backup
128
+ """
129
+
130
+ BAK_TYPE_UNSPECIFIED = 0
131
+ FULL = 1
132
+ DIFF = 2
133
+ TLOG = 3
134
+
135
+
136
+ class SqlMaintenanceType(proto.Enum):
137
+ r"""The type of maintenance to be performed on the instance.
138
+
139
+ Values:
140
+ SQL_MAINTENANCE_TYPE_UNSPECIFIED (0):
141
+ Maintenance type is unspecified.
142
+ INSTANCE_MAINTENANCE (1):
143
+ Indicates that a standalone instance is
144
+ undergoing maintenance. The instance can be
145
+ either a primary instance or a replica.
146
+ REPLICA_INCLUDED_MAINTENANCE (2):
147
+ Indicates that the primary instance and all
148
+ of its replicas, including cascading replicas,
149
+ are undergoing maintenance. Maintenance is
150
+ performed on groups of replicas first, followed
151
+ by the primary instance.
152
+ INSTANCE_SELF_SERVICE_MAINTENANCE (3):
153
+ Indicates that the standalone instance is
154
+ undergoing maintenance, initiated by
155
+ self-service. The instance can be either a
156
+ primary instance or a replica.
157
+ REPLICA_INCLUDED_SELF_SERVICE_MAINTENANCE (4):
158
+ Indicates that the primary instance and all
159
+ of its replicas are undergoing maintenance,
160
+ initiated by self-service. Maintenance is
161
+ performed on groups of replicas first, followed
162
+ by the primary instance.
163
+ """
164
+
165
+ SQL_MAINTENANCE_TYPE_UNSPECIFIED = 0
166
+ INSTANCE_MAINTENANCE = 1
167
+ REPLICA_INCLUDED_MAINTENANCE = 2
168
+ INSTANCE_SELF_SERVICE_MAINTENANCE = 3
169
+ REPLICA_INCLUDED_SELF_SERVICE_MAINTENANCE = 4
170
+
171
+
172
+ class SqlBackendType(proto.Enum):
173
+ r"""
174
+
175
+ Values:
176
+ SQL_BACKEND_TYPE_UNSPECIFIED (0):
177
+ This is an unknown backend type for instance.
178
+ FIRST_GEN (1):
179
+ V1 speckle instance.
180
+ SECOND_GEN (2):
181
+ V2 speckle instance.
182
+ EXTERNAL (3):
183
+ On premises instance.
184
+ """
185
+
186
+ SQL_BACKEND_TYPE_UNSPECIFIED = 0
187
+ FIRST_GEN = 1
188
+ SECOND_GEN = 2
189
+ EXTERNAL = 3
190
+
191
+
192
+ class SqlIpAddressType(proto.Enum):
193
+ r"""
194
+
195
+ Values:
196
+ SQL_IP_ADDRESS_TYPE_UNSPECIFIED (0):
197
+ This is an unknown IP address type.
198
+ PRIMARY (1):
199
+ IP address the customer is supposed to
200
+ connect to. Usually this is the load balancer's
201
+ IP address
202
+ OUTGOING (2):
203
+ Source IP address of the connection a read
204
+ replica establishes to its external primary
205
+ instance. This IP address can be allowlisted by
206
+ the customer in case it has a firewall that
207
+ filters incoming connection to its on premises
208
+ primary instance.
209
+ PRIVATE (3):
210
+ Private IP used when using private IPs and
211
+ network peering.
212
+ MIGRATED_1ST_GEN (4):
213
+ V1 IP of a migrated instance. We want the
214
+ user to decommission this IP as soon as the
215
+ migration is complete. Note: V1 instances with
216
+ V1 ip addresses will be counted as PRIMARY.
217
+ """
218
+
219
+ SQL_IP_ADDRESS_TYPE_UNSPECIFIED = 0
220
+ PRIMARY = 1
221
+ OUTGOING = 2
222
+ PRIVATE = 3
223
+ MIGRATED_1ST_GEN = 4
224
+
225
+
226
+ class SqlDatabaseVersion(proto.Enum):
227
+ r"""The database engine type and version.
228
+
229
+ Values:
230
+ SQL_DATABASE_VERSION_UNSPECIFIED (0):
231
+ This is an unknown database version.
232
+ MYSQL_5_1 (2):
233
+ The database version is MySQL 5.1.
234
+ MYSQL_5_5 (3):
235
+ The database version is MySQL 5.5.
236
+ MYSQL_5_6 (5):
237
+ The database version is MySQL 5.6.
238
+ MYSQL_5_7 (6):
239
+ The database version is MySQL 5.7.
240
+ MYSQL_8_0 (20):
241
+ The database version is MySQL 8.
242
+ MYSQL_8_0_18 (41):
243
+ The database major version is MySQL 8.0 and
244
+ the minor version is 18.
245
+ MYSQL_8_0_26 (85):
246
+ The database major version is MySQL 8.0 and
247
+ the minor version is 26.
248
+ MYSQL_8_0_27 (111):
249
+ The database major version is MySQL 8.0 and
250
+ the minor version is 27.
251
+ MYSQL_8_0_28 (132):
252
+ The database major version is MySQL 8.0 and
253
+ the minor version is 28.
254
+ MYSQL_8_0_29 (148):
255
+ The database major version is MySQL 8.0 and
256
+ the minor version is 29.
257
+ MYSQL_8_0_30 (174):
258
+ The database major version is MySQL 8.0 and
259
+ the minor version is 30.
260
+ MYSQL_8_0_31 (197):
261
+ The database major version is MySQL 8.0 and
262
+ the minor version is 31.
263
+ MYSQL_8_0_32 (213):
264
+ The database major version is MySQL 8.0 and
265
+ the minor version is 32.
266
+ MYSQL_8_0_33 (238):
267
+ The database major version is MySQL 8.0 and
268
+ the minor version is 33.
269
+ MYSQL_8_0_34 (239):
270
+ The database major version is MySQL 8.0 and
271
+ the minor version is 34.
272
+ MYSQL_8_0_35 (240):
273
+ The database major version is MySQL 8.0 and
274
+ the minor version is 35.
275
+ MYSQL_8_0_36 (241):
276
+ The database major version is MySQL 8.0 and
277
+ the minor version is 36.
278
+ MYSQL_8_0_37 (355):
279
+ The database major version is MySQL 8.0 and
280
+ the minor version is 37.
281
+ MYSQL_8_0_39 (357):
282
+ The database major version is MySQL 8.0 and
283
+ the minor version is 39.
284
+ MYSQL_8_0_40 (358):
285
+ The database major version is MySQL 8.0 and
286
+ the minor version is 40.
287
+ MYSQL_8_0_41 (488):
288
+ The database major version is MySQL 8.0 and
289
+ the minor version is 41.
290
+ MYSQL_8_0_42 (489):
291
+ The database major version is MySQL 8.0 and
292
+ the minor version is 42.
293
+ MYSQL_8_0_43 (553):
294
+ The database major version is MySQL 8.0 and
295
+ the minor version is 43.
296
+ MYSQL_8_0_44 (554):
297
+ The database major version is MySQL 8.0 and
298
+ the minor version is 44.
299
+ MYSQL_8_0_45 (555):
300
+ The database major version is MySQL 8.0 and
301
+ the minor version is 45.
302
+ MYSQL_8_0_46 (556):
303
+ The database major version is MySQL 8.0 and
304
+ the minor version is 46.
305
+ MYSQL_8_4 (398):
306
+ The database version is MySQL 8.4.
307
+ MYSQL_9_7 (654):
308
+ The database version is MySQL 9.7.
309
+ SQLSERVER_2017_STANDARD (11):
310
+ The database version is SQL Server 2017
311
+ Standard.
312
+ SQLSERVER_2017_ENTERPRISE (14):
313
+ The database version is SQL Server 2017
314
+ Enterprise.
315
+ SQLSERVER_2017_EXPRESS (15):
316
+ The database version is SQL Server 2017
317
+ Express.
318
+ SQLSERVER_2017_WEB (16):
319
+ The database version is SQL Server 2017 Web.
320
+ POSTGRES_9_6 (9):
321
+ The database version is PostgreSQL 9.6.
322
+ POSTGRES_10 (18):
323
+ The database version is PostgreSQL 10.
324
+ POSTGRES_11 (10):
325
+ The database version is PostgreSQL 11.
326
+ POSTGRES_12 (19):
327
+ The database version is PostgreSQL 12.
328
+ POSTGRES_13 (23):
329
+ The database version is PostgreSQL 13.
330
+ POSTGRES_14 (110):
331
+ The database version is PostgreSQL 14.
332
+ POSTGRES_15 (172):
333
+ The database version is PostgreSQL 15.
334
+ POSTGRES_16 (272):
335
+ The database version is PostgreSQL 16.
336
+ POSTGRES_17 (408):
337
+ The database version is PostgreSQL 17.
338
+ POSTGRES_18 (557):
339
+ The database version is PostgreSQL 18.
340
+ POSTGRES_19 (684):
341
+ The database version is PostgreSQL 19.
342
+ POSTGRES_20 (781):
343
+ The database version is PostgreSQL 20.
344
+ SQLSERVER_2019_STANDARD (26):
345
+ The database version is SQL Server 2019
346
+ Standard.
347
+ SQLSERVER_2019_ENTERPRISE (27):
348
+ The database version is SQL Server 2019
349
+ Enterprise.
350
+ SQLSERVER_2019_EXPRESS (28):
351
+ The database version is SQL Server 2019
352
+ Express.
353
+ SQLSERVER_2019_WEB (29):
354
+ The database version is SQL Server 2019 Web.
355
+ SQLSERVER_2022_STANDARD (199):
356
+ The database version is SQL Server 2022
357
+ Standard.
358
+ SQLSERVER_2022_ENTERPRISE (200):
359
+ The database version is SQL Server 2022
360
+ Enterprise.
361
+ SQLSERVER_2022_EXPRESS (201):
362
+ The database version is SQL Server 2022
363
+ Express.
364
+ SQLSERVER_2022_WEB (202):
365
+ The database version is SQL Server 2022 Web.
366
+ SQLSERVER_2025_STANDARD (549):
367
+ The database version is SQL Server 2025
368
+ Standard.
369
+ SQLSERVER_2025_ENTERPRISE (550):
370
+ The database version is SQL Server 2025
371
+ Enterprise.
372
+ SQLSERVER_2025_EXPRESS (551):
373
+ The database version is SQL Server 2025
374
+ Express.
375
+ """
376
+
377
+ SQL_DATABASE_VERSION_UNSPECIFIED = 0
378
+ MYSQL_5_1 = 2
379
+ MYSQL_5_5 = 3
380
+ MYSQL_5_6 = 5
381
+ MYSQL_5_7 = 6
382
+ MYSQL_8_0 = 20
383
+ MYSQL_8_0_18 = 41
384
+ MYSQL_8_0_26 = 85
385
+ MYSQL_8_0_27 = 111
386
+ MYSQL_8_0_28 = 132
387
+ MYSQL_8_0_29 = 148
388
+ MYSQL_8_0_30 = 174
389
+ MYSQL_8_0_31 = 197
390
+ MYSQL_8_0_32 = 213
391
+ MYSQL_8_0_33 = 238
392
+ MYSQL_8_0_34 = 239
393
+ MYSQL_8_0_35 = 240
394
+ MYSQL_8_0_36 = 241
395
+ MYSQL_8_0_37 = 355
396
+ MYSQL_8_0_39 = 357
397
+ MYSQL_8_0_40 = 358
398
+ MYSQL_8_0_41 = 488
399
+ MYSQL_8_0_42 = 489
400
+ MYSQL_8_0_43 = 553
401
+ MYSQL_8_0_44 = 554
402
+ MYSQL_8_0_45 = 555
403
+ MYSQL_8_0_46 = 556
404
+ MYSQL_8_4 = 398
405
+ MYSQL_9_7 = 654
406
+ SQLSERVER_2017_STANDARD = 11
407
+ SQLSERVER_2017_ENTERPRISE = 14
408
+ SQLSERVER_2017_EXPRESS = 15
409
+ SQLSERVER_2017_WEB = 16
410
+ POSTGRES_9_6 = 9
411
+ POSTGRES_10 = 18
412
+ POSTGRES_11 = 10
413
+ POSTGRES_12 = 19
414
+ POSTGRES_13 = 23
415
+ POSTGRES_14 = 110
416
+ POSTGRES_15 = 172
417
+ POSTGRES_16 = 272
418
+ POSTGRES_17 = 408
419
+ POSTGRES_18 = 557
420
+ POSTGRES_19 = 684
421
+ POSTGRES_20 = 781
422
+ SQLSERVER_2019_STANDARD = 26
423
+ SQLSERVER_2019_ENTERPRISE = 27
424
+ SQLSERVER_2019_EXPRESS = 28
425
+ SQLSERVER_2019_WEB = 29
426
+ SQLSERVER_2022_STANDARD = 199
427
+ SQLSERVER_2022_ENTERPRISE = 200
428
+ SQLSERVER_2022_EXPRESS = 201
429
+ SQLSERVER_2022_WEB = 202
430
+ SQLSERVER_2025_STANDARD = 549
431
+ SQLSERVER_2025_ENTERPRISE = 550
432
+ SQLSERVER_2025_EXPRESS = 551
433
+
434
+
435
+ class SqlPricingPlan(proto.Enum):
436
+ r"""The pricing plan for this instance.
437
+
438
+ Values:
439
+ SQL_PRICING_PLAN_UNSPECIFIED (0):
440
+ This is an unknown pricing plan for this
441
+ instance.
442
+ PACKAGE (1):
443
+ The instance is billed at a monthly flat
444
+ rate.
445
+ PER_USE (2):
446
+ The instance is billed per usage.
447
+ """
448
+
449
+ SQL_PRICING_PLAN_UNSPECIFIED = 0
450
+ PACKAGE = 1
451
+ PER_USE = 2
452
+
453
+
454
+ class SqlReplicationType(proto.Enum):
455
+ r"""
456
+
457
+ Values:
458
+ SQL_REPLICATION_TYPE_UNSPECIFIED (0):
459
+ This is an unknown replication type for a
460
+ Cloud SQL instance.
461
+ SYNCHRONOUS (1):
462
+ The synchronous replication mode for First
463
+ Generation instances. It is the default value.
464
+ ASYNCHRONOUS (2):
465
+ The asynchronous replication mode for First
466
+ Generation instances. It provides a slight
467
+ performance gain, but if an outage occurs while
468
+ this option is set to asynchronous, you can lose
469
+ up to a few seconds of updates to your data.
470
+ """
471
+
472
+ SQL_REPLICATION_TYPE_UNSPECIFIED = 0
473
+ SYNCHRONOUS = 1
474
+ ASYNCHRONOUS = 2
475
+
476
+
477
+ class SqlDataDiskType(proto.Enum):
478
+ r"""The type of disk that is used for a v2 instance to use.
479
+
480
+ Values:
481
+ SQL_DATA_DISK_TYPE_UNSPECIFIED (0):
482
+ This is an unknown data disk type.
483
+ PD_SSD (1):
484
+ An SSD data disk.
485
+ PD_HDD (2):
486
+ An HDD data disk.
487
+ OBSOLETE_LOCAL_SSD (3):
488
+ This field is deprecated and will be removed
489
+ from a future version of the API.
490
+ HYPERDISK_BALANCED (4):
491
+ A Hyperdisk Balanced data disk.
492
+ """
493
+
494
+ SQL_DATA_DISK_TYPE_UNSPECIFIED = 0
495
+ PD_SSD = 1
496
+ PD_HDD = 2
497
+ OBSOLETE_LOCAL_SSD = 3
498
+ HYPERDISK_BALANCED = 4
499
+
500
+
501
+ class SqlAvailabilityType(proto.Enum):
502
+ r"""The availability type of the given Cloud SQL instance.
503
+
504
+ Values:
505
+ SQL_AVAILABILITY_TYPE_UNSPECIFIED (0):
506
+ This is an unknown Availability type.
507
+ ZONAL (1):
508
+ Zonal available instance.
509
+ REGIONAL (2):
510
+ Regional available instance.
511
+ """
512
+
513
+ SQL_AVAILABILITY_TYPE_UNSPECIFIED = 0
514
+ ZONAL = 1
515
+ REGIONAL = 2
516
+
517
+
518
+ class SqlUpdateTrack(proto.Enum):
519
+ r"""
520
+
521
+ Values:
522
+ SQL_UPDATE_TRACK_UNSPECIFIED (0):
523
+ This is an unknown maintenance timing
524
+ preference.
525
+ canary (1):
526
+ For an instance with a scheduled maintenance window, this
527
+ maintenance timing indicates that the maintenance update is
528
+ scheduled 7 to 14 days after the notification is sent out.
529
+ Also referred to as ``Week 1`` (Console) and ``preview``
530
+ (gcloud CLI).
531
+ stable (2):
532
+ For an instance with a scheduled maintenance window, this
533
+ maintenance timing indicates that the maintenance update is
534
+ scheduled 15 to 21 days after the notification is sent out.
535
+ Also referred to as ``Week 2`` (Console) and ``production``
536
+ (gcloud CLI).
537
+ week5 (3):
538
+ For instance with a scheduled maintenance
539
+ window, this maintenance timing indicates that
540
+ the maintenance update is scheduled 35 to 42
541
+ days after the notification is sent out.
542
+ """
543
+
544
+ SQL_UPDATE_TRACK_UNSPECIFIED = 0
545
+ canary = 1
546
+ stable = 2
547
+ week5 = 3
548
+
549
+
550
+ class AutoDnsStatus(proto.Enum):
551
+ r"""The status of automated DNS provisioning.
552
+
553
+ Values:
554
+ AUTO_DNS_STATUS_UNSPECIFIED (0):
555
+ Unspecified status. This means status is
556
+ missing from dependency service.
557
+ AUTO_DNS_OK (1):
558
+ DNS provisioning is OK.
559
+ AUTO_DNS_FAILED (2):
560
+ DNS provisioning failed.
561
+ AUTO_DNS_UNKNOWN (3):
562
+ DNS provisioning status is not recognized by
563
+ Cloud SQL.
564
+ """
565
+
566
+ AUTO_DNS_STATUS_UNSPECIFIED = 0
567
+ AUTO_DNS_OK = 1
568
+ AUTO_DNS_FAILED = 2
569
+ AUTO_DNS_UNKNOWN = 3
570
+
571
+
572
+ class AclEntry(proto.Message):
573
+ r"""An entry for an Access Control list.
574
+
575
+ Attributes:
576
+ value (str):
577
+ The allowlisted value for the access control
578
+ list.
579
+ expiration_time (google.protobuf.timestamp_pb2.Timestamp):
580
+ The time when this access control entry expires in `RFC
581
+ 3339 <https://tools.ietf.org/html/rfc3339>`__ format, for
582
+ example ``2012-11-15T16:19:00.094Z``.
583
+ name (str):
584
+ Optional. A label to identify this entry.
585
+ kind (str):
586
+ This is always ``sql#aclEntry``.
587
+ """
588
+
589
+ value: str = proto.Field(
590
+ proto.STRING,
591
+ number=1,
592
+ )
593
+ expiration_time: timestamp_pb2.Timestamp = proto.Field(
594
+ proto.MESSAGE,
595
+ number=2,
596
+ message=timestamp_pb2.Timestamp,
597
+ )
598
+ name: str = proto.Field(
599
+ proto.STRING,
600
+ number=3,
601
+ )
602
+ kind: str = proto.Field(
603
+ proto.STRING,
604
+ number=4,
605
+ )
606
+
607
+
608
+ class ApiWarning(proto.Message):
609
+ r"""An Admin API warning message.
610
+
611
+ Attributes:
612
+ code (google.cloud.sqladmin_v1.types.ApiWarning.SqlApiWarningCode):
613
+ Code to uniquely identify the warning type.
614
+ message (str):
615
+ The warning message.
616
+ region (str):
617
+ The region name for REGION_UNREACHABLE warning.
618
+ """
619
+
620
+ class SqlApiWarningCode(proto.Enum):
621
+ r"""
622
+
623
+ Values:
624
+ SQL_API_WARNING_CODE_UNSPECIFIED (0):
625
+ An unknown or unset warning type from Cloud
626
+ SQL API.
627
+ REGION_UNREACHABLE (1):
628
+ Warning when one or more regions are not
629
+ reachable. The returned result set may be
630
+ incomplete.
631
+ MAX_RESULTS_EXCEEDS_LIMIT (2):
632
+ Warning when user provided maxResults
633
+ parameter exceeds the limit. The returned
634
+ result set may be incomplete.
635
+ COMPROMISED_CREDENTIALS (3):
636
+ Warning when user tries to create/update a
637
+ user with credentials that have previously been
638
+ compromised by a public data breach.
639
+ INTERNAL_STATE_FAILURE (4):
640
+ Warning when the operation succeeds but some
641
+ non-critical workflow state failed.
642
+ """
643
+
644
+ SQL_API_WARNING_CODE_UNSPECIFIED = 0
645
+ REGION_UNREACHABLE = 1
646
+ MAX_RESULTS_EXCEEDS_LIMIT = 2
647
+ COMPROMISED_CREDENTIALS = 3
648
+ INTERNAL_STATE_FAILURE = 4
649
+
650
+ code: SqlApiWarningCode = proto.Field(
651
+ proto.ENUM,
652
+ number=1,
653
+ enum=SqlApiWarningCode,
654
+ )
655
+ message: str = proto.Field(
656
+ proto.STRING,
657
+ number=2,
658
+ )
659
+ region: str = proto.Field(
660
+ proto.STRING,
661
+ number=3,
662
+ )
663
+
664
+
665
+ class BackupRetentionSettings(proto.Message):
666
+ r"""We currently only support backup retention by specifying the
667
+ number of backups we will retain.
668
+
669
+ Attributes:
670
+ retention_unit (google.cloud.sqladmin_v1.types.BackupRetentionSettings.RetentionUnit):
671
+ The unit that 'retained_backups' represents.
672
+ retained_backups (google.protobuf.wrappers_pb2.Int32Value):
673
+ Depending on the value of retention_unit, this is used to
674
+ determine if a backup needs to be deleted. If retention_unit
675
+ is 'COUNT', we will retain this many backups.
676
+ """
677
+
678
+ class RetentionUnit(proto.Enum):
679
+ r"""The units that retained_backups specifies, we only support COUNT.
680
+
681
+ Values:
682
+ RETENTION_UNIT_UNSPECIFIED (0):
683
+ Backup retention unit is unspecified, will be
684
+ treated as COUNT.
685
+ COUNT (1):
686
+ Retention will be by count, eg. "retain the
687
+ most recent 7 backups".
688
+ """
689
+
690
+ RETENTION_UNIT_UNSPECIFIED = 0
691
+ COUNT = 1
692
+
693
+ retention_unit: RetentionUnit = proto.Field(
694
+ proto.ENUM,
695
+ number=1,
696
+ enum=RetentionUnit,
697
+ )
698
+ retained_backups: wrappers_pb2.Int32Value = proto.Field(
699
+ proto.MESSAGE,
700
+ number=2,
701
+ message=wrappers_pb2.Int32Value,
702
+ )
703
+
704
+
705
+ class BackupConfiguration(proto.Message):
706
+ r"""Database instance backup configuration.
707
+
708
+ .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
709
+
710
+ Attributes:
711
+ start_time (str):
712
+ Start time for the daily backup configuration in UTC
713
+ timezone in the 24 hour format - ``HH:MM``.
714
+ enabled (google.protobuf.wrappers_pb2.BoolValue):
715
+ Whether this configuration is enabled.
716
+ kind (str):
717
+ This is always ``sql#backupConfiguration``.
718
+ binary_log_enabled (google.protobuf.wrappers_pb2.BoolValue):
719
+ (MySQL only) Whether binary log is enabled.
720
+ If backup configuration is disabled, binarylog
721
+ must be disabled as well.
722
+ replication_log_archiving_enabled (google.protobuf.wrappers_pb2.BoolValue):
723
+ Optional. Deprecated: replication_log_archiving_enabled is
724
+ deprecated and will be removed from a future version of the
725
+ API. Use
726
+ [point_in_time_recovery_enabled][google.cloud.sql.v1.BackupConfiguration.point_in_time_recovery_enabled]
727
+ instead.
728
+ location (str):
729
+ Location of the backup
730
+ point_in_time_recovery_enabled (google.protobuf.wrappers_pb2.BoolValue):
731
+ Whether point in time recovery is enabled.
732
+ backup_retention_settings (google.cloud.sqladmin_v1.types.BackupRetentionSettings):
733
+ Backup retention settings.
734
+ transaction_log_retention_days (google.protobuf.wrappers_pb2.Int32Value):
735
+ The number of days of transaction logs we
736
+ retain for point in time restore, from 1-7.
737
+ transactional_log_storage_state (google.cloud.sqladmin_v1.types.BackupConfiguration.TransactionalLogStorageState):
738
+ Output only. This value contains the storage
739
+ location of transactional logs used to perform
740
+ point-in-time recovery (PITR) for the database.
741
+
742
+ This field is a member of `oneof`_ ``_transactional_log_storage_state``.
743
+ backup_tier (google.cloud.sqladmin_v1.types.BackupConfiguration.BackupTier):
744
+ Output only. Backup tier that manages the
745
+ backups for the instance.
746
+
747
+ This field is a member of `oneof`_ ``_backup_tier``.
748
+ """
749
+
750
+ class TransactionalLogStorageState(proto.Enum):
751
+ r"""This value contains the storage location of the transactional
752
+ logs used to perform point-in-time recovery (PITR) for the
753
+ database.
754
+
755
+ Values:
756
+ TRANSACTIONAL_LOG_STORAGE_STATE_UNSPECIFIED (0):
757
+ Unspecified.
758
+ DISK (1):
759
+ The transaction logs used for PITR for the
760
+ instance are stored on a data disk.
761
+ SWITCHING_TO_CLOUD_STORAGE (2):
762
+ The transaction logs used for PITR for the
763
+ instance are switching from being stored on a
764
+ data disk to being stored in Cloud Storage. Only
765
+ applicable to MySQL.
766
+ SWITCHED_TO_CLOUD_STORAGE (3):
767
+ The transaction logs used for PITR for the
768
+ instance are now stored in Cloud Storage.
769
+ Previously, they were stored on a data disk.
770
+ Only applicable to MySQL.
771
+ CLOUD_STORAGE (4):
772
+ The transaction logs used for PITR for the
773
+ instance are stored in Cloud Storage. Only
774
+ applicable to MySQL and PostgreSQL.
775
+ """
776
+
777
+ TRANSACTIONAL_LOG_STORAGE_STATE_UNSPECIFIED = 0
778
+ DISK = 1
779
+ SWITCHING_TO_CLOUD_STORAGE = 2
780
+ SWITCHED_TO_CLOUD_STORAGE = 3
781
+ CLOUD_STORAGE = 4
782
+
783
+ class BackupTier(proto.Enum):
784
+ r"""Backup tier that manages the backups for the instance.
785
+
786
+ Values:
787
+ BACKUP_TIER_UNSPECIFIED (0):
788
+ Unspecified.
789
+ STANDARD (1):
790
+ Instance is managed by Cloud SQL.
791
+ ADVANCED (2):
792
+ Deprecated: ADVANCED is deprecated. Please
793
+ use ENHANCED instead.
794
+ ENHANCED (3):
795
+ Instance is managed by Google Cloud Backup
796
+ and DR Service.
797
+ """
798
+
799
+ BACKUP_TIER_UNSPECIFIED = 0
800
+ STANDARD = 1
801
+ ADVANCED = 2
802
+ ENHANCED = 3
803
+
804
+ start_time: str = proto.Field(
805
+ proto.STRING,
806
+ number=1,
807
+ )
808
+ enabled: wrappers_pb2.BoolValue = proto.Field(
809
+ proto.MESSAGE,
810
+ number=2,
811
+ message=wrappers_pb2.BoolValue,
812
+ )
813
+ kind: str = proto.Field(
814
+ proto.STRING,
815
+ number=3,
816
+ )
817
+ binary_log_enabled: wrappers_pb2.BoolValue = proto.Field(
818
+ proto.MESSAGE,
819
+ number=4,
820
+ message=wrappers_pb2.BoolValue,
821
+ )
822
+ replication_log_archiving_enabled: wrappers_pb2.BoolValue = proto.Field(
823
+ proto.MESSAGE,
824
+ number=5,
825
+ message=wrappers_pb2.BoolValue,
826
+ )
827
+ location: str = proto.Field(
828
+ proto.STRING,
829
+ number=6,
830
+ )
831
+ point_in_time_recovery_enabled: wrappers_pb2.BoolValue = proto.Field(
832
+ proto.MESSAGE,
833
+ number=7,
834
+ message=wrappers_pb2.BoolValue,
835
+ )
836
+ backup_retention_settings: "BackupRetentionSettings" = proto.Field(
837
+ proto.MESSAGE,
838
+ number=8,
839
+ message="BackupRetentionSettings",
840
+ )
841
+ transaction_log_retention_days: wrappers_pb2.Int32Value = proto.Field(
842
+ proto.MESSAGE,
843
+ number=9,
844
+ message=wrappers_pb2.Int32Value,
845
+ )
846
+ transactional_log_storage_state: TransactionalLogStorageState = proto.Field(
847
+ proto.ENUM,
848
+ number=10,
849
+ optional=True,
850
+ enum=TransactionalLogStorageState,
851
+ )
852
+ backup_tier: BackupTier = proto.Field(
853
+ proto.ENUM,
854
+ number=11,
855
+ optional=True,
856
+ enum=BackupTier,
857
+ )
858
+
859
+
860
+ class PerformDiskShrinkContext(proto.Message):
861
+ r"""Perform disk shrink context.
862
+
863
+ Attributes:
864
+ target_size_gb (int):
865
+ The target disk shrink size in GigaBytes.
866
+ """
867
+
868
+ target_size_gb: int = proto.Field(
869
+ proto.INT64,
870
+ number=1,
871
+ )
872
+
873
+
874
+ class PreCheckResponse(proto.Message):
875
+ r"""Structured PreCheckResponse containing message, type, and
876
+ required actions.
877
+
878
+
879
+ .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
880
+
881
+ Attributes:
882
+ message (str):
883
+ The message to be displayed to the user.
884
+
885
+ This field is a member of `oneof`_ ``_message``.
886
+ message_type (google.cloud.sqladmin_v1.types.PreCheckResponse.MessageType):
887
+ The type of message whether it is an info,
888
+ warning, or error.
889
+
890
+ This field is a member of `oneof`_ ``_message_type``.
891
+ actions_required (MutableSequence[str]):
892
+ The actions that the user needs to take. Use
893
+ repeated for multiple actions.
894
+ """
895
+
896
+ class MessageType(proto.Enum):
897
+ r"""The type of message which can be an info, a warning, or an
898
+ error that requires user intervention.
899
+
900
+ Values:
901
+ MESSAGE_TYPE_UNSPECIFIED (0):
902
+ Default unspecified value to prevent
903
+ unintended behavior changes.
904
+ INFO (1):
905
+ General informational messages that don't
906
+ require action.
907
+ WARNING (2):
908
+ Warnings that might impact the upgrade but
909
+ don't block it.
910
+ ERROR (3):
911
+ Errors that a user must resolve before
912
+ proceeding with the upgrade.
913
+ """
914
+
915
+ MESSAGE_TYPE_UNSPECIFIED = 0
916
+ INFO = 1
917
+ WARNING = 2
918
+ ERROR = 3
919
+
920
+ message: str = proto.Field(
921
+ proto.STRING,
922
+ number=2,
923
+ optional=True,
924
+ )
925
+ message_type: MessageType = proto.Field(
926
+ proto.ENUM,
927
+ number=3,
928
+ optional=True,
929
+ enum=MessageType,
930
+ )
931
+ actions_required: MutableSequence[str] = proto.RepeatedField(
932
+ proto.STRING,
933
+ number=4,
934
+ )
935
+
936
+
937
+ class PreCheckMajorVersionUpgradeContext(proto.Message):
938
+ r"""Pre-check major version upgrade context.
939
+
940
+ Attributes:
941
+ target_database_version (google.cloud.sqladmin_v1.types.SqlDatabaseVersion):
942
+ Required. The target database version to
943
+ upgrade to.
944
+ pre_check_response (MutableSequence[google.cloud.sqladmin_v1.types.PreCheckResponse]):
945
+ Output only. The responses from the precheck
946
+ operation.
947
+ kind (str):
948
+ Optional. This is always
949
+ ``sql#preCheckMajorVersionUpgradeContext``.
950
+ """
951
+
952
+ target_database_version: "SqlDatabaseVersion" = proto.Field(
953
+ proto.ENUM,
954
+ number=1,
955
+ enum="SqlDatabaseVersion",
956
+ )
957
+ pre_check_response: MutableSequence["PreCheckResponse"] = proto.RepeatedField(
958
+ proto.MESSAGE,
959
+ number=2,
960
+ message="PreCheckResponse",
961
+ )
962
+ kind: str = proto.Field(
963
+ proto.STRING,
964
+ number=3,
965
+ )
966
+
967
+
968
+ class BackupContext(proto.Message):
969
+ r"""Backup context.
970
+
971
+ Attributes:
972
+ backup_id (int):
973
+ The identifier of the backup.
974
+ kind (str):
975
+ This is always ``sql#backupContext``.
976
+ name (str):
977
+ The name of the backup.
978
+ Format: projects/{project}/backups/{backup}
979
+ """
980
+
981
+ backup_id: int = proto.Field(
982
+ proto.INT64,
983
+ number=1,
984
+ )
985
+ kind: str = proto.Field(
986
+ proto.STRING,
987
+ number=2,
988
+ )
989
+ name: str = proto.Field(
990
+ proto.STRING,
991
+ number=3,
992
+ )
993
+
994
+
995
+ class Database(proto.Message):
996
+ r"""Represents a SQL database on the Cloud SQL instance.
997
+
998
+ .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
999
+
1000
+ Attributes:
1001
+ kind (str):
1002
+ This is always ``sql#database``.
1003
+ charset (str):
1004
+ The Cloud SQL charset value.
1005
+ collation (str):
1006
+ The Cloud SQL collation value.
1007
+ etag (str):
1008
+ This field is deprecated and will be removed
1009
+ from a future version of the API.
1010
+ name (str):
1011
+ The name of the database in the Cloud SQL
1012
+ instance. This does not include the project ID
1013
+ or instance name.
1014
+ instance (str):
1015
+ The name of the Cloud SQL instance. This does
1016
+ not include the project ID.
1017
+ self_link (str):
1018
+ The URI of this resource.
1019
+ project (str):
1020
+ The project ID of the project containing the
1021
+ Cloud SQL database. The Google apps domain is
1022
+ prefixed if applicable.
1023
+ sqlserver_database_details (google.cloud.sqladmin_v1.types.SqlServerDatabaseDetails):
1024
+
1025
+ This field is a member of `oneof`_ ``database_details``.
1026
+ """
1027
+
1028
+ kind: str = proto.Field(
1029
+ proto.STRING,
1030
+ number=1,
1031
+ )
1032
+ charset: str = proto.Field(
1033
+ proto.STRING,
1034
+ number=2,
1035
+ )
1036
+ collation: str = proto.Field(
1037
+ proto.STRING,
1038
+ number=3,
1039
+ )
1040
+ etag: str = proto.Field(
1041
+ proto.STRING,
1042
+ number=4,
1043
+ )
1044
+ name: str = proto.Field(
1045
+ proto.STRING,
1046
+ number=5,
1047
+ )
1048
+ instance: str = proto.Field(
1049
+ proto.STRING,
1050
+ number=6,
1051
+ )
1052
+ self_link: str = proto.Field(
1053
+ proto.STRING,
1054
+ number=7,
1055
+ )
1056
+ project: str = proto.Field(
1057
+ proto.STRING,
1058
+ number=8,
1059
+ )
1060
+ sqlserver_database_details: "SqlServerDatabaseDetails" = proto.Field(
1061
+ proto.MESSAGE,
1062
+ number=9,
1063
+ oneof="database_details",
1064
+ message="SqlServerDatabaseDetails",
1065
+ )
1066
+
1067
+
1068
+ class SqlServerDatabaseDetails(proto.Message):
1069
+ r"""Represents a Sql Server database on the Cloud SQL instance.
1070
+
1071
+ Attributes:
1072
+ compatibility_level (int):
1073
+ The version of SQL Server with which the
1074
+ database is to be made compatible
1075
+ recovery_model (str):
1076
+ The recovery model of a SQL Server database
1077
+ """
1078
+
1079
+ compatibility_level: int = proto.Field(
1080
+ proto.INT32,
1081
+ number=1,
1082
+ )
1083
+ recovery_model: str = proto.Field(
1084
+ proto.STRING,
1085
+ number=2,
1086
+ )
1087
+
1088
+
1089
+ class DatabaseFlags(proto.Message):
1090
+ r"""Database flags for Cloud SQL instances.
1091
+
1092
+ Attributes:
1093
+ name (str):
1094
+ The name of the flag. These flags are passed at instance
1095
+ startup, so include both server options and system
1096
+ variables. Flags are specified with underscores, not
1097
+ hyphens. For more information, see `Configuring Database
1098
+ Flags <https://cloud.google.com/sql/docs/mysql/flags>`__ in
1099
+ the Cloud SQL documentation.
1100
+ value (str):
1101
+ The value of the flag. Boolean flags are set to ``on`` for
1102
+ true and ``off`` for false. This field must be omitted if
1103
+ the flag doesn't take a value.
1104
+ """
1105
+
1106
+ name: str = proto.Field(
1107
+ proto.STRING,
1108
+ number=1,
1109
+ )
1110
+ value: str = proto.Field(
1111
+ proto.STRING,
1112
+ number=2,
1113
+ )
1114
+
1115
+
1116
+ class MySqlSyncConfig(proto.Message):
1117
+ r"""MySQL-specific external server sync settings.
1118
+
1119
+ Attributes:
1120
+ initial_sync_flags (MutableSequence[google.cloud.sqladmin_v1.types.SyncFlags]):
1121
+ Flags to use for the initial dump.
1122
+ """
1123
+
1124
+ initial_sync_flags: MutableSequence["SyncFlags"] = proto.RepeatedField(
1125
+ proto.MESSAGE,
1126
+ number=1,
1127
+ message="SyncFlags",
1128
+ )
1129
+
1130
+
1131
+ class SyncFlags(proto.Message):
1132
+ r"""Initial sync flags for certain Cloud SQL APIs.
1133
+ Currently used for the MySQL external server initial dump.
1134
+
1135
+ Attributes:
1136
+ name (str):
1137
+ The name of the flag.
1138
+ value (str):
1139
+ The value of the flag. This field must be
1140
+ omitted if the flag doesn't take a value.
1141
+ """
1142
+
1143
+ name: str = proto.Field(
1144
+ proto.STRING,
1145
+ number=1,
1146
+ )
1147
+ value: str = proto.Field(
1148
+ proto.STRING,
1149
+ number=2,
1150
+ )
1151
+
1152
+
1153
+ class InstanceReference(proto.Message):
1154
+ r"""Reference to another Cloud SQL instance.
1155
+
1156
+ Attributes:
1157
+ name (str):
1158
+ The name of the Cloud SQL instance being
1159
+ referenced. This does not include the project
1160
+ ID.
1161
+ region (str):
1162
+ The region of the Cloud SQL instance being
1163
+ referenced.
1164
+ project (str):
1165
+ The project ID of the Cloud SQL instance
1166
+ being referenced. The default is the same
1167
+ project ID as the instance references it.
1168
+ """
1169
+
1170
+ name: str = proto.Field(
1171
+ proto.STRING,
1172
+ number=1,
1173
+ )
1174
+ region: str = proto.Field(
1175
+ proto.STRING,
1176
+ number=2,
1177
+ )
1178
+ project: str = proto.Field(
1179
+ proto.STRING,
1180
+ number=3,
1181
+ )
1182
+
1183
+
1184
+ class DemoteMasterConfiguration(proto.Message):
1185
+ r"""Read-replica configuration for connecting to the on-premises
1186
+ primary instance.
1187
+
1188
+ Attributes:
1189
+ kind (str):
1190
+ This is always ``sql#demoteMasterConfiguration``.
1191
+ mysql_replica_configuration (google.cloud.sqladmin_v1.types.DemoteMasterMySqlReplicaConfiguration):
1192
+ MySQL specific configuration when replicating from a MySQL
1193
+ on-premises primary instance. Replication configuration
1194
+ information such as the username, password, certificates,
1195
+ and keys are not stored in the instance metadata. The
1196
+ configuration information is used only to set up the
1197
+ replication connection and is stored by MySQL in a file
1198
+ named ``master.info`` in the data directory.
1199
+ """
1200
+
1201
+ kind: str = proto.Field(
1202
+ proto.STRING,
1203
+ number=1,
1204
+ )
1205
+ mysql_replica_configuration: "DemoteMasterMySqlReplicaConfiguration" = proto.Field(
1206
+ proto.MESSAGE,
1207
+ number=2,
1208
+ message="DemoteMasterMySqlReplicaConfiguration",
1209
+ )
1210
+
1211
+
1212
+ class DemoteMasterMySqlReplicaConfiguration(proto.Message):
1213
+ r"""Read-replica configuration specific to MySQL databases.
1214
+
1215
+ Attributes:
1216
+ kind (str):
1217
+ This is always
1218
+ ``sql#demoteMasterMysqlReplicaConfiguration``.
1219
+ username (str):
1220
+ The username for the replication connection.
1221
+ password (str):
1222
+ The password for the replication connection.
1223
+ client_key (str):
1224
+ PEM representation of the replica's private
1225
+ key. The corresponding public key is encoded in
1226
+ the client's certificate. The format of the
1227
+ replica's private key can be either PKCS #1 or
1228
+ PKCS #8.
1229
+ client_certificate (str):
1230
+ PEM representation of the replica's x509
1231
+ certificate.
1232
+ ca_certificate (str):
1233
+ PEM representation of the trusted CA's x509
1234
+ certificate.
1235
+ """
1236
+
1237
+ kind: str = proto.Field(
1238
+ proto.STRING,
1239
+ number=1,
1240
+ )
1241
+ username: str = proto.Field(
1242
+ proto.STRING,
1243
+ number=2,
1244
+ )
1245
+ password: str = proto.Field(
1246
+ proto.STRING,
1247
+ number=3,
1248
+ )
1249
+ client_key: str = proto.Field(
1250
+ proto.STRING,
1251
+ number=4,
1252
+ )
1253
+ client_certificate: str = proto.Field(
1254
+ proto.STRING,
1255
+ number=5,
1256
+ )
1257
+ ca_certificate: str = proto.Field(
1258
+ proto.STRING,
1259
+ number=6,
1260
+ )
1261
+
1262
+
1263
+ class ExportContext(proto.Message):
1264
+ r"""Database instance export context.
1265
+
1266
+ Attributes:
1267
+ uri (str):
1268
+ The path to the file in Google Cloud Storage where the
1269
+ export will be stored. The URI is in the form
1270
+ ``gs://bucketName/fileName``. If the file already exists,
1271
+ the request succeeds, but the operation fails. If
1272
+ ``fileType`` is ``SQL`` and the filename ends with .gz, the
1273
+ contents are compressed.
1274
+ databases (MutableSequence[str]):
1275
+ Databases to be exported. ``MySQL instances:`` If
1276
+ ``fileType`` is ``SQL`` and no database is specified, all
1277
+ databases are exported, except for the ``mysql`` system
1278
+ database. If ``fileType`` is ``CSV``, you can specify one
1279
+ database, either by using this property or by using the
1280
+ ``csvExportOptions.selectQuery`` property, which takes
1281
+ precedence over this property. ``PostgreSQL instances:`` If
1282
+ you don't specify a database by name, all user databases in
1283
+ the instance are exported. This excludes system databases
1284
+ and Cloud SQL databases used to manage internal operations.
1285
+ Exporting all user databases is only available for
1286
+ directory-formatted parallel export. If ``fileType`` is
1287
+ ``CSV``, this database must match the one specified in the
1288
+ ``csvExportOptions.selectQuery`` property.
1289
+ ``SQL Server instances:`` You must specify one database to
1290
+ be exported, and the ``fileType`` must be ``BAK``.
1291
+ kind (str):
1292
+ This is always ``sql#exportContext``.
1293
+ sql_export_options (google.cloud.sqladmin_v1.types.ExportContext.SqlExportOptions):
1294
+ Options for exporting data as SQL statements.
1295
+ csv_export_options (google.cloud.sqladmin_v1.types.ExportContext.SqlCsvExportOptions):
1296
+ Options for exporting data as CSV. ``MySQL`` and
1297
+ ``PostgreSQL`` instances only.
1298
+ file_type (google.cloud.sqladmin_v1.types.SqlFileType):
1299
+ The file type for the specified uri.
1300
+ offload (google.protobuf.wrappers_pb2.BoolValue):
1301
+ Whether to perform a serverless export.
1302
+ bak_export_options (google.cloud.sqladmin_v1.types.ExportContext.SqlBakExportOptions):
1303
+ Options for exporting data as BAK files.
1304
+ tde_export_options (google.cloud.sqladmin_v1.types.ExportContext.SqlTdeExportOptions):
1305
+ Optional. Export parameters specific to SQL
1306
+ Server TDE certificates
1307
+ """
1308
+
1309
+ class SqlCsvExportOptions(proto.Message):
1310
+ r"""
1311
+
1312
+ Attributes:
1313
+ select_query (str):
1314
+ The select query used to extract the data.
1315
+ escape_character (str):
1316
+ Specifies the character that should appear
1317
+ before a data character that needs to be
1318
+ escaped.
1319
+ quote_character (str):
1320
+ Specifies the quoting character to be used
1321
+ when a data value is quoted.
1322
+ fields_terminated_by (str):
1323
+ Specifies the character that separates
1324
+ columns within each row (line) of the file.
1325
+ lines_terminated_by (str):
1326
+ This is used to separate lines. If a line
1327
+ does not contain all fields, the rest of the
1328
+ columns are set to their default values.
1329
+ """
1330
+
1331
+ select_query: str = proto.Field(
1332
+ proto.STRING,
1333
+ number=1,
1334
+ )
1335
+ escape_character: str = proto.Field(
1336
+ proto.STRING,
1337
+ number=2,
1338
+ )
1339
+ quote_character: str = proto.Field(
1340
+ proto.STRING,
1341
+ number=3,
1342
+ )
1343
+ fields_terminated_by: str = proto.Field(
1344
+ proto.STRING,
1345
+ number=4,
1346
+ )
1347
+ lines_terminated_by: str = proto.Field(
1348
+ proto.STRING,
1349
+ number=6,
1350
+ )
1351
+
1352
+ class SqlExportOptions(proto.Message):
1353
+ r"""
1354
+
1355
+ Attributes:
1356
+ tables (MutableSequence[str]):
1357
+ Tables to export, or that were exported, from
1358
+ the specified database. If you specify tables,
1359
+ specify one and only one database. For
1360
+ PostgreSQL instances, you can specify only one
1361
+ table.
1362
+ schema_only (google.protobuf.wrappers_pb2.BoolValue):
1363
+ Export only schemas.
1364
+ mysql_export_options (google.cloud.sqladmin_v1.types.ExportContext.SqlExportOptions.MysqlExportOptions):
1365
+
1366
+ threads (google.protobuf.wrappers_pb2.Int32Value):
1367
+ Optional. The number of threads to use for
1368
+ parallel export.
1369
+ parallel (google.protobuf.wrappers_pb2.BoolValue):
1370
+ Optional. Whether or not the export should be
1371
+ parallel.
1372
+ postgres_export_options (google.cloud.sqladmin_v1.types.ExportContext.SqlExportOptions.PostgresExportOptions):
1373
+ Optional. Options for exporting from a Cloud
1374
+ SQL for PostgreSQL instance.
1375
+ """
1376
+
1377
+ class MysqlExportOptions(proto.Message):
1378
+ r"""Options for exporting from MySQL.
1379
+
1380
+ Attributes:
1381
+ master_data (google.protobuf.wrappers_pb2.Int32Value):
1382
+ Option to include SQL statement required to set up
1383
+ replication. If set to ``1``, the dump file includes a
1384
+ CHANGE MASTER TO statement with the binary log coordinates,
1385
+ and --set-gtid-purged is set to ON. If set to ``2``, the
1386
+ CHANGE MASTER TO statement is written as a SQL comment and
1387
+ has no effect. If set to any value other than ``1``,
1388
+ --set-gtid-purged is set to OFF.
1389
+ """
1390
+
1391
+ master_data: wrappers_pb2.Int32Value = proto.Field(
1392
+ proto.MESSAGE,
1393
+ number=1,
1394
+ message=wrappers_pb2.Int32Value,
1395
+ )
1396
+
1397
+ class PostgresExportOptions(proto.Message):
1398
+ r"""Options for exporting from a Cloud SQL for PostgreSQL
1399
+ instance.
1400
+
1401
+ Attributes:
1402
+ clean (google.protobuf.wrappers_pb2.BoolValue):
1403
+ Optional. Use this option to include DROP
1404
+ <code>&lt;object&gt;</code> SQL statements. Use
1405
+ these statements to delete database objects
1406
+ before running the import operation.
1407
+ if_exists (google.protobuf.wrappers_pb2.BoolValue):
1408
+ Optional. Option to include an IF EXISTS SQL
1409
+ statement with each DROP statement produced by
1410
+ clean.
1411
+ """
1412
+
1413
+ clean: wrappers_pb2.BoolValue = proto.Field(
1414
+ proto.MESSAGE,
1415
+ number=1,
1416
+ message=wrappers_pb2.BoolValue,
1417
+ )
1418
+ if_exists: wrappers_pb2.BoolValue = proto.Field(
1419
+ proto.MESSAGE,
1420
+ number=2,
1421
+ message=wrappers_pb2.BoolValue,
1422
+ )
1423
+
1424
+ tables: MutableSequence[str] = proto.RepeatedField(
1425
+ proto.STRING,
1426
+ number=1,
1427
+ )
1428
+ schema_only: wrappers_pb2.BoolValue = proto.Field(
1429
+ proto.MESSAGE,
1430
+ number=2,
1431
+ message=wrappers_pb2.BoolValue,
1432
+ )
1433
+ mysql_export_options: "ExportContext.SqlExportOptions.MysqlExportOptions" = (
1434
+ proto.Field(
1435
+ proto.MESSAGE,
1436
+ number=3,
1437
+ message="ExportContext.SqlExportOptions.MysqlExportOptions",
1438
+ )
1439
+ )
1440
+ threads: wrappers_pb2.Int32Value = proto.Field(
1441
+ proto.MESSAGE,
1442
+ number=4,
1443
+ message=wrappers_pb2.Int32Value,
1444
+ )
1445
+ parallel: wrappers_pb2.BoolValue = proto.Field(
1446
+ proto.MESSAGE,
1447
+ number=5,
1448
+ message=wrappers_pb2.BoolValue,
1449
+ )
1450
+ postgres_export_options: "ExportContext.SqlExportOptions.PostgresExportOptions" = proto.Field(
1451
+ proto.MESSAGE,
1452
+ number=6,
1453
+ message="ExportContext.SqlExportOptions.PostgresExportOptions",
1454
+ )
1455
+
1456
+ class SqlBakExportOptions(proto.Message):
1457
+ r"""Options for exporting BAK files (SQL Server-only)
1458
+
1459
+ Attributes:
1460
+ striped (google.protobuf.wrappers_pb2.BoolValue):
1461
+ Whether or not the export should be striped.
1462
+ stripe_count (google.protobuf.wrappers_pb2.Int32Value):
1463
+ Option for specifying how many stripes to use
1464
+ for the export. If blank, and the value of the
1465
+ striped field is true, the number of stripes is
1466
+ automatically chosen.
1467
+ bak_type (google.cloud.sqladmin_v1.types.BakType):
1468
+ Type of this bak file will be export, FULL or
1469
+ DIFF, SQL Server only
1470
+ copy_only (google.protobuf.wrappers_pb2.BoolValue):
1471
+ Deprecated: copy_only is deprecated. Use differential_base
1472
+ instead
1473
+ differential_base (google.protobuf.wrappers_pb2.BoolValue):
1474
+ Whether or not the backup can be used as a differential base
1475
+ copy_only backup can not be served as differential base
1476
+ export_log_start_time (google.protobuf.timestamp_pb2.Timestamp):
1477
+ Optional. The begin timestamp when transaction log will be
1478
+ included in the export operation. `RFC
1479
+ 3339 <https://tools.ietf.org/html/rfc3339>`__ format (for
1480
+ example, ``2023-10-01T16:19:00.094``) in UTC. When omitted,
1481
+ all available logs from the beginning of retention period
1482
+ will be included. Only applied to Cloud SQL for SQL Server.
1483
+ export_log_end_time (google.protobuf.timestamp_pb2.Timestamp):
1484
+ Optional. The end timestamp when transaction log will be
1485
+ included in the export operation. `RFC
1486
+ 3339 <https://tools.ietf.org/html/rfc3339>`__ format (for
1487
+ example, ``2023-10-01T16:19:00.094``) in UTC. When omitted,
1488
+ all available logs until current time will be included. Only
1489
+ applied to Cloud SQL for SQL Server.
1490
+ """
1491
+
1492
+ striped: wrappers_pb2.BoolValue = proto.Field(
1493
+ proto.MESSAGE,
1494
+ number=1,
1495
+ message=wrappers_pb2.BoolValue,
1496
+ )
1497
+ stripe_count: wrappers_pb2.Int32Value = proto.Field(
1498
+ proto.MESSAGE,
1499
+ number=2,
1500
+ message=wrappers_pb2.Int32Value,
1501
+ )
1502
+ bak_type: "BakType" = proto.Field(
1503
+ proto.ENUM,
1504
+ number=4,
1505
+ enum="BakType",
1506
+ )
1507
+ copy_only: wrappers_pb2.BoolValue = proto.Field(
1508
+ proto.MESSAGE,
1509
+ number=5,
1510
+ message=wrappers_pb2.BoolValue,
1511
+ )
1512
+ differential_base: wrappers_pb2.BoolValue = proto.Field(
1513
+ proto.MESSAGE,
1514
+ number=6,
1515
+ message=wrappers_pb2.BoolValue,
1516
+ )
1517
+ export_log_start_time: timestamp_pb2.Timestamp = proto.Field(
1518
+ proto.MESSAGE,
1519
+ number=7,
1520
+ message=timestamp_pb2.Timestamp,
1521
+ )
1522
+ export_log_end_time: timestamp_pb2.Timestamp = proto.Field(
1523
+ proto.MESSAGE,
1524
+ number=8,
1525
+ message=timestamp_pb2.Timestamp,
1526
+ )
1527
+
1528
+ class SqlTdeExportOptions(proto.Message):
1529
+ r"""
1530
+
1531
+ Attributes:
1532
+ certificate_path (str):
1533
+ Required. Path to the TDE certificate public
1534
+ key in the form gs://bucketName/fileName.
1535
+ The instance must have write access to the
1536
+ bucket. Applicable only for SQL Server
1537
+ instances.
1538
+ private_key_path (str):
1539
+ Required. Path to the TDE certificate private
1540
+ key in the form gs://bucketName/fileName.
1541
+ The instance must have write access to the
1542
+ location. Applicable only for SQL Server
1543
+ instances.
1544
+ private_key_password (str):
1545
+ Required. Password that encrypts the private
1546
+ key.
1547
+ name (str):
1548
+ Required. Certificate name.
1549
+ Applicable only for SQL Server instances.
1550
+ """
1551
+
1552
+ certificate_path: str = proto.Field(
1553
+ proto.STRING,
1554
+ number=1,
1555
+ )
1556
+ private_key_path: str = proto.Field(
1557
+ proto.STRING,
1558
+ number=2,
1559
+ )
1560
+ private_key_password: str = proto.Field(
1561
+ proto.STRING,
1562
+ number=3,
1563
+ )
1564
+ name: str = proto.Field(
1565
+ proto.STRING,
1566
+ number=5,
1567
+ )
1568
+
1569
+ uri: str = proto.Field(
1570
+ proto.STRING,
1571
+ number=1,
1572
+ )
1573
+ databases: MutableSequence[str] = proto.RepeatedField(
1574
+ proto.STRING,
1575
+ number=2,
1576
+ )
1577
+ kind: str = proto.Field(
1578
+ proto.STRING,
1579
+ number=3,
1580
+ )
1581
+ sql_export_options: SqlExportOptions = proto.Field(
1582
+ proto.MESSAGE,
1583
+ number=4,
1584
+ message=SqlExportOptions,
1585
+ )
1586
+ csv_export_options: SqlCsvExportOptions = proto.Field(
1587
+ proto.MESSAGE,
1588
+ number=5,
1589
+ message=SqlCsvExportOptions,
1590
+ )
1591
+ file_type: "SqlFileType" = proto.Field(
1592
+ proto.ENUM,
1593
+ number=6,
1594
+ enum="SqlFileType",
1595
+ )
1596
+ offload: wrappers_pb2.BoolValue = proto.Field(
1597
+ proto.MESSAGE,
1598
+ number=8,
1599
+ message=wrappers_pb2.BoolValue,
1600
+ )
1601
+ bak_export_options: SqlBakExportOptions = proto.Field(
1602
+ proto.MESSAGE,
1603
+ number=9,
1604
+ message=SqlBakExportOptions,
1605
+ )
1606
+ tde_export_options: SqlTdeExportOptions = proto.Field(
1607
+ proto.MESSAGE,
1608
+ number=10,
1609
+ message=SqlTdeExportOptions,
1610
+ )
1611
+
1612
+
1613
+ class ImportContext(proto.Message):
1614
+ r"""Database instance import context.
1615
+
1616
+ Attributes:
1617
+ uri (str):
1618
+ Path to the import file in Cloud Storage, in the form
1619
+ ``gs://bucketName/fileName``. Compressed gzip files (.gz)
1620
+ are supported when ``fileType`` is ``SQL``. The instance
1621
+ must have write permissions to the bucket and read access to
1622
+ the file.
1623
+ database (str):
1624
+ The target database for the import. If ``fileType`` is
1625
+ ``SQL``, this field is required only if the import file does
1626
+ not specify a database, and is overridden by any database
1627
+ specification in the import file. For entire instance
1628
+ parallel import operations, the database is overridden by
1629
+ the database name stored in subdirectory name. If
1630
+ ``fileType`` is ``CSV``, one database must be specified.
1631
+ kind (str):
1632
+ This is always ``sql#importContext``.
1633
+ file_type (google.cloud.sqladmin_v1.types.SqlFileType):
1634
+ The file type for the specified
1635
+ uri.`SQL\ ``: The file contains SQL statements. \``\ CSV\`:
1636
+ The file contains CSV data.
1637
+ csv_import_options (google.cloud.sqladmin_v1.types.ImportContext.SqlCsvImportOptions):
1638
+ Options for importing data as CSV.
1639
+ import_user (str):
1640
+ The PostgreSQL user for this import
1641
+ operation. PostgreSQL instances only.
1642
+ bak_import_options (google.cloud.sqladmin_v1.types.ImportContext.SqlBakImportOptions):
1643
+ Import parameters specific to SQL Server .BAK
1644
+ files
1645
+ sql_import_options (google.cloud.sqladmin_v1.types.ImportContext.SqlImportOptions):
1646
+ Optional. Options for importing data from SQL
1647
+ statements.
1648
+ tde_import_options (google.cloud.sqladmin_v1.types.ImportContext.SqlTdeImportOptions):
1649
+ Optional. Import parameters specific to SQL
1650
+ Server TDE certificates
1651
+ """
1652
+
1653
+ class SqlImportOptions(proto.Message):
1654
+ r"""
1655
+
1656
+ Attributes:
1657
+ threads (google.protobuf.wrappers_pb2.Int32Value):
1658
+ Optional. The number of threads to use for
1659
+ parallel import.
1660
+ parallel (google.protobuf.wrappers_pb2.BoolValue):
1661
+ Optional. Whether or not the import should be
1662
+ parallel.
1663
+ postgres_import_options (google.cloud.sqladmin_v1.types.ImportContext.SqlImportOptions.PostgresImportOptions):
1664
+ Optional. Options for importing from a Cloud
1665
+ SQL for PostgreSQL instance.
1666
+ """
1667
+
1668
+ class PostgresImportOptions(proto.Message):
1669
+ r"""
1670
+
1671
+ Attributes:
1672
+ clean (google.protobuf.wrappers_pb2.BoolValue):
1673
+ Optional. The --clean flag for the pg_restore utility. This
1674
+ flag applies only if you enabled Cloud SQL to import files
1675
+ in parallel.
1676
+ if_exists (google.protobuf.wrappers_pb2.BoolValue):
1677
+ Optional. The --if-exists flag for the pg_restore utility.
1678
+ This flag applies only if you enabled Cloud SQL to import
1679
+ files in parallel.
1680
+ """
1681
+
1682
+ clean: wrappers_pb2.BoolValue = proto.Field(
1683
+ proto.MESSAGE,
1684
+ number=1,
1685
+ message=wrappers_pb2.BoolValue,
1686
+ )
1687
+ if_exists: wrappers_pb2.BoolValue = proto.Field(
1688
+ proto.MESSAGE,
1689
+ number=2,
1690
+ message=wrappers_pb2.BoolValue,
1691
+ )
1692
+
1693
+ threads: wrappers_pb2.Int32Value = proto.Field(
1694
+ proto.MESSAGE,
1695
+ number=1,
1696
+ message=wrappers_pb2.Int32Value,
1697
+ )
1698
+ parallel: wrappers_pb2.BoolValue = proto.Field(
1699
+ proto.MESSAGE,
1700
+ number=2,
1701
+ message=wrappers_pb2.BoolValue,
1702
+ )
1703
+ postgres_import_options: "ImportContext.SqlImportOptions.PostgresImportOptions" = proto.Field(
1704
+ proto.MESSAGE,
1705
+ number=3,
1706
+ message="ImportContext.SqlImportOptions.PostgresImportOptions",
1707
+ )
1708
+
1709
+ class SqlCsvImportOptions(proto.Message):
1710
+ r"""
1711
+
1712
+ Attributes:
1713
+ table (str):
1714
+ The table to which CSV data is imported.
1715
+ columns (MutableSequence[str]):
1716
+ The columns to which CSV data is imported. If
1717
+ not specified, all columns of the database table
1718
+ are loaded with CSV data.
1719
+ escape_character (str):
1720
+ Specifies the character that should appear
1721
+ before a data character that needs to be
1722
+ escaped.
1723
+ quote_character (str):
1724
+ Specifies the quoting character to be used
1725
+ when a data value is quoted.
1726
+ fields_terminated_by (str):
1727
+ Specifies the character that separates
1728
+ columns within each row (line) of the file.
1729
+ lines_terminated_by (str):
1730
+ This is used to separate lines. If a line
1731
+ does not contain all fields, the rest of the
1732
+ columns are set to their default values.
1733
+ """
1734
+
1735
+ table: str = proto.Field(
1736
+ proto.STRING,
1737
+ number=1,
1738
+ )
1739
+ columns: MutableSequence[str] = proto.RepeatedField(
1740
+ proto.STRING,
1741
+ number=2,
1742
+ )
1743
+ escape_character: str = proto.Field(
1744
+ proto.STRING,
1745
+ number=4,
1746
+ )
1747
+ quote_character: str = proto.Field(
1748
+ proto.STRING,
1749
+ number=5,
1750
+ )
1751
+ fields_terminated_by: str = proto.Field(
1752
+ proto.STRING,
1753
+ number=6,
1754
+ )
1755
+ lines_terminated_by: str = proto.Field(
1756
+ proto.STRING,
1757
+ number=8,
1758
+ )
1759
+
1760
+ class SqlBakImportOptions(proto.Message):
1761
+ r"""
1762
+
1763
+ Attributes:
1764
+ encryption_options (google.cloud.sqladmin_v1.types.ImportContext.SqlBakImportOptions.EncryptionOptions):
1765
+
1766
+ striped (google.protobuf.wrappers_pb2.BoolValue):
1767
+ Whether or not the backup set being restored
1768
+ is striped. Applies only to Cloud SQL for SQL
1769
+ Server.
1770
+ no_recovery (google.protobuf.wrappers_pb2.BoolValue):
1771
+ Whether or not the backup importing will
1772
+ restore database with NORECOVERY option.
1773
+ Applies only to Cloud SQL for SQL Server.
1774
+ recovery_only (google.protobuf.wrappers_pb2.BoolValue):
1775
+ Whether or not the backup importing request will just bring
1776
+ database online without downloading Bak content only one of
1777
+ "no_recovery" and "recovery_only" can be true otherwise
1778
+ error will return. Applies only to Cloud SQL for SQL Server.
1779
+ bak_type (google.cloud.sqladmin_v1.types.BakType):
1780
+ Type of the bak content, FULL or DIFF
1781
+ stop_at (google.protobuf.timestamp_pb2.Timestamp):
1782
+ Optional. The timestamp when the import should stop. This
1783
+ timestamp is in the `RFC
1784
+ 3339 <https://tools.ietf.org/html/rfc3339>`__ format (for
1785
+ example, ``2023-10-01T16:19:00.094``). This field is
1786
+ equivalent to the STOPAT keyword and applies to Cloud SQL
1787
+ for SQL Server only.
1788
+ stop_at_mark (str):
1789
+ Optional. The marked transaction where the
1790
+ import should stop. This field is equivalent to
1791
+ the STOPATMARK keyword and applies to Cloud SQL
1792
+ for SQL Server only.
1793
+ """
1794
+
1795
+ class EncryptionOptions(proto.Message):
1796
+ r"""
1797
+
1798
+ Attributes:
1799
+ cert_path (str):
1800
+ Path to the Certificate (.cer) in Cloud Storage, in the form
1801
+ ``gs://bucketName/fileName``. The instance must have write
1802
+ permissions to the bucket and read access to the file.
1803
+ pvk_path (str):
1804
+ Path to the Certificate Private Key (.pvk) in Cloud Storage,
1805
+ in the form ``gs://bucketName/fileName``. The instance must
1806
+ have write permissions to the bucket and read access to the
1807
+ file.
1808
+ pvk_password (str):
1809
+ Password that encrypts the private key
1810
+ keep_encrypted (google.protobuf.wrappers_pb2.BoolValue):
1811
+ Optional. Whether the imported file remains
1812
+ encrypted.
1813
+ """
1814
+
1815
+ cert_path: str = proto.Field(
1816
+ proto.STRING,
1817
+ number=1,
1818
+ )
1819
+ pvk_path: str = proto.Field(
1820
+ proto.STRING,
1821
+ number=2,
1822
+ )
1823
+ pvk_password: str = proto.Field(
1824
+ proto.STRING,
1825
+ number=3,
1826
+ )
1827
+ keep_encrypted: wrappers_pb2.BoolValue = proto.Field(
1828
+ proto.MESSAGE,
1829
+ number=5,
1830
+ message=wrappers_pb2.BoolValue,
1831
+ )
1832
+
1833
+ encryption_options: "ImportContext.SqlBakImportOptions.EncryptionOptions" = (
1834
+ proto.Field(
1835
+ proto.MESSAGE,
1836
+ number=1,
1837
+ message="ImportContext.SqlBakImportOptions.EncryptionOptions",
1838
+ )
1839
+ )
1840
+ striped: wrappers_pb2.BoolValue = proto.Field(
1841
+ proto.MESSAGE,
1842
+ number=2,
1843
+ message=wrappers_pb2.BoolValue,
1844
+ )
1845
+ no_recovery: wrappers_pb2.BoolValue = proto.Field(
1846
+ proto.MESSAGE,
1847
+ number=4,
1848
+ message=wrappers_pb2.BoolValue,
1849
+ )
1850
+ recovery_only: wrappers_pb2.BoolValue = proto.Field(
1851
+ proto.MESSAGE,
1852
+ number=5,
1853
+ message=wrappers_pb2.BoolValue,
1854
+ )
1855
+ bak_type: "BakType" = proto.Field(
1856
+ proto.ENUM,
1857
+ number=6,
1858
+ enum="BakType",
1859
+ )
1860
+ stop_at: timestamp_pb2.Timestamp = proto.Field(
1861
+ proto.MESSAGE,
1862
+ number=7,
1863
+ message=timestamp_pb2.Timestamp,
1864
+ )
1865
+ stop_at_mark: str = proto.Field(
1866
+ proto.STRING,
1867
+ number=8,
1868
+ )
1869
+
1870
+ class SqlTdeImportOptions(proto.Message):
1871
+ r"""
1872
+
1873
+ Attributes:
1874
+ certificate_path (str):
1875
+ Required. Path to the TDE certificate public
1876
+ key in the form gs://bucketName/fileName.
1877
+ The instance must have read access to the file.
1878
+ Applicable only for SQL Server instances.
1879
+ private_key_path (str):
1880
+ Required. Path to the TDE certificate private
1881
+ key in the form gs://bucketName/fileName.
1882
+ The instance must have read access to the file.
1883
+ Applicable only for SQL Server instances.
1884
+ private_key_password (str):
1885
+ Required. Password that encrypts the private
1886
+ key.
1887
+ name (str):
1888
+ Required. Certificate name.
1889
+ Applicable only for SQL Server instances.
1890
+ """
1891
+
1892
+ certificate_path: str = proto.Field(
1893
+ proto.STRING,
1894
+ number=1,
1895
+ )
1896
+ private_key_path: str = proto.Field(
1897
+ proto.STRING,
1898
+ number=2,
1899
+ )
1900
+ private_key_password: str = proto.Field(
1901
+ proto.STRING,
1902
+ number=3,
1903
+ )
1904
+ name: str = proto.Field(
1905
+ proto.STRING,
1906
+ number=5,
1907
+ )
1908
+
1909
+ uri: str = proto.Field(
1910
+ proto.STRING,
1911
+ number=1,
1912
+ )
1913
+ database: str = proto.Field(
1914
+ proto.STRING,
1915
+ number=2,
1916
+ )
1917
+ kind: str = proto.Field(
1918
+ proto.STRING,
1919
+ number=3,
1920
+ )
1921
+ file_type: "SqlFileType" = proto.Field(
1922
+ proto.ENUM,
1923
+ number=4,
1924
+ enum="SqlFileType",
1925
+ )
1926
+ csv_import_options: SqlCsvImportOptions = proto.Field(
1927
+ proto.MESSAGE,
1928
+ number=5,
1929
+ message=SqlCsvImportOptions,
1930
+ )
1931
+ import_user: str = proto.Field(
1932
+ proto.STRING,
1933
+ number=6,
1934
+ )
1935
+ bak_import_options: SqlBakImportOptions = proto.Field(
1936
+ proto.MESSAGE,
1937
+ number=7,
1938
+ message=SqlBakImportOptions,
1939
+ )
1940
+ sql_import_options: SqlImportOptions = proto.Field(
1941
+ proto.MESSAGE,
1942
+ number=8,
1943
+ message=SqlImportOptions,
1944
+ )
1945
+ tde_import_options: SqlTdeImportOptions = proto.Field(
1946
+ proto.MESSAGE,
1947
+ number=9,
1948
+ message=SqlTdeImportOptions,
1949
+ )
1950
+
1951
+
1952
+ class IpConfiguration(proto.Message):
1953
+ r"""IP Management configuration.
1954
+
1955
+ .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
1956
+
1957
+ Attributes:
1958
+ ipv4_enabled (google.protobuf.wrappers_pb2.BoolValue):
1959
+ Whether the instance is assigned a public IP
1960
+ address or not.
1961
+ private_network (str):
1962
+ The resource link for the VPC network from which the Cloud
1963
+ SQL instance is accessible for private IP. For example,
1964
+ ``/projects/myProject/global/networks/default``. This
1965
+ setting can be updated, but it cannot be removed after it is
1966
+ set.
1967
+ require_ssl (google.protobuf.wrappers_pb2.BoolValue):
1968
+ Use ``ssl_mode`` instead.
1969
+
1970
+ Whether SSL/TLS connections over IP are enforced. If set to
1971
+ false, then allow both non-SSL/non-TLS and SSL/TLS
1972
+ connections. For SSL/TLS connections, the client certificate
1973
+ won't be verified. If set to true, then only allow
1974
+ connections encrypted with SSL/TLS and with valid client
1975
+ certificates. If you want to enforce SSL/TLS without
1976
+ enforcing the requirement for valid client certificates,
1977
+ then use the ``ssl_mode`` flag instead of the
1978
+ ``require_ssl`` flag.
1979
+ authorized_networks (MutableSequence[google.cloud.sqladmin_v1.types.AclEntry]):
1980
+ The list of external networks that are allowed to connect to
1981
+ the instance using the IP. In 'CIDR' notation, also known as
1982
+ 'slash' notation (for example: ``157.197.200.0/24``).
1983
+ allocated_ip_range (str):
1984
+ The name of the allocated ip range for the private ip Cloud
1985
+ SQL instance. For example:
1986
+ "google-managed-services-default". If set, the instance ip
1987
+ will be created in the allocated range. The range name must
1988
+ comply with `RFC
1989
+ 1035 <https://tools.ietf.org/html/rfc1035>`__. Specifically,
1990
+ the name must be 1-63 characters long and match the regular
1991
+ expression ``[a-z]([-a-z0-9]*[a-z0-9])?.``
1992
+ enable_private_path_for_google_cloud_services (google.protobuf.wrappers_pb2.BoolValue):
1993
+ Controls connectivity to private IP instances
1994
+ from Google services, such as BigQuery.
1995
+ ssl_mode (google.cloud.sqladmin_v1.types.IpConfiguration.SslMode):
1996
+ Specify how SSL/TLS is enforced in database connections. If
1997
+ you must use the ``require_ssl`` flag for backward
1998
+ compatibility, then only the following value pairs are
1999
+ valid:
2000
+
2001
+ For PostgreSQL and MySQL:
2002
+
2003
+ - ``ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED`` and
2004
+ ``require_ssl=false``
2005
+ - ``ssl_mode=ENCRYPTED_ONLY`` and ``require_ssl=false``
2006
+ - ``ssl_mode=TRUSTED_CLIENT_CERTIFICATE_REQUIRED`` and
2007
+ ``require_ssl=true``
2008
+
2009
+ For SQL Server:
2010
+
2011
+ - ``ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED`` and
2012
+ ``require_ssl=false``
2013
+ - ``ssl_mode=ENCRYPTED_ONLY`` and ``require_ssl=true``
2014
+
2015
+ The value of ``ssl_mode`` has priority over the value of
2016
+ ``require_ssl``.
2017
+
2018
+ For example, for the pair ``ssl_mode=ENCRYPTED_ONLY`` and
2019
+ ``require_ssl=false``, ``ssl_mode=ENCRYPTED_ONLY`` means
2020
+ accept only SSL connections, while ``require_ssl=false``
2021
+ means accept both non-SSL and SSL connections. In this case,
2022
+ MySQL and PostgreSQL databases respect ``ssl_mode`` and
2023
+ accepts only SSL connections.
2024
+ psc_config (google.cloud.sqladmin_v1.types.PscConfig):
2025
+ PSC settings for this instance.
2026
+
2027
+ This field is a member of `oneof`_ ``_psc_config``.
2028
+ server_ca_mode (google.cloud.sqladmin_v1.types.IpConfiguration.CaMode):
2029
+ Specify what type of CA is used for the
2030
+ server certificate.
2031
+
2032
+ This field is a member of `oneof`_ ``_server_ca_mode``.
2033
+ custom_subject_alternative_names (MutableSequence[str]):
2034
+ Optional. Custom Subject Alternative
2035
+ Name(SAN)s for a Cloud SQL instance.
2036
+ server_ca_pool (str):
2037
+ Optional. The resource name of the server CA pool for an
2038
+ instance with ``CUSTOMER_MANAGED_CAS_CA`` as the
2039
+ ``server_ca_mode``. Format:
2040
+ projects/{PROJECT}/locations/{REGION}/caPools/{CA_POOL_ID}
2041
+
2042
+ This field is a member of `oneof`_ ``_server_ca_pool``.
2043
+ server_certificate_rotation_mode (google.cloud.sqladmin_v1.types.IpConfiguration.ServerCertificateRotationMode):
2044
+ Optional. Controls the automatic server certificate rotation
2045
+ feature. This feature is disabled by default. When enabled,
2046
+ the server certificate will be automatically rotated during
2047
+ Cloud SQL scheduled maintenance or self-service maintenance
2048
+ updates up to six months before it expires. This setting can
2049
+ only be set if server_ca_mode is either
2050
+ GOOGLE_MANAGED_CAS_CA or CUSTOMER_MANAGED_CAS_CA.
2051
+
2052
+ This field is a member of `oneof`_ ``_server_certificate_rotation_mode``.
2053
+ """
2054
+
2055
+ class SslMode(proto.Enum):
2056
+ r"""The SSL options for database connections.
2057
+
2058
+ Values:
2059
+ SSL_MODE_UNSPECIFIED (0):
2060
+ The SSL mode is unknown.
2061
+ ALLOW_UNENCRYPTED_AND_ENCRYPTED (1):
2062
+ Allow non-SSL/non-TLS and SSL/TLS connections. For SSL
2063
+ connections to MySQL and PostgreSQL, the client certificate
2064
+ isn't verified.
2065
+
2066
+ When this value is used, the legacy ``require_ssl`` flag
2067
+ must be false or cleared to avoid a conflict between the
2068
+ values of the two flags.
2069
+ ENCRYPTED_ONLY (2):
2070
+ Only allow connections encrypted with SSL/TLS. For SSL
2071
+ connections to MySQL and PostgreSQL, the client certificate
2072
+ isn't verified.
2073
+
2074
+ When this value is used, the legacy ``require_ssl`` flag
2075
+ must be false or cleared to avoid a conflict between the
2076
+ values of the two flags.
2077
+ TRUSTED_CLIENT_CERTIFICATE_REQUIRED (3):
2078
+ Only allow connections encrypted with SSL/TLS and with valid
2079
+ client certificates.
2080
+
2081
+ When this value is used, the legacy ``require_ssl`` flag
2082
+ must be true or cleared to avoid the conflict between values
2083
+ of two flags. PostgreSQL clients or users that connect using
2084
+ IAM database authentication must use either the `Cloud SQL
2085
+ Auth
2086
+ Proxy <https://cloud.google.com/sql/docs/postgres/connect-auth-proxy>`__
2087
+ or `Cloud SQL
2088
+ Connectors <https://cloud.google.com/sql/docs/postgres/connect-connectors>`__
2089
+ to enforce client identity verification.
2090
+
2091
+ Only applicable to MySQL and PostgreSQL. Not applicable to
2092
+ SQL Server.
2093
+ """
2094
+
2095
+ SSL_MODE_UNSPECIFIED = 0
2096
+ ALLOW_UNENCRYPTED_AND_ENCRYPTED = 1
2097
+ ENCRYPTED_ONLY = 2
2098
+ TRUSTED_CLIENT_CERTIFICATE_REQUIRED = 3
2099
+
2100
+ class CaMode(proto.Enum):
2101
+ r"""Various Certificate Authority (CA) modes for certificate
2102
+ signing.
2103
+
2104
+ Values:
2105
+ CA_MODE_UNSPECIFIED (0):
2106
+ CA mode is unspecified. It is effectively the same as
2107
+ ``GOOGLE_MANAGED_INTERNAL_CA``.
2108
+ GOOGLE_MANAGED_INTERNAL_CA (1):
2109
+ Google-managed self-signed internal CA.
2110
+ GOOGLE_MANAGED_CAS_CA (2):
2111
+ Google-managed regional CA part of root CA
2112
+ hierarchy hosted on Google Cloud's Certificate
2113
+ Authority Service (CAS).
2114
+ CUSTOMER_MANAGED_CAS_CA (3):
2115
+ Customer-managed CA hosted on Google Cloud's
2116
+ Certificate Authority Service (CAS).
2117
+ """
2118
+
2119
+ CA_MODE_UNSPECIFIED = 0
2120
+ GOOGLE_MANAGED_INTERNAL_CA = 1
2121
+ GOOGLE_MANAGED_CAS_CA = 2
2122
+ CUSTOMER_MANAGED_CAS_CA = 3
2123
+
2124
+ class ServerCertificateRotationMode(proto.Enum):
2125
+ r"""Settings for automatic server certificate rotation.
2126
+
2127
+ Values:
2128
+ SERVER_CERTIFICATE_ROTATION_MODE_UNSPECIFIED (0):
2129
+ Unspecified: no automatic server certificate
2130
+ rotation.
2131
+ NO_AUTOMATIC_ROTATION (1):
2132
+ No automatic server certificate rotation. The user must
2133
+ `manage server certificate
2134
+ rotation </sql/docs/mysql/manage-ssl-instance#rotate-server-certificate-cas>`__
2135
+ on their side.
2136
+ AUTOMATIC_ROTATION_DURING_MAINTENANCE (2):
2137
+ Automatic server certificate rotation during Cloud SQL
2138
+ scheduled maintenance or self-service maintenance updates.
2139
+ Requires ``server_ca_mode`` to be ``GOOGLE_MANAGED_CAS_CA``
2140
+ or ``CUSTOMER_MANAGED_CAS_CA``.
2141
+ """
2142
+
2143
+ SERVER_CERTIFICATE_ROTATION_MODE_UNSPECIFIED = 0
2144
+ NO_AUTOMATIC_ROTATION = 1
2145
+ AUTOMATIC_ROTATION_DURING_MAINTENANCE = 2
2146
+
2147
+ ipv4_enabled: wrappers_pb2.BoolValue = proto.Field(
2148
+ proto.MESSAGE,
2149
+ number=1,
2150
+ message=wrappers_pb2.BoolValue,
2151
+ )
2152
+ private_network: str = proto.Field(
2153
+ proto.STRING,
2154
+ number=2,
2155
+ )
2156
+ require_ssl: wrappers_pb2.BoolValue = proto.Field(
2157
+ proto.MESSAGE,
2158
+ number=3,
2159
+ message=wrappers_pb2.BoolValue,
2160
+ )
2161
+ authorized_networks: MutableSequence["AclEntry"] = proto.RepeatedField(
2162
+ proto.MESSAGE,
2163
+ number=4,
2164
+ message="AclEntry",
2165
+ )
2166
+ allocated_ip_range: str = proto.Field(
2167
+ proto.STRING,
2168
+ number=6,
2169
+ )
2170
+ enable_private_path_for_google_cloud_services: wrappers_pb2.BoolValue = proto.Field(
2171
+ proto.MESSAGE,
2172
+ number=7,
2173
+ message=wrappers_pb2.BoolValue,
2174
+ )
2175
+ ssl_mode: SslMode = proto.Field(
2176
+ proto.ENUM,
2177
+ number=8,
2178
+ enum=SslMode,
2179
+ )
2180
+ psc_config: "PscConfig" = proto.Field(
2181
+ proto.MESSAGE,
2182
+ number=9,
2183
+ optional=True,
2184
+ message="PscConfig",
2185
+ )
2186
+ server_ca_mode: CaMode = proto.Field(
2187
+ proto.ENUM,
2188
+ number=10,
2189
+ optional=True,
2190
+ enum=CaMode,
2191
+ )
2192
+ custom_subject_alternative_names: MutableSequence[str] = proto.RepeatedField(
2193
+ proto.STRING,
2194
+ number=11,
2195
+ )
2196
+ server_ca_pool: str = proto.Field(
2197
+ proto.STRING,
2198
+ number=12,
2199
+ optional=True,
2200
+ )
2201
+ server_certificate_rotation_mode: ServerCertificateRotationMode = proto.Field(
2202
+ proto.ENUM,
2203
+ number=16,
2204
+ optional=True,
2205
+ enum=ServerCertificateRotationMode,
2206
+ )
2207
+
2208
+
2209
+ class PscConfig(proto.Message):
2210
+ r"""PSC settings for a Cloud SQL instance.
2211
+
2212
+ .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
2213
+
2214
+ Attributes:
2215
+ psc_enabled (bool):
2216
+ Whether PSC connectivity is enabled for this
2217
+ instance.
2218
+
2219
+ This field is a member of `oneof`_ ``_psc_enabled``.
2220
+ allowed_consumer_projects (MutableSequence[str]):
2221
+ Optional. The list of consumer projects that
2222
+ are allow-listed for PSC connections to this
2223
+ instance. This instance can be connected to with
2224
+ PSC from any network in these projects.
2225
+
2226
+ Each consumer project in this list may be
2227
+ represented by a project number (numeric) or by
2228
+ a project id (alphanumeric).
2229
+ psc_auto_connections (MutableSequence[google.cloud.sqladmin_v1.types.PscAutoConnectionConfig]):
2230
+ Optional. The list of settings for requested
2231
+ Private Service Connect consumer endpoints that
2232
+ can be used to connect to this Cloud SQL
2233
+ instance.
2234
+ network_attachment_uri (str):
2235
+ Optional. The network attachment of the
2236
+ consumer network that the Private Service
2237
+ Connect enabled Cloud SQL instance is authorized
2238
+ to connect via PSC interface.
2239
+ format:
2240
+ projects/PROJECT/regions/REGION/networkAttachments/ID
2241
+ psc_auto_dns_enabled (bool):
2242
+ Optional. Indicates whether Private Service
2243
+ Connect DNS automation is enabled for this
2244
+ instance. When enabled, Cloud SQL provisions a
2245
+ universal DNS record across all networks
2246
+ configured with Private Service Connect
2247
+ auto-connections. This will default to true for
2248
+ new instances when Private Service Connect is
2249
+ enabled.
2250
+
2251
+ This field is a member of `oneof`_ ``_psc_auto_dns_enabled``.
2252
+ psc_write_endpoint_dns_enabled (bool):
2253
+ Optional. Indicates whether Private Service Connect write
2254
+ endpoint DNS automation is enabled for this instance. When
2255
+ enabled, Cloud SQL provisions a universal global DNS record
2256
+ across all networks configured with Private Service Connect
2257
+ auto-connections that points to the cluster primary
2258
+ instance. This feature is only supported for Enterprise Plus
2259
+ edition. This will default to true for new Enterprise Plus
2260
+ instances when ``psc_auto_dns_enabled`` is enabled.
2261
+
2262
+ This field is a member of `oneof`_ ``_psc_write_endpoint_dns_enabled``.
2263
+ psc_auto_connection_policy_enabled (bool):
2264
+ Optional. Whether to set up the PSC service
2265
+ connection policy automatically.
2266
+
2267
+ This field is a member of `oneof`_ ``_psc_auto_connection_policy_enabled``.
2268
+ """
2269
+
2270
+ psc_enabled: bool = proto.Field(
2271
+ proto.BOOL,
2272
+ number=1,
2273
+ optional=True,
2274
+ )
2275
+ allowed_consumer_projects: MutableSequence[str] = proto.RepeatedField(
2276
+ proto.STRING,
2277
+ number=2,
2278
+ )
2279
+ psc_auto_connections: MutableSequence["PscAutoConnectionConfig"] = (
2280
+ proto.RepeatedField(
2281
+ proto.MESSAGE,
2282
+ number=3,
2283
+ message="PscAutoConnectionConfig",
2284
+ )
2285
+ )
2286
+ network_attachment_uri: str = proto.Field(
2287
+ proto.STRING,
2288
+ number=4,
2289
+ )
2290
+ psc_auto_dns_enabled: bool = proto.Field(
2291
+ proto.BOOL,
2292
+ number=5,
2293
+ optional=True,
2294
+ )
2295
+ psc_write_endpoint_dns_enabled: bool = proto.Field(
2296
+ proto.BOOL,
2297
+ number=6,
2298
+ optional=True,
2299
+ )
2300
+ psc_auto_connection_policy_enabled: bool = proto.Field(
2301
+ proto.BOOL,
2302
+ number=7,
2303
+ optional=True,
2304
+ )
2305
+
2306
+
2307
+ class PscAutoConnectionConfig(proto.Message):
2308
+ r"""Settings for an automatically-setup Private Service Connect
2309
+ consumer endpoint that is used to connect to a Cloud SQL
2310
+ instance.
2311
+
2312
+
2313
+ .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
2314
+
2315
+ Attributes:
2316
+ consumer_project (str):
2317
+ Optional. This is the project ID of consumer service project
2318
+ of this consumer endpoint.
2319
+
2320
+ This is only applicable if ``consumer_network`` is a shared
2321
+ VPC network.
2322
+ consumer_network (str):
2323
+ Optional. The consumer network of this consumer endpoint.
2324
+ This must be a resource path that includes both the host
2325
+ project and the network name.
2326
+
2327
+ For example, ``projects/project1/global/networks/network1``.
2328
+
2329
+ The consumer host project of this network might be different
2330
+ from the consumer service project.
2331
+ ip_address (str):
2332
+ The IP address of the consumer endpoint.
2333
+
2334
+ This field is a member of `oneof`_ ``_ip_address``.
2335
+ status (str):
2336
+ The connection status of the consumer
2337
+ endpoint.
2338
+
2339
+ This field is a member of `oneof`_ ``_status``.
2340
+ consumer_network_status (str):
2341
+ The connection policy status of the consumer
2342
+ network.
2343
+
2344
+ This field is a member of `oneof`_ ``_consumer_network_status``.
2345
+ service_connection_policy (str):
2346
+ Output only. The service connection policy created
2347
+ automatically for the consumer network when
2348
+ ``psc_auto_connection_policy_enabled`` is true. It is in the
2349
+ format of:
2350
+ ``projects/{project}/regions/{region}/serviceConnectionPolicies/{policy_id}``
2351
+ The ``policy_id`` is in format of ``$NETWORK-$RANDOM``.
2352
+
2353
+ This field is a member of `oneof`_ ``_service_connection_policy``.
2354
+ service_connection_policy_creation_result (str):
2355
+ Output only. The status of service connection
2356
+ policy creation.
2357
+
2358
+ This field is a member of `oneof`_ ``_service_connection_policy_creation_result``.
2359
+ instance_auto_dns_status (google.cloud.sqladmin_v1.types.AutoDnsStatus):
2360
+ Output only. The status of automated DNS
2361
+ provisioning.
2362
+
2363
+ This field is a member of `oneof`_ ``_instance_auto_dns_status``.
2364
+ write_endpoint_auto_dns_status (google.cloud.sqladmin_v1.types.AutoDnsStatus):
2365
+ Output only. The status of automated DNS
2366
+ provisioning for the write endpoint.
2367
+
2368
+ This field is a member of `oneof`_ ``_write_endpoint_auto_dns_status``.
2369
+ """
2370
+
2371
+ consumer_project: str = proto.Field(
2372
+ proto.STRING,
2373
+ number=1,
2374
+ )
2375
+ consumer_network: str = proto.Field(
2376
+ proto.STRING,
2377
+ number=2,
2378
+ )
2379
+ ip_address: str = proto.Field(
2380
+ proto.STRING,
2381
+ number=3,
2382
+ optional=True,
2383
+ )
2384
+ status: str = proto.Field(
2385
+ proto.STRING,
2386
+ number=4,
2387
+ optional=True,
2388
+ )
2389
+ consumer_network_status: str = proto.Field(
2390
+ proto.STRING,
2391
+ number=5,
2392
+ optional=True,
2393
+ )
2394
+ service_connection_policy: str = proto.Field(
2395
+ proto.STRING,
2396
+ number=6,
2397
+ optional=True,
2398
+ )
2399
+ service_connection_policy_creation_result: str = proto.Field(
2400
+ proto.STRING,
2401
+ number=7,
2402
+ optional=True,
2403
+ )
2404
+ instance_auto_dns_status: "AutoDnsStatus" = proto.Field(
2405
+ proto.ENUM,
2406
+ number=8,
2407
+ optional=True,
2408
+ enum="AutoDnsStatus",
2409
+ )
2410
+ write_endpoint_auto_dns_status: "AutoDnsStatus" = proto.Field(
2411
+ proto.ENUM,
2412
+ number=9,
2413
+ optional=True,
2414
+ enum="AutoDnsStatus",
2415
+ )
2416
+
2417
+
2418
+ class LocationPreference(proto.Message):
2419
+ r"""Preferred location. This specifies where a Cloud SQL instance
2420
+ is located. Note that if the preferred location is not
2421
+ available, the instance will be located as close as possible
2422
+ within the region. Only one location may be specified.
2423
+
2424
+ Attributes:
2425
+ follow_gae_application (str):
2426
+ The App Engine application to follow, it must
2427
+ be in the same region as the Cloud SQL instance.
2428
+ WARNING: Changing this might restart the
2429
+ instance.
2430
+ zone (str):
2431
+ The preferred Compute Engine zone (for
2432
+ example: us-central1-a, us-central1-b, etc.).
2433
+ WARNING: Changing this might restart the
2434
+ instance.
2435
+ secondary_zone (str):
2436
+ The preferred Compute Engine zone for the secondary/failover
2437
+ (for example: us-central1-a, us-central1-b, etc.). To
2438
+ disable this field, set it to 'no_secondary_zone'.
2439
+ kind (str):
2440
+ This is always ``sql#locationPreference``.
2441
+ """
2442
+
2443
+ follow_gae_application: str = proto.Field(
2444
+ proto.STRING,
2445
+ number=1,
2446
+ )
2447
+ zone: str = proto.Field(
2448
+ proto.STRING,
2449
+ number=2,
2450
+ )
2451
+ secondary_zone: str = proto.Field(
2452
+ proto.STRING,
2453
+ number=4,
2454
+ )
2455
+ kind: str = proto.Field(
2456
+ proto.STRING,
2457
+ number=3,
2458
+ )
2459
+
2460
+
2461
+ class MaintenanceWindow(proto.Message):
2462
+ r"""Maintenance window. This specifies when a Cloud SQL instance
2463
+ is restarted for system maintenance purposes.
2464
+
2465
+ Attributes:
2466
+ hour (google.protobuf.wrappers_pb2.Int32Value):
2467
+ Hour of day - 0 to 23. Specify in the UTC
2468
+ time zone.
2469
+ day (google.protobuf.wrappers_pb2.Int32Value):
2470
+ Day of week - ``MONDAY``, ``TUESDAY``, ``WEDNESDAY``,
2471
+ ``THURSDAY``, ``FRIDAY``, ``SATURDAY``, or ``SUNDAY``.
2472
+ Specify in the UTC time zone. Returned in output as an
2473
+ integer, 1 to 7, where ``1`` equals Monday.
2474
+ update_track (google.cloud.sqladmin_v1.types.SqlUpdateTrack):
2475
+ Maintenance timing settings: ``canary``, ``stable``, or
2476
+ ``week5``. For more information, see `About maintenance on
2477
+ Cloud SQL
2478
+ instances <https://cloud.google.com/sql/docs/mysql/maintenance>`__.
2479
+ kind (str):
2480
+ This is always ``sql#maintenanceWindow``.
2481
+ """
2482
+
2483
+ hour: wrappers_pb2.Int32Value = proto.Field(
2484
+ proto.MESSAGE,
2485
+ number=1,
2486
+ message=wrappers_pb2.Int32Value,
2487
+ )
2488
+ day: wrappers_pb2.Int32Value = proto.Field(
2489
+ proto.MESSAGE,
2490
+ number=2,
2491
+ message=wrappers_pb2.Int32Value,
2492
+ )
2493
+ update_track: "SqlUpdateTrack" = proto.Field(
2494
+ proto.ENUM,
2495
+ number=3,
2496
+ enum="SqlUpdateTrack",
2497
+ )
2498
+ kind: str = proto.Field(
2499
+ proto.STRING,
2500
+ number=4,
2501
+ )
2502
+
2503
+
2504
+ class DenyMaintenancePeriod(proto.Message):
2505
+ r"""Deny maintenance Periods. This specifies a date range during
2506
+ when all CSA rollout will be denied.
2507
+
2508
+ Attributes:
2509
+ start_date (str):
2510
+ "deny maintenance period" start date. If the
2511
+ year of the start date is empty, the year of the
2512
+ end date also must be empty. In this case, it
2513
+ means the deny maintenance period recurs every
2514
+ year. The date is in format yyyy-mm-dd i.e.,
2515
+ 2020-11-01, or mm-dd, i.e., 11-01
2516
+ end_date (str):
2517
+ "deny maintenance period" end date. If the
2518
+ year of the end date is empty, the year of the
2519
+ start date also must be empty. In this case, it
2520
+ means the no maintenance interval recurs every
2521
+ year. The date is in format yyyy-mm-dd i.e.,
2522
+ 2020-11-01, or mm-dd, i.e., 11-01
2523
+ time (str):
2524
+ Time in UTC when the "deny maintenance period" starts on
2525
+ start_date and ends on end_date. The time is in format:
2526
+ HH:mm:SS, i.e., 00:00:00
2527
+ """
2528
+
2529
+ start_date: str = proto.Field(
2530
+ proto.STRING,
2531
+ number=1,
2532
+ )
2533
+ end_date: str = proto.Field(
2534
+ proto.STRING,
2535
+ number=2,
2536
+ )
2537
+ time: str = proto.Field(
2538
+ proto.STRING,
2539
+ number=3,
2540
+ )
2541
+
2542
+
2543
+ class InsightsConfig(proto.Message):
2544
+ r"""Insights configuration. This specifies when Cloud SQL
2545
+ Insights feature is enabled and optional configuration.
2546
+
2547
+ Attributes:
2548
+ query_insights_enabled (bool):
2549
+ Whether Query Insights feature is enabled.
2550
+ record_client_address (bool):
2551
+ Whether Query Insights will record client
2552
+ address when enabled.
2553
+ record_application_tags (bool):
2554
+ Whether Query Insights will record
2555
+ application tags from query when enabled.
2556
+ query_string_length (google.protobuf.wrappers_pb2.Int32Value):
2557
+ Maximum query length stored in bytes. Default
2558
+ value: 1024 bytes. Range: 256-4500 bytes. Query
2559
+ lengths greater than this field value will be
2560
+ truncated to this value. When unset, query
2561
+ length will be the default value. Changing query
2562
+ length will restart the database.
2563
+ query_plans_per_minute (google.protobuf.wrappers_pb2.Int32Value):
2564
+ Number of query execution plans captured by
2565
+ Insights per minute for all queries combined.
2566
+ Default is 5.
2567
+ enhanced_query_insights_enabled (google.protobuf.wrappers_pb2.BoolValue):
2568
+ Optional. Whether enhanced query insights
2569
+ feature is enabled.
2570
+ """
2571
+
2572
+ query_insights_enabled: bool = proto.Field(
2573
+ proto.BOOL,
2574
+ number=1,
2575
+ )
2576
+ record_client_address: bool = proto.Field(
2577
+ proto.BOOL,
2578
+ number=2,
2579
+ )
2580
+ record_application_tags: bool = proto.Field(
2581
+ proto.BOOL,
2582
+ number=3,
2583
+ )
2584
+ query_string_length: wrappers_pb2.Int32Value = proto.Field(
2585
+ proto.MESSAGE,
2586
+ number=4,
2587
+ message=wrappers_pb2.Int32Value,
2588
+ )
2589
+ query_plans_per_minute: wrappers_pb2.Int32Value = proto.Field(
2590
+ proto.MESSAGE,
2591
+ number=5,
2592
+ message=wrappers_pb2.Int32Value,
2593
+ )
2594
+ enhanced_query_insights_enabled: wrappers_pb2.BoolValue = proto.Field(
2595
+ proto.MESSAGE,
2596
+ number=8,
2597
+ message=wrappers_pb2.BoolValue,
2598
+ )
2599
+
2600
+
2601
+ class MySqlReplicaConfiguration(proto.Message):
2602
+ r"""Read-replica configuration specific to MySQL databases.
2603
+
2604
+ Attributes:
2605
+ dump_file_path (str):
2606
+ Path to a SQL dump file in Google Cloud
2607
+ Storage from which the replica instance is to be
2608
+ created. The URI is in the form
2609
+ gs://bucketName/fileName. Compressed gzip files
2610
+ (.gz) are also supported. Dumps have the binlog
2611
+ co-ordinates from which replication begins. This
2612
+ can be accomplished by setting --master-data to
2613
+ 1 when using mysqldump.
2614
+ username (str):
2615
+ The username for the replication connection.
2616
+ password (str):
2617
+ The password for the replication connection.
2618
+ connect_retry_interval (google.protobuf.wrappers_pb2.Int32Value):
2619
+ Seconds to wait between connect retries.
2620
+ MySQL's default is 60 seconds.
2621
+ master_heartbeat_period (google.protobuf.wrappers_pb2.Int64Value):
2622
+ Interval in milliseconds between replication
2623
+ heartbeats.
2624
+ ca_certificate (str):
2625
+ PEM representation of the trusted CA's x509
2626
+ certificate.
2627
+ client_certificate (str):
2628
+ PEM representation of the replica's x509
2629
+ certificate.
2630
+ client_key (str):
2631
+ PEM representation of the replica's private
2632
+ key. The corresponding public key is encoded in
2633
+ the client's certificate.
2634
+ ssl_cipher (str):
2635
+ A list of permissible ciphers to use for SSL
2636
+ encryption.
2637
+ verify_server_certificate (google.protobuf.wrappers_pb2.BoolValue):
2638
+ Whether or not to check the primary
2639
+ instance's Common Name value in the certificate
2640
+ that it sends during the SSL handshake.
2641
+ kind (str):
2642
+ This is always ``sql#mysqlReplicaConfiguration``.
2643
+ """
2644
+
2645
+ dump_file_path: str = proto.Field(
2646
+ proto.STRING,
2647
+ number=1,
2648
+ )
2649
+ username: str = proto.Field(
2650
+ proto.STRING,
2651
+ number=2,
2652
+ )
2653
+ password: str = proto.Field(
2654
+ proto.STRING,
2655
+ number=3,
2656
+ )
2657
+ connect_retry_interval: wrappers_pb2.Int32Value = proto.Field(
2658
+ proto.MESSAGE,
2659
+ number=4,
2660
+ message=wrappers_pb2.Int32Value,
2661
+ )
2662
+ master_heartbeat_period: wrappers_pb2.Int64Value = proto.Field(
2663
+ proto.MESSAGE,
2664
+ number=5,
2665
+ message=wrappers_pb2.Int64Value,
2666
+ )
2667
+ ca_certificate: str = proto.Field(
2668
+ proto.STRING,
2669
+ number=6,
2670
+ )
2671
+ client_certificate: str = proto.Field(
2672
+ proto.STRING,
2673
+ number=7,
2674
+ )
2675
+ client_key: str = proto.Field(
2676
+ proto.STRING,
2677
+ number=8,
2678
+ )
2679
+ ssl_cipher: str = proto.Field(
2680
+ proto.STRING,
2681
+ number=9,
2682
+ )
2683
+ verify_server_certificate: wrappers_pb2.BoolValue = proto.Field(
2684
+ proto.MESSAGE,
2685
+ number=10,
2686
+ message=wrappers_pb2.BoolValue,
2687
+ )
2688
+ kind: str = proto.Field(
2689
+ proto.STRING,
2690
+ number=11,
2691
+ )
2692
+
2693
+
2694
+ class DiskEncryptionConfiguration(proto.Message):
2695
+ r"""Disk encryption configuration for an instance.
2696
+
2697
+ Attributes:
2698
+ kms_key_name (str):
2699
+ Resource name of KMS key for disk encryption
2700
+ kind (str):
2701
+ This is always ``sql#diskEncryptionConfiguration``.
2702
+ """
2703
+
2704
+ kms_key_name: str = proto.Field(
2705
+ proto.STRING,
2706
+ number=1,
2707
+ )
2708
+ kind: str = proto.Field(
2709
+ proto.STRING,
2710
+ number=2,
2711
+ )
2712
+
2713
+
2714
+ class DiskEncryptionStatus(proto.Message):
2715
+ r"""Disk encryption status for an instance.
2716
+
2717
+ Attributes:
2718
+ kms_key_version_name (str):
2719
+ KMS key version used to encrypt the Cloud SQL
2720
+ instance resource
2721
+ kind (str):
2722
+ This is always ``sql#diskEncryptionStatus``.
2723
+ """
2724
+
2725
+ kms_key_version_name: str = proto.Field(
2726
+ proto.STRING,
2727
+ number=1,
2728
+ )
2729
+ kind: str = proto.Field(
2730
+ proto.STRING,
2731
+ number=2,
2732
+ )
2733
+
2734
+
2735
+ class IpMapping(proto.Message):
2736
+ r"""Database instance IP mapping
2737
+
2738
+ Attributes:
2739
+ type_ (google.cloud.sqladmin_v1.types.SqlIpAddressType):
2740
+ The type of this IP address. A ``PRIMARY`` address is a
2741
+ public address that can accept incoming connections. A
2742
+ ``PRIVATE`` address is a private address that can accept
2743
+ incoming connections. An ``OUTGOING`` address is the source
2744
+ address of connections originating from the instance, if
2745
+ supported.
2746
+ ip_address (str):
2747
+ The IP address assigned.
2748
+ time_to_retire (google.protobuf.timestamp_pb2.Timestamp):
2749
+ The due time for this IP to be retired in `RFC
2750
+ 3339 <https://tools.ietf.org/html/rfc3339>`__ format, for
2751
+ example ``2012-11-15T16:19:00.094Z``. This field is only
2752
+ available when the IP is scheduled to be retired.
2753
+ """
2754
+
2755
+ type_: "SqlIpAddressType" = proto.Field(
2756
+ proto.ENUM,
2757
+ number=1,
2758
+ enum="SqlIpAddressType",
2759
+ )
2760
+ ip_address: str = proto.Field(
2761
+ proto.STRING,
2762
+ number=2,
2763
+ )
2764
+ time_to_retire: timestamp_pb2.Timestamp = proto.Field(
2765
+ proto.MESSAGE,
2766
+ number=3,
2767
+ message=timestamp_pb2.Timestamp,
2768
+ )
2769
+
2770
+
2771
+ class SqlSubOperationType(proto.Message):
2772
+ r"""The sub operation type based on the operation type.
2773
+
2774
+ .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
2775
+
2776
+ Attributes:
2777
+ maintenance_type (google.cloud.sqladmin_v1.types.SqlMaintenanceType):
2778
+ The type of maintenance to be performed on
2779
+ the instance.
2780
+
2781
+ This field is a member of `oneof`_ ``sub_operation_details``.
2782
+ """
2783
+
2784
+ maintenance_type: "SqlMaintenanceType" = proto.Field(
2785
+ proto.ENUM,
2786
+ number=1,
2787
+ oneof="sub_operation_details",
2788
+ enum="SqlMaintenanceType",
2789
+ )
2790
+
2791
+
2792
+ class Operation(proto.Message):
2793
+ r"""An Operation resource.&nbsp;For successful operations that
2794
+ return an Operation resource, only the fields relevant to the
2795
+ operation are populated in the resource.
2796
+
2797
+ Attributes:
2798
+ kind (str):
2799
+ This is always ``sql#operation``.
2800
+ target_link (str):
2801
+
2802
+ status (google.cloud.sqladmin_v1.types.Operation.SqlOperationStatus):
2803
+ The status of an operation.
2804
+ user (str):
2805
+ The email address of the user who initiated
2806
+ this operation.
2807
+ insert_time (google.protobuf.timestamp_pb2.Timestamp):
2808
+ The time this operation was enqueued in UTC timezone in `RFC
2809
+ 3339 <https://tools.ietf.org/html/rfc3339>`__ format, for
2810
+ example ``2012-11-15T16:19:00.094Z``.
2811
+ start_time (google.protobuf.timestamp_pb2.Timestamp):
2812
+ The time this operation actually started in UTC timezone in
2813
+ `RFC 3339 <https://tools.ietf.org/html/rfc3339>`__ format,
2814
+ for example ``2012-11-15T16:19:00.094Z``.
2815
+ end_time (google.protobuf.timestamp_pb2.Timestamp):
2816
+ The time this operation finished in UTC timezone in `RFC
2817
+ 3339 <https://tools.ietf.org/html/rfc3339>`__ format, for
2818
+ example ``2012-11-15T16:19:00.094Z``.
2819
+ error (google.cloud.sqladmin_v1.types.OperationErrors):
2820
+ If errors occurred during processing of this
2821
+ operation, this field will be populated.
2822
+ api_warning (google.cloud.sqladmin_v1.types.ApiWarning):
2823
+ An Admin API warning message.
2824
+ operation_type (google.cloud.sqladmin_v1.types.Operation.SqlOperationType):
2825
+ The type of the operation. Valid values are:
2826
+
2827
+ - ``CREATE``
2828
+ - ``DELETE``
2829
+ - ``UPDATE``
2830
+ - ``RESTART``
2831
+ - ``IMPORT``
2832
+ - ``EXPORT``
2833
+ - ``BACKUP_VOLUME``
2834
+ - ``RESTORE_VOLUME``
2835
+ - ``CREATE_USER``
2836
+ - ``DELETE_USER``
2837
+ - ``CREATE_DATABASE``
2838
+ - ``DELETE_DATABASE``
2839
+ import_context (google.cloud.sqladmin_v1.types.ImportContext):
2840
+ The context for import operation, if
2841
+ applicable.
2842
+ export_context (google.cloud.sqladmin_v1.types.ExportContext):
2843
+ The context for export operation, if
2844
+ applicable.
2845
+ backup_context (google.cloud.sqladmin_v1.types.BackupContext):
2846
+ The context for backup operation, if
2847
+ applicable.
2848
+ pre_check_major_version_upgrade_context (google.cloud.sqladmin_v1.types.PreCheckMajorVersionUpgradeContext):
2849
+ This field is only populated when the operation_type is
2850
+ PRE_CHECK_MAJOR_VERSION_UPGRADE. The
2851
+ PreCheckMajorVersionUpgradeContext message itself contains
2852
+ the details for that pre-check, such as the target database
2853
+ version for the upgrade and the results of the check
2854
+ (including any warnings or errors found).
2855
+ name (str):
2856
+ An identifier that uniquely identifies the
2857
+ operation. You can use this identifier to
2858
+ retrieve the Operations resource that has
2859
+ information about the operation.
2860
+ target_id (str):
2861
+ Name of the resource on which this operation
2862
+ runs.
2863
+ self_link (str):
2864
+ The URI of this resource.
2865
+ target_project (str):
2866
+ The project ID of the target instance related
2867
+ to this operation.
2868
+ acquire_ssrs_lease_context (google.cloud.sqladmin_v1.types.AcquireSsrsLeaseContext):
2869
+ The context for acquire SSRS lease operation,
2870
+ if applicable.
2871
+ sub_operation_type (google.cloud.sqladmin_v1.types.SqlSubOperationType):
2872
+ Optional. The sub operation based on the
2873
+ operation type.
2874
+ """
2875
+
2876
+ class SqlOperationType(proto.Enum):
2877
+ r"""The type of Cloud SQL operation.
2878
+
2879
+ Values:
2880
+ SQL_OPERATION_TYPE_UNSPECIFIED (0):
2881
+ Unknown operation type.
2882
+ IMPORT (1):
2883
+ Imports data into a Cloud SQL instance.
2884
+ EXPORT (2):
2885
+ Exports data from a Cloud SQL instance to a
2886
+ Cloud Storage bucket.
2887
+ CREATE (3):
2888
+ Creates a new Cloud SQL instance.
2889
+ UPDATE (4):
2890
+ Updates the settings of a Cloud SQL instance.
2891
+ DELETE (5):
2892
+ Deletes a Cloud SQL instance.
2893
+ RESTART (6):
2894
+ Restarts the Cloud SQL instance.
2895
+ BACKUP (7):
2896
+ No description available.
2897
+ SNAPSHOT (8):
2898
+ No description available.
2899
+ BACKUP_VOLUME (9):
2900
+ Performs instance backup.
2901
+ DELETE_VOLUME (10):
2902
+ Deletes an instance backup.
2903
+ RESTORE_VOLUME (11):
2904
+ Restores an instance backup.
2905
+ INJECT_USER (12):
2906
+ Injects a privileged user in mysql for MOB
2907
+ instances.
2908
+ CLONE (14):
2909
+ Clones a Cloud SQL instance.
2910
+ STOP_REPLICA (15):
2911
+ Stops replication on a Cloud SQL read replica
2912
+ instance.
2913
+ START_REPLICA (16):
2914
+ Starts replication on a Cloud SQL read
2915
+ replica instance.
2916
+ PROMOTE_REPLICA (17):
2917
+ Promotes a Cloud SQL replica instance.
2918
+ CREATE_REPLICA (18):
2919
+ Creates a Cloud SQL replica instance.
2920
+ CREATE_USER (19):
2921
+ Creates a new user in a Cloud SQL instance.
2922
+ DELETE_USER (20):
2923
+ Deletes a user from a Cloud SQL instance.
2924
+ UPDATE_USER (21):
2925
+ Updates an existing user in a Cloud SQL
2926
+ instance. If a user with the specified username
2927
+ doesn't exist, a new user is created.
2928
+ CREATE_DATABASE (22):
2929
+ Creates a database in the Cloud SQL instance.
2930
+ DELETE_DATABASE (23):
2931
+ Deletes a database in the Cloud SQL instance.
2932
+ UPDATE_DATABASE (24):
2933
+ Updates a database in the Cloud SQL instance.
2934
+ FAILOVER (25):
2935
+ Performs failover of an HA-enabled Cloud SQL
2936
+ failover replica.
2937
+ DELETE_BACKUP (26):
2938
+ Deletes the backup taken by a backup run.
2939
+ RECREATE_REPLICA (27):
2940
+ No description available.
2941
+ TRUNCATE_LOG (28):
2942
+ Truncates a general or slow log table in
2943
+ MySQL.
2944
+ DEMOTE_MASTER (29):
2945
+ Demotes the stand-alone instance to be a
2946
+ Cloud SQL read replica for an external database
2947
+ server.
2948
+ MAINTENANCE (30):
2949
+ Indicates that the instance is currently in
2950
+ maintenance. Maintenance typically causes the
2951
+ instance to be unavailable for 1-3 minutes.
2952
+ ENABLE_PRIVATE_IP (31):
2953
+ This field is deprecated, and will be removed
2954
+ in future version of API.
2955
+ DEFER_MAINTENANCE (32):
2956
+ No description available.
2957
+ CREATE_CLONE (33):
2958
+ Creates clone instance.
2959
+ RESCHEDULE_MAINTENANCE (34):
2960
+ Reschedule maintenance to another time.
2961
+ START_EXTERNAL_SYNC (35):
2962
+ Starts external sync of a Cloud SQL EM
2963
+ replica to an external primary instance.
2964
+ LOG_CLEANUP (36):
2965
+ Recovers logs from an instance's old data
2966
+ disk.
2967
+ AUTO_RESTART (37):
2968
+ Performs auto-restart of an HA-enabled Cloud
2969
+ SQL database for auto recovery.
2970
+ REENCRYPT (38):
2971
+ Re-encrypts CMEK instances with latest key
2972
+ version.
2973
+ SWITCHOVER (39):
2974
+ Switches the roles of the primary and replica
2975
+ pair. The target instance should be the replica.
2976
+ UPDATE_BACKUP (40):
2977
+ Update a backup.
2978
+ ACQUIRE_SSRS_LEASE (42):
2979
+ Acquire a lease for the setup of SQL Server
2980
+ Reporting Services (SSRS).
2981
+ RELEASE_SSRS_LEASE (43):
2982
+ Release a lease for the setup of SQL Server
2983
+ Reporting Services (SSRS).
2984
+ RECONFIGURE_OLD_PRIMARY (44):
2985
+ Reconfigures old primary after a promote
2986
+ replica operation. Effect of a promote operation
2987
+ to the old primary is executed in this
2988
+ operation, asynchronously from the promote
2989
+ replica operation executed to the replica.
2990
+ CLUSTER_MAINTENANCE (45):
2991
+ Indicates that the instance, its read
2992
+ replicas, and its cascading replicas are in
2993
+ maintenance. Maintenance typically gets
2994
+ initiated on groups of replicas first, followed
2995
+ by the primary instance. For each instance,
2996
+ maintenance typically causes the instance to be
2997
+ unavailable for 1-3 minutes.
2998
+ SELF_SERVICE_MAINTENANCE (46):
2999
+ Indicates that the instance (and any of its
3000
+ replicas) are currently in maintenance. This is
3001
+ initiated as a self-service request by using
3002
+ SSM. Maintenance typically causes the instance
3003
+ to be unavailable for 1-3 minutes.
3004
+ SWITCHOVER_TO_REPLICA (47):
3005
+ Switches a primary instance to a replica.
3006
+ This operation runs as part of a switchover
3007
+ operation to the original primary instance.
3008
+ MAJOR_VERSION_UPGRADE (48):
3009
+ Updates the major version of a Cloud SQL
3010
+ instance.
3011
+ ADVANCED_BACKUP (49):
3012
+ Deprecated: ADVANCED_BACKUP is deprecated. Use
3013
+ ENHANCED_BACKUP instead.
3014
+ MANAGE_BACKUP (50):
3015
+ Changes the BackupTier of a Cloud SQL
3016
+ instance.
3017
+ ENHANCED_BACKUP (51):
3018
+ Creates a backup for an Enhanced BackupTier
3019
+ Cloud SQL instance.
3020
+ REPAIR_READ_POOL (52):
3021
+ Repairs entire read pool or specified read
3022
+ pool nodes in the read pool.
3023
+ CREATE_READ_POOL (53):
3024
+ Creates a Cloud SQL read pool instance.
3025
+ PRE_CHECK_MAJOR_VERSION_UPGRADE (54):
3026
+ Pre-checks the major version upgrade
3027
+ operation.
3028
+ SETUP_MIGRATION (55):
3029
+ This operation type represents individual
3030
+ steps in a multi-step setup migration workflow:
3031
+ including configuration, replication,
3032
+ switchover/back, and data reseeding, as defined
3033
+ by operation's intent.
3034
+ """
3035
+
3036
+ SQL_OPERATION_TYPE_UNSPECIFIED = 0
3037
+ IMPORT = 1
3038
+ EXPORT = 2
3039
+ CREATE = 3
3040
+ UPDATE = 4
3041
+ DELETE = 5
3042
+ RESTART = 6
3043
+ BACKUP = 7
3044
+ SNAPSHOT = 8
3045
+ BACKUP_VOLUME = 9
3046
+ DELETE_VOLUME = 10
3047
+ RESTORE_VOLUME = 11
3048
+ INJECT_USER = 12
3049
+ CLONE = 14
3050
+ STOP_REPLICA = 15
3051
+ START_REPLICA = 16
3052
+ PROMOTE_REPLICA = 17
3053
+ CREATE_REPLICA = 18
3054
+ CREATE_USER = 19
3055
+ DELETE_USER = 20
3056
+ UPDATE_USER = 21
3057
+ CREATE_DATABASE = 22
3058
+ DELETE_DATABASE = 23
3059
+ UPDATE_DATABASE = 24
3060
+ FAILOVER = 25
3061
+ DELETE_BACKUP = 26
3062
+ RECREATE_REPLICA = 27
3063
+ TRUNCATE_LOG = 28
3064
+ DEMOTE_MASTER = 29
3065
+ MAINTENANCE = 30
3066
+ ENABLE_PRIVATE_IP = 31
3067
+ DEFER_MAINTENANCE = 32
3068
+ CREATE_CLONE = 33
3069
+ RESCHEDULE_MAINTENANCE = 34
3070
+ START_EXTERNAL_SYNC = 35
3071
+ LOG_CLEANUP = 36
3072
+ AUTO_RESTART = 37
3073
+ REENCRYPT = 38
3074
+ SWITCHOVER = 39
3075
+ UPDATE_BACKUP = 40
3076
+ ACQUIRE_SSRS_LEASE = 42
3077
+ RELEASE_SSRS_LEASE = 43
3078
+ RECONFIGURE_OLD_PRIMARY = 44
3079
+ CLUSTER_MAINTENANCE = 45
3080
+ SELF_SERVICE_MAINTENANCE = 46
3081
+ SWITCHOVER_TO_REPLICA = 47
3082
+ MAJOR_VERSION_UPGRADE = 48
3083
+ ADVANCED_BACKUP = 49
3084
+ MANAGE_BACKUP = 50
3085
+ ENHANCED_BACKUP = 51
3086
+ REPAIR_READ_POOL = 52
3087
+ CREATE_READ_POOL = 53
3088
+ PRE_CHECK_MAJOR_VERSION_UPGRADE = 54
3089
+ SETUP_MIGRATION = 55
3090
+
3091
+ class SqlOperationStatus(proto.Enum):
3092
+ r"""The status of an operation.
3093
+
3094
+ Values:
3095
+ SQL_OPERATION_STATUS_UNSPECIFIED (0):
3096
+ The state of the operation is unknown.
3097
+ PENDING (1):
3098
+ The operation has been queued, but has not
3099
+ started yet.
3100
+ RUNNING (2):
3101
+ The operation is running.
3102
+ DONE (3):
3103
+ The operation completed.
3104
+ """
3105
+
3106
+ SQL_OPERATION_STATUS_UNSPECIFIED = 0
3107
+ PENDING = 1
3108
+ RUNNING = 2
3109
+ DONE = 3
3110
+
3111
+ kind: str = proto.Field(
3112
+ proto.STRING,
3113
+ number=1,
3114
+ )
3115
+ target_link: str = proto.Field(
3116
+ proto.STRING,
3117
+ number=2,
3118
+ )
3119
+ status: SqlOperationStatus = proto.Field(
3120
+ proto.ENUM,
3121
+ number=3,
3122
+ enum=SqlOperationStatus,
3123
+ )
3124
+ user: str = proto.Field(
3125
+ proto.STRING,
3126
+ number=4,
3127
+ )
3128
+ insert_time: timestamp_pb2.Timestamp = proto.Field(
3129
+ proto.MESSAGE,
3130
+ number=5,
3131
+ message=timestamp_pb2.Timestamp,
3132
+ )
3133
+ start_time: timestamp_pb2.Timestamp = proto.Field(
3134
+ proto.MESSAGE,
3135
+ number=6,
3136
+ message=timestamp_pb2.Timestamp,
3137
+ )
3138
+ end_time: timestamp_pb2.Timestamp = proto.Field(
3139
+ proto.MESSAGE,
3140
+ number=7,
3141
+ message=timestamp_pb2.Timestamp,
3142
+ )
3143
+ error: "OperationErrors" = proto.Field(
3144
+ proto.MESSAGE,
3145
+ number=8,
3146
+ message="OperationErrors",
3147
+ )
3148
+ api_warning: "ApiWarning" = proto.Field(
3149
+ proto.MESSAGE,
3150
+ number=19,
3151
+ message="ApiWarning",
3152
+ )
3153
+ operation_type: SqlOperationType = proto.Field(
3154
+ proto.ENUM,
3155
+ number=9,
3156
+ enum=SqlOperationType,
3157
+ )
3158
+ import_context: "ImportContext" = proto.Field(
3159
+ proto.MESSAGE,
3160
+ number=10,
3161
+ message="ImportContext",
3162
+ )
3163
+ export_context: "ExportContext" = proto.Field(
3164
+ proto.MESSAGE,
3165
+ number=11,
3166
+ message="ExportContext",
3167
+ )
3168
+ backup_context: "BackupContext" = proto.Field(
3169
+ proto.MESSAGE,
3170
+ number=17,
3171
+ message="BackupContext",
3172
+ )
3173
+ pre_check_major_version_upgrade_context: "PreCheckMajorVersionUpgradeContext" = (
3174
+ proto.Field(
3175
+ proto.MESSAGE,
3176
+ number=50,
3177
+ message="PreCheckMajorVersionUpgradeContext",
3178
+ )
3179
+ )
3180
+ name: str = proto.Field(
3181
+ proto.STRING,
3182
+ number=12,
3183
+ )
3184
+ target_id: str = proto.Field(
3185
+ proto.STRING,
3186
+ number=13,
3187
+ )
3188
+ self_link: str = proto.Field(
3189
+ proto.STRING,
3190
+ number=14,
3191
+ )
3192
+ target_project: str = proto.Field(
3193
+ proto.STRING,
3194
+ number=15,
3195
+ )
3196
+ acquire_ssrs_lease_context: "AcquireSsrsLeaseContext" = proto.Field(
3197
+ proto.MESSAGE,
3198
+ number=20,
3199
+ message="AcquireSsrsLeaseContext",
3200
+ )
3201
+ sub_operation_type: "SqlSubOperationType" = proto.Field(
3202
+ proto.MESSAGE,
3203
+ number=48,
3204
+ message="SqlSubOperationType",
3205
+ )
3206
+
3207
+
3208
+ class OperationError(proto.Message):
3209
+ r"""Database instance operation error.
3210
+
3211
+ Attributes:
3212
+ kind (str):
3213
+ This is always ``sql#operationError``.
3214
+ code (str):
3215
+ Identifies the specific error that occurred.
3216
+ message (str):
3217
+ Additional information about the error
3218
+ encountered.
3219
+ """
3220
+
3221
+ kind: str = proto.Field(
3222
+ proto.STRING,
3223
+ number=1,
3224
+ )
3225
+ code: str = proto.Field(
3226
+ proto.STRING,
3227
+ number=2,
3228
+ )
3229
+ message: str = proto.Field(
3230
+ proto.STRING,
3231
+ number=3,
3232
+ )
3233
+
3234
+
3235
+ class OperationErrors(proto.Message):
3236
+ r"""Database instance operation errors list wrapper.
3237
+
3238
+ Attributes:
3239
+ kind (str):
3240
+ This is always ``sql#operationErrors``.
3241
+ errors (MutableSequence[google.cloud.sqladmin_v1.types.OperationError]):
3242
+ The list of errors encountered while
3243
+ processing this operation.
3244
+ """
3245
+
3246
+ kind: str = proto.Field(
3247
+ proto.STRING,
3248
+ number=1,
3249
+ )
3250
+ errors: MutableSequence["OperationError"] = proto.RepeatedField(
3251
+ proto.MESSAGE,
3252
+ number=2,
3253
+ message="OperationError",
3254
+ )
3255
+
3256
+
3257
+ class PasswordValidationPolicy(proto.Message):
3258
+ r"""Database instance local user password validation policy.
3259
+ This message defines the password policy for local database
3260
+ users. When enabled, it enforces constraints on password
3261
+ complexity, length, and reuse. Keep this policy enabled to help
3262
+ prevent unauthorized access.
3263
+
3264
+ Attributes:
3265
+ min_length (google.protobuf.wrappers_pb2.Int32Value):
3266
+ Minimum number of characters allowed.
3267
+ complexity (google.cloud.sqladmin_v1.types.PasswordValidationPolicy.Complexity):
3268
+ The complexity of the password.
3269
+ reuse_interval (google.protobuf.wrappers_pb2.Int32Value):
3270
+ Number of previous passwords that cannot be
3271
+ reused.
3272
+ disallow_username_substring (google.protobuf.wrappers_pb2.BoolValue):
3273
+ Disallow username as a part of the password.
3274
+ password_change_interval (google.protobuf.duration_pb2.Duration):
3275
+ Minimum interval after which the password can
3276
+ be changed. This flag is only supported for
3277
+ PostgreSQL.
3278
+ enable_password_policy (google.protobuf.wrappers_pb2.BoolValue):
3279
+ Whether to enable the password policy or not.
3280
+ When enabled, passwords must meet complexity
3281
+ requirements. Keep this policy enabled to help
3282
+ prevent unauthorized access. Disabling this
3283
+ policy allows weak passwords.
3284
+ disallow_compromised_credentials (google.protobuf.wrappers_pb2.BoolValue):
3285
+ This field is deprecated and will be removed
3286
+ in a future version of the API.
3287
+ """
3288
+
3289
+ class Complexity(proto.Enum):
3290
+ r"""The complexity choices of the password.
3291
+
3292
+ Values:
3293
+ COMPLEXITY_UNSPECIFIED (0):
3294
+ Complexity check is not specified.
3295
+ COMPLEXITY_DEFAULT (1):
3296
+ A combination of lowercase, uppercase,
3297
+ numeric, and non-alphanumeric characters.
3298
+ """
3299
+
3300
+ COMPLEXITY_UNSPECIFIED = 0
3301
+ COMPLEXITY_DEFAULT = 1
3302
+
3303
+ min_length: wrappers_pb2.Int32Value = proto.Field(
3304
+ proto.MESSAGE,
3305
+ number=1,
3306
+ message=wrappers_pb2.Int32Value,
3307
+ )
3308
+ complexity: Complexity = proto.Field(
3309
+ proto.ENUM,
3310
+ number=2,
3311
+ enum=Complexity,
3312
+ )
3313
+ reuse_interval: wrappers_pb2.Int32Value = proto.Field(
3314
+ proto.MESSAGE,
3315
+ number=3,
3316
+ message=wrappers_pb2.Int32Value,
3317
+ )
3318
+ disallow_username_substring: wrappers_pb2.BoolValue = proto.Field(
3319
+ proto.MESSAGE,
3320
+ number=4,
3321
+ message=wrappers_pb2.BoolValue,
3322
+ )
3323
+ password_change_interval: duration_pb2.Duration = proto.Field(
3324
+ proto.MESSAGE,
3325
+ number=5,
3326
+ message=duration_pb2.Duration,
3327
+ )
3328
+ enable_password_policy: wrappers_pb2.BoolValue = proto.Field(
3329
+ proto.MESSAGE,
3330
+ number=6,
3331
+ message=wrappers_pb2.BoolValue,
3332
+ )
3333
+ disallow_compromised_credentials: wrappers_pb2.BoolValue = proto.Field(
3334
+ proto.MESSAGE,
3335
+ number=7,
3336
+ message=wrappers_pb2.BoolValue,
3337
+ )
3338
+
3339
+
3340
+ class DataCacheConfig(proto.Message):
3341
+ r"""Data cache configurations.
3342
+
3343
+ Attributes:
3344
+ data_cache_enabled (bool):
3345
+ Whether data cache is enabled for the
3346
+ instance.
3347
+ """
3348
+
3349
+ data_cache_enabled: bool = proto.Field(
3350
+ proto.BOOL,
3351
+ number=1,
3352
+ )
3353
+
3354
+
3355
+ class FinalBackupConfig(proto.Message):
3356
+ r"""Config used to determine the final backup settings for the
3357
+ instance.
3358
+
3359
+
3360
+ .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
3361
+
3362
+ Attributes:
3363
+ enabled (bool):
3364
+ Whether the final backup is enabled for the
3365
+ instance.
3366
+
3367
+ This field is a member of `oneof`_ ``_enabled``.
3368
+ retention_days (int):
3369
+ The number of days to retain the final backup after the
3370
+ instance deletion. The final backup will be purged at
3371
+ (time_of_instance_deletion + retention_days).
3372
+
3373
+ This field is a member of `oneof`_ ``_retention_days``.
3374
+ """
3375
+
3376
+ enabled: bool = proto.Field(
3377
+ proto.BOOL,
3378
+ number=1,
3379
+ optional=True,
3380
+ )
3381
+ retention_days: int = proto.Field(
3382
+ proto.INT32,
3383
+ number=3,
3384
+ optional=True,
3385
+ )
3386
+
3387
+
3388
+ class Settings(proto.Message):
3389
+ r"""Database instance settings.
3390
+
3391
+ .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
3392
+
3393
+ Attributes:
3394
+ settings_version (google.protobuf.wrappers_pb2.Int64Value):
3395
+ The version of instance settings. This is a
3396
+ required field for update method to make sure
3397
+ concurrent updates are handled properly. During
3398
+ update, use the most recent settingsVersion
3399
+ value for this instance and do not try to update
3400
+ this value.
3401
+ authorized_gae_applications (MutableSequence[str]):
3402
+ The App Engine app IDs that can access this
3403
+ instance. (Deprecated) Applied to First
3404
+ Generation instances only.
3405
+ tier (str):
3406
+ The tier (or machine type) for this instance, for example
3407
+ ``db-custom-1-3840``. WARNING: Changing this restarts the
3408
+ instance.
3409
+ kind (str):
3410
+ This is always ``sql#settings``.
3411
+ user_labels (MutableMapping[str, str]):
3412
+ User-provided labels, represented as a
3413
+ dictionary where each label is a single key
3414
+ value pair.
3415
+ availability_type (google.cloud.sqladmin_v1.types.SqlAvailabilityType):
3416
+ Availability type. Potential values:
3417
+
3418
+ - ``ZONAL``: The instance serves data from only one zone.
3419
+ Outages in that zone affect data accessibility.
3420
+ - ``REGIONAL``: The instance can serve data from more than
3421
+ one zone in a region (it is highly available)./
3422
+
3423
+ For more information, see `Overview of the High Availability
3424
+ Configuration <https://cloud.google.com/sql/docs/mysql/high-availability>`__.
3425
+ pricing_plan (google.cloud.sqladmin_v1.types.SqlPricingPlan):
3426
+ The pricing plan for this instance. This can be either
3427
+ ``PER_USE`` or ``PACKAGE``. Only ``PER_USE`` is supported
3428
+ for Second Generation instances.
3429
+ replication_type (google.cloud.sqladmin_v1.types.SqlReplicationType):
3430
+ The type of replication this instance uses. This can be
3431
+ either ``ASYNCHRONOUS`` or ``SYNCHRONOUS``. (Deprecated)
3432
+ This property was only applicable to First Generation
3433
+ instances.
3434
+ storage_auto_resize_limit (google.protobuf.wrappers_pb2.Int64Value):
3435
+ The maximum size to which storage capacity
3436
+ can be automatically increased. The default
3437
+ value is 0, which specifies that there is no
3438
+ limit.
3439
+ activation_policy (google.cloud.sqladmin_v1.types.Settings.SqlActivationPolicy):
3440
+ The activation policy specifies when the instance is
3441
+ activated; it is applicable only when the instance state is
3442
+ RUNNABLE. Valid values:
3443
+
3444
+ - ``ALWAYS``: The instance is on, and remains so even in the
3445
+ absence of connection requests.
3446
+ - ``NEVER``: The instance is off; it is not activated, even
3447
+ if a connection request arrives.
3448
+ ip_configuration (google.cloud.sqladmin_v1.types.IpConfiguration):
3449
+ The settings for IP Management. This allows
3450
+ to enable or disable the instance IP and manage
3451
+ which external networks can connect to the
3452
+ instance. The IPv4 address cannot be disabled
3453
+ for Second Generation instances.
3454
+ storage_auto_resize (google.protobuf.wrappers_pb2.BoolValue):
3455
+ Configuration to increase storage size
3456
+ automatically. The default value is true.
3457
+ location_preference (google.cloud.sqladmin_v1.types.LocationPreference):
3458
+ The location preference settings. This allows
3459
+ the instance to be located as near as possible
3460
+ to either an App Engine app or Compute Engine
3461
+ zone for better performance. App Engine
3462
+ co-location was only applicable to First
3463
+ Generation instances.
3464
+ database_flags (MutableSequence[google.cloud.sqladmin_v1.types.DatabaseFlags]):
3465
+ The database flags passed to the instance at
3466
+ startup.
3467
+ data_disk_type (google.cloud.sqladmin_v1.types.SqlDataDiskType):
3468
+ The type of data disk: ``PD_SSD`` (default) or ``PD_HDD``.
3469
+ Not used for First Generation instances.
3470
+ maintenance_window (google.cloud.sqladmin_v1.types.MaintenanceWindow):
3471
+ The maintenance window for this instance.
3472
+ This specifies when the instance can be
3473
+ restarted for maintenance purposes.
3474
+ backup_configuration (google.cloud.sqladmin_v1.types.BackupConfiguration):
3475
+ The daily backup configuration for the
3476
+ instance.
3477
+ database_replication_enabled (google.protobuf.wrappers_pb2.BoolValue):
3478
+ Configuration specific to read replica
3479
+ instances. Indicates whether replication is
3480
+ enabled or not. WARNING: Changing this restarts
3481
+ the instance.
3482
+ crash_safe_replication_enabled (google.protobuf.wrappers_pb2.BoolValue):
3483
+ Configuration specific to read replica
3484
+ instances. Indicates whether database flags for
3485
+ crash-safe replication are enabled. This
3486
+ property was only applicable to First Generation
3487
+ instances.
3488
+ data_disk_size_gb (google.protobuf.wrappers_pb2.Int64Value):
3489
+ The size of data disk, in GB. The data disk
3490
+ size minimum is 10GB.
3491
+ active_directory_config (google.cloud.sqladmin_v1.types.SqlActiveDirectoryConfig):
3492
+ Active Directory configuration, relevant only
3493
+ for Cloud SQL for SQL Server.
3494
+ collation (str):
3495
+ The name of server Instance collation.
3496
+ deny_maintenance_periods (MutableSequence[google.cloud.sqladmin_v1.types.DenyMaintenancePeriod]):
3497
+ Deny maintenance periods
3498
+ insights_config (google.cloud.sqladmin_v1.types.InsightsConfig):
3499
+ Insights configuration, for now relevant only
3500
+ for Postgres.
3501
+ password_validation_policy (google.cloud.sqladmin_v1.types.PasswordValidationPolicy):
3502
+ The local user password validation policy of
3503
+ the instance.
3504
+ sql_server_audit_config (google.cloud.sqladmin_v1.types.SqlServerAuditConfig):
3505
+ SQL Server specific audit configuration.
3506
+ edition (google.cloud.sqladmin_v1.types.Settings.Edition):
3507
+ Optional. The edition type of the Cloud SQL
3508
+ instance.
3509
+ connector_enforcement (google.cloud.sqladmin_v1.types.Settings.ConnectorEnforcement):
3510
+ Specifies if connections must use Cloud SQL connectors.
3511
+ Option values include the following: ``NOT_REQUIRED`` (Cloud
3512
+ SQL instances can be connected without Cloud SQL Connectors)
3513
+ and ``REQUIRED`` (Only allow connections that use Cloud SQL
3514
+ Connectors).
3515
+
3516
+ Note that using REQUIRED disables all existing authorized
3517
+ networks. If this field is not specified when creating a new
3518
+ instance, NOT_REQUIRED is used. If this field is not
3519
+ specified when patching or updating an existing instance, it
3520
+ is left unchanged in the instance.
3521
+ deletion_protection_enabled (google.protobuf.wrappers_pb2.BoolValue):
3522
+ Configuration to protect against accidental
3523
+ instance deletion.
3524
+ time_zone (str):
3525
+ Server timezone, relevant only for Cloud SQL
3526
+ for SQL Server.
3527
+ advanced_machine_features (google.cloud.sqladmin_v1.types.AdvancedMachineFeatures):
3528
+ Specifies advanced machine configuration for
3529
+ the instances relevant only for SQL Server.
3530
+ data_cache_config (google.cloud.sqladmin_v1.types.DataCacheConfig):
3531
+ Configuration for data cache.
3532
+ replication_lag_max_seconds (google.protobuf.wrappers_pb2.Int32Value):
3533
+ Optional. Configuration value for recreation
3534
+ of replica after certain replication lag
3535
+ enable_google_ml_integration (google.protobuf.wrappers_pb2.BoolValue):
3536
+ Optional. When this parameter is set to true,
3537
+ Cloud SQL instances can connect to Vertex AI to
3538
+ pass requests for real-time predictions and
3539
+ insights to the AI. The default value is false.
3540
+ This applies only to Cloud SQL for MySQL and
3541
+ Cloud SQL for PostgreSQL instances.
3542
+ enable_dataplex_integration (google.protobuf.wrappers_pb2.BoolValue):
3543
+ Optional. By default, Cloud SQL instances
3544
+ have schema extraction disabled for Dataplex.
3545
+ When this parameter is set to true, schema
3546
+ extraction for Dataplex on Cloud SQL instances
3547
+ is activated.
3548
+ retain_backups_on_delete (google.protobuf.wrappers_pb2.BoolValue):
3549
+ Optional. When this parameter is set to true, Cloud SQL
3550
+ retains backups of the instance even after the instance is
3551
+ deleted. The ON_DEMAND backup will be retained until
3552
+ customer deletes the backup or the project. The AUTOMATED
3553
+ backup will be retained based on the backups retention
3554
+ setting.
3555
+ data_disk_provisioned_iops (int):
3556
+ Optional. Provisioned number of I/O
3557
+ operations per second for the data disk. This
3558
+ field is only used for hyperdisk-balanced disk
3559
+ types.
3560
+
3561
+ This field is a member of `oneof`_ ``_data_disk_provisioned_iops``.
3562
+ data_disk_provisioned_throughput (int):
3563
+ Optional. Provisioned throughput measured in
3564
+ MiB per second for the data disk. This field is
3565
+ only used for hyperdisk-balanced disk types.
3566
+
3567
+ This field is a member of `oneof`_ ``_data_disk_provisioned_throughput``.
3568
+ connection_pool_config (google.cloud.sqladmin_v1.types.ConnectionPoolConfig):
3569
+ Optional. The managed connection pooling
3570
+ configuration for the instance.
3571
+
3572
+ This field is a member of `oneof`_ ``_connection_pool_config``.
3573
+ final_backup_config (google.cloud.sqladmin_v1.types.FinalBackupConfig):
3574
+ Optional. The final backup configuration for
3575
+ the instance.
3576
+
3577
+ This field is a member of `oneof`_ ``_final_backup_config``.
3578
+ read_pool_auto_scale_config (google.cloud.sqladmin_v1.types.ReadPoolAutoScaleConfig):
3579
+ Optional. The read pool auto-scale
3580
+ configuration for the instance.
3581
+
3582
+ This field is a member of `oneof`_ ``_read_pool_auto_scale_config``.
3583
+ accelerated_replica_mode (google.protobuf.wrappers_pb2.BoolValue):
3584
+ Optional. Whether the replica is in
3585
+ accelerated mode. This feature is in private
3586
+ preview and requires allowlisting to take
3587
+ effect.
3588
+ auto_upgrade_enabled (bool):
3589
+ Optional. Cloud SQL for MySQL auto-upgrade
3590
+ configuration. When this parameter is set to
3591
+ true, auto-upgrade is enabled for MySQL 8.0
3592
+ minor versions. The MySQL version must be 8.0.35
3593
+ or higher.
3594
+
3595
+ This field is a member of `oneof`_ ``_auto_upgrade_enabled``.
3596
+ entraid_config (google.cloud.sqladmin_v1.types.SqlServerEntraIdConfig):
3597
+ Optional. The Microsoft Entra ID
3598
+ configuration for the SQL Server instance.
3599
+ data_api_access (google.cloud.sqladmin_v1.types.Settings.DataApiAccess):
3600
+ This parameter controls whether to allow
3601
+ using ExecuteSql API to connect to the instance.
3602
+ Not allowed by default.
3603
+
3604
+ This field is a member of `oneof`_ ``_data_api_access``.
3605
+ performance_capture_config (google.cloud.sqladmin_v1.types.PerformanceCaptureConfig):
3606
+ Optional. Configuration for Performance
3607
+ Capture, provides diagnostic metrics during high
3608
+ load situations.
3609
+ """
3610
+
3611
+ class SqlActivationPolicy(proto.Enum):
3612
+ r"""Specifies when the instance is activated.
3613
+
3614
+ Values:
3615
+ SQL_ACTIVATION_POLICY_UNSPECIFIED (0):
3616
+ Unknown activation plan.
3617
+ ALWAYS (1):
3618
+ The instance is always up and running.
3619
+ NEVER (2):
3620
+ The instance never starts.
3621
+ ON_DEMAND (3):
3622
+ The instance starts upon receiving requests.
3623
+ """
3624
+
3625
+ SQL_ACTIVATION_POLICY_UNSPECIFIED = 0
3626
+ ALWAYS = 1
3627
+ NEVER = 2
3628
+ ON_DEMAND = 3
3629
+
3630
+ class Edition(proto.Enum):
3631
+ r"""The list of Cloud SQL editions available to users.
3632
+
3633
+ Values:
3634
+ EDITION_UNSPECIFIED (0):
3635
+ The instance did not specify the edition.
3636
+ ENTERPRISE (2):
3637
+ The instance is an enterprise edition.
3638
+ ENTERPRISE_PLUS (3):
3639
+ The instance is an Enterprise Plus edition.
3640
+ DEVELOPER (5):
3641
+ This instance is a Cloud SQL developer
3642
+ edition instance.
3643
+ """
3644
+
3645
+ EDITION_UNSPECIFIED = 0
3646
+ ENTERPRISE = 2
3647
+ ENTERPRISE_PLUS = 3
3648
+ DEVELOPER = 5
3649
+
3650
+ class ConnectorEnforcement(proto.Enum):
3651
+ r"""The options for enforcing Cloud SQL connectors in the
3652
+ instance.
3653
+
3654
+ Values:
3655
+ CONNECTOR_ENFORCEMENT_UNSPECIFIED (0):
3656
+ The requirement for Cloud SQL connectors is
3657
+ unknown.
3658
+ NOT_REQUIRED (1):
3659
+ Do not require Cloud SQL connectors.
3660
+ REQUIRED (2):
3661
+ Require all connections to use Cloud SQL
3662
+ connectors, including the Cloud SQL Auth Proxy
3663
+ and Cloud SQL Java, Python, and Go connectors.
3664
+ Note: This disables all existing authorized
3665
+ networks.
3666
+ """
3667
+
3668
+ CONNECTOR_ENFORCEMENT_UNSPECIFIED = 0
3669
+ NOT_REQUIRED = 1
3670
+ REQUIRED = 2
3671
+
3672
+ class DataApiAccess(proto.Enum):
3673
+ r"""ExecuteSql API's access to the instance.
3674
+
3675
+ Values:
3676
+ DATA_API_ACCESS_UNSPECIFIED (0):
3677
+ Unspecified, effectively the same as ``DISALLOW_DATA_API``.
3678
+ DISALLOW_DATA_API (1):
3679
+ Disallow using ExecuteSql API to connect to
3680
+ the instance.
3681
+ ALLOW_DATA_API (2):
3682
+ Allow using ExecuteSql API to connect to the
3683
+ instance. For private IP instances, this allows
3684
+ authorized users to access the instance from the
3685
+ public internet using ExecuteSql API.
3686
+ """
3687
+
3688
+ DATA_API_ACCESS_UNSPECIFIED = 0
3689
+ DISALLOW_DATA_API = 1
3690
+ ALLOW_DATA_API = 2
3691
+
3692
+ settings_version: wrappers_pb2.Int64Value = proto.Field(
3693
+ proto.MESSAGE,
3694
+ number=1,
3695
+ message=wrappers_pb2.Int64Value,
3696
+ )
3697
+ authorized_gae_applications: MutableSequence[str] = proto.RepeatedField(
3698
+ proto.STRING,
3699
+ number=2,
3700
+ )
3701
+ tier: str = proto.Field(
3702
+ proto.STRING,
3703
+ number=3,
3704
+ )
3705
+ kind: str = proto.Field(
3706
+ proto.STRING,
3707
+ number=4,
3708
+ )
3709
+ user_labels: MutableMapping[str, str] = proto.MapField(
3710
+ proto.STRING,
3711
+ proto.STRING,
3712
+ number=5,
3713
+ )
3714
+ availability_type: "SqlAvailabilityType" = proto.Field(
3715
+ proto.ENUM,
3716
+ number=6,
3717
+ enum="SqlAvailabilityType",
3718
+ )
3719
+ pricing_plan: "SqlPricingPlan" = proto.Field(
3720
+ proto.ENUM,
3721
+ number=7,
3722
+ enum="SqlPricingPlan",
3723
+ )
3724
+ replication_type: "SqlReplicationType" = proto.Field(
3725
+ proto.ENUM,
3726
+ number=8,
3727
+ enum="SqlReplicationType",
3728
+ )
3729
+ storage_auto_resize_limit: wrappers_pb2.Int64Value = proto.Field(
3730
+ proto.MESSAGE,
3731
+ number=9,
3732
+ message=wrappers_pb2.Int64Value,
3733
+ )
3734
+ activation_policy: SqlActivationPolicy = proto.Field(
3735
+ proto.ENUM,
3736
+ number=10,
3737
+ enum=SqlActivationPolicy,
3738
+ )
3739
+ ip_configuration: "IpConfiguration" = proto.Field(
3740
+ proto.MESSAGE,
3741
+ number=11,
3742
+ message="IpConfiguration",
3743
+ )
3744
+ storage_auto_resize: wrappers_pb2.BoolValue = proto.Field(
3745
+ proto.MESSAGE,
3746
+ number=12,
3747
+ message=wrappers_pb2.BoolValue,
3748
+ )
3749
+ location_preference: "LocationPreference" = proto.Field(
3750
+ proto.MESSAGE,
3751
+ number=13,
3752
+ message="LocationPreference",
3753
+ )
3754
+ database_flags: MutableSequence["DatabaseFlags"] = proto.RepeatedField(
3755
+ proto.MESSAGE,
3756
+ number=14,
3757
+ message="DatabaseFlags",
3758
+ )
3759
+ data_disk_type: "SqlDataDiskType" = proto.Field(
3760
+ proto.ENUM,
3761
+ number=15,
3762
+ enum="SqlDataDiskType",
3763
+ )
3764
+ maintenance_window: "MaintenanceWindow" = proto.Field(
3765
+ proto.MESSAGE,
3766
+ number=16,
3767
+ message="MaintenanceWindow",
3768
+ )
3769
+ backup_configuration: "BackupConfiguration" = proto.Field(
3770
+ proto.MESSAGE,
3771
+ number=17,
3772
+ message="BackupConfiguration",
3773
+ )
3774
+ database_replication_enabled: wrappers_pb2.BoolValue = proto.Field(
3775
+ proto.MESSAGE,
3776
+ number=18,
3777
+ message=wrappers_pb2.BoolValue,
3778
+ )
3779
+ crash_safe_replication_enabled: wrappers_pb2.BoolValue = proto.Field(
3780
+ proto.MESSAGE,
3781
+ number=19,
3782
+ message=wrappers_pb2.BoolValue,
3783
+ )
3784
+ data_disk_size_gb: wrappers_pb2.Int64Value = proto.Field(
3785
+ proto.MESSAGE,
3786
+ number=20,
3787
+ message=wrappers_pb2.Int64Value,
3788
+ )
3789
+ active_directory_config: "SqlActiveDirectoryConfig" = proto.Field(
3790
+ proto.MESSAGE,
3791
+ number=22,
3792
+ message="SqlActiveDirectoryConfig",
3793
+ )
3794
+ collation: str = proto.Field(
3795
+ proto.STRING,
3796
+ number=23,
3797
+ )
3798
+ deny_maintenance_periods: MutableSequence["DenyMaintenancePeriod"] = (
3799
+ proto.RepeatedField(
3800
+ proto.MESSAGE,
3801
+ number=24,
3802
+ message="DenyMaintenancePeriod",
3803
+ )
3804
+ )
3805
+ insights_config: "InsightsConfig" = proto.Field(
3806
+ proto.MESSAGE,
3807
+ number=25,
3808
+ message="InsightsConfig",
3809
+ )
3810
+ password_validation_policy: "PasswordValidationPolicy" = proto.Field(
3811
+ proto.MESSAGE,
3812
+ number=27,
3813
+ message="PasswordValidationPolicy",
3814
+ )
3815
+ sql_server_audit_config: "SqlServerAuditConfig" = proto.Field(
3816
+ proto.MESSAGE,
3817
+ number=29,
3818
+ message="SqlServerAuditConfig",
3819
+ )
3820
+ edition: Edition = proto.Field(
3821
+ proto.ENUM,
3822
+ number=38,
3823
+ enum=Edition,
3824
+ )
3825
+ connector_enforcement: ConnectorEnforcement = proto.Field(
3826
+ proto.ENUM,
3827
+ number=32,
3828
+ enum=ConnectorEnforcement,
3829
+ )
3830
+ deletion_protection_enabled: wrappers_pb2.BoolValue = proto.Field(
3831
+ proto.MESSAGE,
3832
+ number=33,
3833
+ message=wrappers_pb2.BoolValue,
3834
+ )
3835
+ time_zone: str = proto.Field(
3836
+ proto.STRING,
3837
+ number=34,
3838
+ )
3839
+ advanced_machine_features: "AdvancedMachineFeatures" = proto.Field(
3840
+ proto.MESSAGE,
3841
+ number=35,
3842
+ message="AdvancedMachineFeatures",
3843
+ )
3844
+ data_cache_config: "DataCacheConfig" = proto.Field(
3845
+ proto.MESSAGE,
3846
+ number=37,
3847
+ message="DataCacheConfig",
3848
+ )
3849
+ replication_lag_max_seconds: wrappers_pb2.Int32Value = proto.Field(
3850
+ proto.MESSAGE,
3851
+ number=39,
3852
+ message=wrappers_pb2.Int32Value,
3853
+ )
3854
+ enable_google_ml_integration: wrappers_pb2.BoolValue = proto.Field(
3855
+ proto.MESSAGE,
3856
+ number=40,
3857
+ message=wrappers_pb2.BoolValue,
3858
+ )
3859
+ enable_dataplex_integration: wrappers_pb2.BoolValue = proto.Field(
3860
+ proto.MESSAGE,
3861
+ number=41,
3862
+ message=wrappers_pb2.BoolValue,
3863
+ )
3864
+ retain_backups_on_delete: wrappers_pb2.BoolValue = proto.Field(
3865
+ proto.MESSAGE,
3866
+ number=42,
3867
+ message=wrappers_pb2.BoolValue,
3868
+ )
3869
+ data_disk_provisioned_iops: int = proto.Field(
3870
+ proto.INT64,
3871
+ number=43,
3872
+ optional=True,
3873
+ )
3874
+ data_disk_provisioned_throughput: int = proto.Field(
3875
+ proto.INT64,
3876
+ number=44,
3877
+ optional=True,
3878
+ )
3879
+ connection_pool_config: "ConnectionPoolConfig" = proto.Field(
3880
+ proto.MESSAGE,
3881
+ number=45,
3882
+ optional=True,
3883
+ message="ConnectionPoolConfig",
3884
+ )
3885
+ final_backup_config: "FinalBackupConfig" = proto.Field(
3886
+ proto.MESSAGE,
3887
+ number=47,
3888
+ optional=True,
3889
+ message="FinalBackupConfig",
3890
+ )
3891
+ read_pool_auto_scale_config: "ReadPoolAutoScaleConfig" = proto.Field(
3892
+ proto.MESSAGE,
3893
+ number=48,
3894
+ optional=True,
3895
+ message="ReadPoolAutoScaleConfig",
3896
+ )
3897
+ accelerated_replica_mode: wrappers_pb2.BoolValue = proto.Field(
3898
+ proto.MESSAGE,
3899
+ number=49,
3900
+ message=wrappers_pb2.BoolValue,
3901
+ )
3902
+ auto_upgrade_enabled: bool = proto.Field(
3903
+ proto.BOOL,
3904
+ number=50,
3905
+ optional=True,
3906
+ )
3907
+ entraid_config: "SqlServerEntraIdConfig" = proto.Field(
3908
+ proto.MESSAGE,
3909
+ number=52,
3910
+ message="SqlServerEntraIdConfig",
3911
+ )
3912
+ data_api_access: DataApiAccess = proto.Field(
3913
+ proto.ENUM,
3914
+ number=53,
3915
+ optional=True,
3916
+ enum=DataApiAccess,
3917
+ )
3918
+ performance_capture_config: "PerformanceCaptureConfig" = proto.Field(
3919
+ proto.MESSAGE,
3920
+ number=54,
3921
+ message="PerformanceCaptureConfig",
3922
+ )
3923
+
3924
+
3925
+ class PerformanceCaptureConfig(proto.Message):
3926
+ r"""Performance capture configuration.
3927
+
3928
+ .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
3929
+
3930
+ Attributes:
3931
+ enabled (bool):
3932
+ Optional. Enables or disables the performance
3933
+ capture feature.
3934
+
3935
+ This field is a member of `oneof`_ ``_enabled``.
3936
+ probing_interval_seconds (int):
3937
+ Optional. Specifies the interval in seconds
3938
+ between consecutive probes that check if any
3939
+ trigger condition thresholds have been reached.
3940
+
3941
+ This field is a member of `oneof`_ ``_probing_interval_seconds``.
3942
+ probe_threshold (int):
3943
+ Optional. Specifies the minimum number of
3944
+ consecutive probe threshold that triggers
3945
+ performance capture.
3946
+
3947
+ This field is a member of `oneof`_ ``_probe_threshold``.
3948
+ running_threads_threshold (int):
3949
+ Optional. Specifies the minimum number of MySQL
3950
+ ``Threads_running`` to trigger the performance capture on
3951
+ the primary instance.
3952
+
3953
+ This field is a member of `oneof`_ ``_running_threads_threshold``.
3954
+ seconds_behind_source_threshold (int):
3955
+ Optional. Specifies the minimum number of
3956
+ seconds replica must be lagging behind primary
3957
+ instance to trigger the performance capture on
3958
+ replica.
3959
+
3960
+ This field is a member of `oneof`_ ``_seconds_behind_source_threshold``.
3961
+ transaction_duration_threshold (int):
3962
+ Optional. Specifies the amount of time in
3963
+ seconds that a transaction needs to have been
3964
+ open before the watcher starts recording it.
3965
+
3966
+ This field is a member of `oneof`_ ``_transaction_duration_threshold``.
3967
+ cpu_utilization_threshold_percent (int):
3968
+ Optional. Specifies the minimum percentage of CPU
3969
+ utilization to trigger the performance capture. Valid
3970
+ integers range from ``10`` to ``99``. Enter ``0`` to disable
3971
+ the check.
3972
+
3973
+ This field is a member of `oneof`_ ``_cpu_utilization_threshold_percent``.
3974
+ memory_usage_threshold_percent (int):
3975
+ Optional. Specifies the minimum percentage of memory usage
3976
+ to trigger the performance capture. Valid integers range
3977
+ from ``10`` to ``99``. Enter ``0`` to disable the check.
3978
+
3979
+ This field is a member of `oneof`_ ``_memory_usage_threshold_percent``.
3980
+ transaction_lock_wait_threshold_count (int):
3981
+ Optional. Specifies the minimum allowed number of
3982
+ transactions in lock wait state to trigger the performance
3983
+ capture. Valid integers range from ``10`` to ``10000``.
3984
+ Enter ``0`` to disable the check.
3985
+
3986
+ This field is a member of `oneof`_ ``_transaction_lock_wait_threshold_count``.
3987
+ semaphore_wait_threshold_count (int):
3988
+ Optional. Specifies the minimum allowed number of semaphore
3989
+ waits to trigger the performance capture. Valid integers
3990
+ range from ``10`` to ``10000``. Enter ``0`` to disable the
3991
+ check.
3992
+
3993
+ This field is a member of `oneof`_ ``_semaphore_wait_threshold_count``.
3994
+ history_list_length_threshold_count (int):
3995
+ Optional. Specifies the minimum number of undo log entries
3996
+ in the history list length to trigger the performance
3997
+ capture. Valid integers range from ``10000`` to
3998
+ ``10000000``. Enter ``0`` to disable the check.
3999
+
4000
+ This field is a member of `oneof`_ ``_history_list_length_threshold_count``.
4001
+ transaction_kill_threshold_seconds (int):
4002
+ Optional. Specifies the amount of time in seconds that a
4003
+ transaction needs to have been open before the watcher
4004
+ starts terminating it. Valid integers range from ``60`` to
4005
+ ``604800`` (7 days). Enter ``0`` to disable. If enabled
4006
+ (i.e., > 0), this value must be greater than or equal to
4007
+ ``transaction_duration_threshold``. Configurations where
4008
+ ``0 < transaction_kill_threshold_seconds < transaction_duration_threshold``
4009
+ will be rejected.
4010
+
4011
+ This field is a member of `oneof`_ ``_transaction_kill_threshold_seconds``.
4012
+ transaction_kill_excluded_user_hosts (MutableSequence[str]):
4013
+ Optional. Specifies a customer-defined list of users to
4014
+ exclude from transaction termination. Entries can be in the
4015
+ format 'user@host' or just 'user'. A standalone 'user'
4016
+ implies 'user@%', excluding the user from any host. Wildcard
4017
+ '%' is allowed in the host part of the 'user@host' format.
4018
+ Example:
4019
+ ``["app_user", "db_admin@10.1.2.3", "report_user@%"]``
4020
+ transaction_kill_type (google.cloud.sqladmin_v1.types.PerformanceCaptureConfig.TransactionKillType):
4021
+ Optional. Determines which transactions are allowed to be
4022
+ terminated when they exceed
4023
+ ``transaction_kill_threshold_seconds``. This allows
4024
+ protecting write-heavy transactions from auto-termination if
4025
+ desired. Defaults to ``READ_ONLY_TRANSACTIONS`` if
4026
+ unspecified.
4027
+
4028
+ This field is a member of `oneof`_ ``_transaction_kill_type``.
4029
+ """
4030
+
4031
+ class TransactionKillType(proto.Enum):
4032
+ r"""Defines the categories of long-running transactions eligible
4033
+ for automatic termination by the Performance Capture.
4034
+
4035
+ Values:
4036
+ TRANSACTION_KILL_TYPE_UNSPECIFIED (0):
4037
+ Unspecified.
4038
+ READ_ONLY_TRANSACTIONS (1):
4039
+ Only read-only transactions are eligible for
4040
+ termination.
4041
+ ALL_TRANSACTIONS (2):
4042
+ All transactions are eligible for
4043
+ termination, including those with write
4044
+ operations (such as INSERT, UPDATE, DELETE, or
4045
+ DDL).
4046
+ """
4047
+
4048
+ TRANSACTION_KILL_TYPE_UNSPECIFIED = 0
4049
+ READ_ONLY_TRANSACTIONS = 1
4050
+ ALL_TRANSACTIONS = 2
4051
+
4052
+ enabled: bool = proto.Field(
4053
+ proto.BOOL,
4054
+ number=1,
4055
+ optional=True,
4056
+ )
4057
+ probing_interval_seconds: int = proto.Field(
4058
+ proto.INT32,
4059
+ number=2,
4060
+ optional=True,
4061
+ )
4062
+ probe_threshold: int = proto.Field(
4063
+ proto.INT32,
4064
+ number=3,
4065
+ optional=True,
4066
+ )
4067
+ running_threads_threshold: int = proto.Field(
4068
+ proto.INT32,
4069
+ number=4,
4070
+ optional=True,
4071
+ )
4072
+ seconds_behind_source_threshold: int = proto.Field(
4073
+ proto.INT32,
4074
+ number=5,
4075
+ optional=True,
4076
+ )
4077
+ transaction_duration_threshold: int = proto.Field(
4078
+ proto.INT32,
4079
+ number=8,
4080
+ optional=True,
4081
+ )
4082
+ cpu_utilization_threshold_percent: int = proto.Field(
4083
+ proto.INT32,
4084
+ number=9,
4085
+ optional=True,
4086
+ )
4087
+ memory_usage_threshold_percent: int = proto.Field(
4088
+ proto.INT32,
4089
+ number=10,
4090
+ optional=True,
4091
+ )
4092
+ transaction_lock_wait_threshold_count: int = proto.Field(
4093
+ proto.INT32,
4094
+ number=11,
4095
+ optional=True,
4096
+ )
4097
+ semaphore_wait_threshold_count: int = proto.Field(
4098
+ proto.INT32,
4099
+ number=12,
4100
+ optional=True,
4101
+ )
4102
+ history_list_length_threshold_count: int = proto.Field(
4103
+ proto.INT32,
4104
+ number=13,
4105
+ optional=True,
4106
+ )
4107
+ transaction_kill_threshold_seconds: int = proto.Field(
4108
+ proto.INT32,
4109
+ number=14,
4110
+ optional=True,
4111
+ )
4112
+ transaction_kill_excluded_user_hosts: MutableSequence[str] = proto.RepeatedField(
4113
+ proto.STRING,
4114
+ number=16,
4115
+ )
4116
+ transaction_kill_type: TransactionKillType = proto.Field(
4117
+ proto.ENUM,
4118
+ number=17,
4119
+ optional=True,
4120
+ enum=TransactionKillType,
4121
+ )
4122
+
4123
+
4124
+ class ConnectionPoolFlags(proto.Message):
4125
+ r"""Connection pool flags for Cloud SQL instances managed
4126
+ connection pool configuration.
4127
+
4128
+ Attributes:
4129
+ name (str):
4130
+ Required. The name of the flag.
4131
+ value (str):
4132
+ Required. The value of the flag. Boolean flags are set to
4133
+ ``on`` for true and ``off`` for false. This field must be
4134
+ omitted if the flag doesn't take a value.
4135
+ """
4136
+
4137
+ name: str = proto.Field(
4138
+ proto.STRING,
4139
+ number=1,
4140
+ )
4141
+ value: str = proto.Field(
4142
+ proto.STRING,
4143
+ number=2,
4144
+ )
4145
+
4146
+
4147
+ class ConnectionPoolConfig(proto.Message):
4148
+ r"""The managed connection pooling configuration.
4149
+
4150
+ .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
4151
+
4152
+ Attributes:
4153
+ connection_pooling_enabled (bool):
4154
+ Whether managed connection pooling is
4155
+ enabled.
4156
+
4157
+ This field is a member of `oneof`_ ``_connection_pooling_enabled``.
4158
+ flags (MutableSequence[google.cloud.sqladmin_v1.types.ConnectionPoolFlags]):
4159
+ Optional. List of connection pool
4160
+ configuration flags.
4161
+ pooler_count (int):
4162
+ Output only. Number of connection poolers.
4163
+
4164
+ This field is a member of `oneof`_ ``_pooler_count``.
4165
+ """
4166
+
4167
+ connection_pooling_enabled: bool = proto.Field(
4168
+ proto.BOOL,
4169
+ number=1,
4170
+ optional=True,
4171
+ )
4172
+ flags: MutableSequence["ConnectionPoolFlags"] = proto.RepeatedField(
4173
+ proto.MESSAGE,
4174
+ number=8,
4175
+ message="ConnectionPoolFlags",
4176
+ )
4177
+ pooler_count: int = proto.Field(
4178
+ proto.INT32,
4179
+ number=9,
4180
+ optional=True,
4181
+ )
4182
+
4183
+
4184
+ class ReadPoolAutoScaleConfig(proto.Message):
4185
+ r"""The read pool auto-scale configuration.
4186
+
4187
+ .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
4188
+
4189
+ Attributes:
4190
+ enabled (bool):
4191
+ Indicates whether read pool auto scaling is
4192
+ enabled.
4193
+
4194
+ This field is a member of `oneof`_ ``_enabled``.
4195
+ min_node_count (int):
4196
+ Minimum number of read pool nodes to be
4197
+ maintained.
4198
+
4199
+ This field is a member of `oneof`_ ``_min_node_count``.
4200
+ max_node_count (int):
4201
+ Maximum number of read pool nodes to be
4202
+ maintained.
4203
+
4204
+ This field is a member of `oneof`_ ``_max_node_count``.
4205
+ target_metrics (MutableSequence[google.cloud.sqladmin_v1.types.ReadPoolAutoScaleConfig.TargetMetric]):
4206
+ Optional. Target metrics for read pool auto
4207
+ scaling.
4208
+ disable_scale_in (bool):
4209
+ Indicates whether read pool auto scaling
4210
+ supports scale in operations (removing nodes).
4211
+
4212
+ This field is a member of `oneof`_ ``_disable_scale_in``.
4213
+ scale_in_cooldown_seconds (int):
4214
+ The cooldown period for scale-in operations.
4215
+
4216
+ This field is a member of `oneof`_ ``_scale_in_cooldown_seconds``.
4217
+ scale_out_cooldown_seconds (int):
4218
+ The cooldown period for scale-out operations.
4219
+
4220
+ This field is a member of `oneof`_ ``_scale_out_cooldown_seconds``.
4221
+ """
4222
+
4223
+ class TargetMetric(proto.Message):
4224
+ r"""Target metric for read pool auto scaling.
4225
+
4226
+ .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
4227
+
4228
+ Attributes:
4229
+ metric (str):
4230
+ The metric name to be used for auto scaling.
4231
+
4232
+ This field is a member of `oneof`_ ``_metric``.
4233
+ target_value (float):
4234
+ The target value for the metric.
4235
+
4236
+ This field is a member of `oneof`_ ``_target_value``.
4237
+ """
4238
+
4239
+ metric: str = proto.Field(
4240
+ proto.STRING,
4241
+ number=1,
4242
+ optional=True,
4243
+ )
4244
+ target_value: float = proto.Field(
4245
+ proto.FLOAT,
4246
+ number=2,
4247
+ optional=True,
4248
+ )
4249
+
4250
+ enabled: bool = proto.Field(
4251
+ proto.BOOL,
4252
+ number=1,
4253
+ optional=True,
4254
+ )
4255
+ min_node_count: int = proto.Field(
4256
+ proto.INT32,
4257
+ number=2,
4258
+ optional=True,
4259
+ )
4260
+ max_node_count: int = proto.Field(
4261
+ proto.INT32,
4262
+ number=3,
4263
+ optional=True,
4264
+ )
4265
+ target_metrics: MutableSequence[TargetMetric] = proto.RepeatedField(
4266
+ proto.MESSAGE,
4267
+ number=4,
4268
+ message=TargetMetric,
4269
+ )
4270
+ disable_scale_in: bool = proto.Field(
4271
+ proto.BOOL,
4272
+ number=5,
4273
+ optional=True,
4274
+ )
4275
+ scale_in_cooldown_seconds: int = proto.Field(
4276
+ proto.INT32,
4277
+ number=6,
4278
+ optional=True,
4279
+ )
4280
+ scale_out_cooldown_seconds: int = proto.Field(
4281
+ proto.INT32,
4282
+ number=7,
4283
+ optional=True,
4284
+ )
4285
+
4286
+
4287
+ class AdvancedMachineFeatures(proto.Message):
4288
+ r"""Specifies options for controlling advanced machine features.
4289
+
4290
+ Attributes:
4291
+ threads_per_core (int):
4292
+ The number of threads per physical core.
4293
+ """
4294
+
4295
+ threads_per_core: int = proto.Field(
4296
+ proto.INT32,
4297
+ number=1,
4298
+ )
4299
+
4300
+
4301
+ class SslCert(proto.Message):
4302
+ r"""SslCerts Resource
4303
+
4304
+ Attributes:
4305
+ kind (str):
4306
+ This is always ``sql#sslCert``.
4307
+ cert_serial_number (str):
4308
+ Serial number, as extracted from the
4309
+ certificate.
4310
+ cert (str):
4311
+ PEM representation.
4312
+ create_time (google.protobuf.timestamp_pb2.Timestamp):
4313
+ The time when the certificate was created in `RFC
4314
+ 3339 <https://tools.ietf.org/html/rfc3339>`__ format, for
4315
+ example ``2012-11-15T16:19:00.094Z``
4316
+ common_name (str):
4317
+ User supplied name. Constrained to [a-zA-Z.-\_ ]+.
4318
+ expiration_time (google.protobuf.timestamp_pb2.Timestamp):
4319
+ The time when the certificate expires in `RFC
4320
+ 3339 <https://tools.ietf.org/html/rfc3339>`__ format, for
4321
+ example ``2012-11-15T16:19:00.094Z``.
4322
+ sha1_fingerprint (str):
4323
+ Sha1 Fingerprint.
4324
+ instance (str):
4325
+ Name of the database instance.
4326
+ self_link (str):
4327
+ The URI of this resource.
4328
+ """
4329
+
4330
+ kind: str = proto.Field(
4331
+ proto.STRING,
4332
+ number=1,
4333
+ )
4334
+ cert_serial_number: str = proto.Field(
4335
+ proto.STRING,
4336
+ number=2,
4337
+ )
4338
+ cert: str = proto.Field(
4339
+ proto.STRING,
4340
+ number=3,
4341
+ )
4342
+ create_time: timestamp_pb2.Timestamp = proto.Field(
4343
+ proto.MESSAGE,
4344
+ number=4,
4345
+ message=timestamp_pb2.Timestamp,
4346
+ )
4347
+ common_name: str = proto.Field(
4348
+ proto.STRING,
4349
+ number=5,
4350
+ )
4351
+ expiration_time: timestamp_pb2.Timestamp = proto.Field(
4352
+ proto.MESSAGE,
4353
+ number=6,
4354
+ message=timestamp_pb2.Timestamp,
4355
+ )
4356
+ sha1_fingerprint: str = proto.Field(
4357
+ proto.STRING,
4358
+ number=7,
4359
+ )
4360
+ instance: str = proto.Field(
4361
+ proto.STRING,
4362
+ number=8,
4363
+ )
4364
+ self_link: str = proto.Field(
4365
+ proto.STRING,
4366
+ number=9,
4367
+ )
4368
+
4369
+
4370
+ class SslCertDetail(proto.Message):
4371
+ r"""SslCertDetail.
4372
+
4373
+ Attributes:
4374
+ cert_info (google.cloud.sqladmin_v1.types.SslCert):
4375
+ The public information about the cert.
4376
+ cert_private_key (str):
4377
+ The private key for the client cert, in pem
4378
+ format. Keep private in order to protect your
4379
+ security.
4380
+ """
4381
+
4382
+ cert_info: "SslCert" = proto.Field(
4383
+ proto.MESSAGE,
4384
+ number=1,
4385
+ message="SslCert",
4386
+ )
4387
+ cert_private_key: str = proto.Field(
4388
+ proto.STRING,
4389
+ number=2,
4390
+ )
4391
+
4392
+
4393
+ class SqlActiveDirectoryConfig(proto.Message):
4394
+ r"""Active Directory configuration, relevant only for Cloud SQL
4395
+ for SQL Server.
4396
+
4397
+ Attributes:
4398
+ kind (str):
4399
+ This is always sql#activeDirectoryConfig.
4400
+ domain (str):
4401
+ The name of the domain (e.g., mydomain.com).
4402
+ mode (google.cloud.sqladmin_v1.types.SqlActiveDirectoryConfig.ActiveDirectoryMode):
4403
+ Optional. The mode of the Active Directory
4404
+ configuration.
4405
+ dns_servers (MutableSequence[str]):
4406
+ Optional. Domain controller IPv4 addresses
4407
+ used to bootstrap Active Directory.
4408
+ admin_credential_secret_name (str):
4409
+ Optional. The secret manager key storing the
4410
+ administrator credential. (e.g.,
4411
+ projects/{project}/secrets/{secret}).
4412
+ organizational_unit (str):
4413
+ Optional. The organizational unit
4414
+ distinguished name. This is the full
4415
+ hierarchical path to the organizational unit.
4416
+ """
4417
+
4418
+ class ActiveDirectoryMode(proto.Enum):
4419
+ r"""The modes of Active Directory configuration.
4420
+
4421
+ Values:
4422
+ ACTIVE_DIRECTORY_MODE_UNSPECIFIED (0):
4423
+ Unspecified mode. Will default to MANAGED_ACTIVE_DIRECTORY
4424
+ if the mode is not specified to maintain backward
4425
+ compatibility.
4426
+ MANAGED_ACTIVE_DIRECTORY (1):
4427
+ Managed Active Directory mode.
4428
+ SELF_MANAGED_ACTIVE_DIRECTORY (2):
4429
+ Deprecated: Use CUSTOMER_MANAGED_ACTIVE_DIRECTORY instead.
4430
+ CUSTOMER_MANAGED_ACTIVE_DIRECTORY (3):
4431
+ Customer-managed Active Directory mode.
4432
+ """
4433
+
4434
+ ACTIVE_DIRECTORY_MODE_UNSPECIFIED = 0
4435
+ MANAGED_ACTIVE_DIRECTORY = 1
4436
+ SELF_MANAGED_ACTIVE_DIRECTORY = 2
4437
+ CUSTOMER_MANAGED_ACTIVE_DIRECTORY = 3
4438
+
4439
+ kind: str = proto.Field(
4440
+ proto.STRING,
4441
+ number=1,
4442
+ )
4443
+ domain: str = proto.Field(
4444
+ proto.STRING,
4445
+ number=2,
4446
+ )
4447
+ mode: ActiveDirectoryMode = proto.Field(
4448
+ proto.ENUM,
4449
+ number=3,
4450
+ enum=ActiveDirectoryMode,
4451
+ )
4452
+ dns_servers: MutableSequence[str] = proto.RepeatedField(
4453
+ proto.STRING,
4454
+ number=4,
4455
+ )
4456
+ admin_credential_secret_name: str = proto.Field(
4457
+ proto.STRING,
4458
+ number=5,
4459
+ )
4460
+ organizational_unit: str = proto.Field(
4461
+ proto.STRING,
4462
+ number=6,
4463
+ )
4464
+
4465
+
4466
+ class SqlServerAuditConfig(proto.Message):
4467
+ r"""SQL Server specific audit configuration.
4468
+
4469
+ Attributes:
4470
+ kind (str):
4471
+ This is always sql#sqlServerAuditConfig
4472
+ bucket (str):
4473
+ The name of the destination bucket (e.g.,
4474
+ gs://mybucket).
4475
+ retention_interval (google.protobuf.duration_pb2.Duration):
4476
+ How long to keep generated audit files.
4477
+ upload_interval (google.protobuf.duration_pb2.Duration):
4478
+ How often to upload generated audit files.
4479
+ """
4480
+
4481
+ kind: str = proto.Field(
4482
+ proto.STRING,
4483
+ number=1,
4484
+ )
4485
+ bucket: str = proto.Field(
4486
+ proto.STRING,
4487
+ number=2,
4488
+ )
4489
+ retention_interval: duration_pb2.Duration = proto.Field(
4490
+ proto.MESSAGE,
4491
+ number=3,
4492
+ message=duration_pb2.Duration,
4493
+ )
4494
+ upload_interval: duration_pb2.Duration = proto.Field(
4495
+ proto.MESSAGE,
4496
+ number=4,
4497
+ message=duration_pb2.Duration,
4498
+ )
4499
+
4500
+
4501
+ class SqlServerEntraIdConfig(proto.Message):
4502
+ r"""SQL Server Entra ID configuration.
4503
+
4504
+ Attributes:
4505
+ kind (str):
4506
+ Output only. This is always
4507
+ sql#sqlServerEntraIdConfig
4508
+ tenant_id (str):
4509
+ Optional. The tenant ID for the Entra ID
4510
+ configuration.
4511
+ application_id (str):
4512
+ Optional. The application ID for the Entra ID
4513
+ configuration.
4514
+ """
4515
+
4516
+ kind: str = proto.Field(
4517
+ proto.STRING,
4518
+ number=1,
4519
+ )
4520
+ tenant_id: str = proto.Field(
4521
+ proto.STRING,
4522
+ number=2,
4523
+ )
4524
+ application_id: str = proto.Field(
4525
+ proto.STRING,
4526
+ number=3,
4527
+ )
4528
+
4529
+
4530
+ class AcquireSsrsLeaseContext(proto.Message):
4531
+ r"""Acquire SSRS lease context.
4532
+
4533
+ .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
4534
+
4535
+ Attributes:
4536
+ setup_login (str):
4537
+ The username to be used as the setup login to
4538
+ connect to the database server for SSRS setup.
4539
+
4540
+ This field is a member of `oneof`_ ``_setup_login``.
4541
+ service_login (str):
4542
+ The username to be used as the service login
4543
+ to connect to the report database for SSRS
4544
+ setup.
4545
+
4546
+ This field is a member of `oneof`_ ``_service_login``.
4547
+ report_database (str):
4548
+ The report database to be used for SSRS
4549
+ setup.
4550
+
4551
+ This field is a member of `oneof`_ ``_report_database``.
4552
+ duration (google.protobuf.duration_pb2.Duration):
4553
+ Lease duration needed for SSRS setup.
4554
+
4555
+ This field is a member of `oneof`_ ``_duration``.
4556
+ """
4557
+
4558
+ setup_login: str = proto.Field(
4559
+ proto.STRING,
4560
+ number=1,
4561
+ optional=True,
4562
+ )
4563
+ service_login: str = proto.Field(
4564
+ proto.STRING,
4565
+ number=2,
4566
+ optional=True,
4567
+ )
4568
+ report_database: str = proto.Field(
4569
+ proto.STRING,
4570
+ number=3,
4571
+ optional=True,
4572
+ )
4573
+ duration: duration_pb2.Duration = proto.Field(
4574
+ proto.MESSAGE,
4575
+ number=4,
4576
+ optional=True,
4577
+ message=duration_pb2.Duration,
4578
+ )
4579
+
4580
+
4581
+ class DnsNameMapping(proto.Message):
4582
+ r"""DNS metadata.
4583
+
4584
+ Attributes:
4585
+ name (str):
4586
+ Output only. The DNS name.
4587
+ connection_type (google.cloud.sqladmin_v1.types.DnsNameMapping.ConnectionType):
4588
+ Output only. The connection type of the DNS
4589
+ name.
4590
+ dns_scope (google.cloud.sqladmin_v1.types.DnsNameMapping.DnsScope):
4591
+ Output only. The scope that the DNS name
4592
+ applies to.
4593
+ record_manager (google.cloud.sqladmin_v1.types.DnsNameMapping.RecordManager):
4594
+ Output only. The manager for this DNS record.
4595
+ """
4596
+
4597
+ class ConnectionType(proto.Enum):
4598
+ r"""The connection type of the DNS name.
4599
+ This enum is not frozen, and new values may be added in the
4600
+ future.
4601
+
4602
+ Values:
4603
+ CONNECTION_TYPE_UNSPECIFIED (0):
4604
+ Unknown connection type.
4605
+ PUBLIC (1):
4606
+ Public IP.
4607
+ PRIVATE_SERVICES_ACCESS (2):
4608
+ Private services access (private IP).
4609
+ PRIVATE_SERVICE_CONNECT (3):
4610
+ Private Service Connect.
4611
+ """
4612
+
4613
+ CONNECTION_TYPE_UNSPECIFIED = 0
4614
+ PUBLIC = 1
4615
+ PRIVATE_SERVICES_ACCESS = 2
4616
+ PRIVATE_SERVICE_CONNECT = 3
4617
+
4618
+ class DnsScope(proto.Enum):
4619
+ r"""The scope that the DNS name applies to.
4620
+
4621
+ Values:
4622
+ DNS_SCOPE_UNSPECIFIED (0):
4623
+ DNS scope not set. This value should not be
4624
+ used.
4625
+ INSTANCE (1):
4626
+ Indicates an instance-level DNS name.
4627
+ CLUSTER (2):
4628
+ Indicates a cluster-level DNS name.
4629
+ """
4630
+
4631
+ DNS_SCOPE_UNSPECIFIED = 0
4632
+ INSTANCE = 1
4633
+ CLUSTER = 2
4634
+
4635
+ class RecordManager(proto.Enum):
4636
+ r"""The system responsible for managing the DNS record.
4637
+
4638
+ Values:
4639
+ RECORD_MANAGER_UNSPECIFIED (0):
4640
+ Record manager not set. This value should not
4641
+ be used.
4642
+ CUSTOMER (1):
4643
+ The record may be managed by the customer. It
4644
+ is not automatically managed by Cloud SQL
4645
+ automation.
4646
+ CLOUD_SQL_AUTOMATION (2):
4647
+ The record is managed by Cloud SQL, which
4648
+ will create, update, and delete the DNS records
4649
+ for the zone automatically when the Cloud SQL
4650
+ database instance is created or updated.
4651
+ """
4652
+
4653
+ RECORD_MANAGER_UNSPECIFIED = 0
4654
+ CUSTOMER = 1
4655
+ CLOUD_SQL_AUTOMATION = 2
4656
+
4657
+ name: str = proto.Field(
4658
+ proto.STRING,
4659
+ number=1,
4660
+ )
4661
+ connection_type: ConnectionType = proto.Field(
4662
+ proto.ENUM,
4663
+ number=2,
4664
+ enum=ConnectionType,
4665
+ )
4666
+ dns_scope: DnsScope = proto.Field(
4667
+ proto.ENUM,
4668
+ number=3,
4669
+ enum=DnsScope,
4670
+ )
4671
+ record_manager: RecordManager = proto.Field(
4672
+ proto.ENUM,
4673
+ number=4,
4674
+ enum=RecordManager,
4675
+ )
4676
+
4677
+
4678
+ __all__ = tuple(sorted(__protobuf__.manifest))