oci 2.11.0 → 2.12.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (333) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -0
  3. data/lib/oci.rb +1 -0
  4. data/lib/oci/analytics/analytics_client.rb +15 -0
  5. data/lib/oci/announcements_service/announcement_client.rb +4 -0
  6. data/lib/oci/apigateway/api_gateway_client.rb +15 -0
  7. data/lib/oci/apigateway/deployment_client.rb +6 -0
  8. data/lib/oci/apigateway/gateway_client.rb +6 -0
  9. data/lib/oci/apigateway/work_requests_client.rb +5 -0
  10. data/lib/oci/application_migration/application_migration_client.rb +19 -0
  11. data/lib/oci/audit/audit_client.rb +4 -1
  12. data/lib/oci/audit/models/audit_event.rb +8 -7
  13. data/lib/oci/audit/models/data.rb +0 -107
  14. data/lib/oci/audit/models/identity.rb +0 -17
  15. data/lib/oci/audit/models/request.rb +0 -46
  16. data/lib/oci/audit/models/response.rb +0 -34
  17. data/lib/oci/audit/models/state_change.rb +0 -9
  18. data/lib/oci/auth/signers/ephemeral_resource_principals_signer.rb +0 -1
  19. data/lib/oci/auth/signers/resource_principals_signer.rb +1 -1
  20. data/lib/oci/autoscaling/auto_scaling_client.rb +11 -0
  21. data/lib/oci/bds/bds_client.rb +16 -0
  22. data/lib/oci/blockchain/blockchain.rb +1 -0
  23. data/lib/oci/blockchain/blockchain_platform_client.rb +57 -0
  24. data/lib/oci/blockchain/models/blockchain_platform.rb +36 -3
  25. data/lib/oci/blockchain/models/blockchain_platform_by_hostname.rb +1 -1
  26. data/lib/oci/blockchain/models/blockchain_platform_summary.rb +1 -1
  27. data/lib/oci/blockchain/models/create_blockchain_platform_details.rb +2 -2
  28. data/lib/oci/blockchain/models/scaled_blockchain_platform_preview.rb +1 -1
  29. data/lib/oci/blockchain/models/work_request.rb +1 -0
  30. data/lib/oci/blockchain/models/work_request_resource.rb +18 -4
  31. data/lib/oci/blockchain/models/work_request_resource_sub_type_detail.rb +206 -0
  32. data/lib/oci/blockchain/models/work_request_summary.rb +1 -0
  33. data/lib/oci/budget/budget_client.rb +10 -0
  34. data/lib/oci/cims/incident_client.rb +7 -0
  35. data/lib/oci/cims/user_client.rb +1 -0
  36. data/lib/oci/cloud_guard/cloud_guard_client.rb +82 -0
  37. data/lib/oci/cloud_guard/models/rule_summary.rb +1 -0
  38. data/lib/oci/compute_instance_agent/compute_instance_agent_client.rb +6 -0
  39. data/lib/oci/container_engine/container_engine_client.rb +18 -0
  40. data/lib/oci/core/blockstorage_client.rb +53 -0
  41. data/lib/oci/core/compute_client.rb +71 -0
  42. data/lib/oci/core/compute_management_client.rb +28 -0
  43. data/lib/oci/core/virtual_network_client.rb +194 -0
  44. data/lib/oci/data_catalog/data_catalog.rb +5 -0
  45. data/lib/oci/data_catalog/data_catalog_client.rb +307 -4
  46. data/lib/oci/data_catalog/models/attribute.rb +45 -4
  47. data/lib/oci/data_catalog/models/attribute_summary.rb +45 -4
  48. data/lib/oci/data_catalog/models/faceted_search_aggregation.rb +55 -4
  49. data/lib/oci/{database/models/create_autonomous_data_warehouse_backup_details.rb → data_catalog/models/rule_attribute.rb} +25 -18
  50. data/lib/oci/data_catalog/models/rule_collection.rb +161 -0
  51. data/lib/oci/data_catalog/models/rule_origin_type.rb +12 -0
  52. data/lib/oci/data_catalog/models/rule_summary.rb +439 -0
  53. data/lib/oci/data_catalog/models/rule_type.rb +12 -0
  54. data/lib/oci/data_catalog/models/search_result_collection.rb +18 -4
  55. data/lib/oci/data_flow/data_flow_client.rb +24 -0
  56. data/lib/oci/data_integration/data_integration_client.rb +92 -0
  57. data/lib/oci/data_safe/data_safe.rb +8 -0
  58. data/lib/oci/data_safe/data_safe_client.rb +606 -13
  59. data/lib/oci/data_safe/data_safe_client_composite_operations.rb +198 -0
  60. data/lib/oci/data_safe/models/change_on_prem_connector_compartment_details.rb +154 -0
  61. data/lib/oci/data_safe/models/create_data_safe_private_endpoint_details.rb +1 -1
  62. data/lib/oci/{database/models/update_autonomous_data_warehouse_details.rb → data_safe/models/create_on_prem_connector_details.rb} +27 -49
  63. data/lib/oci/data_safe/models/data_safe_configuration.rb +5 -5
  64. data/lib/oci/data_safe/models/data_safe_private_endpoint.rb +2 -2
  65. data/lib/oci/data_safe/models/data_safe_private_endpoint_summary.rb +1 -1
  66. data/lib/oci/data_safe/models/enable_data_safe_configuration_details.rb +6 -40
  67. data/lib/oci/{database/models/generate_autonomous_data_warehouse_wallet_details.rb → data_safe/models/generate_on_prem_connector_configuration_details.rb} +3 -4
  68. data/lib/oci/{database/models/autonomous_data_warehouse_backup_summary.rb → data_safe/models/on_prem_connector.rb} +98 -98
  69. data/lib/oci/data_safe/models/on_prem_connector_lifecycle_state.rb +16 -0
  70. data/lib/oci/{database/models/autonomous_data_warehouse_backup.rb → data_safe/models/on_prem_connector_summary.rb} +90 -99
  71. data/lib/oci/data_safe/models/service_list.rb +1 -0
  72. data/lib/oci/data_safe/models/update_data_safe_private_endpoint_details.rb +1 -1
  73. data/lib/oci/data_safe/models/update_on_prem_connector_details.rb +198 -0
  74. data/lib/oci/data_safe/models/update_on_prem_connector_wallet_details.rb +156 -0
  75. data/lib/oci/data_safe/models/work_request.rb +11 -6
  76. data/lib/oci/data_safe/models/work_request_error.rb +3 -4
  77. data/lib/oci/data_safe/models/work_request_log_entry.rb +3 -3
  78. data/lib/oci/data_safe/models/work_request_summary.rb +13 -8
  79. data/lib/oci/data_science/data_science_client.rb +34 -0
  80. data/lib/oci/database/database.rb +4 -8
  81. data/lib/oci/database/database_client.rb +523 -766
  82. data/lib/oci/database/database_client_composite_operations.rb +1299 -330
  83. data/lib/oci/database/models/activate_exadata_infrastructure_details.rb +2 -1
  84. data/lib/oci/database/models/autonomous_container_database.rb +3 -3
  85. data/lib/oci/database/models/autonomous_container_database_dataguard_association.rb +2 -2
  86. data/lib/oci/database/models/autonomous_container_database_summary.rb +3 -3
  87. data/lib/oci/database/models/autonomous_data_warehouse.rb +8 -21
  88. data/lib/oci/database/models/autonomous_data_warehouse_summary.rb +8 -21
  89. data/lib/oci/database/models/autonomous_database.rb +35 -3
  90. data/lib/oci/database/models/autonomous_database_apex.rb +169 -0
  91. data/lib/oci/database/models/autonomous_database_dataguard_association.rb +2 -2
  92. data/lib/oci/database/models/autonomous_database_summary.rb +35 -3
  93. data/lib/oci/database/models/autonomous_db_preview_version_summary.rb +2 -0
  94. data/lib/oci/database/models/autonomous_db_version_summary.rb +2 -0
  95. data/lib/oci/database/models/backup.rb +19 -5
  96. data/lib/oci/database/models/backup_summary.rb +19 -5
  97. data/lib/oci/database/models/change_cloud_exadata_infrastructure_compartment_details.rb +1 -1
  98. data/lib/oci/database/models/change_cloud_vm_cluster_compartment_details.rb +1 -1
  99. data/lib/oci/database/models/cloud_exadata_infrastructure.rb +2 -1
  100. data/lib/oci/database/models/cloud_exadata_infrastructure_summary.rb +2 -1
  101. data/lib/oci/database/models/cloud_vm_cluster.rb +1 -1
  102. data/lib/oci/database/models/cloud_vm_cluster_summary.rb +1 -1
  103. data/lib/oci/database/models/create_autonomous_container_database_details.rb +1 -1
  104. data/lib/oci/database/models/create_autonomous_database_base.rb +7 -3
  105. data/lib/oci/database/models/create_cloud_exadata_infrastructure_details.rb +1 -1
  106. data/lib/oci/database/models/create_cloud_vm_cluster_details.rb +2 -1
  107. data/lib/oci/database/models/create_database_base.rb +33 -4
  108. data/lib/oci/database/models/create_database_from_backup.rb +9 -1
  109. data/lib/oci/database/models/create_db_home_base.rb +30 -1
  110. data/lib/oci/database/models/create_db_home_with_db_system_id_details.rb +9 -1
  111. data/lib/oci/database/models/create_db_home_with_db_system_id_from_backup_details.rb +9 -1
  112. data/lib/oci/database/models/create_db_home_with_db_system_id_from_database_details.rb +9 -1
  113. data/lib/oci/database/models/create_db_home_with_vm_cluster_id_details.rb +9 -1
  114. data/lib/oci/database/models/create_db_home_with_vm_cluster_id_from_backup_details.rb +9 -1
  115. data/lib/oci/database/models/create_exadata_infrastructure_details.rb +16 -2
  116. data/lib/oci/database/models/create_new_database_details.rb +9 -1
  117. data/lib/oci/database/models/create_vm_cluster_details.rb +2 -1
  118. data/lib/oci/database/models/database.rb +16 -2
  119. data/lib/oci/database/models/database_summary.rb +16 -2
  120. data/lib/oci/database/models/db_home.rb +16 -2
  121. data/lib/oci/database/models/db_home_summary.rb +16 -2
  122. data/lib/oci/database/models/db_system.rb +16 -2
  123. data/lib/oci/database/models/db_system_summary.rb +16 -2
  124. data/lib/oci/database/models/exadata_db_system_migration.rb +1 -1
  125. data/lib/oci/database/models/exadata_db_system_migration_summary.rb +1 -1
  126. data/lib/oci/database/models/exadata_infrastructure.rb +15 -1
  127. data/lib/oci/database/models/exadata_infrastructure_summary.rb +18 -2
  128. data/lib/oci/database/models/flex_component_collection.rb +150 -0
  129. data/lib/oci/database/models/flex_component_summary.rb +197 -0
  130. data/lib/oci/database/models/generate_recommended_network_details.rb +1 -1
  131. data/lib/oci/database/models/launch_db_system_base.rb +30 -1
  132. data/lib/oci/database/models/launch_db_system_details.rb +9 -1
  133. data/lib/oci/database/models/launch_db_system_from_backup_details.rb +9 -1
  134. data/lib/oci/database/models/launch_db_system_from_database_details.rb +9 -1
  135. data/lib/oci/database/models/launch_db_system_from_db_system_details.rb +9 -1
  136. data/lib/oci/database/models/maintenance_run.rb +2 -1
  137. data/lib/oci/database/models/maintenance_run_summary.rb +2 -1
  138. data/lib/oci/database/models/migrate_vault_key_details.rb +170 -0
  139. data/lib/oci/database/models/update_autonomous_container_database_details.rb +1 -1
  140. data/lib/oci/database/models/update_autonomous_database_details.rb +6 -2
  141. data/lib/oci/database/models/update_cloud_exadata_infrastructure_details.rb +1 -1
  142. data/lib/oci/database/models/update_cloud_vm_cluster_details.rb +3 -2
  143. data/lib/oci/database/models/update_database_details.rb +1 -1
  144. data/lib/oci/database/models/update_details.rb +1 -1
  145. data/lib/oci/database/models/update_exadata_infrastructure_details.rb +16 -2
  146. data/lib/oci/database/models/update_history_entry_summary.rb +2 -1
  147. data/lib/oci/database/models/update_summary.rb +1 -1
  148. data/lib/oci/database/models/update_vm_cluster_details.rb +3 -1
  149. data/lib/oci/database/models/update_vm_cluster_network_details.rb +1 -1
  150. data/lib/oci/database/models/vm_cluster.rb +2 -1
  151. data/lib/oci/database/models/vm_cluster_network_details.rb +1 -1
  152. data/lib/oci/database/models/vm_cluster_network_summary.rb +2 -1
  153. data/lib/oci/database/models/vm_cluster_summary.rb +1 -0
  154. data/lib/oci/database/models/vm_network_details.rb +2 -1
  155. data/lib/oci/dns/dns_client.rb +49 -0
  156. data/lib/oci/dts/appliance_export_job_client.rb +6 -0
  157. data/lib/oci/dts/shipping_vendors_client.rb +1 -0
  158. data/lib/oci/dts/transfer_appliance_client.rb +8 -0
  159. data/lib/oci/dts/transfer_appliance_entitlement_client.rb +3 -0
  160. data/lib/oci/dts/transfer_device_client.rb +5 -0
  161. data/lib/oci/dts/transfer_job_client.rb +6 -0
  162. data/lib/oci/dts/transfer_package_client.rb +7 -0
  163. data/lib/oci/email/email_client.rb +10 -0
  164. data/lib/oci/events/events_client.rb +6 -0
  165. data/lib/oci/file_storage/file_storage_client.rb +25 -0
  166. data/lib/oci/functions/functions_invoke_client.rb +1 -0
  167. data/lib/oci/functions/functions_management_client.rb +11 -0
  168. data/lib/oci/healthchecks/health_checks_client.rb +17 -0
  169. data/lib/oci/identity/identity_client.rb +120 -0
  170. data/lib/oci/identity/models/saml2_identity_provider.rb +12 -1
  171. data/lib/oci/integration/integration.rb +3 -0
  172. data/lib/oci/integration/integration_instance_client.rb +12 -0
  173. data/lib/oci/integration/models/create_custom_endpoint_details.rb +167 -0
  174. data/lib/oci/integration/models/create_integration_instance_details.rb +44 -1
  175. data/lib/oci/integration/models/custom_endpoint_details.rb +180 -0
  176. data/lib/oci/integration/models/integration_instance.rb +43 -1
  177. data/lib/oci/integration/models/integration_instance_summary.rb +43 -1
  178. data/lib/oci/integration/models/update_custom_endpoint_details.rb +167 -0
  179. data/lib/oci/integration/models/update_integration_instance_details.rb +47 -4
  180. data/lib/oci/key_management/kms_crypto_client.rb +4 -0
  181. data/lib/oci/key_management/kms_management_client.rb +31 -0
  182. data/lib/oci/key_management/kms_vault_client.rb +11 -0
  183. data/lib/oci/limits/limits_client.rb +4 -0
  184. data/lib/oci/limits/quotas_client.rb +5 -0
  185. data/lib/oci/load_balancer/load_balancer.rb +1 -0
  186. data/lib/oci/load_balancer/load_balancer_client.rb +56 -0
  187. data/lib/oci/load_balancer/models/create_load_balancer_details.rb +16 -1
  188. data/lib/oci/load_balancer/models/load_balancer.rb +14 -1
  189. data/lib/oci/load_balancer/models/shape_details.rb +180 -0
  190. data/lib/oci/load_balancer/models/ssl_configuration.rb +1 -1
  191. data/lib/oci/load_balancer/models/ssl_configuration_details.rb +1 -1
  192. data/lib/oci/load_balancer/models/update_load_balancer_shape_details.rb +22 -4
  193. data/lib/oci/log_analytics/log_analytics_client.rb +126 -0
  194. data/lib/oci/logging/logging_management_client.rb +32 -0
  195. data/lib/oci/loggingingestion/logging_client.rb +1 -0
  196. data/lib/oci/loggingsearch/log_search_client.rb +1 -0
  197. data/lib/oci/management_agent/management_agent.rb +2 -0
  198. data/lib/oci/management_agent/management_agent_client.rb +101 -0
  199. data/lib/oci/management_agent/models/availability_history_summary.rb +217 -0
  200. data/lib/oci/management_agent/models/availability_status.rb +12 -0
  201. data/lib/oci/management_agent/models/management_agent.rb +35 -1
  202. data/lib/oci/management_agent/models/management_agent_summary.rb +49 -1
  203. data/lib/oci/management_dashboard/dashx_apis_client.rb +14 -0
  204. data/lib/oci/marketplace/marketplace_client.rb +16 -0
  205. data/lib/oci/monitoring/monitoring_client.rb +12 -0
  206. data/lib/oci/mysql/channels_client.rb +625 -0
  207. data/lib/oci/mysql/channels_client_composite_operations.rb +271 -0
  208. data/lib/oci/mysql/db_backups_client.rb +11 -0
  209. data/lib/oci/mysql/db_system_client.rb +17 -0
  210. data/lib/oci/mysql/models/backup.rb +16 -3
  211. data/lib/oci/mysql/models/backup_summary.rb +17 -3
  212. data/lib/oci/mysql/models/ca_certificate.rb +189 -0
  213. data/lib/oci/mysql/models/channel.rb +340 -0
  214. data/lib/oci/mysql/models/channel_source.rb +189 -0
  215. data/lib/oci/mysql/models/channel_source_mysql.rb +230 -0
  216. data/lib/oci/mysql/models/channel_summary.rb +304 -0
  217. data/lib/oci/mysql/models/channel_target.rb +189 -0
  218. data/lib/oci/mysql/models/channel_target_db_system.rb +193 -0
  219. data/lib/oci/mysql/models/configuration.rb +2 -2
  220. data/lib/oci/mysql/models/configuration_summary.rb +2 -2
  221. data/lib/oci/mysql/models/configuration_variables.rb +30 -15
  222. data/lib/oci/mysql/models/create_backup_details.rb +2 -2
  223. data/lib/oci/mysql/models/create_backup_policy_details.rb +3 -0
  224. data/lib/oci/mysql/models/create_channel_details.rb +248 -0
  225. data/lib/oci/mysql/models/create_channel_source_details.rb +170 -0
  226. data/lib/oci/mysql/models/create_channel_source_from_mysql_details.rb +224 -0
  227. data/lib/oci/mysql/models/create_channel_target_details.rb +170 -0
  228. data/lib/oci/mysql/models/create_channel_target_from_db_system_details.rb +193 -0
  229. data/lib/oci/mysql/models/create_configuration_details.rb +2 -3
  230. data/lib/oci/mysql/models/create_db_system_details.rb +1 -1
  231. data/lib/oci/mysql/models/create_db_system_source_details.rb +1 -0
  232. data/lib/oci/mysql/models/create_db_system_source_from_none_details.rb +146 -0
  233. data/lib/oci/mysql/models/db_system.rb +15 -3
  234. data/lib/oci/mysql/models/db_system_snapshot.rb +437 -0
  235. data/lib/oci/mysql/models/db_system_source.rb +1 -0
  236. data/lib/oci/mysql/models/db_system_source_from_none.rb +146 -0
  237. data/lib/oci/mysql/models/db_system_summary.rb +2 -2
  238. data/lib/oci/mysql/models/pem_ca_certificate.rb +158 -0
  239. data/lib/oci/mysql/models/update_backup_details.rb +2 -2
  240. data/lib/oci/mysql/models/update_backup_policy_details.rb +3 -0
  241. data/lib/oci/mysql/models/update_channel_details.rb +234 -0
  242. data/lib/oci/mysql/models/update_channel_source_details.rb +171 -0
  243. data/lib/oci/mysql/models/update_channel_source_from_mysql_details.rb +224 -0
  244. data/lib/oci/mysql/models/update_channel_target_details.rb +170 -0
  245. data/lib/oci/mysql/models/update_channel_target_from_db_system_details.rb +179 -0
  246. data/lib/oci/mysql/models/update_configuration_details.rb +2 -2
  247. data/lib/oci/mysql/mysql.rb +23 -0
  248. data/lib/oci/mysql/mysqlaas_client.rb +7 -0
  249. data/lib/oci/mysql/work_requests_client.rb +4 -0
  250. data/lib/oci/nosql/nosql_client.rb +22 -0
  251. data/lib/oci/object_storage/models/object_lifecycle_rule.rb +11 -9
  252. data/lib/oci/object_storage/object_storage_client.rb +55 -6
  253. data/lib/oci/oce/oce_instance_client.rb +10 -0
  254. data/lib/oci/ocvp/esxi_host_client.rb +5 -0
  255. data/lib/oci/ocvp/sddc_client.rb +7 -0
  256. data/lib/oci/ocvp/work_request_client.rb +4 -0
  257. data/lib/oci/oda/oda_client.rb +12 -0
  258. data/lib/oci/ons/notification_control_plane_client.rb +6 -0
  259. data/lib/oci/ons/notification_data_plane_client.rb +10 -0
  260. data/lib/oci/opsi/models/sql_insight_aggregation.rb +2 -1
  261. data/lib/oci/opsi/models/sql_insight_thresholds.rb +21 -4
  262. data/lib/oci/opsi/operations_insights_client.rb +22 -3
  263. data/lib/oci/optimizer/optimizer_client.rb +22 -0
  264. data/lib/oci/os_management/os_management_client.rb +53 -0
  265. data/lib/oci/regions.rb +3 -0
  266. data/lib/oci/resource_manager/models/configuration_source_provider.rb +5 -1
  267. data/lib/oci/resource_manager/models/configuration_source_provider_summary.rb +3 -1
  268. data/lib/oci/resource_manager/models/create_configuration_source_provider_details.rb +4 -1
  269. data/lib/oci/resource_manager/models/create_github_access_token_configuration_source_provider_details.rb +200 -0
  270. data/lib/oci/resource_manager/models/create_gitlab_access_token_configuration_source_provider_details.rb +3 -3
  271. data/lib/oci/resource_manager/models/github_access_token_configuration_source_provider.rb +198 -0
  272. data/lib/oci/resource_manager/models/github_access_token_configuration_source_provider_summary.rb +198 -0
  273. data/lib/oci/resource_manager/models/gitlab_access_token_configuration_source_provider.rb +2 -2
  274. data/lib/oci/resource_manager/models/gitlab_access_token_configuration_source_provider_summary.rb +2 -2
  275. data/lib/oci/resource_manager/models/update_configuration_source_provider_details.rb +4 -1
  276. data/lib/oci/resource_manager/models/update_github_access_token_configuration_source_provider_details.rb +196 -0
  277. data/lib/oci/resource_manager/models/update_gitlab_access_token_configuration_source_provider_details.rb +3 -3
  278. data/lib/oci/resource_manager/resource_manager.rb +4 -0
  279. data/lib/oci/resource_manager/resource_manager_client.rb +36 -2
  280. data/lib/oci/resource_search/resource_search_client.rb +3 -0
  281. data/lib/oci/rover/models/change_rover_cluster_compartment_details.rb +155 -0
  282. data/lib/oci/{database/models/autonomous_data_warehouse_console_token_details.rb → rover/models/change_rover_entitlement_compartment_details.rb} +13 -23
  283. data/lib/oci/rover/models/change_rover_node_compartment_details.rb +155 -0
  284. data/lib/oci/rover/models/create_rover_cluster_details.rb +459 -0
  285. data/lib/oci/rover/models/create_rover_entitlement_details.rb +320 -0
  286. data/lib/oci/rover/models/create_rover_node_details.rb +501 -0
  287. data/lib/oci/rover/models/enclosure_type.rb +11 -0
  288. data/lib/oci/rover/models/lifecycle_state.rb +15 -0
  289. data/lib/oci/rover/models/node_type.rb +11 -0
  290. data/lib/oci/rover/models/rover_cluster.rb +610 -0
  291. data/lib/oci/rover/models/rover_cluster_certificate.rb +150 -0
  292. data/lib/oci/{database/models/restore_autonomous_data_warehouse_details.rb → rover/models/rover_cluster_collection.rb} +11 -12
  293. data/lib/oci/{database/models/create_autonomous_data_warehouse_details.rb → rover/models/rover_cluster_summary.rb} +99 -84
  294. data/lib/oci/rover/models/rover_entitlement.rb +363 -0
  295. data/lib/oci/rover/models/rover_entitlement_collection.rb +150 -0
  296. data/lib/oci/rover/models/rover_entitlement_summary.rb +285 -0
  297. data/lib/oci/rover/models/rover_node.rb +661 -0
  298. data/lib/oci/rover/models/rover_node_action_set_key_details.rb +154 -0
  299. data/lib/oci/rover/models/rover_node_certificate.rb +150 -0
  300. data/lib/oci/rover/models/rover_node_collection.rb +150 -0
  301. data/lib/oci/rover/models/rover_node_encryption_key.rb +154 -0
  302. data/lib/oci/rover/models/rover_node_get_rpt.rb +168 -0
  303. data/lib/oci/rover/models/rover_node_set_key.rb +154 -0
  304. data/lib/oci/rover/models/rover_node_summary.rb +323 -0
  305. data/lib/oci/rover/models/rover_workload.rb +264 -0
  306. data/lib/oci/rover/models/shipping_address.rb +276 -0
  307. data/lib/oci/rover/models/sort_orders.rb +11 -0
  308. data/lib/oci/rover/models/update_rover_cluster_details.rb +445 -0
  309. data/lib/oci/rover/models/update_rover_entitlement_details.rb +306 -0
  310. data/lib/oci/rover/models/update_rover_node_details.rb +487 -0
  311. data/lib/oci/rover/rover.rb +54 -0
  312. data/lib/oci/rover/rover_cluster_client.rb +549 -0
  313. data/lib/oci/rover/rover_cluster_client_composite_operations.rb +144 -0
  314. data/lib/oci/rover/rover_entitlement_client.rb +514 -0
  315. data/lib/oci/rover/rover_entitlement_client_composite_operations.rb +144 -0
  316. data/lib/oci/rover/rover_node_client.rb +738 -0
  317. data/lib/oci/rover/rover_node_client_composite_operations.rb +144 -0
  318. data/lib/oci/rover/util.rb +3 -0
  319. data/lib/oci/sch/service_connector_client.rb +12 -0
  320. data/lib/oci/secrets/secrets_client.rb +2 -0
  321. data/lib/oci/streaming/stream_admin_client.rb +18 -0
  322. data/lib/oci/streaming/stream_client.rb +8 -0
  323. data/lib/oci/tenant_manager_control_plane/link_client.rb +3 -0
  324. data/lib/oci/tenant_manager_control_plane/recipient_invitation_client.rb +5 -0
  325. data/lib/oci/tenant_manager_control_plane/sender_invitation_client.rb +5 -0
  326. data/lib/oci/tenant_manager_control_plane/work_request_client.rb +4 -0
  327. data/lib/oci/usage_api/usageapi_client.rb +2 -0
  328. data/lib/oci/vault/vaults_client.rb +11 -0
  329. data/lib/oci/version.rb +1 -1
  330. data/lib/oci/waas/redirect_client.rb +6 -0
  331. data/lib/oci/waas/waas_client.rb +66 -0
  332. data/lib/oci/work_requests/work_request_client.rb +4 -0
  333. metadata +91 -10
@@ -123,6 +123,11 @@ require 'oci/data_catalog/models/pattern'
123
123
  require 'oci/data_catalog/models/pattern_collection'
124
124
  require 'oci/data_catalog/models/pattern_summary'
125
125
  require 'oci/data_catalog/models/property_definition'
126
+ require 'oci/data_catalog/models/rule_attribute'
127
+ require 'oci/data_catalog/models/rule_collection'
128
+ require 'oci/data_catalog/models/rule_origin_type'
129
+ require 'oci/data_catalog/models/rule_summary'
130
+ require 'oci/data_catalog/models/rule_type'
126
131
  require 'oci/data_catalog/models/search_criteria'
127
132
  require 'oci/data_catalog/models/search_result'
128
133
  require 'oci/data_catalog/models/search_result_collection'
@@ -119,6 +119,7 @@ module OCI
119
119
  # might be rejected.
120
120
  #
121
121
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::DataAsset DataAsset}
122
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/add_data_selector_patterns.rb.html) to see an example of how to use add_data_selector_patterns API.
122
123
  def add_data_selector_patterns(catalog_id, data_asset_key, data_selector_pattern_details, opts = {})
123
124
  logger.debug 'Calling operation DataCatalogClient#add_data_selector_patterns.' if logger
124
125
 
@@ -193,6 +194,7 @@ module OCI
193
194
  # might be rejected.
194
195
  #
195
196
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::Type Type}
197
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/associate_custom_property.rb.html) to see an example of how to use associate_custom_property API.
196
198
  def associate_custom_property(catalog_id, type_key, associate_custom_property_details, opts = {})
197
199
  logger.debug 'Calling operation DataCatalogClient#associate_custom_property.' if logger
198
200
 
@@ -265,6 +267,7 @@ module OCI
265
267
  # might be rejected.
266
268
  #
267
269
  # @return [Response] A Response object with data of type nil
270
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/attach_catalog_private_endpoint.rb.html) to see an example of how to use attach_catalog_private_endpoint API.
268
271
  def attach_catalog_private_endpoint(attach_catalog_private_endpoint_details, catalog_id, opts = {})
269
272
  logger.debug 'Calling operation DataCatalogClient#attach_catalog_private_endpoint.' if logger
270
273
 
@@ -328,6 +331,7 @@ module OCI
328
331
  #
329
332
  # @option opts [String] :opc_request_id The client request ID for tracing.
330
333
  # @return [Response] A Response object with data of type nil
334
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/change_catalog_compartment.rb.html) to see an example of how to use change_catalog_compartment API.
331
335
  def change_catalog_compartment(change_catalog_compartment_details, catalog_id, opts = {})
332
336
  logger.debug 'Calling operation DataCatalogClient#change_catalog_compartment.' if logger
333
337
 
@@ -389,6 +393,7 @@ module OCI
389
393
  #
390
394
  # @option opts [String] :opc_request_id The client request ID for tracing.
391
395
  # @return [Response] A Response object with data of type nil
396
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/change_catalog_private_endpoint_compartment.rb.html) to see an example of how to use change_catalog_private_endpoint_compartment API.
392
397
  def change_catalog_private_endpoint_compartment(change_catalog_private_endpoint_compartment_details, catalog_private_endpoint_id, opts = {})
393
398
  logger.debug 'Calling operation DataCatalogClient#change_catalog_private_endpoint_compartment.' if logger
394
399
 
@@ -452,6 +457,7 @@ module OCI
452
457
  # might be rejected.
453
458
  #
454
459
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::Attribute Attribute}
460
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/create_attribute.rb.html) to see an example of how to use create_attribute API.
455
461
  def create_attribute(catalog_id, data_asset_key, entity_key, create_attribute_details, opts = {})
456
462
  logger.debug 'Calling operation DataCatalogClient#create_attribute.' if logger
457
463
 
@@ -522,6 +528,7 @@ module OCI
522
528
  # might be rejected.
523
529
  #
524
530
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::AttributeTag AttributeTag}
531
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/create_attribute_tag.rb.html) to see an example of how to use create_attribute_tag API.
525
532
  def create_attribute_tag(catalog_id, data_asset_key, entity_key, attribute_key, create_attribute_tag_details, opts = {})
526
533
  logger.debug 'Calling operation DataCatalogClient#create_attribute_tag.' if logger
527
534
 
@@ -592,6 +599,7 @@ module OCI
592
599
  #
593
600
  # @option opts [String] :opc_request_id The client request ID for tracing.
594
601
  # @return [Response] A Response object with data of type nil
602
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/create_catalog.rb.html) to see an example of how to use create_catalog API.
595
603
  def create_catalog(create_catalog_details, opts = {})
596
604
  logger.debug 'Calling operation DataCatalogClient#create_catalog.' if logger
597
605
 
@@ -651,6 +659,7 @@ module OCI
651
659
  # might be rejected.
652
660
  #
653
661
  # @return [Response] A Response object with data of type nil
662
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/create_catalog_private_endpoint.rb.html) to see an example of how to use create_catalog_private_endpoint API.
654
663
  def create_catalog_private_endpoint(create_catalog_private_endpoint_details, opts = {})
655
664
  logger.debug 'Calling operation DataCatalogClient#create_catalog_private_endpoint.' if logger
656
665
 
@@ -712,6 +721,7 @@ module OCI
712
721
  # might be rejected.
713
722
  #
714
723
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::Connection Connection}
724
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/create_connection.rb.html) to see an example of how to use create_connection API.
715
725
  def create_connection(catalog_id, data_asset_key, create_connection_details, opts = {})
716
726
  logger.debug 'Calling operation DataCatalogClient#create_connection.' if logger
717
727
 
@@ -779,6 +789,7 @@ module OCI
779
789
  # might be rejected.
780
790
  #
781
791
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::CustomProperty CustomProperty}
792
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/create_custom_property.rb.html) to see an example of how to use create_custom_property API.
782
793
  def create_custom_property(catalog_id, namespace_id, create_custom_property_details, opts = {})
783
794
  logger.debug 'Calling operation DataCatalogClient#create_custom_property.' if logger
784
795
 
@@ -844,6 +855,7 @@ module OCI
844
855
  # might be rejected.
845
856
  #
846
857
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::DataAsset DataAsset}
858
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/create_data_asset.rb.html) to see an example of how to use create_data_asset API.
847
859
  def create_data_asset(catalog_id, create_data_asset_details, opts = {})
848
860
  logger.debug 'Calling operation DataCatalogClient#create_data_asset.' if logger
849
861
 
@@ -908,6 +920,7 @@ module OCI
908
920
  # might be rejected.
909
921
  #
910
922
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::DataAssetTag DataAssetTag}
923
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/create_data_asset_tag.rb.html) to see an example of how to use create_data_asset_tag API.
911
924
  def create_data_asset_tag(catalog_id, data_asset_key, create_data_asset_tag_details, opts = {})
912
925
  logger.debug 'Calling operation DataCatalogClient#create_data_asset_tag.' if logger
913
926
 
@@ -974,6 +987,7 @@ module OCI
974
987
  # might be rejected.
975
988
  #
976
989
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::Entity Entity}
990
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/create_entity.rb.html) to see an example of how to use create_entity API.
977
991
  def create_entity(catalog_id, data_asset_key, create_entity_details, opts = {})
978
992
  logger.debug 'Calling operation DataCatalogClient#create_entity.' if logger
979
993
 
@@ -1041,6 +1055,7 @@ module OCI
1041
1055
  # might be rejected.
1042
1056
  #
1043
1057
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::EntityTag EntityTag}
1058
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/create_entity_tag.rb.html) to see an example of how to use create_entity_tag API.
1044
1059
  def create_entity_tag(catalog_id, data_asset_key, entity_key, create_entity_tag_details, opts = {})
1045
1060
  logger.debug 'Calling operation DataCatalogClient#create_entity_tag.' if logger
1046
1061
 
@@ -1109,6 +1124,7 @@ module OCI
1109
1124
  # might be rejected.
1110
1125
  #
1111
1126
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::Folder Folder}
1127
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/create_folder.rb.html) to see an example of how to use create_folder API.
1112
1128
  def create_folder(catalog_id, data_asset_key, create_folder_details, opts = {})
1113
1129
  logger.debug 'Calling operation DataCatalogClient#create_folder.' if logger
1114
1130
 
@@ -1176,6 +1192,7 @@ module OCI
1176
1192
  # might be rejected.
1177
1193
  #
1178
1194
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::FolderTag FolderTag}
1195
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/create_folder_tag.rb.html) to see an example of how to use create_folder_tag API.
1179
1196
  def create_folder_tag(catalog_id, data_asset_key, folder_key, create_folder_tag_details, opts = {})
1180
1197
  logger.debug 'Calling operation DataCatalogClient#create_folder_tag.' if logger
1181
1198
 
@@ -1243,6 +1260,7 @@ module OCI
1243
1260
  # might be rejected.
1244
1261
  #
1245
1262
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::Glossary Glossary}
1263
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/create_glossary.rb.html) to see an example of how to use create_glossary API.
1246
1264
  def create_glossary(catalog_id, create_glossary_details, opts = {})
1247
1265
  logger.debug 'Calling operation DataCatalogClient#create_glossary.' if logger
1248
1266
 
@@ -1306,6 +1324,7 @@ module OCI
1306
1324
  # might be rejected.
1307
1325
  #
1308
1326
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::Job Job}
1327
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/create_job.rb.html) to see an example of how to use create_job API.
1309
1328
  def create_job(catalog_id, create_job_details, opts = {})
1310
1329
  logger.debug 'Calling operation DataCatalogClient#create_job.' if logger
1311
1330
 
@@ -1369,6 +1388,7 @@ module OCI
1369
1388
  # might be rejected.
1370
1389
  #
1371
1390
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::JobDefinition JobDefinition}
1391
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/create_job_definition.rb.html) to see an example of how to use create_job_definition API.
1372
1392
  def create_job_definition(catalog_id, create_job_definition_details, opts = {})
1373
1393
  logger.debug 'Calling operation DataCatalogClient#create_job_definition.' if logger
1374
1394
 
@@ -1433,6 +1453,7 @@ module OCI
1433
1453
  # might be rejected.
1434
1454
  #
1435
1455
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::JobExecution JobExecution}
1456
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/create_job_execution.rb.html) to see an example of how to use create_job_execution API.
1436
1457
  def create_job_execution(catalog_id, job_key, create_job_execution_details, opts = {})
1437
1458
  logger.debug 'Calling operation DataCatalogClient#create_job_execution.' if logger
1438
1459
 
@@ -1499,6 +1520,7 @@ module OCI
1499
1520
  # might be rejected.
1500
1521
  #
1501
1522
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::Namespace Namespace}
1523
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/create_namespace.rb.html) to see an example of how to use create_namespace API.
1502
1524
  def create_namespace(catalog_id, create_namespace_details, opts = {})
1503
1525
  logger.debug 'Calling operation DataCatalogClient#create_namespace.' if logger
1504
1526
 
@@ -1562,6 +1584,7 @@ module OCI
1562
1584
  # might be rejected.
1563
1585
  #
1564
1586
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::Pattern Pattern}
1587
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/create_pattern.rb.html) to see an example of how to use create_pattern API.
1565
1588
  def create_pattern(catalog_id, create_pattern_details, opts = {})
1566
1589
  logger.debug 'Calling operation DataCatalogClient#create_pattern.' if logger
1567
1590
 
@@ -1626,6 +1649,7 @@ module OCI
1626
1649
  # might be rejected.
1627
1650
  #
1628
1651
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::Term Term}
1652
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/create_term.rb.html) to see an example of how to use create_term API.
1629
1653
  def create_term(catalog_id, glossary_key, create_term_details, opts = {})
1630
1654
  logger.debug 'Calling operation DataCatalogClient#create_term.' if logger
1631
1655
 
@@ -1693,6 +1717,7 @@ module OCI
1693
1717
  # might be rejected.
1694
1718
  #
1695
1719
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::TermRelationship TermRelationship}
1720
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/create_term_relationship.rb.html) to see an example of how to use create_term_relationship API.
1696
1721
  def create_term_relationship(catalog_id, glossary_key, term_key, create_term_relationship_details, opts = {})
1697
1722
  logger.debug 'Calling operation DataCatalogClient#create_term_relationship.' if logger
1698
1723
 
@@ -1762,6 +1787,7 @@ module OCI
1762
1787
  #
1763
1788
  # @option opts [String] :opc_request_id The client request ID for tracing.
1764
1789
  # @return [Response] A Response object with data of type nil
1790
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/delete_attribute.rb.html) to see an example of how to use delete_attribute API.
1765
1791
  def delete_attribute(catalog_id, data_asset_key, entity_key, attribute_key, opts = {})
1766
1792
  logger.debug 'Calling operation DataCatalogClient#delete_attribute.' if logger
1767
1793
 
@@ -1831,6 +1857,7 @@ module OCI
1831
1857
  #
1832
1858
  # @option opts [String] :opc_request_id The client request ID for tracing.
1833
1859
  # @return [Response] A Response object with data of type nil
1860
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/delete_attribute_tag.rb.html) to see an example of how to use delete_attribute_tag API.
1834
1861
  def delete_attribute_tag(catalog_id, data_asset_key, entity_key, attribute_key, tag_key, opts = {})
1835
1862
  logger.debug 'Calling operation DataCatalogClient#delete_attribute_tag.' if logger
1836
1863
 
@@ -1898,6 +1925,7 @@ module OCI
1898
1925
  #
1899
1926
  # @option opts [String] :opc_request_id The client request ID for tracing.
1900
1927
  # @return [Response] A Response object with data of type nil
1928
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/delete_catalog.rb.html) to see an example of how to use delete_catalog API.
1901
1929
  def delete_catalog(catalog_id, opts = {})
1902
1930
  logger.debug 'Calling operation DataCatalogClient#delete_catalog.' if logger
1903
1931
 
@@ -1957,6 +1985,7 @@ module OCI
1957
1985
  #
1958
1986
  # @option opts [String] :opc_request_id The client request ID for tracing.
1959
1987
  # @return [Response] A Response object with data of type nil
1988
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/delete_catalog_private_endpoint.rb.html) to see an example of how to use delete_catalog_private_endpoint API.
1960
1989
  def delete_catalog_private_endpoint(catalog_private_endpoint_id, opts = {})
1961
1990
  logger.debug 'Calling operation DataCatalogClient#delete_catalog_private_endpoint.' if logger
1962
1991
 
@@ -2018,6 +2047,7 @@ module OCI
2018
2047
  #
2019
2048
  # @option opts [String] :opc_request_id The client request ID for tracing.
2020
2049
  # @return [Response] A Response object with data of type nil
2050
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/delete_connection.rb.html) to see an example of how to use delete_connection API.
2021
2051
  def delete_connection(catalog_id, data_asset_key, connection_key, opts = {})
2022
2052
  logger.debug 'Calling operation DataCatalogClient#delete_connection.' if logger
2023
2053
 
@@ -2083,6 +2113,7 @@ module OCI
2083
2113
  #
2084
2114
  # @option opts [String] :opc_request_id The client request ID for tracing.
2085
2115
  # @return [Response] A Response object with data of type nil
2116
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/delete_custom_property.rb.html) to see an example of how to use delete_custom_property API.
2086
2117
  def delete_custom_property(catalog_id, namespace_id, custom_property_key, opts = {})
2087
2118
  logger.debug 'Calling operation DataCatalogClient#delete_custom_property.' if logger
2088
2119
 
@@ -2147,6 +2178,7 @@ module OCI
2147
2178
  #
2148
2179
  # @option opts [String] :opc_request_id The client request ID for tracing.
2149
2180
  # @return [Response] A Response object with data of type nil
2181
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/delete_data_asset.rb.html) to see an example of how to use delete_data_asset API.
2150
2182
  def delete_data_asset(catalog_id, data_asset_key, opts = {})
2151
2183
  logger.debug 'Calling operation DataCatalogClient#delete_data_asset.' if logger
2152
2184
 
@@ -2210,6 +2242,7 @@ module OCI
2210
2242
  #
2211
2243
  # @option opts [String] :opc_request_id The client request ID for tracing.
2212
2244
  # @return [Response] A Response object with data of type nil
2245
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/delete_data_asset_tag.rb.html) to see an example of how to use delete_data_asset_tag API.
2213
2246
  def delete_data_asset_tag(catalog_id, data_asset_key, tag_key, opts = {})
2214
2247
  logger.debug 'Calling operation DataCatalogClient#delete_data_asset_tag.' if logger
2215
2248
 
@@ -2275,6 +2308,7 @@ module OCI
2275
2308
  #
2276
2309
  # @option opts [String] :opc_request_id The client request ID for tracing.
2277
2310
  # @return [Response] A Response object with data of type nil
2311
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/delete_entity.rb.html) to see an example of how to use delete_entity API.
2278
2312
  def delete_entity(catalog_id, data_asset_key, entity_key, opts = {})
2279
2313
  logger.debug 'Calling operation DataCatalogClient#delete_entity.' if logger
2280
2314
 
@@ -2341,6 +2375,7 @@ module OCI
2341
2375
  #
2342
2376
  # @option opts [String] :opc_request_id The client request ID for tracing.
2343
2377
  # @return [Response] A Response object with data of type nil
2378
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/delete_entity_tag.rb.html) to see an example of how to use delete_entity_tag API.
2344
2379
  def delete_entity_tag(catalog_id, data_asset_key, entity_key, tag_key, opts = {})
2345
2380
  logger.debug 'Calling operation DataCatalogClient#delete_entity_tag.' if logger
2346
2381
 
@@ -2408,6 +2443,7 @@ module OCI
2408
2443
  #
2409
2444
  # @option opts [String] :opc_request_id The client request ID for tracing.
2410
2445
  # @return [Response] A Response object with data of type nil
2446
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/delete_folder.rb.html) to see an example of how to use delete_folder API.
2411
2447
  def delete_folder(catalog_id, data_asset_key, folder_key, opts = {})
2412
2448
  logger.debug 'Calling operation DataCatalogClient#delete_folder.' if logger
2413
2449
 
@@ -2474,6 +2510,7 @@ module OCI
2474
2510
  #
2475
2511
  # @option opts [String] :opc_request_id The client request ID for tracing.
2476
2512
  # @return [Response] A Response object with data of type nil
2513
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/delete_folder_tag.rb.html) to see an example of how to use delete_folder_tag API.
2477
2514
  def delete_folder_tag(catalog_id, data_asset_key, folder_key, tag_key, opts = {})
2478
2515
  logger.debug 'Calling operation DataCatalogClient#delete_folder_tag.' if logger
2479
2516
 
@@ -2540,6 +2577,7 @@ module OCI
2540
2577
  #
2541
2578
  # @option opts [String] :opc_request_id The client request ID for tracing.
2542
2579
  # @return [Response] A Response object with data of type nil
2580
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/delete_glossary.rb.html) to see an example of how to use delete_glossary API.
2543
2581
  def delete_glossary(catalog_id, glossary_key, opts = {})
2544
2582
  logger.debug 'Calling operation DataCatalogClient#delete_glossary.' if logger
2545
2583
 
@@ -2602,6 +2640,7 @@ module OCI
2602
2640
  #
2603
2641
  # @option opts [String] :opc_request_id The client request ID for tracing.
2604
2642
  # @return [Response] A Response object with data of type nil
2643
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/delete_job.rb.html) to see an example of how to use delete_job API.
2605
2644
  def delete_job(catalog_id, job_key, opts = {})
2606
2645
  logger.debug 'Calling operation DataCatalogClient#delete_job.' if logger
2607
2646
 
@@ -2664,6 +2703,7 @@ module OCI
2664
2703
  #
2665
2704
  # @option opts [String] :opc_request_id The client request ID for tracing.
2666
2705
  # @return [Response] A Response object with data of type nil
2706
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/delete_job_definition.rb.html) to see an example of how to use delete_job_definition API.
2667
2707
  def delete_job_definition(catalog_id, job_definition_key, opts = {})
2668
2708
  logger.debug 'Calling operation DataCatalogClient#delete_job_definition.' if logger
2669
2709
 
@@ -2726,6 +2766,7 @@ module OCI
2726
2766
  #
2727
2767
  # @option opts [String] :opc_request_id The client request ID for tracing.
2728
2768
  # @return [Response] A Response object with data of type nil
2769
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/delete_namespace.rb.html) to see an example of how to use delete_namespace API.
2729
2770
  def delete_namespace(catalog_id, namespace_id, opts = {})
2730
2771
  logger.debug 'Calling operation DataCatalogClient#delete_namespace.' if logger
2731
2772
 
@@ -2788,6 +2829,7 @@ module OCI
2788
2829
  #
2789
2830
  # @option opts [String] :opc_request_id The client request ID for tracing.
2790
2831
  # @return [Response] A Response object with data of type nil
2832
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/delete_pattern.rb.html) to see an example of how to use delete_pattern API.
2791
2833
  def delete_pattern(catalog_id, pattern_key, opts = {})
2792
2834
  logger.debug 'Calling operation DataCatalogClient#delete_pattern.' if logger
2793
2835
 
@@ -2851,6 +2893,7 @@ module OCI
2851
2893
  #
2852
2894
  # @option opts [String] :opc_request_id The client request ID for tracing.
2853
2895
  # @return [Response] A Response object with data of type nil
2896
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/delete_term.rb.html) to see an example of how to use delete_term API.
2854
2897
  def delete_term(catalog_id, glossary_key, term_key, opts = {})
2855
2898
  logger.debug 'Calling operation DataCatalogClient#delete_term.' if logger
2856
2899
 
@@ -2917,6 +2960,7 @@ module OCI
2917
2960
  #
2918
2961
  # @option opts [String] :opc_request_id The client request ID for tracing.
2919
2962
  # @return [Response] A Response object with data of type nil
2963
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/delete_term_relationship.rb.html) to see an example of how to use delete_term_relationship API.
2920
2964
  def delete_term_relationship(catalog_id, glossary_key, term_key, term_relationship_key, opts = {})
2921
2965
  logger.debug 'Calling operation DataCatalogClient#delete_term_relationship.' if logger
2922
2966
 
@@ -2983,6 +3027,7 @@ module OCI
2983
3027
  #
2984
3028
  # @option opts [String] :opc_request_id The client request ID for tracing.
2985
3029
  # @return [Response] A Response object with data of type nil
3030
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/detach_catalog_private_endpoint.rb.html) to see an example of how to use detach_catalog_private_endpoint API.
2986
3031
  def detach_catalog_private_endpoint(detach_catalog_private_endpoint_details, catalog_id, opts = {})
2987
3032
  logger.debug 'Calling operation DataCatalogClient#detach_catalog_private_endpoint.' if logger
2988
3033
 
@@ -3052,6 +3097,7 @@ module OCI
3052
3097
  # might be rejected.
3053
3098
  #
3054
3099
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::Type Type}
3100
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/disassociate_custom_property.rb.html) to see an example of how to use disassociate_custom_property API.
3055
3101
  def disassociate_custom_property(catalog_id, type_key, disassociate_custom_property_details, opts = {})
3056
3102
  logger.debug 'Calling operation DataCatalogClient#disassociate_custom_property.' if logger
3057
3103
 
@@ -3118,6 +3164,7 @@ module OCI
3118
3164
  # might be rejected.
3119
3165
  #
3120
3166
  # @return [Response] A Response object with data of type Array<{OCI::DataCatalog::Models::GlossaryTreeElement GlossaryTreeElement}>
3167
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/expand_tree_for_glossary.rb.html) to see an example of how to use expand_tree_for_glossary API.
3121
3168
  def expand_tree_for_glossary(catalog_id, glossary_key, opts = {})
3122
3169
  logger.debug 'Calling operation DataCatalogClient#expand_tree_for_glossary.' if logger
3123
3170
 
@@ -3183,6 +3230,7 @@ module OCI
3183
3230
  # might be rejected.
3184
3231
  #
3185
3232
  # @return [Response] A Response object with data of type String
3233
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/export_glossary.rb.html) to see an example of how to use export_glossary API.
3186
3234
  def export_glossary(catalog_id, glossary_key, opts = {})
3187
3235
  logger.debug 'Calling operation DataCatalogClient#export_glossary.' if logger
3188
3236
 
@@ -3201,7 +3249,7 @@ module OCI
3201
3249
 
3202
3250
  # Header Params
3203
3251
  header_params = {}
3204
- header_params[:accept] = 'application/json, text/csv'
3252
+ header_params[:accept] = 'application/json, text/csv, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'
3205
3253
  header_params[:'content-type'] = 'application/json'
3206
3254
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
3207
3255
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
@@ -3247,6 +3295,7 @@ module OCI
3247
3295
  # Allowed values are: key, displayName, description, entityKey, lifecycleState, timeCreated, timeUpdated, createdById, updatedById, externalDataType, externalKey, isIncrementalData, isNullable, length, position, precision, scale, timeExternal, uri, properties, path, minCollectionCount, maxCollectionCount, datatypeEntityKey, externalDatatypeEntityKey, parentAttributeKey, externalParentAttributeKey
3248
3296
  # @option opts [String] :opc_request_id The client request ID for tracing.
3249
3297
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::Attribute Attribute}
3298
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/get_attribute.rb.html) to see an example of how to use get_attribute API.
3250
3299
  def get_attribute(catalog_id, data_asset_key, entity_key, attribute_key, opts = {})
3251
3300
  logger.debug 'Calling operation DataCatalogClient#get_attribute.' if logger
3252
3301
 
@@ -3324,6 +3373,7 @@ module OCI
3324
3373
  # Allowed values are: key, name, termKey, termPath, termDescription, lifecycleState, timeCreated, createdById, uri, attributeKey
3325
3374
  # @option opts [String] :opc_request_id The client request ID for tracing.
3326
3375
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::AttributeTag AttributeTag}
3376
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/get_attribute_tag.rb.html) to see an example of how to use get_attribute_tag API.
3327
3377
  def get_attribute_tag(catalog_id, data_asset_key, entity_key, attribute_key, tag_key, opts = {})
3328
3378
  logger.debug 'Calling operation DataCatalogClient#get_attribute_tag.' if logger
3329
3379
 
@@ -3396,6 +3446,7 @@ module OCI
3396
3446
  # retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry
3397
3447
  # @option opts [String] :opc_request_id The client request ID for tracing.
3398
3448
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::Catalog Catalog}
3449
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/get_catalog.rb.html) to see an example of how to use get_catalog API.
3399
3450
  def get_catalog(catalog_id, opts = {})
3400
3451
  logger.debug 'Calling operation DataCatalogClient#get_catalog.' if logger
3401
3452
 
@@ -3449,6 +3500,7 @@ module OCI
3449
3500
  # retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry
3450
3501
  # @option opts [String] :opc_request_id The client request ID for tracing.
3451
3502
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::CatalogPrivateEndpoint CatalogPrivateEndpoint}
3503
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/get_catalog_private_endpoint.rb.html) to see an example of how to use get_catalog_private_endpoint API.
3452
3504
  def get_catalog_private_endpoint(catalog_private_endpoint_id, opts = {})
3453
3505
  logger.debug 'Calling operation DataCatalogClient#get_catalog_private_endpoint.' if logger
3454
3506
 
@@ -3507,6 +3559,7 @@ module OCI
3507
3559
  # Allowed values are: key, displayName, description, dataAssetKey, typeKey, timeCreated, timeUpdated, createdById, updatedById, properties, externalKey, timeStatusUpdated, lifecycleState, isDefault, uri
3508
3560
  # @option opts [String] :opc_request_id The client request ID for tracing.
3509
3561
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::Connection Connection}
3562
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/get_connection.rb.html) to see an example of how to use get_connection API.
3510
3563
  def get_connection(catalog_id, data_asset_key, connection_key, opts = {})
3511
3564
  logger.debug 'Calling operation DataCatalogClient#get_connection.' if logger
3512
3565
 
@@ -3580,6 +3633,7 @@ module OCI
3580
3633
  # Allowed values are: key, displayName, description, dataType, namespaceName, lifecycleState, timeCreated, timeUpdated, createdById, updatedById, properties
3581
3634
  # @option opts [String] :opc_request_id The client request ID for tracing.
3582
3635
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::CustomProperty CustomProperty}
3636
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/get_custom_property.rb.html) to see an example of how to use get_custom_property API.
3583
3637
  def get_custom_property(catalog_id, namespace_id, custom_property_key, opts = {})
3584
3638
  logger.debug 'Calling operation DataCatalogClient#get_custom_property.' if logger
3585
3639
 
@@ -3652,6 +3706,7 @@ module OCI
3652
3706
  # Allowed values are: key, displayName, description, catalogId, externalKey, typeKey, lifecycleState, timeCreated, timeUpdated, createdById, updatedById, uri, properties
3653
3707
  # @option opts [String] :opc_request_id The client request ID for tracing.
3654
3708
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::DataAsset DataAsset}
3709
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/get_data_asset.rb.html) to see an example of how to use get_data_asset API.
3655
3710
  def get_data_asset(catalog_id, data_asset_key, opts = {})
3656
3711
  logger.debug 'Calling operation DataCatalogClient#get_data_asset.' if logger
3657
3712
 
@@ -3723,6 +3778,7 @@ module OCI
3723
3778
  # Allowed values are: key, name, termKey, termPath, termDescription, lifecycleState, timeCreated, createdById, uri, dataAssetKey
3724
3779
  # @option opts [String] :opc_request_id The client request ID for tracing.
3725
3780
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::DataAssetTag DataAssetTag}
3781
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/get_data_asset_tag.rb.html) to see an example of how to use get_data_asset_tag API.
3726
3782
  def get_data_asset_tag(catalog_id, data_asset_key, tag_key, opts = {})
3727
3783
  logger.debug 'Calling operation DataCatalogClient#get_data_asset_tag.' if logger
3728
3784
 
@@ -3796,6 +3852,7 @@ module OCI
3796
3852
  # Allowed values are: key, displayName, description, dataAssetKey, timeCreated, timeUpdated, createdById, updatedById, lifecycleState, externalKey, timeExternal, timeStatusUpdated, isLogical, isPartition, folderKey, folderName, typeKey, path, harvestStatus, lastJobKey, uri, properties
3797
3853
  # @option opts [String] :opc_request_id The client request ID for tracing.
3798
3854
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::Entity Entity}
3855
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/get_entity.rb.html) to see an example of how to use get_entity API.
3799
3856
  def get_entity(catalog_id, data_asset_key, entity_key, opts = {})
3800
3857
  logger.debug 'Calling operation DataCatalogClient#get_entity.' if logger
3801
3858
 
@@ -3870,6 +3927,7 @@ module OCI
3870
3927
  # Allowed values are: key, name, termKey, termPath, termDescription, lifecycleState, timeCreated, createdById, uri, entityKey
3871
3928
  # @option opts [String] :opc_request_id The client request ID for tracing.
3872
3929
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::EntityTag EntityTag}
3930
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/get_entity_tag.rb.html) to see an example of how to use get_entity_tag API.
3873
3931
  def get_entity_tag(catalog_id, data_asset_key, entity_key, tag_key, opts = {})
3874
3932
  logger.debug 'Calling operation DataCatalogClient#get_entity_tag.' if logger
3875
3933
 
@@ -3945,6 +4003,7 @@ module OCI
3945
4003
  # Allowed values are: key, displayName, description, parentFolderKey, path, dataAssetKey, properties, externalKey, timeCreated, timeUpdated, createdById, updatedById, timeExternal, lifecycleState, harvestStatus, lastJobKey, uri
3946
4004
  # @option opts [String] :opc_request_id The client request ID for tracing.
3947
4005
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::Folder Folder}
4006
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/get_folder.rb.html) to see an example of how to use get_folder API.
3948
4007
  def get_folder(catalog_id, data_asset_key, folder_key, opts = {})
3949
4008
  logger.debug 'Calling operation DataCatalogClient#get_folder.' if logger
3950
4009
 
@@ -4019,6 +4078,7 @@ module OCI
4019
4078
  # Allowed values are: key, name, termKey, termPath, termDescription, lifecycleState, timeCreated, createdById, uri, folderKey
4020
4079
  # @option opts [String] :opc_request_id The client request ID for tracing.
4021
4080
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::FolderTag FolderTag}
4081
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/get_folder_tag.rb.html) to see an example of how to use get_folder_tag API.
4022
4082
  def get_folder_tag(catalog_id, data_asset_key, folder_key, tag_key, opts = {})
4023
4083
  logger.debug 'Calling operation DataCatalogClient#get_folder_tag.' if logger
4024
4084
 
@@ -4093,6 +4153,7 @@ module OCI
4093
4153
  # Allowed values are: key, displayName, description, catalogId, lifecycleState, timeCreated, timeUpdated, createdById, updatedById, owner, workflowStatus, uri
4094
4154
  # @option opts [String] :opc_request_id The client request ID for tracing.
4095
4155
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::Glossary Glossary}
4156
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/get_glossary.rb.html) to see an example of how to use get_glossary API.
4096
4157
  def get_glossary(catalog_id, glossary_key, opts = {})
4097
4158
  logger.debug 'Calling operation DataCatalogClient#get_glossary.' if logger
4098
4159
 
@@ -4163,6 +4224,7 @@ module OCI
4163
4224
  # Allowed values are: key, displayName, description, catalogId, lifecycleState, timeCreated, timeUpdated, jobType, scheduleCronExpression, timeScheduleBegin, timeScheduleEnd, scheduleType, connectionKey, jobDefinitionKey, internalVersion, executionCount, timeOfLatestExecution, executions, createdById, updatedById, uri, jobDefinitionName, errorCode, errorMessage
4164
4225
  # @option opts [String] :opc_request_id The client request ID for tracing.
4165
4226
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::Job Job}
4227
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/get_job.rb.html) to see an example of how to use get_job API.
4166
4228
  def get_job(catalog_id, job_key, opts = {})
4167
4229
  logger.debug 'Calling operation DataCatalogClient#get_job.' if logger
4168
4230
 
@@ -4233,6 +4295,7 @@ module OCI
4233
4295
  # Allowed values are: key, displayName, description, catalogId, jobType, isIncremental, dataAssetKey, connectionKey, internalVersion, lifecycleState, timeCreated, timeUpdated, createdById, updatedById, uri, isSampleDataExtracted, sampleDataSizeInMBs, timeLatestExecutionStarted, timeLatestExecutionEnded, jobExecutionState, scheduleType, properties
4234
4296
  # @option opts [String] :opc_request_id The client request ID for tracing.
4235
4297
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::JobDefinition JobDefinition}
4298
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/get_job_definition.rb.html) to see an example of how to use get_job_definition API.
4236
4299
  def get_job_definition(catalog_id, job_definition_key, opts = {})
4237
4300
  logger.debug 'Calling operation DataCatalogClient#get_job_definition.' if logger
4238
4301
 
@@ -4304,6 +4367,7 @@ module OCI
4304
4367
  # Allowed values are: key, jobKey, jobType, subType, parentKey, scheduleInstanceKey, lifecycleState, timeCreated, timeStarted, timeEnded, errorCode, errorMessage, processKey, externalUrl, eventKey, dataEntityKey, createdById, updatedById, properties, uri
4305
4368
  # @option opts [String] :opc_request_id The client request ID for tracing.
4306
4369
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::JobExecution JobExecution}
4370
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/get_job_execution.rb.html) to see an example of how to use get_job_execution API.
4307
4371
  def get_job_execution(catalog_id, job_key, job_execution_key, opts = {})
4308
4372
  logger.debug 'Calling operation DataCatalogClient#get_job_execution.' if logger
4309
4373
 
@@ -4378,6 +4442,7 @@ module OCI
4378
4442
  # Allowed values are: key, jobExecutionKey, createdById, updatedById, timeUpdated, timeCreated, severity, logMessage, uri
4379
4443
  # @option opts [String] :opc_request_id The client request ID for tracing.
4380
4444
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::JobLog JobLog}
4445
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/get_job_log.rb.html) to see an example of how to use get_job_log API.
4381
4446
  def get_job_log(catalog_id, job_key, job_execution_key, job_log_key, opts = {})
4382
4447
  logger.debug 'Calling operation DataCatalogClient#get_job_log.' if logger
4383
4448
 
@@ -4454,6 +4519,7 @@ module OCI
4454
4519
  # Allowed values are: key, description, displayName, timeInserted, category, subCategory, unit, value, batchKey, jobExecutionKey, createdById, updatedById, timeUpdated, timeCreated, uri
4455
4520
  # @option opts [String] :opc_request_id The client request ID for tracing.
4456
4521
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::JobMetric JobMetric}
4522
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/get_job_metrics.rb.html) to see an example of how to use get_job_metrics API.
4457
4523
  def get_job_metrics(catalog_id, job_key, job_execution_key, job_metrics_key, opts = {})
4458
4524
  logger.debug 'Calling operation DataCatalogClient#get_job_metrics.' if logger
4459
4525
 
@@ -4528,6 +4594,7 @@ module OCI
4528
4594
  # Allowed values are: key, displayName, description, lifecycleState, timeCreated, timeUpdated, createdById, updatedById, properties
4529
4595
  # @option opts [String] :opc_request_id The client request ID for tracing.
4530
4596
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::Namespace Namespace}
4597
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/get_namespace.rb.html) to see an example of how to use get_namespace API.
4531
4598
  def get_namespace(catalog_id, namespace_id, opts = {})
4532
4599
  logger.debug 'Calling operation DataCatalogClient#get_namespace.' if logger
4533
4600
 
@@ -4598,6 +4665,7 @@ module OCI
4598
4665
  # Allowed values are: key, displayName, description, catalogId, expression, lifecycleState, timeCreated, timeUpdated, createdById, updatedById, properties
4599
4666
  # @option opts [String] :opc_request_id The client request ID for tracing.
4600
4667
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::Pattern Pattern}
4668
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/get_pattern.rb.html) to see an example of how to use get_pattern API.
4601
4669
  def get_pattern(catalog_id, pattern_key, opts = {})
4602
4670
  logger.debug 'Calling operation DataCatalogClient#get_pattern.' if logger
4603
4671
 
@@ -4669,6 +4737,7 @@ module OCI
4669
4737
  # Allowed values are: key, displayName, description, glossaryKey, parentTermKey, isAllowedToHaveChildTerms, path, lifecycleState, timeCreated, timeUpdated, createdById, updatedById, owner, workflowStatus, uri, relatedTerms, associatedObjectCount, associatedObjects
4670
4738
  # @option opts [String] :opc_request_id The client request ID for tracing.
4671
4739
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::Term Term}
4740
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/get_term.rb.html) to see an example of how to use get_term API.
4672
4741
  def get_term(catalog_id, glossary_key, term_key, opts = {})
4673
4742
  logger.debug 'Calling operation DataCatalogClient#get_term.' if logger
4674
4743
 
@@ -4743,6 +4812,7 @@ module OCI
4743
4812
  # Allowed values are: key, displayName, description, relatedTermKey, relatedTermDisplayName, parentTermKey, parentTermDisplayName, lifecycleState, timeCreated, uri
4744
4813
  # @option opts [String] :opc_request_id The client request ID for tracing.
4745
4814
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::TermRelationship TermRelationship}
4815
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/get_term_relationship.rb.html) to see an example of how to use get_term_relationship API.
4746
4816
  def get_term_relationship(catalog_id, glossary_key, term_key, term_relationship_key, opts = {})
4747
4817
  logger.debug 'Calling operation DataCatalogClient#get_term_relationship.' if logger
4748
4818
 
@@ -4817,6 +4887,7 @@ module OCI
4817
4887
  # Allowed values are: key, description, name, catalogId, properties, isInternal, isTag, isApproved, typeCategory, externalTypeName, lifecycleState, uri
4818
4888
  # @option opts [String] :opc_request_id The client request ID for tracing.
4819
4889
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::Type Type}
4890
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/get_type.rb.html) to see an example of how to use get_type API.
4820
4891
  def get_type(catalog_id, type_key, opts = {})
4821
4892
  logger.debug 'Calling operation DataCatalogClient#get_type.' if logger
4822
4893
 
@@ -4883,6 +4954,7 @@ module OCI
4883
4954
  # retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry
4884
4955
  # @option opts [String] :opc_request_id The client request ID for tracing.
4885
4956
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::WorkRequest WorkRequest}
4957
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/get_work_request.rb.html) to see an example of how to use get_work_request API.
4886
4958
  def get_work_request(work_request_id, opts = {})
4887
4959
  logger.debug 'Calling operation DataCatalogClient#get_work_request.' if logger
4888
4960
 
@@ -4950,6 +5022,7 @@ module OCI
4950
5022
  # might be rejected.
4951
5023
  #
4952
5024
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::Connection Connection}
5025
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/import_connection.rb.html) to see an example of how to use import_connection API.
4953
5026
  def import_connection(catalog_id, data_asset_key, import_connection_details, opts = {})
4954
5027
  logger.debug 'Calling operation DataCatalogClient#import_connection.' if logger
4955
5028
 
@@ -5018,6 +5091,7 @@ module OCI
5018
5091
  # might be rejected.
5019
5092
  #
5020
5093
  # @return [Response] A Response object with data of type nil
5094
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/import_glossary.rb.html) to see an example of how to use import_glossary API.
5021
5095
  def import_glossary(catalog_id, glossary_key, import_glossary_details, opts = {})
5022
5096
  logger.debug 'Calling operation DataCatalogClient#import_glossary.' if logger
5023
5097
 
@@ -5079,8 +5153,20 @@ module OCI
5079
5153
  # @option opts [Array<String>] :fields Specifies the fields to return in an entity response.
5080
5154
  #
5081
5155
  # Allowed values are: key, displayName, description, dataAssetKey, timeCreated, timeUpdated, createdById, updatedById, lifecycleState, externalKey, timeExternal, timeStatusUpdated, isLogical, isPartition, folderKey, folderName, typeKey, path, harvestStatus, lastJobKey, uri, properties
5156
+ # @option opts [String] :display_name_contains A filter to return only resources that match display name pattern given. The match is not case sensitive.
5157
+ # For Example : /folders?displayNameContains=Cu.*
5158
+ # The above would match all folders with display name that starts with \"Cu\".
5159
+ #
5160
+ # @option opts [String] :sort_by The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.
5161
+ #
5162
+ # Allowed values are: TIMECREATED, DISPLAYNAME
5163
+ # @option opts [String] :sort_order The sort order to use, either 'asc' or 'desc'.
5164
+ # Allowed values are: ASC, DESC
5165
+ # @option opts [Integer] :limit The maximum number of items to return.
5166
+ # @option opts [String] :page The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
5082
5167
  # @option opts [String] :opc_request_id The client request ID for tracing.
5083
5168
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::EntityCollection EntityCollection}
5169
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/list_aggregated_physical_entities.rb.html) to see an example of how to use list_aggregated_physical_entities API.
5084
5170
  def list_aggregated_physical_entities(catalog_id, data_asset_key, entity_key, opts = {})
5085
5171
  logger.debug 'Calling operation DataCatalogClient#list_aggregated_physical_entities.' if logger
5086
5172
 
@@ -5097,6 +5183,14 @@ module OCI
5097
5183
  end
5098
5184
  end
5099
5185
  end
5186
+
5187
+ if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by])
5188
+ raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.'
5189
+ end
5190
+
5191
+ if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
5192
+ raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
5193
+ end
5100
5194
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
5101
5195
  raise "Parameter value for 'data_asset_key' must not be blank" if OCI::Internal::Util.blank_string?(data_asset_key)
5102
5196
  raise "Parameter value for 'entity_key' must not be blank" if OCI::Internal::Util.blank_string?(entity_key)
@@ -5108,6 +5202,11 @@ module OCI
5108
5202
  # Query Params
5109
5203
  query_params = {}
5110
5204
  query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty?
5205
+ query_params[:displayNameContains] = opts[:display_name_contains] if opts[:display_name_contains]
5206
+ query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
5207
+ query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
5208
+ query_params[:limit] = opts[:limit] if opts[:limit]
5209
+ query_params[:page] = opts[:page] if opts[:page]
5111
5210
 
5112
5211
  # Header Params
5113
5212
  header_params = {}
@@ -5168,6 +5267,7 @@ module OCI
5168
5267
  # @option opts [String] :page The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
5169
5268
  # @option opts [String] :opc_request_id The client request ID for tracing.
5170
5269
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::AttributeTagCollection AttributeTagCollection}
5270
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/list_attribute_tags.rb.html) to see an example of how to use list_attribute_tags API.
5171
5271
  def list_attribute_tags(catalog_id, data_asset_key, entity_key, attribute_key, opts = {})
5172
5272
  logger.debug 'Calling operation DataCatalogClient#list_attribute_tags.' if logger
5173
5273
 
@@ -5291,6 +5391,7 @@ module OCI
5291
5391
  # @option opts [String] :page The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
5292
5392
  # @option opts [String] :opc_request_id The client request ID for tracing.
5293
5393
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::AttributeCollection AttributeCollection}
5394
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/list_attributes.rb.html) to see an example of how to use list_attributes API.
5294
5395
  def list_attributes(catalog_id, data_asset_key, entity_key, opts = {})
5295
5396
  logger.debug 'Calling operation DataCatalogClient#list_attributes.' if logger
5296
5397
 
@@ -5401,6 +5502,7 @@ module OCI
5401
5502
  # Allowed values are: TIMECREATED, DISPLAYNAME
5402
5503
  # @option opts [String] :opc_request_id The client request ID for tracing.
5403
5504
  # @return [Response] A Response object with data of type Array<{OCI::DataCatalog::Models::CatalogPrivateEndpointSummary CatalogPrivateEndpointSummary}>
5505
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/list_catalog_private_endpoints.rb.html) to see an example of how to use list_catalog_private_endpoints API.
5404
5506
  def list_catalog_private_endpoints(compartment_id, opts = {})
5405
5507
  logger.debug 'Calling operation DataCatalogClient#list_catalog_private_endpoints.' if logger
5406
5508
 
@@ -5482,6 +5584,7 @@ module OCI
5482
5584
  # Allowed values are: TIMECREATED, DISPLAYNAME
5483
5585
  # @option opts [String] :opc_request_id The client request ID for tracing.
5484
5586
  # @return [Response] A Response object with data of type Array<{OCI::DataCatalog::Models::CatalogSummary CatalogSummary}>
5587
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/list_catalogs.rb.html) to see an example of how to use list_catalogs API.
5485
5588
  def list_catalogs(compartment_id, opts = {})
5486
5589
  logger.debug 'Calling operation DataCatalogClient#list_catalogs.' if logger
5487
5590
 
@@ -5577,6 +5680,7 @@ module OCI
5577
5680
  # @option opts [String] :page The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
5578
5681
  # @option opts [String] :opc_request_id The client request ID for tracing.
5579
5682
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::ConnectionCollection ConnectionCollection}
5683
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/list_connections.rb.html) to see an example of how to use list_connections API.
5580
5684
  def list_connections(catalog_id, data_asset_key, opts = {})
5581
5685
  logger.debug 'Calling operation DataCatalogClient#list_connections.' if logger
5582
5686
 
@@ -5677,7 +5781,7 @@ module OCI
5677
5781
  #
5678
5782
  # Allowed values are: TEXT, RICH_TEXT, BOOLEAN, NUMBER, DATE
5679
5783
  # @option opts [Array<String>] :type_name A filter to return only resources that match the entire type name given. The match is not case sensitive
5680
- # Allowed values are: DATA_ASSET, AUTONOMOUS_DATA_WAREHOUSE, HIVE, KAFKA, MYSQL, ORACLE_OBJECT_STORAGE, AUTONOMOUS_TRANSACTION_PROCESSING, ORACLE, POSTGRESQL, MICROSOFT_AZURE_SQL_DATABASE, MICROSOFT_SQL_SERVER, IBM_DB2, DATA_ENTITY, LOGICAL_ENTITY, TABLE, VIEW, ATTRIBUTE, FOLDER, CONNECTION, GLOSSARY, TERM, CATEGORY, FILE, BUCKET
5784
+ # Allowed values are: DATA_ASSET, AUTONOMOUS_DATA_WAREHOUSE, HIVE, KAFKA, MYSQL, ORACLE_OBJECT_STORAGE, AUTONOMOUS_TRANSACTION_PROCESSING, ORACLE, POSTGRESQL, MICROSOFT_AZURE_SQL_DATABASE, MICROSOFT_SQL_SERVER, IBM_DB2, DATA_ENTITY, LOGICAL_ENTITY, TABLE, VIEW, ATTRIBUTE, FOLDER, CONNECTION, GLOSSARY, TERM, CATEGORY, FILE, BUCKET, MESSAGE, UNRECOGNIZED_FILE
5681
5785
  # @option opts [String] :lifecycle_state A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
5682
5786
  # @option opts [DateTime] :time_created Time that the resource was created. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string.
5683
5787
  # @option opts [DateTime] :time_updated Time that the resource was updated. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string.
@@ -5695,6 +5799,7 @@ module OCI
5695
5799
  # @option opts [String] :page The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
5696
5800
  # @option opts [String] :opc_request_id The client request ID for tracing.
5697
5801
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::CustomPropertyCollection CustomPropertyCollection}
5802
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/list_custom_properties.rb.html) to see an example of how to use list_custom_properties API.
5698
5803
  def list_custom_properties(catalog_id, namespace_id, opts = {})
5699
5804
  logger.debug 'Calling operation DataCatalogClient#list_custom_properties.' if logger
5700
5805
 
@@ -5712,11 +5817,11 @@ module OCI
5712
5817
  end
5713
5818
 
5714
5819
 
5715
- type_name_allowable_values = %w[DATA_ASSET AUTONOMOUS_DATA_WAREHOUSE HIVE KAFKA MYSQL ORACLE_OBJECT_STORAGE AUTONOMOUS_TRANSACTION_PROCESSING ORACLE POSTGRESQL MICROSOFT_AZURE_SQL_DATABASE MICROSOFT_SQL_SERVER IBM_DB2 DATA_ENTITY LOGICAL_ENTITY TABLE VIEW ATTRIBUTE FOLDER CONNECTION GLOSSARY TERM CATEGORY FILE BUCKET]
5820
+ type_name_allowable_values = %w[DATA_ASSET AUTONOMOUS_DATA_WAREHOUSE HIVE KAFKA MYSQL ORACLE_OBJECT_STORAGE AUTONOMOUS_TRANSACTION_PROCESSING ORACLE POSTGRESQL MICROSOFT_AZURE_SQL_DATABASE MICROSOFT_SQL_SERVER IBM_DB2 DATA_ENTITY LOGICAL_ENTITY TABLE VIEW ATTRIBUTE FOLDER CONNECTION GLOSSARY TERM CATEGORY FILE BUCKET MESSAGE UNRECOGNIZED_FILE]
5716
5821
  if opts[:type_name] && !opts[:type_name].empty?
5717
5822
  opts[:type_name].each do |val_to_check|
5718
5823
  unless type_name_allowable_values.include?(val_to_check)
5719
- raise 'Invalid value for "type_name", must be one of DATA_ASSET, AUTONOMOUS_DATA_WAREHOUSE, HIVE, KAFKA, MYSQL, ORACLE_OBJECT_STORAGE, AUTONOMOUS_TRANSACTION_PROCESSING, ORACLE, POSTGRESQL, MICROSOFT_AZURE_SQL_DATABASE, MICROSOFT_SQL_SERVER, IBM_DB2, DATA_ENTITY, LOGICAL_ENTITY, TABLE, VIEW, ATTRIBUTE, FOLDER, CONNECTION, GLOSSARY, TERM, CATEGORY, FILE, BUCKET.'
5824
+ raise 'Invalid value for "type_name", must be one of DATA_ASSET, AUTONOMOUS_DATA_WAREHOUSE, HIVE, KAFKA, MYSQL, ORACLE_OBJECT_STORAGE, AUTONOMOUS_TRANSACTION_PROCESSING, ORACLE, POSTGRESQL, MICROSOFT_AZURE_SQL_DATABASE, MICROSOFT_SQL_SERVER, IBM_DB2, DATA_ENTITY, LOGICAL_ENTITY, TABLE, VIEW, ATTRIBUTE, FOLDER, CONNECTION, GLOSSARY, TERM, CATEGORY, FILE, BUCKET, MESSAGE, UNRECOGNIZED_FILE.'
5720
5825
  end
5721
5826
  end
5722
5827
  end
@@ -5823,6 +5928,7 @@ module OCI
5823
5928
  # @option opts [String] :page The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
5824
5929
  # @option opts [String] :opc_request_id The client request ID for tracing.
5825
5930
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::DataAssetTagCollection DataAssetTagCollection}
5931
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/list_data_asset_tags.rb.html) to see an example of how to use list_data_asset_tags API.
5826
5932
  def list_data_asset_tags(catalog_id, data_asset_key, opts = {})
5827
5933
  logger.debug 'Calling operation DataCatalogClient#list_data_asset_tags.' if logger
5828
5934
 
@@ -5933,6 +6039,7 @@ module OCI
5933
6039
  # @option opts [String] :page The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
5934
6040
  # @option opts [String] :opc_request_id The client request ID for tracing.
5935
6041
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::DataAssetCollection DataAssetCollection}
6042
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/list_data_assets.rb.html) to see an example of how to use list_data_assets API.
5936
6043
  def list_data_assets(catalog_id, opts = {})
5937
6044
  logger.debug 'Calling operation DataCatalogClient#list_data_assets.' if logger
5938
6045
 
@@ -6021,6 +6128,17 @@ module OCI
6021
6128
  # @param [Hash] opts the optional parameters
6022
6129
  # @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level
6023
6130
  # retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry
6131
+ # @option opts [String] :display_name_contains A filter to return only resources that match display name pattern given. The match is not case sensitive.
6132
+ # For Example : /folders?displayNameContains=Cu.*
6133
+ # The above would match all folders with display name that starts with \"Cu\".
6134
+ #
6135
+ # @option opts [String] :sort_by The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.
6136
+ #
6137
+ # Allowed values are: TIMECREATED, DISPLAYNAME
6138
+ # @option opts [String] :sort_order The sort order to use, either 'asc' or 'desc'.
6139
+ # Allowed values are: ASC, DESC
6140
+ # @option opts [Integer] :limit The maximum number of items to return.
6141
+ # @option opts [String] :page The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
6024
6142
  # @option opts [String] :opc_request_id The client request ID for tracing.
6025
6143
  # @option opts [String] :if_match For optimistic concurrency control. In the PUT or DELETE call
6026
6144
  # for a resource, set the `if-match` parameter to the value of the
@@ -6035,11 +6153,20 @@ module OCI
6035
6153
  # might be rejected.
6036
6154
  #
6037
6155
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::EntityCollection EntityCollection}
6156
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/list_derived_logical_entities.rb.html) to see an example of how to use list_derived_logical_entities API.
6038
6157
  def list_derived_logical_entities(catalog_id, pattern_key, opts = {})
6039
6158
  logger.debug 'Calling operation DataCatalogClient#list_derived_logical_entities.' if logger
6040
6159
 
6041
6160
  raise "Missing the required parameter 'catalog_id' when calling list_derived_logical_entities." if catalog_id.nil?
6042
6161
  raise "Missing the required parameter 'pattern_key' when calling list_derived_logical_entities." if pattern_key.nil?
6162
+
6163
+ if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by])
6164
+ raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.'
6165
+ end
6166
+
6167
+ if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
6168
+ raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
6169
+ end
6043
6170
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
6044
6171
  raise "Parameter value for 'pattern_key' must not be blank" if OCI::Internal::Util.blank_string?(pattern_key)
6045
6172
 
@@ -6049,6 +6176,11 @@ module OCI
6049
6176
  # rubocop:disable Style/NegatedIf
6050
6177
  # Query Params
6051
6178
  query_params = {}
6179
+ query_params[:displayNameContains] = opts[:display_name_contains] if opts[:display_name_contains]
6180
+ query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
6181
+ query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
6182
+ query_params[:limit] = opts[:limit] if opts[:limit]
6183
+ query_params[:page] = opts[:page] if opts[:page]
6052
6184
 
6053
6185
  # Header Params
6054
6186
  header_params = {}
@@ -6125,6 +6257,7 @@ module OCI
6125
6257
  # @option opts [String] :page The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
6126
6258
  # @option opts [String] :opc_request_id The client request ID for tracing.
6127
6259
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::EntityCollection EntityCollection}
6260
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/list_entities.rb.html) to see an example of how to use list_entities API.
6128
6261
  def list_entities(catalog_id, data_asset_key, opts = {})
6129
6262
  logger.debug 'Calling operation DataCatalogClient#list_entities.' if logger
6130
6263
 
@@ -6246,6 +6379,7 @@ module OCI
6246
6379
  # @option opts [String] :page The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
6247
6380
  # @option opts [String] :opc_request_id The client request ID for tracing.
6248
6381
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::EntityTagCollection EntityTagCollection}
6382
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/list_entity_tags.rb.html) to see an example of how to use list_entity_tags API.
6249
6383
  def list_entity_tags(catalog_id, data_asset_key, entity_key, opts = {})
6250
6384
  logger.debug 'Calling operation DataCatalogClient#list_entity_tags.' if logger
6251
6385
 
@@ -6354,6 +6488,7 @@ module OCI
6354
6488
  # @option opts [String] :page The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
6355
6489
  # @option opts [String] :opc_request_id The client request ID for tracing.
6356
6490
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::FolderTagCollection FolderTagCollection}
6491
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/list_folder_tags.rb.html) to see an example of how to use list_folder_tags API.
6357
6492
  def list_folder_tags(catalog_id, data_asset_key, folder_key, opts = {})
6358
6493
  logger.debug 'Calling operation DataCatalogClient#list_folder_tags.' if logger
6359
6494
 
@@ -6470,6 +6605,7 @@ module OCI
6470
6605
  # @option opts [String] :page The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
6471
6606
  # @option opts [String] :opc_request_id The client request ID for tracing.
6472
6607
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::FolderCollection FolderCollection}
6608
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/list_folders.rb.html) to see an example of how to use list_folders API.
6473
6609
  def list_folders(catalog_id, data_asset_key, opts = {})
6474
6610
  logger.debug 'Calling operation DataCatalogClient#list_folders.' if logger
6475
6611
 
@@ -6588,6 +6724,7 @@ module OCI
6588
6724
  # @option opts [String] :page The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
6589
6725
  # @option opts [String] :opc_request_id The client request ID for tracing.
6590
6726
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::GlossaryCollection GlossaryCollection}
6727
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/list_glossaries.rb.html) to see an example of how to use list_glossaries API.
6591
6728
  def list_glossaries(catalog_id, opts = {})
6592
6729
  logger.debug 'Calling operation DataCatalogClient#list_glossaries.' if logger
6593
6730
 
@@ -6701,6 +6838,7 @@ module OCI
6701
6838
  # @option opts [String] :page The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
6702
6839
  # @option opts [String] :opc_request_id The client request ID for tracing.
6703
6840
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::JobDefinitionCollection JobDefinitionCollection}
6841
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/list_job_definitions.rb.html) to see an example of how to use list_job_definitions API.
6704
6842
  def list_job_definitions(catalog_id, opts = {})
6705
6843
  logger.debug 'Calling operation DataCatalogClient#list_job_definitions.' if logger
6706
6844
 
@@ -6835,6 +6973,7 @@ module OCI
6835
6973
  # @option opts [String] :page The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
6836
6974
  # @option opts [String] :opc_request_id The client request ID for tracing.
6837
6975
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::JobExecutionCollection JobExecutionCollection}
6976
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/list_job_executions.rb.html) to see an example of how to use list_job_executions API.
6838
6977
  def list_job_executions(catalog_id, job_key, opts = {})
6839
6978
  logger.debug 'Calling operation DataCatalogClient#list_job_executions.' if logger
6840
6979
 
@@ -6955,6 +7094,7 @@ module OCI
6955
7094
  # @option opts [String] :page The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
6956
7095
  # @option opts [String] :opc_request_id The client request ID for tracing.
6957
7096
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::JobLogCollection JobLogCollection}
7097
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/list_job_logs.rb.html) to see an example of how to use list_job_logs API.
6958
7098
  def list_job_logs(catalog_id, job_key, job_execution_key, opts = {})
6959
7099
  logger.debug 'Calling operation DataCatalogClient#list_job_logs.' if logger
6960
7100
 
@@ -7074,6 +7214,7 @@ module OCI
7074
7214
  # @option opts [String] :page The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
7075
7215
  # @option opts [String] :opc_request_id The client request ID for tracing.
7076
7216
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::JobMetricCollection JobMetricCollection}
7217
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/list_job_metrics.rb.html) to see an example of how to use list_job_metrics API.
7077
7218
  def list_job_metrics(catalog_id, job_key, job_execution_key, opts = {})
7078
7219
  logger.debug 'Calling operation DataCatalogClient#list_job_metrics.' if logger
7079
7220
 
@@ -7201,6 +7342,7 @@ module OCI
7201
7342
  # @option opts [String] :page The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
7202
7343
  # @option opts [String] :opc_request_id The client request ID for tracing.
7203
7344
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::JobCollection JobCollection}
7345
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/list_jobs.rb.html) to see an example of how to use list_jobs API.
7204
7346
  def list_jobs(catalog_id, opts = {})
7205
7347
  logger.debug 'Calling operation DataCatalogClient#list_jobs.' if logger
7206
7348
 
@@ -7325,6 +7467,7 @@ module OCI
7325
7467
  # @option opts [String] :page The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
7326
7468
  # @option opts [String] :opc_request_id The client request ID for tracing.
7327
7469
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::NamespaceCollection NamespaceCollection}
7470
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/list_namespaces.rb.html) to see an example of how to use list_namespaces API.
7328
7471
  def list_namespaces(catalog_id, opts = {})
7329
7472
  logger.debug 'Calling operation DataCatalogClient#list_namespaces.' if logger
7330
7473
 
@@ -7432,6 +7575,7 @@ module OCI
7432
7575
  # @option opts [String] :page The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
7433
7576
  # @option opts [String] :opc_request_id The client request ID for tracing.
7434
7577
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::PatternCollection PatternCollection}
7578
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/list_patterns.rb.html) to see an example of how to use list_patterns API.
7435
7579
  def list_patterns(catalog_id, opts = {})
7436
7580
  logger.debug 'Calling operation DataCatalogClient#list_patterns.' if logger
7437
7581
 
@@ -7512,6 +7656,134 @@ module OCI
7512
7656
  # rubocop:disable Metrics/MethodLength, Layout/EmptyLines
7513
7657
 
7514
7658
 
7659
+ # Returns a list of all rules of a data entity.
7660
+ # @param [String] catalog_id Unique catalog identifier.
7661
+ # @param [String] data_asset_key Unique data asset key.
7662
+ # @param [String] entity_key Unique entity key.
7663
+ # @param [Hash] opts the optional parameters
7664
+ # @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level
7665
+ # retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry
7666
+ # @option opts [String] :display_name A filter to return only resources that match the entire display name given. The match is not case sensitive.
7667
+ # @option opts [String] :display_name_contains A filter to return only resources that match display name pattern given. The match is not case sensitive.
7668
+ # For Example : /folders?displayNameContains=Cu.*
7669
+ # The above would match all folders with display name that starts with \"Cu\".
7670
+ #
7671
+ # @option opts [String] :rule_type Rule type used to filter the response to a list rules call.
7672
+ # @option opts [String] :lifecycle_state A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
7673
+ # @option opts [String] :origin_type Rule origin type used to filter the response to a list rules call.
7674
+ # @option opts [String] :external_key Unique external identifier of this resource in the external source system.
7675
+ # @option opts [DateTime] :time_created Time that the resource was created. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string.
7676
+ # @option opts [DateTime] :time_updated Time that the resource was updated. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string.
7677
+ # @option opts [String] :created_by_id OCID of the user who created the resource.
7678
+ # @option opts [String] :updated_by_id OCID of the user who updated the resource.
7679
+ # @option opts [Array<String>] :fields Specifies the fields to return in a rule summary response.
7680
+ #
7681
+ # Allowed values are: key, displayName, ruleType, externalKey, referencedFolderKey, referencedFolderName, referencedEntityKey, referencedEntityName, referencedRuleKey, referencedRuleName, originType, lifecycleState, timeCreated, uri
7682
+ # @option opts [String] :sort_by The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.
7683
+ #
7684
+ # Allowed values are: TIMECREATED, DISPLAYNAME
7685
+ # @option opts [String] :sort_order The sort order to use, either 'asc' or 'desc'.
7686
+ # Allowed values are: ASC, DESC
7687
+ # @option opts [Integer] :limit The maximum number of items to return.
7688
+ # @option opts [String] :page The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
7689
+ # @option opts [String] :opc_request_id The client request ID for tracing.
7690
+ # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::RuleCollection RuleCollection}
7691
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/list_rules.rb.html) to see an example of how to use list_rules API.
7692
+ def list_rules(catalog_id, data_asset_key, entity_key, opts = {})
7693
+ logger.debug 'Calling operation DataCatalogClient#list_rules.' if logger
7694
+
7695
+ raise "Missing the required parameter 'catalog_id' when calling list_rules." if catalog_id.nil?
7696
+ raise "Missing the required parameter 'data_asset_key' when calling list_rules." if data_asset_key.nil?
7697
+ raise "Missing the required parameter 'entity_key' when calling list_rules." if entity_key.nil?
7698
+
7699
+ if opts[:rule_type] && !OCI::DataCatalog::Models::RULE_TYPE_ENUM.include?(opts[:rule_type])
7700
+ raise 'Invalid value for "rule_type", must be one of the values in OCI::DataCatalog::Models::RULE_TYPE_ENUM.'
7701
+ end
7702
+
7703
+ if opts[:lifecycle_state] && !OCI::DataCatalog::Models::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
7704
+ raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataCatalog::Models::LIFECYCLE_STATE_ENUM.'
7705
+ end
7706
+
7707
+ if opts[:origin_type] && !OCI::DataCatalog::Models::RULE_ORIGIN_TYPE_ENUM.include?(opts[:origin_type])
7708
+ raise 'Invalid value for "origin_type", must be one of the values in OCI::DataCatalog::Models::RULE_ORIGIN_TYPE_ENUM.'
7709
+ end
7710
+
7711
+
7712
+ fields_allowable_values = %w[key displayName ruleType externalKey referencedFolderKey referencedFolderName referencedEntityKey referencedEntityName referencedRuleKey referencedRuleName originType lifecycleState timeCreated uri]
7713
+ if opts[:fields] && !opts[:fields].empty?
7714
+ opts[:fields].each do |val_to_check|
7715
+ unless fields_allowable_values.include?(val_to_check)
7716
+ raise 'Invalid value for "fields", must be one of key, displayName, ruleType, externalKey, referencedFolderKey, referencedFolderName, referencedEntityKey, referencedEntityName, referencedRuleKey, referencedRuleName, originType, lifecycleState, timeCreated, uri.'
7717
+ end
7718
+ end
7719
+ end
7720
+
7721
+ if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by])
7722
+ raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.'
7723
+ end
7724
+
7725
+ if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
7726
+ raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
7727
+ end
7728
+ raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
7729
+ raise "Parameter value for 'data_asset_key' must not be blank" if OCI::Internal::Util.blank_string?(data_asset_key)
7730
+ raise "Parameter value for 'entity_key' must not be blank" if OCI::Internal::Util.blank_string?(entity_key)
7731
+
7732
+ path = '/catalogs/{catalogId}/dataAssets/{dataAssetKey}/entities/{entityKey}/rules'.sub('{catalogId}', catalog_id.to_s).sub('{dataAssetKey}', data_asset_key.to_s).sub('{entityKey}', entity_key.to_s)
7733
+ operation_signing_strategy = :standard
7734
+
7735
+ # rubocop:disable Style/NegatedIf
7736
+ # Query Params
7737
+ query_params = {}
7738
+ query_params[:displayName] = opts[:display_name] if opts[:display_name]
7739
+ query_params[:displayNameContains] = opts[:display_name_contains] if opts[:display_name_contains]
7740
+ query_params[:ruleType] = opts[:rule_type] if opts[:rule_type]
7741
+ query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
7742
+ query_params[:originType] = opts[:origin_type] if opts[:origin_type]
7743
+ query_params[:externalKey] = opts[:external_key] if opts[:external_key]
7744
+ query_params[:timeCreated] = opts[:time_created] if opts[:time_created]
7745
+ query_params[:timeUpdated] = opts[:time_updated] if opts[:time_updated]
7746
+ query_params[:createdById] = opts[:created_by_id] if opts[:created_by_id]
7747
+ query_params[:updatedById] = opts[:updated_by_id] if opts[:updated_by_id]
7748
+ query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty?
7749
+ query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
7750
+ query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
7751
+ query_params[:limit] = opts[:limit] if opts[:limit]
7752
+ query_params[:page] = opts[:page] if opts[:page]
7753
+
7754
+ # Header Params
7755
+ header_params = {}
7756
+ header_params[:accept] = 'application/json'
7757
+ header_params[:'content-type'] = 'application/json'
7758
+ header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
7759
+ # rubocop:enable Style/NegatedIf
7760
+
7761
+ post_body = nil
7762
+
7763
+ # rubocop:disable Metrics/BlockLength
7764
+ OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#list_rules') do
7765
+ @api_client.call_api(
7766
+ :GET,
7767
+ path,
7768
+ endpoint,
7769
+ header_params: header_params,
7770
+ query_params: query_params,
7771
+ operation_signing_strategy: operation_signing_strategy,
7772
+ body: post_body,
7773
+ return_type: 'OCI::DataCatalog::Models::RuleCollection'
7774
+ )
7775
+ end
7776
+ # rubocop:enable Metrics/BlockLength
7777
+ end
7778
+ # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity
7779
+ # rubocop:enable Style/IfUnlessModifier, Metrics/ParameterLists
7780
+ # rubocop:enable Metrics/MethodLength, Layout/EmptyLines
7781
+
7782
+ # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity
7783
+ # rubocop:disable Style/IfUnlessModifier, Metrics/ParameterLists
7784
+ # rubocop:disable Metrics/MethodLength, Layout/EmptyLines
7785
+
7786
+
7515
7787
  # Returns a list of all user created tags in the system.
7516
7788
  # @param [String] catalog_id Unique catalog identifier.
7517
7789
  # @param [Hash] opts the optional parameters
@@ -7535,6 +7807,7 @@ module OCI
7535
7807
  # @option opts [String] :page The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
7536
7808
  # @option opts [String] :opc_request_id The client request ID for tracing.
7537
7809
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::TermCollection TermCollection}
7810
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/list_tags.rb.html) to see an example of how to use list_tags API.
7538
7811
  def list_tags(catalog_id, opts = {})
7539
7812
  logger.debug 'Calling operation DataCatalogClient#list_tags.' if logger
7540
7813
 
@@ -7636,6 +7909,7 @@ module OCI
7636
7909
  # @option opts [String] :page The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
7637
7910
  # @option opts [String] :opc_request_id The client request ID for tracing.
7638
7911
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::TermRelationshipCollection TermRelationshipCollection}
7912
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/list_term_relationships.rb.html) to see an example of how to use list_term_relationships API.
7639
7913
  def list_term_relationships(catalog_id, glossary_key, term_key, opts = {})
7640
7914
  logger.debug 'Calling operation DataCatalogClient#list_term_relationships.' if logger
7641
7915
 
@@ -7744,6 +8018,7 @@ module OCI
7744
8018
  # @option opts [String] :page The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
7745
8019
  # @option opts [String] :opc_request_id The client request ID for tracing.
7746
8020
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::TermCollection TermCollection}
8021
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/list_terms.rb.html) to see an example of how to use list_terms API.
7747
8022
  def list_terms(catalog_id, glossary_key, opts = {})
7748
8023
  logger.debug 'Calling operation DataCatalogClient#list_terms.' if logger
7749
8024
 
@@ -7854,6 +8129,7 @@ module OCI
7854
8129
  # @option opts [String] :page The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
7855
8130
  # @option opts [String] :opc_request_id The client request ID for tracing.
7856
8131
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::TypeCollection TypeCollection}
8132
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/list_types.rb.html) to see an example of how to use list_types API.
7857
8133
  def list_types(catalog_id, opts = {})
7858
8134
  logger.debug 'Calling operation DataCatalogClient#list_types.' if logger
7859
8135
 
@@ -7949,6 +8225,7 @@ module OCI
7949
8225
  # @option opts [String] :sort_order The sort order to use, either 'asc' or 'desc'.
7950
8226
  # Allowed values are: ASC, DESC
7951
8227
  # @return [Response] A Response object with data of type Array<{OCI::DataCatalog::Models::WorkRequestError WorkRequestError}>
8228
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/list_work_request_errors.rb.html) to see an example of how to use list_work_request_errors API.
7952
8229
  def list_work_request_errors(work_request_id, opts = {})
7953
8230
  logger.debug 'Calling operation DataCatalogClient#list_work_request_errors.' if logger
7954
8231
 
@@ -8022,6 +8299,7 @@ module OCI
8022
8299
  # @option opts [String] :sort_order The sort order to use, either 'asc' or 'desc'.
8023
8300
  # Allowed values are: ASC, DESC
8024
8301
  # @return [Response] A Response object with data of type Array<{OCI::DataCatalog::Models::WorkRequestLog WorkRequestLog}>
8302
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/list_work_request_logs.rb.html) to see an example of how to use list_work_request_logs API.
8025
8303
  def list_work_request_logs(work_request_id, opts = {})
8026
8304
  logger.debug 'Calling operation DataCatalogClient#list_work_request_logs.' if logger
8027
8305
 
@@ -8090,6 +8368,7 @@ module OCI
8090
8368
  # @option opts [String] :page The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
8091
8369
  # @option opts [Integer] :limit The maximum number of items to return.
8092
8370
  # @return [Response] A Response object with data of type Array<{OCI::DataCatalog::Models::WorkRequest WorkRequest}>
8371
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/list_work_requests.rb.html) to see an example of how to use list_work_requests API.
8093
8372
  def list_work_requests(compartment_id, opts = {})
8094
8373
  logger.debug 'Calling operation DataCatalogClient#list_work_requests.' if logger
8095
8374
 
@@ -8152,6 +8431,7 @@ module OCI
8152
8431
  # @option opts [String] :page The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
8153
8432
  # @option opts [String] :opc_request_id The client request ID for tracing.
8154
8433
  # @return [Response] A Response object with data of type String
8434
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/object_stats.rb.html) to see an example of how to use object_stats API.
8155
8435
  def object_stats(catalog_id, opts = {})
8156
8436
  logger.debug 'Calling operation DataCatalogClient#object_stats.' if logger
8157
8437
 
@@ -8226,6 +8506,7 @@ module OCI
8226
8506
  # might be rejected.
8227
8507
  #
8228
8508
  # @return [Response] A Response object with data of type Array<{OCI::DataCatalog::Models::ConnectionAliasSummary ConnectionAliasSummary}>
8509
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/parse_connection.rb.html) to see an example of how to use parse_connection API.
8229
8510
  def parse_connection(catalog_id, data_asset_key, parse_connection_details, opts = {})
8230
8511
  logger.debug 'Calling operation DataCatalogClient#parse_connection.' if logger
8231
8512
 
@@ -8299,6 +8580,7 @@ module OCI
8299
8580
  # might be rejected.
8300
8581
  #
8301
8582
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::DataAsset DataAsset}
8583
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/remove_data_selector_patterns.rb.html) to see an example of how to use remove_data_selector_patterns API.
8302
8584
  def remove_data_selector_patterns(catalog_id, data_asset_key, data_selector_pattern_details, opts = {})
8303
8585
  logger.debug 'Calling operation DataCatalogClient#remove_data_selector_patterns.' if logger
8304
8586
 
@@ -8373,6 +8655,7 @@ module OCI
8373
8655
  # @option opts [String] :page The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
8374
8656
  # @option opts [String] :opc_request_id The client request ID for tracing.
8375
8657
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::SearchResultCollection SearchResultCollection}
8658
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/search_criteria.rb.html) to see an example of how to use search_criteria API.
8376
8659
  def search_criteria(catalog_id, opts = {})
8377
8660
  logger.debug 'Calling operation DataCatalogClient#search_criteria.' if logger
8378
8661
 
@@ -8454,6 +8737,7 @@ module OCI
8454
8737
  # might be rejected.
8455
8738
  #
8456
8739
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::ValidateConnectionResult ValidateConnectionResult}
8740
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/test_connection.rb.html) to see an example of how to use test_connection API.
8457
8741
  def test_connection(catalog_id, data_asset_key, connection_key, opts = {})
8458
8742
  logger.debug 'Calling operation DataCatalogClient#test_connection.' if logger
8459
8743
 
@@ -8523,6 +8807,7 @@ module OCI
8523
8807
  #
8524
8808
  # @option opts [String] :opc_request_id The client request ID for tracing.
8525
8809
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::Attribute Attribute}
8810
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/update_attribute.rb.html) to see an example of how to use update_attribute API.
8526
8811
  def update_attribute(catalog_id, data_asset_key, entity_key, attribute_key, update_attribute_details, opts = {})
8527
8812
  logger.debug 'Calling operation DataCatalogClient#update_attribute.' if logger
8528
8813
 
@@ -8591,6 +8876,7 @@ module OCI
8591
8876
  #
8592
8877
  # @option opts [String] :opc_request_id The client request ID for tracing.
8593
8878
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::Catalog Catalog}
8879
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/update_catalog.rb.html) to see an example of how to use update_catalog API.
8594
8880
  def update_catalog(catalog_id, update_catalog_details, opts = {})
8595
8881
  logger.debug 'Calling operation DataCatalogClient#update_catalog.' if logger
8596
8882
 
@@ -8653,6 +8939,7 @@ module OCI
8653
8939
  #
8654
8940
  # @option opts [String] :opc_request_id The client request ID for tracing.
8655
8941
  # @return [Response] A Response object with data of type nil
8942
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/update_catalog_private_endpoint.rb.html) to see an example of how to use update_catalog_private_endpoint API.
8656
8943
  def update_catalog_private_endpoint(catalog_private_endpoint_id, update_catalog_private_endpoint_details, opts = {})
8657
8944
  logger.debug 'Calling operation DataCatalogClient#update_catalog_private_endpoint.' if logger
8658
8945
 
@@ -8716,6 +9003,7 @@ module OCI
8716
9003
  #
8717
9004
  # @option opts [String] :opc_request_id The client request ID for tracing.
8718
9005
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::Connection Connection}
9006
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/update_connection.rb.html) to see an example of how to use update_connection API.
8719
9007
  def update_connection(catalog_id, data_asset_key, connection_key, update_connection_details, opts = {})
8720
9008
  logger.debug 'Calling operation DataCatalogClient#update_connection.' if logger
8721
9009
 
@@ -8784,6 +9072,7 @@ module OCI
8784
9072
  #
8785
9073
  # @option opts [String] :opc_request_id The client request ID for tracing.
8786
9074
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::CustomProperty CustomProperty}
9075
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/update_custom_property.rb.html) to see an example of how to use update_custom_property API.
8787
9076
  def update_custom_property(catalog_id, namespace_id, custom_property_key, update_custom_property_details, opts = {})
8788
9077
  logger.debug 'Calling operation DataCatalogClient#update_custom_property.' if logger
8789
9078
 
@@ -8851,6 +9140,7 @@ module OCI
8851
9140
  #
8852
9141
  # @option opts [String] :opc_request_id The client request ID for tracing.
8853
9142
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::DataAsset DataAsset}
9143
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/update_data_asset.rb.html) to see an example of how to use update_data_asset API.
8854
9144
  def update_data_asset(catalog_id, data_asset_key, update_data_asset_details, opts = {})
8855
9145
  logger.debug 'Calling operation DataCatalogClient#update_data_asset.' if logger
8856
9146
 
@@ -8917,6 +9207,7 @@ module OCI
8917
9207
  #
8918
9208
  # @option opts [String] :opc_request_id The client request ID for tracing.
8919
9209
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::Entity Entity}
9210
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/update_entity.rb.html) to see an example of how to use update_entity API.
8920
9211
  def update_entity(catalog_id, data_asset_key, entity_key, update_entity_details, opts = {})
8921
9212
  logger.debug 'Calling operation DataCatalogClient#update_entity.' if logger
8922
9213
 
@@ -8985,6 +9276,7 @@ module OCI
8985
9276
  #
8986
9277
  # @option opts [String] :opc_request_id The client request ID for tracing.
8987
9278
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::Folder Folder}
9279
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/update_folder.rb.html) to see an example of how to use update_folder API.
8988
9280
  def update_folder(catalog_id, data_asset_key, folder_key, update_folder_details, opts = {})
8989
9281
  logger.debug 'Calling operation DataCatalogClient#update_folder.' if logger
8990
9282
 
@@ -9052,6 +9344,7 @@ module OCI
9052
9344
  #
9053
9345
  # @option opts [String] :opc_request_id The client request ID for tracing.
9054
9346
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::Glossary Glossary}
9347
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/update_glossary.rb.html) to see an example of how to use update_glossary API.
9055
9348
  def update_glossary(catalog_id, glossary_key, update_glossary_details, opts = {})
9056
9349
  logger.debug 'Calling operation DataCatalogClient#update_glossary.' if logger
9057
9350
 
@@ -9117,6 +9410,7 @@ module OCI
9117
9410
  #
9118
9411
  # @option opts [String] :opc_request_id The client request ID for tracing.
9119
9412
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::Job Job}
9413
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/update_job.rb.html) to see an example of how to use update_job API.
9120
9414
  def update_job(catalog_id, job_key, update_job_details, opts = {})
9121
9415
  logger.debug 'Calling operation DataCatalogClient#update_job.' if logger
9122
9416
 
@@ -9182,6 +9476,7 @@ module OCI
9182
9476
  #
9183
9477
  # @option opts [String] :opc_request_id The client request ID for tracing.
9184
9478
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::JobDefinition JobDefinition}
9479
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/update_job_definition.rb.html) to see an example of how to use update_job_definition API.
9185
9480
  def update_job_definition(catalog_id, job_definition_key, update_job_definition_details, opts = {})
9186
9481
  logger.debug 'Calling operation DataCatalogClient#update_job_definition.' if logger
9187
9482
 
@@ -9247,6 +9542,7 @@ module OCI
9247
9542
  #
9248
9543
  # @option opts [String] :opc_request_id The client request ID for tracing.
9249
9544
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::Namespace Namespace}
9545
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/update_namespace.rb.html) to see an example of how to use update_namespace API.
9250
9546
  def update_namespace(catalog_id, namespace_id, update_namespace_details, opts = {})
9251
9547
  logger.debug 'Calling operation DataCatalogClient#update_namespace.' if logger
9252
9548
 
@@ -9312,6 +9608,7 @@ module OCI
9312
9608
  #
9313
9609
  # @option opts [String] :opc_request_id The client request ID for tracing.
9314
9610
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::Pattern Pattern}
9611
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/update_pattern.rb.html) to see an example of how to use update_pattern API.
9315
9612
  def update_pattern(catalog_id, pattern_key, update_pattern_details, opts = {})
9316
9613
  logger.debug 'Calling operation DataCatalogClient#update_pattern.' if logger
9317
9614
 
@@ -9378,6 +9675,7 @@ module OCI
9378
9675
  #
9379
9676
  # @option opts [String] :opc_request_id The client request ID for tracing.
9380
9677
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::Term Term}
9678
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/update_term.rb.html) to see an example of how to use update_term API.
9381
9679
  def update_term(catalog_id, glossary_key, term_key, update_term_details, opts = {})
9382
9680
  logger.debug 'Calling operation DataCatalogClient#update_term.' if logger
9383
9681
 
@@ -9447,6 +9745,7 @@ module OCI
9447
9745
  #
9448
9746
  # @option opts [String] :opc_request_id The client request ID for tracing.
9449
9747
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::TermRelationship TermRelationship}
9748
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/update_term_relationship.rb.html) to see an example of how to use update_term_relationship API.
9450
9749
  def update_term_relationship(catalog_id, glossary_key, term_key, term_relationship_key, update_term_relationship_details, opts = {})
9451
9750
  logger.debug 'Calling operation DataCatalogClient#update_term_relationship.' if logger
9452
9751
 
@@ -9523,6 +9822,7 @@ module OCI
9523
9822
  # might be rejected.
9524
9823
  #
9525
9824
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::Connection Connection}
9825
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/upload_credentials.rb.html) to see an example of how to use upload_credentials API.
9526
9826
  def upload_credentials(catalog_id, data_asset_key, connection_key, upload_credentials_details, opts = {})
9527
9827
  logger.debug 'Calling operation DataCatalogClient#upload_credentials.' if logger
9528
9828
 
@@ -9591,6 +9891,7 @@ module OCI
9591
9891
  # @option opts [String] :page The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
9592
9892
  # @option opts [String] :opc_request_id The client request ID for tracing.
9593
9893
  # @return [Response] A Response object with data of type String
9894
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/users.rb.html) to see an example of how to use users API.
9594
9895
  def users(catalog_id, opts = {})
9595
9896
  logger.debug 'Calling operation DataCatalogClient#users.' if logger
9596
9897
 
@@ -9664,6 +9965,7 @@ module OCI
9664
9965
  # might be rejected.
9665
9966
  #
9666
9967
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::ValidateConnectionResult ValidateConnectionResult}
9968
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/validate_connection.rb.html) to see an example of how to use validate_connection API.
9667
9969
  def validate_connection(catalog_id, data_asset_key, validate_connection_details, opts = {})
9668
9970
  logger.debug 'Calling operation DataCatalogClient#validate_connection.' if logger
9669
9971
 
@@ -9730,6 +10032,7 @@ module OCI
9730
10032
  # might be rejected.
9731
10033
  #
9732
10034
  # @return [Response] A Response object with data of type {OCI::DataCatalog::Models::ValidatePatternResult ValidatePatternResult}
10035
+ # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/datacatalog/validate_pattern.rb.html) to see an example of how to use validate_pattern API.
9733
10036
  def validate_pattern(catalog_id, pattern_key, validate_pattern_details, opts = {})
9734
10037
  logger.debug 'Calling operation DataCatalogClient#validate_pattern.' if logger
9735
10038