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,4514 @@
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 google.rpc.status_pb2 as status_pb2 # type: ignore
24
+ import proto # type: ignore
25
+
26
+ from google.cloud.sqladmin_v1.types import cloud_sql_resources
27
+
28
+ __protobuf__ = proto.module(
29
+ package="google.cloud.sql.v1",
30
+ manifest={
31
+ "ExternalSyncParallelLevel",
32
+ "SqlInstanceType",
33
+ "SqlSuspensionReason",
34
+ "SqlInstancesAddServerCaRequest",
35
+ "SqlInstancesAddServerCertificateRequest",
36
+ "SqlInstancesAddEntraIdCertificateRequest",
37
+ "SqlInstancesCloneRequest",
38
+ "SqlInstancesDeleteRequest",
39
+ "SqlInstancesDemoteMasterRequest",
40
+ "SqlInstancesDemoteRequest",
41
+ "SqlInstancesExportRequest",
42
+ "SqlInstancesFailoverRequest",
43
+ "SqlInstancesGetRequest",
44
+ "SqlInstancesImportRequest",
45
+ "SqlInstancesInsertRequest",
46
+ "SqlInstancesListRequest",
47
+ "SqlInstancesListServerCasRequest",
48
+ "SqlInstancesListServerCertificatesRequest",
49
+ "SqlInstancesListEntraIdCertificatesRequest",
50
+ "SqlInstancesPatchRequest",
51
+ "SqlInstancesPromoteReplicaRequest",
52
+ "SqlInstancesSwitchoverRequest",
53
+ "SqlInstancesResetSslConfigRequest",
54
+ "SqlInstancesRestartRequest",
55
+ "SqlInstancesRestoreBackupRequest",
56
+ "SqlInstancesRotateServerCaRequest",
57
+ "SqlInstancesRotateServerCertificateRequest",
58
+ "SqlInstancesRotateEntraIdCertificateRequest",
59
+ "SqlInstancesStartReplicaRequest",
60
+ "SqlInstancesStopReplicaRequest",
61
+ "SqlInstancesTruncateLogRequest",
62
+ "SqlInstancesPerformDiskShrinkRequest",
63
+ "SqlInstancesUpdateRequest",
64
+ "SqlInstancesRescheduleMaintenanceRequest",
65
+ "SqlInstancesReencryptRequest",
66
+ "InstancesReencryptRequest",
67
+ "BackupReencryptionConfig",
68
+ "ExternalSyncSelectedObject",
69
+ "SqlInstancesGetDiskShrinkConfigRequest",
70
+ "SqlInstancesVerifyExternalSyncSettingsRequest",
71
+ "SqlInstancesStartExternalSyncRequest",
72
+ "SqlInstancesResetReplicaSizeRequest",
73
+ "SqlInstancesCreateEphemeralCertRequest",
74
+ "InstancesCloneRequest",
75
+ "InstancesDemoteMasterRequest",
76
+ "InstancesDemoteRequest",
77
+ "InstancesExportRequest",
78
+ "InstancesFailoverRequest",
79
+ "SslCertsCreateEphemeralRequest",
80
+ "InstancesImportRequest",
81
+ "InstancesPreCheckMajorVersionUpgradeRequest",
82
+ "InstancesListResponse",
83
+ "InstancesListServerCasResponse",
84
+ "InstancesListServerCertificatesResponse",
85
+ "InstancesListEntraIdCertificatesResponse",
86
+ "InstancesRestoreBackupRequest",
87
+ "InstancesRotateServerCaRequest",
88
+ "InstancesRotateServerCertificateRequest",
89
+ "InstancesRotateEntraIdCertificateRequest",
90
+ "InstancesTruncateLogRequest",
91
+ "InstancesAcquireSsrsLeaseRequest",
92
+ "SqlInstancesPreCheckMajorVersionUpgradeRequest",
93
+ "SqlInstancesVerifyExternalSyncSettingsResponse",
94
+ "SqlInstancesGetDiskShrinkConfigResponse",
95
+ "SqlInstancesGetLatestRecoveryTimeRequest",
96
+ "SqlInstancesGetLatestRecoveryTimeResponse",
97
+ "CloneContext",
98
+ "PointInTimeRestoreContext",
99
+ "BinLogCoordinates",
100
+ "DatabaseInstance",
101
+ "GeminiInstanceConfig",
102
+ "ReplicationCluster",
103
+ "AvailableDatabaseVersion",
104
+ "SqlInstancesRescheduleMaintenanceRequestBody",
105
+ "DemoteMasterContext",
106
+ "DemoteContext",
107
+ "FailoverContext",
108
+ "RestoreBackupContext",
109
+ "RotateServerCaContext",
110
+ "RotateServerCertificateContext",
111
+ "RotateEntraIdCertificateContext",
112
+ "TruncateLogContext",
113
+ "SqlExternalSyncSettingError",
114
+ "SelectedObjects",
115
+ "OnPremisesConfiguration",
116
+ "ReplicaConfiguration",
117
+ "SqlInstancesExecuteSqlRequest",
118
+ "ExecuteSqlPayload",
119
+ "SqlInstancesExecuteSqlResponse",
120
+ "QueryResult",
121
+ "Column",
122
+ "Row",
123
+ "Value",
124
+ "Metadata",
125
+ "SqlInstancesAcquireSsrsLeaseRequest",
126
+ "SqlInstancesAcquireSsrsLeaseResponse",
127
+ "SqlInstancesReleaseSsrsLeaseRequest",
128
+ "SqlInstancesReleaseSsrsLeaseResponse",
129
+ "SqlInstancesPointInTimeRestoreRequest",
130
+ },
131
+ )
132
+
133
+
134
+ class ExternalSyncParallelLevel(proto.Enum):
135
+ r"""External Sync parallel level.
136
+
137
+ Values:
138
+ EXTERNAL_SYNC_PARALLEL_LEVEL_UNSPECIFIED (0):
139
+ Unknown sync parallel level. Will be
140
+ defaulted to OPTIMAL.
141
+ MIN (1):
142
+ Minimal parallel level.
143
+ OPTIMAL (2):
144
+ Optimal parallel level.
145
+ MAX (3):
146
+ Maximum parallel level.
147
+ """
148
+
149
+ EXTERNAL_SYNC_PARALLEL_LEVEL_UNSPECIFIED = 0
150
+ MIN = 1
151
+ OPTIMAL = 2
152
+ MAX = 3
153
+
154
+
155
+ class SqlInstanceType(proto.Enum):
156
+ r"""
157
+
158
+ Values:
159
+ SQL_INSTANCE_TYPE_UNSPECIFIED (0):
160
+ This is an unknown Cloud SQL instance type.
161
+ CLOUD_SQL_INSTANCE (1):
162
+ A regular Cloud SQL instance that is not
163
+ replicating from a primary instance.
164
+ ON_PREMISES_INSTANCE (2):
165
+ An instance running on the customer's
166
+ premises that is not managed by Cloud SQL.
167
+ READ_REPLICA_INSTANCE (3):
168
+ A Cloud SQL instance acting as a
169
+ read-replica.
170
+ READ_POOL_INSTANCE (5):
171
+ A Cloud SQL read pool.
172
+ """
173
+
174
+ SQL_INSTANCE_TYPE_UNSPECIFIED = 0
175
+ CLOUD_SQL_INSTANCE = 1
176
+ ON_PREMISES_INSTANCE = 2
177
+ READ_REPLICA_INSTANCE = 3
178
+ READ_POOL_INSTANCE = 5
179
+
180
+
181
+ class SqlSuspensionReason(proto.Enum):
182
+ r"""The suspension reason of the database instance if the state
183
+ is SUSPENDED.
184
+
185
+ Values:
186
+ SQL_SUSPENSION_REASON_UNSPECIFIED (0):
187
+ This is an unknown suspension reason.
188
+ BILLING_ISSUE (2):
189
+ The instance is suspended due to billing
190
+ issues (for example:, account issue)
191
+ LEGAL_ISSUE (3):
192
+ The instance is suspended due to illegal
193
+ content (for example:, child pornography,
194
+ copyrighted material, etc.).
195
+ OPERATIONAL_ISSUE (4):
196
+ The instance is causing operational issues
197
+ (for example:, causing the database to crash).
198
+ KMS_KEY_ISSUE (5):
199
+ The KMS key used by the instance is either
200
+ revoked or denied access to
201
+ PROJECT_ABUSE (8):
202
+ The project is suspended due to abuse
203
+ detected by Ares.
204
+ """
205
+
206
+ SQL_SUSPENSION_REASON_UNSPECIFIED = 0
207
+ BILLING_ISSUE = 2
208
+ LEGAL_ISSUE = 3
209
+ OPERATIONAL_ISSUE = 4
210
+ KMS_KEY_ISSUE = 5
211
+ PROJECT_ABUSE = 8
212
+
213
+
214
+ class SqlInstancesAddServerCaRequest(proto.Message):
215
+ r"""Instance add server CA request.
216
+
217
+ Attributes:
218
+ instance (str):
219
+ Cloud SQL instance ID. This does not include
220
+ the project ID.
221
+ project (str):
222
+ Project ID of the project that contains the
223
+ instance.
224
+ """
225
+
226
+ instance: str = proto.Field(
227
+ proto.STRING,
228
+ number=1,
229
+ )
230
+ project: str = proto.Field(
231
+ proto.STRING,
232
+ number=2,
233
+ )
234
+
235
+
236
+ class SqlInstancesAddServerCertificateRequest(proto.Message):
237
+ r"""Instance add server certificate request.
238
+
239
+ Attributes:
240
+ instance (str):
241
+ Cloud SQL instance ID. This does not include
242
+ the project ID.
243
+ project (str):
244
+ Project ID of the project that contains the
245
+ instance.
246
+ """
247
+
248
+ instance: str = proto.Field(
249
+ proto.STRING,
250
+ number=1,
251
+ )
252
+ project: str = proto.Field(
253
+ proto.STRING,
254
+ number=2,
255
+ )
256
+
257
+
258
+ class SqlInstancesAddEntraIdCertificateRequest(proto.Message):
259
+ r"""Instance add Entra ID certificate request.
260
+
261
+ Attributes:
262
+ instance (str):
263
+ Required. Cloud SQL instance ID. This does
264
+ not include the project ID.
265
+ project (str):
266
+ Required. Project ID of the project that
267
+ contains the instance.
268
+ """
269
+
270
+ instance: str = proto.Field(
271
+ proto.STRING,
272
+ number=1,
273
+ )
274
+ project: str = proto.Field(
275
+ proto.STRING,
276
+ number=2,
277
+ )
278
+
279
+
280
+ class SqlInstancesCloneRequest(proto.Message):
281
+ r"""Instance clone request.
282
+
283
+ Attributes:
284
+ instance (str):
285
+ Required. The ID of the Cloud SQL instance to
286
+ be cloned (source). This does not include the
287
+ project ID.
288
+ project (str):
289
+ Required. Project ID of the source Cloud SQL
290
+ instance.
291
+ body (google.cloud.sqladmin_v1.types.InstancesCloneRequest):
292
+
293
+ """
294
+
295
+ instance: str = proto.Field(
296
+ proto.STRING,
297
+ number=1,
298
+ )
299
+ project: str = proto.Field(
300
+ proto.STRING,
301
+ number=2,
302
+ )
303
+ body: "InstancesCloneRequest" = proto.Field(
304
+ proto.MESSAGE,
305
+ number=100,
306
+ message="InstancesCloneRequest",
307
+ )
308
+
309
+
310
+ class SqlInstancesDeleteRequest(proto.Message):
311
+ r"""Instance delete request.
312
+
313
+ This message has `oneof`_ fields (mutually exclusive fields).
314
+ For each oneof, at most one member field can be set at the same time.
315
+ Setting any member of the oneof automatically clears all other
316
+ members.
317
+
318
+ .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
319
+
320
+ Attributes:
321
+ instance (str):
322
+ Cloud SQL instance ID. This does not include
323
+ the project ID.
324
+ project (str):
325
+ Project ID of the project that contains the
326
+ instance to be deleted.
327
+ enable_final_backup (bool):
328
+ Flag to opt-in for final backup. By default,
329
+ it is turned off.
330
+
331
+ This field is a member of `oneof`_ ``_enable_final_backup``.
332
+ final_backup_ttl_days (int):
333
+ Optional. Retention period of the final
334
+ backup.
335
+
336
+ This field is a member of `oneof`_ ``expiration``.
337
+ final_backup_expiry_time (google.protobuf.timestamp_pb2.Timestamp):
338
+ Optional. Final Backup expiration time.
339
+ Timestamp in UTC of when this resource is
340
+ considered expired.
341
+
342
+ This field is a member of `oneof`_ ``expiration``.
343
+ final_backup_description (str):
344
+ Optional. The description of the final
345
+ backup.
346
+ """
347
+
348
+ instance: str = proto.Field(
349
+ proto.STRING,
350
+ number=1,
351
+ )
352
+ project: str = proto.Field(
353
+ proto.STRING,
354
+ number=2,
355
+ )
356
+ enable_final_backup: bool = proto.Field(
357
+ proto.BOOL,
358
+ number=7,
359
+ optional=True,
360
+ )
361
+ final_backup_ttl_days: int = proto.Field(
362
+ proto.INT64,
363
+ number=4,
364
+ oneof="expiration",
365
+ )
366
+ final_backup_expiry_time: timestamp_pb2.Timestamp = proto.Field(
367
+ proto.MESSAGE,
368
+ number=6,
369
+ oneof="expiration",
370
+ message=timestamp_pb2.Timestamp,
371
+ )
372
+ final_backup_description: str = proto.Field(
373
+ proto.STRING,
374
+ number=5,
375
+ )
376
+
377
+
378
+ class SqlInstancesDemoteMasterRequest(proto.Message):
379
+ r"""Instance demote master request.
380
+
381
+ Attributes:
382
+ instance (str):
383
+ Cloud SQL instance name.
384
+ project (str):
385
+ ID of the project that contains the instance.
386
+ body (google.cloud.sqladmin_v1.types.InstancesDemoteMasterRequest):
387
+
388
+ """
389
+
390
+ instance: str = proto.Field(
391
+ proto.STRING,
392
+ number=1,
393
+ )
394
+ project: str = proto.Field(
395
+ proto.STRING,
396
+ number=2,
397
+ )
398
+ body: "InstancesDemoteMasterRequest" = proto.Field(
399
+ proto.MESSAGE,
400
+ number=100,
401
+ message="InstancesDemoteMasterRequest",
402
+ )
403
+
404
+
405
+ class SqlInstancesDemoteRequest(proto.Message):
406
+ r"""Instance demote request.
407
+
408
+ Attributes:
409
+ instance (str):
410
+ Required. Cloud SQL instance name.
411
+ project (str):
412
+ Required. ID of the project that contains the
413
+ instance.
414
+ body (google.cloud.sqladmin_v1.types.InstancesDemoteRequest):
415
+ Required. The request body.
416
+ """
417
+
418
+ instance: str = proto.Field(
419
+ proto.STRING,
420
+ number=1,
421
+ )
422
+ project: str = proto.Field(
423
+ proto.STRING,
424
+ number=2,
425
+ )
426
+ body: "InstancesDemoteRequest" = proto.Field(
427
+ proto.MESSAGE,
428
+ number=100,
429
+ message="InstancesDemoteRequest",
430
+ )
431
+
432
+
433
+ class SqlInstancesExportRequest(proto.Message):
434
+ r"""Instance export request.
435
+
436
+ Attributes:
437
+ instance (str):
438
+ Cloud SQL instance ID. This does not include
439
+ the project ID.
440
+ project (str):
441
+ Project ID of the project that contains the
442
+ instance to be exported.
443
+ body (google.cloud.sqladmin_v1.types.InstancesExportRequest):
444
+
445
+ """
446
+
447
+ instance: str = proto.Field(
448
+ proto.STRING,
449
+ number=1,
450
+ )
451
+ project: str = proto.Field(
452
+ proto.STRING,
453
+ number=2,
454
+ )
455
+ body: "InstancesExportRequest" = proto.Field(
456
+ proto.MESSAGE,
457
+ number=100,
458
+ message="InstancesExportRequest",
459
+ )
460
+
461
+
462
+ class SqlInstancesFailoverRequest(proto.Message):
463
+ r"""Instance failover request.
464
+
465
+ Attributes:
466
+ instance (str):
467
+ Cloud SQL instance ID. This does not include
468
+ the project ID.
469
+ project (str):
470
+ ID of the project that contains the read
471
+ replica.
472
+ body (google.cloud.sqladmin_v1.types.InstancesFailoverRequest):
473
+
474
+ """
475
+
476
+ instance: str = proto.Field(
477
+ proto.STRING,
478
+ number=1,
479
+ )
480
+ project: str = proto.Field(
481
+ proto.STRING,
482
+ number=2,
483
+ )
484
+ body: "InstancesFailoverRequest" = proto.Field(
485
+ proto.MESSAGE,
486
+ number=100,
487
+ message="InstancesFailoverRequest",
488
+ )
489
+
490
+
491
+ class SqlInstancesGetRequest(proto.Message):
492
+ r"""Instance get request.
493
+
494
+ Attributes:
495
+ instance (str):
496
+ Required. Database instance ID. This does not
497
+ include the project ID.
498
+ project (str):
499
+ Required. Project ID of the project that
500
+ contains the instance.
501
+ """
502
+
503
+ instance: str = proto.Field(
504
+ proto.STRING,
505
+ number=1,
506
+ )
507
+ project: str = proto.Field(
508
+ proto.STRING,
509
+ number=2,
510
+ )
511
+
512
+
513
+ class SqlInstancesImportRequest(proto.Message):
514
+ r"""Instance import request.
515
+
516
+ Attributes:
517
+ instance (str):
518
+ Cloud SQL instance ID. This does not include
519
+ the project ID.
520
+ project (str):
521
+ Project ID of the project that contains the
522
+ instance.
523
+ body (google.cloud.sqladmin_v1.types.InstancesImportRequest):
524
+
525
+ """
526
+
527
+ instance: str = proto.Field(
528
+ proto.STRING,
529
+ number=1,
530
+ )
531
+ project: str = proto.Field(
532
+ proto.STRING,
533
+ number=2,
534
+ )
535
+ body: "InstancesImportRequest" = proto.Field(
536
+ proto.MESSAGE,
537
+ number=100,
538
+ message="InstancesImportRequest",
539
+ )
540
+
541
+
542
+ class SqlInstancesInsertRequest(proto.Message):
543
+ r"""Instance insert request.
544
+
545
+ Attributes:
546
+ project (str):
547
+ Project ID of the project to which the newly
548
+ created Cloud SQL instances should belong.
549
+ body (google.cloud.sqladmin_v1.types.DatabaseInstance):
550
+
551
+ """
552
+
553
+ project: str = proto.Field(
554
+ proto.STRING,
555
+ number=1,
556
+ )
557
+ body: "DatabaseInstance" = proto.Field(
558
+ proto.MESSAGE,
559
+ number=100,
560
+ message="DatabaseInstance",
561
+ )
562
+
563
+
564
+ class SqlInstancesListRequest(proto.Message):
565
+ r"""Instance list request.
566
+
567
+ Attributes:
568
+ filter (str):
569
+ A filter expression that filters resources listed in the
570
+ response. The expression is in the form of field:value. For
571
+ example, 'instanceType:CLOUD_SQL_INSTANCE'. Fields can be
572
+ nested as needed as per their JSON representation, such as
573
+ 'settings.userLabels.auto_start:true'.
574
+
575
+ Multiple filter queries are space-separated. For example.
576
+ 'state:RUNNABLE instanceType:CLOUD_SQL_INSTANCE'. By
577
+ default, each expression is an AND expression. However, you
578
+ can include AND and OR expressions explicitly.
579
+ max_results (int):
580
+ The maximum number of instances to return.
581
+ The service may return fewer than this value. If
582
+ unspecified, at most 500 instances are returned.
583
+ The maximum value is 1000; values above 1000 are
584
+ coerced to 1000.
585
+ page_token (str):
586
+ A previously-returned page token representing
587
+ part of the larger set of results to view.
588
+ project (str):
589
+ Project ID of the project for which to list
590
+ Cloud SQL instances.
591
+ """
592
+
593
+ filter: str = proto.Field(
594
+ proto.STRING,
595
+ number=1,
596
+ )
597
+ max_results: int = proto.Field(
598
+ proto.UINT32,
599
+ number=2,
600
+ )
601
+ page_token: str = proto.Field(
602
+ proto.STRING,
603
+ number=3,
604
+ )
605
+ project: str = proto.Field(
606
+ proto.STRING,
607
+ number=4,
608
+ )
609
+
610
+
611
+ class SqlInstancesListServerCasRequest(proto.Message):
612
+ r"""Instance list server CAs request.
613
+
614
+ Attributes:
615
+ instance (str):
616
+ Cloud SQL instance ID. This does not include
617
+ the project ID.
618
+ project (str):
619
+ Project ID of the project that contains the
620
+ instance.
621
+ """
622
+
623
+ instance: str = proto.Field(
624
+ proto.STRING,
625
+ number=1,
626
+ )
627
+ project: str = proto.Field(
628
+ proto.STRING,
629
+ number=2,
630
+ )
631
+
632
+
633
+ class SqlInstancesListServerCertificatesRequest(proto.Message):
634
+ r"""Instance list server certificates request.
635
+
636
+ Attributes:
637
+ instance (str):
638
+ Required. Cloud SQL instance ID. This does
639
+ not include the project ID.
640
+ project (str):
641
+ Required. Project ID of the project that
642
+ contains the instance.
643
+ """
644
+
645
+ instance: str = proto.Field(
646
+ proto.STRING,
647
+ number=1,
648
+ )
649
+ project: str = proto.Field(
650
+ proto.STRING,
651
+ number=2,
652
+ )
653
+
654
+
655
+ class SqlInstancesListEntraIdCertificatesRequest(proto.Message):
656
+ r"""Instance list Entra ID certificates request.
657
+
658
+ Attributes:
659
+ instance (str):
660
+ Required. Cloud SQL instance ID. This does
661
+ not include the project ID.
662
+ project (str):
663
+ Required. Project ID of the project that
664
+ contains the instance.
665
+ """
666
+
667
+ instance: str = proto.Field(
668
+ proto.STRING,
669
+ number=1,
670
+ )
671
+ project: str = proto.Field(
672
+ proto.STRING,
673
+ number=2,
674
+ )
675
+
676
+
677
+ class SqlInstancesPatchRequest(proto.Message):
678
+ r"""Instance patch request.
679
+
680
+ .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
681
+
682
+ Attributes:
683
+ instance (str):
684
+ Cloud SQL instance ID. This does not include
685
+ the project ID.
686
+ project (str):
687
+ Project ID of the project that contains the
688
+ instance.
689
+ reconcile_psc_networking (bool):
690
+ Optional. Set PSC config to the same value as
691
+ the existing config to reconcile the PSC
692
+ networking.
693
+
694
+ This field is a member of `oneof`_ ``_reconcile_psc_networking``.
695
+ reconcile_psc_networking_force (bool):
696
+ Optional. Set PSC config to the same value as
697
+ the existing config and force reconcile the PSC
698
+ networking.
699
+
700
+ This field is a member of `oneof`_ ``_reconcile_psc_networking_force``.
701
+ body (google.cloud.sqladmin_v1.types.DatabaseInstance):
702
+
703
+ """
704
+
705
+ instance: str = proto.Field(
706
+ proto.STRING,
707
+ number=1,
708
+ )
709
+ project: str = proto.Field(
710
+ proto.STRING,
711
+ number=2,
712
+ )
713
+ reconcile_psc_networking: bool = proto.Field(
714
+ proto.BOOL,
715
+ number=4,
716
+ optional=True,
717
+ )
718
+ reconcile_psc_networking_force: bool = proto.Field(
719
+ proto.BOOL,
720
+ number=5,
721
+ optional=True,
722
+ )
723
+ body: "DatabaseInstance" = proto.Field(
724
+ proto.MESSAGE,
725
+ number=100,
726
+ message="DatabaseInstance",
727
+ )
728
+
729
+
730
+ class SqlInstancesPromoteReplicaRequest(proto.Message):
731
+ r"""Instance promote replica request.
732
+
733
+ Attributes:
734
+ instance (str):
735
+ Cloud SQL read replica instance name.
736
+ project (str):
737
+ ID of the project that contains the read
738
+ replica.
739
+ failover (bool):
740
+ Set to true to invoke a replica failover to
741
+ the DR replica. As part of replica failover, the
742
+ promote operation attempts to add the original
743
+ primary instance as a replica of the promoted DR
744
+ replica when the original primary instance comes
745
+ back online. If set to false or not specified,
746
+ then the original primary instance becomes an
747
+ independent Cloud SQL primary instance.
748
+ """
749
+
750
+ instance: str = proto.Field(
751
+ proto.STRING,
752
+ number=1,
753
+ )
754
+ project: str = proto.Field(
755
+ proto.STRING,
756
+ number=2,
757
+ )
758
+ failover: bool = proto.Field(
759
+ proto.BOOL,
760
+ number=3,
761
+ )
762
+
763
+
764
+ class SqlInstancesSwitchoverRequest(proto.Message):
765
+ r"""Instance switchover request.
766
+
767
+ Attributes:
768
+ instance (str):
769
+ Cloud SQL read replica instance name.
770
+ project (str):
771
+ ID of the project that contains the replica.
772
+ db_timeout (google.protobuf.duration_pb2.Duration):
773
+ Optional. (MySQL and PostgreSQL only) Cloud
774
+ SQL instance operations timeout, which is a sum
775
+ of all database operations. Default value is 10
776
+ minutes and can be modified to a maximum value
777
+ of 24 hours.
778
+ """
779
+
780
+ instance: str = proto.Field(
781
+ proto.STRING,
782
+ number=1,
783
+ )
784
+ project: str = proto.Field(
785
+ proto.STRING,
786
+ number=2,
787
+ )
788
+ db_timeout: duration_pb2.Duration = proto.Field(
789
+ proto.MESSAGE,
790
+ number=3,
791
+ message=duration_pb2.Duration,
792
+ )
793
+
794
+
795
+ class SqlInstancesResetSslConfigRequest(proto.Message):
796
+ r"""Instance reset SSL config request.
797
+
798
+ Attributes:
799
+ instance (str):
800
+ Cloud SQL instance ID. This does not include
801
+ the project ID.
802
+ project (str):
803
+ Project ID of the project that contains the
804
+ instance.
805
+ mode (google.cloud.sqladmin_v1.types.SqlInstancesResetSslConfigRequest.ResetSslMode):
806
+ Optional. Reset SSL mode to use.
807
+ """
808
+
809
+ class ResetSslMode(proto.Enum):
810
+ r"""Reset SSL mode to selectively refresh the SSL materials.
811
+
812
+ Values:
813
+ RESET_SSL_MODE_UNSPECIFIED (0):
814
+ Reset SSL mode is not specified.
815
+ ALL (1):
816
+ Refresh all TLS configs. This is the default
817
+ behaviour.
818
+ SYNC_FROM_PRIMARY (2):
819
+ Refreshes the replication-related TLS
820
+ configuration settings provided by the primary
821
+ instance. Not applicable to on-premises
822
+ replication instances.
823
+ """
824
+
825
+ RESET_SSL_MODE_UNSPECIFIED = 0
826
+ ALL = 1
827
+ SYNC_FROM_PRIMARY = 2
828
+
829
+ instance: str = proto.Field(
830
+ proto.STRING,
831
+ number=1,
832
+ )
833
+ project: str = proto.Field(
834
+ proto.STRING,
835
+ number=2,
836
+ )
837
+ mode: ResetSslMode = proto.Field(
838
+ proto.ENUM,
839
+ number=3,
840
+ enum=ResetSslMode,
841
+ )
842
+
843
+
844
+ class SqlInstancesRestartRequest(proto.Message):
845
+ r"""Instance restart request.
846
+
847
+ Attributes:
848
+ instance (str):
849
+ Cloud SQL instance ID. This does not include
850
+ the project ID.
851
+ project (str):
852
+ Project ID of the project that contains the
853
+ instance to be restarted.
854
+ """
855
+
856
+ instance: str = proto.Field(
857
+ proto.STRING,
858
+ number=1,
859
+ )
860
+ project: str = proto.Field(
861
+ proto.STRING,
862
+ number=2,
863
+ )
864
+
865
+
866
+ class SqlInstancesRestoreBackupRequest(proto.Message):
867
+ r"""Instance restore backup request.
868
+
869
+ Attributes:
870
+ instance (str):
871
+ Cloud SQL instance ID. This does not include
872
+ the project ID.
873
+ project (str):
874
+ Project ID of the project that contains the
875
+ instance.
876
+ body (google.cloud.sqladmin_v1.types.InstancesRestoreBackupRequest):
877
+
878
+ """
879
+
880
+ instance: str = proto.Field(
881
+ proto.STRING,
882
+ number=1,
883
+ )
884
+ project: str = proto.Field(
885
+ proto.STRING,
886
+ number=2,
887
+ )
888
+ body: "InstancesRestoreBackupRequest" = proto.Field(
889
+ proto.MESSAGE,
890
+ number=100,
891
+ message="InstancesRestoreBackupRequest",
892
+ )
893
+
894
+
895
+ class SqlInstancesRotateServerCaRequest(proto.Message):
896
+ r"""Instance rotate server CA request.
897
+
898
+ Attributes:
899
+ instance (str):
900
+ Cloud SQL instance ID. This does not include
901
+ the project ID.
902
+ project (str):
903
+ Project ID of the project that contains the
904
+ instance.
905
+ body (google.cloud.sqladmin_v1.types.InstancesRotateServerCaRequest):
906
+
907
+ """
908
+
909
+ instance: str = proto.Field(
910
+ proto.STRING,
911
+ number=1,
912
+ )
913
+ project: str = proto.Field(
914
+ proto.STRING,
915
+ number=2,
916
+ )
917
+ body: "InstancesRotateServerCaRequest" = proto.Field(
918
+ proto.MESSAGE,
919
+ number=100,
920
+ message="InstancesRotateServerCaRequest",
921
+ )
922
+
923
+
924
+ class SqlInstancesRotateServerCertificateRequest(proto.Message):
925
+ r"""Instance rotate server certificate request.
926
+
927
+ Attributes:
928
+ instance (str):
929
+ Required. Cloud SQL instance ID. This does
930
+ not include the project ID.
931
+ project (str):
932
+ Required. Project ID of the project that
933
+ contains the instance.
934
+ body (google.cloud.sqladmin_v1.types.InstancesRotateServerCertificateRequest):
935
+ Optional. Rotate server certificate request
936
+ body.
937
+ """
938
+
939
+ instance: str = proto.Field(
940
+ proto.STRING,
941
+ number=1,
942
+ )
943
+ project: str = proto.Field(
944
+ proto.STRING,
945
+ number=2,
946
+ )
947
+ body: "InstancesRotateServerCertificateRequest" = proto.Field(
948
+ proto.MESSAGE,
949
+ number=100,
950
+ message="InstancesRotateServerCertificateRequest",
951
+ )
952
+
953
+
954
+ class SqlInstancesRotateEntraIdCertificateRequest(proto.Message):
955
+ r"""Instance rotate server certificate request.
956
+
957
+ Attributes:
958
+ instance (str):
959
+ Required. Cloud SQL instance ID. This does
960
+ not include the project ID.
961
+ project (str):
962
+ Required. Project ID of the project that
963
+ contains the instance.
964
+ body (google.cloud.sqladmin_v1.types.InstancesRotateEntraIdCertificateRequest):
965
+ Optional. Rotate Entra ID certificate request
966
+ body.
967
+ """
968
+
969
+ instance: str = proto.Field(
970
+ proto.STRING,
971
+ number=1,
972
+ )
973
+ project: str = proto.Field(
974
+ proto.STRING,
975
+ number=2,
976
+ )
977
+ body: "InstancesRotateEntraIdCertificateRequest" = proto.Field(
978
+ proto.MESSAGE,
979
+ number=100,
980
+ message="InstancesRotateEntraIdCertificateRequest",
981
+ )
982
+
983
+
984
+ class SqlInstancesStartReplicaRequest(proto.Message):
985
+ r"""Instance start replica request.
986
+
987
+ Attributes:
988
+ instance (str):
989
+ Cloud SQL read replica instance name.
990
+ project (str):
991
+ ID of the project that contains the read
992
+ replica.
993
+ """
994
+
995
+ instance: str = proto.Field(
996
+ proto.STRING,
997
+ number=1,
998
+ )
999
+ project: str = proto.Field(
1000
+ proto.STRING,
1001
+ number=2,
1002
+ )
1003
+
1004
+
1005
+ class SqlInstancesStopReplicaRequest(proto.Message):
1006
+ r"""Instance stop replica request.
1007
+
1008
+ Attributes:
1009
+ instance (str):
1010
+ Cloud SQL read replica instance name.
1011
+ project (str):
1012
+ ID of the project that contains the read
1013
+ replica.
1014
+ """
1015
+
1016
+ instance: str = proto.Field(
1017
+ proto.STRING,
1018
+ number=1,
1019
+ )
1020
+ project: str = proto.Field(
1021
+ proto.STRING,
1022
+ number=2,
1023
+ )
1024
+
1025
+
1026
+ class SqlInstancesTruncateLogRequest(proto.Message):
1027
+ r"""Instance truncate log request.
1028
+
1029
+ Attributes:
1030
+ instance (str):
1031
+ Cloud SQL instance ID. This does not include
1032
+ the project ID.
1033
+ project (str):
1034
+ Project ID of the Cloud SQL project.
1035
+ body (google.cloud.sqladmin_v1.types.InstancesTruncateLogRequest):
1036
+
1037
+ """
1038
+
1039
+ instance: str = proto.Field(
1040
+ proto.STRING,
1041
+ number=1,
1042
+ )
1043
+ project: str = proto.Field(
1044
+ proto.STRING,
1045
+ number=2,
1046
+ )
1047
+ body: "InstancesTruncateLogRequest" = proto.Field(
1048
+ proto.MESSAGE,
1049
+ number=100,
1050
+ message="InstancesTruncateLogRequest",
1051
+ )
1052
+
1053
+
1054
+ class SqlInstancesPerformDiskShrinkRequest(proto.Message):
1055
+ r"""Instance perform disk shrink request.
1056
+
1057
+ Attributes:
1058
+ instance (str):
1059
+ Cloud SQL instance ID. This does not include
1060
+ the project ID.
1061
+ project (str):
1062
+ Project ID of the project that contains the
1063
+ instance.
1064
+ body (google.cloud.sqladmin_v1.types.PerformDiskShrinkContext):
1065
+ Perform disk shrink context.
1066
+ """
1067
+
1068
+ instance: str = proto.Field(
1069
+ proto.STRING,
1070
+ number=1,
1071
+ )
1072
+ project: str = proto.Field(
1073
+ proto.STRING,
1074
+ number=2,
1075
+ )
1076
+ body: cloud_sql_resources.PerformDiskShrinkContext = proto.Field(
1077
+ proto.MESSAGE,
1078
+ number=100,
1079
+ message=cloud_sql_resources.PerformDiskShrinkContext,
1080
+ )
1081
+
1082
+
1083
+ class SqlInstancesUpdateRequest(proto.Message):
1084
+ r"""Instance update request.
1085
+
1086
+ Attributes:
1087
+ instance (str):
1088
+ Cloud SQL instance ID. This does not include
1089
+ the project ID.
1090
+ project (str):
1091
+ Project ID of the project that contains the
1092
+ instance.
1093
+ body (google.cloud.sqladmin_v1.types.DatabaseInstance):
1094
+
1095
+ """
1096
+
1097
+ instance: str = proto.Field(
1098
+ proto.STRING,
1099
+ number=1,
1100
+ )
1101
+ project: str = proto.Field(
1102
+ proto.STRING,
1103
+ number=2,
1104
+ )
1105
+ body: "DatabaseInstance" = proto.Field(
1106
+ proto.MESSAGE,
1107
+ number=100,
1108
+ message="DatabaseInstance",
1109
+ )
1110
+
1111
+
1112
+ class SqlInstancesRescheduleMaintenanceRequest(proto.Message):
1113
+ r"""Instance reschedule maintenance request.
1114
+
1115
+ Attributes:
1116
+ instance (str):
1117
+ Cloud SQL instance ID. This does not include
1118
+ the project ID.
1119
+ project (str):
1120
+ ID of the project that contains the instance.
1121
+ body (google.cloud.sqladmin_v1.types.SqlInstancesRescheduleMaintenanceRequestBody):
1122
+
1123
+ """
1124
+
1125
+ instance: str = proto.Field(
1126
+ proto.STRING,
1127
+ number=1,
1128
+ )
1129
+ project: str = proto.Field(
1130
+ proto.STRING,
1131
+ number=2,
1132
+ )
1133
+ body: "SqlInstancesRescheduleMaintenanceRequestBody" = proto.Field(
1134
+ proto.MESSAGE,
1135
+ number=100,
1136
+ message="SqlInstancesRescheduleMaintenanceRequestBody",
1137
+ )
1138
+
1139
+
1140
+ class SqlInstancesReencryptRequest(proto.Message):
1141
+ r"""Instance reencrypt request.
1142
+
1143
+ Attributes:
1144
+ instance (str):
1145
+ Cloud SQL instance ID. This does not include
1146
+ the project ID.
1147
+ project (str):
1148
+ ID of the project that contains the instance.
1149
+ body (google.cloud.sqladmin_v1.types.InstancesReencryptRequest):
1150
+ Reencrypt body that users request
1151
+ """
1152
+
1153
+ instance: str = proto.Field(
1154
+ proto.STRING,
1155
+ number=1,
1156
+ )
1157
+ project: str = proto.Field(
1158
+ proto.STRING,
1159
+ number=2,
1160
+ )
1161
+ body: "InstancesReencryptRequest" = proto.Field(
1162
+ proto.MESSAGE,
1163
+ number=3,
1164
+ message="InstancesReencryptRequest",
1165
+ )
1166
+
1167
+
1168
+ class InstancesReencryptRequest(proto.Message):
1169
+ r"""Database Instance reencrypt request.
1170
+
1171
+ .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
1172
+
1173
+ Attributes:
1174
+ backup_reencryption_config (google.cloud.sqladmin_v1.types.BackupReencryptionConfig):
1175
+ Configuration specific to backup
1176
+ re-encryption
1177
+
1178
+ This field is a member of `oneof`_ ``_backup_reencryption_config``.
1179
+ """
1180
+
1181
+ backup_reencryption_config: "BackupReencryptionConfig" = proto.Field(
1182
+ proto.MESSAGE,
1183
+ number=1,
1184
+ optional=True,
1185
+ message="BackupReencryptionConfig",
1186
+ )
1187
+
1188
+
1189
+ class BackupReencryptionConfig(proto.Message):
1190
+ r"""Backup Reencryption Config
1191
+
1192
+ .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
1193
+
1194
+ Attributes:
1195
+ backup_limit (int):
1196
+ Backup re-encryption limit
1197
+
1198
+ This field is a member of `oneof`_ ``_backup_limit``.
1199
+ backup_type (google.cloud.sqladmin_v1.types.BackupReencryptionConfig.BackupType):
1200
+ Type of backups users want to re-encrypt.
1201
+
1202
+ This field is a member of `oneof`_ ``_backup_type``.
1203
+ """
1204
+
1205
+ class BackupType(proto.Enum):
1206
+ r"""Backup type for re-encryption
1207
+
1208
+ Values:
1209
+ BACKUP_TYPE_UNSPECIFIED (0):
1210
+ Unknown backup type, will be defaulted to
1211
+ AUTOMATIC backup type
1212
+ AUTOMATED (1):
1213
+ Reencrypt automatic backups
1214
+ ON_DEMAND (2):
1215
+ Reencrypt on-demand backups
1216
+ """
1217
+
1218
+ BACKUP_TYPE_UNSPECIFIED = 0
1219
+ AUTOMATED = 1
1220
+ ON_DEMAND = 2
1221
+
1222
+ backup_limit: int = proto.Field(
1223
+ proto.INT32,
1224
+ number=1,
1225
+ optional=True,
1226
+ )
1227
+ backup_type: BackupType = proto.Field(
1228
+ proto.ENUM,
1229
+ number=2,
1230
+ optional=True,
1231
+ enum=BackupType,
1232
+ )
1233
+
1234
+
1235
+ class ExternalSyncSelectedObject(proto.Message):
1236
+ r"""The selected object that Cloud SQL migrates.
1237
+
1238
+ Attributes:
1239
+ database (str):
1240
+ The name of the database that Cloud SQL
1241
+ migrates.
1242
+ """
1243
+
1244
+ database: str = proto.Field(
1245
+ proto.STRING,
1246
+ number=1,
1247
+ )
1248
+
1249
+
1250
+ class SqlInstancesGetDiskShrinkConfigRequest(proto.Message):
1251
+ r"""Instance get disk shrink config request.
1252
+
1253
+ Attributes:
1254
+ instance (str):
1255
+ Cloud SQL instance ID. This does not include
1256
+ the project ID.
1257
+ project (str):
1258
+ Project ID of the project that contains the
1259
+ instance.
1260
+ """
1261
+
1262
+ instance: str = proto.Field(
1263
+ proto.STRING,
1264
+ number=1,
1265
+ )
1266
+ project: str = proto.Field(
1267
+ proto.STRING,
1268
+ number=2,
1269
+ )
1270
+
1271
+
1272
+ class SqlInstancesVerifyExternalSyncSettingsRequest(proto.Message):
1273
+ r"""Instance verify external sync settings request.
1274
+
1275
+ .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
1276
+
1277
+ Attributes:
1278
+ instance (str):
1279
+ Cloud SQL instance ID. This does not include
1280
+ the project ID.
1281
+ project (str):
1282
+ Project ID of the project that contains the
1283
+ instance.
1284
+ verify_connection_only (bool):
1285
+ Flag to enable verifying connection only
1286
+ sync_mode (google.cloud.sqladmin_v1.types.SqlInstancesVerifyExternalSyncSettingsRequest.ExternalSyncMode):
1287
+ External sync mode
1288
+ verify_replication_only (bool):
1289
+ Optional. Flag to verify settings required by
1290
+ replication setup only
1291
+ mysql_sync_config (google.cloud.sqladmin_v1.types.MySqlSyncConfig):
1292
+ Optional. MySQL-specific settings for start
1293
+ external sync.
1294
+
1295
+ This field is a member of `oneof`_ ``sync_config``.
1296
+ migration_type (google.cloud.sqladmin_v1.types.SqlInstancesVerifyExternalSyncSettingsRequest.MigrationType):
1297
+ Optional. MigrationType configures the migration to use
1298
+ physical files or logical dump files. If not set, then the
1299
+ logical dump file configuration is used. Valid values are
1300
+ ``LOGICAL`` or ``PHYSICAL``. Only applicable to MySQL.
1301
+ sync_parallel_level (google.cloud.sqladmin_v1.types.ExternalSyncParallelLevel):
1302
+ Optional. Parallel level for initial data
1303
+ sync. Only applicable for PostgreSQL.
1304
+ selected_objects (MutableSequence[google.cloud.sqladmin_v1.types.ExternalSyncSelectedObject]):
1305
+ Optional. Migrate only the specified objects
1306
+ from the source instance. If this field is
1307
+ empty, then migrate all objects.
1308
+ """
1309
+
1310
+ class ExternalSyncMode(proto.Enum):
1311
+ r"""
1312
+
1313
+ Values:
1314
+ EXTERNAL_SYNC_MODE_UNSPECIFIED (0):
1315
+ Unknown external sync mode, will be defaulted
1316
+ to ONLINE mode
1317
+ ONLINE (1):
1318
+ Online external sync will set up replication
1319
+ after initial data external sync
1320
+ OFFLINE (2):
1321
+ Offline external sync only dumps and loads a
1322
+ one-time snapshot of the primary instance's data
1323
+ """
1324
+
1325
+ EXTERNAL_SYNC_MODE_UNSPECIFIED = 0
1326
+ ONLINE = 1
1327
+ OFFLINE = 2
1328
+
1329
+ class MigrationType(proto.Enum):
1330
+ r"""MigrationType determines whether the migration is a physical
1331
+ file-based migration or a logical dump file-based migration.
1332
+
1333
+ Values:
1334
+ MIGRATION_TYPE_UNSPECIFIED (0):
1335
+ Default value is a logical dump file-based
1336
+ migration
1337
+ LOGICAL (1):
1338
+ Logical dump file-based migration
1339
+ PHYSICAL (2):
1340
+ Physical file-based migration
1341
+ """
1342
+
1343
+ MIGRATION_TYPE_UNSPECIFIED = 0
1344
+ LOGICAL = 1
1345
+ PHYSICAL = 2
1346
+
1347
+ instance: str = proto.Field(
1348
+ proto.STRING,
1349
+ number=1,
1350
+ )
1351
+ project: str = proto.Field(
1352
+ proto.STRING,
1353
+ number=2,
1354
+ )
1355
+ verify_connection_only: bool = proto.Field(
1356
+ proto.BOOL,
1357
+ number=3,
1358
+ )
1359
+ sync_mode: ExternalSyncMode = proto.Field(
1360
+ proto.ENUM,
1361
+ number=4,
1362
+ enum=ExternalSyncMode,
1363
+ )
1364
+ verify_replication_only: bool = proto.Field(
1365
+ proto.BOOL,
1366
+ number=5,
1367
+ )
1368
+ mysql_sync_config: cloud_sql_resources.MySqlSyncConfig = proto.Field(
1369
+ proto.MESSAGE,
1370
+ number=6,
1371
+ oneof="sync_config",
1372
+ message=cloud_sql_resources.MySqlSyncConfig,
1373
+ )
1374
+ migration_type: MigrationType = proto.Field(
1375
+ proto.ENUM,
1376
+ number=7,
1377
+ enum=MigrationType,
1378
+ )
1379
+ sync_parallel_level: "ExternalSyncParallelLevel" = proto.Field(
1380
+ proto.ENUM,
1381
+ number=8,
1382
+ enum="ExternalSyncParallelLevel",
1383
+ )
1384
+ selected_objects: MutableSequence["ExternalSyncSelectedObject"] = (
1385
+ proto.RepeatedField(
1386
+ proto.MESSAGE,
1387
+ number=9,
1388
+ message="ExternalSyncSelectedObject",
1389
+ )
1390
+ )
1391
+
1392
+
1393
+ class SqlInstancesStartExternalSyncRequest(proto.Message):
1394
+ r"""Instance start external sync request.
1395
+
1396
+ .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
1397
+
1398
+ Attributes:
1399
+ instance (str):
1400
+ Cloud SQL instance ID. This does not include
1401
+ the project ID.
1402
+ project (str):
1403
+ ID of the project that contains the instance.
1404
+ sync_mode (google.cloud.sqladmin_v1.types.SqlInstancesVerifyExternalSyncSettingsRequest.ExternalSyncMode):
1405
+ External sync mode.
1406
+ skip_verification (bool):
1407
+ Whether to skip the verification step (VESS).
1408
+ mysql_sync_config (google.cloud.sqladmin_v1.types.MySqlSyncConfig):
1409
+ MySQL-specific settings for start external
1410
+ sync.
1411
+
1412
+ This field is a member of `oneof`_ ``sync_config``.
1413
+ sync_parallel_level (google.cloud.sqladmin_v1.types.ExternalSyncParallelLevel):
1414
+ Optional. Parallel level for initial data
1415
+ sync. Currently only applicable for MySQL.
1416
+ migration_type (google.cloud.sqladmin_v1.types.SqlInstancesVerifyExternalSyncSettingsRequest.MigrationType):
1417
+ Optional. MigrationType configures the migration to use
1418
+ physical files or logical dump files. If not set, then the
1419
+ logical dump file configuration is used. Valid values are
1420
+ ``LOGICAL`` or ``PHYSICAL``. Only applicable to MySQL.
1421
+ replica_overwrite_enabled (bool):
1422
+ Optional. MySQL only. True if end-user has confirmed that
1423
+ this SES call will wipe replica databases overlapping with
1424
+ the proposed selected_objects. If this field is not set and
1425
+ there are both overlapping and additional databases
1426
+ proposed, an error will be returned.
1427
+ """
1428
+
1429
+ instance: str = proto.Field(
1430
+ proto.STRING,
1431
+ number=1,
1432
+ )
1433
+ project: str = proto.Field(
1434
+ proto.STRING,
1435
+ number=2,
1436
+ )
1437
+ sync_mode: "SqlInstancesVerifyExternalSyncSettingsRequest.ExternalSyncMode" = (
1438
+ proto.Field(
1439
+ proto.ENUM,
1440
+ number=3,
1441
+ enum="SqlInstancesVerifyExternalSyncSettingsRequest.ExternalSyncMode",
1442
+ )
1443
+ )
1444
+ skip_verification: bool = proto.Field(
1445
+ proto.BOOL,
1446
+ number=4,
1447
+ )
1448
+ mysql_sync_config: cloud_sql_resources.MySqlSyncConfig = proto.Field(
1449
+ proto.MESSAGE,
1450
+ number=6,
1451
+ oneof="sync_config",
1452
+ message=cloud_sql_resources.MySqlSyncConfig,
1453
+ )
1454
+ sync_parallel_level: "ExternalSyncParallelLevel" = proto.Field(
1455
+ proto.ENUM,
1456
+ number=7,
1457
+ enum="ExternalSyncParallelLevel",
1458
+ )
1459
+ migration_type: "SqlInstancesVerifyExternalSyncSettingsRequest.MigrationType" = (
1460
+ proto.Field(
1461
+ proto.ENUM,
1462
+ number=8,
1463
+ enum="SqlInstancesVerifyExternalSyncSettingsRequest.MigrationType",
1464
+ )
1465
+ )
1466
+ replica_overwrite_enabled: bool = proto.Field(
1467
+ proto.BOOL,
1468
+ number=9,
1469
+ )
1470
+
1471
+
1472
+ class SqlInstancesResetReplicaSizeRequest(proto.Message):
1473
+ r"""Instance reset replica size request.
1474
+
1475
+ Attributes:
1476
+ instance (str):
1477
+ Cloud SQL read replica instance name.
1478
+ project (str):
1479
+ ID of the project that contains the read
1480
+ replica.
1481
+ """
1482
+
1483
+ instance: str = proto.Field(
1484
+ proto.STRING,
1485
+ number=1,
1486
+ )
1487
+ project: str = proto.Field(
1488
+ proto.STRING,
1489
+ number=2,
1490
+ )
1491
+
1492
+
1493
+ class SqlInstancesCreateEphemeralCertRequest(proto.Message):
1494
+ r"""Instance create ephemeral certificate request.
1495
+
1496
+ Attributes:
1497
+ instance (str):
1498
+ Cloud SQL instance ID. This does not include
1499
+ the project ID.
1500
+ project (str):
1501
+ Project ID of the Cloud SQL project.
1502
+ body (google.cloud.sqladmin_v1.types.SslCertsCreateEphemeralRequest):
1503
+
1504
+ """
1505
+
1506
+ instance: str = proto.Field(
1507
+ proto.STRING,
1508
+ number=1,
1509
+ )
1510
+ project: str = proto.Field(
1511
+ proto.STRING,
1512
+ number=2,
1513
+ )
1514
+ body: "SslCertsCreateEphemeralRequest" = proto.Field(
1515
+ proto.MESSAGE,
1516
+ number=100,
1517
+ message="SslCertsCreateEphemeralRequest",
1518
+ )
1519
+
1520
+
1521
+ class InstancesCloneRequest(proto.Message):
1522
+ r"""Database instance clone request.
1523
+
1524
+ Attributes:
1525
+ clone_context (google.cloud.sqladmin_v1.types.CloneContext):
1526
+ Required. Contains details about the clone
1527
+ operation.
1528
+ """
1529
+
1530
+ clone_context: "CloneContext" = proto.Field(
1531
+ proto.MESSAGE,
1532
+ number=1,
1533
+ message="CloneContext",
1534
+ )
1535
+
1536
+
1537
+ class InstancesDemoteMasterRequest(proto.Message):
1538
+ r"""Database demote primary instance request.
1539
+
1540
+ Attributes:
1541
+ demote_master_context (google.cloud.sqladmin_v1.types.DemoteMasterContext):
1542
+ Contains details about the demoteMaster
1543
+ operation.
1544
+ """
1545
+
1546
+ demote_master_context: "DemoteMasterContext" = proto.Field(
1547
+ proto.MESSAGE,
1548
+ number=1,
1549
+ message="DemoteMasterContext",
1550
+ )
1551
+
1552
+
1553
+ class InstancesDemoteRequest(proto.Message):
1554
+ r"""This request is used to demote an existing standalone
1555
+ instance to be a Cloud SQL read replica for an external database
1556
+ server.
1557
+
1558
+ Attributes:
1559
+ demote_context (google.cloud.sqladmin_v1.types.DemoteContext):
1560
+ Required. Contains details about the demote
1561
+ operation.
1562
+ """
1563
+
1564
+ demote_context: "DemoteContext" = proto.Field(
1565
+ proto.MESSAGE,
1566
+ number=1,
1567
+ message="DemoteContext",
1568
+ )
1569
+
1570
+
1571
+ class InstancesExportRequest(proto.Message):
1572
+ r"""Database instance export request.
1573
+
1574
+ Attributes:
1575
+ export_context (google.cloud.sqladmin_v1.types.ExportContext):
1576
+ Contains details about the export operation.
1577
+ """
1578
+
1579
+ export_context: cloud_sql_resources.ExportContext = proto.Field(
1580
+ proto.MESSAGE,
1581
+ number=1,
1582
+ message=cloud_sql_resources.ExportContext,
1583
+ )
1584
+
1585
+
1586
+ class InstancesFailoverRequest(proto.Message):
1587
+ r"""Instance failover request.
1588
+
1589
+ Attributes:
1590
+ failover_context (google.cloud.sqladmin_v1.types.FailoverContext):
1591
+ Failover Context.
1592
+ """
1593
+
1594
+ failover_context: "FailoverContext" = proto.Field(
1595
+ proto.MESSAGE,
1596
+ number=1,
1597
+ message="FailoverContext",
1598
+ )
1599
+
1600
+
1601
+ class SslCertsCreateEphemeralRequest(proto.Message):
1602
+ r"""SslCerts create ephemeral certificate request.
1603
+
1604
+ Attributes:
1605
+ public_key (str):
1606
+ PEM encoded public key to include in the
1607
+ signed certificate.
1608
+ access_token (str):
1609
+ Access token to include in the signed
1610
+ certificate.
1611
+ """
1612
+
1613
+ public_key: str = proto.Field(
1614
+ proto.STRING,
1615
+ number=1,
1616
+ )
1617
+ access_token: str = proto.Field(
1618
+ proto.STRING,
1619
+ number=2,
1620
+ )
1621
+
1622
+
1623
+ class InstancesImportRequest(proto.Message):
1624
+ r"""Database instance import request.
1625
+
1626
+ Attributes:
1627
+ import_context (google.cloud.sqladmin_v1.types.ImportContext):
1628
+ Contains details about the import operation.
1629
+ """
1630
+
1631
+ import_context: cloud_sql_resources.ImportContext = proto.Field(
1632
+ proto.MESSAGE,
1633
+ number=1,
1634
+ message=cloud_sql_resources.ImportContext,
1635
+ )
1636
+
1637
+
1638
+ class InstancesPreCheckMajorVersionUpgradeRequest(proto.Message):
1639
+ r"""Request for Pre-checks for MVU
1640
+
1641
+ Attributes:
1642
+ pre_check_major_version_upgrade_context (google.cloud.sqladmin_v1.types.PreCheckMajorVersionUpgradeContext):
1643
+ Required. Contains details about the
1644
+ pre-check major version upgrade operation.
1645
+ """
1646
+
1647
+ pre_check_major_version_upgrade_context: cloud_sql_resources.PreCheckMajorVersionUpgradeContext = proto.Field(
1648
+ proto.MESSAGE,
1649
+ number=1,
1650
+ message=cloud_sql_resources.PreCheckMajorVersionUpgradeContext,
1651
+ )
1652
+
1653
+
1654
+ class InstancesListResponse(proto.Message):
1655
+ r"""Database instances list response.
1656
+
1657
+ Attributes:
1658
+ kind (str):
1659
+ This is always ``sql#instancesList``.
1660
+ warnings (MutableSequence[google.cloud.sqladmin_v1.types.ApiWarning]):
1661
+ List of warnings that occurred while handling
1662
+ the request.
1663
+ items (MutableSequence[google.cloud.sqladmin_v1.types.DatabaseInstance]):
1664
+ List of database instance resources.
1665
+ next_page_token (str):
1666
+ The continuation token, used to page through
1667
+ large result sets. Provide this value in a
1668
+ subsequent request to return the next page of
1669
+ results.
1670
+ """
1671
+
1672
+ @property
1673
+ def raw_page(self):
1674
+ return self
1675
+
1676
+ kind: str = proto.Field(
1677
+ proto.STRING,
1678
+ number=1,
1679
+ )
1680
+ warnings: MutableSequence[cloud_sql_resources.ApiWarning] = proto.RepeatedField(
1681
+ proto.MESSAGE,
1682
+ number=2,
1683
+ message=cloud_sql_resources.ApiWarning,
1684
+ )
1685
+ items: MutableSequence["DatabaseInstance"] = proto.RepeatedField(
1686
+ proto.MESSAGE,
1687
+ number=3,
1688
+ message="DatabaseInstance",
1689
+ )
1690
+ next_page_token: str = proto.Field(
1691
+ proto.STRING,
1692
+ number=4,
1693
+ )
1694
+
1695
+
1696
+ class InstancesListServerCasResponse(proto.Message):
1697
+ r"""Instances ListServerCas response.
1698
+
1699
+ Attributes:
1700
+ certs (MutableSequence[google.cloud.sqladmin_v1.types.SslCert]):
1701
+ List of server CA certificates for the
1702
+ instance.
1703
+ active_version (str):
1704
+
1705
+ kind (str):
1706
+ This is always ``sql#instancesListServerCas``.
1707
+ """
1708
+
1709
+ certs: MutableSequence[cloud_sql_resources.SslCert] = proto.RepeatedField(
1710
+ proto.MESSAGE,
1711
+ number=1,
1712
+ message=cloud_sql_resources.SslCert,
1713
+ )
1714
+ active_version: str = proto.Field(
1715
+ proto.STRING,
1716
+ number=2,
1717
+ )
1718
+ kind: str = proto.Field(
1719
+ proto.STRING,
1720
+ number=3,
1721
+ )
1722
+
1723
+
1724
+ class InstancesListServerCertificatesResponse(proto.Message):
1725
+ r"""Instances ListServerCertificates response.
1726
+
1727
+ Attributes:
1728
+ ca_certs (MutableSequence[google.cloud.sqladmin_v1.types.SslCert]):
1729
+ List of server CA certificates for the
1730
+ instance.
1731
+ server_certs (MutableSequence[google.cloud.sqladmin_v1.types.SslCert]):
1732
+ List of server certificates for the instance, signed by the
1733
+ corresponding CA from the ``ca_certs`` list.
1734
+ active_version (str):
1735
+ The ``sha1_fingerprint`` of the active certificate from
1736
+ ``server_certs``.
1737
+ kind (str):
1738
+ This is always ``sql#instancesListServerCertificates``.
1739
+ """
1740
+
1741
+ ca_certs: MutableSequence[cloud_sql_resources.SslCert] = proto.RepeatedField(
1742
+ proto.MESSAGE,
1743
+ number=1,
1744
+ message=cloud_sql_resources.SslCert,
1745
+ )
1746
+ server_certs: MutableSequence[cloud_sql_resources.SslCert] = proto.RepeatedField(
1747
+ proto.MESSAGE,
1748
+ number=2,
1749
+ message=cloud_sql_resources.SslCert,
1750
+ )
1751
+ active_version: str = proto.Field(
1752
+ proto.STRING,
1753
+ number=3,
1754
+ )
1755
+ kind: str = proto.Field(
1756
+ proto.STRING,
1757
+ number=4,
1758
+ )
1759
+
1760
+
1761
+ class InstancesListEntraIdCertificatesResponse(proto.Message):
1762
+ r"""Instances ListEntraIdCertificates response.
1763
+
1764
+ Attributes:
1765
+ certs (MutableSequence[google.cloud.sqladmin_v1.types.SslCert]):
1766
+ List of Entra ID certificates for the
1767
+ instance.
1768
+ active_version (str):
1769
+ The ``sha1_fingerprint`` of the active certificate from
1770
+ ``certs``.
1771
+ kind (str):
1772
+ This is always ``sql#instancesListEntraIdCertificates``.
1773
+ """
1774
+
1775
+ certs: MutableSequence[cloud_sql_resources.SslCert] = proto.RepeatedField(
1776
+ proto.MESSAGE,
1777
+ number=1,
1778
+ message=cloud_sql_resources.SslCert,
1779
+ )
1780
+ active_version: str = proto.Field(
1781
+ proto.STRING,
1782
+ number=2,
1783
+ )
1784
+ kind: str = proto.Field(
1785
+ proto.STRING,
1786
+ number=3,
1787
+ )
1788
+
1789
+
1790
+ class InstancesRestoreBackupRequest(proto.Message):
1791
+ r"""Database instance restore backup request.
1792
+
1793
+ Attributes:
1794
+ restore_backup_context (google.cloud.sqladmin_v1.types.RestoreBackupContext):
1795
+ Parameters required to perform the restore
1796
+ backup operation.
1797
+ backup (str):
1798
+ The name of the backup that's used to restore a Cloud SQL
1799
+ instance: Format:
1800
+ projects/{project-id}/backups/{backup-uid}. Only one of
1801
+ restore_backup_context, backup, backupdr_backup can be
1802
+ passed to the input.
1803
+ backupdr_backup (str):
1804
+ The name of the backup that's used to restore a Cloud SQL
1805
+ instance: Format:
1806
+ "projects/{project-id}/locations/{location}/backupVaults/{backupvault}/dataSources/{datasource}/backups/{backup-uid}".
1807
+ Only one of restore_backup_context, backup, backupdr_backup
1808
+ can be passed to the input.
1809
+ restore_instance_settings (google.cloud.sqladmin_v1.types.DatabaseInstance):
1810
+ Optional. By using this parameter, Cloud SQL
1811
+ overrides any instance settings stored in the
1812
+ backup you are restoring from. You can't change
1813
+ the instance's major database version and you
1814
+ can only increase the disk size. You can use
1815
+ this field to restore new instances only. This
1816
+ field is not applicable for restore to existing
1817
+ instances.
1818
+ restore_instance_clear_overrides_field_names (MutableSequence[str]):
1819
+ Optional. This field has the same purpose as
1820
+ restore_instance_settings, changes any instance settings
1821
+ stored in the backup you are restoring from. With the
1822
+ difference that these fields are cleared in the settings.
1823
+ """
1824
+
1825
+ restore_backup_context: "RestoreBackupContext" = proto.Field(
1826
+ proto.MESSAGE,
1827
+ number=1,
1828
+ message="RestoreBackupContext",
1829
+ )
1830
+ backup: str = proto.Field(
1831
+ proto.STRING,
1832
+ number=2,
1833
+ )
1834
+ backupdr_backup: str = proto.Field(
1835
+ proto.STRING,
1836
+ number=4,
1837
+ )
1838
+ restore_instance_settings: "DatabaseInstance" = proto.Field(
1839
+ proto.MESSAGE,
1840
+ number=3,
1841
+ message="DatabaseInstance",
1842
+ )
1843
+ restore_instance_clear_overrides_field_names: MutableSequence[str] = (
1844
+ proto.RepeatedField(
1845
+ proto.STRING,
1846
+ number=5,
1847
+ )
1848
+ )
1849
+
1850
+
1851
+ class InstancesRotateServerCaRequest(proto.Message):
1852
+ r"""Rotate server CA request.
1853
+
1854
+ Attributes:
1855
+ rotate_server_ca_context (google.cloud.sqladmin_v1.types.RotateServerCaContext):
1856
+ Contains details about the rotate server CA
1857
+ operation.
1858
+ """
1859
+
1860
+ rotate_server_ca_context: "RotateServerCaContext" = proto.Field(
1861
+ proto.MESSAGE,
1862
+ number=1,
1863
+ message="RotateServerCaContext",
1864
+ )
1865
+
1866
+
1867
+ class InstancesRotateServerCertificateRequest(proto.Message):
1868
+ r"""Rotate server certificate request.
1869
+
1870
+ Attributes:
1871
+ rotate_server_certificate_context (google.cloud.sqladmin_v1.types.RotateServerCertificateContext):
1872
+ Optional. Contains details about the rotate
1873
+ server certificate operation.
1874
+ """
1875
+
1876
+ rotate_server_certificate_context: "RotateServerCertificateContext" = proto.Field(
1877
+ proto.MESSAGE,
1878
+ number=1,
1879
+ message="RotateServerCertificateContext",
1880
+ )
1881
+
1882
+
1883
+ class InstancesRotateEntraIdCertificateRequest(proto.Message):
1884
+ r"""Rotate Entra ID certificate request.
1885
+
1886
+ Attributes:
1887
+ rotate_entra_id_certificate_context (google.cloud.sqladmin_v1.types.RotateEntraIdCertificateContext):
1888
+ Optional. Contains details about the rotate
1889
+ server certificate operation.
1890
+ """
1891
+
1892
+ rotate_entra_id_certificate_context: "RotateEntraIdCertificateContext" = (
1893
+ proto.Field(
1894
+ proto.MESSAGE,
1895
+ number=1,
1896
+ message="RotateEntraIdCertificateContext",
1897
+ )
1898
+ )
1899
+
1900
+
1901
+ class InstancesTruncateLogRequest(proto.Message):
1902
+ r"""Instance truncate log request.
1903
+
1904
+ Attributes:
1905
+ truncate_log_context (google.cloud.sqladmin_v1.types.TruncateLogContext):
1906
+ Contains details about the truncate log
1907
+ operation.
1908
+ """
1909
+
1910
+ truncate_log_context: "TruncateLogContext" = proto.Field(
1911
+ proto.MESSAGE,
1912
+ number=1,
1913
+ message="TruncateLogContext",
1914
+ )
1915
+
1916
+
1917
+ class InstancesAcquireSsrsLeaseRequest(proto.Message):
1918
+ r"""Request to acquire a lease for SSRS.
1919
+
1920
+ Attributes:
1921
+ acquire_ssrs_lease_context (google.cloud.sqladmin_v1.types.AcquireSsrsLeaseContext):
1922
+ Contains details about the acquire SSRS lease
1923
+ operation.
1924
+ """
1925
+
1926
+ acquire_ssrs_lease_context: cloud_sql_resources.AcquireSsrsLeaseContext = (
1927
+ proto.Field(
1928
+ proto.MESSAGE,
1929
+ number=1,
1930
+ message=cloud_sql_resources.AcquireSsrsLeaseContext,
1931
+ )
1932
+ )
1933
+
1934
+
1935
+ class SqlInstancesPreCheckMajorVersionUpgradeRequest(proto.Message):
1936
+ r"""Request for Pre-checks for MVU
1937
+
1938
+ Attributes:
1939
+ instance (str):
1940
+ Required. Cloud SQL instance ID. This does
1941
+ not include the project ID.
1942
+ project (str):
1943
+ Required. Project ID of the project that
1944
+ contains the instance.
1945
+ body (google.cloud.sqladmin_v1.types.InstancesPreCheckMajorVersionUpgradeRequest):
1946
+ Required. The context for request to perform
1947
+ the pre-check major version upgrade operation.
1948
+ """
1949
+
1950
+ instance: str = proto.Field(
1951
+ proto.STRING,
1952
+ number=1,
1953
+ )
1954
+ project: str = proto.Field(
1955
+ proto.STRING,
1956
+ number=2,
1957
+ )
1958
+ body: "InstancesPreCheckMajorVersionUpgradeRequest" = proto.Field(
1959
+ proto.MESSAGE,
1960
+ number=3,
1961
+ message="InstancesPreCheckMajorVersionUpgradeRequest",
1962
+ )
1963
+
1964
+
1965
+ class SqlInstancesVerifyExternalSyncSettingsResponse(proto.Message):
1966
+ r"""Instance verify external sync settings response.
1967
+
1968
+ Attributes:
1969
+ kind (str):
1970
+ This is always ``sql#migrationSettingErrorList``.
1971
+ errors (MutableSequence[google.cloud.sqladmin_v1.types.SqlExternalSyncSettingError]):
1972
+ List of migration violations.
1973
+ warnings (MutableSequence[google.cloud.sqladmin_v1.types.SqlExternalSyncSettingError]):
1974
+ List of migration warnings.
1975
+ """
1976
+
1977
+ kind: str = proto.Field(
1978
+ proto.STRING,
1979
+ number=1,
1980
+ )
1981
+ errors: MutableSequence["SqlExternalSyncSettingError"] = proto.RepeatedField(
1982
+ proto.MESSAGE,
1983
+ number=2,
1984
+ message="SqlExternalSyncSettingError",
1985
+ )
1986
+ warnings: MutableSequence["SqlExternalSyncSettingError"] = proto.RepeatedField(
1987
+ proto.MESSAGE,
1988
+ number=3,
1989
+ message="SqlExternalSyncSettingError",
1990
+ )
1991
+
1992
+
1993
+ class SqlInstancesGetDiskShrinkConfigResponse(proto.Message):
1994
+ r"""Instance get disk shrink config response.
1995
+
1996
+ Attributes:
1997
+ kind (str):
1998
+ This is always ``sql#getDiskShrinkConfig``.
1999
+ minimal_target_size_gb (int):
2000
+ The minimum size to which a disk can be
2001
+ shrunk in GigaBytes.
2002
+ message (str):
2003
+ Additional message to customers.
2004
+ """
2005
+
2006
+ kind: str = proto.Field(
2007
+ proto.STRING,
2008
+ number=1,
2009
+ )
2010
+ minimal_target_size_gb: int = proto.Field(
2011
+ proto.INT64,
2012
+ number=2,
2013
+ )
2014
+ message: str = proto.Field(
2015
+ proto.STRING,
2016
+ number=3,
2017
+ )
2018
+
2019
+
2020
+ class SqlInstancesGetLatestRecoveryTimeRequest(proto.Message):
2021
+ r"""Instance get latest recovery time request.
2022
+
2023
+ .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
2024
+
2025
+ Attributes:
2026
+ instance (str):
2027
+ Cloud SQL instance ID. This does not include
2028
+ the project ID.
2029
+ project (str):
2030
+ Project ID of the project that contains the
2031
+ instance.
2032
+ source_instance_deletion_time (google.protobuf.timestamp_pb2.Timestamp):
2033
+ The timestamp used to identify the time when
2034
+ the source instance is deleted. If this instance
2035
+ is deleted, then you must set the timestamp.
2036
+
2037
+ This field is a member of `oneof`_ ``_source_instance_deletion_time``.
2038
+ """
2039
+
2040
+ instance: str = proto.Field(
2041
+ proto.STRING,
2042
+ number=1,
2043
+ )
2044
+ project: str = proto.Field(
2045
+ proto.STRING,
2046
+ number=2,
2047
+ )
2048
+ source_instance_deletion_time: timestamp_pb2.Timestamp = proto.Field(
2049
+ proto.MESSAGE,
2050
+ number=3,
2051
+ optional=True,
2052
+ message=timestamp_pb2.Timestamp,
2053
+ )
2054
+
2055
+
2056
+ class SqlInstancesGetLatestRecoveryTimeResponse(proto.Message):
2057
+ r"""Instance get latest recovery time response.
2058
+
2059
+ Attributes:
2060
+ kind (str):
2061
+ This is always ``sql#getLatestRecoveryTime``.
2062
+ latest_recovery_time (google.protobuf.timestamp_pb2.Timestamp):
2063
+ Timestamp, identifies the latest recovery
2064
+ time of the source instance.
2065
+ earliest_recovery_time (google.protobuf.timestamp_pb2.Timestamp):
2066
+ Timestamp, identifies the earliest recovery
2067
+ time of the source instance.
2068
+ """
2069
+
2070
+ kind: str = proto.Field(
2071
+ proto.STRING,
2072
+ number=1,
2073
+ )
2074
+ latest_recovery_time: timestamp_pb2.Timestamp = proto.Field(
2075
+ proto.MESSAGE,
2076
+ number=2,
2077
+ message=timestamp_pb2.Timestamp,
2078
+ )
2079
+ earliest_recovery_time: timestamp_pb2.Timestamp = proto.Field(
2080
+ proto.MESSAGE,
2081
+ number=3,
2082
+ message=timestamp_pb2.Timestamp,
2083
+ )
2084
+
2085
+
2086
+ class CloneContext(proto.Message):
2087
+ r"""Database instance clone context.
2088
+
2089
+ .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
2090
+
2091
+ Attributes:
2092
+ kind (str):
2093
+ This is always ``sql#cloneContext``.
2094
+ pitr_timestamp_ms (int):
2095
+ Reserved for future use.
2096
+ destination_instance_name (str):
2097
+ Required. Name of the Cloud SQL instance to
2098
+ be created as a clone.
2099
+ bin_log_coordinates (google.cloud.sqladmin_v1.types.BinLogCoordinates):
2100
+ Binary log coordinates, if specified,
2101
+ identify the position up to which the source
2102
+ instance is cloned. If not specified, the source
2103
+ instance is cloned up to the most recent binary
2104
+ log coordinates.
2105
+ point_in_time (google.protobuf.timestamp_pb2.Timestamp):
2106
+ Timestamp, if specified, identifies the time
2107
+ to which the source instance is cloned.
2108
+ allocated_ip_range (str):
2109
+ The name of the allocated ip range for the private ip Cloud
2110
+ SQL instance. For example:
2111
+ "google-managed-services-default". If set, the cloned
2112
+ instance ip will be created in the allocated range. The
2113
+ range name must comply with `RFC
2114
+ 1035 <https://tools.ietf.org/html/rfc1035>`__. Specifically,
2115
+ the name must be 1-63 characters long and match the regular
2116
+ expression `a-z <[-a-z0-9]*[a-z0-9]>`__?. Reserved for
2117
+ future use.
2118
+ database_names (MutableSequence[str]):
2119
+ (SQL Server only) Clone only the specified
2120
+ databases from the source instance. Clone all
2121
+ databases if empty.
2122
+ preferred_zone (str):
2123
+ Optional. Copy clone and point-in-time
2124
+ recovery clone of an instance to the specified
2125
+ zone. If no zone is specified, clone to the same
2126
+ primary zone as the source instance. This field
2127
+ applies to all DB types.
2128
+
2129
+ This field is a member of `oneof`_ ``_preferred_zone``.
2130
+ preferred_secondary_zone (str):
2131
+ Optional. Copy clone and point-in-time recovery clone of a
2132
+ regional instance in the specified zones. If not specified,
2133
+ clone to the same secondary zone as the source instance.
2134
+ This value cannot be the same as the preferred_zone field.
2135
+ This field applies to all DB types.
2136
+
2137
+ This field is a member of `oneof`_ ``_preferred_secondary_zone``.
2138
+ source_instance_deletion_time (google.protobuf.timestamp_pb2.Timestamp):
2139
+ The timestamp used to identify the time when
2140
+ the source instance is deleted. If this instance
2141
+ is deleted, then you must set the timestamp.
2142
+
2143
+ This field is a member of `oneof`_ ``_source_instance_deletion_time``.
2144
+ destination_project (str):
2145
+ Optional. The project ID of the destination
2146
+ project where the cloned instance will be
2147
+ created. To perform a cross-project clone, this
2148
+ field is required. If not specified, the clone
2149
+ is created in the same project as the source
2150
+ instance.
2151
+
2152
+ This field is a member of `oneof`_ ``_destination_project``.
2153
+ destination_network (str):
2154
+ Optional. The fully qualified URI of the VPC network to
2155
+ which the cloned instance will be connected via private
2156
+ services access for private IP. For
2157
+ example:``projects/my-network-project/global/networks/my-network``.
2158
+ This field is only required for cross-project cloning.
2159
+
2160
+ This field is a member of `oneof`_ ``_destination_network``.
2161
+ """
2162
+
2163
+ kind: str = proto.Field(
2164
+ proto.STRING,
2165
+ number=1,
2166
+ )
2167
+ pitr_timestamp_ms: int = proto.Field(
2168
+ proto.INT64,
2169
+ number=2,
2170
+ )
2171
+ destination_instance_name: str = proto.Field(
2172
+ proto.STRING,
2173
+ number=3,
2174
+ )
2175
+ bin_log_coordinates: "BinLogCoordinates" = proto.Field(
2176
+ proto.MESSAGE,
2177
+ number=4,
2178
+ message="BinLogCoordinates",
2179
+ )
2180
+ point_in_time: timestamp_pb2.Timestamp = proto.Field(
2181
+ proto.MESSAGE,
2182
+ number=5,
2183
+ message=timestamp_pb2.Timestamp,
2184
+ )
2185
+ allocated_ip_range: str = proto.Field(
2186
+ proto.STRING,
2187
+ number=6,
2188
+ )
2189
+ database_names: MutableSequence[str] = proto.RepeatedField(
2190
+ proto.STRING,
2191
+ number=9,
2192
+ )
2193
+ preferred_zone: str = proto.Field(
2194
+ proto.STRING,
2195
+ number=10,
2196
+ optional=True,
2197
+ )
2198
+ preferred_secondary_zone: str = proto.Field(
2199
+ proto.STRING,
2200
+ number=11,
2201
+ optional=True,
2202
+ )
2203
+ source_instance_deletion_time: timestamp_pb2.Timestamp = proto.Field(
2204
+ proto.MESSAGE,
2205
+ number=12,
2206
+ optional=True,
2207
+ message=timestamp_pb2.Timestamp,
2208
+ )
2209
+ destination_project: str = proto.Field(
2210
+ proto.STRING,
2211
+ number=13,
2212
+ optional=True,
2213
+ )
2214
+ destination_network: str = proto.Field(
2215
+ proto.STRING,
2216
+ number=14,
2217
+ optional=True,
2218
+ )
2219
+
2220
+
2221
+ class PointInTimeRestoreContext(proto.Message):
2222
+ r"""The context to perform a point-in-time recovery of an
2223
+ instance managed by Backup and Disaster Recovery (DR) Service.
2224
+
2225
+
2226
+ .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
2227
+
2228
+ Attributes:
2229
+ datasource (str):
2230
+ The Backup and Disaster Recovery (DR) Service
2231
+ Datasource URI. Format:
2232
+
2233
+ projects/{project}/locations/{region}/backupVaults/{backupvault}/dataSources/{datasource}.
2234
+
2235
+ This field is a member of `oneof`_ ``_datasource``.
2236
+ point_in_time (google.protobuf.timestamp_pb2.Timestamp):
2237
+ Required. The date and time to which you want
2238
+ to restore the instance.
2239
+ target_instance (str):
2240
+ Target instance name.
2241
+
2242
+ This field is a member of `oneof`_ ``_target_instance``.
2243
+ private_network (str):
2244
+ Optional. The resource link for the VPC network from which
2245
+ the Cloud SQL instance is accessible for private IP. For
2246
+ example, ``/projects/myProject/global/networks/default``.
2247
+
2248
+ This field is a member of `oneof`_ ``_private_network``.
2249
+ allocated_ip_range (str):
2250
+ Optional. The name of the allocated IP range for the
2251
+ internal IP Cloud SQL instance. For example:
2252
+ "google-managed-services-default". If you set this, then
2253
+ Cloud SQL creates the IP address for the cloned instance in
2254
+ the allocated range. This range must comply with `RFC
2255
+ 1035 <https://tools.ietf.org/html/rfc1035>`__ standards.
2256
+ Specifically, the name must be 1-63 characters long and
2257
+ match the regular expression `a-z <[-a-z0-9]*[a-z0-9]>`__?.
2258
+ Reserved for future use.
2259
+
2260
+ This field is a member of `oneof`_ ``_allocated_ip_range``.
2261
+ preferred_zone (str):
2262
+ Optional. Point-in-time recovery of an
2263
+ instance to the specified zone. If no zone is
2264
+ specified, then clone to the same primary zone
2265
+ as the source instance.
2266
+
2267
+ This field is a member of `oneof`_ ``_preferred_zone``.
2268
+ preferred_secondary_zone (str):
2269
+ Optional. Point-in-time recovery of a regional instance in
2270
+ the specified zones. If not specified, clone to the same
2271
+ secondary zone as the source instance. This value cannot be
2272
+ the same as the preferred_zone field.
2273
+
2274
+ This field is a member of `oneof`_ ``_preferred_secondary_zone``.
2275
+ target_instance_settings (google.cloud.sqladmin_v1.types.DatabaseInstance):
2276
+ Optional. Specifies the instance settings
2277
+ that will be overridden from the source
2278
+ instance. This field is only applicable for
2279
+ cross project PITRs.
2280
+ target_instance_clear_settings_field_names (MutableSequence[str]):
2281
+ Optional. Specifies the instance settings
2282
+ that will be cleared from the source instance.
2283
+ This field is only applicable for cross project
2284
+ PITRs.
2285
+ region (str):
2286
+ Optional. The region of the target instance
2287
+ where the datasource will be restored. For
2288
+ example: "us-central1".
2289
+
2290
+ This field is a member of `oneof`_ ``_region``.
2291
+ """
2292
+
2293
+ datasource: str = proto.Field(
2294
+ proto.STRING,
2295
+ number=1,
2296
+ optional=True,
2297
+ )
2298
+ point_in_time: timestamp_pb2.Timestamp = proto.Field(
2299
+ proto.MESSAGE,
2300
+ number=2,
2301
+ message=timestamp_pb2.Timestamp,
2302
+ )
2303
+ target_instance: str = proto.Field(
2304
+ proto.STRING,
2305
+ number=3,
2306
+ optional=True,
2307
+ )
2308
+ private_network: str = proto.Field(
2309
+ proto.STRING,
2310
+ number=4,
2311
+ optional=True,
2312
+ )
2313
+ allocated_ip_range: str = proto.Field(
2314
+ proto.STRING,
2315
+ number=5,
2316
+ optional=True,
2317
+ )
2318
+ preferred_zone: str = proto.Field(
2319
+ proto.STRING,
2320
+ number=6,
2321
+ optional=True,
2322
+ )
2323
+ preferred_secondary_zone: str = proto.Field(
2324
+ proto.STRING,
2325
+ number=9,
2326
+ optional=True,
2327
+ )
2328
+ target_instance_settings: "DatabaseInstance" = proto.Field(
2329
+ proto.MESSAGE,
2330
+ number=11,
2331
+ message="DatabaseInstance",
2332
+ )
2333
+ target_instance_clear_settings_field_names: MutableSequence[str] = (
2334
+ proto.RepeatedField(
2335
+ proto.STRING,
2336
+ number=12,
2337
+ )
2338
+ )
2339
+ region: str = proto.Field(
2340
+ proto.STRING,
2341
+ number=13,
2342
+ optional=True,
2343
+ )
2344
+
2345
+
2346
+ class BinLogCoordinates(proto.Message):
2347
+ r"""Binary log coordinates.
2348
+
2349
+ Attributes:
2350
+ bin_log_file_name (str):
2351
+ Name of the binary log file for a Cloud SQL
2352
+ instance.
2353
+ bin_log_position (int):
2354
+ Position (offset) within the binary log file.
2355
+ kind (str):
2356
+ This is always ``sql#binLogCoordinates``.
2357
+ """
2358
+
2359
+ bin_log_file_name: str = proto.Field(
2360
+ proto.STRING,
2361
+ number=1,
2362
+ )
2363
+ bin_log_position: int = proto.Field(
2364
+ proto.INT64,
2365
+ number=2,
2366
+ )
2367
+ kind: str = proto.Field(
2368
+ proto.STRING,
2369
+ number=3,
2370
+ )
2371
+
2372
+
2373
+ class DatabaseInstance(proto.Message):
2374
+ r"""A Cloud SQL instance resource.
2375
+
2376
+ .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
2377
+
2378
+ Attributes:
2379
+ kind (str):
2380
+ This is always ``sql#instance``.
2381
+ state (google.cloud.sqladmin_v1.types.DatabaseInstance.SqlInstanceState):
2382
+ The current serving state of the Cloud SQL
2383
+ instance.
2384
+ database_version (google.cloud.sqladmin_v1.types.SqlDatabaseVersion):
2385
+ The database engine type and version. The
2386
+ ``databaseVersion`` field cannot be changed after instance
2387
+ creation.
2388
+ settings (google.cloud.sqladmin_v1.types.Settings):
2389
+ The user settings.
2390
+ etag (str):
2391
+ This field is deprecated and will be removed from a future
2392
+ version of the API. Use the ``settings.settingsVersion``
2393
+ field instead.
2394
+ failover_replica (google.cloud.sqladmin_v1.types.DatabaseInstance.SqlFailoverReplica):
2395
+ The name and status of the failover replica.
2396
+ master_instance_name (str):
2397
+ The name of the instance which will act as
2398
+ primary in the replication setup.
2399
+ replica_names (MutableSequence[str]):
2400
+ The replicas of the instance.
2401
+ max_disk_size (google.protobuf.wrappers_pb2.Int64Value):
2402
+ The maximum disk size of the instance in
2403
+ bytes.
2404
+ current_disk_size (google.protobuf.wrappers_pb2.Int64Value):
2405
+ The current disk usage of the instance in bytes. This
2406
+ property has been deprecated. Use the
2407
+ "cloudsql.googleapis.com/database/disk/bytes_used" metric in
2408
+ Cloud Monitoring API instead. Please see `this
2409
+ announcement <https://groups.google.com/d/msg/google-cloud-sql-announce/I_7-F9EBhT0/BtvFtdFeAgAJ>`__
2410
+ for details.
2411
+ ip_addresses (MutableSequence[google.cloud.sqladmin_v1.types.IpMapping]):
2412
+ The assigned IP addresses for the instance.
2413
+ server_ca_cert (google.cloud.sqladmin_v1.types.SslCert):
2414
+ SSL configuration.
2415
+ instance_type (google.cloud.sqladmin_v1.types.SqlInstanceType):
2416
+ The instance type.
2417
+ project (str):
2418
+ The project ID of the project containing the
2419
+ Cloud SQL instance. The Google apps domain is
2420
+ prefixed if applicable.
2421
+ ipv6_address (str):
2422
+ The IPv6 address assigned to the instance.
2423
+ (Deprecated) This property was applicable only
2424
+ to First Generation instances.
2425
+ service_account_email_address (str):
2426
+ The service account email address assigned to
2427
+ the instance.\This property is read-only.
2428
+ on_premises_configuration (google.cloud.sqladmin_v1.types.OnPremisesConfiguration):
2429
+ Configuration specific to on-premises
2430
+ instances.
2431
+ replica_configuration (google.cloud.sqladmin_v1.types.ReplicaConfiguration):
2432
+ Configuration specific to failover replicas
2433
+ and read replicas.
2434
+ backend_type (google.cloud.sqladmin_v1.types.SqlBackendType):
2435
+ The backend type. ``SECOND_GEN``: Cloud SQL database
2436
+ instance. ``EXTERNAL``: A database server that is not
2437
+ managed by Google.
2438
+
2439
+ This property is read-only; use the ``tier`` property in the
2440
+ ``settings`` object to determine the database type.
2441
+ self_link (str):
2442
+ The URI of this resource.
2443
+ suspension_reason (MutableSequence[google.cloud.sqladmin_v1.types.SqlSuspensionReason]):
2444
+ If the instance state is SUSPENDED, the
2445
+ reason for the suspension.
2446
+ connection_name (str):
2447
+ Connection name of the Cloud SQL instance
2448
+ used in connection strings.
2449
+ name (str):
2450
+ Name of the Cloud SQL instance. This does not
2451
+ include the project ID.
2452
+ region (str):
2453
+ The geographical region of the Cloud SQL instance.
2454
+
2455
+ It can be one of the
2456
+ `regions <https://cloud.google.com/sql/docs/mysql/locations#location-r>`__
2457
+ where Cloud SQL operates:
2458
+
2459
+ For example, ``asia-east1``, ``europe-west1``, and
2460
+ ``us-central1``. The default value is ``us-central1``.
2461
+ gce_zone (str):
2462
+ The Compute Engine zone that the instance is
2463
+ currently serving from. This value could be
2464
+ different from the zone that was specified when
2465
+ the instance was created if the instance has
2466
+ failed over to its secondary zone. WARNING:
2467
+
2468
+ Changing this might restart the instance.
2469
+ secondary_gce_zone (str):
2470
+ The Compute Engine zone that the failover
2471
+ instance is currently serving from for a
2472
+ regional instance. This value could be different
2473
+ from the zone that was specified when the
2474
+ instance was created if the instance has failed
2475
+ over to its secondary/failover zone.
2476
+ disk_encryption_configuration (google.cloud.sqladmin_v1.types.DiskEncryptionConfiguration):
2477
+ Disk encryption configuration specific to an
2478
+ instance.
2479
+ disk_encryption_status (google.cloud.sqladmin_v1.types.DiskEncryptionStatus):
2480
+ Disk encryption status specific to an
2481
+ instance.
2482
+ root_password (str):
2483
+ Initial root password. Use only on creation.
2484
+ You must set root passwords before you can
2485
+ connect to PostgreSQL instances.
2486
+ scheduled_maintenance (google.cloud.sqladmin_v1.types.DatabaseInstance.SqlScheduledMaintenance):
2487
+ The start time of any upcoming scheduled
2488
+ maintenance for this instance.
2489
+ satisfies_pzs (google.protobuf.wrappers_pb2.BoolValue):
2490
+ This status indicates whether the instance
2491
+ satisfies PZS.
2492
+ The status is reserved for future use.
2493
+ database_installed_version (str):
2494
+ Output only. Stores the current database version running on
2495
+ the instance including minor version such as
2496
+ ``MYSQL_8_0_18``.
2497
+ out_of_disk_report (google.cloud.sqladmin_v1.types.DatabaseInstance.SqlOutOfDiskReport):
2498
+ This field represents the report generated by the proactive
2499
+ database wellness job for OutOfDisk issues.
2500
+
2501
+ - Writers:
2502
+ - the proactive database wellness job for OOD.
2503
+ - Readers:
2504
+ - the proactive database wellness job
2505
+
2506
+ This field is a member of `oneof`_ ``_out_of_disk_report``.
2507
+ create_time (google.protobuf.timestamp_pb2.Timestamp):
2508
+ Output only. The time when the instance was created in `RFC
2509
+ 3339 <https://tools.ietf.org/html/rfc3339>`__ format, for
2510
+ example ``2012-11-15T16:19:00.094Z``.
2511
+ available_maintenance_versions (MutableSequence[str]):
2512
+ Output only. List all maintenance versions
2513
+ applicable on the instance
2514
+ maintenance_version (str):
2515
+ The current software version on the instance.
2516
+ upgradable_database_versions (MutableSequence[google.cloud.sqladmin_v1.types.AvailableDatabaseVersion]):
2517
+ Output only. All database versions that are
2518
+ available for upgrade.
2519
+ sql_network_architecture (google.cloud.sqladmin_v1.types.DatabaseInstance.SqlNetworkArchitecture):
2520
+
2521
+ This field is a member of `oneof`_ ``_sql_network_architecture``.
2522
+ psc_service_attachment_link (str):
2523
+ Output only. The link to service attachment
2524
+ of PSC instance.
2525
+
2526
+ This field is a member of `oneof`_ ``_psc_service_attachment_link``.
2527
+ dns_name (str):
2528
+ Output only. The dns name of the instance.
2529
+
2530
+ This field is a member of `oneof`_ ``_dns_name``.
2531
+ primary_dns_name (str):
2532
+ Output only. DEPRECATED: please use write_endpoint instead.
2533
+
2534
+ This field is a member of `oneof`_ ``_primary_dns_name``.
2535
+ write_endpoint (str):
2536
+ Output only. The dns name of the primary
2537
+ instance in a replication group.
2538
+
2539
+ This field is a member of `oneof`_ ``_write_endpoint``.
2540
+ replication_cluster (google.cloud.sqladmin_v1.types.ReplicationCluster):
2541
+ Optional. A primary instance and disaster
2542
+ recovery (DR) replica pair. A DR replica is a
2543
+ cross-region replica that you designate for
2544
+ failover in the event that the primary instance
2545
+ experiences regional failure.
2546
+ Applicable to MySQL and PostgreSQL.
2547
+ gemini_config (google.cloud.sqladmin_v1.types.GeminiInstanceConfig):
2548
+ Gemini instance configuration.
2549
+
2550
+ This field is a member of `oneof`_ ``_gemini_config``.
2551
+ satisfies_pzi (google.protobuf.wrappers_pb2.BoolValue):
2552
+ Output only. This status indicates whether
2553
+ the instance satisfies PZI.
2554
+ The status is reserved for future use.
2555
+ switch_transaction_logs_to_cloud_storage_enabled (google.protobuf.wrappers_pb2.BoolValue):
2556
+ Input only. Whether Cloud SQL is enabled to
2557
+ switch storing point-in-time recovery log files
2558
+ from a data disk to Cloud Storage.
2559
+
2560
+ This field is a member of `oneof`_ ``_switch_transaction_logs_to_cloud_storage_enabled``.
2561
+ include_replicas_for_major_version_upgrade (google.protobuf.wrappers_pb2.BoolValue):
2562
+ Input only. Determines whether an in-place
2563
+ major version upgrade of replicas happens when
2564
+ an in-place major version upgrade of a primary
2565
+ instance is initiated.
2566
+
2567
+ This field is a member of `oneof`_ ``_include_replicas_for_major_version_upgrade``.
2568
+ tags (MutableMapping[str, str]):
2569
+ Optional. Input only. Immutable. Tag keys and tag values
2570
+ that are bound to this instance. You must represent each
2571
+ item in the map as:
2572
+ ``"<tag-key-namespaced-name>" : "<tag-value-short-name>"``.
2573
+
2574
+ For example, a single resource can have the following tags:
2575
+
2576
+ ::
2577
+
2578
+ "123/environment": "production",
2579
+ "123/costCenter": "marketing",
2580
+
2581
+ For more information on tag creation and management, see
2582
+ https://cloud.google.com/resource-manager/docs/tags/tags-overview.
2583
+ node_count (int):
2584
+ The number of read pool nodes in a read pool.
2585
+
2586
+ This field is a member of `oneof`_ ``_node_count``.
2587
+ nodes (MutableSequence[google.cloud.sqladmin_v1.types.DatabaseInstance.PoolNodeConfig]):
2588
+ Output only. Entries containing information
2589
+ about each read pool node of the read pool.
2590
+ dns_names (MutableSequence[google.cloud.sqladmin_v1.types.DnsNameMapping]):
2591
+ Output only. The list of DNS names used by
2592
+ this instance.
2593
+ database_center_integration_enabled (google.protobuf.wrappers_pb2.BoolValue):
2594
+ Optional. If true, instance metadata is sent
2595
+ to the Database Center. If false, instance
2596
+ metadata is not sent to the Database Center.
2597
+ """
2598
+
2599
+ class SqlInstanceState(proto.Enum):
2600
+ r"""The current serving state of the database instance.
2601
+
2602
+ Values:
2603
+ SQL_INSTANCE_STATE_UNSPECIFIED (0):
2604
+ The state of the instance is unknown.
2605
+ RUNNABLE (1):
2606
+ The instance is running, or has been stopped
2607
+ by owner.
2608
+ SUSPENDED (2):
2609
+ The instance is not available, for example
2610
+ due to problems with billing.
2611
+ PENDING_DELETE (3):
2612
+ The instance is being deleted.
2613
+ PENDING_CREATE (4):
2614
+ The instance is being created.
2615
+ MAINTENANCE (5):
2616
+ The instance is down for maintenance.
2617
+ FAILED (6):
2618
+ The creation of the instance failed or a
2619
+ fatal error occurred during maintenance.
2620
+ ONLINE_MAINTENANCE (7):
2621
+ Deprecated
2622
+ REPAIRING (8):
2623
+ (Applicable to read pool nodes only.) The
2624
+ read pool node needs to be repaired. The
2625
+ database might be unavailable.
2626
+ """
2627
+
2628
+ SQL_INSTANCE_STATE_UNSPECIFIED = 0
2629
+ RUNNABLE = 1
2630
+ SUSPENDED = 2
2631
+ PENDING_DELETE = 3
2632
+ PENDING_CREATE = 4
2633
+ MAINTENANCE = 5
2634
+ FAILED = 6
2635
+ ONLINE_MAINTENANCE = 7
2636
+ REPAIRING = 8
2637
+
2638
+ class SqlNetworkArchitecture(proto.Enum):
2639
+ r"""The SQL network architecture for the instance.
2640
+
2641
+ Values:
2642
+ SQL_NETWORK_ARCHITECTURE_UNSPECIFIED (0):
2643
+ No description available.
2644
+ NEW_NETWORK_ARCHITECTURE (1):
2645
+ The instance uses the new network
2646
+ architecture.
2647
+ OLD_NETWORK_ARCHITECTURE (2):
2648
+ The instance uses the old network
2649
+ architecture.
2650
+ """
2651
+
2652
+ SQL_NETWORK_ARCHITECTURE_UNSPECIFIED = 0
2653
+ NEW_NETWORK_ARCHITECTURE = 1
2654
+ OLD_NETWORK_ARCHITECTURE = 2
2655
+
2656
+ class SqlFailoverReplica(proto.Message):
2657
+ r"""
2658
+
2659
+ Attributes:
2660
+ name (str):
2661
+ The name of the failover replica. If
2662
+ specified at instance creation, a failover
2663
+ replica is created for the instance. The name
2664
+ doesn't include the project ID.
2665
+ available (google.protobuf.wrappers_pb2.BoolValue):
2666
+ The availability status of the failover
2667
+ replica. A false status indicates that the
2668
+ failover replica is out of sync. The primary
2669
+ instance can only failover to the failover
2670
+ replica when the status is true.
2671
+ """
2672
+
2673
+ name: str = proto.Field(
2674
+ proto.STRING,
2675
+ number=1,
2676
+ )
2677
+ available: wrappers_pb2.BoolValue = proto.Field(
2678
+ proto.MESSAGE,
2679
+ number=2,
2680
+ message=wrappers_pb2.BoolValue,
2681
+ )
2682
+
2683
+ class SqlScheduledMaintenance(proto.Message):
2684
+ r"""Any scheduled maintenance for this instance.
2685
+
2686
+ .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
2687
+
2688
+ Attributes:
2689
+ start_time (google.protobuf.timestamp_pb2.Timestamp):
2690
+ The start time of any upcoming scheduled
2691
+ maintenance for this instance.
2692
+ can_defer (bool):
2693
+
2694
+ can_reschedule (bool):
2695
+ If the scheduled maintenance can be
2696
+ rescheduled.
2697
+ schedule_deadline_time (google.protobuf.timestamp_pb2.Timestamp):
2698
+ Maintenance cannot be rescheduled to start
2699
+ beyond this deadline.
2700
+
2701
+ This field is a member of `oneof`_ ``_schedule_deadline_time``.
2702
+ """
2703
+
2704
+ start_time: timestamp_pb2.Timestamp = proto.Field(
2705
+ proto.MESSAGE,
2706
+ number=1,
2707
+ message=timestamp_pb2.Timestamp,
2708
+ )
2709
+ can_defer: bool = proto.Field(
2710
+ proto.BOOL,
2711
+ number=2,
2712
+ )
2713
+ can_reschedule: bool = proto.Field(
2714
+ proto.BOOL,
2715
+ number=3,
2716
+ )
2717
+ schedule_deadline_time: timestamp_pb2.Timestamp = proto.Field(
2718
+ proto.MESSAGE,
2719
+ number=4,
2720
+ optional=True,
2721
+ message=timestamp_pb2.Timestamp,
2722
+ )
2723
+
2724
+ class SqlOutOfDiskReport(proto.Message):
2725
+ r"""This message wraps up the information written by out-of-disk
2726
+ detection job.
2727
+
2728
+
2729
+ .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
2730
+
2731
+ Attributes:
2732
+ sql_out_of_disk_state (google.cloud.sqladmin_v1.types.DatabaseInstance.SqlOutOfDiskReport.SqlOutOfDiskState):
2733
+ This field represents the state generated by the proactive
2734
+ database wellness job for OutOfDisk issues.
2735
+
2736
+ - Writers:
2737
+ - the proactive database wellness job for OOD.
2738
+ - Readers:
2739
+ - the proactive database wellness job
2740
+
2741
+ This field is a member of `oneof`_ ``_sql_out_of_disk_state``.
2742
+ sql_min_recommended_increase_size_gb (int):
2743
+ The minimum recommended increase size in GigaBytes This
2744
+ field is consumed by the frontend
2745
+
2746
+ - Writers:
2747
+ - the proactive database wellness job for OOD.
2748
+ - Readers:
2749
+
2750
+ This field is a member of `oneof`_ ``_sql_min_recommended_increase_size_gb``.
2751
+ """
2752
+
2753
+ class SqlOutOfDiskState(proto.Enum):
2754
+ r"""This enum lists all possible states regarding out-of-disk
2755
+ issues.
2756
+
2757
+ Values:
2758
+ SQL_OUT_OF_DISK_STATE_UNSPECIFIED (0):
2759
+ Unspecified state
2760
+ NORMAL (1):
2761
+ The instance has plenty space on data disk
2762
+ SOFT_SHUTDOWN (2):
2763
+ Data disk is almost used up. It is shutdown
2764
+ to prevent data corruption.
2765
+ """
2766
+
2767
+ SQL_OUT_OF_DISK_STATE_UNSPECIFIED = 0
2768
+ NORMAL = 1
2769
+ SOFT_SHUTDOWN = 2
2770
+
2771
+ sql_out_of_disk_state: "DatabaseInstance.SqlOutOfDiskReport.SqlOutOfDiskState" = proto.Field(
2772
+ proto.ENUM,
2773
+ number=1,
2774
+ optional=True,
2775
+ enum="DatabaseInstance.SqlOutOfDiskReport.SqlOutOfDiskState",
2776
+ )
2777
+ sql_min_recommended_increase_size_gb: int = proto.Field(
2778
+ proto.INT32,
2779
+ number=2,
2780
+ optional=True,
2781
+ )
2782
+
2783
+ class PoolNodeConfig(proto.Message):
2784
+ r"""Details of a single read pool node of a read pool.
2785
+
2786
+ .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
2787
+
2788
+ Attributes:
2789
+ name (str):
2790
+ Output only. The name of the read pool node,
2791
+ to be used for retrieving metrics and logs.
2792
+
2793
+ This field is a member of `oneof`_ ``_name``.
2794
+ gce_zone (str):
2795
+ Output only. The zone of the read pool node.
2796
+
2797
+ This field is a member of `oneof`_ ``_gce_zone``.
2798
+ ip_addresses (MutableSequence[google.cloud.sqladmin_v1.types.IpMapping]):
2799
+ Output only. Mappings containing IP addresses
2800
+ that can be used to connect to the read pool
2801
+ node.
2802
+ dns_name (str):
2803
+ Output only. The DNS name of the read pool
2804
+ node.
2805
+
2806
+ This field is a member of `oneof`_ ``_dns_name``.
2807
+ state (google.cloud.sqladmin_v1.types.DatabaseInstance.SqlInstanceState):
2808
+ Output only. The current state of the read
2809
+ pool node.
2810
+
2811
+ This field is a member of `oneof`_ ``_state``.
2812
+ dns_names (MutableSequence[google.cloud.sqladmin_v1.types.DnsNameMapping]):
2813
+ Output only. The list of DNS names used by
2814
+ this read pool node.
2815
+ psc_service_attachment_link (str):
2816
+ Output only. The Private Service Connect
2817
+ (PSC) service attachment of the read pool node.
2818
+
2819
+ This field is a member of `oneof`_ ``_psc_service_attachment_link``.
2820
+ psc_auto_connections (MutableSequence[google.cloud.sqladmin_v1.types.PscAutoConnectionConfig]):
2821
+ Output only. The list of settings for
2822
+ requested automatically-setup Private Service
2823
+ Connect (PSC) consumer endpoints that can be
2824
+ used to connect to this read pool node.
2825
+ """
2826
+
2827
+ name: str = proto.Field(
2828
+ proto.STRING,
2829
+ number=1,
2830
+ optional=True,
2831
+ )
2832
+ gce_zone: str = proto.Field(
2833
+ proto.STRING,
2834
+ number=2,
2835
+ optional=True,
2836
+ )
2837
+ ip_addresses: MutableSequence[cloud_sql_resources.IpMapping] = (
2838
+ proto.RepeatedField(
2839
+ proto.MESSAGE,
2840
+ number=3,
2841
+ message=cloud_sql_resources.IpMapping,
2842
+ )
2843
+ )
2844
+ dns_name: str = proto.Field(
2845
+ proto.STRING,
2846
+ number=4,
2847
+ optional=True,
2848
+ )
2849
+ state: "DatabaseInstance.SqlInstanceState" = proto.Field(
2850
+ proto.ENUM,
2851
+ number=5,
2852
+ optional=True,
2853
+ enum="DatabaseInstance.SqlInstanceState",
2854
+ )
2855
+ dns_names: MutableSequence[cloud_sql_resources.DnsNameMapping] = (
2856
+ proto.RepeatedField(
2857
+ proto.MESSAGE,
2858
+ number=6,
2859
+ message=cloud_sql_resources.DnsNameMapping,
2860
+ )
2861
+ )
2862
+ psc_service_attachment_link: str = proto.Field(
2863
+ proto.STRING,
2864
+ number=7,
2865
+ optional=True,
2866
+ )
2867
+ psc_auto_connections: MutableSequence[
2868
+ cloud_sql_resources.PscAutoConnectionConfig
2869
+ ] = proto.RepeatedField(
2870
+ proto.MESSAGE,
2871
+ number=8,
2872
+ message=cloud_sql_resources.PscAutoConnectionConfig,
2873
+ )
2874
+
2875
+ kind: str = proto.Field(
2876
+ proto.STRING,
2877
+ number=1,
2878
+ )
2879
+ state: SqlInstanceState = proto.Field(
2880
+ proto.ENUM,
2881
+ number=2,
2882
+ enum=SqlInstanceState,
2883
+ )
2884
+ database_version: cloud_sql_resources.SqlDatabaseVersion = proto.Field(
2885
+ proto.ENUM,
2886
+ number=3,
2887
+ enum=cloud_sql_resources.SqlDatabaseVersion,
2888
+ )
2889
+ settings: cloud_sql_resources.Settings = proto.Field(
2890
+ proto.MESSAGE,
2891
+ number=4,
2892
+ message=cloud_sql_resources.Settings,
2893
+ )
2894
+ etag: str = proto.Field(
2895
+ proto.STRING,
2896
+ number=5,
2897
+ )
2898
+ failover_replica: SqlFailoverReplica = proto.Field(
2899
+ proto.MESSAGE,
2900
+ number=6,
2901
+ message=SqlFailoverReplica,
2902
+ )
2903
+ master_instance_name: str = proto.Field(
2904
+ proto.STRING,
2905
+ number=7,
2906
+ )
2907
+ replica_names: MutableSequence[str] = proto.RepeatedField(
2908
+ proto.STRING,
2909
+ number=8,
2910
+ )
2911
+ max_disk_size: wrappers_pb2.Int64Value = proto.Field(
2912
+ proto.MESSAGE,
2913
+ number=9,
2914
+ message=wrappers_pb2.Int64Value,
2915
+ )
2916
+ current_disk_size: wrappers_pb2.Int64Value = proto.Field(
2917
+ proto.MESSAGE,
2918
+ number=10,
2919
+ message=wrappers_pb2.Int64Value,
2920
+ )
2921
+ ip_addresses: MutableSequence[cloud_sql_resources.IpMapping] = proto.RepeatedField(
2922
+ proto.MESSAGE,
2923
+ number=11,
2924
+ message=cloud_sql_resources.IpMapping,
2925
+ )
2926
+ server_ca_cert: cloud_sql_resources.SslCert = proto.Field(
2927
+ proto.MESSAGE,
2928
+ number=12,
2929
+ message=cloud_sql_resources.SslCert,
2930
+ )
2931
+ instance_type: "SqlInstanceType" = proto.Field(
2932
+ proto.ENUM,
2933
+ number=13,
2934
+ enum="SqlInstanceType",
2935
+ )
2936
+ project: str = proto.Field(
2937
+ proto.STRING,
2938
+ number=14,
2939
+ )
2940
+ ipv6_address: str = proto.Field(
2941
+ proto.STRING,
2942
+ number=15,
2943
+ )
2944
+ service_account_email_address: str = proto.Field(
2945
+ proto.STRING,
2946
+ number=16,
2947
+ )
2948
+ on_premises_configuration: "OnPremisesConfiguration" = proto.Field(
2949
+ proto.MESSAGE,
2950
+ number=17,
2951
+ message="OnPremisesConfiguration",
2952
+ )
2953
+ replica_configuration: "ReplicaConfiguration" = proto.Field(
2954
+ proto.MESSAGE,
2955
+ number=18,
2956
+ message="ReplicaConfiguration",
2957
+ )
2958
+ backend_type: cloud_sql_resources.SqlBackendType = proto.Field(
2959
+ proto.ENUM,
2960
+ number=19,
2961
+ enum=cloud_sql_resources.SqlBackendType,
2962
+ )
2963
+ self_link: str = proto.Field(
2964
+ proto.STRING,
2965
+ number=20,
2966
+ )
2967
+ suspension_reason: MutableSequence["SqlSuspensionReason"] = proto.RepeatedField(
2968
+ proto.ENUM,
2969
+ number=21,
2970
+ enum="SqlSuspensionReason",
2971
+ )
2972
+ connection_name: str = proto.Field(
2973
+ proto.STRING,
2974
+ number=22,
2975
+ )
2976
+ name: str = proto.Field(
2977
+ proto.STRING,
2978
+ number=23,
2979
+ )
2980
+ region: str = proto.Field(
2981
+ proto.STRING,
2982
+ number=24,
2983
+ )
2984
+ gce_zone: str = proto.Field(
2985
+ proto.STRING,
2986
+ number=25,
2987
+ )
2988
+ secondary_gce_zone: str = proto.Field(
2989
+ proto.STRING,
2990
+ number=34,
2991
+ )
2992
+ disk_encryption_configuration: cloud_sql_resources.DiskEncryptionConfiguration = (
2993
+ proto.Field(
2994
+ proto.MESSAGE,
2995
+ number=26,
2996
+ message=cloud_sql_resources.DiskEncryptionConfiguration,
2997
+ )
2998
+ )
2999
+ disk_encryption_status: cloud_sql_resources.DiskEncryptionStatus = proto.Field(
3000
+ proto.MESSAGE,
3001
+ number=27,
3002
+ message=cloud_sql_resources.DiskEncryptionStatus,
3003
+ )
3004
+ root_password: str = proto.Field(
3005
+ proto.STRING,
3006
+ number=29,
3007
+ )
3008
+ scheduled_maintenance: SqlScheduledMaintenance = proto.Field(
3009
+ proto.MESSAGE,
3010
+ number=30,
3011
+ message=SqlScheduledMaintenance,
3012
+ )
3013
+ satisfies_pzs: wrappers_pb2.BoolValue = proto.Field(
3014
+ proto.MESSAGE,
3015
+ number=35,
3016
+ message=wrappers_pb2.BoolValue,
3017
+ )
3018
+ database_installed_version: str = proto.Field(
3019
+ proto.STRING,
3020
+ number=40,
3021
+ )
3022
+ out_of_disk_report: SqlOutOfDiskReport = proto.Field(
3023
+ proto.MESSAGE,
3024
+ number=38,
3025
+ optional=True,
3026
+ message=SqlOutOfDiskReport,
3027
+ )
3028
+ create_time: timestamp_pb2.Timestamp = proto.Field(
3029
+ proto.MESSAGE,
3030
+ number=39,
3031
+ message=timestamp_pb2.Timestamp,
3032
+ )
3033
+ available_maintenance_versions: MutableSequence[str] = proto.RepeatedField(
3034
+ proto.STRING,
3035
+ number=41,
3036
+ )
3037
+ maintenance_version: str = proto.Field(
3038
+ proto.STRING,
3039
+ number=42,
3040
+ )
3041
+ upgradable_database_versions: MutableSequence["AvailableDatabaseVersion"] = (
3042
+ proto.RepeatedField(
3043
+ proto.MESSAGE,
3044
+ number=45,
3045
+ message="AvailableDatabaseVersion",
3046
+ )
3047
+ )
3048
+ sql_network_architecture: SqlNetworkArchitecture = proto.Field(
3049
+ proto.ENUM,
3050
+ number=47,
3051
+ optional=True,
3052
+ enum=SqlNetworkArchitecture,
3053
+ )
3054
+ psc_service_attachment_link: str = proto.Field(
3055
+ proto.STRING,
3056
+ number=48,
3057
+ optional=True,
3058
+ )
3059
+ dns_name: str = proto.Field(
3060
+ proto.STRING,
3061
+ number=49,
3062
+ optional=True,
3063
+ )
3064
+ primary_dns_name: str = proto.Field(
3065
+ proto.STRING,
3066
+ number=51,
3067
+ optional=True,
3068
+ )
3069
+ write_endpoint: str = proto.Field(
3070
+ proto.STRING,
3071
+ number=52,
3072
+ optional=True,
3073
+ )
3074
+ replication_cluster: "ReplicationCluster" = proto.Field(
3075
+ proto.MESSAGE,
3076
+ number=54,
3077
+ message="ReplicationCluster",
3078
+ )
3079
+ gemini_config: "GeminiInstanceConfig" = proto.Field(
3080
+ proto.MESSAGE,
3081
+ number=55,
3082
+ optional=True,
3083
+ message="GeminiInstanceConfig",
3084
+ )
3085
+ satisfies_pzi: wrappers_pb2.BoolValue = proto.Field(
3086
+ proto.MESSAGE,
3087
+ number=56,
3088
+ message=wrappers_pb2.BoolValue,
3089
+ )
3090
+ switch_transaction_logs_to_cloud_storage_enabled: wrappers_pb2.BoolValue = (
3091
+ proto.Field(
3092
+ proto.MESSAGE,
3093
+ number=57,
3094
+ optional=True,
3095
+ message=wrappers_pb2.BoolValue,
3096
+ )
3097
+ )
3098
+ include_replicas_for_major_version_upgrade: wrappers_pb2.BoolValue = proto.Field(
3099
+ proto.MESSAGE,
3100
+ number=59,
3101
+ optional=True,
3102
+ message=wrappers_pb2.BoolValue,
3103
+ )
3104
+ tags: MutableMapping[str, str] = proto.MapField(
3105
+ proto.STRING,
3106
+ proto.STRING,
3107
+ number=60,
3108
+ )
3109
+ node_count: int = proto.Field(
3110
+ proto.INT32,
3111
+ number=63,
3112
+ optional=True,
3113
+ )
3114
+ nodes: MutableSequence[PoolNodeConfig] = proto.RepeatedField(
3115
+ proto.MESSAGE,
3116
+ number=64,
3117
+ message=PoolNodeConfig,
3118
+ )
3119
+ dns_names: MutableSequence[cloud_sql_resources.DnsNameMapping] = (
3120
+ proto.RepeatedField(
3121
+ proto.MESSAGE,
3122
+ number=67,
3123
+ message=cloud_sql_resources.DnsNameMapping,
3124
+ )
3125
+ )
3126
+ database_center_integration_enabled: wrappers_pb2.BoolValue = proto.Field(
3127
+ proto.MESSAGE,
3128
+ number=72,
3129
+ message=wrappers_pb2.BoolValue,
3130
+ )
3131
+
3132
+
3133
+ class GeminiInstanceConfig(proto.Message):
3134
+ r"""Gemini instance configuration.
3135
+
3136
+ .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
3137
+
3138
+ Attributes:
3139
+ entitled (bool):
3140
+ Output only. Whether Gemini is enabled.
3141
+
3142
+ This field is a member of `oneof`_ ``_entitled``.
3143
+ google_vacuum_mgmt_enabled (bool):
3144
+ Output only. Whether the vacuum management is
3145
+ enabled.
3146
+
3147
+ This field is a member of `oneof`_ ``_google_vacuum_mgmt_enabled``.
3148
+ oom_session_cancel_enabled (bool):
3149
+ Output only. Whether canceling the
3150
+ out-of-memory (OOM) session is enabled.
3151
+
3152
+ This field is a member of `oneof`_ ``_oom_session_cancel_enabled``.
3153
+ active_query_enabled (bool):
3154
+ Output only. Whether the active query is
3155
+ enabled.
3156
+
3157
+ This field is a member of `oneof`_ ``_active_query_enabled``.
3158
+ index_advisor_enabled (bool):
3159
+ Output only. Whether the index advisor is
3160
+ enabled.
3161
+
3162
+ This field is a member of `oneof`_ ``_index_advisor_enabled``.
3163
+ flag_recommender_enabled (bool):
3164
+ Output only. Whether the flag recommender is
3165
+ enabled.
3166
+
3167
+ This field is a member of `oneof`_ ``_flag_recommender_enabled``.
3168
+ """
3169
+
3170
+ entitled: bool = proto.Field(
3171
+ proto.BOOL,
3172
+ number=1,
3173
+ optional=True,
3174
+ )
3175
+ google_vacuum_mgmt_enabled: bool = proto.Field(
3176
+ proto.BOOL,
3177
+ number=2,
3178
+ optional=True,
3179
+ )
3180
+ oom_session_cancel_enabled: bool = proto.Field(
3181
+ proto.BOOL,
3182
+ number=3,
3183
+ optional=True,
3184
+ )
3185
+ active_query_enabled: bool = proto.Field(
3186
+ proto.BOOL,
3187
+ number=4,
3188
+ optional=True,
3189
+ )
3190
+ index_advisor_enabled: bool = proto.Field(
3191
+ proto.BOOL,
3192
+ number=5,
3193
+ optional=True,
3194
+ )
3195
+ flag_recommender_enabled: bool = proto.Field(
3196
+ proto.BOOL,
3197
+ number=6,
3198
+ optional=True,
3199
+ )
3200
+
3201
+
3202
+ class ReplicationCluster(proto.Message):
3203
+ r"""A primary instance and disaster recovery (DR) replica pair.
3204
+ A DR replica is a cross-region replica that you designate for
3205
+ failover in the event that the primary instance experiences
3206
+ regional failure. Applicable to MySQL and PostgreSQL.
3207
+
3208
+ Attributes:
3209
+ psa_write_endpoint (str):
3210
+ Output only. If set, this field indicates
3211
+ this instance has a private service access (PSA)
3212
+ DNS endpoint that is pointing to the primary
3213
+ instance of the cluster. If this instance is the
3214
+ primary, then the DNS endpoint points to this
3215
+ instance. After a switchover or replica failover
3216
+ operation, this DNS endpoint points to the
3217
+ promoted instance. This is a read-only field,
3218
+ returned to the user as information. This field
3219
+ can exist even if a standalone instance doesn't
3220
+ have a DR replica yet or the DR replica is
3221
+ deleted.
3222
+ failover_dr_replica_name (str):
3223
+ Optional. If the instance is a primary
3224
+ instance, then this field identifies the
3225
+ disaster recovery (DR) replica. A DR replica is
3226
+ an optional configuration for Enterprise Plus
3227
+ edition instances. If the instance is a read
3228
+ replica, then the field is not set. Set this
3229
+ field to a replica name to designate a DR
3230
+ replica for a primary instance. Remove the
3231
+ replica name to remove the DR replica
3232
+ designation.
3233
+ dr_replica (bool):
3234
+ Output only. Read-only field that indicates
3235
+ whether the replica is a DR replica. This field
3236
+ is not set if the instance is a primary
3237
+ instance.
3238
+ """
3239
+
3240
+ psa_write_endpoint: str = proto.Field(
3241
+ proto.STRING,
3242
+ number=1,
3243
+ )
3244
+ failover_dr_replica_name: str = proto.Field(
3245
+ proto.STRING,
3246
+ number=2,
3247
+ )
3248
+ dr_replica: bool = proto.Field(
3249
+ proto.BOOL,
3250
+ number=4,
3251
+ )
3252
+
3253
+
3254
+ class AvailableDatabaseVersion(proto.Message):
3255
+ r"""An available database version. It can be a major or a minor
3256
+ version.
3257
+
3258
+
3259
+ .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
3260
+
3261
+ Attributes:
3262
+ major_version (str):
3263
+ The version's major version name.
3264
+
3265
+ This field is a member of `oneof`_ ``_major_version``.
3266
+ name (str):
3267
+ The database version name. For MySQL 8.0,
3268
+ this string provides the database major and
3269
+ minor version.
3270
+
3271
+ This field is a member of `oneof`_ ``_name``.
3272
+ display_name (str):
3273
+ The database version's display name.
3274
+
3275
+ This field is a member of `oneof`_ ``_display_name``.
3276
+ """
3277
+
3278
+ major_version: str = proto.Field(
3279
+ proto.STRING,
3280
+ number=3,
3281
+ optional=True,
3282
+ )
3283
+ name: str = proto.Field(
3284
+ proto.STRING,
3285
+ number=8,
3286
+ optional=True,
3287
+ )
3288
+ display_name: str = proto.Field(
3289
+ proto.STRING,
3290
+ number=9,
3291
+ optional=True,
3292
+ )
3293
+
3294
+
3295
+ class SqlInstancesRescheduleMaintenanceRequestBody(proto.Message):
3296
+ r"""Reschedule options for maintenance windows.
3297
+
3298
+ Attributes:
3299
+ reschedule (google.cloud.sqladmin_v1.types.SqlInstancesRescheduleMaintenanceRequestBody.Reschedule):
3300
+ Required. The type of the reschedule the user
3301
+ wants.
3302
+ """
3303
+
3304
+ class RescheduleType(proto.Enum):
3305
+ r"""
3306
+
3307
+ Values:
3308
+ RESCHEDULE_TYPE_UNSPECIFIED (0):
3309
+ No description available.
3310
+ IMMEDIATE (1):
3311
+ Reschedules maintenance to happen now (within
3312
+ 5 minutes).
3313
+ NEXT_AVAILABLE_WINDOW (2):
3314
+ Reschedules maintenance to occur within one
3315
+ week from the originally scheduled day and time.
3316
+ SPECIFIC_TIME (3):
3317
+ Reschedules maintenance to a specific time
3318
+ and day.
3319
+ """
3320
+
3321
+ RESCHEDULE_TYPE_UNSPECIFIED = 0
3322
+ IMMEDIATE = 1
3323
+ NEXT_AVAILABLE_WINDOW = 2
3324
+ SPECIFIC_TIME = 3
3325
+
3326
+ class Reschedule(proto.Message):
3327
+ r"""
3328
+
3329
+ Attributes:
3330
+ reschedule_type (google.cloud.sqladmin_v1.types.SqlInstancesRescheduleMaintenanceRequestBody.RescheduleType):
3331
+ Required. The type of the reschedule.
3332
+ schedule_time (google.protobuf.timestamp_pb2.Timestamp):
3333
+ Optional. Timestamp when the maintenance shall be
3334
+ rescheduled to if reschedule_type=SPECIFIC_TIME, in `RFC
3335
+ 3339 <https://tools.ietf.org/html/rfc3339>`__ format, for
3336
+ example ``2012-11-15T16:19:00.094Z``.
3337
+ """
3338
+
3339
+ reschedule_type: "SqlInstancesRescheduleMaintenanceRequestBody.RescheduleType" = proto.Field(
3340
+ proto.ENUM,
3341
+ number=1,
3342
+ enum="SqlInstancesRescheduleMaintenanceRequestBody.RescheduleType",
3343
+ )
3344
+ schedule_time: timestamp_pb2.Timestamp = proto.Field(
3345
+ proto.MESSAGE,
3346
+ number=2,
3347
+ message=timestamp_pb2.Timestamp,
3348
+ )
3349
+
3350
+ reschedule: Reschedule = proto.Field(
3351
+ proto.MESSAGE,
3352
+ number=3,
3353
+ message=Reschedule,
3354
+ )
3355
+
3356
+
3357
+ class DemoteMasterContext(proto.Message):
3358
+ r"""Database instance demote primary instance context.
3359
+
3360
+ Attributes:
3361
+ kind (str):
3362
+ This is always ``sql#demoteMasterContext``.
3363
+ verify_gtid_consistency (google.protobuf.wrappers_pb2.BoolValue):
3364
+ Verify the GTID consistency for demote operation. Default
3365
+ value: ``True``. Setting this flag to ``false`` enables you
3366
+ to bypass the GTID consistency check between on-premises
3367
+ primary instance and Cloud SQL instance during the demotion
3368
+ operation but also exposes you to the risk of future
3369
+ replication failures. Change the value only if you know the
3370
+ reason for the GTID divergence and are confident that doing
3371
+ so will not cause any replication issues.
3372
+ master_instance_name (str):
3373
+ The name of the instance which will act as
3374
+ on-premises primary instance in the replication
3375
+ setup.
3376
+ replica_configuration (google.cloud.sqladmin_v1.types.DemoteMasterConfiguration):
3377
+ Configuration specific to read-replicas
3378
+ replicating from the on-premises primary
3379
+ instance.
3380
+ skip_replication_setup (bool):
3381
+ Flag to skip replication setup on the
3382
+ instance.
3383
+ """
3384
+
3385
+ kind: str = proto.Field(
3386
+ proto.STRING,
3387
+ number=1,
3388
+ )
3389
+ verify_gtid_consistency: wrappers_pb2.BoolValue = proto.Field(
3390
+ proto.MESSAGE,
3391
+ number=2,
3392
+ message=wrappers_pb2.BoolValue,
3393
+ )
3394
+ master_instance_name: str = proto.Field(
3395
+ proto.STRING,
3396
+ number=3,
3397
+ )
3398
+ replica_configuration: cloud_sql_resources.DemoteMasterConfiguration = proto.Field(
3399
+ proto.MESSAGE,
3400
+ number=4,
3401
+ message=cloud_sql_resources.DemoteMasterConfiguration,
3402
+ )
3403
+ skip_replication_setup: bool = proto.Field(
3404
+ proto.BOOL,
3405
+ number=5,
3406
+ )
3407
+
3408
+
3409
+ class DemoteContext(proto.Message):
3410
+ r"""This context is used to demote an existing standalone
3411
+ instance to be a Cloud SQL read replica for an external database
3412
+ server.
3413
+
3414
+ Attributes:
3415
+ kind (str):
3416
+ This is always ``sql#demoteContext``.
3417
+ source_representative_instance_name (str):
3418
+ Required. The name of the instance which acts
3419
+ as the on-premises primary instance in the
3420
+ replication setup.
3421
+ """
3422
+
3423
+ kind: str = proto.Field(
3424
+ proto.STRING,
3425
+ number=1,
3426
+ )
3427
+ source_representative_instance_name: str = proto.Field(
3428
+ proto.STRING,
3429
+ number=2,
3430
+ )
3431
+
3432
+
3433
+ class FailoverContext(proto.Message):
3434
+ r"""Database instance failover context.
3435
+
3436
+ Attributes:
3437
+ settings_version (int):
3438
+ The current settings version of this
3439
+ instance. Request will be rejected if this
3440
+ version doesn't match the current settings
3441
+ version.
3442
+ kind (str):
3443
+ This is always ``sql#failoverContext``.
3444
+ """
3445
+
3446
+ settings_version: int = proto.Field(
3447
+ proto.INT64,
3448
+ number=1,
3449
+ )
3450
+ kind: str = proto.Field(
3451
+ proto.STRING,
3452
+ number=2,
3453
+ )
3454
+
3455
+
3456
+ class RestoreBackupContext(proto.Message):
3457
+ r"""Database instance restore from backup context.
3458
+ Backup context contains source instance id and project id.
3459
+
3460
+ Attributes:
3461
+ kind (str):
3462
+ This is always ``sql#restoreBackupContext``.
3463
+ backup_run_id (int):
3464
+ The ID of the backup run to restore from.
3465
+ instance_id (str):
3466
+ The ID of the instance that the backup was
3467
+ taken from.
3468
+ project (str):
3469
+ The full project ID of the source instance.
3470
+ """
3471
+
3472
+ kind: str = proto.Field(
3473
+ proto.STRING,
3474
+ number=1,
3475
+ )
3476
+ backup_run_id: int = proto.Field(
3477
+ proto.INT64,
3478
+ number=2,
3479
+ )
3480
+ instance_id: str = proto.Field(
3481
+ proto.STRING,
3482
+ number=3,
3483
+ )
3484
+ project: str = proto.Field(
3485
+ proto.STRING,
3486
+ number=4,
3487
+ )
3488
+
3489
+
3490
+ class RotateServerCaContext(proto.Message):
3491
+ r"""Instance rotate server CA context.
3492
+
3493
+ Attributes:
3494
+ kind (str):
3495
+ This is always ``sql#rotateServerCaContext``.
3496
+ next_version (str):
3497
+ The fingerprint of the next version to be
3498
+ rotated to. If left unspecified, will be rotated
3499
+ to the most recently added server CA version.
3500
+ """
3501
+
3502
+ kind: str = proto.Field(
3503
+ proto.STRING,
3504
+ number=1,
3505
+ )
3506
+ next_version: str = proto.Field(
3507
+ proto.STRING,
3508
+ number=2,
3509
+ )
3510
+
3511
+
3512
+ class RotateServerCertificateContext(proto.Message):
3513
+ r"""Instance rotate server certificate context.
3514
+
3515
+ Attributes:
3516
+ kind (str):
3517
+ Optional. This is always
3518
+ ``sql#rotateServerCertificateContext``.
3519
+ next_version (str):
3520
+ The fingerprint of the next version to be
3521
+ rotated to. If left unspecified, will be rotated
3522
+ to the most recently added server certificate
3523
+ version.
3524
+ """
3525
+
3526
+ kind: str = proto.Field(
3527
+ proto.STRING,
3528
+ number=1,
3529
+ )
3530
+ next_version: str = proto.Field(
3531
+ proto.STRING,
3532
+ number=2,
3533
+ )
3534
+
3535
+
3536
+ class RotateEntraIdCertificateContext(proto.Message):
3537
+ r"""Instance rotate Entra ID certificate context.
3538
+
3539
+ Attributes:
3540
+ kind (str):
3541
+ Optional. This is always
3542
+ ``sql#rotateEntraIdCertificateContext``.
3543
+ next_version (str):
3544
+ Optional. The fingerprint of the next version
3545
+ to be rotated to. If left unspecified, will be
3546
+ rotated to the most recently added server
3547
+ certificate version.
3548
+ """
3549
+
3550
+ kind: str = proto.Field(
3551
+ proto.STRING,
3552
+ number=1,
3553
+ )
3554
+ next_version: str = proto.Field(
3555
+ proto.STRING,
3556
+ number=2,
3557
+ )
3558
+
3559
+
3560
+ class TruncateLogContext(proto.Message):
3561
+ r"""Database Instance truncate log context.
3562
+
3563
+ Attributes:
3564
+ kind (str):
3565
+ This is always ``sql#truncateLogContext``.
3566
+ log_type (str):
3567
+ The type of log to truncate. Valid values are
3568
+ ``MYSQL_GENERAL_TABLE`` and ``MYSQL_SLOW_TABLE``.
3569
+ """
3570
+
3571
+ kind: str = proto.Field(
3572
+ proto.STRING,
3573
+ number=1,
3574
+ )
3575
+ log_type: str = proto.Field(
3576
+ proto.STRING,
3577
+ number=2,
3578
+ )
3579
+
3580
+
3581
+ class SqlExternalSyncSettingError(proto.Message):
3582
+ r"""External primary instance migration setting error/warning.
3583
+
3584
+ Attributes:
3585
+ kind (str):
3586
+ Can be ``sql#externalSyncSettingError`` or
3587
+ ``sql#externalSyncSettingWarning``.
3588
+ type_ (google.cloud.sqladmin_v1.types.SqlExternalSyncSettingError.SqlExternalSyncSettingErrorType):
3589
+ Identifies the specific error that occurred.
3590
+ detail (str):
3591
+ Additional information about the error
3592
+ encountered.
3593
+ """
3594
+
3595
+ class SqlExternalSyncSettingErrorType(proto.Enum):
3596
+ r"""
3597
+
3598
+ Values:
3599
+ SQL_EXTERNAL_SYNC_SETTING_ERROR_TYPE_UNSPECIFIED (0):
3600
+ No description available.
3601
+ CONNECTION_FAILURE (1):
3602
+ No description available.
3603
+ BINLOG_NOT_ENABLED (2):
3604
+ No description available.
3605
+ INCOMPATIBLE_DATABASE_VERSION (3):
3606
+ No description available.
3607
+ REPLICA_ALREADY_SETUP (4):
3608
+ No description available.
3609
+ INSUFFICIENT_PRIVILEGE (5):
3610
+ The replication user is missing privileges
3611
+ that are required.
3612
+ UNSUPPORTED_MIGRATION_TYPE (6):
3613
+ Unsupported migration type.
3614
+ NO_PGLOGICAL_INSTALLED (7):
3615
+ No pglogical extension installed on
3616
+ databases, applicable for postgres.
3617
+ PGLOGICAL_NODE_ALREADY_EXISTS (8):
3618
+ pglogical node already exists on databases,
3619
+ applicable for postgres.
3620
+ INVALID_WAL_LEVEL (9):
3621
+ The value of parameter wal_level is not set to logical.
3622
+ INVALID_SHARED_PRELOAD_LIBRARY (10):
3623
+ The value of parameter shared_preload_libraries does not
3624
+ include pglogical.
3625
+ INSUFFICIENT_MAX_REPLICATION_SLOTS (11):
3626
+ The value of parameter max_replication_slots is not
3627
+ sufficient.
3628
+ INSUFFICIENT_MAX_WAL_SENDERS (12):
3629
+ The value of parameter max_wal_senders is not sufficient.
3630
+ INSUFFICIENT_MAX_WORKER_PROCESSES (13):
3631
+ The value of parameter max_worker_processes is not
3632
+ sufficient.
3633
+ UNSUPPORTED_EXTENSIONS (14):
3634
+ Extensions installed are either not supported
3635
+ or having unsupported versions.
3636
+ INVALID_RDS_LOGICAL_REPLICATION (15):
3637
+ The value of parameter rds.logical_replication is not set to
3638
+ 1.
3639
+ INVALID_LOGGING_SETUP (16):
3640
+ The primary instance logging setup doesn't
3641
+ allow EM sync.
3642
+ INVALID_DB_PARAM (17):
3643
+ The primary instance database parameter setup
3644
+ doesn't allow EM sync.
3645
+ UNSUPPORTED_GTID_MODE (18):
3646
+ The gtid_mode is not supported, applicable for MySQL.
3647
+ SQLSERVER_AGENT_NOT_RUNNING (19):
3648
+ SQL Server Agent is not running.
3649
+ UNSUPPORTED_TABLE_DEFINITION (20):
3650
+ The table definition is not support due to
3651
+ missing primary key or replica identity,
3652
+ applicable for postgres. Note that this is a
3653
+ warning and won't block the migration.
3654
+ UNSUPPORTED_DEFINER (21):
3655
+ The customer has a definer that will break EM
3656
+ setup.
3657
+ SQLSERVER_SERVERNAME_MISMATCH (22):
3658
+ SQL Server @@SERVERNAME does not match actual
3659
+ host name.
3660
+ PRIMARY_ALREADY_SETUP (23):
3661
+ The primary instance has been setup and will
3662
+ fail the setup.
3663
+ UNSUPPORTED_BINLOG_FORMAT (24):
3664
+ The primary instance has unsupported binary
3665
+ log format.
3666
+ BINLOG_RETENTION_SETTING (25):
3667
+ The primary instance's binary log retention
3668
+ setting.
3669
+ UNSUPPORTED_STORAGE_ENGINE (26):
3670
+ The primary instance has tables with
3671
+ unsupported storage engine.
3672
+ LIMITED_SUPPORT_TABLES (27):
3673
+ Source has tables with limited support
3674
+ eg: PostgreSQL tables without primary keys.
3675
+ EXISTING_DATA_IN_REPLICA (28):
3676
+ The replica instance contains existing data.
3677
+ MISSING_OPTIONAL_PRIVILEGES (29):
3678
+ The replication user is missing privileges
3679
+ that are optional.
3680
+ RISKY_BACKUP_ADMIN_PRIVILEGE (30):
3681
+ Additional BACKUP_ADMIN privilege is granted to the
3682
+ replication user which may lock source MySQL 8 instance for
3683
+ DDLs during initial sync.
3684
+ INSUFFICIENT_GCS_PERMISSIONS (31):
3685
+ The Cloud Storage bucket is missing necessary
3686
+ permissions.
3687
+ INVALID_FILE_INFO (32):
3688
+ The Cloud Storage bucket has an error in the
3689
+ file or contains invalid file information.
3690
+ UNSUPPORTED_DATABASE_SETTINGS (33):
3691
+ The source instance has unsupported database
3692
+ settings for migration.
3693
+ MYSQL_PARALLEL_IMPORT_INSUFFICIENT_PRIVILEGE (34):
3694
+ The replication user is missing parallel
3695
+ import specific privileges. (e.g. LOCK TABLES)
3696
+ for MySQL.
3697
+ LOCAL_INFILE_OFF (35):
3698
+ The global variable local_infile is off on external server
3699
+ replica.
3700
+ TURN_ON_PITR_AFTER_PROMOTE (36):
3701
+ This code instructs customers to turn on
3702
+ point-in-time recovery manually for the instance
3703
+ after promoting the Cloud SQL for PostgreSQL
3704
+ instance.
3705
+ INCOMPATIBLE_DATABASE_MINOR_VERSION (37):
3706
+ The minor version of replica database is
3707
+ incompatible with the source.
3708
+ SOURCE_MAX_SUBSCRIPTIONS (38):
3709
+ This warning message indicates that Cloud SQL
3710
+ uses the maximum number of subscriptions to
3711
+ migrate data from the source to the destination.
3712
+ UNABLE_TO_VERIFY_DEFINERS (39):
3713
+ Unable to verify definers on the source for
3714
+ MySQL.
3715
+ SUBSCRIPTION_CALCULATION_STATUS (40):
3716
+ If a time out occurs while the subscription
3717
+ counts are calculated, then this value is set to
3718
+ 1. Otherwise, this value is set to 2.
3719
+ PG_SUBSCRIPTION_COUNT (41):
3720
+ Count of subscriptions needed to sync source
3721
+ data for PostgreSQL database.
3722
+ PG_SYNC_PARALLEL_LEVEL (42):
3723
+ Final parallel level that is used to do
3724
+ migration.
3725
+ INSUFFICIENT_DISK_SIZE (43):
3726
+ The disk size of the replica instance is
3727
+ smaller than the data size of the source
3728
+ instance.
3729
+ INSUFFICIENT_MACHINE_TIER (44):
3730
+ The data size of the source instance is
3731
+ greater than 1 TB, the number of cores of the
3732
+ replica instance is less than 8, and the memory
3733
+ of the replica is less than 32 GB.
3734
+ UNSUPPORTED_EXTENSIONS_NOT_MIGRATED (45):
3735
+ The warning message indicates the unsupported
3736
+ extensions will not be migrated to the
3737
+ destination.
3738
+ EXTENSIONS_NOT_MIGRATED (46):
3739
+ The warning message indicates the pg_cron extension and
3740
+ settings will not be migrated to the destination.
3741
+ PG_CRON_FLAG_ENABLED_IN_REPLICA (47):
3742
+ The error message indicates that pg_cron flags are enabled
3743
+ on the destination which is not supported during the
3744
+ migration.
3745
+ EXTENSIONS_NOT_ENABLED_IN_REPLICA (48):
3746
+ This error message indicates that the
3747
+ specified extensions are not enabled on
3748
+ destination instance. For example, before you
3749
+ can migrate data to the destination instance,
3750
+ you must enable the PGAudit extension on the
3751
+ instance.
3752
+ UNSUPPORTED_COLUMNS (49):
3753
+ The source database has generated columns
3754
+ that can't be migrated. Please change them to
3755
+ regular columns before migration.
3756
+ USERS_NOT_CREATED_IN_REPLICA (50):
3757
+ The source database has users that aren't created in the
3758
+ replica. First, create all users, which are in the
3759
+ pg_user_mappings table of the source database, in the
3760
+ destination instance. Then, perform the migration.
3761
+ UNSUPPORTED_SYSTEM_OBJECTS (51):
3762
+ The selected objects include system objects
3763
+ that aren't supported for migration.
3764
+ UNSUPPORTED_TABLES_WITH_REPLICA_IDENTITY (52):
3765
+ The source database has tables with the FULL
3766
+ or NOTHING replica identity. Before starting
3767
+ your migration, either remove the identity or
3768
+ change it to DEFAULT. Note that this is an error
3769
+ and will block the migration.
3770
+ SELECTED_OBJECTS_NOT_EXIST_ON_SOURCE (53):
3771
+ The selected objects don't exist on the
3772
+ source instance.
3773
+ PSC_ONLY_INSTANCE_WITH_NO_NETWORK_ATTACHMENT_URI (54):
3774
+ PSC only destination instance does not have a
3775
+ network attachment URI.
3776
+ SELECTED_OBJECTS_REFERENCE_UNSELECTED_OBJECTS (55):
3777
+ Selected objects reference unselected
3778
+ objects. Based on their object type (foreign key
3779
+ constraint or view), selected objects will fail
3780
+ during migration.
3781
+ PROMPT_DELETE_EXISTING (56):
3782
+ The migration will delete existing data in the replica; set
3783
+ [replica_overwrite_enabled][google.cloud.sql.v1.SqlInstancesStartExternalSyncRequest.replica_overwrite_enabled]
3784
+ in the request to acknowledge this. This is an error. MySQL
3785
+ only.
3786
+ WILL_DELETE_EXISTING (57):
3787
+ The migration will delete existing data in the replica;
3788
+ [replica_overwrite_enabled][google.cloud.sql.v1.SqlInstancesStartExternalSyncRequest.replica_overwrite_enabled]
3789
+ was set in the request acknowledging this. This is a warning
3790
+ rather than an error. MySQL only.
3791
+ PG_DDL_REPLICATION_INSUFFICIENT_PRIVILEGE (58):
3792
+ The replication user is missing specific
3793
+ privileges to setup DDL replication. (e.g.
3794
+ CREATE EVENT TRIGGER, CREATE SCHEMA) for
3795
+ PostgreSQL.
3796
+ """
3797
+
3798
+ SQL_EXTERNAL_SYNC_SETTING_ERROR_TYPE_UNSPECIFIED = 0
3799
+ CONNECTION_FAILURE = 1
3800
+ BINLOG_NOT_ENABLED = 2
3801
+ INCOMPATIBLE_DATABASE_VERSION = 3
3802
+ REPLICA_ALREADY_SETUP = 4
3803
+ INSUFFICIENT_PRIVILEGE = 5
3804
+ UNSUPPORTED_MIGRATION_TYPE = 6
3805
+ NO_PGLOGICAL_INSTALLED = 7
3806
+ PGLOGICAL_NODE_ALREADY_EXISTS = 8
3807
+ INVALID_WAL_LEVEL = 9
3808
+ INVALID_SHARED_PRELOAD_LIBRARY = 10
3809
+ INSUFFICIENT_MAX_REPLICATION_SLOTS = 11
3810
+ INSUFFICIENT_MAX_WAL_SENDERS = 12
3811
+ INSUFFICIENT_MAX_WORKER_PROCESSES = 13
3812
+ UNSUPPORTED_EXTENSIONS = 14
3813
+ INVALID_RDS_LOGICAL_REPLICATION = 15
3814
+ INVALID_LOGGING_SETUP = 16
3815
+ INVALID_DB_PARAM = 17
3816
+ UNSUPPORTED_GTID_MODE = 18
3817
+ SQLSERVER_AGENT_NOT_RUNNING = 19
3818
+ UNSUPPORTED_TABLE_DEFINITION = 20
3819
+ UNSUPPORTED_DEFINER = 21
3820
+ SQLSERVER_SERVERNAME_MISMATCH = 22
3821
+ PRIMARY_ALREADY_SETUP = 23
3822
+ UNSUPPORTED_BINLOG_FORMAT = 24
3823
+ BINLOG_RETENTION_SETTING = 25
3824
+ UNSUPPORTED_STORAGE_ENGINE = 26
3825
+ LIMITED_SUPPORT_TABLES = 27
3826
+ EXISTING_DATA_IN_REPLICA = 28
3827
+ MISSING_OPTIONAL_PRIVILEGES = 29
3828
+ RISKY_BACKUP_ADMIN_PRIVILEGE = 30
3829
+ INSUFFICIENT_GCS_PERMISSIONS = 31
3830
+ INVALID_FILE_INFO = 32
3831
+ UNSUPPORTED_DATABASE_SETTINGS = 33
3832
+ MYSQL_PARALLEL_IMPORT_INSUFFICIENT_PRIVILEGE = 34
3833
+ LOCAL_INFILE_OFF = 35
3834
+ TURN_ON_PITR_AFTER_PROMOTE = 36
3835
+ INCOMPATIBLE_DATABASE_MINOR_VERSION = 37
3836
+ SOURCE_MAX_SUBSCRIPTIONS = 38
3837
+ UNABLE_TO_VERIFY_DEFINERS = 39
3838
+ SUBSCRIPTION_CALCULATION_STATUS = 40
3839
+ PG_SUBSCRIPTION_COUNT = 41
3840
+ PG_SYNC_PARALLEL_LEVEL = 42
3841
+ INSUFFICIENT_DISK_SIZE = 43
3842
+ INSUFFICIENT_MACHINE_TIER = 44
3843
+ UNSUPPORTED_EXTENSIONS_NOT_MIGRATED = 45
3844
+ EXTENSIONS_NOT_MIGRATED = 46
3845
+ PG_CRON_FLAG_ENABLED_IN_REPLICA = 47
3846
+ EXTENSIONS_NOT_ENABLED_IN_REPLICA = 48
3847
+ UNSUPPORTED_COLUMNS = 49
3848
+ USERS_NOT_CREATED_IN_REPLICA = 50
3849
+ UNSUPPORTED_SYSTEM_OBJECTS = 51
3850
+ UNSUPPORTED_TABLES_WITH_REPLICA_IDENTITY = 52
3851
+ SELECTED_OBJECTS_NOT_EXIST_ON_SOURCE = 53
3852
+ PSC_ONLY_INSTANCE_WITH_NO_NETWORK_ATTACHMENT_URI = 54
3853
+ SELECTED_OBJECTS_REFERENCE_UNSELECTED_OBJECTS = 55
3854
+ PROMPT_DELETE_EXISTING = 56
3855
+ WILL_DELETE_EXISTING = 57
3856
+ PG_DDL_REPLICATION_INSUFFICIENT_PRIVILEGE = 58
3857
+
3858
+ kind: str = proto.Field(
3859
+ proto.STRING,
3860
+ number=1,
3861
+ )
3862
+ type_: SqlExternalSyncSettingErrorType = proto.Field(
3863
+ proto.ENUM,
3864
+ number=2,
3865
+ enum=SqlExternalSyncSettingErrorType,
3866
+ )
3867
+ detail: str = proto.Field(
3868
+ proto.STRING,
3869
+ number=3,
3870
+ )
3871
+
3872
+
3873
+ class SelectedObjects(proto.Message):
3874
+ r"""A list of objects that the user selects for replication from
3875
+ an external source instance.
3876
+
3877
+ Attributes:
3878
+ database (str):
3879
+ Required. The name of the database to
3880
+ migrate.
3881
+ """
3882
+
3883
+ database: str = proto.Field(
3884
+ proto.STRING,
3885
+ number=1,
3886
+ )
3887
+
3888
+
3889
+ class OnPremisesConfiguration(proto.Message):
3890
+ r"""On-premises instance configuration.
3891
+
3892
+ Attributes:
3893
+ host_port (str):
3894
+ The host and port of the on-premises instance
3895
+ in host:port format
3896
+ kind (str):
3897
+ This is always ``sql#onPremisesConfiguration``.
3898
+ username (str):
3899
+ The username for connecting to on-premises
3900
+ instance.
3901
+ password (str):
3902
+ The password for connecting to on-premises
3903
+ instance.
3904
+ ca_certificate (str):
3905
+ PEM representation of the trusted CA's x509
3906
+ certificate.
3907
+ client_certificate (str):
3908
+ PEM representation of the replica's x509
3909
+ certificate.
3910
+ client_key (str):
3911
+ PEM representation of the replica's private
3912
+ key. The corresponding public key is encoded in
3913
+ the client's certificate.
3914
+ dump_file_path (str):
3915
+ The dump file to create the Cloud SQL
3916
+ replica.
3917
+ source_instance (google.cloud.sqladmin_v1.types.InstanceReference):
3918
+ The reference to Cloud SQL instance if the
3919
+ source is Cloud SQL.
3920
+ selected_objects (MutableSequence[google.cloud.sqladmin_v1.types.SelectedObjects]):
3921
+ Optional. A list of objects that the user
3922
+ selects for replication from an external source
3923
+ instance.
3924
+ ssl_option (google.cloud.sqladmin_v1.types.OnPremisesConfiguration.SslOption):
3925
+ Optional. SSL option for replica connection
3926
+ to the on-premises source.
3927
+ dms_managed (bool):
3928
+ Output only. Indicates whether the resource
3929
+ is managed by Database Migration Service.
3930
+ """
3931
+
3932
+ class SslOption(proto.Enum):
3933
+ r"""SslOption defines the SSL mode to be used for replica
3934
+ connection to the on-premises source.
3935
+
3936
+ Values:
3937
+ SSL_OPTION_UNSPECIFIED (0):
3938
+ Unknown SSL option i.e. SSL option not
3939
+ specified by user.
3940
+ DISABLE (1):
3941
+ SSL is not used for replica connection to the
3942
+ on-premises source.
3943
+ REQUIRE (2):
3944
+ SSL is required for replica connection to the
3945
+ on-premises source.
3946
+ VERIFY_CA (3):
3947
+ Verify CA is required for replica connection
3948
+ to the on-premises source.
3949
+ """
3950
+
3951
+ SSL_OPTION_UNSPECIFIED = 0
3952
+ DISABLE = 1
3953
+ REQUIRE = 2
3954
+ VERIFY_CA = 3
3955
+
3956
+ host_port: str = proto.Field(
3957
+ proto.STRING,
3958
+ number=1,
3959
+ )
3960
+ kind: str = proto.Field(
3961
+ proto.STRING,
3962
+ number=2,
3963
+ )
3964
+ username: str = proto.Field(
3965
+ proto.STRING,
3966
+ number=3,
3967
+ )
3968
+ password: str = proto.Field(
3969
+ proto.STRING,
3970
+ number=4,
3971
+ )
3972
+ ca_certificate: str = proto.Field(
3973
+ proto.STRING,
3974
+ number=5,
3975
+ )
3976
+ client_certificate: str = proto.Field(
3977
+ proto.STRING,
3978
+ number=6,
3979
+ )
3980
+ client_key: str = proto.Field(
3981
+ proto.STRING,
3982
+ number=7,
3983
+ )
3984
+ dump_file_path: str = proto.Field(
3985
+ proto.STRING,
3986
+ number=8,
3987
+ )
3988
+ source_instance: cloud_sql_resources.InstanceReference = proto.Field(
3989
+ proto.MESSAGE,
3990
+ number=15,
3991
+ message=cloud_sql_resources.InstanceReference,
3992
+ )
3993
+ selected_objects: MutableSequence["SelectedObjects"] = proto.RepeatedField(
3994
+ proto.MESSAGE,
3995
+ number=16,
3996
+ message="SelectedObjects",
3997
+ )
3998
+ ssl_option: SslOption = proto.Field(
3999
+ proto.ENUM,
4000
+ number=18,
4001
+ enum=SslOption,
4002
+ )
4003
+ dms_managed: bool = proto.Field(
4004
+ proto.BOOL,
4005
+ number=20,
4006
+ )
4007
+
4008
+
4009
+ class ReplicaConfiguration(proto.Message):
4010
+ r"""Read-replica configuration for connecting to the primary
4011
+ instance.
4012
+
4013
+ Attributes:
4014
+ kind (str):
4015
+ This is always ``sql#replicaConfiguration``.
4016
+ mysql_replica_configuration (google.cloud.sqladmin_v1.types.MySqlReplicaConfiguration):
4017
+ MySQL specific configuration when replicating from a MySQL
4018
+ on-premises primary instance. Replication configuration
4019
+ information such as the username, password, certificates,
4020
+ and keys are not stored in the instance metadata. The
4021
+ configuration information is used only to set up the
4022
+ replication connection and is stored by MySQL in a file
4023
+ named ``master.info`` in the data directory.
4024
+ failover_target (google.protobuf.wrappers_pb2.BoolValue):
4025
+ Specifies if the replica is the failover target. If the
4026
+ field is set to ``true``, the replica will be designated as
4027
+ a failover replica. In case the primary instance fails, the
4028
+ replica instance will be promoted as the new primary
4029
+ instance. Only one replica can be specified as failover
4030
+ target, and the replica has to be in different zone with the
4031
+ primary instance.
4032
+ cascadable_replica (google.protobuf.wrappers_pb2.BoolValue):
4033
+ Optional. Specifies if a SQL Server replica
4034
+ is a cascadable replica. A cascadable replica is
4035
+ a SQL Server cross region replica that supports
4036
+ replica(s) under it.
4037
+ """
4038
+
4039
+ kind: str = proto.Field(
4040
+ proto.STRING,
4041
+ number=1,
4042
+ )
4043
+ mysql_replica_configuration: cloud_sql_resources.MySqlReplicaConfiguration = (
4044
+ proto.Field(
4045
+ proto.MESSAGE,
4046
+ number=2,
4047
+ message=cloud_sql_resources.MySqlReplicaConfiguration,
4048
+ )
4049
+ )
4050
+ failover_target: wrappers_pb2.BoolValue = proto.Field(
4051
+ proto.MESSAGE,
4052
+ number=3,
4053
+ message=wrappers_pb2.BoolValue,
4054
+ )
4055
+ cascadable_replica: wrappers_pb2.BoolValue = proto.Field(
4056
+ proto.MESSAGE,
4057
+ number=5,
4058
+ message=wrappers_pb2.BoolValue,
4059
+ )
4060
+
4061
+
4062
+ class SqlInstancesExecuteSqlRequest(proto.Message):
4063
+ r"""Execute SQL statements request.
4064
+
4065
+ Attributes:
4066
+ instance (str):
4067
+ Required. Database instance ID. This does not
4068
+ include the project ID.
4069
+ project (str):
4070
+ Required. Project ID of the project that
4071
+ contains the instance.
4072
+ body (google.cloud.sqladmin_v1.types.ExecuteSqlPayload):
4073
+ The request body.
4074
+ """
4075
+
4076
+ instance: str = proto.Field(
4077
+ proto.STRING,
4078
+ number=1,
4079
+ )
4080
+ project: str = proto.Field(
4081
+ proto.STRING,
4082
+ number=2,
4083
+ )
4084
+ body: "ExecuteSqlPayload" = proto.Field(
4085
+ proto.MESSAGE,
4086
+ number=100,
4087
+ message="ExecuteSqlPayload",
4088
+ )
4089
+
4090
+
4091
+ class ExecuteSqlPayload(proto.Message):
4092
+ r"""The request payload used to execute SQL statements.
4093
+
4094
+ This message has `oneof`_ fields (mutually exclusive fields).
4095
+ For each oneof, at most one member field can be set at the same time.
4096
+ Setting any member of the oneof automatically clears all other
4097
+ members.
4098
+
4099
+ .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
4100
+
4101
+ Attributes:
4102
+ user (str):
4103
+ Optional. The name of an existing database user to connect
4104
+ to the database. When ``auto_iam_authn`` is set to true,
4105
+ this field is ignored and the API caller's IAM user is used.
4106
+ sql_statement (str):
4107
+ Required. SQL statements to run on the
4108
+ database. It can be a single statement or a
4109
+ sequence of statements separated by semicolons.
4110
+ database (str):
4111
+ Optional. Name of the database on which the
4112
+ statement will be executed.
4113
+ password_secret_version (str):
4114
+ Optional. The resource name of the Secret Manager secret
4115
+ holding the password for the user to log into the database.
4116
+ The secret should be created using the regional endpoint
4117
+ (for API) or from the Regional Secrets page (for UI), and
4118
+ stored in the same region as the Cloud SQL instance. The
4119
+ expected resource name format is
4120
+ ``projects/{project}/locations/{location}/secrets/{secret}/versions/{secret_version}``.
4121
+ Used together with the ``user`` field. The secret resource
4122
+ name will not be stored.
4123
+
4124
+ This field is a member of `oneof`_ ``user_password``.
4125
+ auto_iam_authn (bool):
4126
+ Optional. When set to ``true``, the API caller identity
4127
+ associated with the request is used for database
4128
+ authentication. The API caller must be an IAM user in the
4129
+ database.
4130
+
4131
+ This field is a member of `oneof`_ ``user_password``.
4132
+ row_limit (int):
4133
+ Optional. The maximum number of rows returned
4134
+ per SQL statement.
4135
+ partial_result_mode (google.cloud.sqladmin_v1.types.ExecuteSqlPayload.PartialResultMode):
4136
+ Optional. Controls how the API should respond
4137
+ when the SQL execution result is incomplete due
4138
+ to the size limit or another error. The default
4139
+ mode is to throw an error.
4140
+ application (str):
4141
+ Optional. Specifies the name of the
4142
+ application that is making the request. This
4143
+ field is used for telemetry. Only alphanumeric
4144
+ characters, dashes, and underscores are allowed.
4145
+ The maximum length is 32 characters.
4146
+ """
4147
+
4148
+ class PartialResultMode(proto.Enum):
4149
+ r"""Controls how the API should respond when the SQL execution
4150
+ result exceeds 10 MB.
4151
+
4152
+ Values:
4153
+ PARTIAL_RESULT_MODE_UNSPECIFIED (0):
4154
+ Unspecified mode, effectively the same as
4155
+ ``FAIL_PARTIAL_RESULT``.
4156
+ FAIL_PARTIAL_RESULT (1):
4157
+ Throw an error if the result exceeds 10 MB or
4158
+ if only a partial result can be retrieved. Don't
4159
+ return the result.
4160
+ ALLOW_PARTIAL_RESULT (2):
4161
+ Return a truncated result and set ``partial_result`` to true
4162
+ if the result exceeds 10 MB or if only a partial result can
4163
+ be retrieved due to error. Don't throw an error.
4164
+ """
4165
+
4166
+ PARTIAL_RESULT_MODE_UNSPECIFIED = 0
4167
+ FAIL_PARTIAL_RESULT = 1
4168
+ ALLOW_PARTIAL_RESULT = 2
4169
+
4170
+ user: str = proto.Field(
4171
+ proto.STRING,
4172
+ number=1,
4173
+ )
4174
+ sql_statement: str = proto.Field(
4175
+ proto.STRING,
4176
+ number=2,
4177
+ )
4178
+ database: str = proto.Field(
4179
+ proto.STRING,
4180
+ number=3,
4181
+ )
4182
+ password_secret_version: str = proto.Field(
4183
+ proto.STRING,
4184
+ number=5,
4185
+ oneof="user_password",
4186
+ )
4187
+ auto_iam_authn: bool = proto.Field(
4188
+ proto.BOOL,
4189
+ number=11,
4190
+ oneof="user_password",
4191
+ )
4192
+ row_limit: int = proto.Field(
4193
+ proto.INT64,
4194
+ number=10,
4195
+ )
4196
+ partial_result_mode: PartialResultMode = proto.Field(
4197
+ proto.ENUM,
4198
+ number=13,
4199
+ enum=PartialResultMode,
4200
+ )
4201
+ application: str = proto.Field(
4202
+ proto.STRING,
4203
+ number=16,
4204
+ )
4205
+
4206
+
4207
+ class SqlInstancesExecuteSqlResponse(proto.Message):
4208
+ r"""Execute SQL statements response.
4209
+
4210
+ Attributes:
4211
+ messages (MutableSequence[google.cloud.sqladmin_v1.types.SqlInstancesExecuteSqlResponse.Message]):
4212
+ A list of notices and warnings generated during query
4213
+ execution. For PostgreSQL, this includes all notices and
4214
+ warnings. For MySQL, this includes warnings generated by the
4215
+ last executed statement. To retrieve all warnings for a
4216
+ multi-statement query, ``SHOW WARNINGS`` must be executed
4217
+ after each statement.
4218
+ metadata (google.cloud.sqladmin_v1.types.Metadata):
4219
+ The additional metadata information regarding
4220
+ the execution of the SQL statements.
4221
+ results (MutableSequence[google.cloud.sqladmin_v1.types.QueryResult]):
4222
+ The list of results after executing all the
4223
+ SQL statements.
4224
+ status (google.rpc.status_pb2.Status):
4225
+ Contains the error from the database if the
4226
+ SQL execution failed.
4227
+ """
4228
+
4229
+ class Message(proto.Message):
4230
+ r"""Represents a notice or warning message from the database.
4231
+
4232
+ .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
4233
+
4234
+ Attributes:
4235
+ message (str):
4236
+ The full message string.
4237
+ For PostgreSQL, this is a formatted string that
4238
+ may include severity, code, and the
4239
+ notice/warning message.
4240
+ For MySQL, this contains the warning message.
4241
+
4242
+ This field is a member of `oneof`_ ``_message``.
4243
+ severity (str):
4244
+ The severity of the message (e.g., "NOTICE"
4245
+ for PostgreSQL, "WARNING" for MySQL).
4246
+
4247
+ This field is a member of `oneof`_ ``_severity``.
4248
+ """
4249
+
4250
+ message: str = proto.Field(
4251
+ proto.STRING,
4252
+ number=1,
4253
+ optional=True,
4254
+ )
4255
+ severity: str = proto.Field(
4256
+ proto.STRING,
4257
+ number=2,
4258
+ optional=True,
4259
+ )
4260
+
4261
+ messages: MutableSequence[Message] = proto.RepeatedField(
4262
+ proto.MESSAGE,
4263
+ number=9,
4264
+ message=Message,
4265
+ )
4266
+ metadata: "Metadata" = proto.Field(
4267
+ proto.MESSAGE,
4268
+ number=6,
4269
+ message="Metadata",
4270
+ )
4271
+ results: MutableSequence["QueryResult"] = proto.RepeatedField(
4272
+ proto.MESSAGE,
4273
+ number=7,
4274
+ message="QueryResult",
4275
+ )
4276
+ status: status_pb2.Status = proto.Field(
4277
+ proto.MESSAGE,
4278
+ number=8,
4279
+ message=status_pb2.Status,
4280
+ )
4281
+
4282
+
4283
+ class QueryResult(proto.Message):
4284
+ r"""QueryResult contains the result of executing a single SQL
4285
+ statement.
4286
+
4287
+ Attributes:
4288
+ columns (MutableSequence[google.cloud.sqladmin_v1.types.Column]):
4289
+ List of columns included in the result. This
4290
+ also includes the data type of the column.
4291
+ rows (MutableSequence[google.cloud.sqladmin_v1.types.Row]):
4292
+ Rows returned by the SQL statement.
4293
+ message (str):
4294
+ Message related to the SQL execution result.
4295
+ partial_result (bool):
4296
+ Set to true if the SQL execution's result is
4297
+ truncated due to size limits or an error
4298
+ retrieving results.
4299
+ status (google.rpc.status_pb2.Status):
4300
+ If results were truncated due to an error,
4301
+ details of that error.
4302
+ """
4303
+
4304
+ columns: MutableSequence["Column"] = proto.RepeatedField(
4305
+ proto.MESSAGE,
4306
+ number=1,
4307
+ message="Column",
4308
+ )
4309
+ rows: MutableSequence["Row"] = proto.RepeatedField(
4310
+ proto.MESSAGE,
4311
+ number=2,
4312
+ message="Row",
4313
+ )
4314
+ message: str = proto.Field(
4315
+ proto.STRING,
4316
+ number=3,
4317
+ )
4318
+ partial_result: bool = proto.Field(
4319
+ proto.BOOL,
4320
+ number=4,
4321
+ )
4322
+ status: status_pb2.Status = proto.Field(
4323
+ proto.MESSAGE,
4324
+ number=8,
4325
+ message=status_pb2.Status,
4326
+ )
4327
+
4328
+
4329
+ class Column(proto.Message):
4330
+ r"""Contains the name and datatype of a column.
4331
+
4332
+ Attributes:
4333
+ name (str):
4334
+ Name of the column.
4335
+ type_ (str):
4336
+ Datatype of the column.
4337
+ """
4338
+
4339
+ name: str = proto.Field(
4340
+ proto.STRING,
4341
+ number=1,
4342
+ )
4343
+ type_: str = proto.Field(
4344
+ proto.STRING,
4345
+ number=2,
4346
+ )
4347
+
4348
+
4349
+ class Row(proto.Message):
4350
+ r"""Contains the values for a row.
4351
+
4352
+ Attributes:
4353
+ values (MutableSequence[google.cloud.sqladmin_v1.types.Value]):
4354
+ The values for the row.
4355
+ """
4356
+
4357
+ values: MutableSequence["Value"] = proto.RepeatedField(
4358
+ proto.MESSAGE,
4359
+ number=1,
4360
+ message="Value",
4361
+ )
4362
+
4363
+
4364
+ class Value(proto.Message):
4365
+ r"""The cell value of the table.
4366
+
4367
+ Attributes:
4368
+ value (str):
4369
+ The cell value in string format.
4370
+ null_value (bool):
4371
+ If cell value is null, then this flag will be
4372
+ set to true.
4373
+ """
4374
+
4375
+ value: str = proto.Field(
4376
+ proto.STRING,
4377
+ number=1,
4378
+ )
4379
+ null_value: bool = proto.Field(
4380
+ proto.BOOL,
4381
+ number=2,
4382
+ )
4383
+
4384
+
4385
+ class Metadata(proto.Message):
4386
+ r"""The additional metadata information regarding the execution
4387
+ of the SQL statements.
4388
+
4389
+ Attributes:
4390
+ sql_statement_execution_time (google.protobuf.duration_pb2.Duration):
4391
+ The time taken to execute the SQL statements.
4392
+ """
4393
+
4394
+ sql_statement_execution_time: duration_pb2.Duration = proto.Field(
4395
+ proto.MESSAGE,
4396
+ number=1,
4397
+ message=duration_pb2.Duration,
4398
+ )
4399
+
4400
+
4401
+ class SqlInstancesAcquireSsrsLeaseRequest(proto.Message):
4402
+ r"""Request to acquire a lease for SSRS.
4403
+
4404
+ Attributes:
4405
+ instance (str):
4406
+ Required. Cloud SQL instance ID. This doesn't
4407
+ include the project ID. It's composed of
4408
+ lowercase letters, numbers, and hyphens, and it
4409
+ must start with a letter. The total length must
4410
+ be 98 characters or less (Example:
4411
+
4412
+ instance-id).
4413
+ project (str):
4414
+ Required. Project ID of the project that
4415
+ contains the instance (Example: project-id).
4416
+ body (google.cloud.sqladmin_v1.types.InstancesAcquireSsrsLeaseRequest):
4417
+ Required. The request body.
4418
+ """
4419
+
4420
+ instance: str = proto.Field(
4421
+ proto.STRING,
4422
+ number=1,
4423
+ )
4424
+ project: str = proto.Field(
4425
+ proto.STRING,
4426
+ number=2,
4427
+ )
4428
+ body: "InstancesAcquireSsrsLeaseRequest" = proto.Field(
4429
+ proto.MESSAGE,
4430
+ number=100,
4431
+ message="InstancesAcquireSsrsLeaseRequest",
4432
+ )
4433
+
4434
+
4435
+ class SqlInstancesAcquireSsrsLeaseResponse(proto.Message):
4436
+ r"""Response for the acquire SSRS lease request.
4437
+
4438
+ Attributes:
4439
+ operation_id (str):
4440
+ The unique identifier for this operation.
4441
+ """
4442
+
4443
+ operation_id: str = proto.Field(
4444
+ proto.STRING,
4445
+ number=1,
4446
+ )
4447
+
4448
+
4449
+ class SqlInstancesReleaseSsrsLeaseRequest(proto.Message):
4450
+ r"""Request to release a lease for SSRS.
4451
+
4452
+ Attributes:
4453
+ instance (str):
4454
+ Required. The Cloud SQL instance ID. This
4455
+ doesn't include the project ID. The instance ID
4456
+ contains lowercase letters, numbers, and
4457
+ hyphens, and it must start with a letter. This
4458
+ ID can have a maximum length of 98 characters.
4459
+ project (str):
4460
+ Required. The project ID that contains the
4461
+ instance.
4462
+ """
4463
+
4464
+ instance: str = proto.Field(
4465
+ proto.STRING,
4466
+ number=1,
4467
+ )
4468
+ project: str = proto.Field(
4469
+ proto.STRING,
4470
+ number=2,
4471
+ )
4472
+
4473
+
4474
+ class SqlInstancesReleaseSsrsLeaseResponse(proto.Message):
4475
+ r"""Response for the release SSRS lease request.
4476
+
4477
+ Attributes:
4478
+ operation_id (str):
4479
+ The unique identifier for this operation.
4480
+ """
4481
+
4482
+ operation_id: str = proto.Field(
4483
+ proto.STRING,
4484
+ number=1,
4485
+ )
4486
+
4487
+
4488
+ class SqlInstancesPointInTimeRestoreRequest(proto.Message):
4489
+ r"""Request to perform a point in time restore on a Google Cloud
4490
+ Backup and Disaster Recovery managed instance.
4491
+
4492
+ Attributes:
4493
+ parent (str):
4494
+ Required. The parent resource where you
4495
+ created this instance. Format:
4496
+ projects/{project}
4497
+ context (google.cloud.sqladmin_v1.types.PointInTimeRestoreContext):
4498
+ Required. The context for request to perform
4499
+ a PITR on a Google Cloud Backup and Disaster
4500
+ Recovery managed instance.
4501
+ """
4502
+
4503
+ parent: str = proto.Field(
4504
+ proto.STRING,
4505
+ number=1,
4506
+ )
4507
+ context: "PointInTimeRestoreContext" = proto.Field(
4508
+ proto.MESSAGE,
4509
+ number=100,
4510
+ message="PointInTimeRestoreContext",
4511
+ )
4512
+
4513
+
4514
+ __all__ = tuple(sorted(__protobuf__.manifest))