diff --git a/CHANGELOG.rst b/CHANGELOG.rst index a4b06c27cb..cb4322fec4 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -3,6 +3,24 @@ Change Log All notable changes to this project will be documented in this file. The format is based on `Keep a Changelog `_. +==================== +2.112.1 - 2023-09-12 +==================== + +Added +------ +* Support for SQL tuning sets in Database Management service +* Support for announcement chaining in Announcements service +* Support for automatic promotion of hosts in Stack Monitoring service +* Support for face detection in AI Vision service +* Support for change parameters on list character sets operation in Database Management service +* Support for displaying software sources attached to a managed instance group in OS Management service +* Support for Alloy configuration + +Fixed +----- +* Fixed a bug in `EnvRptPathProvider` introduced after adding support for Resource Principals v3 + ==================== 2.112.0 - 2023-09-05 ==================== diff --git a/docs/api/ai_vision.rst b/docs/api/ai_vision.rst index 7a9396d299..6bac6e50e9 100644 --- a/docs/api/ai_vision.rst +++ b/docs/api/ai_vision.rst @@ -45,6 +45,8 @@ Ai Vision oci.ai_vision.models.DocumentMetadata oci.ai_vision.models.DocumentTableDetectionFeature oci.ai_vision.models.DocumentTextDetectionFeature + oci.ai_vision.models.Face + oci.ai_vision.models.FaceDetectionFeature oci.ai_vision.models.FieldLabel oci.ai_vision.models.FieldName oci.ai_vision.models.FieldValue @@ -60,6 +62,7 @@ Ai Vision oci.ai_vision.models.InlineImageDetails oci.ai_vision.models.InputLocation oci.ai_vision.models.Label + oci.ai_vision.models.Landmark oci.ai_vision.models.Line oci.ai_vision.models.Model oci.ai_vision.models.ModelCollection diff --git a/docs/api/ai_vision/models/oci.ai_vision.models.Face.rst b/docs/api/ai_vision/models/oci.ai_vision.models.Face.rst new file mode 100644 index 0000000000..1876fc7e45 --- /dev/null +++ b/docs/api/ai_vision/models/oci.ai_vision.models.Face.rst @@ -0,0 +1,11 @@ +Face +==== + +.. currentmodule:: oci.ai_vision.models + +.. autoclass:: Face + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/ai_vision/models/oci.ai_vision.models.FaceDetectionFeature.rst b/docs/api/ai_vision/models/oci.ai_vision.models.FaceDetectionFeature.rst new file mode 100644 index 0000000000..b73220d762 --- /dev/null +++ b/docs/api/ai_vision/models/oci.ai_vision.models.FaceDetectionFeature.rst @@ -0,0 +1,11 @@ +FaceDetectionFeature +==================== + +.. currentmodule:: oci.ai_vision.models + +.. autoclass:: FaceDetectionFeature + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/ai_vision/models/oci.ai_vision.models.Landmark.rst b/docs/api/ai_vision/models/oci.ai_vision.models.Landmark.rst new file mode 100644 index 0000000000..ba11af81cf --- /dev/null +++ b/docs/api/ai_vision/models/oci.ai_vision.models.Landmark.rst @@ -0,0 +1,11 @@ +Landmark +======== + +.. currentmodule:: oci.ai_vision.models + +.. autoclass:: Landmark + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management.rst b/docs/api/database_management.rst index 63689a2e8b..1cdb7e0895 100644 --- a/docs/api/database_management.rst +++ b/docs/api/database_management.rst @@ -8,9 +8,11 @@ Database Management oci.database_management.DbManagementClient oci.database_management.DiagnosabilityClient + oci.database_management.PerfhubClient oci.database_management.SqlTuningClient oci.database_management.DbManagementClientCompositeOperations oci.database_management.DiagnosabilityClientCompositeOperations + oci.database_management.PerfhubClientCompositeOperations oci.database_management.SqlTuningClientCompositeOperations -------- @@ -104,6 +106,7 @@ Database Management oci.database_management.models.CreateJobDetails oci.database_management.models.CreateManagedDatabaseGroupDetails oci.database_management.models.CreateSqlJobDetails + oci.database_management.models.CreateSqlTuningSetDetails oci.database_management.models.CreateTablespaceDetails oci.database_management.models.CursorCacheStatementCollection oci.database_management.models.CursorCacheStatementSummary @@ -151,7 +154,9 @@ Database Management oci.database_management.models.DiscoveredExternalListener oci.database_management.models.DiscoveredExternalPluggableDatabase oci.database_management.models.DropSqlPlanBaselinesDetails + oci.database_management.models.DropSqlTuningSetDetails oci.database_management.models.DropSqlTuningTaskDetails + oci.database_management.models.DropSqlsInSqlTuningSetDetails oci.database_management.models.DropTablespaceDetails oci.database_management.models.EnableAutomaticInitialPlanCaptureDetails oci.database_management.models.EnableAutomaticSpmEvolveAdvisorTaskDetails @@ -243,6 +248,7 @@ Database Management oci.database_management.models.ExternalStorageGridDiscoverySummary oci.database_management.models.ExternalStorageServerDiscoverySummary oci.database_management.models.FailedConnectionsAggregateMetrics + oci.database_management.models.FetchSqlTuningSetDetails oci.database_management.models.FindingSchemaOrOperation oci.database_management.models.FleetMetricDefinition oci.database_management.models.FleetMetricSummaryDefinition @@ -274,6 +280,7 @@ Database Management oci.database_management.models.JobSummary oci.database_management.models.LoadSqlPlanBaselinesFromAwrDetails oci.database_management.models.LoadSqlPlanBaselinesFromCursorCacheDetails + oci.database_management.models.LoadSqlTuningSetDetails oci.database_management.models.ManagedDatabase oci.database_management.models.ManagedDatabaseCollection oci.database_management.models.ManagedDatabaseCredential @@ -289,6 +296,7 @@ Database Management oci.database_management.models.MetricStatisticsDefinition oci.database_management.models.MetricsAggregationRange oci.database_management.models.MetricsAggregationRangeCollection + oci.database_management.models.ModifySnapshotSettingsDetails oci.database_management.models.ObjectPrivilegeCollection oci.database_management.models.ObjectPrivilegeSummary oci.database_management.models.ObjectStorageJobExecutionResultDetails @@ -333,11 +341,14 @@ Database Management oci.database_management.models.RoleSummary oci.database_management.models.RuleFinding oci.database_management.models.RunHistoricAddmDetails + oci.database_management.models.SaveSqlTuningSetAsDetails oci.database_management.models.SchemaDefinition oci.database_management.models.SnapshotDetails oci.database_management.models.SpmEvolveTaskParameters oci.database_management.models.SqlCpuActivity + oci.database_management.models.SqlInSqlTuningSet oci.database_management.models.SqlJob + oci.database_management.models.SqlMetrics oci.database_management.models.SqlPlanBaseline oci.database_management.models.SqlPlanBaselineAggregation oci.database_management.models.SqlPlanBaselineAggregationCollection @@ -363,6 +374,11 @@ Database Management oci.database_management.models.SqlTuningAdvisorTaskSummaryReportStatementCounts oci.database_management.models.SqlTuningAdvisorTaskSummaryReportStatistics oci.database_management.models.SqlTuningAdvisorTaskSummaryReportTaskInfo + oci.database_management.models.SqlTuningSet + oci.database_management.models.SqlTuningSetAdminActionStatus + oci.database_management.models.SqlTuningSetAdminCredentialDetails + oci.database_management.models.SqlTuningSetAdminPasswordCredentialDetails + oci.database_management.models.SqlTuningSetAdminSecretCredentialDetails oci.database_management.models.SqlTuningSetCollection oci.database_management.models.SqlTuningSetInput oci.database_management.models.SqlTuningSetSummary @@ -415,6 +431,7 @@ Database Management oci.database_management.models.User oci.database_management.models.UserCollection oci.database_management.models.UserSummary + oci.database_management.models.ValidateBasicFilterDetails oci.database_management.models.WorkRequest oci.database_management.models.WorkRequestCollection oci.database_management.models.WorkRequestError diff --git a/docs/api/database_management/client/oci.database_management.PerfhubClient.rst b/docs/api/database_management/client/oci.database_management.PerfhubClient.rst new file mode 100644 index 0000000000..015ae7a821 --- /dev/null +++ b/docs/api/database_management/client/oci.database_management.PerfhubClient.rst @@ -0,0 +1,8 @@ +PerfhubClient +============= + +.. currentmodule:: oci.database_management + +.. autoclass:: PerfhubClient + :special-members: __init__ + :members: \ No newline at end of file diff --git a/docs/api/database_management/client/oci.database_management.PerfhubClientCompositeOperations.rst b/docs/api/database_management/client/oci.database_management.PerfhubClientCompositeOperations.rst new file mode 100644 index 0000000000..2b63e3d8ed --- /dev/null +++ b/docs/api/database_management/client/oci.database_management.PerfhubClientCompositeOperations.rst @@ -0,0 +1,8 @@ +PerfhubClientCompositeOperations +================================ + +.. currentmodule:: oci.database_management + +.. autoclass:: PerfhubClientCompositeOperations + :special-members: __init__ + :members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.CreateSqlTuningSetDetails.rst b/docs/api/database_management/models/oci.database_management.models.CreateSqlTuningSetDetails.rst new file mode 100644 index 0000000000..4913fb0ecd --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.CreateSqlTuningSetDetails.rst @@ -0,0 +1,11 @@ +CreateSqlTuningSetDetails +========================= + +.. currentmodule:: oci.database_management.models + +.. autoclass:: CreateSqlTuningSetDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.DropSqlTuningSetDetails.rst b/docs/api/database_management/models/oci.database_management.models.DropSqlTuningSetDetails.rst new file mode 100644 index 0000000000..63d7d0d601 --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.DropSqlTuningSetDetails.rst @@ -0,0 +1,11 @@ +DropSqlTuningSetDetails +======================= + +.. currentmodule:: oci.database_management.models + +.. autoclass:: DropSqlTuningSetDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.DropSqlsInSqlTuningSetDetails.rst b/docs/api/database_management/models/oci.database_management.models.DropSqlsInSqlTuningSetDetails.rst new file mode 100644 index 0000000000..48f3232863 --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.DropSqlsInSqlTuningSetDetails.rst @@ -0,0 +1,11 @@ +DropSqlsInSqlTuningSetDetails +============================= + +.. currentmodule:: oci.database_management.models + +.. autoclass:: DropSqlsInSqlTuningSetDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.FetchSqlTuningSetDetails.rst b/docs/api/database_management/models/oci.database_management.models.FetchSqlTuningSetDetails.rst new file mode 100644 index 0000000000..c1e5e27222 --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.FetchSqlTuningSetDetails.rst @@ -0,0 +1,11 @@ +FetchSqlTuningSetDetails +======================== + +.. currentmodule:: oci.database_management.models + +.. autoclass:: FetchSqlTuningSetDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.LoadSqlTuningSetDetails.rst b/docs/api/database_management/models/oci.database_management.models.LoadSqlTuningSetDetails.rst new file mode 100644 index 0000000000..666c1fe6da --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.LoadSqlTuningSetDetails.rst @@ -0,0 +1,11 @@ +LoadSqlTuningSetDetails +======================= + +.. currentmodule:: oci.database_management.models + +.. autoclass:: LoadSqlTuningSetDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.ModifySnapshotSettingsDetails.rst b/docs/api/database_management/models/oci.database_management.models.ModifySnapshotSettingsDetails.rst new file mode 100644 index 0000000000..1141b9d0bf --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.ModifySnapshotSettingsDetails.rst @@ -0,0 +1,11 @@ +ModifySnapshotSettingsDetails +============================= + +.. currentmodule:: oci.database_management.models + +.. autoclass:: ModifySnapshotSettingsDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.SaveSqlTuningSetAsDetails.rst b/docs/api/database_management/models/oci.database_management.models.SaveSqlTuningSetAsDetails.rst new file mode 100644 index 0000000000..a0f6050397 --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.SaveSqlTuningSetAsDetails.rst @@ -0,0 +1,11 @@ +SaveSqlTuningSetAsDetails +========================= + +.. currentmodule:: oci.database_management.models + +.. autoclass:: SaveSqlTuningSetAsDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.SqlInSqlTuningSet.rst b/docs/api/database_management/models/oci.database_management.models.SqlInSqlTuningSet.rst new file mode 100644 index 0000000000..7195460814 --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.SqlInSqlTuningSet.rst @@ -0,0 +1,11 @@ +SqlInSqlTuningSet +================= + +.. currentmodule:: oci.database_management.models + +.. autoclass:: SqlInSqlTuningSet + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.SqlMetrics.rst b/docs/api/database_management/models/oci.database_management.models.SqlMetrics.rst new file mode 100644 index 0000000000..9b3ea64772 --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.SqlMetrics.rst @@ -0,0 +1,11 @@ +SqlMetrics +========== + +.. currentmodule:: oci.database_management.models + +.. autoclass:: SqlMetrics + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.SqlTuningSet.rst b/docs/api/database_management/models/oci.database_management.models.SqlTuningSet.rst new file mode 100644 index 0000000000..7f27f75c64 --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.SqlTuningSet.rst @@ -0,0 +1,11 @@ +SqlTuningSet +============ + +.. currentmodule:: oci.database_management.models + +.. autoclass:: SqlTuningSet + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.SqlTuningSetAdminActionStatus.rst b/docs/api/database_management/models/oci.database_management.models.SqlTuningSetAdminActionStatus.rst new file mode 100644 index 0000000000..a41212f50a --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.SqlTuningSetAdminActionStatus.rst @@ -0,0 +1,11 @@ +SqlTuningSetAdminActionStatus +============================= + +.. currentmodule:: oci.database_management.models + +.. autoclass:: SqlTuningSetAdminActionStatus + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.SqlTuningSetAdminCredentialDetails.rst b/docs/api/database_management/models/oci.database_management.models.SqlTuningSetAdminCredentialDetails.rst new file mode 100644 index 0000000000..47e415b409 --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.SqlTuningSetAdminCredentialDetails.rst @@ -0,0 +1,11 @@ +SqlTuningSetAdminCredentialDetails +================================== + +.. currentmodule:: oci.database_management.models + +.. autoclass:: SqlTuningSetAdminCredentialDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.SqlTuningSetAdminPasswordCredentialDetails.rst b/docs/api/database_management/models/oci.database_management.models.SqlTuningSetAdminPasswordCredentialDetails.rst new file mode 100644 index 0000000000..63dba26d81 --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.SqlTuningSetAdminPasswordCredentialDetails.rst @@ -0,0 +1,11 @@ +SqlTuningSetAdminPasswordCredentialDetails +========================================== + +.. currentmodule:: oci.database_management.models + +.. autoclass:: SqlTuningSetAdminPasswordCredentialDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.SqlTuningSetAdminSecretCredentialDetails.rst b/docs/api/database_management/models/oci.database_management.models.SqlTuningSetAdminSecretCredentialDetails.rst new file mode 100644 index 0000000000..27e2af728b --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.SqlTuningSetAdminSecretCredentialDetails.rst @@ -0,0 +1,11 @@ +SqlTuningSetAdminSecretCredentialDetails +======================================== + +.. currentmodule:: oci.database_management.models + +.. autoclass:: SqlTuningSetAdminSecretCredentialDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.ValidateBasicFilterDetails.rst b/docs/api/database_management/models/oci.database_management.models.ValidateBasicFilterDetails.rst new file mode 100644 index 0000000000..500d94a088 --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.ValidateBasicFilterDetails.rst @@ -0,0 +1,11 @@ +ValidateBasicFilterDetails +========================== + +.. currentmodule:: oci.database_management.models + +.. autoclass:: ValidateBasicFilterDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/landing.rst b/docs/api/landing.rst index 9467abdc93..e123cddb03 100644 --- a/docs/api/landing.rst +++ b/docs/api/landing.rst @@ -149,6 +149,7 @@ API Reference * :doc:`Organization Subscription ` * :doc:`Organization Subscription ` * :doc:`Os Management ` +* :doc:`Perfhub ` * :doc:`Plugin ` * :doc:`Pluginconfig ` * :doc:`Query ` diff --git a/docs/api/stack_monitoring.rst b/docs/api/stack_monitoring.rst index 56273752de..223f15a348 100644 --- a/docs/api/stack_monitoring.rst +++ b/docs/api/stack_monitoring.rst @@ -24,8 +24,16 @@ Stack Monitoring oci.stack_monitoring.models.AssociatedResourcesSummary oci.stack_monitoring.models.AssociationDetails oci.stack_monitoring.models.AssociationResourceDetails + oci.stack_monitoring.models.AutoPromoteConfigDetails + oci.stack_monitoring.models.AutoPromoteConfigSummary + oci.stack_monitoring.models.ChangeConfigCompartmentDetails oci.stack_monitoring.models.ChangeMonitoredResourceCompartmentDetails + oci.stack_monitoring.models.Config + oci.stack_monitoring.models.ConfigCollection + oci.stack_monitoring.models.ConfigSummary oci.stack_monitoring.models.ConnectionDetails + oci.stack_monitoring.models.CreateAutoPromoteConfigDetails + oci.stack_monitoring.models.CreateConfigDetails oci.stack_monitoring.models.CreateDiscoveryJobDetails oci.stack_monitoring.models.CreateMonitoredResourceDetails oci.stack_monitoring.models.CredentialCollection @@ -59,6 +67,8 @@ Stack Monitoring oci.stack_monitoring.models.SearchMonitoredResourceMembersDetails oci.stack_monitoring.models.SearchMonitoredResourcesDetails oci.stack_monitoring.models.UpdateAndPropagateTagsDetails + oci.stack_monitoring.models.UpdateAutoPromoteConfigDetails + oci.stack_monitoring.models.UpdateConfigDetails oci.stack_monitoring.models.UpdateMonitoredResourceDetails oci.stack_monitoring.models.WorkRequest oci.stack_monitoring.models.WorkRequestError diff --git a/docs/api/stack_monitoring/models/oci.stack_monitoring.models.AutoPromoteConfigDetails.rst b/docs/api/stack_monitoring/models/oci.stack_monitoring.models.AutoPromoteConfigDetails.rst new file mode 100644 index 0000000000..c5b9208abc --- /dev/null +++ b/docs/api/stack_monitoring/models/oci.stack_monitoring.models.AutoPromoteConfigDetails.rst @@ -0,0 +1,11 @@ +AutoPromoteConfigDetails +======================== + +.. currentmodule:: oci.stack_monitoring.models + +.. autoclass:: AutoPromoteConfigDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/stack_monitoring/models/oci.stack_monitoring.models.AutoPromoteConfigSummary.rst b/docs/api/stack_monitoring/models/oci.stack_monitoring.models.AutoPromoteConfigSummary.rst new file mode 100644 index 0000000000..9d49183ca5 --- /dev/null +++ b/docs/api/stack_monitoring/models/oci.stack_monitoring.models.AutoPromoteConfigSummary.rst @@ -0,0 +1,11 @@ +AutoPromoteConfigSummary +======================== + +.. currentmodule:: oci.stack_monitoring.models + +.. autoclass:: AutoPromoteConfigSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/stack_monitoring/models/oci.stack_monitoring.models.ChangeConfigCompartmentDetails.rst b/docs/api/stack_monitoring/models/oci.stack_monitoring.models.ChangeConfigCompartmentDetails.rst new file mode 100644 index 0000000000..7ce387649c --- /dev/null +++ b/docs/api/stack_monitoring/models/oci.stack_monitoring.models.ChangeConfigCompartmentDetails.rst @@ -0,0 +1,11 @@ +ChangeConfigCompartmentDetails +============================== + +.. currentmodule:: oci.stack_monitoring.models + +.. autoclass:: ChangeConfigCompartmentDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/stack_monitoring/models/oci.stack_monitoring.models.Config.rst b/docs/api/stack_monitoring/models/oci.stack_monitoring.models.Config.rst new file mode 100644 index 0000000000..708fc67ff3 --- /dev/null +++ b/docs/api/stack_monitoring/models/oci.stack_monitoring.models.Config.rst @@ -0,0 +1,11 @@ +Config +====== + +.. currentmodule:: oci.stack_monitoring.models + +.. autoclass:: Config + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/stack_monitoring/models/oci.stack_monitoring.models.ConfigCollection.rst b/docs/api/stack_monitoring/models/oci.stack_monitoring.models.ConfigCollection.rst new file mode 100644 index 0000000000..7a531ae7cb --- /dev/null +++ b/docs/api/stack_monitoring/models/oci.stack_monitoring.models.ConfigCollection.rst @@ -0,0 +1,11 @@ +ConfigCollection +================ + +.. currentmodule:: oci.stack_monitoring.models + +.. autoclass:: ConfigCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/stack_monitoring/models/oci.stack_monitoring.models.ConfigSummary.rst b/docs/api/stack_monitoring/models/oci.stack_monitoring.models.ConfigSummary.rst new file mode 100644 index 0000000000..311b8060c7 --- /dev/null +++ b/docs/api/stack_monitoring/models/oci.stack_monitoring.models.ConfigSummary.rst @@ -0,0 +1,11 @@ +ConfigSummary +============= + +.. currentmodule:: oci.stack_monitoring.models + +.. autoclass:: ConfigSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/stack_monitoring/models/oci.stack_monitoring.models.CreateAutoPromoteConfigDetails.rst b/docs/api/stack_monitoring/models/oci.stack_monitoring.models.CreateAutoPromoteConfigDetails.rst new file mode 100644 index 0000000000..4ccff39263 --- /dev/null +++ b/docs/api/stack_monitoring/models/oci.stack_monitoring.models.CreateAutoPromoteConfigDetails.rst @@ -0,0 +1,11 @@ +CreateAutoPromoteConfigDetails +============================== + +.. currentmodule:: oci.stack_monitoring.models + +.. autoclass:: CreateAutoPromoteConfigDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/stack_monitoring/models/oci.stack_monitoring.models.CreateConfigDetails.rst b/docs/api/stack_monitoring/models/oci.stack_monitoring.models.CreateConfigDetails.rst new file mode 100644 index 0000000000..b3ae79a2db --- /dev/null +++ b/docs/api/stack_monitoring/models/oci.stack_monitoring.models.CreateConfigDetails.rst @@ -0,0 +1,11 @@ +CreateConfigDetails +=================== + +.. currentmodule:: oci.stack_monitoring.models + +.. autoclass:: CreateConfigDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/stack_monitoring/models/oci.stack_monitoring.models.UpdateAutoPromoteConfigDetails.rst b/docs/api/stack_monitoring/models/oci.stack_monitoring.models.UpdateAutoPromoteConfigDetails.rst new file mode 100644 index 0000000000..eabb00afe7 --- /dev/null +++ b/docs/api/stack_monitoring/models/oci.stack_monitoring.models.UpdateAutoPromoteConfigDetails.rst @@ -0,0 +1,11 @@ +UpdateAutoPromoteConfigDetails +============================== + +.. currentmodule:: oci.stack_monitoring.models + +.. autoclass:: UpdateAutoPromoteConfigDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/stack_monitoring/models/oci.stack_monitoring.models.UpdateConfigDetails.rst b/docs/api/stack_monitoring/models/oci.stack_monitoring.models.UpdateConfigDetails.rst new file mode 100644 index 0000000000..a12598749d --- /dev/null +++ b/docs/api/stack_monitoring/models/oci.stack_monitoring.models.UpdateConfigDetails.rst @@ -0,0 +1,11 @@ +UpdateConfigDetails +=================== + +.. currentmodule:: oci.stack_monitoring.models + +.. autoclass:: UpdateConfigDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/examples/showoci/CHANGELOG.rst b/examples/showoci/CHANGELOG.rst index 9611ad69f7..804e83711c 100644 --- a/examples/showoci/CHANGELOG.rst +++ b/examples/showoci/CHANGELOG.rst @@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file. The format is based on `Keep a Changelog `_. +===================== +23.09.05 - 23.09.05 +===================== +* Added Autonomous database ECPU +* emptied vcn_cidr in csv files, vcn_cidrs should be used + ===================== 23.08.15 - 23.08.15 ===================== diff --git a/examples/showoci/showoci.py b/examples/showoci/showoci.py index 092c44f364..f4211c00fa 100644 --- a/examples/showoci/showoci.py +++ b/examples/showoci/showoci.py @@ -118,7 +118,7 @@ import os import time -version = "23.08.15" +version = "23.09.03" ########################################################################## # check OCI version diff --git a/examples/showoci/showoci_data.py b/examples/showoci/showoci_data.py index 72025b1a1b..9e6ed2b8a3 100644 --- a/examples/showoci/showoci_data.py +++ b/examples/showoci/showoci_data.py @@ -19,7 +19,7 @@ class ShowOCIData(object): - version = "23.08.15" + version = "23.09.03" ############################################ # ShowOCIService - Service object to query @@ -993,7 +993,7 @@ def __get_core_network_vcn(self, region_name, compartment): 'id': vcn['id'], 'name': vcn['name'], 'display_name': vcn['display_name'], - 'cidr_block': vcn['cidr_block'], + 'cidr_block': "", 'cidr_blocks': vcn['cidr_blocks'], 'ipv6_private_cidr_blocks': vcn['ipv6_private_cidr_blocks'], 'ipv6_cidr_blocks': vcn['ipv6_cidr_blocks'], @@ -2665,6 +2665,7 @@ def __get_database_db_exacc_adb_dedicated(self, region_name, compartment, infra_ 'is_mtls_enabled': vm['is_mtls_enabled'], 'defined_tags': vm['defined_tags'], 'freeform_tags': vm['freeform_tags'], + 'compute_model': vm['compute_model'], 'sum_info': 'Database ExaCC ADB VM ' + vm['license_model'], 'sum_info_storage': 'Database - Storage (GB)', 'sum_size_gb': vm['db_node_storage_size_in_gbs'], @@ -2684,8 +2685,7 @@ def __get_database_db_exacc_adb_dedicated(self, region_name, compartment, infra_ databases = self.service.search_multi_items(self.service.C_DATABASE, self.service.C_DATABASE_ADB_DATABASE, 'autonomous_container_database_id', ct['id']) for arr in databases: db = self.__get_database_adb_database_info(arr) - db['name'] = str(db['db_name'] + " (" + db['display_name'] + ") - " + vm['license_model'] + " - " + db['lifecycle_state'] + " (" + str(db['sum_count']) + " OCPUs" + (" AutoScale" if db['is_auto_scaling_enabled'] else "") + ") - " + db['db_workload']) - db['sum_info'] = "Autonomous Database Dedicated " + str(db['db_workload']) + " (OCPUs) - " + vm['license_model'] + db['sum_info'] = "Autonomous Database Dedicated " + str(db['db_workload']) + " (" + db['compute_model'] + "s) - " + vm['license_model'] db['sum_info_stopped'] = "Stopped Autonomous Database Dedicated " + str(db['db_workload']) + " (Count) - " + vm['license_model'] db['sum_info_count'] = "Autonomous Database Dedicated " + str(db['db_workload']) + " (Count) - " + vm['license_model'] db['sum_info_storage'] = "Autonomous Database Dedicated (TB)" @@ -2860,9 +2860,14 @@ def __get_database_adb_database_info(self, dbs): try: freemsg = ", FreeTier" if dbs['is_free_tier'] else "" freesum = "Free " if dbs['is_free_tier'] else "" + role = (" - " + dbs['role']) if dbs['role'] else "" + open_mode = (" - " + dbs['open_mode']) if dbs['open_mode'] else "" + lifecycle = (" - " + dbs['lifecycle_state']) if dbs['lifecycle_state'] else "" + autoscale = (" AutoScale" if dbs['is_auto_scaling_enabled'] else "") + compute_count = str(dbs['compute_count']) + " " + dbs['compute_model'] value = { 'id': str(dbs['id']), - 'name': str(dbs['db_name']) + " (" + (str(dbs['display_name']) + ") - " + str(dbs['license_model']) + " - " + str(dbs['role']) + " - " + str(dbs['lifecycle_state']) + " (" + str(dbs['sum_count']) + " OCPUs" + (" AutoScale" if dbs['is_auto_scaling_enabled'] else "") + ") - " + dbs['db_workload'] + " - " + dbs['db_type'] + freemsg), + 'name': str(dbs['db_name']) + " (" + (str(dbs['display_name']) + ") - " + str(dbs['license_model']) + open_mode + role + lifecycle + " (" + compute_count + autoscale + ") - " + dbs['db_workload'] + " - " + dbs['db_type'] + freemsg), 'display_name': dbs['display_name'], 'license_model': dbs['license_model'], 'lifecycle_state': dbs['lifecycle_state'], @@ -2876,10 +2881,10 @@ def __get_database_adb_database_info(self, dbs): 'time_created': str(dbs['time_created'])[0:16], 'connection_strings': str(dbs['connection_strings']), 'connection_urls': str(dbs['connection_urls']), - 'sum_info': "Autonomous Database " + freesum + str(dbs['db_workload']) + " (OCPUs) - " + dbs['license_model'], + 'sum_info': "Autonomous Database " + freesum + str(dbs['db_workload']) + " " + dbs['compute_model'] + " - " + dbs['license_model'], 'sum_info_stopped': "Stopped Autonomous Database " + freesum + str(dbs['db_workload']) + " (Count) - " + dbs['license_model'], 'sum_info_count': "Autonomous Database " + freesum + str(dbs['db_workload']) + " (Count) - " + dbs['license_model'], - 'sum_count': str(dbs['sum_count']), + 'sum_count': str(dbs['compute_count']), 'sum_info_storage': "Autonomous Database " + freesum + "(TB)", 'sum_size_tb': str(dbs['data_storage_size_in_tbs']), 'whitelisted_ips': dbs['whitelisted_ips'], @@ -2922,7 +2927,52 @@ def __get_database_adb_database_info(self, dbs): 'vault_id': dbs['vault_id'], 'key_store_wallet_name': dbs['key_store_wallet_name'], 'key_store_id': dbs['key_store_id'], + 'in_memory_percentage': dbs['in_memory_percentage'], 'role': dbs['role'], + 'in_memory_area_in_gbs': dbs['in_memory_area_in_gbs'], + 'memory_per_oracle_compute_unit_in_gbs': dbs['memory_per_oracle_compute_unit_in_gbs'], + 'next_long_term_backup_time_stamp': dbs['next_long_term_backup_time_stamp'], + 'compute_model': dbs['compute_model'], + 'compute_count': dbs['compute_count'], + 'backup_retention_period_in_days': dbs['backup_retention_period_in_days'], + 'total_backup_storage_size_in_gbs': dbs['total_backup_storage_size_in_gbs'], + 'data_storage_size_in_gbs': dbs['data_storage_size_in_gbs'], + 'used_data_storage_size_in_gbs': dbs['used_data_storage_size_in_gbs'], + 'used_data_storage_size_in_tbs': dbs['used_data_storage_size_in_tbs'], + 'is_refreshable_clone': dbs['is_refreshable_clone'], + 'time_of_last_refresh': dbs['time_of_last_refresh'], + 'time_of_last_refresh_point': dbs['time_of_last_refresh_point'], + 'time_of_next_refresh': dbs['time_of_next_refresh'], + 'open_mode': dbs['open_mode'], + 'refreshable_status': dbs['refreshable_status'], + 'refreshable_mode': dbs['refreshable_mode'], + 'permission_level': dbs['permission_level'], + 'is_local_data_guard_enabled': dbs['is_local_data_guard_enabled'], + 'is_remote_data_guard_enabled': dbs['is_remote_data_guard_enabled'], + 'is_mtls_connection_required': dbs['is_mtls_connection_required'], + 'time_until_reconnect_clone_enabled': dbs['time_until_reconnect_clone_enabled'], + 'is_auto_scaling_for_storage_enabled': dbs['is_auto_scaling_for_storage_enabled'], + 'allocated_storage_size_in_tbs': dbs['allocated_storage_size_in_tbs'], + 'actual_used_data_storage_size_in_tbs': dbs['actual_used_data_storage_size_in_tbs'], + 'max_cpu_core_count': dbs['max_cpu_core_count'], + 'database_edition': dbs['database_edition'], + 'local_disaster_recovery_type': dbs['local_disaster_recovery_type'], + 'disaster_recovery_region_type': dbs['disaster_recovery_region_type'], + 'time_disaster_recovery_role_changed': dbs['time_disaster_recovery_role_changed'], + 'are_primary_whitelisted_ips_used': dbs['are_primary_whitelisted_ips_used'], + 'autonomous_maintenance_schedule_type': dbs['autonomous_maintenance_schedule_type'], + 'character_set': dbs['character_set'], + 'ncharacter_set': dbs['ncharacter_set'], + 'database_management_status': dbs['database_management_status'], + 'is_access_control_enabled': dbs['is_access_control_enabled'], + 'is_reconnect_clone_enabled': dbs['is_reconnect_clone_enabled'], + 'kms_key_lifecycle_details': dbs['kms_key_lifecycle_details'], + 'kms_key_version_id': dbs['kms_key_version_id'], + 'local_adg_auto_failover_max_data_loss_limit': dbs['local_adg_auto_failover_max_data_loss_limit'], + 'operations_insights_status': dbs['operations_insights_status'], + 'provisionable_cpus': dbs['provisionable_cpus'], + 'source_id': dbs['source_id'], + 'standby_whitelisted_ips': dbs['standby_whitelisted_ips'], 'backups': self.__get_database_adb_databases_backups(dbs['backups']) } @@ -3020,6 +3070,12 @@ def __get_database_adb_dedicated(self, region_name, compartment, infra_id): 'compartment_path': vm['compartment_path'], 'compartment_id': vm['compartment_id'], 'region_name': vm['region_name'], + 'compute_model': vm['compute_model'], + 'is_mtls_enabled_vm_cluster': vm['is_mtls_enabled_vm_cluster'], + 'scan_listener_port_tls': vm['scan_listener_port_tls'], + 'scan_listener_port_non_tls': vm['scan_listener_port_non_tls'], + 'time_database_ssl_certificate_expires': vm['time_database_ssl_certificate_expires'], + 'time_ords_certificate_expires': vm['time_ords_certificate_expires'], 'containers': []} # fetch the containers @@ -3032,8 +3088,7 @@ def __get_database_adb_dedicated(self, region_name, compartment, infra_id): databases = self.service.search_multi_items(self.service.C_DATABASE, self.service.C_DATABASE_ADB_DATABASE, 'autonomous_container_database_id', ct['id']) for arr in databases: db = self.__get_database_adb_database_info(arr) - db['name'] = str(db['db_name'] + " (" + db['display_name'] + ") - " + vm['license_model'] + " - " + db['lifecycle_state'] + " (" + str(db['sum_count']) + " OCPUs" + (" AutoScale" if db['is_auto_scaling_enabled'] else "") + ") - " + db['db_workload']) - db['sum_info'] = "Autonomous Database Dedicated " + str(db['db_workload']) + " (OCPUs) - " + vm['license_model'] + db['sum_info'] = "Autonomous Database Dedicated " + str(db['db_workload']) + " (" + db['compute_model'] + "s) - " + vm['license_model'] db['sum_info_stopped'] = "Stopped Autonomous Database Dedicated " + str(db['db_workload']) + " (Count) - " + vm['license_model'] db['sum_info_count'] = "Autonomous Database Dedicated " + str(db['db_workload']) + " (Count) - " + vm['license_model'] db['sum_info_storage'] = "Autonomous Database Dedicated (TB)" diff --git a/examples/showoci/showoci_output.py b/examples/showoci/showoci_output.py index 8f5f08ca81..ac0dc52145 100644 --- a/examples/showoci/showoci_output.py +++ b/examples/showoci/showoci_output.py @@ -21,7 +21,7 @@ class ShowOCIOutput(object): - version = "23.08.15" + version = "23.09.03" ########################################################################## # spaces for align @@ -1646,14 +1646,14 @@ def __print_database_db_autonomous(self, dbs): for db in dbs: print(self.taba + "ADB-S : " + db['name']) if 'cpu_core_count' in db: - print(self.tabs + "Size : " + str(db['cpu_core_count']) + " OCPUs, " + str(db['data_storage_size_in_tbs']) + "TB Storage") + print(self.tabs + "Size : " + str(db['compute_count']) + " " + db['compute_model'] + ", " + str(db['data_storage_size_in_tbs']) + "TB Storage") if 'time_created' in db: print(self.tabs + "Created : " + db['time_created']) if 'whitelisted_ips' in db: if db['whitelisted_ips']: print(self.tabs + "Allowed IPs: " + db['whitelisted_ips']) if 'private_endpoint' in db: - if db['private_endpoint'] != 'None': + if db['private_endpoint']: print(self.tabs + "Private EP : " + db['private_endpoint'] + ", Subnet: " + db['subnet_name']) if 'nsg_names' in db: for nsg in db['nsg_names']: @@ -4991,8 +4991,8 @@ def __csv_core_network_vcn_subnet(self, region_name, subnets, vcn, igw, sgw, nat for subnet in subnets: data = {'region_name': region_name, 'vcn_name': vcn['display_name'], - 'vcn_cidr': vcn['cidr_block'], - 'vcn_cidrs': vcn['cidr_blocks'], + 'vcn_cidr': "", + 'vcn_cidrs': str(','.join(x for x in vcn['cidr_blocks'])), 'vcn_compartment': vcn['compartment_name'], 'vcn_compartment_path': vcn['compartment_path'], 'internet_gateway': igw, @@ -5021,8 +5021,8 @@ def __csv_core_network_vcn_subnet(self, region_name, subnets, vcn, igw, sgw, nat for ip in subnet['private_ips']: data = {'region_name': region_name, 'vcn_name': vcn['display_name'], - 'vcn_cidr': vcn['cidr_block'], - 'vcn_cidrs': vcn['cidr_blocks'], + 'vcn_cidr': "", + 'vcn_cidrs': str(','.join(x for x in vcn['cidr_blocks'])), 'vcn_compartment': vcn['compartment_name'], 'vcn_compartment_path': vcn['compartment_path'], 'subnet_name': subnet['name'], @@ -5062,8 +5062,8 @@ def __csv_core_network_vcn_security_lists(self, region_name, sec_lists, vcn): if len(sl['sec_rules']) == 0: data = {'region_name': region_name, 'vcn_name': vcn['display_name'], - 'vcn_cidr': vcn['cidr_block'], - 'vcn_cidrs': vcn['cidr_blocks'], + 'vcn_cidr': "", + 'vcn_cidrs': str(','.join(x for x in vcn['cidr_blocks'])), 'vcn_compartment': vcn['compartment_name'], 'vcn_compartment_path': vcn['compartment_path'], 'sec_name': sl['name'], @@ -5083,8 +5083,8 @@ def __csv_core_network_vcn_security_lists(self, region_name, sec_lists, vcn): for slr in sl['sec_rules']: data = {'region_name': region_name, 'vcn_name': vcn['display_name'], - 'vcn_cidr': vcn['cidr_block'], - 'vcn_cidrs': vcn['cidr_blocks'], + 'vcn_cidr': "", + 'vcn_cidrs': str(','.join(x for x in vcn['cidr_blocks'])), 'vcn_compartment': vcn['compartment_name'], 'vcn_compartment_path': vcn['compartment_path'], 'sec_name': sl['name'], @@ -5311,8 +5311,8 @@ def __csv_core_network_vcn_security_groups(self, region_name, nsg, vcn): if len(sl['sec_rules']) == 0: data = {'region_name': region_name, 'vcn_name': vcn['display_name'], - 'vcn_cidr': vcn['cidr_block'], - 'vcn_cidrs': vcn['cidr_blocks'], + 'vcn_cidr': "", + 'vcn_cidrs': str(','.join(x for x in vcn['cidr_blocks'])), 'vcn_compartment': vcn['compartment_name'], 'vcn_compartment_path': vcn['compartment_path'], 'sec_name': sl['name'], @@ -5332,8 +5332,8 @@ def __csv_core_network_vcn_security_groups(self, region_name, nsg, vcn): for slr in sl['sec_rules']: data = {'region_name': region_name, 'vcn_name': vcn['display_name'], - 'vcn_cidr': vcn['cidr_block'], - 'vcn_cidrs': vcn['cidr_blocks'], + 'vcn_cidr': "", + 'vcn_cidrs': str(','.join(x for x in vcn['cidr_blocks'])), 'vcn_compartment': vcn['compartment_name'], 'vcn_compartment_path': vcn['compartment_path'], 'sec_name': sl['name'], @@ -5370,8 +5370,8 @@ def __csv_core_network_vcn_dhcp_options(self, region_name, dhcp_options, vcn): for dhcp in dhcp_options: data = {'region_name': region_name, 'vcn_name': vcn['display_name'], - 'vcn_cidr': vcn['cidr_block'], - 'vcn_cidrs': vcn['cidr_blocks'], + 'vcn_cidr': "", + 'vcn_cidrs': str(','.join(x for x in vcn['cidr_blocks'])), 'vcn_compartment': vcn['compartment_name'], 'vcn_compartment_path': vcn['compartment_path'], 'dhcp_name': dhcp['name'], @@ -5408,8 +5408,8 @@ def __csv_core_network_vcn_route_tables(self, region_name, route_tables, vcn): if len(rt['route_rules']) == 0: data = {'region_name': region_name, 'vcn_name': vcn['display_name'], - 'vcn_cidr': vcn['cidr_block'], - 'vcn_cidrs': vcn['cidr_blocks'], + 'vcn_cidr': "", + 'vcn_cidrs': str(','.join(x for x in vcn['cidr_blocks'])), 'vcn_compartment': vcn['compartment_name'], 'vcn_compartment_path': vcn['compartment_path'], 'route_name': rt['name'], @@ -5428,8 +5428,8 @@ def __csv_core_network_vcn_route_tables(self, region_name, route_tables, vcn): for rl in rt['route_rules']: data = {'region_name': region_name, 'vcn_name': vcn['display_name'], - 'vcn_cidr': vcn['cidr_block'], - 'vcn_cidrs': vcn['cidr_blocks'], + 'vcn_cidr': "", + 'vcn_cidrs': str(','.join(x for x in vcn['cidr_blocks'])), 'vcn_compartment': vcn['compartment_name'], 'vcn_compartment_path': vcn['compartment_path'], 'route_name': rt['name'], @@ -5516,8 +5516,8 @@ def __csv_core_network_vcn(self, region_name, vcns): 'compartment': vcn['compartment_name'], 'compartment_path': vcn['compartment_path'], 'name': vcn['display_name'], - 'cidr': vcn['cidr_block'], - 'cidrs': vcn['cidr_blocks'], + 'cidr': "", + 'cidrs': str(','.join(x for x in vcn['cidr_blocks'])), 'internet_gateway': igw, 'service_gateway': sgw, 'nat': nat, @@ -5633,6 +5633,8 @@ def __csv_database_db_system(self, region_name, list_db_systems): 'type': "DB System", 'name': dbs['display_name'], 'shape': dbs['shape'], + 'compute_model': 'OCPU', + 'compute_count': dbs['cpu_core_count'], 'cpu_core_count': dbs['cpu_core_count'], 'db_storage_gb': dbs['sum_size_gb'], 'shape_ocpus': dbs['shape_ocpu'], @@ -5810,6 +5812,8 @@ def __csv_database_db_exadata(self, region_name, list_exa): 'type': "ExaCS", 'name': dbs['display_name'], 'shape': dbs['shape'], + 'compute_model': 'OCPU', + 'compute_count': vm['cpu_core_count'], 'cpu_core_count': vm['cpu_core_count'], 'db_storage_gb': dbs['sum_size_gb'], 'shape_ocpus': dbs['shape_ocpu'], @@ -5957,6 +5961,8 @@ def __csv_database_db_exacc(self, region_name, list_exa): 'type': "ExaCC", 'name': dbs['display_name'], 'shape': dbs['shape'], + 'compute_model': 'OCPU', + 'compute_count': vm['cpus_enabled'], 'cpu_core_count': vm['cpus_enabled'], 'db_storage_gb': "", 'shape_ocpus': "", @@ -6014,6 +6020,8 @@ def __csv_database_db_exacc_autonomous_dedicated(self, region_name, databases): 'type': "Autonomous Dedicated " + str(db['db_workload']), 'name': db['display_name'], 'shape': vm['shape'], + 'compute_model': db['compute_model'], + 'compute_count': db['compute_count'], 'cpu_core_count': db['cpu_core_count'], 'db_storage_gb': str(int(db['data_storage_size_in_tbs']) * 1024), 'shape_ocpus': vm['ocpu_count'], @@ -6059,6 +6067,8 @@ def __csv_database_db_autonomous(self, region_name, databases): 'status': dbs['lifecycle_state'], 'type': "Autonomous " + dbs['db_workload'], 'name': dbs['display_name'], 'shape': "", + 'compute_model': dbs['compute_model'], + 'compute_count': dbs['compute_count'], 'cpu_core_count': dbs['cpu_core_count'], 'db_storage_gb': str(int(dbs['data_storage_size_in_tbs']) * 1024), 'shape_ocpus': "", @@ -6101,6 +6111,8 @@ def __csv_database_db_autonomous(self, region_name, databases): 'cluster_name': "", 'container_name': "", 'cpu_core_count': dbs['cpu_core_count'], + 'compute_model': dbs['compute_model'], + 'compute_count': dbs['compute_count'], 'db_storage_tb': dbs['data_storage_size_in_tbs'], 'db_version': dbs['db_version'], 'db_name': dbs['db_name'], @@ -6182,6 +6194,8 @@ def __csv_database_db_autonomous_dedicated(self, region_name, databases): 'name': db['display_name'], 'shape': dbs['shape'], 'cpu_core_count': db['cpu_core_count'], + 'compute_model': db['compute_model'], + 'compute_count': db['compute_count'], 'db_storage_gb': str(int(db['data_storage_size_in_tbs']) * 1024), 'shape_ocpus': vm['ocpu_count'], 'memory_gb': vm['memory_size_in_gbs'], @@ -6231,6 +6245,8 @@ def __csv_database_db_autonomous_databases(self, region_name, databases): 'infra_name': dbs['display_name'], 'cluster_name': vm['display_name'], 'container_name': ct['display_name'], + 'compute_model': db['compute_model'], + 'compute_count': db['compute_count'], 'cpu_core_count': db['cpu_core_count'], 'db_storage_tb': db['data_storage_size_in_tbs'], 'db_version': db['db_version'], diff --git a/examples/showoci/showoci_service.py b/examples/showoci/showoci_service.py index 48b4017633..99723b2c99 100644 --- a/examples/showoci/showoci_service.py +++ b/examples/showoci/showoci_service.py @@ -38,8 +38,8 @@ # class ShowOCIService ########################################################################## class ShowOCIService(object): - version = "23.08.15" - oci_compatible_version = "2.106.0" + version = "23.09.03" + oci_compatible_version = "2.110.2" thread_lock = threading.Lock() ########################################################################## @@ -2566,7 +2566,7 @@ def __load_core_network_vcn(self, virtual_network, compartments): 'id': str(vcn.id), 'name': str(', '.join(x for x in vcn.cidr_blocks)) + " - " + str(vcn.display_name) + " - " + str(vcn.vcn_domain_name), 'display_name': str(vcn.display_name), - 'cidr_block': self.get_value(vcn.cidr_block), + 'cidr_block': '', 'cidr_blocks': vcn.cidr_blocks, 'ipv6_private_cidr_blocks': vcn.ipv6_private_cidr_blocks, 'ipv6_cidr_blocks': vcn.ipv6_cidr_blocks, @@ -9588,6 +9588,12 @@ def __load_database_adb_d_vmclusters(self, database_client, compartments): 'compartment_name': str(compartment['name']), 'compartment_path': str(compartment['path']), 'compartment_id': str(compartment['id']), + 'compute_model': str(dbs.compute_model), + 'is_mtls_enabled_vm_cluster': str(dbs.is_mtls_enabled_vm_cluster), + 'scan_listener_port_tls': str(dbs.scan_listener_port_tls), + 'scan_listener_port_non_tls': str(dbs.scan_listener_port_non_tls), + 'time_database_ssl_certificate_expires': str(dbs.time_database_ssl_certificate_expires), + 'time_ords_certificate_expires': str(dbs.time_ords_certificate_expires), 'region_name': str(self.config['region'])} # license model @@ -9693,6 +9699,7 @@ def __load_database_adb_d_containers(self, database_client, compartments): 'db_version': str(arr.db_version), 'key_store_id': str(arr.key_store_id), 'key_store_wallet_name': str(arr.key_store_wallet_name), + 'compute_model': str(arr.compute_model), 'compartment_name': str(compartment['name']), 'compartment_path': str(compartment['path']), 'compartment_id': str(compartment['id']), @@ -9768,13 +9775,13 @@ def __load_database_adb_database(self, database_client, compartments): 'lifecycle_state': str(dbs.lifecycle_state), 'data_storage_size_in_tbs': str(dbs.data_storage_size_in_tbs), 'db_name': str(dbs.db_name), - 'cpu_core_count': str(dbs.cpu_core_count), + 'cpu_core_count': self.get_value(dbs.cpu_core_count), 'sum_count': ("0" if dbs.lifecycle_state == oci.database.models.AutonomousDatabaseSummary.LIFECYCLE_STATE_STOPPED else str(dbs.cpu_core_count)), - 'db_version': str(dbs.db_version), - 'service_console_url': str(dbs.service_console_url), + 'db_version': self.get_value(dbs.db_version), + 'service_console_url': self.get_value(dbs.service_console_url), 'connection_strings': "", - 'connection_urls': str(dbs.connection_urls), - 'time_created': str(dbs.time_created), + 'connection_urls': self.get_value(dbs.connection_urls), + 'time_created': self.get_value(dbs.time_created), 'compartment_name': str(compartment['name']), 'compartment_path': str(compartment['path']), 'compartment_id': str(compartment['id']), @@ -9786,41 +9793,97 @@ def __load_database_adb_database(self, database_client, compartments): 'db_type': ("ATP" if str(dbs.db_workload) == "OLTP" else "ADWC"), 'is_auto_scaling_enabled': dbs.is_auto_scaling_enabled, 'is_dedicated': dbs.is_dedicated, - 'subnet_id': str(dbs.subnet_id), - 'data_safe_status': str(dbs.data_safe_status), - 'time_maintenance_begin': str(dbs.time_maintenance_begin), - 'time_maintenance_end': str(dbs.time_maintenance_end), + 'subnet_id': self.get_value(dbs.subnet_id), + 'data_safe_status': self.get_value(dbs.data_safe_status), + 'time_maintenance_begin': self.get_value(dbs.time_maintenance_begin), + 'time_maintenance_end': self.get_value(dbs.time_maintenance_end), 'nsg_ids': dbs.nsg_ids, - 'private_endpoint': str(dbs.private_endpoint), - 'private_endpoint_label': str(dbs.private_endpoint_label), + 'private_endpoint': self.get_value(dbs.private_endpoint), + 'private_endpoint_label': self.get_value(dbs.private_endpoint_label), 'backups': [], - 'autonomous_container_database_id': str(dbs.autonomous_container_database_id), + 'autonomous_container_database_id': self.get_value(dbs.autonomous_container_database_id), 'is_data_guard_enabled': dbs.is_data_guard_enabled, 'is_free_tier': dbs.is_free_tier, 'is_preview': dbs.is_preview, - 'infrastructure_type': str(dbs.infrastructure_type), - 'time_deletion_of_free_autonomous_database': str(dbs.time_deletion_of_free_autonomous_database), - 'time_reclamation_of_free_autonomous_database': str(dbs.time_reclamation_of_free_autonomous_database), + 'infrastructure_type': self.get_value(dbs.infrastructure_type), + 'time_deletion_of_free_autonomous_database': self.get_value(dbs.time_deletion_of_free_autonomous_database), + 'time_reclamation_of_free_autonomous_database': self.get_value(dbs.time_reclamation_of_free_autonomous_database), 'system_tags': dbs.system_tags, - 'time_of_last_switchover': str(dbs.time_of_last_switchover), - 'time_of_last_failover': str(dbs.time_of_last_failover), - 'failed_data_recovery_in_seconds': str(dbs.failed_data_recovery_in_seconds), + 'time_of_last_switchover': self.get_value(dbs.time_of_last_switchover), + 'time_of_last_failover': self.get_value(dbs.time_of_last_failover), + 'failed_data_recovery_in_seconds': self.get_value(dbs.failed_data_recovery_in_seconds), 'standby_lag_time_in_seconds': "", 'standby_lifecycle_state': "", 'peer_db_ids': dbs.peer_db_ids, - 'time_data_guard_role_changed': str(dbs.time_data_guard_role_changed), - 'time_local_data_guard_enabled': str(dbs.time_local_data_guard_enabled), - 'dataguard_region_type': str(dbs.dataguard_region_type), + 'time_data_guard_role_changed': self.get_value(dbs.time_data_guard_role_changed), + 'time_local_data_guard_enabled': self.get_value(dbs.time_local_data_guard_enabled), + 'dataguard_region_type': self.get_value(dbs.dataguard_region_type), 'customer_contacts': "" if dbs.customer_contacts is None else str(', '.join(x.email for x in dbs.customer_contacts)), 'supported_regions_to_clone_to': dbs.supported_regions_to_clone_to, - 'kms_key_id': str(dbs.kms_key_id), - 'vault_id': str(dbs.vault_id), - 'key_store_wallet_name': str(dbs.key_store_wallet_name), - 'key_store_id': str(dbs.key_store_id), - 'available_upgrade_versions': str(dbs.available_upgrade_versions), - 'role': str(dbs.role) + 'kms_key_id': self.get_value(dbs.kms_key_id), + 'vault_id': self.get_value(dbs.vault_id), + 'key_store_wallet_name': self.get_value(dbs.key_store_wallet_name), + 'key_store_id': self.get_value(dbs.key_store_id), + 'available_upgrade_versions': self.get_value(dbs.available_upgrade_versions), + 'role': self.get_value(dbs.role), + 'in_memory_percentage': self.get_value(dbs.in_memory_percentage), + 'in_memory_area_in_gbs': self.get_value(dbs.in_memory_area_in_gbs), + 'memory_per_oracle_compute_unit_in_gbs': self.get_value(dbs.memory_per_oracle_compute_unit_in_gbs), + 'next_long_term_backup_time_stamp': self.get_value(dbs.next_long_term_backup_time_stamp), + 'compute_model': self.get_value(dbs.compute_model), + 'compute_count': self.get_value(dbs.compute_count), + 'backup_retention_period_in_days': self.get_value(dbs.backup_retention_period_in_days), + 'total_backup_storage_size_in_gbs': self.get_value(dbs.total_backup_storage_size_in_gbs), + 'data_storage_size_in_gbs': self.get_value(dbs.data_storage_size_in_gbs), + 'used_data_storage_size_in_gbs': self.get_value(dbs.used_data_storage_size_in_gbs), + 'is_refreshable_clone': self.get_value(dbs.is_refreshable_clone), + 'time_of_last_refresh': self.get_value(dbs.time_of_last_refresh), + 'time_of_last_refresh_point': self.get_value(dbs.time_of_last_refresh_point), + 'time_of_next_refresh': self.get_value(dbs.time_of_next_refresh), + 'open_mode': self.get_value(dbs.open_mode), + 'refreshable_status': self.get_value(dbs.refreshable_status), + 'refreshable_mode': self.get_value(dbs.refreshable_mode), + 'permission_level': self.get_value(dbs.permission_level), + 'is_local_data_guard_enabled': self.get_value(dbs.is_local_data_guard_enabled), + 'is_remote_data_guard_enabled': self.get_value(dbs.is_remote_data_guard_enabled), + 'is_mtls_connection_required': self.get_value(dbs.is_mtls_connection_required), + 'time_until_reconnect_clone_enabled': self.get_value(dbs.time_until_reconnect_clone_enabled), + 'is_auto_scaling_for_storage_enabled': self.get_value(dbs.is_auto_scaling_for_storage_enabled), + 'allocated_storage_size_in_tbs': self.get_value(dbs.allocated_storage_size_in_tbs), + 'actual_used_data_storage_size_in_tbs': self.get_value(dbs.actual_used_data_storage_size_in_tbs), + 'max_cpu_core_count': self.get_value(dbs.max_cpu_core_count), + 'database_edition': self.get_value(dbs.database_edition), + 'local_disaster_recovery_type': self.get_value(dbs.local_disaster_recovery_type), + 'disaster_recovery_region_type': self.get_value(dbs.disaster_recovery_region_type), + 'time_disaster_recovery_role_changed': self.get_value(dbs.time_disaster_recovery_role_changed), + 'are_primary_whitelisted_ips_used': self.get_value(dbs.are_primary_whitelisted_ips_used), + 'autonomous_maintenance_schedule_type': self.get_value(dbs.autonomous_maintenance_schedule_type), + 'character_set': self.get_value(dbs.character_set), + 'ncharacter_set': self.get_value(dbs.ncharacter_set), + 'database_management_status': self.get_value(dbs.database_management_status), + 'is_access_control_enabled': self.get_value(dbs.is_access_control_enabled), + 'is_reconnect_clone_enabled': self.get_value(dbs.is_reconnect_clone_enabled), + 'kms_key_lifecycle_details': self.get_value(dbs.kms_key_lifecycle_details), + 'kms_key_version_id': self.get_value(dbs.kms_key_version_id), + 'license_model': self.get_value(dbs.license_model), + 'local_adg_auto_failover_max_data_loss_limit': self.get_value(dbs.local_adg_auto_failover_max_data_loss_limit), + 'operations_insights_status': self.get_value(dbs.operations_insights_status), + 'provisionable_cpus': dbs.provisionable_cpus, + 'source_id': self.get_value(dbs.source_id), + 'standby_whitelisted_ips': self.get_value(dbs.standby_whitelisted_ips), + 'used_data_storage_size_in_tbs': self.get_value(dbs.used_data_storage_size_in_tbs) } + # Not included: + # apex_details (oci.database.models.AutonomousDatabaseApex) + # db_tools_details (list[oci.database.models.DatabaseTool]) + # key_history_entry (list[oci.database.models.AutonomousDatabaseKeyHistoryEntry]) + # local_standby_db (oci.database.models.AutonomousDatabaseStandbySummary) + # long_term_backup_schedule (oci.database.models.LongTermBackUpScheduleDetails) + # remote_disaster_recovery_configuration (oci.database.models.DisasterRecoveryConfiguration) + # scheduled_operations (list[oci.database.models.ScheduledOperationDetails]) + # standby_db (oci.database.models.AutonomousDatabaseStandbySummary) + # connection string if dbs.connection_strings: if dbs.connection_strings.all_connection_strings: @@ -16404,8 +16467,8 @@ def __load_identity_domain_authentication_factor_settings(self, identity_domain_ if self.skip_threads: print(".", end="") - ext_third_party_auth_factor = var.urnietfparamsscimschemasoracleidcsextensionthird_party_authentication_factor_settings - ext_fido_auth_factor = var.urnietfparamsscimschemasoracleidcsextensionfido_authentication_factor_settings + ext_third_party_auth_factor = var.urn_ietf_params_scim_schemas_oracle_idcs_extension_third_party_authentication_factor_settings + ext_fido_auth_factor = var.urn_ietf_params_scim_schemas_oracle_idcs_extension_fido_authentication_factor_settings data.append({ 'id': self.get_value(var.id), diff --git a/src/oci/__init__.py b/src/oci/__init__.py index 60472adaae..34fa9146e8 100644 --- a/src/oci/__init__.py +++ b/src/oci/__init__.py @@ -2,7 +2,7 @@ # Copyright (c) 2016, 2023, Oracle and/or its affiliates. All rights reserved. # This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. -from . import auth, config, constants, decorators, exceptions, regions, pagination, retry, fips, circuit_breaker +from . import auth, config, constants, decorators, exceptions, regions, pagination, retry, fips, circuit_breaker, alloy from .base_client import BaseClient from .request import Request from .response import Response @@ -18,7 +18,7 @@ pass else: __all__ = [ - "BaseClient", "Error", "Request", "Response", "Signer", "config", "constants", "decorators", "exceptions", "regions", "wait_until", "pagination", "auth", "retry", "fips", "circuit_breaker", + "BaseClient", "Error", "Request", "Response", "Signer", "config", "constants", "decorators", "exceptions", "regions", "wait_until", "pagination", "auth", "retry", "fips", "circuit_breaker", "alloy", "access_governance_cp", "adm", "ai_anomaly_detection", "ai_document", "ai_language", "ai_speech", "ai_vision", "analytics", "announcements_service", "apigateway", "apm_config", "apm_control_plane", "apm_synthetics", "apm_traces", "application_migration", "appmgmt_control", "artifacts", "audit", "autoscaling", "bastion", "bds", "blockchain", "budget", "certificates", "certificates_management", "cims", "cloud_bridge", "cloud_guard", "cloud_migrations", "compute_cloud_at_customer", "compute_instance_agent", "container_engine", "container_instances", "core", "dashboard_service", "data_catalog", "data_flow", "data_integration", "data_labeling_service", "data_labeling_service_dataplane", "data_safe", "data_science", "database", "database_management", "database_migration", "database_tools", "devops", "disaster_recovery", "dns", "dts", "em_warehouse", "email", "events", "file_storage", "fleet_software_update", "functions", "fusion_apps", "generic_artifacts_content", "golden_gate", "governance_rules_control_plane", "healthchecks", "identity", "identity_data_plane", "identity_domains", "integration", "jms", "key_management", "license_manager", "limits", "load_balancer", "lockbox", "log_analytics", "logging", "loggingingestion", "loggingsearch", "management_agent", "management_dashboard", "marketplace", "media_services", "monitoring", "mysql", "network_firewall", "network_load_balancer", "nosql", "object_storage", "oce", "oci_control_center", "ocvp", "oda", "onesubscription", "ons", "opa", "opensearch", "operator_access_control", "opsi", "optimizer", "os_management", "os_management_hub", "osp_gateway", "osub_billing_schedule", "osub_organization_subscription", "osub_subscription", "osub_usage", "queue", "recovery", "resource_manager", "resource_search", "rover", "sch", "secrets", "service_catalog", "service_manager_proxy", "service_mesh", "stack_monitoring", "streaming", "tenant_manager_control_plane", "threat_intelligence", "usage", "usage_api", "vault", "vbs_inst", "visual_builder", "vn_monitoring", "vulnerability_scanning", "waa", "waas", "waf", "work_requests" ] if sys.version_info >= (3, 7) and os.getenv("OCI_PYTHON_SDK_LAZY_IMPORTS_DISABLED", "False").lower() != "true": diff --git a/src/oci/access_governance_cp/access_governance_cp_client.py b/src/oci/access_governance_cp/access_governance_cp_client.py index 7f1c1d68c1..7d080a7e52 100644 --- a/src/oci/access_governance_cp/access_governance_cp_client.py +++ b/src/oci/access_governance_cp/access_governance_cp_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import access_governance_cp_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("access_governance_cp"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/adm/application_dependency_management_client.py b/src/oci/adm/application_dependency_management_client.py index 105b3bbd42..56d9051839 100644 --- a/src/oci/adm/application_dependency_management_client.py +++ b/src/oci/adm/application_dependency_management_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import adm_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("adm"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/ai_anomaly_detection/anomaly_detection_client.py b/src/oci/ai_anomaly_detection/anomaly_detection_client.py index 537e08d720..57b24e8552 100644 --- a/src/oci/ai_anomaly_detection/anomaly_detection_client.py +++ b/src/oci/ai_anomaly_detection/anomaly_detection_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import ai_anomaly_detection_type_mapping missing = Sentinel("Missing") @@ -76,6 +78,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("ai_anomaly_detection"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/ai_document/ai_service_document_client.py b/src/oci/ai_document/ai_service_document_client.py index 5527d74c2e..de15f6a144 100644 --- a/src/oci/ai_document/ai_service_document_client.py +++ b/src/oci/ai_document/ai_service_document_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import ai_document_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("ai_document"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/ai_language/ai_service_language_client.py b/src/oci/ai_language/ai_service_language_client.py index a6bbbc609b..8b050fdc51 100644 --- a/src/oci/ai_language/ai_service_language_client.py +++ b/src/oci/ai_language/ai_service_language_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import ai_language_type_mapping missing = Sentinel("Missing") @@ -76,6 +78,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("ai_language"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/ai_speech/ai_service_speech_client.py b/src/oci/ai_speech/ai_service_speech_client.py index 046f3cfc03..c69126847d 100644 --- a/src/oci/ai_speech/ai_service_speech_client.py +++ b/src/oci/ai_speech/ai_service_speech_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import ai_speech_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("ai_speech"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/ai_vision/ai_service_vision_client.py b/src/oci/ai_vision/ai_service_vision_client.py index e143937a23..82f84c17f8 100644 --- a/src/oci/ai_vision/ai_service_vision_client.py +++ b/src/oci/ai_vision/ai_service_vision_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import ai_vision_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("ai_vision"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] @@ -293,7 +298,7 @@ def cancel_document_job(self, document_job_id, **kwargs): :param str document_job_id: (required) - Document job id. + The document job ID. :param str if_match: (optional) For optimistic concurrency control. In the PUT or DELETE call @@ -396,7 +401,7 @@ def cancel_image_job(self, image_job_id, **kwargs): :param str image_job_id: (required) - Image job id. + The image job ID. :param str if_match: (optional) For optimistic concurrency control. In the PUT or DELETE call @@ -1408,7 +1413,7 @@ def get_document_job(self, document_job_id, **kwargs): :param str document_job_id: (required) - Document job id. + The document job ID. :param str opc_request_id: (optional) The client request ID for tracing. @@ -1504,7 +1509,7 @@ def get_image_job(self, image_job_id, **kwargs): :param str image_job_id: (required) - Image job id. + The image job ID. :param str opc_request_id: (optional) The client request ID for tracing. diff --git a/src/oci/ai_vision/models/__init__.py b/src/oci/ai_vision/models/__init__.py index 9a4f33a78e..5991e37137 100644 --- a/src/oci/ai_vision/models/__init__.py +++ b/src/oci/ai_vision/models/__init__.py @@ -33,6 +33,8 @@ from .document_metadata import DocumentMetadata from .document_table_detection_feature import DocumentTableDetectionFeature from .document_text_detection_feature import DocumentTextDetectionFeature +from .face import Face +from .face_detection_feature import FaceDetectionFeature from .field_label import FieldLabel from .field_name import FieldName from .field_value import FieldValue @@ -48,6 +50,7 @@ from .inline_image_details import InlineImageDetails from .input_location import InputLocation from .label import Label +from .landmark import Landmark from .line import Line from .model import Model from .model_collection import ModelCollection @@ -115,6 +118,8 @@ "DocumentMetadata": DocumentMetadata, "DocumentTableDetectionFeature": DocumentTableDetectionFeature, "DocumentTextDetectionFeature": DocumentTextDetectionFeature, + "Face": Face, + "FaceDetectionFeature": FaceDetectionFeature, "FieldLabel": FieldLabel, "FieldName": FieldName, "FieldValue": FieldValue, @@ -130,6 +135,7 @@ "InlineImageDetails": InlineImageDetails, "InputLocation": InputLocation, "Label": Label, + "Landmark": Landmark, "Line": Line, "Model": Model, "ModelCollection": ModelCollection, diff --git a/src/oci/ai_vision/models/analyze_image_result.py b/src/oci/ai_vision/models/analyze_image_result.py index eee576e3ab..60f9d022bd 100644 --- a/src/oci/ai_vision/models/analyze_image_result.py +++ b/src/oci/ai_vision/models/analyze_image_result.py @@ -36,6 +36,10 @@ def __init__(self, **kwargs): The value to assign to the image_text property of this AnalyzeImageResult. :type image_text: oci.ai_vision.models.ImageText + :param detected_faces: + The value to assign to the detected_faces property of this AnalyzeImageResult. + :type detected_faces: list[oci.ai_vision.models.Face] + :param image_classification_model_version: The value to assign to the image_classification_model_version property of this AnalyzeImageResult. :type image_classification_model_version: str @@ -48,6 +52,10 @@ def __init__(self, **kwargs): The value to assign to the text_detection_model_version property of this AnalyzeImageResult. :type text_detection_model_version: str + :param face_detection_model_version: + The value to assign to the face_detection_model_version property of this AnalyzeImageResult. + :type face_detection_model_version: str + :param errors: The value to assign to the errors property of this AnalyzeImageResult. :type errors: list[oci.ai_vision.models.ProcessingError] @@ -58,9 +66,11 @@ def __init__(self, **kwargs): 'labels': 'list[Label]', 'ontology_classes': 'list[OntologyClass]', 'image_text': 'ImageText', + 'detected_faces': 'list[Face]', 'image_classification_model_version': 'str', 'object_detection_model_version': 'str', 'text_detection_model_version': 'str', + 'face_detection_model_version': 'str', 'errors': 'list[ProcessingError]' } @@ -69,9 +79,11 @@ def __init__(self, **kwargs): 'labels': 'labels', 'ontology_classes': 'ontologyClasses', 'image_text': 'imageText', + 'detected_faces': 'detectedFaces', 'image_classification_model_version': 'imageClassificationModelVersion', 'object_detection_model_version': 'objectDetectionModelVersion', 'text_detection_model_version': 'textDetectionModelVersion', + 'face_detection_model_version': 'faceDetectionModelVersion', 'errors': 'errors' } @@ -79,9 +91,11 @@ def __init__(self, **kwargs): self._labels = None self._ontology_classes = None self._image_text = None + self._detected_faces = None self._image_classification_model_version = None self._object_detection_model_version = None self._text_detection_model_version = None + self._face_detection_model_version = None self._errors = None @property @@ -176,6 +190,30 @@ def image_text(self, image_text): """ self._image_text = image_text + @property + def detected_faces(self): + """ + Gets the detected_faces of this AnalyzeImageResult. + The detected faces. + + + :return: The detected_faces of this AnalyzeImageResult. + :rtype: list[oci.ai_vision.models.Face] + """ + return self._detected_faces + + @detected_faces.setter + def detected_faces(self, detected_faces): + """ + Sets the detected_faces of this AnalyzeImageResult. + The detected faces. + + + :param detected_faces: The detected_faces of this AnalyzeImageResult. + :type: list[oci.ai_vision.models.Face] + """ + self._detected_faces = detected_faces + @property def image_classification_model_version(self): """ @@ -248,6 +286,30 @@ def text_detection_model_version(self, text_detection_model_version): """ self._text_detection_model_version = text_detection_model_version + @property + def face_detection_model_version(self): + """ + Gets the face_detection_model_version of this AnalyzeImageResult. + The face detection model version. + + + :return: The face_detection_model_version of this AnalyzeImageResult. + :rtype: str + """ + return self._face_detection_model_version + + @face_detection_model_version.setter + def face_detection_model_version(self, face_detection_model_version): + """ + Sets the face_detection_model_version of this AnalyzeImageResult. + The face detection model version. + + + :param face_detection_model_version: The face_detection_model_version of this AnalyzeImageResult. + :type: str + """ + self._face_detection_model_version = face_detection_model_version + @property def errors(self): """ diff --git a/src/oci/ai_vision/models/data_science_labeling_dataset.py b/src/oci/ai_vision/models/data_science_labeling_dataset.py index 1256b74811..76e3367f30 100644 --- a/src/oci/ai_vision/models/data_science_labeling_dataset.py +++ b/src/oci/ai_vision/models/data_science_labeling_dataset.py @@ -48,7 +48,7 @@ def __init__(self, **kwargs): @property def dataset_id(self): """ - Gets the dataset_id of this DataScienceLabelingDataset. + **[Required]** Gets the dataset_id of this DataScienceLabelingDataset. OCID of the Data Labeling dataset. diff --git a/src/oci/ai_vision/models/face.py b/src/oci/ai_vision/models/face.py new file mode 100644 index 0000000000..1d7e606b65 --- /dev/null +++ b/src/oci/ai_vision/models/face.py @@ -0,0 +1,161 @@ +# coding: utf-8 +# Copyright (c) 2016, 2023, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20220125 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class Face(object): + """ + The detected face. + """ + + def __init__(self, **kwargs): + """ + Initializes a new Face object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param confidence: + The value to assign to the confidence property of this Face. + :type confidence: float + + :param bounding_polygon: + The value to assign to the bounding_polygon property of this Face. + :type bounding_polygon: oci.ai_vision.models.BoundingPolygon + + :param quality_score: + The value to assign to the quality_score property of this Face. + :type quality_score: float + + :param landmarks: + The value to assign to the landmarks property of this Face. + :type landmarks: list[oci.ai_vision.models.Landmark] + + """ + self.swagger_types = { + 'confidence': 'float', + 'bounding_polygon': 'BoundingPolygon', + 'quality_score': 'float', + 'landmarks': 'list[Landmark]' + } + + self.attribute_map = { + 'confidence': 'confidence', + 'bounding_polygon': 'boundingPolygon', + 'quality_score': 'qualityScore', + 'landmarks': 'landmarks' + } + + self._confidence = None + self._bounding_polygon = None + self._quality_score = None + self._landmarks = None + + @property + def confidence(self): + """ + **[Required]** Gets the confidence of this Face. + The confidence score, between 0 and 1. + + + :return: The confidence of this Face. + :rtype: float + """ + return self._confidence + + @confidence.setter + def confidence(self, confidence): + """ + Sets the confidence of this Face. + The confidence score, between 0 and 1. + + + :param confidence: The confidence of this Face. + :type: float + """ + self._confidence = confidence + + @property + def bounding_polygon(self): + """ + **[Required]** Gets the bounding_polygon of this Face. + + :return: The bounding_polygon of this Face. + :rtype: oci.ai_vision.models.BoundingPolygon + """ + return self._bounding_polygon + + @bounding_polygon.setter + def bounding_polygon(self, bounding_polygon): + """ + Sets the bounding_polygon of this Face. + + :param bounding_polygon: The bounding_polygon of this Face. + :type: oci.ai_vision.models.BoundingPolygon + """ + self._bounding_polygon = bounding_polygon + + @property + def quality_score(self): + """ + **[Required]** Gets the quality_score of this Face. + The quality score of the face detected, between 0 and 1. + + + :return: The quality_score of this Face. + :rtype: float + """ + return self._quality_score + + @quality_score.setter + def quality_score(self, quality_score): + """ + Sets the quality_score of this Face. + The quality score of the face detected, between 0 and 1. + + + :param quality_score: The quality_score of this Face. + :type: float + """ + self._quality_score = quality_score + + @property + def landmarks(self): + """ + Gets the landmarks of this Face. + A point of interest within a face. + + + :return: The landmarks of this Face. + :rtype: list[oci.ai_vision.models.Landmark] + """ + return self._landmarks + + @landmarks.setter + def landmarks(self, landmarks): + """ + Sets the landmarks of this Face. + A point of interest within a face. + + + :param landmarks: The landmarks of this Face. + :type: list[oci.ai_vision.models.Landmark] + """ + self._landmarks = landmarks + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/ai_vision/models/face_detection_feature.py b/src/oci/ai_vision/models/face_detection_feature.py new file mode 100644 index 0000000000..e283c8430c --- /dev/null +++ b/src/oci/ai_vision/models/face_detection_feature.py @@ -0,0 +1,113 @@ +# coding: utf-8 +# Copyright (c) 2016, 2023, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20220125 + +from .image_feature import ImageFeature +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class FaceDetectionFeature(ImageFeature): + """ + The face detection parameters. + """ + + def __init__(self, **kwargs): + """ + Initializes a new FaceDetectionFeature object with values from keyword arguments. The default value of the :py:attr:`~oci.ai_vision.models.FaceDetectionFeature.feature_type` attribute + of this class is ``FACE_DETECTION`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param feature_type: + The value to assign to the feature_type property of this FaceDetectionFeature. + Allowed values for this property are: "IMAGE_CLASSIFICATION", "OBJECT_DETECTION", "TEXT_DETECTION", "FACE_DETECTION" + :type feature_type: str + + :param max_results: + The value to assign to the max_results property of this FaceDetectionFeature. + :type max_results: int + + :param should_return_landmarks: + The value to assign to the should_return_landmarks property of this FaceDetectionFeature. + :type should_return_landmarks: bool + + """ + self.swagger_types = { + 'feature_type': 'str', + 'max_results': 'int', + 'should_return_landmarks': 'bool' + } + + self.attribute_map = { + 'feature_type': 'featureType', + 'max_results': 'maxResults', + 'should_return_landmarks': 'shouldReturnLandmarks' + } + + self._feature_type = None + self._max_results = None + self._should_return_landmarks = None + self._feature_type = 'FACE_DETECTION' + + @property + def max_results(self): + """ + Gets the max_results of this FaceDetectionFeature. + The maximum number of results to return. + + + :return: The max_results of this FaceDetectionFeature. + :rtype: int + """ + return self._max_results + + @max_results.setter + def max_results(self, max_results): + """ + Sets the max_results of this FaceDetectionFeature. + The maximum number of results to return. + + + :param max_results: The max_results of this FaceDetectionFeature. + :type: int + """ + self._max_results = max_results + + @property + def should_return_landmarks(self): + """ + Gets the should_return_landmarks of this FaceDetectionFeature. + Whether or not return face landmarks. + + + :return: The should_return_landmarks of this FaceDetectionFeature. + :rtype: bool + """ + return self._should_return_landmarks + + @should_return_landmarks.setter + def should_return_landmarks(self, should_return_landmarks): + """ + Sets the should_return_landmarks of this FaceDetectionFeature. + Whether or not return face landmarks. + + + :param should_return_landmarks: The should_return_landmarks of this FaceDetectionFeature. + :type: bool + """ + self._should_return_landmarks = should_return_landmarks + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/ai_vision/models/image_classification_feature.py b/src/oci/ai_vision/models/image_classification_feature.py index 16655ae0c5..9b44fe9c59 100644 --- a/src/oci/ai_vision/models/image_classification_feature.py +++ b/src/oci/ai_vision/models/image_classification_feature.py @@ -23,7 +23,7 @@ def __init__(self, **kwargs): :param feature_type: The value to assign to the feature_type property of this ImageClassificationFeature. - Allowed values for this property are: "IMAGE_CLASSIFICATION", "OBJECT_DETECTION", "TEXT_DETECTION" + Allowed values for this property are: "IMAGE_CLASSIFICATION", "OBJECT_DETECTION", "TEXT_DETECTION", "FACE_DETECTION" :type feature_type: str :param max_results: diff --git a/src/oci/ai_vision/models/image_feature.py b/src/oci/ai_vision/models/image_feature.py index 84d0852979..7c936a1a26 100644 --- a/src/oci/ai_vision/models/image_feature.py +++ b/src/oci/ai_vision/models/image_feature.py @@ -27,12 +27,17 @@ class ImageFeature(object): #: This constant has a value of "TEXT_DETECTION" FEATURE_TYPE_TEXT_DETECTION = "TEXT_DETECTION" + #: A constant which can be used with the feature_type property of a ImageFeature. + #: This constant has a value of "FACE_DETECTION" + FEATURE_TYPE_FACE_DETECTION = "FACE_DETECTION" + def __init__(self, **kwargs): """ Initializes a new ImageFeature object with values from keyword arguments. This class has the following subclasses and if you are using this class as input to a service operations then you should favor using a subclass over the base class: * :class:`~oci.ai_vision.models.ImageTextDetectionFeature` + * :class:`~oci.ai_vision.models.FaceDetectionFeature` * :class:`~oci.ai_vision.models.ImageObjectDetectionFeature` * :class:`~oci.ai_vision.models.ImageClassificationFeature` @@ -40,7 +45,7 @@ def __init__(self, **kwargs): :param feature_type: The value to assign to the feature_type property of this ImageFeature. - Allowed values for this property are: "IMAGE_CLASSIFICATION", "OBJECT_DETECTION", "TEXT_DETECTION", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "IMAGE_CLASSIFICATION", "OBJECT_DETECTION", "TEXT_DETECTION", "FACE_DETECTION", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type feature_type: str @@ -66,6 +71,9 @@ def get_subtype(object_dictionary): if type == 'TEXT_DETECTION': return 'ImageTextDetectionFeature' + if type == 'FACE_DETECTION': + return 'FaceDetectionFeature' + if type == 'OBJECT_DETECTION': return 'ImageObjectDetectionFeature' @@ -82,9 +90,10 @@ def feature_type(self): The allowed values are: - `IMAGE_CLASSIFICATION`: Label the image. - `OBJECT_DETECTION`: Identify objects in the image with bounding boxes. - - `TEXT_DETECTION`: Recognize text in the image. + - `TEXT_DETECTION`: Recognize text at the word and line level. + - `FACE_DETECTION`: Identify faces in the image with bounding boxes and face landmarks. - Allowed values for this property are: "IMAGE_CLASSIFICATION", "OBJECT_DETECTION", "TEXT_DETECTION", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "IMAGE_CLASSIFICATION", "OBJECT_DETECTION", "TEXT_DETECTION", "FACE_DETECTION", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -101,13 +110,14 @@ def feature_type(self, feature_type): The allowed values are: - `IMAGE_CLASSIFICATION`: Label the image. - `OBJECT_DETECTION`: Identify objects in the image with bounding boxes. - - `TEXT_DETECTION`: Recognize text in the image. + - `TEXT_DETECTION`: Recognize text at the word and line level. + - `FACE_DETECTION`: Identify faces in the image with bounding boxes and face landmarks. :param feature_type: The feature_type of this ImageFeature. :type: str """ - allowed_values = ["IMAGE_CLASSIFICATION", "OBJECT_DETECTION", "TEXT_DETECTION"] + allowed_values = ["IMAGE_CLASSIFICATION", "OBJECT_DETECTION", "TEXT_DETECTION", "FACE_DETECTION"] if not value_allowed_none_or_none_sentinel(feature_type, allowed_values): feature_type = 'UNKNOWN_ENUM_VALUE' self._feature_type = feature_type diff --git a/src/oci/ai_vision/models/image_object_detection_feature.py b/src/oci/ai_vision/models/image_object_detection_feature.py index 3a94ec1bb8..fb9367bba4 100644 --- a/src/oci/ai_vision/models/image_object_detection_feature.py +++ b/src/oci/ai_vision/models/image_object_detection_feature.py @@ -23,7 +23,7 @@ def __init__(self, **kwargs): :param feature_type: The value to assign to the feature_type property of this ImageObjectDetectionFeature. - Allowed values for this property are: "IMAGE_CLASSIFICATION", "OBJECT_DETECTION", "TEXT_DETECTION" + Allowed values for this property are: "IMAGE_CLASSIFICATION", "OBJECT_DETECTION", "TEXT_DETECTION", "FACE_DETECTION" :type feature_type: str :param max_results: diff --git a/src/oci/ai_vision/models/image_text_detection_feature.py b/src/oci/ai_vision/models/image_text_detection_feature.py index ef834b5e01..e7b8c56467 100644 --- a/src/oci/ai_vision/models/image_text_detection_feature.py +++ b/src/oci/ai_vision/models/image_text_detection_feature.py @@ -123,7 +123,7 @@ def __init__(self, **kwargs): :param feature_type: The value to assign to the feature_type property of this ImageTextDetectionFeature. - Allowed values for this property are: "IMAGE_CLASSIFICATION", "OBJECT_DETECTION", "TEXT_DETECTION", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "IMAGE_CLASSIFICATION", "OBJECT_DETECTION", "TEXT_DETECTION", "FACE_DETECTION", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type feature_type: str diff --git a/src/oci/ai_vision/models/landmark.py b/src/oci/ai_vision/models/landmark.py new file mode 100644 index 0000000000..bf57435d04 --- /dev/null +++ b/src/oci/ai_vision/models/landmark.py @@ -0,0 +1,162 @@ +# coding: utf-8 +# Copyright (c) 2016, 2023, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20220125 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class Landmark(object): + """ + The landmark on the face. + """ + + #: A constant which can be used with the type property of a Landmark. + #: This constant has a value of "LEFT_EYE" + TYPE_LEFT_EYE = "LEFT_EYE" + + #: A constant which can be used with the type property of a Landmark. + #: This constant has a value of "RIGHT_EYE" + TYPE_RIGHT_EYE = "RIGHT_EYE" + + #: A constant which can be used with the type property of a Landmark. + #: This constant has a value of "NOSE_TIP" + TYPE_NOSE_TIP = "NOSE_TIP" + + #: A constant which can be used with the type property of a Landmark. + #: This constant has a value of "LEFT_EDGE_OF_MOUTH" + TYPE_LEFT_EDGE_OF_MOUTH = "LEFT_EDGE_OF_MOUTH" + + #: A constant which can be used with the type property of a Landmark. + #: This constant has a value of "RIGHT_EDGE_OF_MOUTH" + TYPE_RIGHT_EDGE_OF_MOUTH = "RIGHT_EDGE_OF_MOUTH" + + def __init__(self, **kwargs): + """ + Initializes a new Landmark object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param type: + The value to assign to the type property of this Landmark. + Allowed values for this property are: "LEFT_EYE", "RIGHT_EYE", "NOSE_TIP", "LEFT_EDGE_OF_MOUTH", "RIGHT_EDGE_OF_MOUTH", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type type: str + + :param x: + The value to assign to the x property of this Landmark. + :type x: float + + :param y: + The value to assign to the y property of this Landmark. + :type y: float + + """ + self.swagger_types = { + 'type': 'str', + 'x': 'float', + 'y': 'float' + } + + self.attribute_map = { + 'type': 'type', + 'x': 'x', + 'y': 'y' + } + + self._type = None + self._x = None + self._y = None + + @property + def type(self): + """ + **[Required]** Gets the type of this Landmark. + The face landmark type + + Allowed values for this property are: "LEFT_EYE", "RIGHT_EYE", "NOSE_TIP", "LEFT_EDGE_OF_MOUTH", "RIGHT_EDGE_OF_MOUTH", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The type of this Landmark. + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """ + Sets the type of this Landmark. + The face landmark type + + + :param type: The type of this Landmark. + :type: str + """ + allowed_values = ["LEFT_EYE", "RIGHT_EYE", "NOSE_TIP", "LEFT_EDGE_OF_MOUTH", "RIGHT_EDGE_OF_MOUTH"] + if not value_allowed_none_or_none_sentinel(type, allowed_values): + type = 'UNKNOWN_ENUM_VALUE' + self._type = type + + @property + def x(self): + """ + **[Required]** Gets the x of this Landmark. + The X-axis normalized coordinate. + + + :return: The x of this Landmark. + :rtype: float + """ + return self._x + + @x.setter + def x(self, x): + """ + Sets the x of this Landmark. + The X-axis normalized coordinate. + + + :param x: The x of this Landmark. + :type: float + """ + self._x = x + + @property + def y(self): + """ + **[Required]** Gets the y of this Landmark. + The Y-axis normalized coordinate. + + + :return: The y of this Landmark. + :rtype: float + """ + return self._y + + @y.setter + def y(self, y): + """ + Sets the y of this Landmark. + The Y-axis normalized coordinate. + + + :param y: The y of this Landmark. + :type: float + """ + self._y = y + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/ai_vision/models/object_storage_dataset.py b/src/oci/ai_vision/models/object_storage_dataset.py index e04606c0e4..a7a69843f6 100644 --- a/src/oci/ai_vision/models/object_storage_dataset.py +++ b/src/oci/ai_vision/models/object_storage_dataset.py @@ -62,7 +62,7 @@ def __init__(self, **kwargs): @property def namespace_name(self): """ - Gets the namespace_name of this ObjectStorageDataset. + **[Required]** Gets the namespace_name of this ObjectStorageDataset. The namespace name of the Object Storage bucket that contains the input data file. @@ -86,7 +86,7 @@ def namespace_name(self, namespace_name): @property def bucket_name(self): """ - Gets the bucket_name of this ObjectStorageDataset. + **[Required]** Gets the bucket_name of this ObjectStorageDataset. The name of the Object Storage bucket that contains the input data file. @@ -110,7 +110,7 @@ def bucket_name(self, bucket_name): @property def object_name(self): """ - Gets the object_name of this ObjectStorageDataset. + **[Required]** Gets the object_name of this ObjectStorageDataset. The object name of the input data file. diff --git a/src/oci/alloy.py b/src/oci/alloy.py new file mode 100644 index 0000000000..fad86c9368 --- /dev/null +++ b/src/oci/alloy.py @@ -0,0 +1,140 @@ +# coding: utf-8 +# Copyright (c) 2016, 2023, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from __future__ import absolute_import +import re +import os +import logging +import json + +import oci.regions +import oci.regions_definitions +from oci.exceptions import InvalidAlloyConfig + + +OCI_ALLOY_FILE_PATH_ENV_VAR_NAME = "OCI_ALLOY_CONFIG_FILE_PATH" +ALLOY_CONFIG_FILE_PATH = os.path.join('~', '.oci', 'alloy-config.json') + +ALLOY_CONFIG_SERVICE_KEY_NAME = "services" +ALLOY_CONFIG_REGIONS_KEY_NAME = "regions" +ALLOY_CONFIG_PROVIDER_KEY_NAME = "alloyProvider" +ALLOY_CONFIG_REGION_COEXIST_KEY_NAME = "ociRegionCoexist" +ALLOY_CONFIG_SCHEMA_REQUIRED_KEYS = (ALLOY_CONFIG_SERVICE_KEY_NAME, + ALLOY_CONFIG_REGIONS_KEY_NAME) +ALLOY_CONFIG_SCHEMA_OPTIONAL_KEYS = (ALLOY_CONFIG_REGION_COEXIST_KEY_NAME, + ALLOY_CONFIG_PROVIDER_KEY_NAME) +logger = logging.getLogger(__name__) + + +def _enable_alloy_mode(): + if not oci.regions._IS_ALLOY_MODE: + logger.debug("Alloy mode detected") + oci.regions._IS_ALLOY_MODE = True + + +# Class to define the behavior of the set containing services enabled by the alloy provider +class OciSdkEnabledServicesSet(object): + + def __init__(self): + self._enabled_services_set = set() + self._cleared_set_for_user_override = False + + def _clean_up_service_name_string(self, service_name): + # By default, the OCI Python SDK uses underscores in the module name for services, however, the service names in + # OCI_SDK_ENABLED_SERVICES_SET are expected without underscores, in lower case + return re.sub('[^a-z]+', '', service_name.lower()) + + def add(self, service_name, override_by_user=True): + if not self._cleared_set_for_user_override and override_by_user: + logger.warning("WARNING: Clearing OCI_SDK_ENABLED_SERVICES_SET to allow user override through code") + self.clear() + # Set _cleared_set_for_user_override to true, to clear the set only once + self._cleared_set_for_user_override = True + clean_service_name_string = self._clean_up_service_name_string(service_name) + self._enabled_services_set.add(clean_service_name_string) + + def isempty(self): + return len(self._enabled_services_set) == 0 + + def clear(self): + self._enabled_services_set.clear() + + def is_service_enabled(self, service_name): + # If OCI_SDK_ENABLED_SERVICES_SET is empty, all the services are enabled + if self.isempty(): + return True + clean_service_name_string = self._clean_up_service_name_string(service_name) + return clean_service_name_string in self._enabled_services_set + + +OCI_SDK_ENABLED_SERVICES_SET = OciSdkEnabledServicesSet() + + +def _validate_alloy_config_schema(alloy_config_json_object): + for key in ALLOY_CONFIG_SCHEMA_REQUIRED_KEYS: + if key not in alloy_config_json_object: + logger.debug("Key {} not found in alloy config".format(key)) + raise InvalidAlloyConfig("Alloy config is invalid. Missing required key {}".format(key)) + for key in ALLOY_CONFIG_SCHEMA_OPTIONAL_KEYS: + if key in alloy_config_json_object and key is ALLOY_CONFIG_REGION_COEXIST_KEY_NAME: + if not isinstance(alloy_config_json_object[key], (bool, str)): + raise InvalidAlloyConfig("{} must be either bool or str".format(ALLOY_CONFIG_REGION_COEXIST_KEY_NAME)) + if isinstance(alloy_config_json_object[key], str) and alloy_config_json_object[key].lower() not in ("true", "false"): + raise InvalidAlloyConfig("Allowed values for {} are either true or false".format(ALLOY_CONFIG_REGION_COEXIST_KEY_NAME)) + return True + + +def _add_services_from_alloy_config(alloy_config_services_list): + if alloy_config_services_list: + for service in alloy_config_services_list: + OCI_SDK_ENABLED_SERVICES_SET.add(service, override_by_user=False) + + +def _set_alloy_config_from_file(): + """ + Looks for alloy-config.json and parses enabled services and regions information from it + Default location is ~/.oci/alloy-config.json + Default location can be overridden by setting environment variable OCI_ALLOY_CONFIG_FILE_PATH + """ + if os.getenv(OCI_ALLOY_FILE_PATH_ENV_VAR_NAME): + config_file_location = os.getenv(OCI_ALLOY_FILE_PATH_ENV_VAR_NAME) + logger.debug("Overriding default path for alloy-config.json to {}".format(OCI_ALLOY_FILE_PATH_ENV_VAR_NAME)) + else: + config_file_location = ALLOY_CONFIG_FILE_PATH + expanded_file_location = os.path.expanduser(config_file_location) + if os.path.isfile(expanded_file_location): + _enable_alloy_mode() + logger.debug("Alloy configuration file found at location {}".format(expanded_file_location)) + try: + with open(expanded_file_location, 'r') as alloy_config_file: + alloy_config_raw_file_content = alloy_config_file.read() + except (OSError, IOError) as e: + logger.debug("Reading alloy configuration file failed because of error: {}".format(e)) + raise e + try: + alloy_config_json_object = json.loads(alloy_config_raw_file_content) + except json.JSONDecodeError as e: + # Unable to parse the json array + logger.debug("Decoding JSON array from alloy configuration file failed because of error: {}".format(e)) + raise e + + if _validate_alloy_config_schema(alloy_config_json_object): + # Extract enabled services and regions from alloy_config_json_object + _add_services_from_alloy_config(alloy_config_json_object[ALLOY_CONFIG_SERVICE_KEY_NAME]) + oci.regions._IS_ALLOY_REGION_COEXIST = alloy_config_json_object.get(ALLOY_CONFIG_REGION_COEXIST_KEY_NAME, + False) + oci.regions._process_region_metadata_from_alloy_config(alloy_config_json_object[ALLOY_CONFIG_REGIONS_KEY_NAME]) + oci.regions.ALLOY_PROVIDER_NAME = alloy_config_json_object.get(ALLOY_CONFIG_PROVIDER_KEY_NAME, False) + + +def _configure_alloy_mode(): + """ + Determines if alloy specific inputs are provided and configures the SDK for alloy mode + Alloy mode is enabled if alloy-config.json file is found + """ + # Read all the sources to determine alloy mode + _set_alloy_config_from_file() + + +_configure_alloy_mode() diff --git a/src/oci/analytics/analytics_client.py b/src/oci/analytics/analytics_client.py index fda90d4b1b..7ac7a19124 100644 --- a/src/oci/analytics/analytics_client.py +++ b/src/oci/analytics/analytics_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import analytics_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("analytics"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/announcements_service/announcement_client.py b/src/oci/announcements_service/announcement_client.py index 4e8f58a8b8..df2edd862e 100644 --- a/src/oci/announcements_service/announcement_client.py +++ b/src/oci/announcements_service/announcement_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import announcements_service_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("announcements_service"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] @@ -366,6 +371,12 @@ def list_announcements(self, compartment_id, **kwargs): :param list[str] exclude_announcement_types: (optional) Exclude The type of announcement. + :param bool should_show_only_latest_in_chain: (optional) + A filter to display only the latest announcement in a chain. + + :param str chain_id: (optional) + A filter to return only announcements belonging to the specified announcement chain ID. + :param str opc_request_id: (optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the complete request ID. @@ -412,6 +423,8 @@ def list_announcements(self, compartment_id, **kwargs): "service", "platform_type", "exclude_announcement_types", + "should_show_only_latest_in_chain", + "chain_id", "opc_request_id" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] @@ -461,7 +474,9 @@ def list_announcements(self, compartment_id, **kwargs): "environmentName": kwargs.get("environment_name", missing), "service": kwargs.get("service", missing), "platformType": kwargs.get("platform_type", missing), - "excludeAnnouncementTypes": self.base_client.generate_collection_format_param(kwargs.get("exclude_announcement_types", missing), 'multi') + "excludeAnnouncementTypes": self.base_client.generate_collection_format_param(kwargs.get("exclude_announcement_types", missing), 'multi'), + "shouldShowOnlyLatestInChain": kwargs.get("should_show_only_latest_in_chain", missing), + "chainId": kwargs.get("chain_id", missing) } query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} diff --git a/src/oci/announcements_service/announcement_subscription_client.py b/src/oci/announcements_service/announcement_subscription_client.py index 5815429fb7..93b6c1043b 100644 --- a/src/oci/announcements_service/announcement_subscription_client.py +++ b/src/oci/announcements_service/announcement_subscription_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import announcements_service_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("announcements_service"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/announcements_service/announcements_preferences_client.py b/src/oci/announcements_service/announcements_preferences_client.py index dbea4590bd..a00a7f38ae 100644 --- a/src/oci/announcements_service/announcements_preferences_client.py +++ b/src/oci/announcements_service/announcements_preferences_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import announcements_service_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("announcements_service"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/announcements_service/models/announcement.py b/src/oci/announcements_service/models/announcement.py index a1c5794904..a360708259 100644 --- a/src/oci/announcements_service/models/announcement.py +++ b/src/oci/announcements_service/models/announcement.py @@ -107,6 +107,10 @@ def __init__(self, **kwargs): Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type platform_type: str + :param chain_id: + The value to assign to the chain_id property of this Announcement. + :type chain_id: str + :param description: The value to assign to the description property of this Announcement. :type description: str @@ -140,6 +144,7 @@ def __init__(self, **kwargs): 'time_updated': 'datetime', 'environment_name': 'str', 'platform_type': 'str', + 'chain_id': 'str', 'description': 'str', 'additional_information': 'str', 'affected_resources': 'list[AffectedResource]' @@ -165,6 +170,7 @@ def __init__(self, **kwargs): 'time_updated': 'timeUpdated', 'environment_name': 'environmentName', 'platform_type': 'platformType', + 'chain_id': 'chainId', 'description': 'description', 'additional_information': 'additionalInformation', 'affected_resources': 'affectedResources' @@ -189,6 +195,7 @@ def __init__(self, **kwargs): self._time_updated = None self._environment_name = None self._platform_type = None + self._chain_id = None self._description = None self._additional_information = None self._affected_resources = None diff --git a/src/oci/announcements_service/models/announcement_subscription.py b/src/oci/announcements_service/models/announcement_subscription.py index 2d424e0999..93d564ef5e 100644 --- a/src/oci/announcements_service/models/announcement_subscription.py +++ b/src/oci/announcements_service/models/announcement_subscription.py @@ -409,7 +409,7 @@ def filter_groups(self, filter_groups): def preferred_language(self): """ Gets the preferred_language of this AnnouncementSubscription. - (For announcement subscriptions with Oracle Fusion Applications configured as the service only) The language in which the user prefers to receive emailed announcements. Specify the preference with a value that uses the language tag format (x-obmcs-human-language). For example fr-FR. + (For announcement subscriptions with SaaS configured as the platform type or Oracle Fusion Applications as the service, or both, only) The language in which the user prefers to receive emailed announcements. Specify the preference with a value that uses the x-obmcs-human-language format. For example fr-FR. :return: The preferred_language of this AnnouncementSubscription. @@ -421,7 +421,7 @@ def preferred_language(self): def preferred_language(self, preferred_language): """ Sets the preferred_language of this AnnouncementSubscription. - (For announcement subscriptions with Oracle Fusion Applications configured as the service only) The language in which the user prefers to receive emailed announcements. Specify the preference with a value that uses the language tag format (x-obmcs-human-language). For example fr-FR. + (For announcement subscriptions with SaaS configured as the platform type or Oracle Fusion Applications as the service, or both, only) The language in which the user prefers to receive emailed announcements. Specify the preference with a value that uses the x-obmcs-human-language format. For example fr-FR. :param preferred_language: The preferred_language of this AnnouncementSubscription. @@ -433,7 +433,7 @@ def preferred_language(self, preferred_language): def preferred_time_zone(self): """ Gets the preferred_time_zone of this AnnouncementSubscription. - The time zone that the user prefers for announcement time stamps. Specify the preference with a value that uses the IANA Time Zone Database format (x-obmcs-time-zone). For example America/Los_Angeles. + The time zone in which the user prefers to receive announcements. Specify the preference with a value that uses the IANA Time Zone Database format (x-obmcs-time-zone). For example - America/Los_Angeles :return: The preferred_time_zone of this AnnouncementSubscription. @@ -445,7 +445,7 @@ def preferred_time_zone(self): def preferred_time_zone(self, preferred_time_zone): """ Sets the preferred_time_zone of this AnnouncementSubscription. - The time zone that the user prefers for announcement time stamps. Specify the preference with a value that uses the IANA Time Zone Database format (x-obmcs-time-zone). For example America/Los_Angeles. + The time zone in which the user prefers to receive announcements. Specify the preference with a value that uses the IANA Time Zone Database format (x-obmcs-time-zone). For example - America/Los_Angeles :param preferred_time_zone: The preferred_time_zone of this AnnouncementSubscription. diff --git a/src/oci/announcements_service/models/announcement_summary.py b/src/oci/announcements_service/models/announcement_summary.py index 59d1b73fff..652792127a 100644 --- a/src/oci/announcements_service/models/announcement_summary.py +++ b/src/oci/announcements_service/models/announcement_summary.py @@ -107,6 +107,10 @@ def __init__(self, **kwargs): Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type platform_type: str + :param chain_id: + The value to assign to the chain_id property of this AnnouncementSummary. + :type chain_id: str + """ self.swagger_types = { 'id': 'str', @@ -127,7 +131,8 @@ def __init__(self, **kwargs): 'time_created': 'datetime', 'time_updated': 'datetime', 'environment_name': 'str', - 'platform_type': 'str' + 'platform_type': 'str', + 'chain_id': 'str' } self.attribute_map = { @@ -149,7 +154,8 @@ def __init__(self, **kwargs): 'time_created': 'timeCreated', 'time_updated': 'timeUpdated', 'environment_name': 'environmentName', - 'platform_type': 'platformType' + 'platform_type': 'platformType', + 'chain_id': 'chainId' } self._id = None @@ -171,6 +177,7 @@ def __init__(self, **kwargs): self._time_updated = None self._environment_name = None self._platform_type = None + self._chain_id = None self._type = 'AnnouncementSummary' def __repr__(self): diff --git a/src/oci/announcements_service/models/base_announcement.py b/src/oci/announcements_service/models/base_announcement.py index 97b9bb77da..dc6f27f50e 100644 --- a/src/oci/announcements_service/models/base_announcement.py +++ b/src/oci/announcements_service/models/base_announcement.py @@ -214,6 +214,10 @@ def __init__(self, **kwargs): Allowed values for this property are: "IAAS", "SAAS" :type platform_type: str + :param chain_id: + The value to assign to the chain_id property of this BaseAnnouncement. + :type chain_id: str + """ self.swagger_types = { 'id': 'str', @@ -234,7 +238,8 @@ def __init__(self, **kwargs): 'time_created': 'datetime', 'time_updated': 'datetime', 'environment_name': 'str', - 'platform_type': 'str' + 'platform_type': 'str', + 'chain_id': 'str' } self.attribute_map = { @@ -256,7 +261,8 @@ def __init__(self, **kwargs): 'time_created': 'timeCreated', 'time_updated': 'timeUpdated', 'environment_name': 'environmentName', - 'platform_type': 'platformType' + 'platform_type': 'platformType', + 'chain_id': 'chainId' } self._id = None @@ -278,6 +284,7 @@ def __init__(self, **kwargs): self._time_updated = None self._environment_name = None self._platform_type = None + self._chain_id = None @staticmethod def get_subtype(object_dictionary): @@ -817,6 +824,30 @@ def platform_type(self, platform_type): ) self._platform_type = platform_type + @property + def chain_id(self): + """ + Gets the chain_id of this BaseAnnouncement. + The sequence of connected announcements, or announcement chain, that this announcement belongs to. Related announcements share the same chain ID. + + + :return: The chain_id of this BaseAnnouncement. + :rtype: str + """ + return self._chain_id + + @chain_id.setter + def chain_id(self, chain_id): + """ + Sets the chain_id of this BaseAnnouncement. + The sequence of connected announcements, or announcement chain, that this announcement belongs to. Related announcements share the same chain ID. + + + :param chain_id: The chain_id of this BaseAnnouncement. + :type: str + """ + self._chain_id = chain_id + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/announcements_service/models/base_announcements_preferences.py b/src/oci/announcements_service/models/base_announcements_preferences.py index b6c4e0821c..d1c41d51e5 100644 --- a/src/oci/announcements_service/models/base_announcements_preferences.py +++ b/src/oci/announcements_service/models/base_announcements_preferences.py @@ -281,7 +281,7 @@ def preference_type(self, preference_type): def preferred_time_zone(self): """ Gets the preferred_time_zone of this BaseAnnouncementsPreferences. - The time zone that the user prefers for announcement time stamps. Specify the preference with a value that uses the IANA Time Zone Database format (x-obmcs-time-zone). For example America/Los_Angeles. + The time zone in which the user prefers to receive announcements. Specify the preference with a value that uses the IANA Time Zone Database format (x-obmcs-time-zone). For example - America/Los_Angeles :return: The preferred_time_zone of this BaseAnnouncementsPreferences. @@ -293,7 +293,7 @@ def preferred_time_zone(self): def preferred_time_zone(self, preferred_time_zone): """ Sets the preferred_time_zone of this BaseAnnouncementsPreferences. - The time zone that the user prefers for announcement time stamps. Specify the preference with a value that uses the IANA Time Zone Database format (x-obmcs-time-zone). For example America/Los_Angeles. + The time zone in which the user prefers to receive announcements. Specify the preference with a value that uses the IANA Time Zone Database format (x-obmcs-time-zone). For example - America/Los_Angeles :param preferred_time_zone: The preferred_time_zone of this BaseAnnouncementsPreferences. diff --git a/src/oci/announcements_service/models/base_create_announcements_preferences_details.py b/src/oci/announcements_service/models/base_create_announcements_preferences_details.py index a02780f115..6702f9c9a6 100644 --- a/src/oci/announcements_service/models/base_create_announcements_preferences_details.py +++ b/src/oci/announcements_service/models/base_create_announcements_preferences_details.py @@ -209,7 +209,7 @@ def preference_type(self, preference_type): def preferred_time_zone(self): """ Gets the preferred_time_zone of this BaseCreateAnnouncementsPreferencesDetails. - The time zone that the user prefers for announcement time stamps. Specify the preference with a value that uses the IANA Time Zone Database format (x-obmcs-time-zone). For example America/Los_Angeles. + The time zone in which the user prefers to receive announcements. Specify the preference with a value that uses the IANA Time Zone Database format (x-obmcs-time-zone). For example - America/Los_Angeles :return: The preferred_time_zone of this BaseCreateAnnouncementsPreferencesDetails. @@ -221,7 +221,7 @@ def preferred_time_zone(self): def preferred_time_zone(self, preferred_time_zone): """ Sets the preferred_time_zone of this BaseCreateAnnouncementsPreferencesDetails. - The time zone that the user prefers for announcement time stamps. Specify the preference with a value that uses the IANA Time Zone Database format (x-obmcs-time-zone). For example America/Los_Angeles. + The time zone in which the user prefers to receive announcements. Specify the preference with a value that uses the IANA Time Zone Database format (x-obmcs-time-zone). For example - America/Los_Angeles :param preferred_time_zone: The preferred_time_zone of this BaseCreateAnnouncementsPreferencesDetails. diff --git a/src/oci/announcements_service/models/create_announcement_subscription_details.py b/src/oci/announcements_service/models/create_announcement_subscription_details.py index e9d5c823bb..2e88f8a9e2 100644 --- a/src/oci/announcements_service/models/create_announcement_subscription_details.py +++ b/src/oci/announcements_service/models/create_announcement_subscription_details.py @@ -223,7 +223,7 @@ def filter_groups(self, filter_groups): def preferred_language(self): """ Gets the preferred_language of this CreateAnnouncementSubscriptionDetails. - (For announcement subscriptions with Oracle Fusion Applications configured as the service only) The language in which the user prefers to receive emailed announcements. Specify the preference with a value that uses the language tag format (x-obmcs-human-language). For example fr-FR. + (For announcement subscriptions with SaaS configured as the platform type or Oracle Fusion Applications as the service, or both, only) The language in which the user prefers to receive emailed announcements. Specify the preference with a value that uses the x-obmcs-human-language format. For example fr-FR. :return: The preferred_language of this CreateAnnouncementSubscriptionDetails. @@ -235,7 +235,7 @@ def preferred_language(self): def preferred_language(self, preferred_language): """ Sets the preferred_language of this CreateAnnouncementSubscriptionDetails. - (For announcement subscriptions with Oracle Fusion Applications configured as the service only) The language in which the user prefers to receive emailed announcements. Specify the preference with a value that uses the language tag format (x-obmcs-human-language). For example fr-FR. + (For announcement subscriptions with SaaS configured as the platform type or Oracle Fusion Applications as the service, or both, only) The language in which the user prefers to receive emailed announcements. Specify the preference with a value that uses the x-obmcs-human-language format. For example fr-FR. :param preferred_language: The preferred_language of this CreateAnnouncementSubscriptionDetails. @@ -247,7 +247,7 @@ def preferred_language(self, preferred_language): def preferred_time_zone(self): """ Gets the preferred_time_zone of this CreateAnnouncementSubscriptionDetails. - The time zone that the user prefers for announcement time stamps. Specify the preference with a value that uses the IANA Time Zone Database format (x-obmcs-time-zone). For example America/Los_Angeles. + The time zone in which the user prefers to receive announcements. Specify the preference with a value that uses the IANA Time Zone Database format (x-obmcs-time-zone). For example - America/Los_Angeles :return: The preferred_time_zone of this CreateAnnouncementSubscriptionDetails. @@ -259,7 +259,7 @@ def preferred_time_zone(self): def preferred_time_zone(self, preferred_time_zone): """ Sets the preferred_time_zone of this CreateAnnouncementSubscriptionDetails. - The time zone that the user prefers for announcement time stamps. Specify the preference with a value that uses the IANA Time Zone Database format (x-obmcs-time-zone). For example America/Los_Angeles. + The time zone in which the user prefers to receive announcements. Specify the preference with a value that uses the IANA Time Zone Database format (x-obmcs-time-zone). For example - America/Los_Angeles :param preferred_time_zone: The preferred_time_zone of this CreateAnnouncementSubscriptionDetails. diff --git a/src/oci/announcements_service/models/filter.py b/src/oci/announcements_service/models/filter.py index 704be26ea6..857bc968f6 100644 --- a/src/oci/announcements_service/models/filter.py +++ b/src/oci/announcements_service/models/filter.py @@ -12,7 +12,7 @@ @init_model_state_from_kwargs class Filter(object): """ - Criteria that the Announcements service uses to match announcements in order to provide only desired, matching announcements. + Criteria that the Announcements service uses to match announcements so it can provide only desired announcements to subscribers. """ #: A constant which can be used with the type property of a Filter. @@ -72,7 +72,7 @@ def __init__(self, **kwargs): def type(self): """ **[Required]** Gets the type of this Filter. - The type of filter. + The type of filter. You cannot combine the RESOURCE_ID filter with any other type of filter within a given filter group. For filter types that support multiple values, specify the values individually. Allowed values for this property are: "COMPARTMENT_ID", "PLATFORM_TYPE", "REGION", "SERVICE", "RESOURCE_ID", "ANNOUNCEMENT_TYPE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -87,7 +87,7 @@ def type(self): def type(self, type): """ Sets the type of this Filter. - The type of filter. + The type of filter. You cannot combine the RESOURCE_ID filter with any other type of filter within a given filter group. For filter types that support multiple values, specify the values individually. :param type: The type of this Filter. diff --git a/src/oci/announcements_service/models/filter_group.py b/src/oci/announcements_service/models/filter_group.py index ada040e778..dfda44d3e5 100644 --- a/src/oci/announcements_service/models/filter_group.py +++ b/src/oci/announcements_service/models/filter_group.py @@ -70,7 +70,7 @@ def name(self, name): def filters(self): """ **[Required]** Gets the filters of this FilterGroup. - A list of filters against which the Announcements service matches announcements. You cannot have more than one of any given filter type within a filter group. You also cannot combine the RESOURCE_ID filter with any other type of filter within a given filter group. + A list of filters against which the Announcements service matches announcements. You cannot combine the RESOURCE_ID filter with any other type of filter within a given filter group. For filter types that support multiple values, specify the values individually. :return: The filters of this FilterGroup. @@ -82,7 +82,7 @@ def filters(self): def filters(self, filters): """ Sets the filters of this FilterGroup. - A list of filters against which the Announcements service matches announcements. You cannot have more than one of any given filter type within a filter group. You also cannot combine the RESOURCE_ID filter with any other type of filter within a given filter group. + A list of filters against which the Announcements service matches announcements. You cannot combine the RESOURCE_ID filter with any other type of filter within a given filter group. For filter types that support multiple values, specify the values individually. :param filters: The filters of this FilterGroup. diff --git a/src/oci/announcements_service/models/filter_group_details.py b/src/oci/announcements_service/models/filter_group_details.py index a8ee36f51b..450abefe47 100644 --- a/src/oci/announcements_service/models/filter_group_details.py +++ b/src/oci/announcements_service/models/filter_group_details.py @@ -39,7 +39,7 @@ def __init__(self, **kwargs): def filters(self): """ **[Required]** Gets the filters of this FilterGroupDetails. - A list of filters against which the Announcements service matches announcements. You cannot have more than one of any given filter type within a filter group. + A list of filters against which the Announcements service matches announcements. You cannot combine the RESOURCE_ID filter with any other type of filter within a given filter group. For filter types that support multiple values, specify the values individually. :return: The filters of this FilterGroupDetails. @@ -51,7 +51,7 @@ def filters(self): def filters(self, filters): """ Sets the filters of this FilterGroupDetails. - A list of filters against which the Announcements service matches announcements. You cannot have more than one of any given filter type within a filter group. + A list of filters against which the Announcements service matches announcements. You cannot combine the RESOURCE_ID filter with any other type of filter within a given filter group. For filter types that support multiple values, specify the values individually. :param filters: The filters of this FilterGroupDetails. diff --git a/src/oci/announcements_service/models/update_announcement_subscription_details.py b/src/oci/announcements_service/models/update_announcement_subscription_details.py index 39b50aee16..a549d3f5d3 100644 --- a/src/oci/announcements_service/models/update_announcement_subscription_details.py +++ b/src/oci/announcements_service/models/update_announcement_subscription_details.py @@ -159,7 +159,7 @@ def ons_topic_id(self, ons_topic_id): def preferred_language(self): """ Gets the preferred_language of this UpdateAnnouncementSubscriptionDetails. - (For announcement subscriptions with Oracle Fusion Applications configured as the service only) The language in which the user prefers to receive emailed announcements. Specify the preference with a value that uses the language tag format (x-obmcs-human-language). For example fr-FR. + (For announcement subscriptions with SaaS configured as the platform type or Oracle Fusion Applications as the service, or both, only) The language in which the user prefers to receive emailed announcements. Specify the preference with a value that uses the x-obmcs-human-language format. For example fr-FR. :return: The preferred_language of this UpdateAnnouncementSubscriptionDetails. @@ -171,7 +171,7 @@ def preferred_language(self): def preferred_language(self, preferred_language): """ Sets the preferred_language of this UpdateAnnouncementSubscriptionDetails. - (For announcement subscriptions with Oracle Fusion Applications configured as the service only) The language in which the user prefers to receive emailed announcements. Specify the preference with a value that uses the language tag format (x-obmcs-human-language). For example fr-FR. + (For announcement subscriptions with SaaS configured as the platform type or Oracle Fusion Applications as the service, or both, only) The language in which the user prefers to receive emailed announcements. Specify the preference with a value that uses the x-obmcs-human-language format. For example fr-FR. :param preferred_language: The preferred_language of this UpdateAnnouncementSubscriptionDetails. @@ -183,7 +183,7 @@ def preferred_language(self, preferred_language): def preferred_time_zone(self): """ Gets the preferred_time_zone of this UpdateAnnouncementSubscriptionDetails. - The time zone that the user prefers for announcement time stamps. Specify the preference with a value that uses the IANA Time Zone Database format (x-obmcs-time-zone). For example America/Los_Angeles. + The time zone in which the user prefers to receive announcements. Specify the preference with a value that uses the IANA Time Zone Database format (x-obmcs-time-zone). For example - America/Los_Angeles :return: The preferred_time_zone of this UpdateAnnouncementSubscriptionDetails. @@ -195,7 +195,7 @@ def preferred_time_zone(self): def preferred_time_zone(self, preferred_time_zone): """ Sets the preferred_time_zone of this UpdateAnnouncementSubscriptionDetails. - The time zone that the user prefers for announcement time stamps. Specify the preference with a value that uses the IANA Time Zone Database format (x-obmcs-time-zone). For example America/Los_Angeles. + The time zone in which the user prefers to receive announcements. Specify the preference with a value that uses the IANA Time Zone Database format (x-obmcs-time-zone). For example - America/Los_Angeles :param preferred_time_zone: The preferred_time_zone of this UpdateAnnouncementSubscriptionDetails. diff --git a/src/oci/announcements_service/models/update_filter_group_details.py b/src/oci/announcements_service/models/update_filter_group_details.py index 484574ee27..832622a7c5 100644 --- a/src/oci/announcements_service/models/update_filter_group_details.py +++ b/src/oci/announcements_service/models/update_filter_group_details.py @@ -39,7 +39,7 @@ def __init__(self, **kwargs): def filters(self): """ **[Required]** Gets the filters of this UpdateFilterGroupDetails. - A list of filters against which the Announcements service will match announcements. You cannot have more than one of any given filter type within a filter group. + A list of filters against which the Announcements service will match announcements. You cannot combine the RESOURCE_ID filter with any other type of filter within a given filter group. For filter types that support multiple values, specify the values individually. :return: The filters of this UpdateFilterGroupDetails. @@ -51,7 +51,7 @@ def filters(self): def filters(self, filters): """ Sets the filters of this UpdateFilterGroupDetails. - A list of filters against which the Announcements service will match announcements. You cannot have more than one of any given filter type within a filter group. + A list of filters against which the Announcements service will match announcements. You cannot combine the RESOURCE_ID filter with any other type of filter within a given filter group. For filter types that support multiple values, specify the values individually. :param filters: The filters of this UpdateFilterGroupDetails. diff --git a/src/oci/apigateway/api_gateway_client.py b/src/oci/apigateway/api_gateway_client.py index aaf742b641..4ce2957e46 100644 --- a/src/oci/apigateway/api_gateway_client.py +++ b/src/oci/apigateway/api_gateway_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import apigateway_type_mapping missing = Sentinel("Missing") @@ -76,6 +78,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("apigateway"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/apigateway/deployment_client.py b/src/oci/apigateway/deployment_client.py index 4200146b62..0eeb0d0bef 100644 --- a/src/oci/apigateway/deployment_client.py +++ b/src/oci/apigateway/deployment_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import apigateway_type_mapping missing = Sentinel("Missing") @@ -76,6 +78,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("apigateway"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/apigateway/gateway_client.py b/src/oci/apigateway/gateway_client.py index 7af561fd7d..0318195c90 100644 --- a/src/oci/apigateway/gateway_client.py +++ b/src/oci/apigateway/gateway_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import apigateway_type_mapping missing = Sentinel("Missing") @@ -76,6 +78,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("apigateway"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/apigateway/subscribers_client.py b/src/oci/apigateway/subscribers_client.py index 9cecc0db01..4e22674102 100644 --- a/src/oci/apigateway/subscribers_client.py +++ b/src/oci/apigateway/subscribers_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import apigateway_type_mapping missing = Sentinel("Missing") @@ -76,6 +78,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("apigateway"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/apigateway/usage_plans_client.py b/src/oci/apigateway/usage_plans_client.py index 742661e790..a2102a2ffe 100644 --- a/src/oci/apigateway/usage_plans_client.py +++ b/src/oci/apigateway/usage_plans_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import apigateway_type_mapping missing = Sentinel("Missing") @@ -76,6 +78,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("apigateway"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/apigateway/work_requests_client.py b/src/oci/apigateway/work_requests_client.py index 3ee3e29fb1..2e77ea52a2 100644 --- a/src/oci/apigateway/work_requests_client.py +++ b/src/oci/apigateway/work_requests_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import apigateway_type_mapping missing = Sentinel("Missing") @@ -76,6 +78,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("apigateway"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/apm_config/config_client.py b/src/oci/apm_config/config_client.py index 532be65f9c..fdfc628637 100644 --- a/src/oci/apm_config/config_client.py +++ b/src/oci/apm_config/config_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import apm_config_type_mapping missing = Sentinel("Missing") @@ -75,6 +77,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("apm_config"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/apm_control_plane/apm_domain_client.py b/src/oci/apm_control_plane/apm_domain_client.py index c907d56f20..2e4c20e1ff 100644 --- a/src/oci/apm_control_plane/apm_domain_client.py +++ b/src/oci/apm_control_plane/apm_domain_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import apm_control_plane_type_mapping missing = Sentinel("Missing") @@ -75,6 +77,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("apm_control_plane"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/apm_synthetics/apm_synthetic_client.py b/src/oci/apm_synthetics/apm_synthetic_client.py index a4d95eda30..2cd8467a76 100644 --- a/src/oci/apm_synthetics/apm_synthetic_client.py +++ b/src/oci/apm_synthetics/apm_synthetic_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import apm_synthetics_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("apm_synthetics"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/apm_traces/query_client.py b/src/oci/apm_traces/query_client.py index 1fd89ace59..9f07f94ec5 100644 --- a/src/oci/apm_traces/query_client.py +++ b/src/oci/apm_traces/query_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import apm_traces_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("apm_traces"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/apm_traces/trace_client.py b/src/oci/apm_traces/trace_client.py index fb45e3d3ab..38a271af3e 100644 --- a/src/oci/apm_traces/trace_client.py +++ b/src/oci/apm_traces/trace_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import apm_traces_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("apm_traces"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/application_migration/application_migration_client.py b/src/oci/application_migration/application_migration_client.py index f499a18054..774f1f4eee 100644 --- a/src/oci/application_migration/application_migration_client.py +++ b/src/oci/application_migration/application_migration_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import application_migration_type_mapping missing = Sentinel("Missing") @@ -77,6 +79,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("application_migration"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/appmgmt_control/appmgmt_control_client.py b/src/oci/appmgmt_control/appmgmt_control_client.py index 10ee77671d..07e6726522 100644 --- a/src/oci/appmgmt_control/appmgmt_control_client.py +++ b/src/oci/appmgmt_control/appmgmt_control_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import appmgmt_control_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("appmgmt_control"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/artifacts/artifacts_client.py b/src/oci/artifacts/artifacts_client.py index 20ba3b73bd..31d01dc86f 100644 --- a/src/oci/artifacts/artifacts_client.py +++ b/src/oci/artifacts/artifacts_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import artifacts_type_mapping missing = Sentinel("Missing") @@ -75,6 +77,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("artifacts"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/audit/audit_client.py b/src/oci/audit/audit_client.py index e4a5590592..7a32873d23 100644 --- a/src/oci/audit/audit_client.py +++ b/src/oci/audit/audit_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import audit_type_mapping missing = Sentinel("Missing") @@ -77,6 +79,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("audit"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/auth/rpt_path_providers.py b/src/oci/auth/rpt_path_providers.py index 40fd55155e..24254e254f 100644 --- a/src/oci/auth/rpt_path_providers.py +++ b/src/oci/auth/rpt_path_providers.py @@ -76,12 +76,12 @@ def build_replacements(self): class EnvRptPathProvider(AbstractRptPathProvider): def __init__(self, **kwargs): - super(EnvRptPathProvider, self).__init__(self.get_path_template()) - self.replacements = self.build_replacements() if kwargs.get("child_resource", False): self.child_resource = True else: self.child_resource = False + super(EnvRptPathProvider, self).__init__(self.get_path_template()) + self.replacements = self.build_replacements() def get_replacements(self): return self.replacements diff --git a/src/oci/autoscaling/auto_scaling_client.py b/src/oci/autoscaling/auto_scaling_client.py index 3e426ed36b..ba04b65b67 100644 --- a/src/oci/autoscaling/auto_scaling_client.py +++ b/src/oci/autoscaling/auto_scaling_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import autoscaling_type_mapping missing = Sentinel("Missing") @@ -79,6 +81,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("autoscaling"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/bastion/bastion_client.py b/src/oci/bastion/bastion_client.py index 840d400063..3939aa3ab5 100644 --- a/src/oci/bastion/bastion_client.py +++ b/src/oci/bastion/bastion_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import bastion_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("bastion"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/bds/bds_client.py b/src/oci/bds/bds_client.py index 4e9d0fde11..627507d07c 100644 --- a/src/oci/bds/bds_client.py +++ b/src/oci/bds/bds_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import bds_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("bds"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/blockchain/blockchain_platform_client.py b/src/oci/blockchain/blockchain_platform_client.py index 3796b7515f..b9541abe4c 100644 --- a/src/oci/blockchain/blockchain_platform_client.py +++ b/src/oci/blockchain/blockchain_platform_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import blockchain_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("blockchain"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/budget/budget_client.py b/src/oci/budget/budget_client.py index 168a6b71f6..16339520f1 100644 --- a/src/oci/budget/budget_client.py +++ b/src/oci/budget/budget_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import budget_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("budget"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/certificates/certificates_client.py b/src/oci/certificates/certificates_client.py index 9ae65e51d2..e94d00a072 100644 --- a/src/oci/certificates/certificates_client.py +++ b/src/oci/certificates/certificates_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import certificates_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("certificates"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/certificates_management/certificates_management_client.py b/src/oci/certificates_management/certificates_management_client.py index a60dfe7317..d40dc4ad0e 100644 --- a/src/oci/certificates_management/certificates_management_client.py +++ b/src/oci/certificates_management/certificates_management_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import certificates_management_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("certificates_management"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/cims/incident_client.py b/src/oci/cims/incident_client.py index e4520b6199..0a7da3cb5c 100644 --- a/src/oci/cims/incident_client.py +++ b/src/oci/cims/incident_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import cims_type_mapping missing = Sentinel("Missing") @@ -79,6 +81,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("cims"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/cloud_bridge/common_client.py b/src/oci/cloud_bridge/common_client.py index 3ba6ad2099..b8f8ceb67b 100644 --- a/src/oci/cloud_bridge/common_client.py +++ b/src/oci/cloud_bridge/common_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import cloud_bridge_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("cloud_bridge"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/cloud_bridge/discovery_client.py b/src/oci/cloud_bridge/discovery_client.py index 3880178f38..aacd61f488 100644 --- a/src/oci/cloud_bridge/discovery_client.py +++ b/src/oci/cloud_bridge/discovery_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import cloud_bridge_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("cloud_bridge"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/cloud_bridge/inventory_client.py b/src/oci/cloud_bridge/inventory_client.py index fe2e5faab4..a24215abf8 100644 --- a/src/oci/cloud_bridge/inventory_client.py +++ b/src/oci/cloud_bridge/inventory_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import cloud_bridge_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("cloud_bridge"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/cloud_bridge/ocb_agent_svc_client.py b/src/oci/cloud_bridge/ocb_agent_svc_client.py index b001122592..addbc9f470 100644 --- a/src/oci/cloud_bridge/ocb_agent_svc_client.py +++ b/src/oci/cloud_bridge/ocb_agent_svc_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import cloud_bridge_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("cloud_bridge"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/cloud_guard/cloud_guard_client.py b/src/oci/cloud_guard/cloud_guard_client.py index a420f9445e..9be89e3e44 100644 --- a/src/oci/cloud_guard/cloud_guard_client.py +++ b/src/oci/cloud_guard/cloud_guard_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import cloud_guard_type_mapping missing = Sentinel("Missing") @@ -76,6 +78,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("cloud_guard"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/cloud_migrations/migration_client.py b/src/oci/cloud_migrations/migration_client.py index efba72cad3..15917e2a16 100644 --- a/src/oci/cloud_migrations/migration_client.py +++ b/src/oci/cloud_migrations/migration_client.py @@ -15,6 +15,8 @@ from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME from oci.util import back_up_body_calculate_stream_content_length, is_content_length_calculable_by_req_util +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import cloud_migrations_type_mapping missing = Sentinel("Missing") @@ -75,6 +77,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("cloud_migrations"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/compute_cloud_at_customer/compute_cloud_at_customer_client.py b/src/oci/compute_cloud_at_customer/compute_cloud_at_customer_client.py index c05c54b09a..80699f66cb 100644 --- a/src/oci/compute_cloud_at_customer/compute_cloud_at_customer_client.py +++ b/src/oci/compute_cloud_at_customer/compute_cloud_at_customer_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import compute_cloud_at_customer_type_mapping missing = Sentinel("Missing") @@ -76,6 +78,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("compute_cloud_at_customer"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/compute_instance_agent/compute_instance_agent_client.py b/src/oci/compute_instance_agent/compute_instance_agent_client.py index f799ffeeeb..67e9525642 100644 --- a/src/oci/compute_instance_agent/compute_instance_agent_client.py +++ b/src/oci/compute_instance_agent/compute_instance_agent_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import compute_instance_agent_type_mapping missing = Sentinel("Missing") @@ -75,6 +77,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("compute_instance_agent"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/compute_instance_agent/plugin_client.py b/src/oci/compute_instance_agent/plugin_client.py index d82fc87e83..d32d25f2c0 100644 --- a/src/oci/compute_instance_agent/plugin_client.py +++ b/src/oci/compute_instance_agent/plugin_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import compute_instance_agent_type_mapping missing = Sentinel("Missing") @@ -75,6 +77,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("compute_instance_agent"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/compute_instance_agent/pluginconfig_client.py b/src/oci/compute_instance_agent/pluginconfig_client.py index e797df5eec..57ac294c60 100644 --- a/src/oci/compute_instance_agent/pluginconfig_client.py +++ b/src/oci/compute_instance_agent/pluginconfig_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import compute_instance_agent_type_mapping missing = Sentinel("Missing") @@ -75,6 +77,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("compute_instance_agent"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/container_engine/container_engine_client.py b/src/oci/container_engine/container_engine_client.py index 01d264334a..0a398809d2 100644 --- a/src/oci/container_engine/container_engine_client.py +++ b/src/oci/container_engine/container_engine_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import container_engine_type_mapping missing = Sentinel("Missing") @@ -76,6 +78,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("container_engine"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/container_instances/container_instance_client.py b/src/oci/container_instances/container_instance_client.py index e4354bffd8..9caf07bf45 100644 --- a/src/oci/container_instances/container_instance_client.py +++ b/src/oci/container_instances/container_instance_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import container_instances_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("container_instances"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/core/blockstorage_client.py b/src/oci/core/blockstorage_client.py index f9049c6c33..79a41e74d5 100644 --- a/src/oci/core/blockstorage_client.py +++ b/src/oci/core/blockstorage_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import core_type_mapping missing = Sentinel("Missing") @@ -80,6 +82,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("core"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/core/compute_client.py b/src/oci/core/compute_client.py index 6aab326c8b..2c333741a8 100644 --- a/src/oci/core/compute_client.py +++ b/src/oci/core/compute_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import core_type_mapping missing = Sentinel("Missing") @@ -80,6 +82,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("core"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/core/compute_management_client.py b/src/oci/core/compute_management_client.py index 69750cb280..a6509e84e6 100644 --- a/src/oci/core/compute_management_client.py +++ b/src/oci/core/compute_management_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import core_type_mapping missing = Sentinel("Missing") @@ -80,6 +82,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("core"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/core/virtual_network_client.py b/src/oci/core/virtual_network_client.py index 58a694a881..371e6a5610 100644 --- a/src/oci/core/virtual_network_client.py +++ b/src/oci/core/virtual_network_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import core_type_mapping missing = Sentinel("Missing") @@ -80,6 +82,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("core"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/dashboard_service/dashboard_client.py b/src/oci/dashboard_service/dashboard_client.py index e65556082b..6c8cef6596 100644 --- a/src/oci/dashboard_service/dashboard_client.py +++ b/src/oci/dashboard_service/dashboard_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import dashboard_service_type_mapping missing = Sentinel("Missing") @@ -81,6 +83,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("dashboard_service"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/dashboard_service/dashboard_group_client.py b/src/oci/dashboard_service/dashboard_group_client.py index d250ba382e..245022c7c7 100644 --- a/src/oci/dashboard_service/dashboard_group_client.py +++ b/src/oci/dashboard_service/dashboard_group_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import dashboard_service_type_mapping missing = Sentinel("Missing") @@ -81,6 +83,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("dashboard_service"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/data_catalog/data_catalog_client.py b/src/oci/data_catalog/data_catalog_client.py index b578923822..cb76103874 100644 --- a/src/oci/data_catalog/data_catalog_client.py +++ b/src/oci/data_catalog/data_catalog_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import data_catalog_type_mapping missing = Sentinel("Missing") @@ -75,6 +77,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("data_catalog"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/data_flow/data_flow_client.py b/src/oci/data_flow/data_flow_client.py index 6c228da700..1d7d2f238d 100644 --- a/src/oci/data_flow/data_flow_client.py +++ b/src/oci/data_flow/data_flow_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import data_flow_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("data_flow"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/data_integration/data_integration_client.py b/src/oci/data_integration/data_integration_client.py index 886c626dfe..720f6c8dc7 100644 --- a/src/oci/data_integration/data_integration_client.py +++ b/src/oci/data_integration/data_integration_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import data_integration_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("data_integration"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/data_labeling_service/data_labeling_management_client.py b/src/oci/data_labeling_service/data_labeling_management_client.py index da776ba14c..048bc17104 100644 --- a/src/oci/data_labeling_service/data_labeling_management_client.py +++ b/src/oci/data_labeling_service/data_labeling_management_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import data_labeling_service_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("data_labeling_service"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/data_labeling_service_dataplane/data_labeling_client.py b/src/oci/data_labeling_service_dataplane/data_labeling_client.py index 356ce2eaa8..f4f0ec5a12 100644 --- a/src/oci/data_labeling_service_dataplane/data_labeling_client.py +++ b/src/oci/data_labeling_service_dataplane/data_labeling_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import data_labeling_service_dataplane_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("data_labeling_service_dataplane"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/data_safe/data_safe_client.py b/src/oci/data_safe/data_safe_client.py index 8091648754..2739ca4f2e 100644 --- a/src/oci/data_safe/data_safe_client.py +++ b/src/oci/data_safe/data_safe_client.py @@ -15,6 +15,8 @@ from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME from oci.util import back_up_body_calculate_stream_content_length, is_content_length_calculable_by_req_util +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import data_safe_type_mapping missing = Sentinel("Missing") @@ -75,6 +77,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("data_safe"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/data_science/data_science_client.py b/src/oci/data_science/data_science_client.py index 2cbad03a57..80a25c9523 100644 --- a/src/oci/data_science/data_science_client.py +++ b/src/oci/data_science/data_science_client.py @@ -15,6 +15,8 @@ from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME from oci.util import back_up_body_calculate_stream_content_length, is_content_length_calculable_by_req_util +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import data_science_type_mapping missing = Sentinel("Missing") @@ -75,6 +77,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("data_science"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/database/database_client.py b/src/oci/database/database_client.py index bb68f72b72..add69914ad 100644 --- a/src/oci/database/database_client.py +++ b/src/oci/database/database_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import database_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("database"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] @@ -2269,7 +2274,7 @@ def change_db_system_compartment(self, change_compartment_details, db_system_id, def change_disaster_recovery_configuration(self, autonomous_database_id, change_disaster_recovery_configuration_details, **kwargs): """ - This operation updates the cross-region disaster recovery (DR) details of the standby Shared Autonomous Database, and must be run on the standby side. + This operation updates the cross-region disaster recovery (DR) details of the standby Autonomous Database Serverless database, and must be run on the standby side. :param str autonomous_database_id: (required) @@ -2278,7 +2283,7 @@ def change_disaster_recovery_configuration(self, autonomous_database_id, change_ __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param oci.database.models.ChangeDisasterRecoveryConfigurationDetails change_disaster_recovery_configuration_details: (required) - Request to update the cross-region disaster recovery (DR) details of the standby Shared Autonomous Database. + Request to update the cross-region disaster recovery (DR) details of the standby Autonomous Database Serverless database. :param str if_match: (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` @@ -19454,7 +19459,10 @@ def list_autonomous_database_character_sets(self, **kwargs): Unique identifier for the request. :param bool is_shared: (optional) - Specifies whether this request is for Autonomous Database on Shared infrastructure. By default, this request will be for Autonomous Database on Dedicated Exadata Infrastructure. + Specifies whether this request is for an Autonomous Database Serverless instance. By default, this request will be for Autonomous Database on Dedicated Exadata Infrastructure. + + :param bool is_dedicated: (optional) + Specifies if the request is for an Autonomous Database Dedicated instance. The default request is for an Autonomous Database Dedicated instance. :param str character_set_type: (optional) Specifies whether this request pertains to database character sets or national character sets. @@ -19492,6 +19500,7 @@ def list_autonomous_database_character_sets(self, **kwargs): "retry_strategy", "opc_request_id", "is_shared", + "is_dedicated", "character_set_type" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] @@ -19508,6 +19517,7 @@ def list_autonomous_database_character_sets(self, **kwargs): query_params = { "isShared": kwargs.get("is_shared", missing), + "isDedicated": kwargs.get("is_dedicated", missing), "characterSetType": kwargs.get("character_set_type", missing) } query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} @@ -20168,9 +20178,7 @@ def list_autonomous_databases(self, compartment_id, **kwargs): def list_autonomous_db_preview_versions(self, compartment_id, **kwargs): """ Gets a list of supported Autonomous Database versions. Note that preview version software is only available for - databases with `shared Exadata infrastructure`__. - - __ https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html + Autonomous Database Serverless (https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html) databases. :param str compartment_id: (required) diff --git a/src/oci/database/database_client_composite_operations.py b/src/oci/database/database_client_composite_operations.py index 67da9deb3e..c3c42c510d 100644 --- a/src/oci/database/database_client_composite_operations.py +++ b/src/oci/database/database_client_composite_operations.py @@ -1088,7 +1088,7 @@ def change_disaster_recovery_configuration_and_wait_for_work_request(self, auton __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param oci.database.models.ChangeDisasterRecoveryConfigurationDetails change_disaster_recovery_configuration_details: (required) - Request to update the cross-region disaster recovery (DR) details of the standby Shared Autonomous Database. + Request to update the cross-region disaster recovery (DR) details of the standby Autonomous Database Serverless database. :param list[str] work_request_states: (optional) An array of work requests states to wait on. These should be valid values for :py:attr:`~oci.work_requests.models.WorkRequest.status` @@ -1128,7 +1128,7 @@ def change_disaster_recovery_configuration_and_wait_for_state(self, autonomous_d __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param oci.database.models.ChangeDisasterRecoveryConfigurationDetails change_disaster_recovery_configuration_details: (required) - Request to update the cross-region disaster recovery (DR) details of the standby Shared Autonomous Database. + Request to update the cross-region disaster recovery (DR) details of the standby Autonomous Database Serverless database. :param list[str] wait_for_states: An array of states to wait on. These should be valid values for :py:attr:`~oci.database.models.AutonomousDatabase.lifecycle_state` diff --git a/src/oci/database/models/autonomous_database.py b/src/oci/database/models/autonomous_database.py index ff3009dd3e..58aa6ae0d5 100644 --- a/src/oci/database/models/autonomous_database.py +++ b/src/oci/database/models/autonomous_database.py @@ -1702,8 +1702,8 @@ def compute_model(self, compute_model): def compute_count(self): """ Gets the compute_count of this AutonomousDatabase. - The compute amount available to the database. Minimum and maximum values depend on the compute model and whether the database is on Shared or Dedicated infrastructure. - For an Autonomous Database on Shared infrastructure, the 'ECPU' compute model requires values in multiples of two. Required when using the `computeModel` parameter. When using `cpuCoreCount` parameter, it is an error to specify computeCount to a non-null value. + The compute amount available to the database. Minimum and maximum values depend on the compute model and whether the database is an Autonomous Database Serverless instance or an Autonomous Database on Dedicated Exadata Infrastructure. + For an Autonomous Database Serverless instance, the 'ECPU' compute model requires values in multiples of two. Required when using the `computeModel` parameter. When using `cpuCoreCount` parameter, it is an error to specify computeCount to a non-null value. :return: The compute_count of this AutonomousDatabase. @@ -1715,8 +1715,8 @@ def compute_count(self): def compute_count(self, compute_count): """ Sets the compute_count of this AutonomousDatabase. - The compute amount available to the database. Minimum and maximum values depend on the compute model and whether the database is on Shared or Dedicated infrastructure. - For an Autonomous Database on Shared infrastructure, the 'ECPU' compute model requires values in multiples of two. Required when using the `computeModel` parameter. When using `cpuCoreCount` parameter, it is an error to specify computeCount to a non-null value. + The compute amount available to the database. Minimum and maximum values depend on the compute model and whether the database is an Autonomous Database Serverless instance or an Autonomous Database on Dedicated Exadata Infrastructure. + For an Autonomous Database Serverless instance, the 'ECPU' compute model requires values in multiples of two. Required when using the `computeModel` parameter. When using `cpuCoreCount` parameter, it is an error to specify computeCount to a non-null value. :param compute_count: The compute_count of this AutonomousDatabase. @@ -1779,14 +1779,14 @@ def ocpu_count(self): The number of OCPU cores to be made available to the database. The following points apply: - - For Autonomous Databases on dedicated Exadata infrastructure, to provision less than 1 core, enter a fractional value in an increment of 0.1. For example, you can provision 0.3 or 0.4 cores, but not 0.35 cores. (Note that fractional OCPU values are not supported for Autonomous Databasese on shared Exadata infrastructure.) + - For Autonomous Databases on Dedicated Exadata Infrastructure, to provision less than 1 core, enter a fractional value in an increment of 0.1. For example, you can provision 0.3 or 0.4 cores, but not 0.35 cores. (Note that fractional OCPU values are not supported for Autonomous Database Serverless instances.) - To provision 1 or more cores, you must enter an integer between 1 and the maximum number of cores available for the infrastructure shape. For example, you can provision 2 cores or 3 cores, but not 2.5 cores. This applies to Autonomous Databases on both shared and dedicated Exadata infrastructure. - For Autonomous Databases on dedicated Exadata infrastructure, the maximum number of cores is determined by the infrastructure shape. See `Characteristics of Infrastructure Shapes`__ for shape details. + For Autonomous Databases on Dedicated Exadata Infrastructure, the maximum number of cores is determined by the infrastructure shape. See `Characteristics of Infrastructure Shapes`__ for shape details. **Note:** This parameter cannot be used with the `cpuCoreCount` parameter. - __ https://www.oracle.com/pls/topic/lookup?ctx=en/cloud/paas/autonomous-database&id=ATPFG-GUID-B0F033C1-CC5A-42F0-B2E7-3CECFEDA1FD1 + __ https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbde/index.html :return: The ocpu_count of this AutonomousDatabase. @@ -1801,14 +1801,14 @@ def ocpu_count(self, ocpu_count): The number of OCPU cores to be made available to the database. The following points apply: - - For Autonomous Databases on dedicated Exadata infrastructure, to provision less than 1 core, enter a fractional value in an increment of 0.1. For example, you can provision 0.3 or 0.4 cores, but not 0.35 cores. (Note that fractional OCPU values are not supported for Autonomous Databasese on shared Exadata infrastructure.) + - For Autonomous Databases on Dedicated Exadata Infrastructure, to provision less than 1 core, enter a fractional value in an increment of 0.1. For example, you can provision 0.3 or 0.4 cores, but not 0.35 cores. (Note that fractional OCPU values are not supported for Autonomous Database Serverless instances.) - To provision 1 or more cores, you must enter an integer between 1 and the maximum number of cores available for the infrastructure shape. For example, you can provision 2 cores or 3 cores, but not 2.5 cores. This applies to Autonomous Databases on both shared and dedicated Exadata infrastructure. - For Autonomous Databases on dedicated Exadata infrastructure, the maximum number of cores is determined by the infrastructure shape. See `Characteristics of Infrastructure Shapes`__ for shape details. + For Autonomous Databases on Dedicated Exadata Infrastructure, the maximum number of cores is determined by the infrastructure shape. See `Characteristics of Infrastructure Shapes`__ for shape details. **Note:** This parameter cannot be used with the `cpuCoreCount` parameter. - __ https://www.oracle.com/pls/topic/lookup?ctx=en/cloud/paas/autonomous-database&id=ATPFG-GUID-B0F033C1-CC5A-42F0-B2E7-3CECFEDA1FD1 + __ https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbde/index.html :param ocpu_count: The ocpu_count of this AutonomousDatabase. @@ -2142,10 +2142,10 @@ def connection_urls(self, connection_urls): def license_model(self): """ Gets the license_model of this AutonomousDatabase. - The Oracle license model that applies to the Oracle Autonomous Database. Bring your own license (BYOL) allows you to apply your current on-premises Oracle software licenses to equivalent, highly automated Oracle PaaS and IaaS services in the cloud. - License Included allows you to subscribe to new Oracle Database software licenses and the Database service. - Note that when provisioning an Autonomous Database on `dedicated Exadata infrastructure`__, this attribute must be null because the attribute is already set at the - Autonomous Exadata Infrastructure level. When using `shared Exadata infrastructure`__, if a value is not specified, the system will supply the value of `BRING_YOUR_OWN_LICENSE`. + The Oracle license model that applies to the Oracle Autonomous Database. Bring your own license (BYOL) allows you to apply your current on-premises Oracle software licenses to equivalent, highly automated Oracle services in the cloud. + License Included allows you to subscribe to new Oracle Database software licenses and the Oracle Database service. + Note that when provisioning an `Autonomous Database on dedicated Exadata infrastructure`__, this attribute must be null. It is already set at the + Autonomous Exadata Infrastructure level. When provisioning an `Autonomous Database Serverless]`__ database, if a value is not specified, the system defaults the value to `BRING_YOUR_OWN_LICENSE`. This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, maxCpuCoreCount, dataStorageSizeInTBs, adminPassword, isMTLSConnectionRequired, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, dbName, scheduledOperations, dbToolsDetails, or isFreeTier. @@ -2165,10 +2165,10 @@ def license_model(self): def license_model(self, license_model): """ Sets the license_model of this AutonomousDatabase. - The Oracle license model that applies to the Oracle Autonomous Database. Bring your own license (BYOL) allows you to apply your current on-premises Oracle software licenses to equivalent, highly automated Oracle PaaS and IaaS services in the cloud. - License Included allows you to subscribe to new Oracle Database software licenses and the Database service. - Note that when provisioning an Autonomous Database on `dedicated Exadata infrastructure`__, this attribute must be null because the attribute is already set at the - Autonomous Exadata Infrastructure level. When using `shared Exadata infrastructure`__, if a value is not specified, the system will supply the value of `BRING_YOUR_OWN_LICENSE`. + The Oracle license model that applies to the Oracle Autonomous Database. Bring your own license (BYOL) allows you to apply your current on-premises Oracle software licenses to equivalent, highly automated Oracle services in the cloud. + License Included allows you to subscribe to new Oracle Database software licenses and the Oracle Database service. + Note that when provisioning an `Autonomous Database on dedicated Exadata infrastructure`__, this attribute must be null. It is already set at the + Autonomous Exadata Infrastructure level. When provisioning an `Autonomous Database Serverless]`__ database, if a value is not specified, the system defaults the value to `BRING_YOUR_OWN_LICENSE`. This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, maxCpuCoreCount, dataStorageSizeInTBs, adminPassword, isMTLSConnectionRequired, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, dbName, scheduledOperations, dbToolsDetails, or isFreeTier. @@ -2560,13 +2560,13 @@ def is_access_control_enabled(self, is_access_control_enabled): def whitelisted_ips(self): """ Gets the whitelisted_ips of this AutonomousDatabase. - The client IP access control list (ACL). This feature is available for autonomous databases on `shared Exadata infrastructure`__ and on Exadata Cloud@Customer. + The client IP access control list (ACL). This feature is available for `Autonomous Database Serverless]`__ and on Exadata Cloud@Customer. Only clients connecting from an IP address included in the ACL may access the Autonomous Database instance. - For shared Exadata infrastructure, this is an array of CIDR (Classless Inter-Domain Routing) notations for a subnet or VCN OCID. + For Autonomous Database Serverless, this is an array of CIDR (classless inter-domain routing) notations for a subnet or VCN OCID (virtual cloud network Oracle Cloud ID). Use a semicolon (;) as a deliminator between the VCN-specific subnets or IPs. Example: `[\"1.1.1.1\",\"1.1.1.0/24\",\"ocid1.vcn.oc1.sea.\",\"ocid1.vcn.oc1.sea.;1.1.1.1\",\"ocid1.vcn.oc1.sea.;1.1.0.0/16\"]` - For Exadata Cloud@Customer, this is an array of IP addresses or CIDR (Classless Inter-Domain Routing) notations. + For Exadata Cloud@Customer, this is an array of IP addresses or CIDR notations. Example: `[\"1.1.1.1\",\"1.1.1.0/24\",\"1.1.2.25\"]` For an update operation, if you want to delete all the IPs in the ACL, use an array with a single empty string entry. @@ -2585,13 +2585,13 @@ def whitelisted_ips(self): def whitelisted_ips(self, whitelisted_ips): """ Sets the whitelisted_ips of this AutonomousDatabase. - The client IP access control list (ACL). This feature is available for autonomous databases on `shared Exadata infrastructure`__ and on Exadata Cloud@Customer. + The client IP access control list (ACL). This feature is available for `Autonomous Database Serverless]`__ and on Exadata Cloud@Customer. Only clients connecting from an IP address included in the ACL may access the Autonomous Database instance. - For shared Exadata infrastructure, this is an array of CIDR (Classless Inter-Domain Routing) notations for a subnet or VCN OCID. + For Autonomous Database Serverless, this is an array of CIDR (classless inter-domain routing) notations for a subnet or VCN OCID (virtual cloud network Oracle Cloud ID). Use a semicolon (;) as a deliminator between the VCN-specific subnets or IPs. Example: `[\"1.1.1.1\",\"1.1.1.0/24\",\"ocid1.vcn.oc1.sea.\",\"ocid1.vcn.oc1.sea.;1.1.1.1\",\"ocid1.vcn.oc1.sea.;1.1.0.0/16\"]` - For Exadata Cloud@Customer, this is an array of IP addresses or CIDR (Classless Inter-Domain Routing) notations. + For Exadata Cloud@Customer, this is an array of IP addresses or CIDR notations. Example: `[\"1.1.1.1\",\"1.1.1.0/24\",\"1.1.2.25\"]` For an update operation, if you want to delete all the IPs in the ACL, use an array with a single empty string entry. @@ -2638,13 +2638,13 @@ def are_primary_whitelisted_ips_used(self, are_primary_whitelisted_ips_used): def standby_whitelisted_ips(self): """ Gets the standby_whitelisted_ips of this AutonomousDatabase. - The client IP access control list (ACL). This feature is available for autonomous databases on `shared Exadata infrastructure`__ and on Exadata Cloud@Customer. + The client IP access control list (ACL). This feature is available for `Autonomous Database Serverless]`__ and on Exadata Cloud@Customer. Only clients connecting from an IP address included in the ACL may access the Autonomous Database instance. - For shared Exadata infrastructure, this is an array of CIDR (Classless Inter-Domain Routing) notations for a subnet or VCN OCID. + For Autonomous Database Serverless, this is an array of CIDR (classless inter-domain routing) notations for a subnet or VCN OCID (virtual cloud network Oracle Cloud ID). Use a semicolon (;) as a deliminator between the VCN-specific subnets or IPs. Example: `[\"1.1.1.1\",\"1.1.1.0/24\",\"ocid1.vcn.oc1.sea.\",\"ocid1.vcn.oc1.sea.;1.1.1.1\",\"ocid1.vcn.oc1.sea.;1.1.0.0/16\"]` - For Exadata Cloud@Customer, this is an array of IP addresses or CIDR (Classless Inter-Domain Routing) notations. + For Exadata Cloud@Customer, this is an array of IP addresses or CIDR notations. Example: `[\"1.1.1.1\",\"1.1.1.0/24\",\"1.1.2.25\"]` For an update operation, if you want to delete all the IPs in the ACL, use an array with a single empty string entry. @@ -2663,13 +2663,13 @@ def standby_whitelisted_ips(self): def standby_whitelisted_ips(self, standby_whitelisted_ips): """ Sets the standby_whitelisted_ips of this AutonomousDatabase. - The client IP access control list (ACL). This feature is available for autonomous databases on `shared Exadata infrastructure`__ and on Exadata Cloud@Customer. + The client IP access control list (ACL). This feature is available for `Autonomous Database Serverless]`__ and on Exadata Cloud@Customer. Only clients connecting from an IP address included in the ACL may access the Autonomous Database instance. - For shared Exadata infrastructure, this is an array of CIDR (Classless Inter-Domain Routing) notations for a subnet or VCN OCID. + For Autonomous Database Serverless, this is an array of CIDR (classless inter-domain routing) notations for a subnet or VCN OCID (virtual cloud network Oracle Cloud ID). Use a semicolon (;) as a deliminator between the VCN-specific subnets or IPs. Example: `[\"1.1.1.1\",\"1.1.1.0/24\",\"ocid1.vcn.oc1.sea.\",\"ocid1.vcn.oc1.sea.;1.1.1.1\",\"ocid1.vcn.oc1.sea.;1.1.0.0/16\"]` - For Exadata Cloud@Customer, this is an array of IP addresses or CIDR (Classless Inter-Domain Routing) notations. + For Exadata Cloud@Customer, this is an array of IP addresses or CIDR notations. Example: `[\"1.1.1.1\",\"1.1.1.0/24\",\"1.1.2.25\"]` For an update operation, if you want to delete all the IPs in the ACL, use an array with a single empty string entry. @@ -3496,7 +3496,7 @@ def time_local_data_guard_enabled(self, time_local_data_guard_enabled): def dataguard_region_type(self): """ Gets the dataguard_region_type of this AutonomousDatabase. - The Autonomous Data Guard region type of the Autonomous Database. For Autonomous Databases on shared Exadata infrastructure, Data Guard associations have designated primary and standby regions, and these region types do not change when the database changes roles. The standby regions in Data Guard associations can be the same region designated as the primary region, or they can be remote regions. Certain database administrative operations may be available only in the primary region of the Data Guard association, and cannot be performed when the database using the \"primary\" role is operating in a remote Data Guard standby region. + The Autonomous Data Guard region type of the Autonomous Database. For Autonomous Database Serverless, Autonomous Data Guard associations have designated primary and standby regions, and these region types do not change when the database changes roles. The standby regions in Autonomous Data Guard associations can be the same region designated as the primary region, or they can be remote regions. Certain database administrative operations may be available only in the primary region of the Autonomous Data Guard association, and cannot be performed when the database using the primary role is operating in a remote Autonomous Data Guard standby region. Allowed values for this property are: "PRIMARY_DG_REGION", "REMOTE_STANDBY_DG_REGION", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -3511,7 +3511,7 @@ def dataguard_region_type(self): def dataguard_region_type(self, dataguard_region_type): """ Sets the dataguard_region_type of this AutonomousDatabase. - The Autonomous Data Guard region type of the Autonomous Database. For Autonomous Databases on shared Exadata infrastructure, Data Guard associations have designated primary and standby regions, and these region types do not change when the database changes roles. The standby regions in Data Guard associations can be the same region designated as the primary region, or they can be remote regions. Certain database administrative operations may be available only in the primary region of the Data Guard association, and cannot be performed when the database using the \"primary\" role is operating in a remote Data Guard standby region. + The Autonomous Data Guard region type of the Autonomous Database. For Autonomous Database Serverless, Autonomous Data Guard associations have designated primary and standby regions, and these region types do not change when the database changes roles. The standby regions in Autonomous Data Guard associations can be the same region designated as the primary region, or they can be remote regions. Certain database administrative operations may be available only in the primary region of the Autonomous Data Guard association, and cannot be performed when the database using the primary role is operating in a remote Autonomous Data Guard standby region. :param dataguard_region_type: The dataguard_region_type of this AutonomousDatabase. @@ -3550,9 +3550,9 @@ def time_data_guard_role_changed(self, time_data_guard_role_changed): def peer_db_ids(self): """ Gets the peer_db_ids of this AutonomousDatabase. - The list of `OCIDs`__ of standby databases located in Autonomous Data Guard remote regions that are associated with the source database. Note that for shared Exadata infrastructure, standby databases located in the same region as the source primary database do not have OCIDs. + The list of `OCIDs`__ of standby databases located in Autonomous Data Guard remote regions that are associated with the source database. Note that for Autonomous Database Serverless instances, standby databases located in the same region as the source primary database do not have OCIDs. - __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + __ https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm :return: The peer_db_ids of this AutonomousDatabase. @@ -3564,9 +3564,9 @@ def peer_db_ids(self): def peer_db_ids(self, peer_db_ids): """ Sets the peer_db_ids of this AutonomousDatabase. - The list of `OCIDs`__ of standby databases located in Autonomous Data Guard remote regions that are associated with the source database. Note that for shared Exadata infrastructure, standby databases located in the same region as the source primary database do not have OCIDs. + The list of `OCIDs`__ of standby databases located in Autonomous Data Guard remote regions that are associated with the source database. Note that for Autonomous Database Serverless instances, standby databases located in the same region as the source primary database do not have OCIDs. - __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + __ https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm :param peer_db_ids: The peer_db_ids of this AutonomousDatabase. @@ -3586,7 +3586,7 @@ def is_mtls_connection_required(self): - CreateAutonomousDatabase - GetAutonomousDatabase - UpdateAutonomousDatabase - Details: Prior to the July 1, 2023 change, the isMTLSConnectionRequired attribute default value was true. This applies to Autonomous Databases on shared Exadata infrastructure. + Details: Prior to the July 1, 2023 change, the isMTLSConnectionRequired attribute default value was true. This applies to Autonomous Database Serverless. Does this impact me? If you use or maintain custom scripts or Terraform scripts referencing the CreateAutonomousDatabase, GetAutonomousDatabase, or UpdateAutonomousDatabase APIs, you want to check, and possibly modify, the scripts for the changed default value of the attribute. Should you choose not to leave your scripts unchanged, the API calls containing this attribute will continue to work, but the default value will switch from true to false. How do I make this change? Using either OCI SDKs or command line tools, update your custom scripts to explicitly set the isMTLSConnectionRequired attribute to true. @@ -3608,7 +3608,7 @@ def is_mtls_connection_required(self, is_mtls_connection_required): - CreateAutonomousDatabase - GetAutonomousDatabase - UpdateAutonomousDatabase - Details: Prior to the July 1, 2023 change, the isMTLSConnectionRequired attribute default value was true. This applies to Autonomous Databases on shared Exadata infrastructure. + Details: Prior to the July 1, 2023 change, the isMTLSConnectionRequired attribute default value was true. This applies to Autonomous Database Serverless. Does this impact me? If you use or maintain custom scripts or Terraform scripts referencing the CreateAutonomousDatabase, GetAutonomousDatabase, or UpdateAutonomousDatabase APIs, you want to check, and possibly modify, the scripts for the changed default value of the attribute. Should you choose not to leave your scripts unchanged, the API calls containing this attribute will continue to work, but the default value will switch from true to false. How do I make this change? Using either OCI SDKs or command line tools, update your custom scripts to explicitly set the isMTLSConnectionRequired attribute to true. @@ -3670,8 +3670,8 @@ def time_until_reconnect_clone_enabled(self, time_until_reconnect_clone_enabled) def autonomous_maintenance_schedule_type(self): """ Gets the autonomous_maintenance_schedule_type of this AutonomousDatabase. - The maintenance schedule type of the Autonomous Database on shared Exadata infrastructure. The EARLY maintenance schedule of this Autonomous Database - follows a schedule that applies patches prior to the REGULAR schedule.The REGULAR maintenance schedule of this Autonomous Database follows the normal cycle. + The maintenance schedule type of the Autonomous Database Serverless. An EARLY maintenance schedule + follows a schedule applying patches prior to the REGULAR schedule. A REGULAR maintenance schedule follows the normal cycle Allowed values for this property are: "EARLY", "REGULAR", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -3686,8 +3686,8 @@ def autonomous_maintenance_schedule_type(self): def autonomous_maintenance_schedule_type(self, autonomous_maintenance_schedule_type): """ Sets the autonomous_maintenance_schedule_type of this AutonomousDatabase. - The maintenance schedule type of the Autonomous Database on shared Exadata infrastructure. The EARLY maintenance schedule of this Autonomous Database - follows a schedule that applies patches prior to the REGULAR schedule.The REGULAR maintenance schedule of this Autonomous Database follows the normal cycle. + The maintenance schedule type of the Autonomous Database Serverless. An EARLY maintenance schedule + follows a schedule applying patches prior to the REGULAR schedule. A REGULAR maintenance schedule follows the normal cycle :param autonomous_maintenance_schedule_type: The autonomous_maintenance_schedule_type of this AutonomousDatabase. @@ -3888,7 +3888,7 @@ def db_tools_details(self, db_tools_details): def local_disaster_recovery_type(self): """ Gets the local_disaster_recovery_type of this AutonomousDatabase. - Indicates the local disaster recovery (DR) type of the Shared Autonomous Database. + Indicates the local disaster recovery (DR) type of the Autonomous Database Serverless instance. Autonomous Data Guard (ADG) DR type provides business critical DR with a faster recovery time objective (RTO) during failover or switchover. Backup-based DR type provides lower cost DR with a slower RTO during failover or switchover. @@ -3902,7 +3902,7 @@ def local_disaster_recovery_type(self): def local_disaster_recovery_type(self, local_disaster_recovery_type): """ Sets the local_disaster_recovery_type of this AutonomousDatabase. - Indicates the local disaster recovery (DR) type of the Shared Autonomous Database. + Indicates the local disaster recovery (DR) type of the Autonomous Database Serverless instance. Autonomous Data Guard (ADG) DR type provides business critical DR with a faster recovery time objective (RTO) during failover or switchover. Backup-based DR type provides lower cost DR with a slower RTO during failover or switchover. @@ -3916,7 +3916,7 @@ def local_disaster_recovery_type(self, local_disaster_recovery_type): def disaster_recovery_region_type(self): """ Gets the disaster_recovery_region_type of this AutonomousDatabase. - The disaster recovery (DR) region type of the Autonomous Database. For Shared Autonomous Databases, DR associations have designated primary and standby regions. These region types do not change when the database changes roles. The standby region in DR associations can be the same region as the primary region, or they can be in a remote regions. Some database administration operations may be available only in the primary region of the DR association, and cannot be performed when the database using the primary role is operating in a remote region. + The disaster recovery (DR) region type of the Autonomous Database. For Autonomous Database Serverless instances, DR associations have designated primary and standby regions. These region types do not change when the database changes roles. The standby region in DR associations can be the same region as the primary region, or they can be in a remote regions. Some database administration operations may be available only in the primary region of the DR association, and cannot be performed when the database using the primary role is operating in a remote region. Allowed values for this property are: "PRIMARY", "REMOTE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -3931,7 +3931,7 @@ def disaster_recovery_region_type(self): def disaster_recovery_region_type(self, disaster_recovery_region_type): """ Sets the disaster_recovery_region_type of this AutonomousDatabase. - The disaster recovery (DR) region type of the Autonomous Database. For Shared Autonomous Databases, DR associations have designated primary and standby regions. These region types do not change when the database changes roles. The standby region in DR associations can be the same region as the primary region, or they can be in a remote regions. Some database administration operations may be available only in the primary region of the DR association, and cannot be performed when the database using the primary role is operating in a remote region. + The disaster recovery (DR) region type of the Autonomous Database. For Autonomous Database Serverless instances, DR associations have designated primary and standby regions. These region types do not change when the database changes roles. The standby region in DR associations can be the same region as the primary region, or they can be in a remote regions. Some database administration operations may be available only in the primary region of the DR association, and cannot be performed when the database using the primary role is operating in a remote region. :param disaster_recovery_region_type: The disaster_recovery_region_type of this AutonomousDatabase. diff --git a/src/oci/database/models/autonomous_database_summary.py b/src/oci/database/models/autonomous_database_summary.py index 486e1ac433..9be51c3e84 100644 --- a/src/oci/database/models/autonomous_database_summary.py +++ b/src/oci/database/models/autonomous_database_summary.py @@ -1704,8 +1704,8 @@ def compute_model(self, compute_model): def compute_count(self): """ Gets the compute_count of this AutonomousDatabaseSummary. - The compute amount available to the database. Minimum and maximum values depend on the compute model and whether the database is on Shared or Dedicated infrastructure. - For an Autonomous Database on Shared infrastructure, the 'ECPU' compute model requires values in multiples of two. Required when using the `computeModel` parameter. When using `cpuCoreCount` parameter, it is an error to specify computeCount to a non-null value. + The compute amount available to the database. Minimum and maximum values depend on the compute model and whether the database is an Autonomous Database Serverless instance or an Autonomous Database on Dedicated Exadata Infrastructure. + For an Autonomous Database Serverless instance, the 'ECPU' compute model requires values in multiples of two. Required when using the `computeModel` parameter. When using `cpuCoreCount` parameter, it is an error to specify computeCount to a non-null value. :return: The compute_count of this AutonomousDatabaseSummary. @@ -1717,8 +1717,8 @@ def compute_count(self): def compute_count(self, compute_count): """ Sets the compute_count of this AutonomousDatabaseSummary. - The compute amount available to the database. Minimum and maximum values depend on the compute model and whether the database is on Shared or Dedicated infrastructure. - For an Autonomous Database on Shared infrastructure, the 'ECPU' compute model requires values in multiples of two. Required when using the `computeModel` parameter. When using `cpuCoreCount` parameter, it is an error to specify computeCount to a non-null value. + The compute amount available to the database. Minimum and maximum values depend on the compute model and whether the database is an Autonomous Database Serverless instance or an Autonomous Database on Dedicated Exadata Infrastructure. + For an Autonomous Database Serverless instance, the 'ECPU' compute model requires values in multiples of two. Required when using the `computeModel` parameter. When using `cpuCoreCount` parameter, it is an error to specify computeCount to a non-null value. :param compute_count: The compute_count of this AutonomousDatabaseSummary. @@ -1781,14 +1781,14 @@ def ocpu_count(self): The number of OCPU cores to be made available to the database. The following points apply: - - For Autonomous Databases on dedicated Exadata infrastructure, to provision less than 1 core, enter a fractional value in an increment of 0.1. For example, you can provision 0.3 or 0.4 cores, but not 0.35 cores. (Note that fractional OCPU values are not supported for Autonomous Databasese on shared Exadata infrastructure.) + - For Autonomous Databases on Dedicated Exadata Infrastructure, to provision less than 1 core, enter a fractional value in an increment of 0.1. For example, you can provision 0.3 or 0.4 cores, but not 0.35 cores. (Note that fractional OCPU values are not supported for Autonomous Database Serverless instances.) - To provision 1 or more cores, you must enter an integer between 1 and the maximum number of cores available for the infrastructure shape. For example, you can provision 2 cores or 3 cores, but not 2.5 cores. This applies to Autonomous Databases on both shared and dedicated Exadata infrastructure. - For Autonomous Databases on dedicated Exadata infrastructure, the maximum number of cores is determined by the infrastructure shape. See `Characteristics of Infrastructure Shapes`__ for shape details. + For Autonomous Databases on Dedicated Exadata Infrastructure, the maximum number of cores is determined by the infrastructure shape. See `Characteristics of Infrastructure Shapes`__ for shape details. **Note:** This parameter cannot be used with the `cpuCoreCount` parameter. - __ https://www.oracle.com/pls/topic/lookup?ctx=en/cloud/paas/autonomous-database&id=ATPFG-GUID-B0F033C1-CC5A-42F0-B2E7-3CECFEDA1FD1 + __ https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbde/index.html :return: The ocpu_count of this AutonomousDatabaseSummary. @@ -1803,14 +1803,14 @@ def ocpu_count(self, ocpu_count): The number of OCPU cores to be made available to the database. The following points apply: - - For Autonomous Databases on dedicated Exadata infrastructure, to provision less than 1 core, enter a fractional value in an increment of 0.1. For example, you can provision 0.3 or 0.4 cores, but not 0.35 cores. (Note that fractional OCPU values are not supported for Autonomous Databasese on shared Exadata infrastructure.) + - For Autonomous Databases on Dedicated Exadata Infrastructure, to provision less than 1 core, enter a fractional value in an increment of 0.1. For example, you can provision 0.3 or 0.4 cores, but not 0.35 cores. (Note that fractional OCPU values are not supported for Autonomous Database Serverless instances.) - To provision 1 or more cores, you must enter an integer between 1 and the maximum number of cores available for the infrastructure shape. For example, you can provision 2 cores or 3 cores, but not 2.5 cores. This applies to Autonomous Databases on both shared and dedicated Exadata infrastructure. - For Autonomous Databases on dedicated Exadata infrastructure, the maximum number of cores is determined by the infrastructure shape. See `Characteristics of Infrastructure Shapes`__ for shape details. + For Autonomous Databases on Dedicated Exadata Infrastructure, the maximum number of cores is determined by the infrastructure shape. See `Characteristics of Infrastructure Shapes`__ for shape details. **Note:** This parameter cannot be used with the `cpuCoreCount` parameter. - __ https://www.oracle.com/pls/topic/lookup?ctx=en/cloud/paas/autonomous-database&id=ATPFG-GUID-B0F033C1-CC5A-42F0-B2E7-3CECFEDA1FD1 + __ https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbde/index.html :param ocpu_count: The ocpu_count of this AutonomousDatabaseSummary. @@ -2144,10 +2144,10 @@ def connection_urls(self, connection_urls): def license_model(self): """ Gets the license_model of this AutonomousDatabaseSummary. - The Oracle license model that applies to the Oracle Autonomous Database. Bring your own license (BYOL) allows you to apply your current on-premises Oracle software licenses to equivalent, highly automated Oracle PaaS and IaaS services in the cloud. - License Included allows you to subscribe to new Oracle Database software licenses and the Database service. - Note that when provisioning an Autonomous Database on `dedicated Exadata infrastructure`__, this attribute must be null because the attribute is already set at the - Autonomous Exadata Infrastructure level. When using `shared Exadata infrastructure`__, if a value is not specified, the system will supply the value of `BRING_YOUR_OWN_LICENSE`. + The Oracle license model that applies to the Oracle Autonomous Database. Bring your own license (BYOL) allows you to apply your current on-premises Oracle software licenses to equivalent, highly automated Oracle services in the cloud. + License Included allows you to subscribe to new Oracle Database software licenses and the Oracle Database service. + Note that when provisioning an `Autonomous Database on dedicated Exadata infrastructure`__, this attribute must be null. It is already set at the + Autonomous Exadata Infrastructure level. When provisioning an `Autonomous Database Serverless]`__ database, if a value is not specified, the system defaults the value to `BRING_YOUR_OWN_LICENSE`. This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, maxCpuCoreCount, dataStorageSizeInTBs, adminPassword, isMTLSConnectionRequired, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, dbName, scheduledOperations, dbToolsDetails, or isFreeTier. @@ -2167,10 +2167,10 @@ def license_model(self): def license_model(self, license_model): """ Sets the license_model of this AutonomousDatabaseSummary. - The Oracle license model that applies to the Oracle Autonomous Database. Bring your own license (BYOL) allows you to apply your current on-premises Oracle software licenses to equivalent, highly automated Oracle PaaS and IaaS services in the cloud. - License Included allows you to subscribe to new Oracle Database software licenses and the Database service. - Note that when provisioning an Autonomous Database on `dedicated Exadata infrastructure`__, this attribute must be null because the attribute is already set at the - Autonomous Exadata Infrastructure level. When using `shared Exadata infrastructure`__, if a value is not specified, the system will supply the value of `BRING_YOUR_OWN_LICENSE`. + The Oracle license model that applies to the Oracle Autonomous Database. Bring your own license (BYOL) allows you to apply your current on-premises Oracle software licenses to equivalent, highly automated Oracle services in the cloud. + License Included allows you to subscribe to new Oracle Database software licenses and the Oracle Database service. + Note that when provisioning an `Autonomous Database on dedicated Exadata infrastructure`__, this attribute must be null. It is already set at the + Autonomous Exadata Infrastructure level. When provisioning an `Autonomous Database Serverless]`__ database, if a value is not specified, the system defaults the value to `BRING_YOUR_OWN_LICENSE`. This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, maxCpuCoreCount, dataStorageSizeInTBs, adminPassword, isMTLSConnectionRequired, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, dbName, scheduledOperations, dbToolsDetails, or isFreeTier. @@ -2562,13 +2562,13 @@ def is_access_control_enabled(self, is_access_control_enabled): def whitelisted_ips(self): """ Gets the whitelisted_ips of this AutonomousDatabaseSummary. - The client IP access control list (ACL). This feature is available for autonomous databases on `shared Exadata infrastructure`__ and on Exadata Cloud@Customer. + The client IP access control list (ACL). This feature is available for `Autonomous Database Serverless]`__ and on Exadata Cloud@Customer. Only clients connecting from an IP address included in the ACL may access the Autonomous Database instance. - For shared Exadata infrastructure, this is an array of CIDR (Classless Inter-Domain Routing) notations for a subnet or VCN OCID. + For Autonomous Database Serverless, this is an array of CIDR (classless inter-domain routing) notations for a subnet or VCN OCID (virtual cloud network Oracle Cloud ID). Use a semicolon (;) as a deliminator between the VCN-specific subnets or IPs. Example: `[\"1.1.1.1\",\"1.1.1.0/24\",\"ocid1.vcn.oc1.sea.\",\"ocid1.vcn.oc1.sea.;1.1.1.1\",\"ocid1.vcn.oc1.sea.;1.1.0.0/16\"]` - For Exadata Cloud@Customer, this is an array of IP addresses or CIDR (Classless Inter-Domain Routing) notations. + For Exadata Cloud@Customer, this is an array of IP addresses or CIDR notations. Example: `[\"1.1.1.1\",\"1.1.1.0/24\",\"1.1.2.25\"]` For an update operation, if you want to delete all the IPs in the ACL, use an array with a single empty string entry. @@ -2587,13 +2587,13 @@ def whitelisted_ips(self): def whitelisted_ips(self, whitelisted_ips): """ Sets the whitelisted_ips of this AutonomousDatabaseSummary. - The client IP access control list (ACL). This feature is available for autonomous databases on `shared Exadata infrastructure`__ and on Exadata Cloud@Customer. + The client IP access control list (ACL). This feature is available for `Autonomous Database Serverless]`__ and on Exadata Cloud@Customer. Only clients connecting from an IP address included in the ACL may access the Autonomous Database instance. - For shared Exadata infrastructure, this is an array of CIDR (Classless Inter-Domain Routing) notations for a subnet or VCN OCID. + For Autonomous Database Serverless, this is an array of CIDR (classless inter-domain routing) notations for a subnet or VCN OCID (virtual cloud network Oracle Cloud ID). Use a semicolon (;) as a deliminator between the VCN-specific subnets or IPs. Example: `[\"1.1.1.1\",\"1.1.1.0/24\",\"ocid1.vcn.oc1.sea.\",\"ocid1.vcn.oc1.sea.;1.1.1.1\",\"ocid1.vcn.oc1.sea.;1.1.0.0/16\"]` - For Exadata Cloud@Customer, this is an array of IP addresses or CIDR (Classless Inter-Domain Routing) notations. + For Exadata Cloud@Customer, this is an array of IP addresses or CIDR notations. Example: `[\"1.1.1.1\",\"1.1.1.0/24\",\"1.1.2.25\"]` For an update operation, if you want to delete all the IPs in the ACL, use an array with a single empty string entry. @@ -2640,13 +2640,13 @@ def are_primary_whitelisted_ips_used(self, are_primary_whitelisted_ips_used): def standby_whitelisted_ips(self): """ Gets the standby_whitelisted_ips of this AutonomousDatabaseSummary. - The client IP access control list (ACL). This feature is available for autonomous databases on `shared Exadata infrastructure`__ and on Exadata Cloud@Customer. + The client IP access control list (ACL). This feature is available for `Autonomous Database Serverless]`__ and on Exadata Cloud@Customer. Only clients connecting from an IP address included in the ACL may access the Autonomous Database instance. - For shared Exadata infrastructure, this is an array of CIDR (Classless Inter-Domain Routing) notations for a subnet or VCN OCID. + For Autonomous Database Serverless, this is an array of CIDR (classless inter-domain routing) notations for a subnet or VCN OCID (virtual cloud network Oracle Cloud ID). Use a semicolon (;) as a deliminator between the VCN-specific subnets or IPs. Example: `[\"1.1.1.1\",\"1.1.1.0/24\",\"ocid1.vcn.oc1.sea.\",\"ocid1.vcn.oc1.sea.;1.1.1.1\",\"ocid1.vcn.oc1.sea.;1.1.0.0/16\"]` - For Exadata Cloud@Customer, this is an array of IP addresses or CIDR (Classless Inter-Domain Routing) notations. + For Exadata Cloud@Customer, this is an array of IP addresses or CIDR notations. Example: `[\"1.1.1.1\",\"1.1.1.0/24\",\"1.1.2.25\"]` For an update operation, if you want to delete all the IPs in the ACL, use an array with a single empty string entry. @@ -2665,13 +2665,13 @@ def standby_whitelisted_ips(self): def standby_whitelisted_ips(self, standby_whitelisted_ips): """ Sets the standby_whitelisted_ips of this AutonomousDatabaseSummary. - The client IP access control list (ACL). This feature is available for autonomous databases on `shared Exadata infrastructure`__ and on Exadata Cloud@Customer. + The client IP access control list (ACL). This feature is available for `Autonomous Database Serverless]`__ and on Exadata Cloud@Customer. Only clients connecting from an IP address included in the ACL may access the Autonomous Database instance. - For shared Exadata infrastructure, this is an array of CIDR (Classless Inter-Domain Routing) notations for a subnet or VCN OCID. + For Autonomous Database Serverless, this is an array of CIDR (classless inter-domain routing) notations for a subnet or VCN OCID (virtual cloud network Oracle Cloud ID). Use a semicolon (;) as a deliminator between the VCN-specific subnets or IPs. Example: `[\"1.1.1.1\",\"1.1.1.0/24\",\"ocid1.vcn.oc1.sea.\",\"ocid1.vcn.oc1.sea.;1.1.1.1\",\"ocid1.vcn.oc1.sea.;1.1.0.0/16\"]` - For Exadata Cloud@Customer, this is an array of IP addresses or CIDR (Classless Inter-Domain Routing) notations. + For Exadata Cloud@Customer, this is an array of IP addresses or CIDR notations. Example: `[\"1.1.1.1\",\"1.1.1.0/24\",\"1.1.2.25\"]` For an update operation, if you want to delete all the IPs in the ACL, use an array with a single empty string entry. @@ -3498,7 +3498,7 @@ def time_local_data_guard_enabled(self, time_local_data_guard_enabled): def dataguard_region_type(self): """ Gets the dataguard_region_type of this AutonomousDatabaseSummary. - The Autonomous Data Guard region type of the Autonomous Database. For Autonomous Databases on shared Exadata infrastructure, Data Guard associations have designated primary and standby regions, and these region types do not change when the database changes roles. The standby regions in Data Guard associations can be the same region designated as the primary region, or they can be remote regions. Certain database administrative operations may be available only in the primary region of the Data Guard association, and cannot be performed when the database using the \"primary\" role is operating in a remote Data Guard standby region. + The Autonomous Data Guard region type of the Autonomous Database. For Autonomous Database Serverless, Autonomous Data Guard associations have designated primary and standby regions, and these region types do not change when the database changes roles. The standby regions in Autonomous Data Guard associations can be the same region designated as the primary region, or they can be remote regions. Certain database administrative operations may be available only in the primary region of the Autonomous Data Guard association, and cannot be performed when the database using the primary role is operating in a remote Autonomous Data Guard standby region. Allowed values for this property are: "PRIMARY_DG_REGION", "REMOTE_STANDBY_DG_REGION", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -3513,7 +3513,7 @@ def dataguard_region_type(self): def dataguard_region_type(self, dataguard_region_type): """ Sets the dataguard_region_type of this AutonomousDatabaseSummary. - The Autonomous Data Guard region type of the Autonomous Database. For Autonomous Databases on shared Exadata infrastructure, Data Guard associations have designated primary and standby regions, and these region types do not change when the database changes roles. The standby regions in Data Guard associations can be the same region designated as the primary region, or they can be remote regions. Certain database administrative operations may be available only in the primary region of the Data Guard association, and cannot be performed when the database using the \"primary\" role is operating in a remote Data Guard standby region. + The Autonomous Data Guard region type of the Autonomous Database. For Autonomous Database Serverless, Autonomous Data Guard associations have designated primary and standby regions, and these region types do not change when the database changes roles. The standby regions in Autonomous Data Guard associations can be the same region designated as the primary region, or they can be remote regions. Certain database administrative operations may be available only in the primary region of the Autonomous Data Guard association, and cannot be performed when the database using the primary role is operating in a remote Autonomous Data Guard standby region. :param dataguard_region_type: The dataguard_region_type of this AutonomousDatabaseSummary. @@ -3552,9 +3552,9 @@ def time_data_guard_role_changed(self, time_data_guard_role_changed): def peer_db_ids(self): """ Gets the peer_db_ids of this AutonomousDatabaseSummary. - The list of `OCIDs`__ of standby databases located in Autonomous Data Guard remote regions that are associated with the source database. Note that for shared Exadata infrastructure, standby databases located in the same region as the source primary database do not have OCIDs. + The list of `OCIDs`__ of standby databases located in Autonomous Data Guard remote regions that are associated with the source database. Note that for Autonomous Database Serverless instances, standby databases located in the same region as the source primary database do not have OCIDs. - __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + __ https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm :return: The peer_db_ids of this AutonomousDatabaseSummary. @@ -3566,9 +3566,9 @@ def peer_db_ids(self): def peer_db_ids(self, peer_db_ids): """ Sets the peer_db_ids of this AutonomousDatabaseSummary. - The list of `OCIDs`__ of standby databases located in Autonomous Data Guard remote regions that are associated with the source database. Note that for shared Exadata infrastructure, standby databases located in the same region as the source primary database do not have OCIDs. + The list of `OCIDs`__ of standby databases located in Autonomous Data Guard remote regions that are associated with the source database. Note that for Autonomous Database Serverless instances, standby databases located in the same region as the source primary database do not have OCIDs. - __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + __ https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm :param peer_db_ids: The peer_db_ids of this AutonomousDatabaseSummary. @@ -3588,7 +3588,7 @@ def is_mtls_connection_required(self): - CreateAutonomousDatabase - GetAutonomousDatabase - UpdateAutonomousDatabase - Details: Prior to the July 1, 2023 change, the isMTLSConnectionRequired attribute default value was true. This applies to Autonomous Databases on shared Exadata infrastructure. + Details: Prior to the July 1, 2023 change, the isMTLSConnectionRequired attribute default value was true. This applies to Autonomous Database Serverless. Does this impact me? If you use or maintain custom scripts or Terraform scripts referencing the CreateAutonomousDatabase, GetAutonomousDatabase, or UpdateAutonomousDatabase APIs, you want to check, and possibly modify, the scripts for the changed default value of the attribute. Should you choose not to leave your scripts unchanged, the API calls containing this attribute will continue to work, but the default value will switch from true to false. How do I make this change? Using either OCI SDKs or command line tools, update your custom scripts to explicitly set the isMTLSConnectionRequired attribute to true. @@ -3610,7 +3610,7 @@ def is_mtls_connection_required(self, is_mtls_connection_required): - CreateAutonomousDatabase - GetAutonomousDatabase - UpdateAutonomousDatabase - Details: Prior to the July 1, 2023 change, the isMTLSConnectionRequired attribute default value was true. This applies to Autonomous Databases on shared Exadata infrastructure. + Details: Prior to the July 1, 2023 change, the isMTLSConnectionRequired attribute default value was true. This applies to Autonomous Database Serverless. Does this impact me? If you use or maintain custom scripts or Terraform scripts referencing the CreateAutonomousDatabase, GetAutonomousDatabase, or UpdateAutonomousDatabase APIs, you want to check, and possibly modify, the scripts for the changed default value of the attribute. Should you choose not to leave your scripts unchanged, the API calls containing this attribute will continue to work, but the default value will switch from true to false. How do I make this change? Using either OCI SDKs or command line tools, update your custom scripts to explicitly set the isMTLSConnectionRequired attribute to true. @@ -3672,8 +3672,8 @@ def time_until_reconnect_clone_enabled(self, time_until_reconnect_clone_enabled) def autonomous_maintenance_schedule_type(self): """ Gets the autonomous_maintenance_schedule_type of this AutonomousDatabaseSummary. - The maintenance schedule type of the Autonomous Database on shared Exadata infrastructure. The EARLY maintenance schedule of this Autonomous Database - follows a schedule that applies patches prior to the REGULAR schedule.The REGULAR maintenance schedule of this Autonomous Database follows the normal cycle. + The maintenance schedule type of the Autonomous Database Serverless. An EARLY maintenance schedule + follows a schedule applying patches prior to the REGULAR schedule. A REGULAR maintenance schedule follows the normal cycle Allowed values for this property are: "EARLY", "REGULAR", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -3688,8 +3688,8 @@ def autonomous_maintenance_schedule_type(self): def autonomous_maintenance_schedule_type(self, autonomous_maintenance_schedule_type): """ Sets the autonomous_maintenance_schedule_type of this AutonomousDatabaseSummary. - The maintenance schedule type of the Autonomous Database on shared Exadata infrastructure. The EARLY maintenance schedule of this Autonomous Database - follows a schedule that applies patches prior to the REGULAR schedule.The REGULAR maintenance schedule of this Autonomous Database follows the normal cycle. + The maintenance schedule type of the Autonomous Database Serverless. An EARLY maintenance schedule + follows a schedule applying patches prior to the REGULAR schedule. A REGULAR maintenance schedule follows the normal cycle :param autonomous_maintenance_schedule_type: The autonomous_maintenance_schedule_type of this AutonomousDatabaseSummary. @@ -3890,7 +3890,7 @@ def db_tools_details(self, db_tools_details): def local_disaster_recovery_type(self): """ Gets the local_disaster_recovery_type of this AutonomousDatabaseSummary. - Indicates the local disaster recovery (DR) type of the Shared Autonomous Database. + Indicates the local disaster recovery (DR) type of the Autonomous Database Serverless instance. Autonomous Data Guard (ADG) DR type provides business critical DR with a faster recovery time objective (RTO) during failover or switchover. Backup-based DR type provides lower cost DR with a slower RTO during failover or switchover. @@ -3904,7 +3904,7 @@ def local_disaster_recovery_type(self): def local_disaster_recovery_type(self, local_disaster_recovery_type): """ Sets the local_disaster_recovery_type of this AutonomousDatabaseSummary. - Indicates the local disaster recovery (DR) type of the Shared Autonomous Database. + Indicates the local disaster recovery (DR) type of the Autonomous Database Serverless instance. Autonomous Data Guard (ADG) DR type provides business critical DR with a faster recovery time objective (RTO) during failover or switchover. Backup-based DR type provides lower cost DR with a slower RTO during failover or switchover. @@ -3918,7 +3918,7 @@ def local_disaster_recovery_type(self, local_disaster_recovery_type): def disaster_recovery_region_type(self): """ Gets the disaster_recovery_region_type of this AutonomousDatabaseSummary. - The disaster recovery (DR) region type of the Autonomous Database. For Shared Autonomous Databases, DR associations have designated primary and standby regions. These region types do not change when the database changes roles. The standby region in DR associations can be the same region as the primary region, or they can be in a remote regions. Some database administration operations may be available only in the primary region of the DR association, and cannot be performed when the database using the primary role is operating in a remote region. + The disaster recovery (DR) region type of the Autonomous Database. For Autonomous Database Serverless instances, DR associations have designated primary and standby regions. These region types do not change when the database changes roles. The standby region in DR associations can be the same region as the primary region, or they can be in a remote regions. Some database administration operations may be available only in the primary region of the DR association, and cannot be performed when the database using the primary role is operating in a remote region. Allowed values for this property are: "PRIMARY", "REMOTE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -3933,7 +3933,7 @@ def disaster_recovery_region_type(self): def disaster_recovery_region_type(self, disaster_recovery_region_type): """ Sets the disaster_recovery_region_type of this AutonomousDatabaseSummary. - The disaster recovery (DR) region type of the Autonomous Database. For Shared Autonomous Databases, DR associations have designated primary and standby regions. These region types do not change when the database changes roles. The standby region in DR associations can be the same region as the primary region, or they can be in a remote regions. Some database administration operations may be available only in the primary region of the DR association, and cannot be performed when the database using the primary role is operating in a remote region. + The disaster recovery (DR) region type of the Autonomous Database. For Autonomous Database Serverless instances, DR associations have designated primary and standby regions. These region types do not change when the database changes roles. The standby region in DR associations can be the same region as the primary region, or they can be in a remote regions. Some database administration operations may be available only in the primary region of the DR association, and cannot be performed when the database using the primary role is operating in a remote region. :param disaster_recovery_region_type: The disaster_recovery_region_type of this AutonomousDatabaseSummary. diff --git a/src/oci/database/models/autonomous_db_preview_version_summary.py b/src/oci/database/models/autonomous_db_preview_version_summary.py index 0c90f3c4f0..f0d19ec988 100644 --- a/src/oci/database/models/autonomous_db_preview_version_summary.py +++ b/src/oci/database/models/autonomous_db_preview_version_summary.py @@ -12,9 +12,9 @@ @init_model_state_from_kwargs class AutonomousDbPreviewVersionSummary(object): """ - The Autonomous Database preview version. Note that preview version software is only available for databases on `shared Exadata infrastructure`__. + The Autonomous Database preview version. Note that preview version software is only available for `Autonomous Database Serverless instances`__. - __ https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html + __ https://docs.oracle.com/en/cloud/paas/autonomous-database/shared/index.html """ #: A constant which can be used with the db_workload property of a AutonomousDbPreviewVersionSummary. diff --git a/src/oci/database/models/change_disaster_recovery_configuration_details.py b/src/oci/database/models/change_disaster_recovery_configuration_details.py index a2b0f10087..730429d476 100644 --- a/src/oci/database/models/change_disaster_recovery_configuration_details.py +++ b/src/oci/database/models/change_disaster_recovery_configuration_details.py @@ -12,7 +12,7 @@ @init_model_state_from_kwargs class ChangeDisasterRecoveryConfigurationDetails(object): """ - Details to update the cross-region Disaster Recovery (DR) details of the Standby Autonomous Database on shared Exadata infrastructure. + Details to update the cross-region disaster recovery (DR) details of the standby Autonomous Database Serverless instance. """ #: A constant which can be used with the disaster_recovery_type property of a ChangeDisasterRecoveryConfigurationDetails. @@ -62,7 +62,7 @@ def __init__(self, **kwargs): def disaster_recovery_type(self): """ Gets the disaster_recovery_type of this ChangeDisasterRecoveryConfigurationDetails. - Indicates the disaster recovery (DR) type of the Shared Autonomous Database. + Indicates the disaster recovery (DR) type of the Autonomous Database Serverless instance. Autonomous Data Guard (ADG) DR type provides business critical DR with a faster recovery time objective (RTO) during failover or switchover. Backup-based DR type provides lower cost DR with a slower RTO during failover or switchover. @@ -78,7 +78,7 @@ def disaster_recovery_type(self): def disaster_recovery_type(self, disaster_recovery_type): """ Sets the disaster_recovery_type of this ChangeDisasterRecoveryConfigurationDetails. - Indicates the disaster recovery (DR) type of the Shared Autonomous Database. + Indicates the disaster recovery (DR) type of the Autonomous Database Serverless instance. Autonomous Data Guard (ADG) DR type provides business critical DR with a faster recovery time objective (RTO) during failover or switchover. Backup-based DR type provides lower cost DR with a slower RTO during failover or switchover. diff --git a/src/oci/database/models/cloud_autonomous_vm_cluster.py b/src/oci/database/models/cloud_autonomous_vm_cluster.py index dbe25c290b..d652621dcd 100644 --- a/src/oci/database/models/cloud_autonomous_vm_cluster.py +++ b/src/oci/database/models/cloud_autonomous_vm_cluster.py @@ -1140,10 +1140,10 @@ def memory_size_in_gbs(self, memory_size_in_gbs): def license_model(self): """ Gets the license_model of this CloudAutonomousVmCluster. - The Oracle license model that applies to the Oracle Autonomous Database. Bring your own license (BYOL) allows you to apply your current on-premises Oracle software licenses to equivalent, highly automated Oracle PaaS and IaaS services in the cloud. - License Included allows you to subscribe to new Oracle Database software licenses and the Database service. - Note that when provisioning an Autonomous Database on `dedicated Exadata infrastructure`__, this attribute must be null because the attribute is already set at the - Autonomous Exadata Infrastructure level. When using `shared Exadata infrastructure`__, if a value is not specified, the system will supply the value of `BRING_YOUR_OWN_LICENSE`. + The Oracle license model that applies to the Oracle Autonomous Database. Bring your own license (BYOL) allows you to apply your current on-premises Oracle software licenses to equivalent, highly automated Oracle services in the cloud. + License Included allows you to subscribe to new Oracle Database software licenses and the Oracle Database service. + Note that when provisioning an `Autonomous Database on dedicated Exadata infrastructure`__, this attribute must be null. It is already set at the + Autonomous Exadata Infrastructure level. When provisioning an `Autonomous Database Serverless]`__ database, if a value is not specified, the system defaults the value to `BRING_YOUR_OWN_LICENSE`. This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, maxCpuCoreCount, dataStorageSizeInTBs, adminPassword, isMTLSConnectionRequired, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, dbName, scheduledOperations, dbToolsDetails, or isFreeTier. @@ -1163,10 +1163,10 @@ def license_model(self): def license_model(self, license_model): """ Sets the license_model of this CloudAutonomousVmCluster. - The Oracle license model that applies to the Oracle Autonomous Database. Bring your own license (BYOL) allows you to apply your current on-premises Oracle software licenses to equivalent, highly automated Oracle PaaS and IaaS services in the cloud. - License Included allows you to subscribe to new Oracle Database software licenses and the Database service. - Note that when provisioning an Autonomous Database on `dedicated Exadata infrastructure`__, this attribute must be null because the attribute is already set at the - Autonomous Exadata Infrastructure level. When using `shared Exadata infrastructure`__, if a value is not specified, the system will supply the value of `BRING_YOUR_OWN_LICENSE`. + The Oracle license model that applies to the Oracle Autonomous Database. Bring your own license (BYOL) allows you to apply your current on-premises Oracle software licenses to equivalent, highly automated Oracle services in the cloud. + License Included allows you to subscribe to new Oracle Database software licenses and the Oracle Database service. + Note that when provisioning an `Autonomous Database on dedicated Exadata infrastructure`__, this attribute must be null. It is already set at the + Autonomous Exadata Infrastructure level. When provisioning an `Autonomous Database Serverless]`__ database, if a value is not specified, the system defaults the value to `BRING_YOUR_OWN_LICENSE`. This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, maxCpuCoreCount, dataStorageSizeInTBs, adminPassword, isMTLSConnectionRequired, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, dbName, scheduledOperations, dbToolsDetails, or isFreeTier. diff --git a/src/oci/database/models/cloud_autonomous_vm_cluster_summary.py b/src/oci/database/models/cloud_autonomous_vm_cluster_summary.py index 165d08368c..95a3f9a419 100644 --- a/src/oci/database/models/cloud_autonomous_vm_cluster_summary.py +++ b/src/oci/database/models/cloud_autonomous_vm_cluster_summary.py @@ -1140,10 +1140,10 @@ def memory_size_in_gbs(self, memory_size_in_gbs): def license_model(self): """ Gets the license_model of this CloudAutonomousVmClusterSummary. - The Oracle license model that applies to the Oracle Autonomous Database. Bring your own license (BYOL) allows you to apply your current on-premises Oracle software licenses to equivalent, highly automated Oracle PaaS and IaaS services in the cloud. - License Included allows you to subscribe to new Oracle Database software licenses and the Database service. - Note that when provisioning an Autonomous Database on `dedicated Exadata infrastructure`__, this attribute must be null because the attribute is already set at the - Autonomous Exadata Infrastructure level. When using `shared Exadata infrastructure`__, if a value is not specified, the system will supply the value of `BRING_YOUR_OWN_LICENSE`. + The Oracle license model that applies to the Oracle Autonomous Database. Bring your own license (BYOL) allows you to apply your current on-premises Oracle software licenses to equivalent, highly automated Oracle services in the cloud. + License Included allows you to subscribe to new Oracle Database software licenses and the Oracle Database service. + Note that when provisioning an `Autonomous Database on dedicated Exadata infrastructure`__, this attribute must be null. It is already set at the + Autonomous Exadata Infrastructure level. When provisioning an `Autonomous Database Serverless]`__ database, if a value is not specified, the system defaults the value to `BRING_YOUR_OWN_LICENSE`. This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, maxCpuCoreCount, dataStorageSizeInTBs, adminPassword, isMTLSConnectionRequired, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, dbName, scheduledOperations, dbToolsDetails, or isFreeTier. @@ -1163,10 +1163,10 @@ def license_model(self): def license_model(self, license_model): """ Sets the license_model of this CloudAutonomousVmClusterSummary. - The Oracle license model that applies to the Oracle Autonomous Database. Bring your own license (BYOL) allows you to apply your current on-premises Oracle software licenses to equivalent, highly automated Oracle PaaS and IaaS services in the cloud. - License Included allows you to subscribe to new Oracle Database software licenses and the Database service. - Note that when provisioning an Autonomous Database on `dedicated Exadata infrastructure`__, this attribute must be null because the attribute is already set at the - Autonomous Exadata Infrastructure level. When using `shared Exadata infrastructure`__, if a value is not specified, the system will supply the value of `BRING_YOUR_OWN_LICENSE`. + The Oracle license model that applies to the Oracle Autonomous Database. Bring your own license (BYOL) allows you to apply your current on-premises Oracle software licenses to equivalent, highly automated Oracle services in the cloud. + License Included allows you to subscribe to new Oracle Database software licenses and the Oracle Database service. + Note that when provisioning an `Autonomous Database on dedicated Exadata infrastructure`__, this attribute must be null. It is already set at the + Autonomous Exadata Infrastructure level. When provisioning an `Autonomous Database Serverless]`__ database, if a value is not specified, the system defaults the value to `BRING_YOUR_OWN_LICENSE`. This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, maxCpuCoreCount, dataStorageSizeInTBs, adminPassword, isMTLSConnectionRequired, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, dbName, scheduledOperations, dbToolsDetails, or isFreeTier. diff --git a/src/oci/database/models/create_autonomous_database_base.py b/src/oci/database/models/create_autonomous_database_base.py index 89d40d64dc..74fe86e868 100644 --- a/src/oci/database/models/create_autonomous_database_base.py +++ b/src/oci/database/models/create_autonomous_database_base.py @@ -510,13 +510,13 @@ def compartment_id(self, compartment_id): def character_set(self): """ Gets the character_set of this CreateAutonomousDatabaseBase. - The character set for the autonomous database. The default is AL32UTF8. Allowed values for an Autonomous Database on shared infrastructure as as returned by `List Autonomous Database Character Sets`__ + The character set for the autonomous database. The default is AL32UTF8. Allowed values for an Autonomous Database Serverless instance as as returned by `List Autonomous Database Character Sets`__ For an Autonomous Database on dedicated infrastructure, the allowed values are: AL32UTF8, AR8ADOS710, AR8ADOS720, AR8APTEC715, AR8ARABICMACS, AR8ASMO8X, AR8ISO8859P6, AR8MSWIN1256, AR8MUSSAD768, AR8NAFITHA711, AR8NAFITHA721, AR8SAKHR706, AR8SAKHR707, AZ8ISO8859P9E, BG8MSWIN, BG8PC437S, BLT8CP921, BLT8ISO8859P13, BLT8MSWIN1257, BLT8PC775, BN8BSCII, CDN8PC863, CEL8ISO8859P14, CL8ISO8859P5, CL8ISOIR111, CL8KOI8R, CL8KOI8U, CL8MACCYRILLICS, CL8MSWIN1251, EE8ISO8859P2, EE8MACCES, EE8MACCROATIANS, EE8MSWIN1250, EE8PC852, EL8DEC, EL8ISO8859P7, EL8MACGREEKS, EL8MSWIN1253, EL8PC437S, EL8PC851, EL8PC869, ET8MSWIN923, HU8ABMOD, HU8CWI2, IN8ISCII, IS8PC861, IW8ISO8859P8, IW8MACHEBREWS, IW8MSWIN1255, IW8PC1507, JA16EUC, JA16EUCTILDE, JA16SJIS, JA16SJISTILDE, JA16VMS, KO16KSC5601, KO16KSCCS, KO16MSWIN949, LA8ISO6937, LA8PASSPORT, LT8MSWIN921, LT8PC772, LT8PC774, LV8PC1117, LV8PC8LR, LV8RST104090, N8PC865, NE8ISO8859P10, NEE8ISO8859P4, RU8BESTA, RU8PC855, RU8PC866, SE8ISO8859P3, TH8MACTHAIS, TH8TISASCII, TR8DEC, TR8MACTURKISHS, TR8MSWIN1254, TR8PC857, US7ASCII, US8PC437, UTF8, VN8MSWIN1258, VN8VN3, WE8DEC, WE8DG, WE8ISO8859P1, WE8ISO8859P15, WE8ISO8859P9, WE8MACROMAN8S, WE8MSWIN1252, WE8NCR4970, WE8NEXTSTEP, WE8PC850, WE8PC858, WE8PC860, WE8ROMAN8, ZHS16CGB231280, ZHS16GBK, ZHT16BIG5, ZHT16CCDC, ZHT16DBT, ZHT16HKSCS, ZHT16MSWIN950, ZHT32EUC, ZHT32SOPS, ZHT32TRIS - __ https://docs.cloud.oracle.com/autonomousDatabaseCharacterSets + __ https://docs.oracle.com/iaas/autonomous-database-serverless/doc/autonomous-character-set-selection.html :return: The character_set of this CreateAutonomousDatabaseBase. @@ -528,13 +528,13 @@ def character_set(self): def character_set(self, character_set): """ Sets the character_set of this CreateAutonomousDatabaseBase. - The character set for the autonomous database. The default is AL32UTF8. Allowed values for an Autonomous Database on shared infrastructure as as returned by `List Autonomous Database Character Sets`__ + The character set for the autonomous database. The default is AL32UTF8. Allowed values for an Autonomous Database Serverless instance as as returned by `List Autonomous Database Character Sets`__ For an Autonomous Database on dedicated infrastructure, the allowed values are: AL32UTF8, AR8ADOS710, AR8ADOS720, AR8APTEC715, AR8ARABICMACS, AR8ASMO8X, AR8ISO8859P6, AR8MSWIN1256, AR8MUSSAD768, AR8NAFITHA711, AR8NAFITHA721, AR8SAKHR706, AR8SAKHR707, AZ8ISO8859P9E, BG8MSWIN, BG8PC437S, BLT8CP921, BLT8ISO8859P13, BLT8MSWIN1257, BLT8PC775, BN8BSCII, CDN8PC863, CEL8ISO8859P14, CL8ISO8859P5, CL8ISOIR111, CL8KOI8R, CL8KOI8U, CL8MACCYRILLICS, CL8MSWIN1251, EE8ISO8859P2, EE8MACCES, EE8MACCROATIANS, EE8MSWIN1250, EE8PC852, EL8DEC, EL8ISO8859P7, EL8MACGREEKS, EL8MSWIN1253, EL8PC437S, EL8PC851, EL8PC869, ET8MSWIN923, HU8ABMOD, HU8CWI2, IN8ISCII, IS8PC861, IW8ISO8859P8, IW8MACHEBREWS, IW8MSWIN1255, IW8PC1507, JA16EUC, JA16EUCTILDE, JA16SJIS, JA16SJISTILDE, JA16VMS, KO16KSC5601, KO16KSCCS, KO16MSWIN949, LA8ISO6937, LA8PASSPORT, LT8MSWIN921, LT8PC772, LT8PC774, LV8PC1117, LV8PC8LR, LV8RST104090, N8PC865, NE8ISO8859P10, NEE8ISO8859P4, RU8BESTA, RU8PC855, RU8PC866, SE8ISO8859P3, TH8MACTHAIS, TH8TISASCII, TR8DEC, TR8MACTURKISHS, TR8MSWIN1254, TR8PC857, US7ASCII, US8PC437, UTF8, VN8MSWIN1258, VN8VN3, WE8DEC, WE8DG, WE8ISO8859P1, WE8ISO8859P15, WE8ISO8859P9, WE8MACROMAN8S, WE8MSWIN1252, WE8NCR4970, WE8NEXTSTEP, WE8PC850, WE8PC858, WE8PC860, WE8ROMAN8, ZHS16CGB231280, ZHS16GBK, ZHT16BIG5, ZHT16CCDC, ZHT16DBT, ZHT16HKSCS, ZHT16MSWIN950, ZHT32EUC, ZHT32SOPS, ZHT32TRIS - __ https://docs.cloud.oracle.com/autonomousDatabaseCharacterSets + __ https://docs.oracle.com/iaas/autonomous-database-serverless/doc/autonomous-character-set-selection.html :param character_set: The character_set of this CreateAutonomousDatabaseBase. @@ -546,10 +546,12 @@ def character_set(self, character_set): def ncharacter_set(self): """ Gets the ncharacter_set of this CreateAutonomousDatabaseBase. - The character set for the Autonomous Database. The default is AL32UTF8. Use :func:`list_autonomous_database_character_sets` to list the allowed values for an Autonomous Database on shared Exadata infrastructure. + The character set for the Autonomous Database. The default is AL32UTF8. Use `List Autonomous Database Character Sets`__ to list the allowed values for an Autonomous Database Serverless instance. For an Autonomous Database on dedicated Exadata infrastructure, the allowed values are: AL16UTF16 or UTF8. + __ https://docs.oracle.com/iaas/autonomous-database-serverless/doc/autonomous-character-set-selection.html + :return: The ncharacter_set of this CreateAutonomousDatabaseBase. :rtype: str @@ -560,10 +562,12 @@ def ncharacter_set(self): def ncharacter_set(self, ncharacter_set): """ Sets the ncharacter_set of this CreateAutonomousDatabaseBase. - The character set for the Autonomous Database. The default is AL32UTF8. Use :func:`list_autonomous_database_character_sets` to list the allowed values for an Autonomous Database on shared Exadata infrastructure. + The character set for the Autonomous Database. The default is AL32UTF8. Use `List Autonomous Database Character Sets`__ to list the allowed values for an Autonomous Database Serverless instance. For an Autonomous Database on dedicated Exadata infrastructure, the allowed values are: AL16UTF16 or UTF8. + __ https://docs.oracle.com/iaas/autonomous-database-serverless/doc/autonomous-character-set-selection.html + :param ncharacter_set: The ncharacter_set of this CreateAutonomousDatabaseBase. :type: str @@ -686,7 +690,7 @@ def compute_model(self, compute_model): def compute_count(self): """ Gets the compute_count of this CreateAutonomousDatabaseBase. - The compute amount available to the database. Minimum and maximum values depend on the compute model and whether the database is on Shared or Dedicated infrastructure. For an Autonomous Database on Shared infrastructure, the 'ECPU' compute model requires values in multiples of two. Required when using the `computeModel` parameter. When using `cpuCoreCount` parameter, it is an error to specify computeCount to a non-null value. + The compute amount available to the database. Minimum and maximum values depend on the compute model and whether the database is an Autonomous Database Serverless instance or an Autonomous Database on Dedicated Exadata Infrastructure, the 'ECPU' compute model requires values in multiples of two. Required when using the `computeModel` parameter. When using `cpuCoreCount` parameter, it is an error to specify computeCount to a non-null value. :return: The compute_count of this CreateAutonomousDatabaseBase. @@ -698,7 +702,7 @@ def compute_count(self): def compute_count(self, compute_count): """ Sets the compute_count of this CreateAutonomousDatabaseBase. - The compute amount available to the database. Minimum and maximum values depend on the compute model and whether the database is on Shared or Dedicated infrastructure. For an Autonomous Database on Shared infrastructure, the 'ECPU' compute model requires values in multiples of two. Required when using the `computeModel` parameter. When using `cpuCoreCount` parameter, it is an error to specify computeCount to a non-null value. + The compute amount available to the database. Minimum and maximum values depend on the compute model and whether the database is an Autonomous Database Serverless instance or an Autonomous Database on Dedicated Exadata Infrastructure, the 'ECPU' compute model requires values in multiples of two. Required when using the `computeModel` parameter. When using `cpuCoreCount` parameter, it is an error to specify computeCount to a non-null value. :param compute_count: The compute_count of this CreateAutonomousDatabaseBase. @@ -713,8 +717,8 @@ def ocpu_count(self): The number of OCPU cores to be made available to the database. The following points apply: - - For Autonomous Databases on Dedicated Exadata infrastructure, to provision less than 1 core, enter a fractional value in an increment of 0.1. For example, you can provision 0.3 or 0.4 cores, but not 0.35 cores. (Note that fractional OCPU values are not supported for Autonomous Databasese on shared Exadata infrastructure.) - - To provision 1 or more cores, you must enter an integer between 1 and the maximum number of cores available for the infrastructure shape. For example, you can provision 2 cores or 3 cores, but not 2.5 cores. This applies to Autonomous Databases on both shared and dedicated Exadata infrastructure. + - For Autonomous Databases on Dedicated Exadata infrastructure, to provision less than 1 core, enter a fractional value in an increment of 0.1. For example, you can provision 0.3 or 0.4 cores, but not 0.35 cores. (Note that fractional OCPU values are not supported for Autonomous Database Serverless instances.) + - To provision 1 or more cores, you must enter an integer between 1 and the maximum number of cores available for the infrastructure shape. For example, you can provision 2 cores or 3 cores, but not 2.5 cores. This applies to an Autonomous Database Serverless instance or an Autonomous Database on Dedicated Exadata Infrastructure. For Autonomous Databases on Dedicated Exadata infrastructure, the maximum number of cores is determined by the infrastructure shape. See `Characteristics of Infrastructure Shapes`__ for shape details. @@ -735,8 +739,8 @@ def ocpu_count(self, ocpu_count): The number of OCPU cores to be made available to the database. The following points apply: - - For Autonomous Databases on Dedicated Exadata infrastructure, to provision less than 1 core, enter a fractional value in an increment of 0.1. For example, you can provision 0.3 or 0.4 cores, but not 0.35 cores. (Note that fractional OCPU values are not supported for Autonomous Databasese on shared Exadata infrastructure.) - - To provision 1 or more cores, you must enter an integer between 1 and the maximum number of cores available for the infrastructure shape. For example, you can provision 2 cores or 3 cores, but not 2.5 cores. This applies to Autonomous Databases on both shared and dedicated Exadata infrastructure. + - For Autonomous Databases on Dedicated Exadata infrastructure, to provision less than 1 core, enter a fractional value in an increment of 0.1. For example, you can provision 0.3 or 0.4 cores, but not 0.35 cores. (Note that fractional OCPU values are not supported for Autonomous Database Serverless instances.) + - To provision 1 or more cores, you must enter an integer between 1 and the maximum number of cores available for the infrastructure shape. For example, you can provision 2 cores or 3 cores, but not 2.5 cores. This applies to an Autonomous Database Serverless instance or an Autonomous Database on Dedicated Exadata Infrastructure. For Autonomous Databases on Dedicated Exadata infrastructure, the maximum number of cores is determined by the infrastructure shape. See `Characteristics of Infrastructure Shapes`__ for shape details. @@ -952,7 +956,9 @@ def vault_id(self, vault_id): def admin_password(self): """ Gets the admin_password of this CreateAutonomousDatabaseBase. - **Important** The `adminPassword` must be specified for all Autonomous Databases except for refreshable clones. The password must be between 12 and 30 characters long, and must contain at least 1 uppercase, 1 lowercase, and 1 numeric character. It cannot contain the double quote symbol (\") or the username \"admin\", regardless of casing. + **Important** The `adminPassword` or `secretId` must be specified for all Autonomous Databases except for refreshable clones. The password must be between 12 and 30 characters long, and must contain at least 1 uppercase, 1 lowercase, and 1 numeric character. It cannot contain the double quote symbol (\") or the username \"admin\", regardless of casing. + + This cannot be used in conjunction with with OCI vault secrets (secretId). :return: The admin_password of this CreateAutonomousDatabaseBase. @@ -964,7 +970,9 @@ def admin_password(self): def admin_password(self, admin_password): """ Sets the admin_password of this CreateAutonomousDatabaseBase. - **Important** The `adminPassword` must be specified for all Autonomous Databases except for refreshable clones. The password must be between 12 and 30 characters long, and must contain at least 1 uppercase, 1 lowercase, and 1 numeric character. It cannot contain the double quote symbol (\") or the username \"admin\", regardless of casing. + **Important** The `adminPassword` or `secretId` must be specified for all Autonomous Databases except for refreshable clones. The password must be between 12 and 30 characters long, and must contain at least 1 uppercase, 1 lowercase, and 1 numeric character. It cannot contain the double quote symbol (\") or the username \"admin\", regardless of casing. + + This cannot be used in conjunction with with OCI vault secrets (secretId). :param admin_password: The admin_password of this CreateAutonomousDatabaseBase. @@ -1000,10 +1008,10 @@ def display_name(self, display_name): def license_model(self): """ Gets the license_model of this CreateAutonomousDatabaseBase. - The Oracle license model that applies to the Oracle Autonomous Database. Bring your own license (BYOL) allows you to apply your current on-premises Oracle software licenses to equivalent, highly automated Oracle PaaS and IaaS services in the cloud. - License Included allows you to subscribe to new Oracle Database software licenses and the Database service. - Note that when provisioning an Autonomous Database on `dedicated Exadata infrastructure`__, this attribute must be null because the attribute is already set at the - Autonomous Exadata Infrastructure level. When using `shared Exadata infrastructure`__, if a value is not specified, the system will supply the value of `BRING_YOUR_OWN_LICENSE`. + The Oracle license model that applies to the Oracle Autonomous Database. Bring your own license (BYOL) allows you to apply your current on-premises Oracle software licenses to equivalent, highly automated Oracle services in the cloud. + License Included allows you to subscribe to new Oracle Database software licenses and the Oracle Database service. + Note that when provisioning an `Autonomous Database on dedicated Exadata infrastructure`__, this attribute must be null. It is already set at the + Autonomous Exadata Infrastructure level. When provisioning an `Autonomous Database Serverless]`__ database, if a value is not specified, the system defaults the value to `BRING_YOUR_OWN_LICENSE`. This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, maxCpuCoreCount, dataStorageSizeInTBs, adminPassword, isMTLSConnectionRequired, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, dbName, scheduledOperations, dbToolsDetails, or isFreeTier. @@ -1022,10 +1030,10 @@ def license_model(self): def license_model(self, license_model): """ Sets the license_model of this CreateAutonomousDatabaseBase. - The Oracle license model that applies to the Oracle Autonomous Database. Bring your own license (BYOL) allows you to apply your current on-premises Oracle software licenses to equivalent, highly automated Oracle PaaS and IaaS services in the cloud. - License Included allows you to subscribe to new Oracle Database software licenses and the Database service. - Note that when provisioning an Autonomous Database on `dedicated Exadata infrastructure`__, this attribute must be null because the attribute is already set at the - Autonomous Exadata Infrastructure level. When using `shared Exadata infrastructure`__, if a value is not specified, the system will supply the value of `BRING_YOUR_OWN_LICENSE`. + The Oracle license model that applies to the Oracle Autonomous Database. Bring your own license (BYOL) allows you to apply your current on-premises Oracle software licenses to equivalent, highly automated Oracle services in the cloud. + License Included allows you to subscribe to new Oracle Database software licenses and the Oracle Database service. + Note that when provisioning an `Autonomous Database on dedicated Exadata infrastructure`__, this attribute must be null. It is already set at the + Autonomous Exadata Infrastructure level. When provisioning an `Autonomous Database Serverless]`__ database, if a value is not specified, the system defaults the value to `BRING_YOUR_OWN_LICENSE`. This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, maxCpuCoreCount, dataStorageSizeInTBs, adminPassword, isMTLSConnectionRequired, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, dbName, scheduledOperations, dbToolsDetails, or isFreeTier. @@ -1048,9 +1056,7 @@ def license_model(self, license_model): def is_preview_version_with_service_terms_accepted(self): """ Gets the is_preview_version_with_service_terms_accepted of this CreateAutonomousDatabaseBase. - If set to `TRUE`, indicates that an Autonomous Database preview version is being provisioned, and that the preview version's terms of service have been accepted. Note that preview version software is only available for databases on `shared Exadata infrastructure`__. - - __ https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html + If set to `TRUE`, indicates that an Autonomous Database preview version is being provisioned, and that the preview version's terms of service have been accepted. Note that preview version software is only available for Autonomous Database Serverless instances (https://docs.oracle.com/en/cloud/paas/autonomous-database/shared/index.html). :return: The is_preview_version_with_service_terms_accepted of this CreateAutonomousDatabaseBase. @@ -1062,9 +1068,7 @@ def is_preview_version_with_service_terms_accepted(self): def is_preview_version_with_service_terms_accepted(self, is_preview_version_with_service_terms_accepted): """ Sets the is_preview_version_with_service_terms_accepted of this CreateAutonomousDatabaseBase. - If set to `TRUE`, indicates that an Autonomous Database preview version is being provisioned, and that the preview version's terms of service have been accepted. Note that preview version software is only available for databases on `shared Exadata infrastructure`__. - - __ https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html + If set to `TRUE`, indicates that an Autonomous Database preview version is being provisioned, and that the preview version's terms of service have been accepted. Note that preview version software is only available for Autonomous Database Serverless instances (https://docs.oracle.com/en/cloud/paas/autonomous-database/shared/index.html). :param is_preview_version_with_service_terms_accepted: The is_preview_version_with_service_terms_accepted of this CreateAutonomousDatabaseBase. @@ -1216,13 +1220,13 @@ def is_access_control_enabled(self, is_access_control_enabled): def whitelisted_ips(self): """ Gets the whitelisted_ips of this CreateAutonomousDatabaseBase. - The client IP access control list (ACL). This feature is available for autonomous databases on `shared Exadata infrastructure`__ and on Exadata Cloud@Customer. + The client IP access control list (ACL). This feature is available for `Autonomous Database Serverless]`__ and on Exadata Cloud@Customer. Only clients connecting from an IP address included in the ACL may access the Autonomous Database instance. - For shared Exadata infrastructure, this is an array of CIDR (Classless Inter-Domain Routing) notations for a subnet or VCN OCID. + For Autonomous Database Serverless, this is an array of CIDR (classless inter-domain routing) notations for a subnet or VCN OCID (virtual cloud network Oracle Cloud ID). Use a semicolon (;) as a deliminator between the VCN-specific subnets or IPs. Example: `[\"1.1.1.1\",\"1.1.1.0/24\",\"ocid1.vcn.oc1.sea.\",\"ocid1.vcn.oc1.sea.;1.1.1.1\",\"ocid1.vcn.oc1.sea.;1.1.0.0/16\"]` - For Exadata Cloud@Customer, this is an array of IP addresses or CIDR (Classless Inter-Domain Routing) notations. + For Exadata Cloud@Customer, this is an array of IP addresses or CIDR notations. Example: `[\"1.1.1.1\",\"1.1.1.0/24\",\"1.1.2.25\"]` For an update operation, if you want to delete all the IPs in the ACL, use an array with a single empty string entry. @@ -1241,13 +1245,13 @@ def whitelisted_ips(self): def whitelisted_ips(self, whitelisted_ips): """ Sets the whitelisted_ips of this CreateAutonomousDatabaseBase. - The client IP access control list (ACL). This feature is available for autonomous databases on `shared Exadata infrastructure`__ and on Exadata Cloud@Customer. + The client IP access control list (ACL). This feature is available for `Autonomous Database Serverless]`__ and on Exadata Cloud@Customer. Only clients connecting from an IP address included in the ACL may access the Autonomous Database instance. - For shared Exadata infrastructure, this is an array of CIDR (Classless Inter-Domain Routing) notations for a subnet or VCN OCID. + For Autonomous Database Serverless, this is an array of CIDR (classless inter-domain routing) notations for a subnet or VCN OCID (virtual cloud network Oracle Cloud ID). Use a semicolon (;) as a deliminator between the VCN-specific subnets or IPs. Example: `[\"1.1.1.1\",\"1.1.1.0/24\",\"ocid1.vcn.oc1.sea.\",\"ocid1.vcn.oc1.sea.;1.1.1.1\",\"ocid1.vcn.oc1.sea.;1.1.0.0/16\"]` - For Exadata Cloud@Customer, this is an array of IP addresses or CIDR (Classless Inter-Domain Routing) notations. + For Exadata Cloud@Customer, this is an array of IP addresses or CIDR notations. Example: `[\"1.1.1.1\",\"1.1.1.0/24\",\"1.1.2.25\"]` For an update operation, if you want to delete all the IPs in the ACL, use an array with a single empty string entry. @@ -1294,13 +1298,13 @@ def are_primary_whitelisted_ips_used(self, are_primary_whitelisted_ips_used): def standby_whitelisted_ips(self): """ Gets the standby_whitelisted_ips of this CreateAutonomousDatabaseBase. - The client IP access control list (ACL). This feature is available for autonomous databases on `shared Exadata infrastructure`__ and on Exadata Cloud@Customer. + The client IP access control list (ACL). This feature is available for `Autonomous Database Serverless]`__ and on Exadata Cloud@Customer. Only clients connecting from an IP address included in the ACL may access the Autonomous Database instance. - For shared Exadata infrastructure, this is an array of CIDR (Classless Inter-Domain Routing) notations for a subnet or VCN OCID. + For Autonomous Database Serverless, this is an array of CIDR (classless inter-domain routing) notations for a subnet or VCN OCID (virtual cloud network Oracle Cloud ID). Use a semicolon (;) as a deliminator between the VCN-specific subnets or IPs. Example: `[\"1.1.1.1\",\"1.1.1.0/24\",\"ocid1.vcn.oc1.sea.\",\"ocid1.vcn.oc1.sea.;1.1.1.1\",\"ocid1.vcn.oc1.sea.;1.1.0.0/16\"]` - For Exadata Cloud@Customer, this is an array of IP addresses or CIDR (Classless Inter-Domain Routing) notations. + For Exadata Cloud@Customer, this is an array of IP addresses or CIDR notations. Example: `[\"1.1.1.1\",\"1.1.1.0/24\",\"1.1.2.25\"]` For an update operation, if you want to delete all the IPs in the ACL, use an array with a single empty string entry. @@ -1319,13 +1323,13 @@ def standby_whitelisted_ips(self): def standby_whitelisted_ips(self, standby_whitelisted_ips): """ Sets the standby_whitelisted_ips of this CreateAutonomousDatabaseBase. - The client IP access control list (ACL). This feature is available for autonomous databases on `shared Exadata infrastructure`__ and on Exadata Cloud@Customer. + The client IP access control list (ACL). This feature is available for `Autonomous Database Serverless]`__ and on Exadata Cloud@Customer. Only clients connecting from an IP address included in the ACL may access the Autonomous Database instance. - For shared Exadata infrastructure, this is an array of CIDR (Classless Inter-Domain Routing) notations for a subnet or VCN OCID. + For Autonomous Database Serverless, this is an array of CIDR (classless inter-domain routing) notations for a subnet or VCN OCID (virtual cloud network Oracle Cloud ID). Use a semicolon (;) as a deliminator between the VCN-specific subnets or IPs. Example: `[\"1.1.1.1\",\"1.1.1.0/24\",\"ocid1.vcn.oc1.sea.\",\"ocid1.vcn.oc1.sea.;1.1.1.1\",\"ocid1.vcn.oc1.sea.;1.1.0.0/16\"]` - For Exadata Cloud@Customer, this is an array of IP addresses or CIDR (Classless Inter-Domain Routing) notations. + For Exadata Cloud@Customer, this is an array of IP addresses or CIDR notations. Example: `[\"1.1.1.1\",\"1.1.1.0/24\",\"1.1.2.25\"]` For an update operation, if you want to delete all the IPs in the ACL, use an array with a single empty string entry. @@ -1614,9 +1618,9 @@ def source(self): Gets the source of this CreateAutonomousDatabaseBase. The source of the database: Use `NONE` for creating a new Autonomous Database. Use `DATABASE` for creating a new Autonomous Database by cloning an existing Autonomous Database. Use `CROSS_REGION_DATAGUARD` to create a standby Data Guard database in another region. - For Autonomous Databases on `shared Exadata infrastructure`__, the following cloning options are available: Use `BACKUP_FROM_ID` for creating a new Autonomous Database from a specified backup. Use `BACKUP_FROM_TIMESTAMP` for creating a point-in-time Autonomous Database clone using backups. For more information, see `Cloning and Moving an Autonomous Database`__. + For `Autonomous Database Serverless instances`__, the following cloning options are available: Use `BACKUP_FROM_ID` for creating a new Autonomous Database from a specified backup. Use `BACKUP_FROM_TIMESTAMP` for creating a point-in-time Autonomous Database clone using backups. For more information, see `Cloning and Moving an Autonomous Database`__. - __ https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html + __ https://docs.oracle.com/en/cloud/paas/autonomous-database/shared/index.html __ https://docs.oracle.com/en/cloud/paas/autonomous-database/adbsa/clone-autonomous-database.html#GUID-D771796F-5081-4CFB-A7FF-0F893EABD7BC Allowed values for this property are: "NONE", "DATABASE", "BACKUP_FROM_ID", "BACKUP_FROM_TIMESTAMP", "CLONE_TO_REFRESHABLE", "CROSS_REGION_DATAGUARD", "CROSS_REGION_DISASTER_RECOVERY" @@ -1633,9 +1637,9 @@ def source(self, source): Sets the source of this CreateAutonomousDatabaseBase. The source of the database: Use `NONE` for creating a new Autonomous Database. Use `DATABASE` for creating a new Autonomous Database by cloning an existing Autonomous Database. Use `CROSS_REGION_DATAGUARD` to create a standby Data Guard database in another region. - For Autonomous Databases on `shared Exadata infrastructure`__, the following cloning options are available: Use `BACKUP_FROM_ID` for creating a new Autonomous Database from a specified backup. Use `BACKUP_FROM_TIMESTAMP` for creating a point-in-time Autonomous Database clone using backups. For more information, see `Cloning and Moving an Autonomous Database`__. + For `Autonomous Database Serverless instances`__, the following cloning options are available: Use `BACKUP_FROM_ID` for creating a new Autonomous Database from a specified backup. Use `BACKUP_FROM_TIMESTAMP` for creating a point-in-time Autonomous Database clone using backups. For more information, see `Cloning and Moving an Autonomous Database`__. - __ https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html + __ https://docs.oracle.com/en/cloud/paas/autonomous-database/shared/index.html __ https://docs.oracle.com/en/cloud/paas/autonomous-database/adbsa/clone-autonomous-database.html#GUID-D771796F-5081-4CFB-A7FF-0F893EABD7BC @@ -1686,7 +1690,7 @@ def is_mtls_connection_required(self): - CreateAutonomousDatabase - GetAutonomousDatabase - UpdateAutonomousDatabase - Details: Prior to the July 1, 2023 change, the isMTLSConnectionRequired attribute default value was true. This applies to Autonomous Databases on shared Exadata infrastructure. + Details: Prior to the July 1, 2023 change, the isMTLSConnectionRequired attribute default value was true. This applies to Autonomous Database Serverless. Does this impact me? If you use or maintain custom scripts or Terraform scripts referencing the CreateAutonomousDatabase, GetAutonomousDatabase, or UpdateAutonomousDatabase APIs, you want to check, and possibly modify, the scripts for the changed default value of the attribute. Should you choose not to leave your scripts unchanged, the API calls containing this attribute will continue to work, but the default value will switch from true to false. How do I make this change? Using either OCI SDKs or command line tools, update your custom scripts to explicitly set the isMTLSConnectionRequired attribute to true. @@ -1708,7 +1712,7 @@ def is_mtls_connection_required(self, is_mtls_connection_required): - CreateAutonomousDatabase - GetAutonomousDatabase - UpdateAutonomousDatabase - Details: Prior to the July 1, 2023 change, the isMTLSConnectionRequired attribute default value was true. This applies to Autonomous Databases on shared Exadata infrastructure. + Details: Prior to the July 1, 2023 change, the isMTLSConnectionRequired attribute default value was true. This applies to Autonomous Database Serverless. Does this impact me? If you use or maintain custom scripts or Terraform scripts referencing the CreateAutonomousDatabase, GetAutonomousDatabase, or UpdateAutonomousDatabase APIs, you want to check, and possibly modify, the scripts for the changed default value of the attribute. Should you choose not to leave your scripts unchanged, the API calls containing this attribute will continue to work, but the default value will switch from true to false. How do I make this change? Using either OCI SDKs or command line tools, update your custom scripts to explicitly set the isMTLSConnectionRequired attribute to true. @@ -1722,8 +1726,8 @@ def is_mtls_connection_required(self, is_mtls_connection_required): def autonomous_maintenance_schedule_type(self): """ Gets the autonomous_maintenance_schedule_type of this CreateAutonomousDatabaseBase. - The maintenance schedule type of the Autonomous Database on shared Exadata infrastructure. The EARLY maintenance schedule of this Autonomous Database - follows a schedule that applies patches prior to the REGULAR schedule.The REGULAR maintenance schedule of this Autonomous Database follows the normal cycle. + The maintenance schedule type of the Autonomous Database Serverless. An EARLY maintenance schedule + follows a schedule applying patches prior to the REGULAR schedule. A REGULAR maintenance schedule follows the normal cycle Allowed values for this property are: "EARLY", "REGULAR" @@ -1737,8 +1741,8 @@ def autonomous_maintenance_schedule_type(self): def autonomous_maintenance_schedule_type(self, autonomous_maintenance_schedule_type): """ Sets the autonomous_maintenance_schedule_type of this CreateAutonomousDatabaseBase. - The maintenance schedule type of the Autonomous Database on shared Exadata infrastructure. The EARLY maintenance schedule of this Autonomous Database - follows a schedule that applies patches prior to the REGULAR schedule.The REGULAR maintenance schedule of this Autonomous Database follows the normal cycle. + The maintenance schedule type of the Autonomous Database Serverless. An EARLY maintenance schedule + follows a schedule applying patches prior to the REGULAR schedule. A REGULAR maintenance schedule follows the normal cycle :param autonomous_maintenance_schedule_type: The autonomous_maintenance_schedule_type of this CreateAutonomousDatabaseBase. @@ -1886,6 +1890,8 @@ def secret_id(self): Gets the secret_id of this CreateAutonomousDatabaseBase. The OCI vault secret [/Content/General/Concepts/identifiers.htm]OCID. + This cannot be used in conjunction with adminPassword. + :return: The secret_id of this CreateAutonomousDatabaseBase. :rtype: str @@ -1898,6 +1904,8 @@ def secret_id(self, secret_id): Sets the secret_id of this CreateAutonomousDatabaseBase. The OCI vault secret [/Content/General/Concepts/identifiers.htm]OCID. + This cannot be used in conjunction with adminPassword. + :param secret_id: The secret_id of this CreateAutonomousDatabaseBase. :type: str diff --git a/src/oci/database/models/create_cloud_autonomous_vm_cluster_details.py b/src/oci/database/models/create_cloud_autonomous_vm_cluster_details.py index 081440a346..0ccb1f40a7 100644 --- a/src/oci/database/models/create_cloud_autonomous_vm_cluster_details.py +++ b/src/oci/database/models/create_cloud_autonomous_vm_cluster_details.py @@ -594,10 +594,10 @@ def scan_listener_port_non_tls(self, scan_listener_port_non_tls): def license_model(self): """ Gets the license_model of this CreateCloudAutonomousVmClusterDetails. - The Oracle license model that applies to the Oracle Autonomous Database. Bring your own license (BYOL) allows you to apply your current on-premises Oracle software licenses to equivalent, highly automated Oracle PaaS and IaaS services in the cloud. - License Included allows you to subscribe to new Oracle Database software licenses and the Database service. - Note that when provisioning an Autonomous Database on `dedicated Exadata infrastructure`__, this attribute must be null because the attribute is already set at the - Autonomous Exadata Infrastructure level. When using `shared Exadata infrastructure`__, if a value is not specified, the system will supply the value of `BRING_YOUR_OWN_LICENSE`. + The Oracle license model that applies to the Oracle Autonomous Database. Bring your own license (BYOL) allows you to apply your current on-premises Oracle software licenses to equivalent, highly automated Oracle services in the cloud. + License Included allows you to subscribe to new Oracle Database software licenses and the Oracle Database service. + Note that when provisioning an `Autonomous Database on dedicated Exadata infrastructure`__, this attribute must be null. It is already set at the + Autonomous Exadata Infrastructure level. When provisioning an `Autonomous Database Serverless]`__ database, if a value is not specified, the system defaults the value to `BRING_YOUR_OWN_LICENSE`. This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, maxCpuCoreCount, dataStorageSizeInTBs, adminPassword, isMTLSConnectionRequired, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, dbName, scheduledOperations, dbToolsDetails, or isFreeTier. @@ -616,10 +616,10 @@ def license_model(self): def license_model(self, license_model): """ Sets the license_model of this CreateCloudAutonomousVmClusterDetails. - The Oracle license model that applies to the Oracle Autonomous Database. Bring your own license (BYOL) allows you to apply your current on-premises Oracle software licenses to equivalent, highly automated Oracle PaaS and IaaS services in the cloud. - License Included allows you to subscribe to new Oracle Database software licenses and the Database service. - Note that when provisioning an Autonomous Database on `dedicated Exadata infrastructure`__, this attribute must be null because the attribute is already set at the - Autonomous Exadata Infrastructure level. When using `shared Exadata infrastructure`__, if a value is not specified, the system will supply the value of `BRING_YOUR_OWN_LICENSE`. + The Oracle license model that applies to the Oracle Autonomous Database. Bring your own license (BYOL) allows you to apply your current on-premises Oracle software licenses to equivalent, highly automated Oracle services in the cloud. + License Included allows you to subscribe to new Oracle Database software licenses and the Oracle Database service. + Note that when provisioning an `Autonomous Database on dedicated Exadata infrastructure`__, this attribute must be null. It is already set at the + Autonomous Exadata Infrastructure level. When provisioning an `Autonomous Database Serverless]`__ database, if a value is not specified, the system defaults the value to `BRING_YOUR_OWN_LICENSE`. This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, maxCpuCoreCount, dataStorageSizeInTBs, adminPassword, isMTLSConnectionRequired, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, dbName, scheduledOperations, dbToolsDetails, or isFreeTier. diff --git a/src/oci/database/models/create_cross_region_disaster_recovery_details.py b/src/oci/database/models/create_cross_region_disaster_recovery_details.py index 797df95d0e..fd60320d8b 100644 --- a/src/oci/database/models/create_cross_region_disaster_recovery_details.py +++ b/src/oci/database/models/create_cross_region_disaster_recovery_details.py @@ -450,7 +450,7 @@ def source_id(self, source_id): def remote_disaster_recovery_type(self): """ **[Required]** Gets the remote_disaster_recovery_type of this CreateCrossRegionDisasterRecoveryDetails. - Indicates the cross-region disaster recovery (DR) type of the standby Shared Autonomous Database. + Indicates the cross-region disaster recovery (DR) type of the standby Autonomous Database Serverless instance. Autonomous Data Guard (ADG) DR type provides business critical DR with a faster recovery time objective (RTO) during failover or switchover. Backup-based DR type provides lower cost DR with a slower RTO during failover or switchover. @@ -464,7 +464,7 @@ def remote_disaster_recovery_type(self): def remote_disaster_recovery_type(self, remote_disaster_recovery_type): """ Sets the remote_disaster_recovery_type of this CreateCrossRegionDisasterRecoveryDetails. - Indicates the cross-region disaster recovery (DR) type of the standby Shared Autonomous Database. + Indicates the cross-region disaster recovery (DR) type of the standby Autonomous Database Serverless instance. Autonomous Data Guard (ADG) DR type provides business critical DR with a faster recovery time objective (RTO) during failover or switchover. Backup-based DR type provides lower cost DR with a slower RTO during failover or switchover. diff --git a/src/oci/database/models/database_connection_string_profile.py b/src/oci/database/models/database_connection_string_profile.py index 6b64aa88a8..13634415ab 100644 --- a/src/oci/database/models/database_connection_string_profile.py +++ b/src/oci/database/models/database_connection_string_profile.py @@ -363,7 +363,7 @@ def syntax_format(self): """ **[Required]** Gets the syntax_format of this DatabaseConnectionStringProfile. Specifies whether the connection string is using the long (`LONG`), Easy Connect (`EZCONNECT`), or Easy Connect Plus (`EZCONNECTPLUS`) format. - Autonomous Databases on shared Exadata infrastructure always use the long format. + Autonomous Database Serverless instances always use the long format. Allowed values for this property are: "LONG", "EZCONNECT", "EZCONNECTPLUS", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -379,7 +379,7 @@ def syntax_format(self, syntax_format): """ Sets the syntax_format of this DatabaseConnectionStringProfile. Specifies whether the connection string is using the long (`LONG`), Easy Connect (`EZCONNECT`), or Easy Connect Plus (`EZCONNECTPLUS`) format. - Autonomous Databases on shared Exadata infrastructure always use the long format. + Autonomous Database Serverless instances always use the long format. :param syntax_format: The syntax_format of this DatabaseConnectionStringProfile. diff --git a/src/oci/database/models/disaster_recovery_configuration.py b/src/oci/database/models/disaster_recovery_configuration.py index 7a9c0a7c19..4a5c3d4bd0 100644 --- a/src/oci/database/models/disaster_recovery_configuration.py +++ b/src/oci/database/models/disaster_recovery_configuration.py @@ -63,7 +63,7 @@ def __init__(self, **kwargs): def disaster_recovery_type(self): """ Gets the disaster_recovery_type of this DisasterRecoveryConfiguration. - Indicates the disaster recovery (DR) type of the Shared Autonomous Database. + Indicates the disaster recovery (DR) type of the Autonomous Database Serverless instance. Autonomous Data Guard (ADG) DR type provides business critical DR with a faster recovery time objective (RTO) during failover or switchover. Backup-based DR type provides lower cost DR with a slower RTO during failover or switchover. @@ -80,7 +80,7 @@ def disaster_recovery_type(self): def disaster_recovery_type(self, disaster_recovery_type): """ Sets the disaster_recovery_type of this DisasterRecoveryConfiguration. - Indicates the disaster recovery (DR) type of the Shared Autonomous Database. + Indicates the disaster recovery (DR) type of the Autonomous Database Serverless instance. Autonomous Data Guard (ADG) DR type provides business critical DR with a faster recovery time objective (RTO) during failover or switchover. Backup-based DR type provides lower cost DR with a slower RTO during failover or switchover. diff --git a/src/oci/database/models/generate_autonomous_database_wallet_details.py b/src/oci/database/models/generate_autonomous_database_wallet_details.py index 60fad165c0..859a9499b0 100644 --- a/src/oci/database/models/generate_autonomous_database_wallet_details.py +++ b/src/oci/database/models/generate_autonomous_database_wallet_details.py @@ -57,7 +57,7 @@ def generate_type(self): Gets the generate_type of this GenerateAutonomousDatabaseWalletDetails. The type of wallet to generate. - **Shared Exadata infrastructure usage:** + **Serverless instance usage:** * `SINGLE` - used to generate a wallet for a single database * `ALL` - used to generate wallet for all databases in the region @@ -77,7 +77,7 @@ def generate_type(self, generate_type): Sets the generate_type of this GenerateAutonomousDatabaseWalletDetails. The type of wallet to generate. - **Shared Exadata infrastructure usage:** + **Serverless instance usage:** * `SINGLE` - used to generate a wallet for a single database * `ALL` - used to generate wallet for all databases in the region diff --git a/src/oci/database/models/maintenance_run.py b/src/oci/database/models/maintenance_run.py index dd90f38b64..824c44149a 100644 --- a/src/oci/database/models/maintenance_run.py +++ b/src/oci/database/models/maintenance_run.py @@ -460,7 +460,7 @@ def description(self, description): def lifecycle_state(self): """ **[Required]** Gets the lifecycle_state of this MaintenanceRun. - The current state of the maintenance run. For Autonomous Database on shared Exadata infrastructure, valid states are IN_PROGRESS, SUCCEEDED and FAILED. + The current state of the maintenance run. For Autonomous Database Serverless instances, valid states are IN_PROGRESS, SUCCEEDED, and FAILED. Allowed values for this property are: "SCHEDULED", "IN_PROGRESS", "SUCCEEDED", "SKIPPED", "FAILED", "UPDATING", "DELETING", "DELETED", "CANCELED", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -475,7 +475,7 @@ def lifecycle_state(self): def lifecycle_state(self, lifecycle_state): """ Sets the lifecycle_state of this MaintenanceRun. - The current state of the maintenance run. For Autonomous Database on shared Exadata infrastructure, valid states are IN_PROGRESS, SUCCEEDED and FAILED. + The current state of the maintenance run. For Autonomous Database Serverless instances, valid states are IN_PROGRESS, SUCCEEDED, and FAILED. :param lifecycle_state: The lifecycle_state of this MaintenanceRun. diff --git a/src/oci/database/models/maintenance_run_summary.py b/src/oci/database/models/maintenance_run_summary.py index ea1dc8fc43..69572ec0ca 100644 --- a/src/oci/database/models/maintenance_run_summary.py +++ b/src/oci/database/models/maintenance_run_summary.py @@ -460,7 +460,7 @@ def description(self, description): def lifecycle_state(self): """ **[Required]** Gets the lifecycle_state of this MaintenanceRunSummary. - The current state of the maintenance run. For Autonomous Database on shared Exadata infrastructure, valid states are IN_PROGRESS, SUCCEEDED and FAILED. + The current state of the maintenance run. For Autonomous Database Serverless instances, valid states are IN_PROGRESS, SUCCEEDED, and FAILED. Allowed values for this property are: "SCHEDULED", "IN_PROGRESS", "SUCCEEDED", "SKIPPED", "FAILED", "UPDATING", "DELETING", "DELETED", "CANCELED", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -475,7 +475,7 @@ def lifecycle_state(self): def lifecycle_state(self, lifecycle_state): """ Sets the lifecycle_state of this MaintenanceRunSummary. - The current state of the maintenance run. For Autonomous Database on shared Exadata infrastructure, valid states are IN_PROGRESS, SUCCEEDED and FAILED. + The current state of the maintenance run. For Autonomous Database Serverless instances, valid states are IN_PROGRESS, SUCCEEDED, and FAILED. :param lifecycle_state: The lifecycle_state of this MaintenanceRunSummary. diff --git a/src/oci/database/models/update.py b/src/oci/database/models/update.py index 1c9d1bc2e6..8a8c6d9260 100644 --- a/src/oci/database/models/update.py +++ b/src/oci/database/models/update.py @@ -215,7 +215,7 @@ def description(self, description): def last_action(self): """ Gets the last_action of this Update. - The update action. + The previous update action performed. Allowed values for this property are: "ROLLING_APPLY", "NON_ROLLING_APPLY", "PRECHECK", "ROLLBACK", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -230,7 +230,7 @@ def last_action(self): def last_action(self, last_action): """ Sets the last_action of this Update. - The update action. + The previous update action performed. :param last_action: The last_action of this Update. diff --git a/src/oci/database/models/update_autonomous_database_details.py b/src/oci/database/models/update_autonomous_database_details.py index 9376c11212..97e5d23ac5 100644 --- a/src/oci/database/models/update_autonomous_database_details.py +++ b/src/oci/database/models/update_autonomous_database_details.py @@ -570,7 +570,7 @@ def long_term_backup_schedule(self, long_term_backup_schedule): def compute_count(self): """ Gets the compute_count of this UpdateAutonomousDatabaseDetails. - The compute amount available to the database. Minimum and maximum values depend on the compute model and whether the database is on Shared or Dedicated Exadata Infrastructure. For an Autonomous Database on Shared Exadata Infrastructure, the ECPU compute model requires values in multiples of two. Required when using the computeModel parameter. When using the cpuCoreCount parameter, computeCount must be null. + The compute amount available to the database. Minimum and maximum values depend on the compute model and whether the database is an Autonomous Database Serverless instance or an Autonomous Database on Dedicated Exadata Infrastructure. For an Autonomous Database Serverless instance, the ECPU compute model requires values in multiples of two. Required when using the computeModel parameter. When using the cpuCoreCount parameter, computeCount must be null. This cannot be updated in parallel with any of the following: licenseModel, databaseEdition, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, or isFreeTier. @@ -584,7 +584,7 @@ def compute_count(self): def compute_count(self, compute_count): """ Sets the compute_count of this UpdateAutonomousDatabaseDetails. - The compute amount available to the database. Minimum and maximum values depend on the compute model and whether the database is on Shared or Dedicated Exadata Infrastructure. For an Autonomous Database on Shared Exadata Infrastructure, the ECPU compute model requires values in multiples of two. Required when using the computeModel parameter. When using the cpuCoreCount parameter, computeCount must be null. + The compute amount available to the database. Minimum and maximum values depend on the compute model and whether the database is an Autonomous Database Serverless instance or an Autonomous Database on Dedicated Exadata Infrastructure. For an Autonomous Database Serverless instance, the ECPU compute model requires values in multiples of two. Required when using the computeModel parameter. When using the cpuCoreCount parameter, computeCount must be null. This cannot be updated in parallel with any of the following: licenseModel, databaseEdition, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, or isFreeTier. @@ -600,13 +600,13 @@ def ocpu_count(self): Gets the ocpu_count of this UpdateAutonomousDatabaseDetails. The number of OCPU cores to be made available to the Autonomous Database. - For databases on dedicated Exadata infrastructure, you can specify a fractional value for this parameter. Fractional values are not supported for Autonomous Database on shared Exadata infrastructure. + For Autonomous Databases on Dedicated Exadata Infrastructure, you can specify a fractional value for this parameter. Fractional values are not supported for Autonomous Database Serverless instances. To provision less than 1 core, enter a fractional value in an increment of 0.1. To provision 1 or more cores, you must enter an integer between 1 and the maximum number of cores available to the infrastructure shape. For example, you can provision 0.3 or 0.4 cores, but not 0.35 cores. Likewise, you can provision 2 cores or 3 cores, but not 2.5 cores. The maximum number of cores is determined by the infrastructure shape. See `Characteristics of Infrastructure Shapes`__ for shape details. **Note:** This parameter cannot be used with the `cpuCoreCount` parameter. - __ https://www.oracle.com/pls/topic/lookup?ctx=en/cloud/paas/autonomous-database&id=ATPFG-GUID-B0F033C1-CC5A-42F0-B2E7-3CECFEDA1FD1 + __ https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbde/index.html :return: The ocpu_count of this UpdateAutonomousDatabaseDetails. @@ -620,13 +620,13 @@ def ocpu_count(self, ocpu_count): Sets the ocpu_count of this UpdateAutonomousDatabaseDetails. The number of OCPU cores to be made available to the Autonomous Database. - For databases on dedicated Exadata infrastructure, you can specify a fractional value for this parameter. Fractional values are not supported for Autonomous Database on shared Exadata infrastructure. + For Autonomous Databases on Dedicated Exadata Infrastructure, you can specify a fractional value for this parameter. Fractional values are not supported for Autonomous Database Serverless instances. To provision less than 1 core, enter a fractional value in an increment of 0.1. To provision 1 or more cores, you must enter an integer between 1 and the maximum number of cores available to the infrastructure shape. For example, you can provision 0.3 or 0.4 cores, but not 0.35 cores. Likewise, you can provision 2 cores or 3 cores, but not 2.5 cores. The maximum number of cores is determined by the infrastructure shape. See `Characteristics of Infrastructure Shapes`__ for shape details. **Note:** This parameter cannot be used with the `cpuCoreCount` parameter. - __ https://www.oracle.com/pls/topic/lookup?ctx=en/cloud/paas/autonomous-database&id=ATPFG-GUID-B0F033C1-CC5A-42F0-B2E7-3CECFEDA1FD1 + __ https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbde/index.html :param ocpu_count: The ocpu_count of this UpdateAutonomousDatabaseDetails. @@ -766,6 +766,8 @@ def admin_password(self): Gets the admin_password of this UpdateAutonomousDatabaseDetails. The password must be between 12 and 30 characters long, and must contain at least 1 uppercase, 1 lowercase, and 1 numeric character. It cannot contain the double quote symbol (\") or the username \"admin\", regardless of casing. It must be different from the last four passwords and it must not be a password used within the last 24 hours. + This cannot be used in conjunction with with OCI vault secrets (secretId). + This cannot be updated in parallel with any of the following: licenseModel, dbEdition, whitelistedIps, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, or isFreeTier. @@ -780,6 +782,8 @@ def admin_password(self, admin_password): Sets the admin_password of this UpdateAutonomousDatabaseDetails. The password must be between 12 and 30 characters long, and must contain at least 1 uppercase, 1 lowercase, and 1 numeric character. It cannot contain the double quote symbol (\") or the username \"admin\", regardless of casing. It must be different from the last four passwords and it must not be a password used within the last 24 hours. + This cannot be used in conjunction with with OCI vault secrets (secretId). + This cannot be updated in parallel with any of the following: licenseModel, dbEdition, whitelistedIps, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, or isFreeTier. @@ -793,8 +797,8 @@ def db_name(self): """ Gets the db_name of this UpdateAutonomousDatabaseDetails. New name for this Autonomous Database. - For databases using dedicated Exadata infrastructure, the name must begin with an alphabetic character, and can contain a maximum of eight alphanumeric characters. Special characters are not permitted. - For databases using shared Exadata infrastructure, the name must begin with an alphabetic character, and can contain a maximum of 14 alphanumeric characters. Special characters are not permitted. The database name must be unique in the tenancy. + For Autonomous Databases on Dedicated Exadata Infrastructure, the name must begin with an alphabetic character, and can contain a maximum of eight alphanumeric characters. Special characters are not permitted. + For Autonomous Database Serverless instances, the name must begin with an alphabetic character, and can contain a maximum of 14 alphanumeric characters. Special characters are not permitted. The database name must be unique in the tenancy. This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails. @@ -809,8 +813,8 @@ def db_name(self, db_name): """ Sets the db_name of this UpdateAutonomousDatabaseDetails. New name for this Autonomous Database. - For databases using dedicated Exadata infrastructure, the name must begin with an alphabetic character, and can contain a maximum of eight alphanumeric characters. Special characters are not permitted. - For databases using shared Exadata infrastructure, the name must begin with an alphabetic character, and can contain a maximum of 14 alphanumeric characters. Special characters are not permitted. The database name must be unique in the tenancy. + For Autonomous Databases on Dedicated Exadata Infrastructure, the name must begin with an alphabetic character, and can contain a maximum of eight alphanumeric characters. Special characters are not permitted. + For Autonomous Database Serverless instances, the name must begin with an alphabetic character, and can contain a maximum of 14 alphanumeric characters. Special characters are not permitted. The database name must be unique in the tenancy. This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails. @@ -934,10 +938,10 @@ def db_workload(self, db_workload): def license_model(self): """ Gets the license_model of this UpdateAutonomousDatabaseDetails. - The Oracle license model that applies to the Oracle Autonomous Database. Bring your own license (BYOL) allows you to apply your current on-premises Oracle software licenses to equivalent, highly automated Oracle PaaS and IaaS services in the cloud. - License Included allows you to subscribe to new Oracle Database software licenses and the Database service. - Note that when provisioning an Autonomous Database on `dedicated Exadata infrastructure`__, this attribute must be null because the attribute is already set at the - Autonomous Exadata Infrastructure level. When using `shared Exadata infrastructure`__, if a value is not specified, the system will supply the value of `BRING_YOUR_OWN_LICENSE`. + The Oracle license model that applies to the Oracle Autonomous Database. Bring your own license (BYOL) allows you to apply your current on-premises Oracle software licenses to equivalent, highly automated Oracle services in the cloud. + License Included allows you to subscribe to new Oracle Database software licenses and the Oracle Database service. + Note that when provisioning an `Autonomous Database on dedicated Exadata infrastructure`__, this attribute must be null. It is already set at the + Autonomous Exadata Infrastructure level. When provisioning an `Autonomous Database Serverless]`__ database, if a value is not specified, the system defaults the value to `BRING_YOUR_OWN_LICENSE`. This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, maxCpuCoreCount, dataStorageSizeInTBs, adminPassword, isMTLSConnectionRequired, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, dbName, scheduledOperations, dbToolsDetails, or isFreeTier. @@ -956,10 +960,10 @@ def license_model(self): def license_model(self, license_model): """ Sets the license_model of this UpdateAutonomousDatabaseDetails. - The Oracle license model that applies to the Oracle Autonomous Database. Bring your own license (BYOL) allows you to apply your current on-premises Oracle software licenses to equivalent, highly automated Oracle PaaS and IaaS services in the cloud. - License Included allows you to subscribe to new Oracle Database software licenses and the Database service. - Note that when provisioning an Autonomous Database on `dedicated Exadata infrastructure`__, this attribute must be null because the attribute is already set at the - Autonomous Exadata Infrastructure level. When using `shared Exadata infrastructure`__, if a value is not specified, the system will supply the value of `BRING_YOUR_OWN_LICENSE`. + The Oracle license model that applies to the Oracle Autonomous Database. Bring your own license (BYOL) allows you to apply your current on-premises Oracle software licenses to equivalent, highly automated Oracle services in the cloud. + License Included allows you to subscribe to new Oracle Database software licenses and the Oracle Database service. + Note that when provisioning an `Autonomous Database on dedicated Exadata infrastructure`__, this attribute must be null. It is already set at the + Autonomous Exadata Infrastructure level. When provisioning an `Autonomous Database Serverless]`__ database, if a value is not specified, the system defaults the value to `BRING_YOUR_OWN_LICENSE`. This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, maxCpuCoreCount, dataStorageSizeInTBs, adminPassword, isMTLSConnectionRequired, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, dbName, scheduledOperations, dbToolsDetails, or isFreeTier. @@ -1018,13 +1022,13 @@ def is_access_control_enabled(self, is_access_control_enabled): def whitelisted_ips(self): """ Gets the whitelisted_ips of this UpdateAutonomousDatabaseDetails. - The client IP access control list (ACL). This feature is available for autonomous databases on `shared Exadata infrastructure`__ and on Exadata Cloud@Customer. + The client IP access control list (ACL). This feature is available for `Autonomous Database Serverless]`__ and on Exadata Cloud@Customer. Only clients connecting from an IP address included in the ACL may access the Autonomous Database instance. - For shared Exadata infrastructure, this is an array of CIDR (Classless Inter-Domain Routing) notations for a subnet or VCN OCID. + For Autonomous Database Serverless, this is an array of CIDR (classless inter-domain routing) notations for a subnet or VCN OCID (virtual cloud network Oracle Cloud ID). Use a semicolon (;) as a deliminator between the VCN-specific subnets or IPs. Example: `[\"1.1.1.1\",\"1.1.1.0/24\",\"ocid1.vcn.oc1.sea.\",\"ocid1.vcn.oc1.sea.;1.1.1.1\",\"ocid1.vcn.oc1.sea.;1.1.0.0/16\"]` - For Exadata Cloud@Customer, this is an array of IP addresses or CIDR (Classless Inter-Domain Routing) notations. + For Exadata Cloud@Customer, this is an array of IP addresses or CIDR notations. Example: `[\"1.1.1.1\",\"1.1.1.0/24\",\"1.1.2.25\"]` For an update operation, if you want to delete all the IPs in the ACL, use an array with a single empty string entry. @@ -1043,13 +1047,13 @@ def whitelisted_ips(self): def whitelisted_ips(self, whitelisted_ips): """ Sets the whitelisted_ips of this UpdateAutonomousDatabaseDetails. - The client IP access control list (ACL). This feature is available for autonomous databases on `shared Exadata infrastructure`__ and on Exadata Cloud@Customer. + The client IP access control list (ACL). This feature is available for `Autonomous Database Serverless]`__ and on Exadata Cloud@Customer. Only clients connecting from an IP address included in the ACL may access the Autonomous Database instance. - For shared Exadata infrastructure, this is an array of CIDR (Classless Inter-Domain Routing) notations for a subnet or VCN OCID. + For Autonomous Database Serverless, this is an array of CIDR (classless inter-domain routing) notations for a subnet or VCN OCID (virtual cloud network Oracle Cloud ID). Use a semicolon (;) as a deliminator between the VCN-specific subnets or IPs. Example: `[\"1.1.1.1\",\"1.1.1.0/24\",\"ocid1.vcn.oc1.sea.\",\"ocid1.vcn.oc1.sea.;1.1.1.1\",\"ocid1.vcn.oc1.sea.;1.1.0.0/16\"]` - For Exadata Cloud@Customer, this is an array of IP addresses or CIDR (Classless Inter-Domain Routing) notations. + For Exadata Cloud@Customer, this is an array of IP addresses or CIDR notations. Example: `[\"1.1.1.1\",\"1.1.1.0/24\",\"1.1.2.25\"]` For an update operation, if you want to delete all the IPs in the ACL, use an array with a single empty string entry. @@ -1096,13 +1100,13 @@ def are_primary_whitelisted_ips_used(self, are_primary_whitelisted_ips_used): def standby_whitelisted_ips(self): """ Gets the standby_whitelisted_ips of this UpdateAutonomousDatabaseDetails. - The client IP access control list (ACL). This feature is available for autonomous databases on `shared Exadata infrastructure`__ and on Exadata Cloud@Customer. + The client IP access control list (ACL). This feature is available for `Autonomous Database Serverless]`__ and on Exadata Cloud@Customer. Only clients connecting from an IP address included in the ACL may access the Autonomous Database instance. - For shared Exadata infrastructure, this is an array of CIDR (Classless Inter-Domain Routing) notations for a subnet or VCN OCID. + For Autonomous Database Serverless, this is an array of CIDR (classless inter-domain routing) notations for a subnet or VCN OCID (virtual cloud network Oracle Cloud ID). Use a semicolon (;) as a deliminator between the VCN-specific subnets or IPs. Example: `[\"1.1.1.1\",\"1.1.1.0/24\",\"ocid1.vcn.oc1.sea.\",\"ocid1.vcn.oc1.sea.;1.1.1.1\",\"ocid1.vcn.oc1.sea.;1.1.0.0/16\"]` - For Exadata Cloud@Customer, this is an array of IP addresses or CIDR (Classless Inter-Domain Routing) notations. + For Exadata Cloud@Customer, this is an array of IP addresses or CIDR notations. Example: `[\"1.1.1.1\",\"1.1.1.0/24\",\"1.1.2.25\"]` For an update operation, if you want to delete all the IPs in the ACL, use an array with a single empty string entry. @@ -1121,13 +1125,13 @@ def standby_whitelisted_ips(self): def standby_whitelisted_ips(self, standby_whitelisted_ips): """ Sets the standby_whitelisted_ips of this UpdateAutonomousDatabaseDetails. - The client IP access control list (ACL). This feature is available for autonomous databases on `shared Exadata infrastructure`__ and on Exadata Cloud@Customer. + The client IP access control list (ACL). This feature is available for `Autonomous Database Serverless]`__ and on Exadata Cloud@Customer. Only clients connecting from an IP address included in the ACL may access the Autonomous Database instance. - For shared Exadata infrastructure, this is an array of CIDR (Classless Inter-Domain Routing) notations for a subnet or VCN OCID. + For Autonomous Database Serverless, this is an array of CIDR (classless inter-domain routing) notations for a subnet or VCN OCID (virtual cloud network Oracle Cloud ID). Use a semicolon (;) as a deliminator between the VCN-specific subnets or IPs. Example: `[\"1.1.1.1\",\"1.1.1.0/24\",\"ocid1.vcn.oc1.sea.\",\"ocid1.vcn.oc1.sea.;1.1.1.1\",\"ocid1.vcn.oc1.sea.;1.1.0.0/16\"]` - For Exadata Cloud@Customer, this is an array of IP addresses or CIDR (Classless Inter-Domain Routing) notations. + For Exadata Cloud@Customer, this is an array of IP addresses or CIDR notations. Example: `[\"1.1.1.1\",\"1.1.1.0/24\",\"1.1.2.25\"]` For an update operation, if you want to delete all the IPs in the ACL, use an array with a single empty string entry. @@ -1146,9 +1150,9 @@ def standby_whitelisted_ips(self, standby_whitelisted_ips): def is_auto_scaling_enabled(self): """ Gets the is_auto_scaling_enabled of this UpdateAutonomousDatabaseDetails. - Indicates whether auto scaling is enabled for the Autonomous Database OCPU core count. Setting to `TRUE` enables auto scaling. Setting to `FALSE` disables auto scaling. The default value is true. Auto scaling is available for databases on `shared Exadata infrastructure`__ only. + Indicates whether auto scaling is enabled for the Autonomous Database OCPU core count. Setting to `TRUE` enables auto scaling. Setting to `FALSE` disables auto scaling. The default value is true. Auto scaling is only available for `Autonomous Database Serverless instances`__. - __ https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html + __ https://docs.oracle.com/en/cloud/paas/autonomous-database/shared/index.html :return: The is_auto_scaling_enabled of this UpdateAutonomousDatabaseDetails. @@ -1160,9 +1164,9 @@ def is_auto_scaling_enabled(self): def is_auto_scaling_enabled(self, is_auto_scaling_enabled): """ Sets the is_auto_scaling_enabled of this UpdateAutonomousDatabaseDetails. - Indicates whether auto scaling is enabled for the Autonomous Database OCPU core count. Setting to `TRUE` enables auto scaling. Setting to `FALSE` disables auto scaling. The default value is true. Auto scaling is available for databases on `shared Exadata infrastructure`__ only. + Indicates whether auto scaling is enabled for the Autonomous Database OCPU core count. Setting to `TRUE` enables auto scaling. Setting to `FALSE` disables auto scaling. The default value is true. Auto scaling is only available for `Autonomous Database Serverless instances`__. - __ https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html + __ https://docs.oracle.com/en/cloud/paas/autonomous-database/shared/index.html :param is_auto_scaling_enabled: The is_auto_scaling_enabled of this UpdateAutonomousDatabaseDetails. @@ -1237,13 +1241,14 @@ def is_local_data_guard_enabled(self): Indicates whether the Autonomous Database has a local (in-region) standby database. Not applicable when creating a cross-region Autonomous Data Guard associations, or to Autonomous Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure. - To create a local standby, set to `TRUE`. To delete a local standby, set to `FALSE`. For more information on using Autonomous Data Guard on shared Exadata infrastructure (local and cross-region) , see `About Standby Databases`__ + To create a local standby, set to `TRUE`. To delete a local standby, set to `FALSE`. For more information on using Autonomous Data Guard on an Autonomous Database Serverless instance (local and cross-region) , see `About Standby Databases`__ - To enable cross-region Autonomous Data Guard on shared Exadata infrastructure, see :func:`create_cross_region_autonomous_database_data_guard_details`. + To enable cross-region Autonomous Data Guard on an Autonomous Database Serverless instance, see `Enable Autonomous Data Guard`__. This cannot be updated in parallel with any of the following: isMTLSRequired, dbWorkload, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, or isFreeTier. __ https://docs.oracle.com/en/cloud/paas/autonomous-database/adbsa/autonomous-data-guard-about.html#GUID-045AD017-8120-4BDC-AF58-7430FFE28D2B + __ https://docs-uat.us.oracle.com/en/cloud/paas/autonomous-database/adbsa/autonomous-data-guard-update-type.html#GUID-967ED737-4A05-4D6E-A7CA-C3F21ACF9BF0 :return: The is_local_data_guard_enabled of this UpdateAutonomousDatabaseDetails. @@ -1258,13 +1263,14 @@ def is_local_data_guard_enabled(self, is_local_data_guard_enabled): Indicates whether the Autonomous Database has a local (in-region) standby database. Not applicable when creating a cross-region Autonomous Data Guard associations, or to Autonomous Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure. - To create a local standby, set to `TRUE`. To delete a local standby, set to `FALSE`. For more information on using Autonomous Data Guard on shared Exadata infrastructure (local and cross-region) , see `About Standby Databases`__ + To create a local standby, set to `TRUE`. To delete a local standby, set to `FALSE`. For more information on using Autonomous Data Guard on an Autonomous Database Serverless instance (local and cross-region) , see `About Standby Databases`__ - To enable cross-region Autonomous Data Guard on shared Exadata infrastructure, see :func:`create_cross_region_autonomous_database_data_guard_details`. + To enable cross-region Autonomous Data Guard on an Autonomous Database Serverless instance, see `Enable Autonomous Data Guard`__. This cannot be updated in parallel with any of the following: isMTLSRequired, dbWorkload, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, or isFreeTier. __ https://docs.oracle.com/en/cloud/paas/autonomous-database/adbsa/autonomous-data-guard-about.html#GUID-045AD017-8120-4BDC-AF58-7430FFE28D2B + __ https://docs-uat.us.oracle.com/en/cloud/paas/autonomous-database/adbsa/autonomous-data-guard-update-type.html#GUID-967ED737-4A05-4D6E-A7CA-C3F21ACF9BF0 :param is_local_data_guard_enabled: The is_local_data_guard_enabled of this UpdateAutonomousDatabaseDetails. @@ -1279,13 +1285,14 @@ def is_data_guard_enabled(self): ** Deprecated. ** Indicates whether the Autonomous Database has a local (in-region) standby database. Not applicable when creating a cross-region Autonomous Data Guard associations, or to Autonomous Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure. - To create a local standby, set to `TRUE`. To delete a local standby, set to `FALSE`. For more information on using Autonomous Data Guard on shared Exadata infrastructure (local and cross-region) , see `About Standby Databases`__ + To create a local standby, set to `TRUE`. To delete a local standby, set to `FALSE`. For more information on using Autonomous Data Guard on an Autonomous Database Serverless instance (local and cross-region) , see `About Standby Databases`__ - To enable cross-region Autonomous Data Guard on shared Exadata infrastructure, see :func:`create_cross_region_autonomous_database_data_guard_details`. + To enable cross-region Autonomous Data Guard on an Autonomous Database Serverless instance, see `Enable Autonomous Data Guard`__. To delete a cross-region standby database, provide the `peerDbId` for the standby database in a remote region, and set `isDataGuardEnabled` to `FALSE`. __ https://docs.oracle.com/en/cloud/paas/autonomous-database/adbsa/autonomous-data-guard-about.html#GUID-045AD017-8120-4BDC-AF58-7430FFE28D2B + __ https://docs-uat.us.oracle.com/en/cloud/paas/autonomous-database/adbsa/autonomous-data-guard-update-type.html#GUID-967ED737-4A05-4D6E-A7CA-C3F21ACF9BF0 :return: The is_data_guard_enabled of this UpdateAutonomousDatabaseDetails. @@ -1300,13 +1307,14 @@ def is_data_guard_enabled(self, is_data_guard_enabled): ** Deprecated. ** Indicates whether the Autonomous Database has a local (in-region) standby database. Not applicable when creating a cross-region Autonomous Data Guard associations, or to Autonomous Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure. - To create a local standby, set to `TRUE`. To delete a local standby, set to `FALSE`. For more information on using Autonomous Data Guard on shared Exadata infrastructure (local and cross-region) , see `About Standby Databases`__ + To create a local standby, set to `TRUE`. To delete a local standby, set to `FALSE`. For more information on using Autonomous Data Guard on an Autonomous Database Serverless instance (local and cross-region) , see `About Standby Databases`__ - To enable cross-region Autonomous Data Guard on shared Exadata infrastructure, see :func:`create_cross_region_autonomous_database_data_guard_details`. + To enable cross-region Autonomous Data Guard on an Autonomous Database Serverless instance, see `Enable Autonomous Data Guard`__. To delete a cross-region standby database, provide the `peerDbId` for the standby database in a remote region, and set `isDataGuardEnabled` to `FALSE`. __ https://docs.oracle.com/en/cloud/paas/autonomous-database/adbsa/autonomous-data-guard-about.html#GUID-045AD017-8120-4BDC-AF58-7430FFE28D2B + __ https://docs-uat.us.oracle.com/en/cloud/paas/autonomous-database/adbsa/autonomous-data-guard-update-type.html#GUID-967ED737-4A05-4D6E-A7CA-C3F21ACF9BF0 :param is_data_guard_enabled: The is_data_guard_enabled of this UpdateAutonomousDatabaseDetails. @@ -1614,7 +1622,7 @@ def is_mtls_connection_required(self): - CreateAutonomousDatabase - GetAutonomousDatabase - UpdateAutonomousDatabase - Details: Prior to the July 1, 2023 change, the isMTLSConnectionRequired attribute default value was true. This applies to Autonomous Databases on shared Exadata infrastructure. + Details: Prior to the July 1, 2023 change, the isMTLSConnectionRequired attribute default value was true. This applies to Autonomous Database Serverless. Does this impact me? If you use or maintain custom scripts or Terraform scripts referencing the CreateAutonomousDatabase, GetAutonomousDatabase, or UpdateAutonomousDatabase APIs, you want to check, and possibly modify, the scripts for the changed default value of the attribute. Should you choose not to leave your scripts unchanged, the API calls containing this attribute will continue to work, but the default value will switch from true to false. How do I make this change? Using either OCI SDKs or command line tools, update your custom scripts to explicitly set the isMTLSConnectionRequired attribute to true. @@ -1636,7 +1644,7 @@ def is_mtls_connection_required(self, is_mtls_connection_required): - CreateAutonomousDatabase - GetAutonomousDatabase - UpdateAutonomousDatabase - Details: Prior to the July 1, 2023 change, the isMTLSConnectionRequired attribute default value was true. This applies to Autonomous Databases on shared Exadata infrastructure. + Details: Prior to the July 1, 2023 change, the isMTLSConnectionRequired attribute default value was true. This applies to Autonomous Database Serverless. Does this impact me? If you use or maintain custom scripts or Terraform scripts referencing the CreateAutonomousDatabase, GetAutonomousDatabase, or UpdateAutonomousDatabase APIs, you want to check, and possibly modify, the scripts for the changed default value of the attribute. Should you choose not to leave your scripts unchanged, the API calls containing this attribute will continue to work, but the default value will switch from true to false. How do I make this change? Using either OCI SDKs or command line tools, update your custom scripts to explicitly set the isMTLSConnectionRequired attribute to true. @@ -1782,7 +1790,7 @@ def db_tools_details(self, db_tools_details): def secret_id(self): """ Gets the secret_id of this UpdateAutonomousDatabaseDetails. - The OCI vault secret [/Content/General/Concepts/identifiers.htm]OCID. + The OCI vault secret [/Content/General/Concepts/identifiers.htm]OCID. This cannot be used in conjunction with adminPassword. :return: The secret_id of this UpdateAutonomousDatabaseDetails. @@ -1794,7 +1802,7 @@ def secret_id(self): def secret_id(self, secret_id): """ Sets the secret_id of this UpdateAutonomousDatabaseDetails. - The OCI vault secret [/Content/General/Concepts/identifiers.htm]OCID. + The OCI vault secret [/Content/General/Concepts/identifiers.htm]OCID. This cannot be used in conjunction with adminPassword. :param secret_id: The secret_id of this UpdateAutonomousDatabaseDetails. diff --git a/src/oci/database/models/update_cloud_autonomous_vm_cluster_details.py b/src/oci/database/models/update_cloud_autonomous_vm_cluster_details.py index 835ce0882c..d718428ada 100644 --- a/src/oci/database/models/update_cloud_autonomous_vm_cluster_details.py +++ b/src/oci/database/models/update_cloud_autonomous_vm_cluster_details.py @@ -158,10 +158,10 @@ def maintenance_window_details(self, maintenance_window_details): def license_model(self): """ Gets the license_model of this UpdateCloudAutonomousVmClusterDetails. - The Oracle license model that applies to the Oracle Autonomous Database. Bring your own license (BYOL) allows you to apply your current on-premises Oracle software licenses to equivalent, highly automated Oracle PaaS and IaaS services in the cloud. - License Included allows you to subscribe to new Oracle Database software licenses and the Database service. - Note that when provisioning an Autonomous Database on `dedicated Exadata infrastructure`__, this attribute must be null because the attribute is already set at the - Autonomous Exadata Infrastructure level. When using `shared Exadata infrastructure`__, if a value is not specified, the system will supply the value of `BRING_YOUR_OWN_LICENSE`. + The Oracle license model that applies to the Oracle Autonomous Database. Bring your own license (BYOL) allows you to apply your current on-premises Oracle software licenses to equivalent, highly automated Oracle services in the cloud. + License Included allows you to subscribe to new Oracle Database software licenses and the Oracle Database service. + Note that when provisioning an `Autonomous Database on dedicated Exadata infrastructure`__, this attribute must be null. It is already set at the + Autonomous Exadata Infrastructure level. When provisioning an `Autonomous Database Serverless]`__ database, if a value is not specified, the system defaults the value to `BRING_YOUR_OWN_LICENSE`. This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, maxCpuCoreCount, dataStorageSizeInTBs, adminPassword, isMTLSConnectionRequired, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, dbName, scheduledOperations, dbToolsDetails, or isFreeTier. @@ -180,10 +180,10 @@ def license_model(self): def license_model(self, license_model): """ Sets the license_model of this UpdateCloudAutonomousVmClusterDetails. - The Oracle license model that applies to the Oracle Autonomous Database. Bring your own license (BYOL) allows you to apply your current on-premises Oracle software licenses to equivalent, highly automated Oracle PaaS and IaaS services in the cloud. - License Included allows you to subscribe to new Oracle Database software licenses and the Database service. - Note that when provisioning an Autonomous Database on `dedicated Exadata infrastructure`__, this attribute must be null because the attribute is already set at the - Autonomous Exadata Infrastructure level. When using `shared Exadata infrastructure`__, if a value is not specified, the system will supply the value of `BRING_YOUR_OWN_LICENSE`. + The Oracle license model that applies to the Oracle Autonomous Database. Bring your own license (BYOL) allows you to apply your current on-premises Oracle software licenses to equivalent, highly automated Oracle services in the cloud. + License Included allows you to subscribe to new Oracle Database software licenses and the Oracle Database service. + Note that when provisioning an `Autonomous Database on dedicated Exadata infrastructure`__, this attribute must be null. It is already set at the + Autonomous Exadata Infrastructure level. When provisioning an `Autonomous Database Serverless]`__ database, if a value is not specified, the system defaults the value to `BRING_YOUR_OWN_LICENSE`. This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, maxCpuCoreCount, dataStorageSizeInTBs, adminPassword, isMTLSConnectionRequired, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, dbName, scheduledOperations, dbToolsDetails, or isFreeTier. diff --git a/src/oci/database/models/update_summary.py b/src/oci/database/models/update_summary.py index 952f00ac4d..ff9161917a 100644 --- a/src/oci/database/models/update_summary.py +++ b/src/oci/database/models/update_summary.py @@ -221,7 +221,7 @@ def description(self, description): def last_action(self): """ Gets the last_action of this UpdateSummary. - The update action. + The previous update action performed. Allowed values for this property are: "ROLLING_APPLY", "NON_ROLLING_APPLY", "PRECHECK", "ROLLBACK", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -236,7 +236,7 @@ def last_action(self): def last_action(self, last_action): """ Sets the last_action of this UpdateSummary. - The update action. + The previous update action performed. :param last_action: The last_action of this UpdateSummary. diff --git a/src/oci/database_management/__init__.py b/src/oci/database_management/__init__.py index 7827688c30..b41d61df42 100644 --- a/src/oci/database_management/__init__.py +++ b/src/oci/database_management/__init__.py @@ -11,8 +11,10 @@ from .db_management_client_composite_operations import DbManagementClientCompositeOperations from .diagnosability_client import DiagnosabilityClient from .diagnosability_client_composite_operations import DiagnosabilityClientCompositeOperations +from .perfhub_client import PerfhubClient +from .perfhub_client_composite_operations import PerfhubClientCompositeOperations from .sql_tuning_client import SqlTuningClient from .sql_tuning_client_composite_operations import SqlTuningClientCompositeOperations from . import models -__all__ = ["DbManagementClient", "DbManagementClientCompositeOperations", "DiagnosabilityClient", "DiagnosabilityClientCompositeOperations", "SqlTuningClient", "SqlTuningClientCompositeOperations", "models"] +__all__ = ["DbManagementClient", "DbManagementClientCompositeOperations", "DiagnosabilityClient", "DiagnosabilityClientCompositeOperations", "PerfhubClient", "PerfhubClientCompositeOperations", "SqlTuningClient", "SqlTuningClientCompositeOperations", "models"] diff --git a/src/oci/database_management/db_management_client.py b/src/oci/database_management/db_management_client.py index a9e904c94d..b42ef3af86 100644 --- a/src/oci/database_management/db_management_client.py +++ b/src/oci/database_management/db_management_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import database_management_type_mapping missing = Sentinel("Missing") @@ -76,6 +78,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("database_management"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/database_management/diagnosability_client.py b/src/oci/database_management/diagnosability_client.py index 13ce61f032..5e5b1e1f86 100644 --- a/src/oci/database_management/diagnosability_client.py +++ b/src/oci/database_management/diagnosability_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import database_management_type_mapping missing = Sentinel("Missing") @@ -76,6 +78,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("database_management"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/database_management/models/__init__.py b/src/oci/database_management/models/__init__.py index 8a57895259..84eacdf22e 100644 --- a/src/oci/database_management/models/__init__.py +++ b/src/oci/database_management/models/__init__.py @@ -88,6 +88,7 @@ from .create_job_details import CreateJobDetails from .create_managed_database_group_details import CreateManagedDatabaseGroupDetails from .create_sql_job_details import CreateSqlJobDetails +from .create_sql_tuning_set_details import CreateSqlTuningSetDetails from .create_tablespace_details import CreateTablespaceDetails from .cursor_cache_statement_collection import CursorCacheStatementCollection from .cursor_cache_statement_summary import CursorCacheStatementSummary @@ -135,7 +136,9 @@ from .discovered_external_listener import DiscoveredExternalListener from .discovered_external_pluggable_database import DiscoveredExternalPluggableDatabase from .drop_sql_plan_baselines_details import DropSqlPlanBaselinesDetails +from .drop_sql_tuning_set_details import DropSqlTuningSetDetails from .drop_sql_tuning_task_details import DropSqlTuningTaskDetails +from .drop_sqls_in_sql_tuning_set_details import DropSqlsInSqlTuningSetDetails from .drop_tablespace_details import DropTablespaceDetails from .enable_automatic_initial_plan_capture_details import EnableAutomaticInitialPlanCaptureDetails from .enable_automatic_spm_evolve_advisor_task_details import EnableAutomaticSpmEvolveAdvisorTaskDetails @@ -227,6 +230,7 @@ from .external_storage_grid_discovery_summary import ExternalStorageGridDiscoverySummary from .external_storage_server_discovery_summary import ExternalStorageServerDiscoverySummary from .failed_connections_aggregate_metrics import FailedConnectionsAggregateMetrics +from .fetch_sql_tuning_set_details import FetchSqlTuningSetDetails from .finding_schema_or_operation import FindingSchemaOrOperation from .fleet_metric_definition import FleetMetricDefinition from .fleet_metric_summary_definition import FleetMetricSummaryDefinition @@ -258,6 +262,7 @@ from .job_summary import JobSummary from .load_sql_plan_baselines_from_awr_details import LoadSqlPlanBaselinesFromAwrDetails from .load_sql_plan_baselines_from_cursor_cache_details import LoadSqlPlanBaselinesFromCursorCacheDetails +from .load_sql_tuning_set_details import LoadSqlTuningSetDetails from .managed_database import ManagedDatabase from .managed_database_collection import ManagedDatabaseCollection from .managed_database_credential import ManagedDatabaseCredential @@ -273,6 +278,7 @@ from .metric_statistics_definition import MetricStatisticsDefinition from .metrics_aggregation_range import MetricsAggregationRange from .metrics_aggregation_range_collection import MetricsAggregationRangeCollection +from .modify_snapshot_settings_details import ModifySnapshotSettingsDetails from .object_privilege_collection import ObjectPrivilegeCollection from .object_privilege_summary import ObjectPrivilegeSummary from .object_storage_job_execution_result_details import ObjectStorageJobExecutionResultDetails @@ -317,11 +323,14 @@ from .role_summary import RoleSummary from .rule_finding import RuleFinding from .run_historic_addm_details import RunHistoricAddmDetails +from .save_sql_tuning_set_as_details import SaveSqlTuningSetAsDetails from .schema_definition import SchemaDefinition from .snapshot_details import SnapshotDetails from .spm_evolve_task_parameters import SpmEvolveTaskParameters from .sql_cpu_activity import SqlCpuActivity +from .sql_in_sql_tuning_set import SqlInSqlTuningSet from .sql_job import SqlJob +from .sql_metrics import SqlMetrics from .sql_plan_baseline import SqlPlanBaseline from .sql_plan_baseline_aggregation import SqlPlanBaselineAggregation from .sql_plan_baseline_aggregation_collection import SqlPlanBaselineAggregationCollection @@ -347,6 +356,11 @@ from .sql_tuning_advisor_task_summary_report_statement_counts import SqlTuningAdvisorTaskSummaryReportStatementCounts from .sql_tuning_advisor_task_summary_report_statistics import SqlTuningAdvisorTaskSummaryReportStatistics from .sql_tuning_advisor_task_summary_report_task_info import SqlTuningAdvisorTaskSummaryReportTaskInfo +from .sql_tuning_set import SqlTuningSet +from .sql_tuning_set_admin_action_status import SqlTuningSetAdminActionStatus +from .sql_tuning_set_admin_credential_details import SqlTuningSetAdminCredentialDetails +from .sql_tuning_set_admin_password_credential_details import SqlTuningSetAdminPasswordCredentialDetails +from .sql_tuning_set_admin_secret_credential_details import SqlTuningSetAdminSecretCredentialDetails from .sql_tuning_set_collection import SqlTuningSetCollection from .sql_tuning_set_input import SqlTuningSetInput from .sql_tuning_set_summary import SqlTuningSetSummary @@ -399,6 +413,7 @@ from .user import User from .user_collection import UserCollection from .user_summary import UserSummary +from .validate_basic_filter_details import ValidateBasicFilterDetails from .work_request import WorkRequest from .work_request_collection import WorkRequestCollection from .work_request_error import WorkRequestError @@ -493,6 +508,7 @@ "CreateJobDetails": CreateJobDetails, "CreateManagedDatabaseGroupDetails": CreateManagedDatabaseGroupDetails, "CreateSqlJobDetails": CreateSqlJobDetails, + "CreateSqlTuningSetDetails": CreateSqlTuningSetDetails, "CreateTablespaceDetails": CreateTablespaceDetails, "CursorCacheStatementCollection": CursorCacheStatementCollection, "CursorCacheStatementSummary": CursorCacheStatementSummary, @@ -540,7 +556,9 @@ "DiscoveredExternalListener": DiscoveredExternalListener, "DiscoveredExternalPluggableDatabase": DiscoveredExternalPluggableDatabase, "DropSqlPlanBaselinesDetails": DropSqlPlanBaselinesDetails, + "DropSqlTuningSetDetails": DropSqlTuningSetDetails, "DropSqlTuningTaskDetails": DropSqlTuningTaskDetails, + "DropSqlsInSqlTuningSetDetails": DropSqlsInSqlTuningSetDetails, "DropTablespaceDetails": DropTablespaceDetails, "EnableAutomaticInitialPlanCaptureDetails": EnableAutomaticInitialPlanCaptureDetails, "EnableAutomaticSpmEvolveAdvisorTaskDetails": EnableAutomaticSpmEvolveAdvisorTaskDetails, @@ -632,6 +650,7 @@ "ExternalStorageGridDiscoverySummary": ExternalStorageGridDiscoverySummary, "ExternalStorageServerDiscoverySummary": ExternalStorageServerDiscoverySummary, "FailedConnectionsAggregateMetrics": FailedConnectionsAggregateMetrics, + "FetchSqlTuningSetDetails": FetchSqlTuningSetDetails, "FindingSchemaOrOperation": FindingSchemaOrOperation, "FleetMetricDefinition": FleetMetricDefinition, "FleetMetricSummaryDefinition": FleetMetricSummaryDefinition, @@ -663,6 +682,7 @@ "JobSummary": JobSummary, "LoadSqlPlanBaselinesFromAwrDetails": LoadSqlPlanBaselinesFromAwrDetails, "LoadSqlPlanBaselinesFromCursorCacheDetails": LoadSqlPlanBaselinesFromCursorCacheDetails, + "LoadSqlTuningSetDetails": LoadSqlTuningSetDetails, "ManagedDatabase": ManagedDatabase, "ManagedDatabaseCollection": ManagedDatabaseCollection, "ManagedDatabaseCredential": ManagedDatabaseCredential, @@ -678,6 +698,7 @@ "MetricStatisticsDefinition": MetricStatisticsDefinition, "MetricsAggregationRange": MetricsAggregationRange, "MetricsAggregationRangeCollection": MetricsAggregationRangeCollection, + "ModifySnapshotSettingsDetails": ModifySnapshotSettingsDetails, "ObjectPrivilegeCollection": ObjectPrivilegeCollection, "ObjectPrivilegeSummary": ObjectPrivilegeSummary, "ObjectStorageJobExecutionResultDetails": ObjectStorageJobExecutionResultDetails, @@ -722,11 +743,14 @@ "RoleSummary": RoleSummary, "RuleFinding": RuleFinding, "RunHistoricAddmDetails": RunHistoricAddmDetails, + "SaveSqlTuningSetAsDetails": SaveSqlTuningSetAsDetails, "SchemaDefinition": SchemaDefinition, "SnapshotDetails": SnapshotDetails, "SpmEvolveTaskParameters": SpmEvolveTaskParameters, "SqlCpuActivity": SqlCpuActivity, + "SqlInSqlTuningSet": SqlInSqlTuningSet, "SqlJob": SqlJob, + "SqlMetrics": SqlMetrics, "SqlPlanBaseline": SqlPlanBaseline, "SqlPlanBaselineAggregation": SqlPlanBaselineAggregation, "SqlPlanBaselineAggregationCollection": SqlPlanBaselineAggregationCollection, @@ -752,6 +776,11 @@ "SqlTuningAdvisorTaskSummaryReportStatementCounts": SqlTuningAdvisorTaskSummaryReportStatementCounts, "SqlTuningAdvisorTaskSummaryReportStatistics": SqlTuningAdvisorTaskSummaryReportStatistics, "SqlTuningAdvisorTaskSummaryReportTaskInfo": SqlTuningAdvisorTaskSummaryReportTaskInfo, + "SqlTuningSet": SqlTuningSet, + "SqlTuningSetAdminActionStatus": SqlTuningSetAdminActionStatus, + "SqlTuningSetAdminCredentialDetails": SqlTuningSetAdminCredentialDetails, + "SqlTuningSetAdminPasswordCredentialDetails": SqlTuningSetAdminPasswordCredentialDetails, + "SqlTuningSetAdminSecretCredentialDetails": SqlTuningSetAdminSecretCredentialDetails, "SqlTuningSetCollection": SqlTuningSetCollection, "SqlTuningSetInput": SqlTuningSetInput, "SqlTuningSetSummary": SqlTuningSetSummary, @@ -804,6 +833,7 @@ "User": User, "UserCollection": UserCollection, "UserSummary": UserSummary, + "ValidateBasicFilterDetails": ValidateBasicFilterDetails, "WorkRequest": WorkRequest, "WorkRequestCollection": WorkRequestCollection, "WorkRequestError": WorkRequestError, diff --git a/src/oci/database_management/models/create_sql_tuning_set_details.py b/src/oci/database_management/models/create_sql_tuning_set_details.py new file mode 100644 index 0000000000..b9a04e7ca7 --- /dev/null +++ b/src/oci/database_management/models/create_sql_tuning_set_details.py @@ -0,0 +1,192 @@ +# coding: utf-8 +# Copyright (c) 2016, 2023, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20201101 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class CreateSqlTuningSetDetails(object): + """ + Create an empty Sql tuning sets. + """ + + def __init__(self, **kwargs): + """ + Initializes a new CreateSqlTuningSetDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param credential_details: + The value to assign to the credential_details property of this CreateSqlTuningSetDetails. + :type credential_details: oci.database_management.models.SqlTuningSetAdminCredentialDetails + + :param name: + The value to assign to the name property of this CreateSqlTuningSetDetails. + :type name: str + + :param owner: + The value to assign to the owner property of this CreateSqlTuningSetDetails. + :type owner: str + + :param description: + The value to assign to the description property of this CreateSqlTuningSetDetails. + :type description: str + + :param show_sql_only: + The value to assign to the show_sql_only property of this CreateSqlTuningSetDetails. + :type show_sql_only: int + + """ + self.swagger_types = { + 'credential_details': 'SqlTuningSetAdminCredentialDetails', + 'name': 'str', + 'owner': 'str', + 'description': 'str', + 'show_sql_only': 'int' + } + + self.attribute_map = { + 'credential_details': 'credentialDetails', + 'name': 'name', + 'owner': 'owner', + 'description': 'description', + 'show_sql_only': 'showSqlOnly' + } + + self._credential_details = None + self._name = None + self._owner = None + self._description = None + self._show_sql_only = None + + @property + def credential_details(self): + """ + **[Required]** Gets the credential_details of this CreateSqlTuningSetDetails. + + :return: The credential_details of this CreateSqlTuningSetDetails. + :rtype: oci.database_management.models.SqlTuningSetAdminCredentialDetails + """ + return self._credential_details + + @credential_details.setter + def credential_details(self, credential_details): + """ + Sets the credential_details of this CreateSqlTuningSetDetails. + + :param credential_details: The credential_details of this CreateSqlTuningSetDetails. + :type: oci.database_management.models.SqlTuningSetAdminCredentialDetails + """ + self._credential_details = credential_details + + @property + def name(self): + """ + **[Required]** Gets the name of this CreateSqlTuningSetDetails. + A unique Sql tuning set name. + + + :return: The name of this CreateSqlTuningSetDetails. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this CreateSqlTuningSetDetails. + A unique Sql tuning set name. + + + :param name: The name of this CreateSqlTuningSetDetails. + :type: str + """ + self._name = name + + @property + def owner(self): + """ + Gets the owner of this CreateSqlTuningSetDetails. + Owner of the Sql tuning set. + + + :return: The owner of this CreateSqlTuningSetDetails. + :rtype: str + """ + return self._owner + + @owner.setter + def owner(self, owner): + """ + Sets the owner of this CreateSqlTuningSetDetails. + Owner of the Sql tuning set. + + + :param owner: The owner of this CreateSqlTuningSetDetails. + :type: str + """ + self._owner = owner + + @property + def description(self): + """ + Gets the description of this CreateSqlTuningSetDetails. + The description of the Sql tuning set. + + + :return: The description of this CreateSqlTuningSetDetails. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this CreateSqlTuningSetDetails. + The description of the Sql tuning set. + + + :param description: The description of this CreateSqlTuningSetDetails. + :type: str + """ + self._description = description + + @property + def show_sql_only(self): + """ + Gets the show_sql_only of this CreateSqlTuningSetDetails. + Flag to indicate whether to create the Sql tuning set or just display the plsql used to create Sql tuning set. + + + :return: The show_sql_only of this CreateSqlTuningSetDetails. + :rtype: int + """ + return self._show_sql_only + + @show_sql_only.setter + def show_sql_only(self, show_sql_only): + """ + Sets the show_sql_only of this CreateSqlTuningSetDetails. + Flag to indicate whether to create the Sql tuning set or just display the plsql used to create Sql tuning set. + + + :param show_sql_only: The show_sql_only of this CreateSqlTuningSetDetails. + :type: int + """ + self._show_sql_only = show_sql_only + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/database_management/models/drop_sql_tuning_set_details.py b/src/oci/database_management/models/drop_sql_tuning_set_details.py new file mode 100644 index 0000000000..0350cbba75 --- /dev/null +++ b/src/oci/database_management/models/drop_sql_tuning_set_details.py @@ -0,0 +1,161 @@ +# coding: utf-8 +# Copyright (c) 2016, 2023, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20201101 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class DropSqlTuningSetDetails(object): + """ + The details required to drop a Sql tuning set. + """ + + def __init__(self, **kwargs): + """ + Initializes a new DropSqlTuningSetDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param credential_details: + The value to assign to the credential_details property of this DropSqlTuningSetDetails. + :type credential_details: oci.database_management.models.SqlTuningSetAdminCredentialDetails + + :param name: + The value to assign to the name property of this DropSqlTuningSetDetails. + :type name: str + + :param owner: + The value to assign to the owner property of this DropSqlTuningSetDetails. + :type owner: str + + :param show_sql_only: + The value to assign to the show_sql_only property of this DropSqlTuningSetDetails. + :type show_sql_only: int + + """ + self.swagger_types = { + 'credential_details': 'SqlTuningSetAdminCredentialDetails', + 'name': 'str', + 'owner': 'str', + 'show_sql_only': 'int' + } + + self.attribute_map = { + 'credential_details': 'credentialDetails', + 'name': 'name', + 'owner': 'owner', + 'show_sql_only': 'showSqlOnly' + } + + self._credential_details = None + self._name = None + self._owner = None + self._show_sql_only = None + + @property + def credential_details(self): + """ + **[Required]** Gets the credential_details of this DropSqlTuningSetDetails. + + :return: The credential_details of this DropSqlTuningSetDetails. + :rtype: oci.database_management.models.SqlTuningSetAdminCredentialDetails + """ + return self._credential_details + + @credential_details.setter + def credential_details(self, credential_details): + """ + Sets the credential_details of this DropSqlTuningSetDetails. + + :param credential_details: The credential_details of this DropSqlTuningSetDetails. + :type: oci.database_management.models.SqlTuningSetAdminCredentialDetails + """ + self._credential_details = credential_details + + @property + def name(self): + """ + **[Required]** Gets the name of this DropSqlTuningSetDetails. + A unique Sql tuning set name. + + + :return: The name of this DropSqlTuningSetDetails. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this DropSqlTuningSetDetails. + A unique Sql tuning set name. + + + :param name: The name of this DropSqlTuningSetDetails. + :type: str + """ + self._name = name + + @property + def owner(self): + """ + Gets the owner of this DropSqlTuningSetDetails. + Owner of the Sql tuning set. + + + :return: The owner of this DropSqlTuningSetDetails. + :rtype: str + """ + return self._owner + + @owner.setter + def owner(self, owner): + """ + Sets the owner of this DropSqlTuningSetDetails. + Owner of the Sql tuning set. + + + :param owner: The owner of this DropSqlTuningSetDetails. + :type: str + """ + self._owner = owner + + @property + def show_sql_only(self): + """ + Gets the show_sql_only of this DropSqlTuningSetDetails. + Flag to indicate whether to drop the Sql tuning set or just display the plsql used to drop Sql tuning set. + + + :return: The show_sql_only of this DropSqlTuningSetDetails. + :rtype: int + """ + return self._show_sql_only + + @show_sql_only.setter + def show_sql_only(self, show_sql_only): + """ + Sets the show_sql_only of this DropSqlTuningSetDetails. + Flag to indicate whether to drop the Sql tuning set or just display the plsql used to drop Sql tuning set. + + + :param show_sql_only: The show_sql_only of this DropSqlTuningSetDetails. + :type: int + """ + self._show_sql_only = show_sql_only + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/database_management/models/drop_sqls_in_sql_tuning_set_details.py b/src/oci/database_management/models/drop_sqls_in_sql_tuning_set_details.py new file mode 100644 index 0000000000..90fc423816 --- /dev/null +++ b/src/oci/database_management/models/drop_sqls_in_sql_tuning_set_details.py @@ -0,0 +1,199 @@ +# coding: utf-8 +# Copyright (c) 2016, 2023, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20201101 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class DropSqlsInSqlTuningSetDetails(object): + """ + Drops the selected list of Sql statements from the current Sql tuning set. + The basicFilter parameter specifies the Sql predicate to filter the Sql from the Sql tuning set defined on attributes of the SQLSET_ROW. + If a valid filter criteria is specified, then, Sql statements matching this filter criteria will be deleted from the current Sql tuning set. + If filter criteria is not specified, then, all Sql statements will be deleted from the current Sql tuning set. + """ + + def __init__(self, **kwargs): + """ + Initializes a new DropSqlsInSqlTuningSetDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param credential_details: + The value to assign to the credential_details property of this DropSqlsInSqlTuningSetDetails. + :type credential_details: oci.database_management.models.SqlTuningSetAdminCredentialDetails + + :param show_sql_only: + The value to assign to the show_sql_only property of this DropSqlsInSqlTuningSetDetails. + :type show_sql_only: int + + :param owner: + The value to assign to the owner property of this DropSqlsInSqlTuningSetDetails. + :type owner: str + + :param name: + The value to assign to the name property of this DropSqlsInSqlTuningSetDetails. + :type name: str + + :param basic_filter: + The value to assign to the basic_filter property of this DropSqlsInSqlTuningSetDetails. + :type basic_filter: str + + """ + self.swagger_types = { + 'credential_details': 'SqlTuningSetAdminCredentialDetails', + 'show_sql_only': 'int', + 'owner': 'str', + 'name': 'str', + 'basic_filter': 'str' + } + + self.attribute_map = { + 'credential_details': 'credentialDetails', + 'show_sql_only': 'showSqlOnly', + 'owner': 'owner', + 'name': 'name', + 'basic_filter': 'basicFilter' + } + + self._credential_details = None + self._show_sql_only = None + self._owner = None + self._name = None + self._basic_filter = None + + @property + def credential_details(self): + """ + **[Required]** Gets the credential_details of this DropSqlsInSqlTuningSetDetails. + + :return: The credential_details of this DropSqlsInSqlTuningSetDetails. + :rtype: oci.database_management.models.SqlTuningSetAdminCredentialDetails + """ + return self._credential_details + + @credential_details.setter + def credential_details(self, credential_details): + """ + Sets the credential_details of this DropSqlsInSqlTuningSetDetails. + + :param credential_details: The credential_details of this DropSqlsInSqlTuningSetDetails. + :type: oci.database_management.models.SqlTuningSetAdminCredentialDetails + """ + self._credential_details = credential_details + + @property + def show_sql_only(self): + """ + Gets the show_sql_only of this DropSqlsInSqlTuningSetDetails. + Flag to indicate whether to drop the Sql statements or just display the plsql used to drop the Sql statements. + + + :return: The show_sql_only of this DropSqlsInSqlTuningSetDetails. + :rtype: int + """ + return self._show_sql_only + + @show_sql_only.setter + def show_sql_only(self, show_sql_only): + """ + Sets the show_sql_only of this DropSqlsInSqlTuningSetDetails. + Flag to indicate whether to drop the Sql statements or just display the plsql used to drop the Sql statements. + + + :param show_sql_only: The show_sql_only of this DropSqlsInSqlTuningSetDetails. + :type: int + """ + self._show_sql_only = show_sql_only + + @property + def owner(self): + """ + Gets the owner of this DropSqlsInSqlTuningSetDetails. + The owner of the Sql tuning set. + + + :return: The owner of this DropSqlsInSqlTuningSetDetails. + :rtype: str + """ + return self._owner + + @owner.setter + def owner(self, owner): + """ + Sets the owner of this DropSqlsInSqlTuningSetDetails. + The owner of the Sql tuning set. + + + :param owner: The owner of this DropSqlsInSqlTuningSetDetails. + :type: str + """ + self._owner = owner + + @property + def name(self): + """ + **[Required]** Gets the name of this DropSqlsInSqlTuningSetDetails. + The name of the Sql tuning set. + + + :return: The name of this DropSqlsInSqlTuningSetDetails. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this DropSqlsInSqlTuningSetDetails. + The name of the Sql tuning set. + + + :param name: The name of this DropSqlsInSqlTuningSetDetails. + :type: str + """ + self._name = name + + @property + def basic_filter(self): + """ + Gets the basic_filter of this DropSqlsInSqlTuningSetDetails. + Specifies the Sql predicate to filter the Sql from the Sql tuning set defined on attributes of the SQLSET_ROW. + User could use any combination of the following columns with appropriate values as Sql predicate + Refer to the documentation https://docs.oracle.com/en/database/oracle/oracle-database/18/arpls/DBMS_SQLTUNE.html#GUID-1F4AFB03-7B29-46FC-B3F2-CB01EC36326C + + + :return: The basic_filter of this DropSqlsInSqlTuningSetDetails. + :rtype: str + """ + return self._basic_filter + + @basic_filter.setter + def basic_filter(self, basic_filter): + """ + Sets the basic_filter of this DropSqlsInSqlTuningSetDetails. + Specifies the Sql predicate to filter the Sql from the Sql tuning set defined on attributes of the SQLSET_ROW. + User could use any combination of the following columns with appropriate values as Sql predicate + Refer to the documentation https://docs.oracle.com/en/database/oracle/oracle-database/18/arpls/DBMS_SQLTUNE.html#GUID-1F4AFB03-7B29-46FC-B3F2-CB01EC36326C + + + :param basic_filter: The basic_filter of this DropSqlsInSqlTuningSetDetails. + :type: str + """ + self._basic_filter = basic_filter + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/database_management/models/external_asm_instance.py b/src/oci/database_management/models/external_asm_instance.py index 49d65a70ad..8cbe7f98c8 100644 --- a/src/oci/database_management/models/external_asm_instance.py +++ b/src/oci/database_management/models/external_asm_instance.py @@ -39,6 +39,10 @@ class ExternalAsmInstance(object): #: This constant has a value of "DELETED" LIFECYCLE_STATE_DELETED = "DELETED" + #: A constant which can be used with the lifecycle_state property of a ExternalAsmInstance. + #: This constant has a value of "FAILED" + LIFECYCLE_STATE_FAILED = "FAILED" + def __init__(self, **kwargs): """ Initializes a new ExternalAsmInstance object with values from keyword arguments. @@ -82,7 +86,7 @@ def __init__(self, **kwargs): :param lifecycle_state: The value to assign to the lifecycle_state property of this ExternalAsmInstance. - Allowed values for this property are: "CREATING", "ACTIVE", "INACTIVE", "UPDATING", "DELETING", "DELETED", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "CREATING", "ACTIVE", "INACTIVE", "UPDATING", "DELETING", "DELETED", "FAILED", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type lifecycle_state: str @@ -387,7 +391,7 @@ def lifecycle_state(self): **[Required]** Gets the lifecycle_state of this ExternalAsmInstance. The current lifecycle state of the external ASM instance. - Allowed values for this property are: "CREATING", "ACTIVE", "INACTIVE", "UPDATING", "DELETING", "DELETED", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "CREATING", "ACTIVE", "INACTIVE", "UPDATING", "DELETING", "DELETED", "FAILED", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -406,7 +410,7 @@ def lifecycle_state(self, lifecycle_state): :param lifecycle_state: The lifecycle_state of this ExternalAsmInstance. :type: str """ - allowed_values = ["CREATING", "ACTIVE", "INACTIVE", "UPDATING", "DELETING", "DELETED"] + allowed_values = ["CREATING", "ACTIVE", "INACTIVE", "UPDATING", "DELETING", "DELETED", "FAILED"] if not value_allowed_none_or_none_sentinel(lifecycle_state, allowed_values): lifecycle_state = 'UNKNOWN_ENUM_VALUE' self._lifecycle_state = lifecycle_state diff --git a/src/oci/database_management/models/fetch_sql_tuning_set_details.py b/src/oci/database_management/models/fetch_sql_tuning_set_details.py new file mode 100644 index 0000000000..f9c2a8da97 --- /dev/null +++ b/src/oci/database_management/models/fetch_sql_tuning_set_details.py @@ -0,0 +1,469 @@ +# coding: utf-8 +# Copyright (c) 2016, 2023, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20201101 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class FetchSqlTuningSetDetails(object): + """ + The details required to fetch the Sql tuning set details. + """ + + #: A constant which can be used with the recursive_sql property of a FetchSqlTuningSetDetails. + #: This constant has a value of "HAS_RECURSIVE_SQL" + RECURSIVE_SQL_HAS_RECURSIVE_SQL = "HAS_RECURSIVE_SQL" + + #: A constant which can be used with the recursive_sql property of a FetchSqlTuningSetDetails. + #: This constant has a value of "NO_RECURSIVE_SQL" + RECURSIVE_SQL_NO_RECURSIVE_SQL = "NO_RECURSIVE_SQL" + + #: A constant which can be used with the ranking_measure1 property of a FetchSqlTuningSetDetails. + #: This constant has a value of "ELAPSED_TIME" + RANKING_MEASURE1_ELAPSED_TIME = "ELAPSED_TIME" + + #: A constant which can be used with the ranking_measure1 property of a FetchSqlTuningSetDetails. + #: This constant has a value of "CPU_TIME" + RANKING_MEASURE1_CPU_TIME = "CPU_TIME" + + #: A constant which can be used with the ranking_measure1 property of a FetchSqlTuningSetDetails. + #: This constant has a value of "OPTIMIZER_COST" + RANKING_MEASURE1_OPTIMIZER_COST = "OPTIMIZER_COST" + + #: A constant which can be used with the ranking_measure1 property of a FetchSqlTuningSetDetails. + #: This constant has a value of "BUFFER_GETS" + RANKING_MEASURE1_BUFFER_GETS = "BUFFER_GETS" + + #: A constant which can be used with the ranking_measure1 property of a FetchSqlTuningSetDetails. + #: This constant has a value of "DISK_READS" + RANKING_MEASURE1_DISK_READS = "DISK_READS" + + #: A constant which can be used with the ranking_measure1 property of a FetchSqlTuningSetDetails. + #: This constant has a value of "DIRECT_WRITES" + RANKING_MEASURE1_DIRECT_WRITES = "DIRECT_WRITES" + + #: A constant which can be used with the ranking_measure2 property of a FetchSqlTuningSetDetails. + #: This constant has a value of "ELAPSED_TIME" + RANKING_MEASURE2_ELAPSED_TIME = "ELAPSED_TIME" + + #: A constant which can be used with the ranking_measure2 property of a FetchSqlTuningSetDetails. + #: This constant has a value of "CPU_TIME" + RANKING_MEASURE2_CPU_TIME = "CPU_TIME" + + #: A constant which can be used with the ranking_measure2 property of a FetchSqlTuningSetDetails. + #: This constant has a value of "OPTIMIZER_COST" + RANKING_MEASURE2_OPTIMIZER_COST = "OPTIMIZER_COST" + + #: A constant which can be used with the ranking_measure2 property of a FetchSqlTuningSetDetails. + #: This constant has a value of "BUFFER_GETS" + RANKING_MEASURE2_BUFFER_GETS = "BUFFER_GETS" + + #: A constant which can be used with the ranking_measure2 property of a FetchSqlTuningSetDetails. + #: This constant has a value of "DISK_READS" + RANKING_MEASURE2_DISK_READS = "DISK_READS" + + #: A constant which can be used with the ranking_measure2 property of a FetchSqlTuningSetDetails. + #: This constant has a value of "DIRECT_WRITES" + RANKING_MEASURE2_DIRECT_WRITES = "DIRECT_WRITES" + + #: A constant which can be used with the ranking_measure3 property of a FetchSqlTuningSetDetails. + #: This constant has a value of "ELAPSED_TIME" + RANKING_MEASURE3_ELAPSED_TIME = "ELAPSED_TIME" + + #: A constant which can be used with the ranking_measure3 property of a FetchSqlTuningSetDetails. + #: This constant has a value of "CPU_TIME" + RANKING_MEASURE3_CPU_TIME = "CPU_TIME" + + #: A constant which can be used with the ranking_measure3 property of a FetchSqlTuningSetDetails. + #: This constant has a value of "OPTIMIZER_COST" + RANKING_MEASURE3_OPTIMIZER_COST = "OPTIMIZER_COST" + + #: A constant which can be used with the ranking_measure3 property of a FetchSqlTuningSetDetails. + #: This constant has a value of "BUFFER_GETS" + RANKING_MEASURE3_BUFFER_GETS = "BUFFER_GETS" + + #: A constant which can be used with the ranking_measure3 property of a FetchSqlTuningSetDetails. + #: This constant has a value of "DISK_READS" + RANKING_MEASURE3_DISK_READS = "DISK_READS" + + #: A constant which can be used with the ranking_measure3 property of a FetchSqlTuningSetDetails. + #: This constant has a value of "DIRECT_WRITES" + RANKING_MEASURE3_DIRECT_WRITES = "DIRECT_WRITES" + + def __init__(self, **kwargs): + """ + Initializes a new FetchSqlTuningSetDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param credential_details: + The value to assign to the credential_details property of this FetchSqlTuningSetDetails. + :type credential_details: oci.database_management.models.SqlTuningSetAdminCredentialDetails + + :param owner: + The value to assign to the owner property of this FetchSqlTuningSetDetails. + :type owner: str + + :param name: + The value to assign to the name property of this FetchSqlTuningSetDetails. + :type name: str + + :param basic_filter: + The value to assign to the basic_filter property of this FetchSqlTuningSetDetails. + :type basic_filter: str + + :param recursive_sql: + The value to assign to the recursive_sql property of this FetchSqlTuningSetDetails. + Allowed values for this property are: "HAS_RECURSIVE_SQL", "NO_RECURSIVE_SQL" + :type recursive_sql: str + + :param result_percentage: + The value to assign to the result_percentage property of this FetchSqlTuningSetDetails. + :type result_percentage: float + + :param result_limit: + The value to assign to the result_limit property of this FetchSqlTuningSetDetails. + :type result_limit: int + + :param ranking_measure1: + The value to assign to the ranking_measure1 property of this FetchSqlTuningSetDetails. + Allowed values for this property are: "ELAPSED_TIME", "CPU_TIME", "OPTIMIZER_COST", "BUFFER_GETS", "DISK_READS", "DIRECT_WRITES" + :type ranking_measure1: str + + :param ranking_measure2: + The value to assign to the ranking_measure2 property of this FetchSqlTuningSetDetails. + Allowed values for this property are: "ELAPSED_TIME", "CPU_TIME", "OPTIMIZER_COST", "BUFFER_GETS", "DISK_READS", "DIRECT_WRITES" + :type ranking_measure2: str + + :param ranking_measure3: + The value to assign to the ranking_measure3 property of this FetchSqlTuningSetDetails. + Allowed values for this property are: "ELAPSED_TIME", "CPU_TIME", "OPTIMIZER_COST", "BUFFER_GETS", "DISK_READS", "DIRECT_WRITES" + :type ranking_measure3: str + + """ + self.swagger_types = { + 'credential_details': 'SqlTuningSetAdminCredentialDetails', + 'owner': 'str', + 'name': 'str', + 'basic_filter': 'str', + 'recursive_sql': 'str', + 'result_percentage': 'float', + 'result_limit': 'int', + 'ranking_measure1': 'str', + 'ranking_measure2': 'str', + 'ranking_measure3': 'str' + } + + self.attribute_map = { + 'credential_details': 'credentialDetails', + 'owner': 'owner', + 'name': 'name', + 'basic_filter': 'basicFilter', + 'recursive_sql': 'recursiveSql', + 'result_percentage': 'resultPercentage', + 'result_limit': 'resultLimit', + 'ranking_measure1': 'rankingMeasure1', + 'ranking_measure2': 'rankingMeasure2', + 'ranking_measure3': 'rankingMeasure3' + } + + self._credential_details = None + self._owner = None + self._name = None + self._basic_filter = None + self._recursive_sql = None + self._result_percentage = None + self._result_limit = None + self._ranking_measure1 = None + self._ranking_measure2 = None + self._ranking_measure3 = None + + @property + def credential_details(self): + """ + **[Required]** Gets the credential_details of this FetchSqlTuningSetDetails. + + :return: The credential_details of this FetchSqlTuningSetDetails. + :rtype: oci.database_management.models.SqlTuningSetAdminCredentialDetails + """ + return self._credential_details + + @credential_details.setter + def credential_details(self, credential_details): + """ + Sets the credential_details of this FetchSqlTuningSetDetails. + + :param credential_details: The credential_details of this FetchSqlTuningSetDetails. + :type: oci.database_management.models.SqlTuningSetAdminCredentialDetails + """ + self._credential_details = credential_details + + @property + def owner(self): + """ + **[Required]** Gets the owner of this FetchSqlTuningSetDetails. + The owner of the Sql tuning set. + + + :return: The owner of this FetchSqlTuningSetDetails. + :rtype: str + """ + return self._owner + + @owner.setter + def owner(self, owner): + """ + Sets the owner of this FetchSqlTuningSetDetails. + The owner of the Sql tuning set. + + + :param owner: The owner of this FetchSqlTuningSetDetails. + :type: str + """ + self._owner = owner + + @property + def name(self): + """ + **[Required]** Gets the name of this FetchSqlTuningSetDetails. + The name of the Sql tuning set. + + + :return: The name of this FetchSqlTuningSetDetails. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this FetchSqlTuningSetDetails. + The name of the Sql tuning set. + + + :param name: The name of this FetchSqlTuningSetDetails. + :type: str + """ + self._name = name + + @property + def basic_filter(self): + """ + Gets the basic_filter of this FetchSqlTuningSetDetails. + Specifies the Sql predicate to filter the Sql from the Sql tuning set defined on attributes of the SQLSET_ROW. + User could use any combination of the following columns with appropriate values as Sql predicate + Refer to the documentation https://docs.oracle.com/en/database/oracle/oracle-database/18/arpls/DBMS_SQLTUNE.html#GUID-1F4AFB03-7B29-46FC-B3F2-CB01EC36326C + + + :return: The basic_filter of this FetchSqlTuningSetDetails. + :rtype: str + """ + return self._basic_filter + + @basic_filter.setter + def basic_filter(self, basic_filter): + """ + Sets the basic_filter of this FetchSqlTuningSetDetails. + Specifies the Sql predicate to filter the Sql from the Sql tuning set defined on attributes of the SQLSET_ROW. + User could use any combination of the following columns with appropriate values as Sql predicate + Refer to the documentation https://docs.oracle.com/en/database/oracle/oracle-database/18/arpls/DBMS_SQLTUNE.html#GUID-1F4AFB03-7B29-46FC-B3F2-CB01EC36326C + + + :param basic_filter: The basic_filter of this FetchSqlTuningSetDetails. + :type: str + """ + self._basic_filter = basic_filter + + @property + def recursive_sql(self): + """ + Gets the recursive_sql of this FetchSqlTuningSetDetails. + Specifies that the filter must include recursive Sql in the Sql tuning set. + + Allowed values for this property are: "HAS_RECURSIVE_SQL", "NO_RECURSIVE_SQL" + + + :return: The recursive_sql of this FetchSqlTuningSetDetails. + :rtype: str + """ + return self._recursive_sql + + @recursive_sql.setter + def recursive_sql(self, recursive_sql): + """ + Sets the recursive_sql of this FetchSqlTuningSetDetails. + Specifies that the filter must include recursive Sql in the Sql tuning set. + + + :param recursive_sql: The recursive_sql of this FetchSqlTuningSetDetails. + :type: str + """ + allowed_values = ["HAS_RECURSIVE_SQL", "NO_RECURSIVE_SQL"] + if not value_allowed_none_or_none_sentinel(recursive_sql, allowed_values): + raise ValueError( + "Invalid value for `recursive_sql`, must be None or one of {0}" + .format(allowed_values) + ) + self._recursive_sql = recursive_sql + + @property + def result_percentage(self): + """ + Gets the result_percentage of this FetchSqlTuningSetDetails. + Specifies a filter that picks the top n% according to the supplied ranking measure. + Note that this parameter applies only if one ranking measure is supplied. + + + :return: The result_percentage of this FetchSqlTuningSetDetails. + :rtype: float + """ + return self._result_percentage + + @result_percentage.setter + def result_percentage(self, result_percentage): + """ + Sets the result_percentage of this FetchSqlTuningSetDetails. + Specifies a filter that picks the top n% according to the supplied ranking measure. + Note that this parameter applies only if one ranking measure is supplied. + + + :param result_percentage: The result_percentage of this FetchSqlTuningSetDetails. + :type: float + """ + self._result_percentage = result_percentage + + @property + def result_limit(self): + """ + Gets the result_limit of this FetchSqlTuningSetDetails. + The top limit Sql from the filtered source, ranked by the ranking measure. + + + :return: The result_limit of this FetchSqlTuningSetDetails. + :rtype: int + """ + return self._result_limit + + @result_limit.setter + def result_limit(self, result_limit): + """ + Sets the result_limit of this FetchSqlTuningSetDetails. + The top limit Sql from the filtered source, ranked by the ranking measure. + + + :param result_limit: The result_limit of this FetchSqlTuningSetDetails. + :type: int + """ + self._result_limit = result_limit + + @property + def ranking_measure1(self): + """ + Gets the ranking_measure1 of this FetchSqlTuningSetDetails. + Specifies an ORDER BY clause on the selected Sql. User can specify upto three ranking measures. + + Allowed values for this property are: "ELAPSED_TIME", "CPU_TIME", "OPTIMIZER_COST", "BUFFER_GETS", "DISK_READS", "DIRECT_WRITES" + + + :return: The ranking_measure1 of this FetchSqlTuningSetDetails. + :rtype: str + """ + return self._ranking_measure1 + + @ranking_measure1.setter + def ranking_measure1(self, ranking_measure1): + """ + Sets the ranking_measure1 of this FetchSqlTuningSetDetails. + Specifies an ORDER BY clause on the selected Sql. User can specify upto three ranking measures. + + + :param ranking_measure1: The ranking_measure1 of this FetchSqlTuningSetDetails. + :type: str + """ + allowed_values = ["ELAPSED_TIME", "CPU_TIME", "OPTIMIZER_COST", "BUFFER_GETS", "DISK_READS", "DIRECT_WRITES"] + if not value_allowed_none_or_none_sentinel(ranking_measure1, allowed_values): + raise ValueError( + "Invalid value for `ranking_measure1`, must be None or one of {0}" + .format(allowed_values) + ) + self._ranking_measure1 = ranking_measure1 + + @property + def ranking_measure2(self): + """ + Gets the ranking_measure2 of this FetchSqlTuningSetDetails. + Specifies an ORDER BY clause on the selected Sql. User can specify upto three ranking measures. + + Allowed values for this property are: "ELAPSED_TIME", "CPU_TIME", "OPTIMIZER_COST", "BUFFER_GETS", "DISK_READS", "DIRECT_WRITES" + + + :return: The ranking_measure2 of this FetchSqlTuningSetDetails. + :rtype: str + """ + return self._ranking_measure2 + + @ranking_measure2.setter + def ranking_measure2(self, ranking_measure2): + """ + Sets the ranking_measure2 of this FetchSqlTuningSetDetails. + Specifies an ORDER BY clause on the selected Sql. User can specify upto three ranking measures. + + + :param ranking_measure2: The ranking_measure2 of this FetchSqlTuningSetDetails. + :type: str + """ + allowed_values = ["ELAPSED_TIME", "CPU_TIME", "OPTIMIZER_COST", "BUFFER_GETS", "DISK_READS", "DIRECT_WRITES"] + if not value_allowed_none_or_none_sentinel(ranking_measure2, allowed_values): + raise ValueError( + "Invalid value for `ranking_measure2`, must be None or one of {0}" + .format(allowed_values) + ) + self._ranking_measure2 = ranking_measure2 + + @property + def ranking_measure3(self): + """ + Gets the ranking_measure3 of this FetchSqlTuningSetDetails. + Specifies an ORDER BY clause on the selected Sql. User can specify upto three ranking measures. + + Allowed values for this property are: "ELAPSED_TIME", "CPU_TIME", "OPTIMIZER_COST", "BUFFER_GETS", "DISK_READS", "DIRECT_WRITES" + + + :return: The ranking_measure3 of this FetchSqlTuningSetDetails. + :rtype: str + """ + return self._ranking_measure3 + + @ranking_measure3.setter + def ranking_measure3(self, ranking_measure3): + """ + Sets the ranking_measure3 of this FetchSqlTuningSetDetails. + Specifies an ORDER BY clause on the selected Sql. User can specify upto three ranking measures. + + + :param ranking_measure3: The ranking_measure3 of this FetchSqlTuningSetDetails. + :type: str + """ + allowed_values = ["ELAPSED_TIME", "CPU_TIME", "OPTIMIZER_COST", "BUFFER_GETS", "DISK_READS", "DIRECT_WRITES"] + if not value_allowed_none_or_none_sentinel(ranking_measure3, allowed_values): + raise ValueError( + "Invalid value for `ranking_measure3`, must be None or one of {0}" + .format(allowed_values) + ) + self._ranking_measure3 = ranking_measure3 + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/database_management/models/load_sql_tuning_set_details.py b/src/oci/database_management/models/load_sql_tuning_set_details.py new file mode 100644 index 0000000000..b907ab6985 --- /dev/null +++ b/src/oci/database_management/models/load_sql_tuning_set_details.py @@ -0,0 +1,1229 @@ +# coding: utf-8 +# Copyright (c) 2016, 2023, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20201101 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class LoadSqlTuningSetDetails(object): + """ + The details required to load the Sql statements into the Sql tuning set. + """ + + #: A constant which can be used with the load_type property of a LoadSqlTuningSetDetails. + #: This constant has a value of "INCREMENTAL_CURSOR_CACHE" + LOAD_TYPE_INCREMENTAL_CURSOR_CACHE = "INCREMENTAL_CURSOR_CACHE" + + #: A constant which can be used with the load_type property of a LoadSqlTuningSetDetails. + #: This constant has a value of "CURRENT_CURSOR_CACHE" + LOAD_TYPE_CURRENT_CURSOR_CACHE = "CURRENT_CURSOR_CACHE" + + #: A constant which can be used with the load_type property of a LoadSqlTuningSetDetails. + #: This constant has a value of "AWR" + LOAD_TYPE_AWR = "AWR" + + #: A constant which can be used with the recursive_sql property of a LoadSqlTuningSetDetails. + #: This constant has a value of "HAS_RECURSIVE_SQL" + RECURSIVE_SQL_HAS_RECURSIVE_SQL = "HAS_RECURSIVE_SQL" + + #: A constant which can be used with the recursive_sql property of a LoadSqlTuningSetDetails. + #: This constant has a value of "NO_RECURSIVE_SQL" + RECURSIVE_SQL_NO_RECURSIVE_SQL = "NO_RECURSIVE_SQL" + + #: A constant which can be used with the ranking_measure1 property of a LoadSqlTuningSetDetails. + #: This constant has a value of "ELAPSED_TIME" + RANKING_MEASURE1_ELAPSED_TIME = "ELAPSED_TIME" + + #: A constant which can be used with the ranking_measure1 property of a LoadSqlTuningSetDetails. + #: This constant has a value of "CPU_TIME" + RANKING_MEASURE1_CPU_TIME = "CPU_TIME" + + #: A constant which can be used with the ranking_measure1 property of a LoadSqlTuningSetDetails. + #: This constant has a value of "OPTIMIZER_COST" + RANKING_MEASURE1_OPTIMIZER_COST = "OPTIMIZER_COST" + + #: A constant which can be used with the ranking_measure1 property of a LoadSqlTuningSetDetails. + #: This constant has a value of "BUFFER_GETS" + RANKING_MEASURE1_BUFFER_GETS = "BUFFER_GETS" + + #: A constant which can be used with the ranking_measure1 property of a LoadSqlTuningSetDetails. + #: This constant has a value of "DISK_READS" + RANKING_MEASURE1_DISK_READS = "DISK_READS" + + #: A constant which can be used with the ranking_measure1 property of a LoadSqlTuningSetDetails. + #: This constant has a value of "DIRECT_WRITES" + RANKING_MEASURE1_DIRECT_WRITES = "DIRECT_WRITES" + + #: A constant which can be used with the ranking_measure2 property of a LoadSqlTuningSetDetails. + #: This constant has a value of "ELAPSED_TIME" + RANKING_MEASURE2_ELAPSED_TIME = "ELAPSED_TIME" + + #: A constant which can be used with the ranking_measure2 property of a LoadSqlTuningSetDetails. + #: This constant has a value of "CPU_TIME" + RANKING_MEASURE2_CPU_TIME = "CPU_TIME" + + #: A constant which can be used with the ranking_measure2 property of a LoadSqlTuningSetDetails. + #: This constant has a value of "OPTIMIZER_COST" + RANKING_MEASURE2_OPTIMIZER_COST = "OPTIMIZER_COST" + + #: A constant which can be used with the ranking_measure2 property of a LoadSqlTuningSetDetails. + #: This constant has a value of "BUFFER_GETS" + RANKING_MEASURE2_BUFFER_GETS = "BUFFER_GETS" + + #: A constant which can be used with the ranking_measure2 property of a LoadSqlTuningSetDetails. + #: This constant has a value of "DISK_READS" + RANKING_MEASURE2_DISK_READS = "DISK_READS" + + #: A constant which can be used with the ranking_measure2 property of a LoadSqlTuningSetDetails. + #: This constant has a value of "DIRECT_WRITES" + RANKING_MEASURE2_DIRECT_WRITES = "DIRECT_WRITES" + + #: A constant which can be used with the ranking_measure3 property of a LoadSqlTuningSetDetails. + #: This constant has a value of "ELAPSED_TIME" + RANKING_MEASURE3_ELAPSED_TIME = "ELAPSED_TIME" + + #: A constant which can be used with the ranking_measure3 property of a LoadSqlTuningSetDetails. + #: This constant has a value of "CPU_TIME" + RANKING_MEASURE3_CPU_TIME = "CPU_TIME" + + #: A constant which can be used with the ranking_measure3 property of a LoadSqlTuningSetDetails. + #: This constant has a value of "OPTIMIZER_COST" + RANKING_MEASURE3_OPTIMIZER_COST = "OPTIMIZER_COST" + + #: A constant which can be used with the ranking_measure3 property of a LoadSqlTuningSetDetails. + #: This constant has a value of "BUFFER_GETS" + RANKING_MEASURE3_BUFFER_GETS = "BUFFER_GETS" + + #: A constant which can be used with the ranking_measure3 property of a LoadSqlTuningSetDetails. + #: This constant has a value of "DISK_READS" + RANKING_MEASURE3_DISK_READS = "DISK_READS" + + #: A constant which can be used with the ranking_measure3 property of a LoadSqlTuningSetDetails. + #: This constant has a value of "DIRECT_WRITES" + RANKING_MEASURE3_DIRECT_WRITES = "DIRECT_WRITES" + + #: A constant which can be used with the capture_option property of a LoadSqlTuningSetDetails. + #: This constant has a value of "INSERT" + CAPTURE_OPTION_INSERT = "INSERT" + + #: A constant which can be used with the capture_option property of a LoadSqlTuningSetDetails. + #: This constant has a value of "UPDATE" + CAPTURE_OPTION_UPDATE = "UPDATE" + + #: A constant which can be used with the capture_option property of a LoadSqlTuningSetDetails. + #: This constant has a value of "MERGE" + CAPTURE_OPTION_MERGE = "MERGE" + + #: A constant which can be used with the capture_mode property of a LoadSqlTuningSetDetails. + #: This constant has a value of "MODE_REPLACE_OLD_STATS" + CAPTURE_MODE_MODE_REPLACE_OLD_STATS = "MODE_REPLACE_OLD_STATS" + + #: A constant which can be used with the capture_mode property of a LoadSqlTuningSetDetails. + #: This constant has a value of "MODE_ACCUMULATE_STATS" + CAPTURE_MODE_MODE_ACCUMULATE_STATS = "MODE_ACCUMULATE_STATS" + + #: A constant which can be used with the load_option property of a LoadSqlTuningSetDetails. + #: This constant has a value of "INSERT" + LOAD_OPTION_INSERT = "INSERT" + + #: A constant which can be used with the load_option property of a LoadSqlTuningSetDetails. + #: This constant has a value of "UPDATE" + LOAD_OPTION_UPDATE = "UPDATE" + + #: A constant which can be used with the load_option property of a LoadSqlTuningSetDetails. + #: This constant has a value of "MERGE" + LOAD_OPTION_MERGE = "MERGE" + + #: A constant which can be used with the update_option property of a LoadSqlTuningSetDetails. + #: This constant has a value of "REPLACE" + UPDATE_OPTION_REPLACE = "REPLACE" + + #: A constant which can be used with the update_option property of a LoadSqlTuningSetDetails. + #: This constant has a value of "ACCUMULATE" + UPDATE_OPTION_ACCUMULATE = "ACCUMULATE" + + #: A constant which can be used with the update_condition property of a LoadSqlTuningSetDetails. + #: This constant has a value of "OLD" + UPDATE_CONDITION_OLD = "OLD" + + #: A constant which can be used with the update_condition property of a LoadSqlTuningSetDetails. + #: This constant has a value of "NEW" + UPDATE_CONDITION_NEW = "NEW" + + def __init__(self, **kwargs): + """ + Initializes a new LoadSqlTuningSetDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param credential_details: + The value to assign to the credential_details property of this LoadSqlTuningSetDetails. + :type credential_details: oci.database_management.models.SqlTuningSetAdminCredentialDetails + + :param show_sql_only: + The value to assign to the show_sql_only property of this LoadSqlTuningSetDetails. + :type show_sql_only: int + + :param owner: + The value to assign to the owner property of this LoadSqlTuningSetDetails. + :type owner: str + + :param name: + The value to assign to the name property of this LoadSqlTuningSetDetails. + :type name: str + + :param load_type: + The value to assign to the load_type property of this LoadSqlTuningSetDetails. + Allowed values for this property are: "INCREMENTAL_CURSOR_CACHE", "CURRENT_CURSOR_CACHE", "AWR" + :type load_type: str + + :param basic_filter: + The value to assign to the basic_filter property of this LoadSqlTuningSetDetails. + :type basic_filter: str + + :param recursive_sql: + The value to assign to the recursive_sql property of this LoadSqlTuningSetDetails. + Allowed values for this property are: "HAS_RECURSIVE_SQL", "NO_RECURSIVE_SQL" + :type recursive_sql: str + + :param result_percentage: + The value to assign to the result_percentage property of this LoadSqlTuningSetDetails. + :type result_percentage: float + + :param result_limit: + The value to assign to the result_limit property of this LoadSqlTuningSetDetails. + :type result_limit: int + + :param ranking_measure1: + The value to assign to the ranking_measure1 property of this LoadSqlTuningSetDetails. + Allowed values for this property are: "ELAPSED_TIME", "CPU_TIME", "OPTIMIZER_COST", "BUFFER_GETS", "DISK_READS", "DIRECT_WRITES" + :type ranking_measure1: str + + :param ranking_measure2: + The value to assign to the ranking_measure2 property of this LoadSqlTuningSetDetails. + Allowed values for this property are: "ELAPSED_TIME", "CPU_TIME", "OPTIMIZER_COST", "BUFFER_GETS", "DISK_READS", "DIRECT_WRITES" + :type ranking_measure2: str + + :param ranking_measure3: + The value to assign to the ranking_measure3 property of this LoadSqlTuningSetDetails. + Allowed values for this property are: "ELAPSED_TIME", "CPU_TIME", "OPTIMIZER_COST", "BUFFER_GETS", "DISK_READS", "DIRECT_WRITES" + :type ranking_measure3: str + + :param total_time_limit: + The value to assign to the total_time_limit property of this LoadSqlTuningSetDetails. + :type total_time_limit: int + + :param repeat_interval: + The value to assign to the repeat_interval property of this LoadSqlTuningSetDetails. + :type repeat_interval: int + + :param capture_option: + The value to assign to the capture_option property of this LoadSqlTuningSetDetails. + Allowed values for this property are: "INSERT", "UPDATE", "MERGE" + :type capture_option: str + + :param capture_mode: + The value to assign to the capture_mode property of this LoadSqlTuningSetDetails. + Allowed values for this property are: "MODE_REPLACE_OLD_STATS", "MODE_ACCUMULATE_STATS" + :type capture_mode: str + + :param attribute_list: + The value to assign to the attribute_list property of this LoadSqlTuningSetDetails. + :type attribute_list: str + + :param load_option: + The value to assign to the load_option property of this LoadSqlTuningSetDetails. + Allowed values for this property are: "INSERT", "UPDATE", "MERGE" + :type load_option: str + + :param update_option: + The value to assign to the update_option property of this LoadSqlTuningSetDetails. + Allowed values for this property are: "REPLACE", "ACCUMULATE" + :type update_option: str + + :param update_attributes: + The value to assign to the update_attributes property of this LoadSqlTuningSetDetails. + :type update_attributes: str + + :param update_condition: + The value to assign to the update_condition property of this LoadSqlTuningSetDetails. + Allowed values for this property are: "OLD", "NEW" + :type update_condition: str + + :param is_ignore_null: + The value to assign to the is_ignore_null property of this LoadSqlTuningSetDetails. + :type is_ignore_null: bool + + :param commit_rows: + The value to assign to the commit_rows property of this LoadSqlTuningSetDetails. + :type commit_rows: int + + :param begin_snapshot: + The value to assign to the begin_snapshot property of this LoadSqlTuningSetDetails. + :type begin_snapshot: int + + :param end_snapshot: + The value to assign to the end_snapshot property of this LoadSqlTuningSetDetails. + :type end_snapshot: int + + :param baseline_name: + The value to assign to the baseline_name property of this LoadSqlTuningSetDetails. + :type baseline_name: str + + """ + self.swagger_types = { + 'credential_details': 'SqlTuningSetAdminCredentialDetails', + 'show_sql_only': 'int', + 'owner': 'str', + 'name': 'str', + 'load_type': 'str', + 'basic_filter': 'str', + 'recursive_sql': 'str', + 'result_percentage': 'float', + 'result_limit': 'int', + 'ranking_measure1': 'str', + 'ranking_measure2': 'str', + 'ranking_measure3': 'str', + 'total_time_limit': 'int', + 'repeat_interval': 'int', + 'capture_option': 'str', + 'capture_mode': 'str', + 'attribute_list': 'str', + 'load_option': 'str', + 'update_option': 'str', + 'update_attributes': 'str', + 'update_condition': 'str', + 'is_ignore_null': 'bool', + 'commit_rows': 'int', + 'begin_snapshot': 'int', + 'end_snapshot': 'int', + 'baseline_name': 'str' + } + + self.attribute_map = { + 'credential_details': 'credentialDetails', + 'show_sql_only': 'showSqlOnly', + 'owner': 'owner', + 'name': 'name', + 'load_type': 'loadType', + 'basic_filter': 'basicFilter', + 'recursive_sql': 'recursiveSql', + 'result_percentage': 'resultPercentage', + 'result_limit': 'resultLimit', + 'ranking_measure1': 'rankingMeasure1', + 'ranking_measure2': 'rankingMeasure2', + 'ranking_measure3': 'rankingMeasure3', + 'total_time_limit': 'totalTimeLimit', + 'repeat_interval': 'repeatInterval', + 'capture_option': 'captureOption', + 'capture_mode': 'captureMode', + 'attribute_list': 'attributeList', + 'load_option': 'loadOption', + 'update_option': 'updateOption', + 'update_attributes': 'updateAttributes', + 'update_condition': 'updateCondition', + 'is_ignore_null': 'isIgnoreNull', + 'commit_rows': 'commitRows', + 'begin_snapshot': 'beginSnapshot', + 'end_snapshot': 'endSnapshot', + 'baseline_name': 'baselineName' + } + + self._credential_details = None + self._show_sql_only = None + self._owner = None + self._name = None + self._load_type = None + self._basic_filter = None + self._recursive_sql = None + self._result_percentage = None + self._result_limit = None + self._ranking_measure1 = None + self._ranking_measure2 = None + self._ranking_measure3 = None + self._total_time_limit = None + self._repeat_interval = None + self._capture_option = None + self._capture_mode = None + self._attribute_list = None + self._load_option = None + self._update_option = None + self._update_attributes = None + self._update_condition = None + self._is_ignore_null = None + self._commit_rows = None + self._begin_snapshot = None + self._end_snapshot = None + self._baseline_name = None + + @property + def credential_details(self): + """ + **[Required]** Gets the credential_details of this LoadSqlTuningSetDetails. + + :return: The credential_details of this LoadSqlTuningSetDetails. + :rtype: oci.database_management.models.SqlTuningSetAdminCredentialDetails + """ + return self._credential_details + + @credential_details.setter + def credential_details(self, credential_details): + """ + Sets the credential_details of this LoadSqlTuningSetDetails. + + :param credential_details: The credential_details of this LoadSqlTuningSetDetails. + :type: oci.database_management.models.SqlTuningSetAdminCredentialDetails + """ + self._credential_details = credential_details + + @property + def show_sql_only(self): + """ + Gets the show_sql_only of this LoadSqlTuningSetDetails. + Flag to indicate whether to create the Sql tuning set or just display the plsql used to create Sql tuning set. + + + :return: The show_sql_only of this LoadSqlTuningSetDetails. + :rtype: int + """ + return self._show_sql_only + + @show_sql_only.setter + def show_sql_only(self, show_sql_only): + """ + Sets the show_sql_only of this LoadSqlTuningSetDetails. + Flag to indicate whether to create the Sql tuning set or just display the plsql used to create Sql tuning set. + + + :param show_sql_only: The show_sql_only of this LoadSqlTuningSetDetails. + :type: int + """ + self._show_sql_only = show_sql_only + + @property + def owner(self): + """ + Gets the owner of this LoadSqlTuningSetDetails. + The owner of the Sql tuning set. + + + :return: The owner of this LoadSqlTuningSetDetails. + :rtype: str + """ + return self._owner + + @owner.setter + def owner(self, owner): + """ + Sets the owner of this LoadSqlTuningSetDetails. + The owner of the Sql tuning set. + + + :param owner: The owner of this LoadSqlTuningSetDetails. + :type: str + """ + self._owner = owner + + @property + def name(self): + """ + **[Required]** Gets the name of this LoadSqlTuningSetDetails. + The name of the Sql tuning set. + + + :return: The name of this LoadSqlTuningSetDetails. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this LoadSqlTuningSetDetails. + The name of the Sql tuning set. + + + :param name: The name of this LoadSqlTuningSetDetails. + :type: str + """ + self._name = name + + @property + def load_type(self): + """ + **[Required]** Gets the load_type of this LoadSqlTuningSetDetails. + Specifies the loading method into the Sql tuning set. + + Allowed values for this property are: "INCREMENTAL_CURSOR_CACHE", "CURRENT_CURSOR_CACHE", "AWR" + + + :return: The load_type of this LoadSqlTuningSetDetails. + :rtype: str + """ + return self._load_type + + @load_type.setter + def load_type(self, load_type): + """ + Sets the load_type of this LoadSqlTuningSetDetails. + Specifies the loading method into the Sql tuning set. + + + :param load_type: The load_type of this LoadSqlTuningSetDetails. + :type: str + """ + allowed_values = ["INCREMENTAL_CURSOR_CACHE", "CURRENT_CURSOR_CACHE", "AWR"] + if not value_allowed_none_or_none_sentinel(load_type, allowed_values): + raise ValueError( + "Invalid value for `load_type`, must be None or one of {0}" + .format(allowed_values) + ) + self._load_type = load_type + + @property + def basic_filter(self): + """ + Gets the basic_filter of this LoadSqlTuningSetDetails. + Specifies the Sql predicate to filter the Sql from the Sql tuning set defined on attributes of the SQLSET_ROW. + User could use any combination of the following columns with appropriate values as Sql predicate + Refer to the documentation https://docs.oracle.com/en/database/oracle/oracle-database/18/arpls/DBMS_SQLTUNE.html#GUID-1F4AFB03-7B29-46FC-B3F2-CB01EC36326C + + + :return: The basic_filter of this LoadSqlTuningSetDetails. + :rtype: str + """ + return self._basic_filter + + @basic_filter.setter + def basic_filter(self, basic_filter): + """ + Sets the basic_filter of this LoadSqlTuningSetDetails. + Specifies the Sql predicate to filter the Sql from the Sql tuning set defined on attributes of the SQLSET_ROW. + User could use any combination of the following columns with appropriate values as Sql predicate + Refer to the documentation https://docs.oracle.com/en/database/oracle/oracle-database/18/arpls/DBMS_SQLTUNE.html#GUID-1F4AFB03-7B29-46FC-B3F2-CB01EC36326C + + + :param basic_filter: The basic_filter of this LoadSqlTuningSetDetails. + :type: str + """ + self._basic_filter = basic_filter + + @property + def recursive_sql(self): + """ + Gets the recursive_sql of this LoadSqlTuningSetDetails. + Specifies that the filter must include recursive Sql in the Sql tuning set. + + Allowed values for this property are: "HAS_RECURSIVE_SQL", "NO_RECURSIVE_SQL" + + + :return: The recursive_sql of this LoadSqlTuningSetDetails. + :rtype: str + """ + return self._recursive_sql + + @recursive_sql.setter + def recursive_sql(self, recursive_sql): + """ + Sets the recursive_sql of this LoadSqlTuningSetDetails. + Specifies that the filter must include recursive Sql in the Sql tuning set. + + + :param recursive_sql: The recursive_sql of this LoadSqlTuningSetDetails. + :type: str + """ + allowed_values = ["HAS_RECURSIVE_SQL", "NO_RECURSIVE_SQL"] + if not value_allowed_none_or_none_sentinel(recursive_sql, allowed_values): + raise ValueError( + "Invalid value for `recursive_sql`, must be None or one of {0}" + .format(allowed_values) + ) + self._recursive_sql = recursive_sql + + @property + def result_percentage(self): + """ + Gets the result_percentage of this LoadSqlTuningSetDetails. + Specifies a filter that picks the top n% according to the supplied ranking measure. + Note that this parameter applies only if one ranking measure is supplied. + + + :return: The result_percentage of this LoadSqlTuningSetDetails. + :rtype: float + """ + return self._result_percentage + + @result_percentage.setter + def result_percentage(self, result_percentage): + """ + Sets the result_percentage of this LoadSqlTuningSetDetails. + Specifies a filter that picks the top n% according to the supplied ranking measure. + Note that this parameter applies only if one ranking measure is supplied. + + + :param result_percentage: The result_percentage of this LoadSqlTuningSetDetails. + :type: float + """ + self._result_percentage = result_percentage + + @property + def result_limit(self): + """ + Gets the result_limit of this LoadSqlTuningSetDetails. + The top limit Sql from the filtered source, ranked by the ranking measure. + + + :return: The result_limit of this LoadSqlTuningSetDetails. + :rtype: int + """ + return self._result_limit + + @result_limit.setter + def result_limit(self, result_limit): + """ + Sets the result_limit of this LoadSqlTuningSetDetails. + The top limit Sql from the filtered source, ranked by the ranking measure. + + + :param result_limit: The result_limit of this LoadSqlTuningSetDetails. + :type: int + """ + self._result_limit = result_limit + + @property + def ranking_measure1(self): + """ + Gets the ranking_measure1 of this LoadSqlTuningSetDetails. + Specifies an ORDER BY clause on the selected Sql. User can specify upto three ranking measures. + + Allowed values for this property are: "ELAPSED_TIME", "CPU_TIME", "OPTIMIZER_COST", "BUFFER_GETS", "DISK_READS", "DIRECT_WRITES" + + + :return: The ranking_measure1 of this LoadSqlTuningSetDetails. + :rtype: str + """ + return self._ranking_measure1 + + @ranking_measure1.setter + def ranking_measure1(self, ranking_measure1): + """ + Sets the ranking_measure1 of this LoadSqlTuningSetDetails. + Specifies an ORDER BY clause on the selected Sql. User can specify upto three ranking measures. + + + :param ranking_measure1: The ranking_measure1 of this LoadSqlTuningSetDetails. + :type: str + """ + allowed_values = ["ELAPSED_TIME", "CPU_TIME", "OPTIMIZER_COST", "BUFFER_GETS", "DISK_READS", "DIRECT_WRITES"] + if not value_allowed_none_or_none_sentinel(ranking_measure1, allowed_values): + raise ValueError( + "Invalid value for `ranking_measure1`, must be None or one of {0}" + .format(allowed_values) + ) + self._ranking_measure1 = ranking_measure1 + + @property + def ranking_measure2(self): + """ + Gets the ranking_measure2 of this LoadSqlTuningSetDetails. + Specifies an ORDER BY clause on the selected Sql. User can specify upto three ranking measures. + + Allowed values for this property are: "ELAPSED_TIME", "CPU_TIME", "OPTIMIZER_COST", "BUFFER_GETS", "DISK_READS", "DIRECT_WRITES" + + + :return: The ranking_measure2 of this LoadSqlTuningSetDetails. + :rtype: str + """ + return self._ranking_measure2 + + @ranking_measure2.setter + def ranking_measure2(self, ranking_measure2): + """ + Sets the ranking_measure2 of this LoadSqlTuningSetDetails. + Specifies an ORDER BY clause on the selected Sql. User can specify upto three ranking measures. + + + :param ranking_measure2: The ranking_measure2 of this LoadSqlTuningSetDetails. + :type: str + """ + allowed_values = ["ELAPSED_TIME", "CPU_TIME", "OPTIMIZER_COST", "BUFFER_GETS", "DISK_READS", "DIRECT_WRITES"] + if not value_allowed_none_or_none_sentinel(ranking_measure2, allowed_values): + raise ValueError( + "Invalid value for `ranking_measure2`, must be None or one of {0}" + .format(allowed_values) + ) + self._ranking_measure2 = ranking_measure2 + + @property + def ranking_measure3(self): + """ + Gets the ranking_measure3 of this LoadSqlTuningSetDetails. + Specifies an ORDER BY clause on the selected Sql. User can specify upto three ranking measures. + + Allowed values for this property are: "ELAPSED_TIME", "CPU_TIME", "OPTIMIZER_COST", "BUFFER_GETS", "DISK_READS", "DIRECT_WRITES" + + + :return: The ranking_measure3 of this LoadSqlTuningSetDetails. + :rtype: str + """ + return self._ranking_measure3 + + @ranking_measure3.setter + def ranking_measure3(self, ranking_measure3): + """ + Sets the ranking_measure3 of this LoadSqlTuningSetDetails. + Specifies an ORDER BY clause on the selected Sql. User can specify upto three ranking measures. + + + :param ranking_measure3: The ranking_measure3 of this LoadSqlTuningSetDetails. + :type: str + """ + allowed_values = ["ELAPSED_TIME", "CPU_TIME", "OPTIMIZER_COST", "BUFFER_GETS", "DISK_READS", "DIRECT_WRITES"] + if not value_allowed_none_or_none_sentinel(ranking_measure3, allowed_values): + raise ValueError( + "Invalid value for `ranking_measure3`, must be None or one of {0}" + .format(allowed_values) + ) + self._ranking_measure3 = ranking_measure3 + + @property + def total_time_limit(self): + """ + Gets the total_time_limit of this LoadSqlTuningSetDetails. + Defines the total amount of time, in seconds, to execute. + + + :return: The total_time_limit of this LoadSqlTuningSetDetails. + :rtype: int + """ + return self._total_time_limit + + @total_time_limit.setter + def total_time_limit(self, total_time_limit): + """ + Sets the total_time_limit of this LoadSqlTuningSetDetails. + Defines the total amount of time, in seconds, to execute. + + + :param total_time_limit: The total_time_limit of this LoadSqlTuningSetDetails. + :type: int + """ + self._total_time_limit = total_time_limit + + @property + def repeat_interval(self): + """ + Gets the repeat_interval of this LoadSqlTuningSetDetails. + Defines the amount of time, in seconds, to pause between sampling. + + + :return: The repeat_interval of this LoadSqlTuningSetDetails. + :rtype: int + """ + return self._repeat_interval + + @repeat_interval.setter + def repeat_interval(self, repeat_interval): + """ + Sets the repeat_interval of this LoadSqlTuningSetDetails. + Defines the amount of time, in seconds, to pause between sampling. + + + :param repeat_interval: The repeat_interval of this LoadSqlTuningSetDetails. + :type: int + """ + self._repeat_interval = repeat_interval + + @property + def capture_option(self): + """ + Gets the capture_option of this LoadSqlTuningSetDetails. + Specifies whether to insert new statements, update existing statements, or both. + + Allowed values for this property are: "INSERT", "UPDATE", "MERGE" + + + :return: The capture_option of this LoadSqlTuningSetDetails. + :rtype: str + """ + return self._capture_option + + @capture_option.setter + def capture_option(self, capture_option): + """ + Sets the capture_option of this LoadSqlTuningSetDetails. + Specifies whether to insert new statements, update existing statements, or both. + + + :param capture_option: The capture_option of this LoadSqlTuningSetDetails. + :type: str + """ + allowed_values = ["INSERT", "UPDATE", "MERGE"] + if not value_allowed_none_or_none_sentinel(capture_option, allowed_values): + raise ValueError( + "Invalid value for `capture_option`, must be None or one of {0}" + .format(allowed_values) + ) + self._capture_option = capture_option + + @property + def capture_mode(self): + """ + Gets the capture_mode of this LoadSqlTuningSetDetails. + Specifies the capture mode. Note that this parameter is applicable only for UPDATE and MERGE capture options. + Capture mode can take one of the following values + - MODE_REPLACE_OLD_STATS + Replaces statistics when the number of executions is greater than the number stored in the Sql tuning set + - MODE_ACCUMULATE_STATS + Adds new values to current values for Sql that is already stored. + Note that this mode detects if a statement has been aged out, so the final value for a statistics is the sum of the statistics of all cursors that statement existed under. + + Allowed values for this property are: "MODE_REPLACE_OLD_STATS", "MODE_ACCUMULATE_STATS" + + + :return: The capture_mode of this LoadSqlTuningSetDetails. + :rtype: str + """ + return self._capture_mode + + @capture_mode.setter + def capture_mode(self, capture_mode): + """ + Sets the capture_mode of this LoadSqlTuningSetDetails. + Specifies the capture mode. Note that this parameter is applicable only for UPDATE and MERGE capture options. + Capture mode can take one of the following values + - MODE_REPLACE_OLD_STATS + Replaces statistics when the number of executions is greater than the number stored in the Sql tuning set + - MODE_ACCUMULATE_STATS + Adds new values to current values for Sql that is already stored. + Note that this mode detects if a statement has been aged out, so the final value for a statistics is the sum of the statistics of all cursors that statement existed under. + + + :param capture_mode: The capture_mode of this LoadSqlTuningSetDetails. + :type: str + """ + allowed_values = ["MODE_REPLACE_OLD_STATS", "MODE_ACCUMULATE_STATS"] + if not value_allowed_none_or_none_sentinel(capture_mode, allowed_values): + raise ValueError( + "Invalid value for `capture_mode`, must be None or one of {0}" + .format(allowed_values) + ) + self._capture_mode = capture_mode + + @property + def attribute_list(self): + """ + Gets the attribute_list of this LoadSqlTuningSetDetails. + Specifies the list of Sql statement attributes to return in the result. + Note that this parameter cannot be made an enum since custom value can take a list of comma separated attribute names. + Attribute list can take one of the following values. + TYPICAL - Specifies BASIC plus Sql plan (without row source statistics) and without object reference list (default). + BASIC - Specifies all attributes (such as execution statistics and binds) except the plans. The execution context is always part of the result. + ALL - Specifies all attributes. + CUSTOM - Comma-separated list of the following attribute names. + - EXECUTION_STATISTICS + - BIND_LIST + - OBJECT_LIST + - SQL_PLAN + - SQL_PLAN_STATISTICS + Usage examples: + 1. \"attributeList\": \"TYPICAL\" + 2. \"attributeList\": \"ALL\" + 3. \"attributeList\": \"EXECUTION_STATISTICS,OBJECT_LIST,SQL_PLAN\" + + + :return: The attribute_list of this LoadSqlTuningSetDetails. + :rtype: str + """ + return self._attribute_list + + @attribute_list.setter + def attribute_list(self, attribute_list): + """ + Sets the attribute_list of this LoadSqlTuningSetDetails. + Specifies the list of Sql statement attributes to return in the result. + Note that this parameter cannot be made an enum since custom value can take a list of comma separated attribute names. + Attribute list can take one of the following values. + TYPICAL - Specifies BASIC plus Sql plan (without row source statistics) and without object reference list (default). + BASIC - Specifies all attributes (such as execution statistics and binds) except the plans. The execution context is always part of the result. + ALL - Specifies all attributes. + CUSTOM - Comma-separated list of the following attribute names. + - EXECUTION_STATISTICS + - BIND_LIST + - OBJECT_LIST + - SQL_PLAN + - SQL_PLAN_STATISTICS + Usage examples: + 1. \"attributeList\": \"TYPICAL\" + 2. \"attributeList\": \"ALL\" + 3. \"attributeList\": \"EXECUTION_STATISTICS,OBJECT_LIST,SQL_PLAN\" + + + :param attribute_list: The attribute_list of this LoadSqlTuningSetDetails. + :type: str + """ + self._attribute_list = attribute_list + + @property + def load_option(self): + """ + Gets the load_option of this LoadSqlTuningSetDetails. + Specifies which statements are loaded into the Sql tuning set. + The possible values are. + - INSERT (default) + Adds only new statements. + - UPDATE + Updates existing the Sql statements and ignores any new statements. + - MERGE + Inserts new statements and updates the information of the existing ones. + + Allowed values for this property are: "INSERT", "UPDATE", "MERGE" + + + :return: The load_option of this LoadSqlTuningSetDetails. + :rtype: str + """ + return self._load_option + + @load_option.setter + def load_option(self, load_option): + """ + Sets the load_option of this LoadSqlTuningSetDetails. + Specifies which statements are loaded into the Sql tuning set. + The possible values are. + - INSERT (default) + Adds only new statements. + - UPDATE + Updates existing the Sql statements and ignores any new statements. + - MERGE + Inserts new statements and updates the information of the existing ones. + + + :param load_option: The load_option of this LoadSqlTuningSetDetails. + :type: str + """ + allowed_values = ["INSERT", "UPDATE", "MERGE"] + if not value_allowed_none_or_none_sentinel(load_option, allowed_values): + raise ValueError( + "Invalid value for `load_option`, must be None or one of {0}" + .format(allowed_values) + ) + self._load_option = load_option + + @property + def update_option(self): + """ + Gets the update_option of this LoadSqlTuningSetDetails. + Specifies how existing Sql statements are updated. + This parameter is applicable only if load_option is specified with UPDATE or MERGE as an option. + Update option can take one of the following values. + REPLACE (default) - Updates the statement using the new statistics, bind list, object list, and so on. + ACCUMULATE - Combines attributes when possible (for example, statistics such as elapsed_time), otherwise replaces the existing values (for example, module and action) with the provided values. + Following Sql statement attributes can be accumulated. + elapsed_time + buffer_gets + direct_writes + disk_reads + row_processed + fetches + executions + end_of_fetch_count + stat_period + active_stat_period + + Allowed values for this property are: "REPLACE", "ACCUMULATE" + + + :return: The update_option of this LoadSqlTuningSetDetails. + :rtype: str + """ + return self._update_option + + @update_option.setter + def update_option(self, update_option): + """ + Sets the update_option of this LoadSqlTuningSetDetails. + Specifies how existing Sql statements are updated. + This parameter is applicable only if load_option is specified with UPDATE or MERGE as an option. + Update option can take one of the following values. + REPLACE (default) - Updates the statement using the new statistics, bind list, object list, and so on. + ACCUMULATE - Combines attributes when possible (for example, statistics such as elapsed_time), otherwise replaces the existing values (for example, module and action) with the provided values. + Following Sql statement attributes can be accumulated. + elapsed_time + buffer_gets + direct_writes + disk_reads + row_processed + fetches + executions + end_of_fetch_count + stat_period + active_stat_period + + + :param update_option: The update_option of this LoadSqlTuningSetDetails. + :type: str + """ + allowed_values = ["REPLACE", "ACCUMULATE"] + if not value_allowed_none_or_none_sentinel(update_option, allowed_values): + raise ValueError( + "Invalid value for `update_option`, must be None or one of {0}" + .format(allowed_values) + ) + self._update_option = update_option + + @property + def update_attributes(self): + """ + Gets the update_attributes of this LoadSqlTuningSetDetails. + Specifies the list of Sql statement attributes to update during a merge or update. + Note that this parameter cannot be made an enum since custom value can take a list of comma separated attribute names. + Update attributes can take one of the following values. + NULL (default) - Specifies the content of the input cursor except the execution context. On other terms, it is equivalent to ALL without execution contexts such as module and action. + BASIC - Specifies statistics and binds only. + TYPICAL - Specifies BASIC with Sql plans (without row source statistics) and without an object reference list. + ALL - Specifies all attributes, including the execution context attributes such as module and action. + CUSTOM - List of comma separated attribute names to update + EXECUTION_CONTEXT + EXECUTION_STATISTICS + SQL_BINDS + SQL_PLAN + SQL_PLAN_STATISTICS (similar to SQL_PLAN with added row source statistics) + Usage examples: + 1. \"updateAttributes\": \"TYPICAL\" + 2. \"updateAttributes\": \"BASIC\" + 3. \"updateAttributes\": \"EXECUTION_STATISTICS,SQL_PLAN_STATISTICS,SQL_PLAN\" + 4. \"updateAttributes\": \"EXECUTION_STATISTICS,SQL_PLAN\" + + + :return: The update_attributes of this LoadSqlTuningSetDetails. + :rtype: str + """ + return self._update_attributes + + @update_attributes.setter + def update_attributes(self, update_attributes): + """ + Sets the update_attributes of this LoadSqlTuningSetDetails. + Specifies the list of Sql statement attributes to update during a merge or update. + Note that this parameter cannot be made an enum since custom value can take a list of comma separated attribute names. + Update attributes can take one of the following values. + NULL (default) - Specifies the content of the input cursor except the execution context. On other terms, it is equivalent to ALL without execution contexts such as module and action. + BASIC - Specifies statistics and binds only. + TYPICAL - Specifies BASIC with Sql plans (without row source statistics) and without an object reference list. + ALL - Specifies all attributes, including the execution context attributes such as module and action. + CUSTOM - List of comma separated attribute names to update + EXECUTION_CONTEXT + EXECUTION_STATISTICS + SQL_BINDS + SQL_PLAN + SQL_PLAN_STATISTICS (similar to SQL_PLAN with added row source statistics) + Usage examples: + 1. \"updateAttributes\": \"TYPICAL\" + 2. \"updateAttributes\": \"BASIC\" + 3. \"updateAttributes\": \"EXECUTION_STATISTICS,SQL_PLAN_STATISTICS,SQL_PLAN\" + 4. \"updateAttributes\": \"EXECUTION_STATISTICS,SQL_PLAN\" + + + :param update_attributes: The update_attributes of this LoadSqlTuningSetDetails. + :type: str + """ + self._update_attributes = update_attributes + + @property + def update_condition(self): + """ + Gets the update_condition of this LoadSqlTuningSetDetails. + Specifies when to perform the update. + The procedure only performs the update when the specified condition is satisfied. + The condition can refer to either the data source or destination. + The condition must use the following prefixes to refer to attributes from the source or the destination: + OLD \u2014 Refers to statement attributes from the SQL tuning set (destination). + NEW \u2014 Refers to statement attributes from the input statements (source). + NULL \u2014 No updates are performed. + + Allowed values for this property are: "OLD", "NEW" + + + :return: The update_condition of this LoadSqlTuningSetDetails. + :rtype: str + """ + return self._update_condition + + @update_condition.setter + def update_condition(self, update_condition): + """ + Sets the update_condition of this LoadSqlTuningSetDetails. + Specifies when to perform the update. + The procedure only performs the update when the specified condition is satisfied. + The condition can refer to either the data source or destination. + The condition must use the following prefixes to refer to attributes from the source or the destination: + OLD \u2014 Refers to statement attributes from the SQL tuning set (destination). + NEW \u2014 Refers to statement attributes from the input statements (source). + NULL \u2014 No updates are performed. + + + :param update_condition: The update_condition of this LoadSqlTuningSetDetails. + :type: str + """ + allowed_values = ["OLD", "NEW"] + if not value_allowed_none_or_none_sentinel(update_condition, allowed_values): + raise ValueError( + "Invalid value for `update_condition`, must be None or one of {0}" + .format(allowed_values) + ) + self._update_condition = update_condition + + @property + def is_ignore_null(self): + """ + Gets the is_ignore_null of this LoadSqlTuningSetDetails. + Specifies whether to update attributes when the new value is NULL. + If TRUE, then the procedure does not update an attribute when the new value is NULL. + That is, do not override with NULL values unless intentional. + Possible values - true or false + + + :return: The is_ignore_null of this LoadSqlTuningSetDetails. + :rtype: bool + """ + return self._is_ignore_null + + @is_ignore_null.setter + def is_ignore_null(self, is_ignore_null): + """ + Sets the is_ignore_null of this LoadSqlTuningSetDetails. + Specifies whether to update attributes when the new value is NULL. + If TRUE, then the procedure does not update an attribute when the new value is NULL. + That is, do not override with NULL values unless intentional. + Possible values - true or false + + + :param is_ignore_null: The is_ignore_null of this LoadSqlTuningSetDetails. + :type: bool + """ + self._is_ignore_null = is_ignore_null + + @property + def commit_rows(self): + """ + Gets the commit_rows of this LoadSqlTuningSetDetails. + Specifies whether to commit statements after DML. + If a value is provided, then the load commits after each specified number of statements is inserted. + If NULL is provided, then the load commits only once, at the end of the operation. + + + :return: The commit_rows of this LoadSqlTuningSetDetails. + :rtype: int + """ + return self._commit_rows + + @commit_rows.setter + def commit_rows(self, commit_rows): + """ + Sets the commit_rows of this LoadSqlTuningSetDetails. + Specifies whether to commit statements after DML. + If a value is provided, then the load commits after each specified number of statements is inserted. + If NULL is provided, then the load commits only once, at the end of the operation. + + + :param commit_rows: The commit_rows of this LoadSqlTuningSetDetails. + :type: int + """ + self._commit_rows = commit_rows + + @property + def begin_snapshot(self): + """ + Gets the begin_snapshot of this LoadSqlTuningSetDetails. + Defines the beginning AWR snapshot (non-inclusive). + + + :return: The begin_snapshot of this LoadSqlTuningSetDetails. + :rtype: int + """ + return self._begin_snapshot + + @begin_snapshot.setter + def begin_snapshot(self, begin_snapshot): + """ + Sets the begin_snapshot of this LoadSqlTuningSetDetails. + Defines the beginning AWR snapshot (non-inclusive). + + + :param begin_snapshot: The begin_snapshot of this LoadSqlTuningSetDetails. + :type: int + """ + self._begin_snapshot = begin_snapshot + + @property + def end_snapshot(self): + """ + Gets the end_snapshot of this LoadSqlTuningSetDetails. + Defines the ending AWR snapshot (inclusive). + + + :return: The end_snapshot of this LoadSqlTuningSetDetails. + :rtype: int + """ + return self._end_snapshot + + @end_snapshot.setter + def end_snapshot(self, end_snapshot): + """ + Sets the end_snapshot of this LoadSqlTuningSetDetails. + Defines the ending AWR snapshot (inclusive). + + + :param end_snapshot: The end_snapshot of this LoadSqlTuningSetDetails. + :type: int + """ + self._end_snapshot = end_snapshot + + @property + def baseline_name(self): + """ + Gets the baseline_name of this LoadSqlTuningSetDetails. + Specifies the name of the AWR baseline period. + When loading the sql statements from AWR, following inputs has to be provided: + beginSnapshot and endSnapshot + OR + baselineName + + + :return: The baseline_name of this LoadSqlTuningSetDetails. + :rtype: str + """ + return self._baseline_name + + @baseline_name.setter + def baseline_name(self, baseline_name): + """ + Sets the baseline_name of this LoadSqlTuningSetDetails. + Specifies the name of the AWR baseline period. + When loading the sql statements from AWR, following inputs has to be provided: + beginSnapshot and endSnapshot + OR + baselineName + + + :param baseline_name: The baseline_name of this LoadSqlTuningSetDetails. + :type: str + """ + self._baseline_name = baseline_name + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/database_management/models/modify_snapshot_settings_details.py b/src/oci/database_management/models/modify_snapshot_settings_details.py new file mode 100644 index 0000000000..1b17bf6d4c --- /dev/null +++ b/src/oci/database_management/models/modify_snapshot_settings_details.py @@ -0,0 +1,103 @@ +# coding: utf-8 +# Copyright (c) 2016, 2023, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20201101 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ModifySnapshotSettingsDetails(object): + """ + Details to modify the AWR snapshot settings for a database. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ModifySnapshotSettingsDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param retention: + The value to assign to the retention property of this ModifySnapshotSettingsDetails. + :type retention: int + + :param interval: + The value to assign to the interval property of this ModifySnapshotSettingsDetails. + :type interval: int + + """ + self.swagger_types = { + 'retention': 'int', + 'interval': 'int' + } + + self.attribute_map = { + 'retention': 'retention', + 'interval': 'interval' + } + + self._retention = None + self._interval = None + + @property + def retention(self): + """ + Gets the retention of this ModifySnapshotSettingsDetails. + The retention time in minutes. Acceptable values are 0, 1440 to 52596000 (inclusive), and null. + + + :return: The retention of this ModifySnapshotSettingsDetails. + :rtype: int + """ + return self._retention + + @retention.setter + def retention(self, retention): + """ + Sets the retention of this ModifySnapshotSettingsDetails. + The retention time in minutes. Acceptable values are 0, 1440 to 52596000 (inclusive), and null. + + + :param retention: The retention of this ModifySnapshotSettingsDetails. + :type: int + """ + self._retention = retention + + @property + def interval(self): + """ + Gets the interval of this ModifySnapshotSettingsDetails. + The interval time in minutes. Acceptable values are 0, 10 to 527040 (inclusive), and null. + + + :return: The interval of this ModifySnapshotSettingsDetails. + :rtype: int + """ + return self._interval + + @interval.setter + def interval(self, interval): + """ + Sets the interval of this ModifySnapshotSettingsDetails. + The interval time in minutes. Acceptable values are 0, 10 to 527040 (inclusive), and null. + + + :param interval: The interval of this ModifySnapshotSettingsDetails. + :type: int + """ + self._interval = interval + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/database_management/models/save_sql_tuning_set_as_details.py b/src/oci/database_management/models/save_sql_tuning_set_as_details.py new file mode 100644 index 0000000000..3fa80642d7 --- /dev/null +++ b/src/oci/database_management/models/save_sql_tuning_set_as_details.py @@ -0,0 +1,1112 @@ +# coding: utf-8 +# Copyright (c) 2016, 2023, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20201101 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class SaveSqlTuningSetAsDetails(object): + """ + Save current list of Sql statements into another Sql tuning set. + """ + + #: A constant which can be used with the plan_filter property of a SaveSqlTuningSetAsDetails. + #: This constant has a value of "LAST_GENERATED" + PLAN_FILTER_LAST_GENERATED = "LAST_GENERATED" + + #: A constant which can be used with the plan_filter property of a SaveSqlTuningSetAsDetails. + #: This constant has a value of "FIRST_GENERATED" + PLAN_FILTER_FIRST_GENERATED = "FIRST_GENERATED" + + #: A constant which can be used with the plan_filter property of a SaveSqlTuningSetAsDetails. + #: This constant has a value of "LAST_LOADED" + PLAN_FILTER_LAST_LOADED = "LAST_LOADED" + + #: A constant which can be used with the plan_filter property of a SaveSqlTuningSetAsDetails. + #: This constant has a value of "FIRST_LOADED" + PLAN_FILTER_FIRST_LOADED = "FIRST_LOADED" + + #: A constant which can be used with the plan_filter property of a SaveSqlTuningSetAsDetails. + #: This constant has a value of "MAX_ELAPSED_TIME" + PLAN_FILTER_MAX_ELAPSED_TIME = "MAX_ELAPSED_TIME" + + #: A constant which can be used with the plan_filter property of a SaveSqlTuningSetAsDetails. + #: This constant has a value of "MAX_BUFFER_GETS" + PLAN_FILTER_MAX_BUFFER_GETS = "MAX_BUFFER_GETS" + + #: A constant which can be used with the plan_filter property of a SaveSqlTuningSetAsDetails. + #: This constant has a value of "MAX_DISK_READS" + PLAN_FILTER_MAX_DISK_READS = "MAX_DISK_READS" + + #: A constant which can be used with the plan_filter property of a SaveSqlTuningSetAsDetails. + #: This constant has a value of "MAX_DIRECT_WRITES" + PLAN_FILTER_MAX_DIRECT_WRITES = "MAX_DIRECT_WRITES" + + #: A constant which can be used with the plan_filter property of a SaveSqlTuningSetAsDetails. + #: This constant has a value of "MAX_OPTIMIZER_COST" + PLAN_FILTER_MAX_OPTIMIZER_COST = "MAX_OPTIMIZER_COST" + + #: A constant which can be used with the recursive_sql property of a SaveSqlTuningSetAsDetails. + #: This constant has a value of "HAS_RECURSIVE_SQL" + RECURSIVE_SQL_HAS_RECURSIVE_SQL = "HAS_RECURSIVE_SQL" + + #: A constant which can be used with the recursive_sql property of a SaveSqlTuningSetAsDetails. + #: This constant has a value of "NO_RECURSIVE_SQL" + RECURSIVE_SQL_NO_RECURSIVE_SQL = "NO_RECURSIVE_SQL" + + #: A constant which can be used with the ranking_measure1 property of a SaveSqlTuningSetAsDetails. + #: This constant has a value of "ELAPSED_TIME" + RANKING_MEASURE1_ELAPSED_TIME = "ELAPSED_TIME" + + #: A constant which can be used with the ranking_measure1 property of a SaveSqlTuningSetAsDetails. + #: This constant has a value of "CPU_TIME" + RANKING_MEASURE1_CPU_TIME = "CPU_TIME" + + #: A constant which can be used with the ranking_measure1 property of a SaveSqlTuningSetAsDetails. + #: This constant has a value of "OPTIMIZER_COST" + RANKING_MEASURE1_OPTIMIZER_COST = "OPTIMIZER_COST" + + #: A constant which can be used with the ranking_measure1 property of a SaveSqlTuningSetAsDetails. + #: This constant has a value of "BUFFER_GETS" + RANKING_MEASURE1_BUFFER_GETS = "BUFFER_GETS" + + #: A constant which can be used with the ranking_measure1 property of a SaveSqlTuningSetAsDetails. + #: This constant has a value of "DISK_READS" + RANKING_MEASURE1_DISK_READS = "DISK_READS" + + #: A constant which can be used with the ranking_measure1 property of a SaveSqlTuningSetAsDetails. + #: This constant has a value of "DIRECT_WRITES" + RANKING_MEASURE1_DIRECT_WRITES = "DIRECT_WRITES" + + #: A constant which can be used with the ranking_measure2 property of a SaveSqlTuningSetAsDetails. + #: This constant has a value of "ELAPSED_TIME" + RANKING_MEASURE2_ELAPSED_TIME = "ELAPSED_TIME" + + #: A constant which can be used with the ranking_measure2 property of a SaveSqlTuningSetAsDetails. + #: This constant has a value of "CPU_TIME" + RANKING_MEASURE2_CPU_TIME = "CPU_TIME" + + #: A constant which can be used with the ranking_measure2 property of a SaveSqlTuningSetAsDetails. + #: This constant has a value of "OPTIMIZER_COST" + RANKING_MEASURE2_OPTIMIZER_COST = "OPTIMIZER_COST" + + #: A constant which can be used with the ranking_measure2 property of a SaveSqlTuningSetAsDetails. + #: This constant has a value of "BUFFER_GETS" + RANKING_MEASURE2_BUFFER_GETS = "BUFFER_GETS" + + #: A constant which can be used with the ranking_measure2 property of a SaveSqlTuningSetAsDetails. + #: This constant has a value of "DISK_READS" + RANKING_MEASURE2_DISK_READS = "DISK_READS" + + #: A constant which can be used with the ranking_measure2 property of a SaveSqlTuningSetAsDetails. + #: This constant has a value of "DIRECT_WRITES" + RANKING_MEASURE2_DIRECT_WRITES = "DIRECT_WRITES" + + #: A constant which can be used with the ranking_measure3 property of a SaveSqlTuningSetAsDetails. + #: This constant has a value of "ELAPSED_TIME" + RANKING_MEASURE3_ELAPSED_TIME = "ELAPSED_TIME" + + #: A constant which can be used with the ranking_measure3 property of a SaveSqlTuningSetAsDetails. + #: This constant has a value of "CPU_TIME" + RANKING_MEASURE3_CPU_TIME = "CPU_TIME" + + #: A constant which can be used with the ranking_measure3 property of a SaveSqlTuningSetAsDetails. + #: This constant has a value of "OPTIMIZER_COST" + RANKING_MEASURE3_OPTIMIZER_COST = "OPTIMIZER_COST" + + #: A constant which can be used with the ranking_measure3 property of a SaveSqlTuningSetAsDetails. + #: This constant has a value of "BUFFER_GETS" + RANKING_MEASURE3_BUFFER_GETS = "BUFFER_GETS" + + #: A constant which can be used with the ranking_measure3 property of a SaveSqlTuningSetAsDetails. + #: This constant has a value of "DISK_READS" + RANKING_MEASURE3_DISK_READS = "DISK_READS" + + #: A constant which can be used with the ranking_measure3 property of a SaveSqlTuningSetAsDetails. + #: This constant has a value of "DIRECT_WRITES" + RANKING_MEASURE3_DIRECT_WRITES = "DIRECT_WRITES" + + #: A constant which can be used with the load_option property of a SaveSqlTuningSetAsDetails. + #: This constant has a value of "INSERT" + LOAD_OPTION_INSERT = "INSERT" + + #: A constant which can be used with the load_option property of a SaveSqlTuningSetAsDetails. + #: This constant has a value of "UPDATE" + LOAD_OPTION_UPDATE = "UPDATE" + + #: A constant which can be used with the load_option property of a SaveSqlTuningSetAsDetails. + #: This constant has a value of "MERGE" + LOAD_OPTION_MERGE = "MERGE" + + #: A constant which can be used with the update_option property of a SaveSqlTuningSetAsDetails. + #: This constant has a value of "REPLACE" + UPDATE_OPTION_REPLACE = "REPLACE" + + #: A constant which can be used with the update_option property of a SaveSqlTuningSetAsDetails. + #: This constant has a value of "ACCUMULATE" + UPDATE_OPTION_ACCUMULATE = "ACCUMULATE" + + #: A constant which can be used with the update_condition property of a SaveSqlTuningSetAsDetails. + #: This constant has a value of "OLD" + UPDATE_CONDITION_OLD = "OLD" + + #: A constant which can be used with the update_condition property of a SaveSqlTuningSetAsDetails. + #: This constant has a value of "NEW" + UPDATE_CONDITION_NEW = "NEW" + + def __init__(self, **kwargs): + """ + Initializes a new SaveSqlTuningSetAsDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param credential_details: + The value to assign to the credential_details property of this SaveSqlTuningSetAsDetails. + :type credential_details: oci.database_management.models.SqlTuningSetAdminCredentialDetails + + :param show_sql_only: + The value to assign to the show_sql_only property of this SaveSqlTuningSetAsDetails. + :type show_sql_only: int + + :param owner: + The value to assign to the owner property of this SaveSqlTuningSetAsDetails. + :type owner: str + + :param name: + The value to assign to the name property of this SaveSqlTuningSetAsDetails. + :type name: str + + :param destination_sql_tuning_set_name: + The value to assign to the destination_sql_tuning_set_name property of this SaveSqlTuningSetAsDetails. + :type destination_sql_tuning_set_name: str + + :param destination_sql_tuning_set_description: + The value to assign to the destination_sql_tuning_set_description property of this SaveSqlTuningSetAsDetails. + :type destination_sql_tuning_set_description: str + + :param destination_sql_tuning_set_owner: + The value to assign to the destination_sql_tuning_set_owner property of this SaveSqlTuningSetAsDetails. + :type destination_sql_tuning_set_owner: str + + :param create_new: + The value to assign to the create_new property of this SaveSqlTuningSetAsDetails. + :type create_new: int + + :param basic_filter: + The value to assign to the basic_filter property of this SaveSqlTuningSetAsDetails. + :type basic_filter: str + + :param plan_filter: + The value to assign to the plan_filter property of this SaveSqlTuningSetAsDetails. + Allowed values for this property are: "LAST_GENERATED", "FIRST_GENERATED", "LAST_LOADED", "FIRST_LOADED", "MAX_ELAPSED_TIME", "MAX_BUFFER_GETS", "MAX_DISK_READS", "MAX_DIRECT_WRITES", "MAX_OPTIMIZER_COST" + :type plan_filter: str + + :param recursive_sql: + The value to assign to the recursive_sql property of this SaveSqlTuningSetAsDetails. + Allowed values for this property are: "HAS_RECURSIVE_SQL", "NO_RECURSIVE_SQL" + :type recursive_sql: str + + :param result_percentage: + The value to assign to the result_percentage property of this SaveSqlTuningSetAsDetails. + :type result_percentage: float + + :param result_limit: + The value to assign to the result_limit property of this SaveSqlTuningSetAsDetails. + :type result_limit: int + + :param ranking_measure1: + The value to assign to the ranking_measure1 property of this SaveSqlTuningSetAsDetails. + Allowed values for this property are: "ELAPSED_TIME", "CPU_TIME", "OPTIMIZER_COST", "BUFFER_GETS", "DISK_READS", "DIRECT_WRITES" + :type ranking_measure1: str + + :param ranking_measure2: + The value to assign to the ranking_measure2 property of this SaveSqlTuningSetAsDetails. + Allowed values for this property are: "ELAPSED_TIME", "CPU_TIME", "OPTIMIZER_COST", "BUFFER_GETS", "DISK_READS", "DIRECT_WRITES" + :type ranking_measure2: str + + :param ranking_measure3: + The value to assign to the ranking_measure3 property of this SaveSqlTuningSetAsDetails. + Allowed values for this property are: "ELAPSED_TIME", "CPU_TIME", "OPTIMIZER_COST", "BUFFER_GETS", "DISK_READS", "DIRECT_WRITES" + :type ranking_measure3: str + + :param attribute_list: + The value to assign to the attribute_list property of this SaveSqlTuningSetAsDetails. + :type attribute_list: str + + :param load_option: + The value to assign to the load_option property of this SaveSqlTuningSetAsDetails. + Allowed values for this property are: "INSERT", "UPDATE", "MERGE" + :type load_option: str + + :param update_option: + The value to assign to the update_option property of this SaveSqlTuningSetAsDetails. + Allowed values for this property are: "REPLACE", "ACCUMULATE" + :type update_option: str + + :param update_condition: + The value to assign to the update_condition property of this SaveSqlTuningSetAsDetails. + Allowed values for this property are: "OLD", "NEW" + :type update_condition: str + + :param update_attributes: + The value to assign to the update_attributes property of this SaveSqlTuningSetAsDetails. + :type update_attributes: str + + :param is_ignore_null: + The value to assign to the is_ignore_null property of this SaveSqlTuningSetAsDetails. + :type is_ignore_null: bool + + :param commit_rows: + The value to assign to the commit_rows property of this SaveSqlTuningSetAsDetails. + :type commit_rows: int + + """ + self.swagger_types = { + 'credential_details': 'SqlTuningSetAdminCredentialDetails', + 'show_sql_only': 'int', + 'owner': 'str', + 'name': 'str', + 'destination_sql_tuning_set_name': 'str', + 'destination_sql_tuning_set_description': 'str', + 'destination_sql_tuning_set_owner': 'str', + 'create_new': 'int', + 'basic_filter': 'str', + 'plan_filter': 'str', + 'recursive_sql': 'str', + 'result_percentage': 'float', + 'result_limit': 'int', + 'ranking_measure1': 'str', + 'ranking_measure2': 'str', + 'ranking_measure3': 'str', + 'attribute_list': 'str', + 'load_option': 'str', + 'update_option': 'str', + 'update_condition': 'str', + 'update_attributes': 'str', + 'is_ignore_null': 'bool', + 'commit_rows': 'int' + } + + self.attribute_map = { + 'credential_details': 'credentialDetails', + 'show_sql_only': 'showSqlOnly', + 'owner': 'owner', + 'name': 'name', + 'destination_sql_tuning_set_name': 'destinationSqlTuningSetName', + 'destination_sql_tuning_set_description': 'destinationSqlTuningSetDescription', + 'destination_sql_tuning_set_owner': 'destinationSqlTuningSetOwner', + 'create_new': 'createNew', + 'basic_filter': 'basicFilter', + 'plan_filter': 'planFilter', + 'recursive_sql': 'recursiveSql', + 'result_percentage': 'resultPercentage', + 'result_limit': 'resultLimit', + 'ranking_measure1': 'rankingMeasure1', + 'ranking_measure2': 'rankingMeasure2', + 'ranking_measure3': 'rankingMeasure3', + 'attribute_list': 'attributeList', + 'load_option': 'loadOption', + 'update_option': 'updateOption', + 'update_condition': 'updateCondition', + 'update_attributes': 'updateAttributes', + 'is_ignore_null': 'isIgnoreNull', + 'commit_rows': 'commitRows' + } + + self._credential_details = None + self._show_sql_only = None + self._owner = None + self._name = None + self._destination_sql_tuning_set_name = None + self._destination_sql_tuning_set_description = None + self._destination_sql_tuning_set_owner = None + self._create_new = None + self._basic_filter = None + self._plan_filter = None + self._recursive_sql = None + self._result_percentage = None + self._result_limit = None + self._ranking_measure1 = None + self._ranking_measure2 = None + self._ranking_measure3 = None + self._attribute_list = None + self._load_option = None + self._update_option = None + self._update_condition = None + self._update_attributes = None + self._is_ignore_null = None + self._commit_rows = None + + @property + def credential_details(self): + """ + **[Required]** Gets the credential_details of this SaveSqlTuningSetAsDetails. + + :return: The credential_details of this SaveSqlTuningSetAsDetails. + :rtype: oci.database_management.models.SqlTuningSetAdminCredentialDetails + """ + return self._credential_details + + @credential_details.setter + def credential_details(self, credential_details): + """ + Sets the credential_details of this SaveSqlTuningSetAsDetails. + + :param credential_details: The credential_details of this SaveSqlTuningSetAsDetails. + :type: oci.database_management.models.SqlTuningSetAdminCredentialDetails + """ + self._credential_details = credential_details + + @property + def show_sql_only(self): + """ + Gets the show_sql_only of this SaveSqlTuningSetAsDetails. + Flag to indicate whether to save the Sql tuning set or just display the plsql used to save Sql tuning set. + + + :return: The show_sql_only of this SaveSqlTuningSetAsDetails. + :rtype: int + """ + return self._show_sql_only + + @show_sql_only.setter + def show_sql_only(self, show_sql_only): + """ + Sets the show_sql_only of this SaveSqlTuningSetAsDetails. + Flag to indicate whether to save the Sql tuning set or just display the plsql used to save Sql tuning set. + + + :param show_sql_only: The show_sql_only of this SaveSqlTuningSetAsDetails. + :type: int + """ + self._show_sql_only = show_sql_only + + @property + def owner(self): + """ + Gets the owner of this SaveSqlTuningSetAsDetails. + The owner of the Sql tuning set. + + + :return: The owner of this SaveSqlTuningSetAsDetails. + :rtype: str + """ + return self._owner + + @owner.setter + def owner(self, owner): + """ + Sets the owner of this SaveSqlTuningSetAsDetails. + The owner of the Sql tuning set. + + + :param owner: The owner of this SaveSqlTuningSetAsDetails. + :type: str + """ + self._owner = owner + + @property + def name(self): + """ + **[Required]** Gets the name of this SaveSqlTuningSetAsDetails. + The name of the Sql tuning set. + + + :return: The name of this SaveSqlTuningSetAsDetails. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this SaveSqlTuningSetAsDetails. + The name of the Sql tuning set. + + + :param name: The name of this SaveSqlTuningSetAsDetails. + :type: str + """ + self._name = name + + @property + def destination_sql_tuning_set_name(self): + """ + **[Required]** Gets the destination_sql_tuning_set_name of this SaveSqlTuningSetAsDetails. + The name of the destination Sql tuning set. + + + :return: The destination_sql_tuning_set_name of this SaveSqlTuningSetAsDetails. + :rtype: str + """ + return self._destination_sql_tuning_set_name + + @destination_sql_tuning_set_name.setter + def destination_sql_tuning_set_name(self, destination_sql_tuning_set_name): + """ + Sets the destination_sql_tuning_set_name of this SaveSqlTuningSetAsDetails. + The name of the destination Sql tuning set. + + + :param destination_sql_tuning_set_name: The destination_sql_tuning_set_name of this SaveSqlTuningSetAsDetails. + :type: str + """ + self._destination_sql_tuning_set_name = destination_sql_tuning_set_name + + @property + def destination_sql_tuning_set_description(self): + """ + Gets the destination_sql_tuning_set_description of this SaveSqlTuningSetAsDetails. + The description for the destination Sql tuning set. + + + :return: The destination_sql_tuning_set_description of this SaveSqlTuningSetAsDetails. + :rtype: str + """ + return self._destination_sql_tuning_set_description + + @destination_sql_tuning_set_description.setter + def destination_sql_tuning_set_description(self, destination_sql_tuning_set_description): + """ + Sets the destination_sql_tuning_set_description of this SaveSqlTuningSetAsDetails. + The description for the destination Sql tuning set. + + + :param destination_sql_tuning_set_description: The destination_sql_tuning_set_description of this SaveSqlTuningSetAsDetails. + :type: str + """ + self._destination_sql_tuning_set_description = destination_sql_tuning_set_description + + @property + def destination_sql_tuning_set_owner(self): + """ + Gets the destination_sql_tuning_set_owner of this SaveSqlTuningSetAsDetails. + Owner of the destination Sql tuning set. + + + :return: The destination_sql_tuning_set_owner of this SaveSqlTuningSetAsDetails. + :rtype: str + """ + return self._destination_sql_tuning_set_owner + + @destination_sql_tuning_set_owner.setter + def destination_sql_tuning_set_owner(self, destination_sql_tuning_set_owner): + """ + Sets the destination_sql_tuning_set_owner of this SaveSqlTuningSetAsDetails. + Owner of the destination Sql tuning set. + + + :param destination_sql_tuning_set_owner: The destination_sql_tuning_set_owner of this SaveSqlTuningSetAsDetails. + :type: str + """ + self._destination_sql_tuning_set_owner = destination_sql_tuning_set_owner + + @property + def create_new(self): + """ + **[Required]** Gets the create_new of this SaveSqlTuningSetAsDetails. + Specifies whether to create a new Sql tuning set or not. + Possible values + 1 - Create a new Sql tuning set + 0 - Do not create a new Sql tuning set + + + :return: The create_new of this SaveSqlTuningSetAsDetails. + :rtype: int + """ + return self._create_new + + @create_new.setter + def create_new(self, create_new): + """ + Sets the create_new of this SaveSqlTuningSetAsDetails. + Specifies whether to create a new Sql tuning set or not. + Possible values + 1 - Create a new Sql tuning set + 0 - Do not create a new Sql tuning set + + + :param create_new: The create_new of this SaveSqlTuningSetAsDetails. + :type: int + """ + self._create_new = create_new + + @property + def basic_filter(self): + """ + Gets the basic_filter of this SaveSqlTuningSetAsDetails. + Specifies the Sql predicate to filter the Sql from the Sql tuning set defined on attributes of the SQLSET_ROW. + User could use any combination of the following columns with appropriate values as Sql predicate + Refer to the documentation https://docs.oracle.com/en/database/oracle/oracle-database/18/arpls/DBMS_SQLTUNE.html#GUID-1F4AFB03-7B29-46FC-B3F2-CB01EC36326C + + + :return: The basic_filter of this SaveSqlTuningSetAsDetails. + :rtype: str + """ + return self._basic_filter + + @basic_filter.setter + def basic_filter(self, basic_filter): + """ + Sets the basic_filter of this SaveSqlTuningSetAsDetails. + Specifies the Sql predicate to filter the Sql from the Sql tuning set defined on attributes of the SQLSET_ROW. + User could use any combination of the following columns with appropriate values as Sql predicate + Refer to the documentation https://docs.oracle.com/en/database/oracle/oracle-database/18/arpls/DBMS_SQLTUNE.html#GUID-1F4AFB03-7B29-46FC-B3F2-CB01EC36326C + + + :param basic_filter: The basic_filter of this SaveSqlTuningSetAsDetails. + :type: str + """ + self._basic_filter = basic_filter + + @property + def plan_filter(self): + """ + Gets the plan_filter of this SaveSqlTuningSetAsDetails. + Specifies the plan filter. + This parameter enables you to select a single plan when a statement has multiple plans. + Refer to the documentation https://docs.oracle.com/en/database/oracle/oracle-database/19/arpls/DBMS_SQLSET.html#GUID-9D995019-91AB-4B1E-9EAF-031050789B21 + + Allowed values for this property are: "LAST_GENERATED", "FIRST_GENERATED", "LAST_LOADED", "FIRST_LOADED", "MAX_ELAPSED_TIME", "MAX_BUFFER_GETS", "MAX_DISK_READS", "MAX_DIRECT_WRITES", "MAX_OPTIMIZER_COST" + + + :return: The plan_filter of this SaveSqlTuningSetAsDetails. + :rtype: str + """ + return self._plan_filter + + @plan_filter.setter + def plan_filter(self, plan_filter): + """ + Sets the plan_filter of this SaveSqlTuningSetAsDetails. + Specifies the plan filter. + This parameter enables you to select a single plan when a statement has multiple plans. + Refer to the documentation https://docs.oracle.com/en/database/oracle/oracle-database/19/arpls/DBMS_SQLSET.html#GUID-9D995019-91AB-4B1E-9EAF-031050789B21 + + + :param plan_filter: The plan_filter of this SaveSqlTuningSetAsDetails. + :type: str + """ + allowed_values = ["LAST_GENERATED", "FIRST_GENERATED", "LAST_LOADED", "FIRST_LOADED", "MAX_ELAPSED_TIME", "MAX_BUFFER_GETS", "MAX_DISK_READS", "MAX_DIRECT_WRITES", "MAX_OPTIMIZER_COST"] + if not value_allowed_none_or_none_sentinel(plan_filter, allowed_values): + raise ValueError( + "Invalid value for `plan_filter`, must be None or one of {0}" + .format(allowed_values) + ) + self._plan_filter = plan_filter + + @property + def recursive_sql(self): + """ + Gets the recursive_sql of this SaveSqlTuningSetAsDetails. + Specifies that the filter must include recursive Sql in the Sql tuning set. + + Allowed values for this property are: "HAS_RECURSIVE_SQL", "NO_RECURSIVE_SQL" + + + :return: The recursive_sql of this SaveSqlTuningSetAsDetails. + :rtype: str + """ + return self._recursive_sql + + @recursive_sql.setter + def recursive_sql(self, recursive_sql): + """ + Sets the recursive_sql of this SaveSqlTuningSetAsDetails. + Specifies that the filter must include recursive Sql in the Sql tuning set. + + + :param recursive_sql: The recursive_sql of this SaveSqlTuningSetAsDetails. + :type: str + """ + allowed_values = ["HAS_RECURSIVE_SQL", "NO_RECURSIVE_SQL"] + if not value_allowed_none_or_none_sentinel(recursive_sql, allowed_values): + raise ValueError( + "Invalid value for `recursive_sql`, must be None or one of {0}" + .format(allowed_values) + ) + self._recursive_sql = recursive_sql + + @property + def result_percentage(self): + """ + Gets the result_percentage of this SaveSqlTuningSetAsDetails. + Specifies a filter that picks the top n% according to the supplied ranking measure. + Note that this parameter applies only if one ranking measure is supplied. + + + :return: The result_percentage of this SaveSqlTuningSetAsDetails. + :rtype: float + """ + return self._result_percentage + + @result_percentage.setter + def result_percentage(self, result_percentage): + """ + Sets the result_percentage of this SaveSqlTuningSetAsDetails. + Specifies a filter that picks the top n% according to the supplied ranking measure. + Note that this parameter applies only if one ranking measure is supplied. + + + :param result_percentage: The result_percentage of this SaveSqlTuningSetAsDetails. + :type: float + """ + self._result_percentage = result_percentage + + @property + def result_limit(self): + """ + Gets the result_limit of this SaveSqlTuningSetAsDetails. + The top limit Sql from the filtered source, ranked by the ranking measure. + + + :return: The result_limit of this SaveSqlTuningSetAsDetails. + :rtype: int + """ + return self._result_limit + + @result_limit.setter + def result_limit(self, result_limit): + """ + Sets the result_limit of this SaveSqlTuningSetAsDetails. + The top limit Sql from the filtered source, ranked by the ranking measure. + + + :param result_limit: The result_limit of this SaveSqlTuningSetAsDetails. + :type: int + """ + self._result_limit = result_limit + + @property + def ranking_measure1(self): + """ + Gets the ranking_measure1 of this SaveSqlTuningSetAsDetails. + Specifies an ORDER BY clause on the selected Sql. User can specify upto three ranking measures. + + Allowed values for this property are: "ELAPSED_TIME", "CPU_TIME", "OPTIMIZER_COST", "BUFFER_GETS", "DISK_READS", "DIRECT_WRITES" + + + :return: The ranking_measure1 of this SaveSqlTuningSetAsDetails. + :rtype: str + """ + return self._ranking_measure1 + + @ranking_measure1.setter + def ranking_measure1(self, ranking_measure1): + """ + Sets the ranking_measure1 of this SaveSqlTuningSetAsDetails. + Specifies an ORDER BY clause on the selected Sql. User can specify upto three ranking measures. + + + :param ranking_measure1: The ranking_measure1 of this SaveSqlTuningSetAsDetails. + :type: str + """ + allowed_values = ["ELAPSED_TIME", "CPU_TIME", "OPTIMIZER_COST", "BUFFER_GETS", "DISK_READS", "DIRECT_WRITES"] + if not value_allowed_none_or_none_sentinel(ranking_measure1, allowed_values): + raise ValueError( + "Invalid value for `ranking_measure1`, must be None or one of {0}" + .format(allowed_values) + ) + self._ranking_measure1 = ranking_measure1 + + @property + def ranking_measure2(self): + """ + Gets the ranking_measure2 of this SaveSqlTuningSetAsDetails. + Specifies an ORDER BY clause on the selected Sql. User can specify upto three ranking measures. + + Allowed values for this property are: "ELAPSED_TIME", "CPU_TIME", "OPTIMIZER_COST", "BUFFER_GETS", "DISK_READS", "DIRECT_WRITES" + + + :return: The ranking_measure2 of this SaveSqlTuningSetAsDetails. + :rtype: str + """ + return self._ranking_measure2 + + @ranking_measure2.setter + def ranking_measure2(self, ranking_measure2): + """ + Sets the ranking_measure2 of this SaveSqlTuningSetAsDetails. + Specifies an ORDER BY clause on the selected Sql. User can specify upto three ranking measures. + + + :param ranking_measure2: The ranking_measure2 of this SaveSqlTuningSetAsDetails. + :type: str + """ + allowed_values = ["ELAPSED_TIME", "CPU_TIME", "OPTIMIZER_COST", "BUFFER_GETS", "DISK_READS", "DIRECT_WRITES"] + if not value_allowed_none_or_none_sentinel(ranking_measure2, allowed_values): + raise ValueError( + "Invalid value for `ranking_measure2`, must be None or one of {0}" + .format(allowed_values) + ) + self._ranking_measure2 = ranking_measure2 + + @property + def ranking_measure3(self): + """ + Gets the ranking_measure3 of this SaveSqlTuningSetAsDetails. + Specifies an ORDER BY clause on the selected Sql. User can specify upto three ranking measures. + + Allowed values for this property are: "ELAPSED_TIME", "CPU_TIME", "OPTIMIZER_COST", "BUFFER_GETS", "DISK_READS", "DIRECT_WRITES" + + + :return: The ranking_measure3 of this SaveSqlTuningSetAsDetails. + :rtype: str + """ + return self._ranking_measure3 + + @ranking_measure3.setter + def ranking_measure3(self, ranking_measure3): + """ + Sets the ranking_measure3 of this SaveSqlTuningSetAsDetails. + Specifies an ORDER BY clause on the selected Sql. User can specify upto three ranking measures. + + + :param ranking_measure3: The ranking_measure3 of this SaveSqlTuningSetAsDetails. + :type: str + """ + allowed_values = ["ELAPSED_TIME", "CPU_TIME", "OPTIMIZER_COST", "BUFFER_GETS", "DISK_READS", "DIRECT_WRITES"] + if not value_allowed_none_or_none_sentinel(ranking_measure3, allowed_values): + raise ValueError( + "Invalid value for `ranking_measure3`, must be None or one of {0}" + .format(allowed_values) + ) + self._ranking_measure3 = ranking_measure3 + + @property + def attribute_list(self): + """ + Gets the attribute_list of this SaveSqlTuningSetAsDetails. + Specifies the list of Sql statement attributes to return in the result. + Note that this parameter cannot be made an enum since custom value can take a list of comma separated attribute names. + Attribute list can take one of the following values. + TYPICAL - Specifies BASIC plus Sql plan (without row source statistics) and without object reference list (default). + BASIC - Specifies all attributes (such as execution statistics and binds) except the plans. The execution context is always part of the result. + ALL - Specifies all attributes. + CUSTOM - Comma-separated list of the following attribute names. + - EXECUTION_STATISTICS + - BIND_LIST + - OBJECT_LIST + - SQL_PLAN + - SQL_PLAN_STATISTICS + Usage examples: + 1. \"attributeList\": \"TYPICAL\" + 2. \"attributeList\": \"ALL\" + 3. \"attributeList\": \"EXECUTION_STATISTICS,OBJECT_LIST,SQL_PLAN\" + + + :return: The attribute_list of this SaveSqlTuningSetAsDetails. + :rtype: str + """ + return self._attribute_list + + @attribute_list.setter + def attribute_list(self, attribute_list): + """ + Sets the attribute_list of this SaveSqlTuningSetAsDetails. + Specifies the list of Sql statement attributes to return in the result. + Note that this parameter cannot be made an enum since custom value can take a list of comma separated attribute names. + Attribute list can take one of the following values. + TYPICAL - Specifies BASIC plus Sql plan (without row source statistics) and without object reference list (default). + BASIC - Specifies all attributes (such as execution statistics and binds) except the plans. The execution context is always part of the result. + ALL - Specifies all attributes. + CUSTOM - Comma-separated list of the following attribute names. + - EXECUTION_STATISTICS + - BIND_LIST + - OBJECT_LIST + - SQL_PLAN + - SQL_PLAN_STATISTICS + Usage examples: + 1. \"attributeList\": \"TYPICAL\" + 2. \"attributeList\": \"ALL\" + 3. \"attributeList\": \"EXECUTION_STATISTICS,OBJECT_LIST,SQL_PLAN\" + + + :param attribute_list: The attribute_list of this SaveSqlTuningSetAsDetails. + :type: str + """ + self._attribute_list = attribute_list + + @property + def load_option(self): + """ + Gets the load_option of this SaveSqlTuningSetAsDetails. + Specifies which statements are loaded into the Sql tuning set. + The possible values are. + - INSERT (default) + Adds only new statements. + - UPDATE + Updates existing the Sql statements and ignores any new statements. + - MERGE + Inserts new statements and updates the information of the existing ones. + + Allowed values for this property are: "INSERT", "UPDATE", "MERGE" + + + :return: The load_option of this SaveSqlTuningSetAsDetails. + :rtype: str + """ + return self._load_option + + @load_option.setter + def load_option(self, load_option): + """ + Sets the load_option of this SaveSqlTuningSetAsDetails. + Specifies which statements are loaded into the Sql tuning set. + The possible values are. + - INSERT (default) + Adds only new statements. + - UPDATE + Updates existing the Sql statements and ignores any new statements. + - MERGE + Inserts new statements and updates the information of the existing ones. + + + :param load_option: The load_option of this SaveSqlTuningSetAsDetails. + :type: str + """ + allowed_values = ["INSERT", "UPDATE", "MERGE"] + if not value_allowed_none_or_none_sentinel(load_option, allowed_values): + raise ValueError( + "Invalid value for `load_option`, must be None or one of {0}" + .format(allowed_values) + ) + self._load_option = load_option + + @property + def update_option(self): + """ + Gets the update_option of this SaveSqlTuningSetAsDetails. + Specifies how existing Sql statements are updated. + This parameter is applicable only if load_option is specified with UPDATE or MERGE as an option. + Update option can take one of the following values. + REPLACE (default) - Updates the statement using the new statistics, bind list, object list, and so on. + ACCUMULATE - Combines attributes when possible (for example, statistics such as elapsed_time), otherwise replaces the existing values (for example, module and action) with the provided values. + Following Sql statement attributes can be accumulated. + elapsed_time + buffer_gets + direct_writes + disk_reads + row_processed + fetches + executions + end_of_fetch_count + stat_period + active_stat_period + + Allowed values for this property are: "REPLACE", "ACCUMULATE" + + + :return: The update_option of this SaveSqlTuningSetAsDetails. + :rtype: str + """ + return self._update_option + + @update_option.setter + def update_option(self, update_option): + """ + Sets the update_option of this SaveSqlTuningSetAsDetails. + Specifies how existing Sql statements are updated. + This parameter is applicable only if load_option is specified with UPDATE or MERGE as an option. + Update option can take one of the following values. + REPLACE (default) - Updates the statement using the new statistics, bind list, object list, and so on. + ACCUMULATE - Combines attributes when possible (for example, statistics such as elapsed_time), otherwise replaces the existing values (for example, module and action) with the provided values. + Following Sql statement attributes can be accumulated. + elapsed_time + buffer_gets + direct_writes + disk_reads + row_processed + fetches + executions + end_of_fetch_count + stat_period + active_stat_period + + + :param update_option: The update_option of this SaveSqlTuningSetAsDetails. + :type: str + """ + allowed_values = ["REPLACE", "ACCUMULATE"] + if not value_allowed_none_or_none_sentinel(update_option, allowed_values): + raise ValueError( + "Invalid value for `update_option`, must be None or one of {0}" + .format(allowed_values) + ) + self._update_option = update_option + + @property + def update_condition(self): + """ + Gets the update_condition of this SaveSqlTuningSetAsDetails. + Specifies when to perform the update. + The procedure only performs the update when the specified condition is satisfied. + The condition can refer to either the data source or destination. + The condition must use the following prefixes to refer to attributes from the source or the destination: + OLD \u2014 Refers to statement attributes from the SQL tuning set (destination). + NEW \u2014 Refers to statement attributes from the input statements (source). + NULL \u2014 No updates are performed. + + Allowed values for this property are: "OLD", "NEW" + + + :return: The update_condition of this SaveSqlTuningSetAsDetails. + :rtype: str + """ + return self._update_condition + + @update_condition.setter + def update_condition(self, update_condition): + """ + Sets the update_condition of this SaveSqlTuningSetAsDetails. + Specifies when to perform the update. + The procedure only performs the update when the specified condition is satisfied. + The condition can refer to either the data source or destination. + The condition must use the following prefixes to refer to attributes from the source or the destination: + OLD \u2014 Refers to statement attributes from the SQL tuning set (destination). + NEW \u2014 Refers to statement attributes from the input statements (source). + NULL \u2014 No updates are performed. + + + :param update_condition: The update_condition of this SaveSqlTuningSetAsDetails. + :type: str + """ + allowed_values = ["OLD", "NEW"] + if not value_allowed_none_or_none_sentinel(update_condition, allowed_values): + raise ValueError( + "Invalid value for `update_condition`, must be None or one of {0}" + .format(allowed_values) + ) + self._update_condition = update_condition + + @property + def update_attributes(self): + """ + Gets the update_attributes of this SaveSqlTuningSetAsDetails. + Specifies the list of Sql statement attributes to update during a merge or update. + Note that this parameter cannot be made an enum since custom value can take a list of comma separated attribute names. + Update attributes can take one of the following values. + NULL (default) - Specifies the content of the input cursor except the execution context. On other terms, it is equivalent to ALL without execution contexts such as module and action. + BASIC - Specifies statistics and binds only. + TYPICAL - Specifies BASIC with Sql plans (without row source statistics) and without an object reference list. + ALL - Specifies all attributes, including the execution context attributes such as module and action. + CUSTOM - List of comma separated attribute names to update + EXECUTION_CONTEXT + EXECUTION_STATISTICS + SQL_BINDS + SQL_PLAN + SQL_PLAN_STATISTICS (similar to SQL_PLAN with added row source statistics) + Usage examples: + 1. \"updateAttributes\": \"TYPICAL\" + 2. \"updateAttributes\": \"BASIC\" + 3. \"updateAttributes\": \"EXECUTION_STATISTICS,SQL_PLAN_STATISTICS,SQL_PLAN\" + 4. \"updateAttributes\": \"EXECUTION_STATISTICS,SQL_PLAN\" + + + :return: The update_attributes of this SaveSqlTuningSetAsDetails. + :rtype: str + """ + return self._update_attributes + + @update_attributes.setter + def update_attributes(self, update_attributes): + """ + Sets the update_attributes of this SaveSqlTuningSetAsDetails. + Specifies the list of Sql statement attributes to update during a merge or update. + Note that this parameter cannot be made an enum since custom value can take a list of comma separated attribute names. + Update attributes can take one of the following values. + NULL (default) - Specifies the content of the input cursor except the execution context. On other terms, it is equivalent to ALL without execution contexts such as module and action. + BASIC - Specifies statistics and binds only. + TYPICAL - Specifies BASIC with Sql plans (without row source statistics) and without an object reference list. + ALL - Specifies all attributes, including the execution context attributes such as module and action. + CUSTOM - List of comma separated attribute names to update + EXECUTION_CONTEXT + EXECUTION_STATISTICS + SQL_BINDS + SQL_PLAN + SQL_PLAN_STATISTICS (similar to SQL_PLAN with added row source statistics) + Usage examples: + 1. \"updateAttributes\": \"TYPICAL\" + 2. \"updateAttributes\": \"BASIC\" + 3. \"updateAttributes\": \"EXECUTION_STATISTICS,SQL_PLAN_STATISTICS,SQL_PLAN\" + 4. \"updateAttributes\": \"EXECUTION_STATISTICS,SQL_PLAN\" + + + :param update_attributes: The update_attributes of this SaveSqlTuningSetAsDetails. + :type: str + """ + self._update_attributes = update_attributes + + @property + def is_ignore_null(self): + """ + Gets the is_ignore_null of this SaveSqlTuningSetAsDetails. + Specifies whether to update attributes when the new value is NULL. + If TRUE, then the procedure does not update an attribute when the new value is NULL. + That is, do not override with NULL values unless intentional. + Possible values - true or false + + + :return: The is_ignore_null of this SaveSqlTuningSetAsDetails. + :rtype: bool + """ + return self._is_ignore_null + + @is_ignore_null.setter + def is_ignore_null(self, is_ignore_null): + """ + Sets the is_ignore_null of this SaveSqlTuningSetAsDetails. + Specifies whether to update attributes when the new value is NULL. + If TRUE, then the procedure does not update an attribute when the new value is NULL. + That is, do not override with NULL values unless intentional. + Possible values - true or false + + + :param is_ignore_null: The is_ignore_null of this SaveSqlTuningSetAsDetails. + :type: bool + """ + self._is_ignore_null = is_ignore_null + + @property + def commit_rows(self): + """ + Gets the commit_rows of this SaveSqlTuningSetAsDetails. + Specifies whether to commit statements after DML. + If a value is provided, then the load commits after each specified number of statements is inserted. + If NULL is provided, then the load commits only once, at the end of the operation. + + + :return: The commit_rows of this SaveSqlTuningSetAsDetails. + :rtype: int + """ + return self._commit_rows + + @commit_rows.setter + def commit_rows(self, commit_rows): + """ + Sets the commit_rows of this SaveSqlTuningSetAsDetails. + Specifies whether to commit statements after DML. + If a value is provided, then the load commits after each specified number of statements is inserted. + If NULL is provided, then the load commits only once, at the end of the operation. + + + :param commit_rows: The commit_rows of this SaveSqlTuningSetAsDetails. + :type: int + """ + self._commit_rows = commit_rows + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/database_management/models/sql_in_sql_tuning_set.py b/src/oci/database_management/models/sql_in_sql_tuning_set.py new file mode 100644 index 0000000000..498a975d9e --- /dev/null +++ b/src/oci/database_management/models/sql_in_sql_tuning_set.py @@ -0,0 +1,258 @@ +# coding: utf-8 +# Copyright (c) 2016, 2023, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20201101 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class SqlInSqlTuningSet(object): + """ + Sql information in the Sql tuning set. + """ + + def __init__(self, **kwargs): + """ + Initializes a new SqlInSqlTuningSet object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param sql_id: + The value to assign to the sql_id property of this SqlInSqlTuningSet. + :type sql_id: str + + :param sql_text: + The value to assign to the sql_text property of this SqlInSqlTuningSet. + :type sql_text: str + + :param container_database_id: + The value to assign to the container_database_id property of this SqlInSqlTuningSet. + :type container_database_id: int + + :param plan_hash_value: + The value to assign to the plan_hash_value property of this SqlInSqlTuningSet. + :type plan_hash_value: int + + :param schema: + The value to assign to the schema property of this SqlInSqlTuningSet. + :type schema: str + + :param module: + The value to assign to the module property of this SqlInSqlTuningSet. + :type module: str + + :param metrics: + The value to assign to the metrics property of this SqlInSqlTuningSet. + :type metrics: list[oci.database_management.models.SqlMetrics] + + """ + self.swagger_types = { + 'sql_id': 'str', + 'sql_text': 'str', + 'container_database_id': 'int', + 'plan_hash_value': 'int', + 'schema': 'str', + 'module': 'str', + 'metrics': 'list[SqlMetrics]' + } + + self.attribute_map = { + 'sql_id': 'sqlId', + 'sql_text': 'sqlText', + 'container_database_id': 'containerDatabaseId', + 'plan_hash_value': 'planHashValue', + 'schema': 'schema', + 'module': 'module', + 'metrics': 'metrics' + } + + self._sql_id = None + self._sql_text = None + self._container_database_id = None + self._plan_hash_value = None + self._schema = None + self._module = None + self._metrics = None + + @property + def sql_id(self): + """ + **[Required]** Gets the sql_id of this SqlInSqlTuningSet. + The unique Sql identifier. + + + :return: The sql_id of this SqlInSqlTuningSet. + :rtype: str + """ + return self._sql_id + + @sql_id.setter + def sql_id(self, sql_id): + """ + Sets the sql_id of this SqlInSqlTuningSet. + The unique Sql identifier. + + + :param sql_id: The sql_id of this SqlInSqlTuningSet. + :type: str + """ + self._sql_id = sql_id + + @property + def sql_text(self): + """ + Gets the sql_text of this SqlInSqlTuningSet. + Sql text. + + + :return: The sql_text of this SqlInSqlTuningSet. + :rtype: str + """ + return self._sql_text + + @sql_text.setter + def sql_text(self, sql_text): + """ + Sets the sql_text of this SqlInSqlTuningSet. + Sql text. + + + :param sql_text: The sql_text of this SqlInSqlTuningSet. + :type: str + """ + self._sql_text = sql_text + + @property + def container_database_id(self): + """ + Gets the container_database_id of this SqlInSqlTuningSet. + The unique container database identifier. + + + :return: The container_database_id of this SqlInSqlTuningSet. + :rtype: int + """ + return self._container_database_id + + @container_database_id.setter + def container_database_id(self, container_database_id): + """ + Sets the container_database_id of this SqlInSqlTuningSet. + The unique container database identifier. + + + :param container_database_id: The container_database_id of this SqlInSqlTuningSet. + :type: int + """ + self._container_database_id = container_database_id + + @property + def plan_hash_value(self): + """ + **[Required]** Gets the plan_hash_value of this SqlInSqlTuningSet. + Plan hash value of the Sql statement. + + + :return: The plan_hash_value of this SqlInSqlTuningSet. + :rtype: int + """ + return self._plan_hash_value + + @plan_hash_value.setter + def plan_hash_value(self, plan_hash_value): + """ + Sets the plan_hash_value of this SqlInSqlTuningSet. + Plan hash value of the Sql statement. + + + :param plan_hash_value: The plan_hash_value of this SqlInSqlTuningSet. + :type: int + """ + self._plan_hash_value = plan_hash_value + + @property + def schema(self): + """ + Gets the schema of this SqlInSqlTuningSet. + The schema name of the Sql. + + + :return: The schema of this SqlInSqlTuningSet. + :rtype: str + """ + return self._schema + + @schema.setter + def schema(self, schema): + """ + Sets the schema of this SqlInSqlTuningSet. + The schema name of the Sql. + + + :param schema: The schema of this SqlInSqlTuningSet. + :type: str + """ + self._schema = schema + + @property + def module(self): + """ + Gets the module of this SqlInSqlTuningSet. + The module of the Sql. + + + :return: The module of this SqlInSqlTuningSet. + :rtype: str + """ + return self._module + + @module.setter + def module(self, module): + """ + Sets the module of this SqlInSqlTuningSet. + The module of the Sql. + + + :param module: The module of this SqlInSqlTuningSet. + :type: str + """ + self._module = module + + @property + def metrics(self): + """ + Gets the metrics of this SqlInSqlTuningSet. + A list of the Sqls associated with the Sql tuning set. + + + :return: The metrics of this SqlInSqlTuningSet. + :rtype: list[oci.database_management.models.SqlMetrics] + """ + return self._metrics + + @metrics.setter + def metrics(self, metrics): + """ + Sets the metrics of this SqlInSqlTuningSet. + A list of the Sqls associated with the Sql tuning set. + + + :param metrics: The metrics of this SqlInSqlTuningSet. + :type: list[oci.database_management.models.SqlMetrics] + """ + self._metrics = metrics + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/database_management/models/sql_metrics.py b/src/oci/database_management/models/sql_metrics.py new file mode 100644 index 0000000000..31590799ff --- /dev/null +++ b/src/oci/database_management/models/sql_metrics.py @@ -0,0 +1,227 @@ +# coding: utf-8 +# Copyright (c) 2016, 2023, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20201101 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class SqlMetrics(object): + """ + Metrics of the Sql in the Sql tuning set. + """ + + def __init__(self, **kwargs): + """ + Initializes a new SqlMetrics object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param cpu_time: + The value to assign to the cpu_time property of this SqlMetrics. + :type cpu_time: int + + :param elapsed_time: + The value to assign to the elapsed_time property of this SqlMetrics. + :type elapsed_time: int + + :param buffer_gets: + The value to assign to the buffer_gets property of this SqlMetrics. + :type buffer_gets: int + + :param disk_reads: + The value to assign to the disk_reads property of this SqlMetrics. + :type disk_reads: int + + :param direct_writes: + The value to assign to the direct_writes property of this SqlMetrics. + :type direct_writes: int + + :param executions: + The value to assign to the executions property of this SqlMetrics. + :type executions: int + + """ + self.swagger_types = { + 'cpu_time': 'int', + 'elapsed_time': 'int', + 'buffer_gets': 'int', + 'disk_reads': 'int', + 'direct_writes': 'int', + 'executions': 'int' + } + + self.attribute_map = { + 'cpu_time': 'cpuTime', + 'elapsed_time': 'elapsedTime', + 'buffer_gets': 'bufferGets', + 'disk_reads': 'diskReads', + 'direct_writes': 'directWrites', + 'executions': 'executions' + } + + self._cpu_time = None + self._elapsed_time = None + self._buffer_gets = None + self._disk_reads = None + self._direct_writes = None + self._executions = None + + @property + def cpu_time(self): + """ + Gets the cpu_time of this SqlMetrics. + Total CPU time consumed by the Sql. + + + :return: The cpu_time of this SqlMetrics. + :rtype: int + """ + return self._cpu_time + + @cpu_time.setter + def cpu_time(self, cpu_time): + """ + Sets the cpu_time of this SqlMetrics. + Total CPU time consumed by the Sql. + + + :param cpu_time: The cpu_time of this SqlMetrics. + :type: int + """ + self._cpu_time = cpu_time + + @property + def elapsed_time(self): + """ + Gets the elapsed_time of this SqlMetrics. + Elapsed time of the Sql. + + + :return: The elapsed_time of this SqlMetrics. + :rtype: int + """ + return self._elapsed_time + + @elapsed_time.setter + def elapsed_time(self, elapsed_time): + """ + Sets the elapsed_time of this SqlMetrics. + Elapsed time of the Sql. + + + :param elapsed_time: The elapsed_time of this SqlMetrics. + :type: int + """ + self._elapsed_time = elapsed_time + + @property + def buffer_gets(self): + """ + Gets the buffer_gets of this SqlMetrics. + Sum total number of buffer gets. + + + :return: The buffer_gets of this SqlMetrics. + :rtype: int + """ + return self._buffer_gets + + @buffer_gets.setter + def buffer_gets(self, buffer_gets): + """ + Sets the buffer_gets of this SqlMetrics. + Sum total number of buffer gets. + + + :param buffer_gets: The buffer_gets of this SqlMetrics. + :type: int + """ + self._buffer_gets = buffer_gets + + @property + def disk_reads(self): + """ + Gets the disk_reads of this SqlMetrics. + Sum total number of disk reads. + + + :return: The disk_reads of this SqlMetrics. + :rtype: int + """ + return self._disk_reads + + @disk_reads.setter + def disk_reads(self, disk_reads): + """ + Sets the disk_reads of this SqlMetrics. + Sum total number of disk reads. + + + :param disk_reads: The disk_reads of this SqlMetrics. + :type: int + """ + self._disk_reads = disk_reads + + @property + def direct_writes(self): + """ + Gets the direct_writes of this SqlMetrics. + Sum total number of direct path writes. + + + :return: The direct_writes of this SqlMetrics. + :rtype: int + """ + return self._direct_writes + + @direct_writes.setter + def direct_writes(self, direct_writes): + """ + Sets the direct_writes of this SqlMetrics. + Sum total number of direct path writes. + + + :param direct_writes: The direct_writes of this SqlMetrics. + :type: int + """ + self._direct_writes = direct_writes + + @property + def executions(self): + """ + Gets the executions of this SqlMetrics. + Total executions of this SQL statement. + + + :return: The executions of this SqlMetrics. + :rtype: int + """ + return self._executions + + @executions.setter + def executions(self, executions): + """ + Sets the executions of this SqlMetrics. + Total executions of this SQL statement. + + + :param executions: The executions of this SqlMetrics. + :type: int + """ + self._executions = executions + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/database_management/models/sql_tuning_set.py b/src/oci/database_management/models/sql_tuning_set.py new file mode 100644 index 0000000000..bf49d3bd6f --- /dev/null +++ b/src/oci/database_management/models/sql_tuning_set.py @@ -0,0 +1,479 @@ +# coding: utf-8 +# Copyright (c) 2016, 2023, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20201101 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class SqlTuningSet(object): + """ + Details of the Sql tuning set. + """ + + #: A constant which can be used with the status property of a SqlTuningSet. + #: This constant has a value of "DISABLED" + STATUS_DISABLED = "DISABLED" + + #: A constant which can be used with the status property of a SqlTuningSet. + #: This constant has a value of "RETRY_SCHEDULED" + STATUS_RETRY_SCHEDULED = "RETRY_SCHEDULED" + + #: A constant which can be used with the status property of a SqlTuningSet. + #: This constant has a value of "SCHEDULED" + STATUS_SCHEDULED = "SCHEDULED" + + #: A constant which can be used with the status property of a SqlTuningSet. + #: This constant has a value of "BLOCKED" + STATUS_BLOCKED = "BLOCKED" + + #: A constant which can be used with the status property of a SqlTuningSet. + #: This constant has a value of "RUNNING" + STATUS_RUNNING = "RUNNING" + + #: A constant which can be used with the status property of a SqlTuningSet. + #: This constant has a value of "COMPLETED" + STATUS_COMPLETED = "COMPLETED" + + #: A constant which can be used with the status property of a SqlTuningSet. + #: This constant has a value of "BROKEN" + STATUS_BROKEN = "BROKEN" + + #: A constant which can be used with the status property of a SqlTuningSet. + #: This constant has a value of "FAILED" + STATUS_FAILED = "FAILED" + + #: A constant which can be used with the status property of a SqlTuningSet. + #: This constant has a value of "REMOTE" + STATUS_REMOTE = "REMOTE" + + #: A constant which can be used with the status property of a SqlTuningSet. + #: This constant has a value of "RESOURCE_UNAVAILABLE" + STATUS_RESOURCE_UNAVAILABLE = "RESOURCE_UNAVAILABLE" + + #: A constant which can be used with the status property of a SqlTuningSet. + #: This constant has a value of "SUCCEEDED" + STATUS_SUCCEEDED = "SUCCEEDED" + + #: A constant which can be used with the status property of a SqlTuningSet. + #: This constant has a value of "CHAIN_STALLED" + STATUS_CHAIN_STALLED = "CHAIN_STALLED" + + def __init__(self, **kwargs): + """ + Initializes a new SqlTuningSet object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param id: + The value to assign to the id property of this SqlTuningSet. + :type id: int + + :param owner: + The value to assign to the owner property of this SqlTuningSet. + :type owner: str + + :param name: + The value to assign to the name property of this SqlTuningSet. + :type name: str + + :param statement_count: + The value to assign to the statement_count property of this SqlTuningSet. + :type statement_count: int + + :param time_created: + The value to assign to the time_created property of this SqlTuningSet. + :type time_created: datetime + + :param description: + The value to assign to the description property of this SqlTuningSet. + :type description: str + + :param time_last_modified: + The value to assign to the time_last_modified property of this SqlTuningSet. + :type time_last_modified: datetime + + :param status: + The value to assign to the status property of this SqlTuningSet. + Allowed values for this property are: "DISABLED", "RETRY_SCHEDULED", "SCHEDULED", "BLOCKED", "RUNNING", "COMPLETED", "BROKEN", "FAILED", "REMOTE", "RESOURCE_UNAVAILABLE", "SUCCEEDED", "CHAIN_STALLED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type status: str + + :param scheduled_job_name: + The value to assign to the scheduled_job_name property of this SqlTuningSet. + :type scheduled_job_name: str + + :param error_message: + The value to assign to the error_message property of this SqlTuningSet. + :type error_message: str + + :param all_sql_statements_fetched: + The value to assign to the all_sql_statements_fetched property of this SqlTuningSet. + :type all_sql_statements_fetched: str + + :param sql_list: + The value to assign to the sql_list property of this SqlTuningSet. + :type sql_list: list[oci.database_management.models.SqlInSqlTuningSet] + + """ + self.swagger_types = { + 'id': 'int', + 'owner': 'str', + 'name': 'str', + 'statement_count': 'int', + 'time_created': 'datetime', + 'description': 'str', + 'time_last_modified': 'datetime', + 'status': 'str', + 'scheduled_job_name': 'str', + 'error_message': 'str', + 'all_sql_statements_fetched': 'str', + 'sql_list': 'list[SqlInSqlTuningSet]' + } + + self.attribute_map = { + 'id': 'id', + 'owner': 'owner', + 'name': 'name', + 'statement_count': 'statementCount', + 'time_created': 'timeCreated', + 'description': 'description', + 'time_last_modified': 'timeLastModified', + 'status': 'status', + 'scheduled_job_name': 'scheduledJobName', + 'error_message': 'errorMessage', + 'all_sql_statements_fetched': 'allSqlStatementsFetched', + 'sql_list': 'sqlList' + } + + self._id = None + self._owner = None + self._name = None + self._statement_count = None + self._time_created = None + self._description = None + self._time_last_modified = None + self._status = None + self._scheduled_job_name = None + self._error_message = None + self._all_sql_statements_fetched = None + self._sql_list = None + + @property + def id(self): + """ + Gets the id of this SqlTuningSet. + The unique Sql tuning set identifier. + + + :return: The id of this SqlTuningSet. + :rtype: int + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this SqlTuningSet. + The unique Sql tuning set identifier. + + + :param id: The id of this SqlTuningSet. + :type: int + """ + self._id = id + + @property + def owner(self): + """ + **[Required]** Gets the owner of this SqlTuningSet. + The owner of the Sql tuning set. + + + :return: The owner of this SqlTuningSet. + :rtype: str + """ + return self._owner + + @owner.setter + def owner(self, owner): + """ + Sets the owner of this SqlTuningSet. + The owner of the Sql tuning set. + + + :param owner: The owner of this SqlTuningSet. + :type: str + """ + self._owner = owner + + @property + def name(self): + """ + **[Required]** Gets the name of this SqlTuningSet. + The name of the Sql tuning set. + + + :return: The name of this SqlTuningSet. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this SqlTuningSet. + The name of the Sql tuning set. + + + :param name: The name of this SqlTuningSet. + :type: str + """ + self._name = name + + @property + def statement_count(self): + """ + Gets the statement_count of this SqlTuningSet. + Number of statements in the Sql tuning set + + + :return: The statement_count of this SqlTuningSet. + :rtype: int + """ + return self._statement_count + + @statement_count.setter + def statement_count(self, statement_count): + """ + Sets the statement_count of this SqlTuningSet. + Number of statements in the Sql tuning set + + + :param statement_count: The statement_count of this SqlTuningSet. + :type: int + """ + self._statement_count = statement_count + + @property + def time_created(self): + """ + Gets the time_created of this SqlTuningSet. + The created time of the Sql tuning set. + + + :return: The time_created of this SqlTuningSet. + :rtype: datetime + """ + return self._time_created + + @time_created.setter + def time_created(self, time_created): + """ + Sets the time_created of this SqlTuningSet. + The created time of the Sql tuning set. + + + :param time_created: The time_created of this SqlTuningSet. + :type: datetime + """ + self._time_created = time_created + + @property + def description(self): + """ + Gets the description of this SqlTuningSet. + The description of the Sql tuning set. + + + :return: The description of this SqlTuningSet. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this SqlTuningSet. + The description of the Sql tuning set. + + + :param description: The description of this SqlTuningSet. + :type: str + """ + self._description = description + + @property + def time_last_modified(self): + """ + Gets the time_last_modified of this SqlTuningSet. + Last modified time of the Sql tuning set. + + + :return: The time_last_modified of this SqlTuningSet. + :rtype: datetime + """ + return self._time_last_modified + + @time_last_modified.setter + def time_last_modified(self, time_last_modified): + """ + Sets the time_last_modified of this SqlTuningSet. + Last modified time of the Sql tuning set. + + + :param time_last_modified: The time_last_modified of this SqlTuningSet. + :type: datetime + """ + self._time_last_modified = time_last_modified + + @property + def status(self): + """ + Gets the status of this SqlTuningSet. + Current status of the Sql tuning set. + + Allowed values for this property are: "DISABLED", "RETRY_SCHEDULED", "SCHEDULED", "BLOCKED", "RUNNING", "COMPLETED", "BROKEN", "FAILED", "REMOTE", "RESOURCE_UNAVAILABLE", "SUCCEEDED", "CHAIN_STALLED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The status of this SqlTuningSet. + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """ + Sets the status of this SqlTuningSet. + Current status of the Sql tuning set. + + + :param status: The status of this SqlTuningSet. + :type: str + """ + allowed_values = ["DISABLED", "RETRY_SCHEDULED", "SCHEDULED", "BLOCKED", "RUNNING", "COMPLETED", "BROKEN", "FAILED", "REMOTE", "RESOURCE_UNAVAILABLE", "SUCCEEDED", "CHAIN_STALLED"] + if not value_allowed_none_or_none_sentinel(status, allowed_values): + status = 'UNKNOWN_ENUM_VALUE' + self._status = status + + @property + def scheduled_job_name(self): + """ + Gets the scheduled_job_name of this SqlTuningSet. + Name of the Sql tuning set scheduler job. + + + :return: The scheduled_job_name of this SqlTuningSet. + :rtype: str + """ + return self._scheduled_job_name + + @scheduled_job_name.setter + def scheduled_job_name(self, scheduled_job_name): + """ + Sets the scheduled_job_name of this SqlTuningSet. + Name of the Sql tuning set scheduler job. + + + :param scheduled_job_name: The scheduled_job_name of this SqlTuningSet. + :type: str + """ + self._scheduled_job_name = scheduled_job_name + + @property + def error_message(self): + """ + Gets the error_message of this SqlTuningSet. + Latest execution error of the plsql that was submitted as a scheduler job. + + + :return: The error_message of this SqlTuningSet. + :rtype: str + """ + return self._error_message + + @error_message.setter + def error_message(self, error_message): + """ + Sets the error_message of this SqlTuningSet. + Latest execution error of the plsql that was submitted as a scheduler job. + + + :param error_message: The error_message of this SqlTuningSet. + :type: str + """ + self._error_message = error_message + + @property + def all_sql_statements_fetched(self): + """ + Gets the all_sql_statements_fetched of this SqlTuningSet. + In OCI database management, there is a limit to fetch only 2000 rows. + This flag indicates whether all Sql statements of this Sql tuning set matching the filter criteria are fetched or not. + Possible values are 'Yes' or 'No' + - Yes - All Sql statements matching the filter criteria are fetched. + - No - There are more Sql statements matching the fitler criteria. + User should fine tune the filter criteria to narrow down the result set. + + + :return: The all_sql_statements_fetched of this SqlTuningSet. + :rtype: str + """ + return self._all_sql_statements_fetched + + @all_sql_statements_fetched.setter + def all_sql_statements_fetched(self, all_sql_statements_fetched): + """ + Sets the all_sql_statements_fetched of this SqlTuningSet. + In OCI database management, there is a limit to fetch only 2000 rows. + This flag indicates whether all Sql statements of this Sql tuning set matching the filter criteria are fetched or not. + Possible values are 'Yes' or 'No' + - Yes - All Sql statements matching the filter criteria are fetched. + - No - There are more Sql statements matching the fitler criteria. + User should fine tune the filter criteria to narrow down the result set. + + + :param all_sql_statements_fetched: The all_sql_statements_fetched of this SqlTuningSet. + :type: str + """ + self._all_sql_statements_fetched = all_sql_statements_fetched + + @property + def sql_list(self): + """ + Gets the sql_list of this SqlTuningSet. + A list of the Sqls associated with the Sql tuning set. + + + :return: The sql_list of this SqlTuningSet. + :rtype: list[oci.database_management.models.SqlInSqlTuningSet] + """ + return self._sql_list + + @sql_list.setter + def sql_list(self, sql_list): + """ + Sets the sql_list of this SqlTuningSet. + A list of the Sqls associated with the Sql tuning set. + + + :param sql_list: The sql_list of this SqlTuningSet. + :type: list[oci.database_management.models.SqlInSqlTuningSet] + """ + self._sql_list = sql_list + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/database_management/models/sql_tuning_set_admin_action_status.py b/src/oci/database_management/models/sql_tuning_set_admin_action_status.py new file mode 100644 index 0000000000..e1c05723b3 --- /dev/null +++ b/src/oci/database_management/models/sql_tuning_set_admin_action_status.py @@ -0,0 +1,245 @@ +# coding: utf-8 +# Copyright (c) 2016, 2023, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20201101 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class SqlTuningSetAdminActionStatus(object): + """ + The status of a Sql tuning set admin action. + """ + + #: A constant which can be used with the status property of a SqlTuningSetAdminActionStatus. + #: This constant has a value of "SUCCEEDED" + STATUS_SUCCEEDED = "SUCCEEDED" + + #: A constant which can be used with the status property of a SqlTuningSetAdminActionStatus. + #: This constant has a value of "FAILED" + STATUS_FAILED = "FAILED" + + def __init__(self, **kwargs): + """ + Initializes a new SqlTuningSetAdminActionStatus object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param status: + The value to assign to the status property of this SqlTuningSetAdminActionStatus. + Allowed values for this property are: "SUCCEEDED", "FAILED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type status: str + + :param success_message: + The value to assign to the success_message property of this SqlTuningSetAdminActionStatus. + :type success_message: str + + :param error_code: + The value to assign to the error_code property of this SqlTuningSetAdminActionStatus. + :type error_code: int + + :param error_message: + The value to assign to the error_message property of this SqlTuningSetAdminActionStatus. + :type error_message: str + + :param show_sql_only: + The value to assign to the show_sql_only property of this SqlTuningSetAdminActionStatus. + :type show_sql_only: int + + :param sql_statement: + The value to assign to the sql_statement property of this SqlTuningSetAdminActionStatus. + :type sql_statement: str + + """ + self.swagger_types = { + 'status': 'str', + 'success_message': 'str', + 'error_code': 'int', + 'error_message': 'str', + 'show_sql_only': 'int', + 'sql_statement': 'str' + } + + self.attribute_map = { + 'status': 'status', + 'success_message': 'successMessage', + 'error_code': 'errorCode', + 'error_message': 'errorMessage', + 'show_sql_only': 'showSqlOnly', + 'sql_statement': 'sqlStatement' + } + + self._status = None + self._success_message = None + self._error_code = None + self._error_message = None + self._show_sql_only = None + self._sql_statement = None + + @property + def status(self): + """ + **[Required]** Gets the status of this SqlTuningSetAdminActionStatus. + The status of a Sql tuning set admin action. + + Allowed values for this property are: "SUCCEEDED", "FAILED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The status of this SqlTuningSetAdminActionStatus. + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """ + Sets the status of this SqlTuningSetAdminActionStatus. + The status of a Sql tuning set admin action. + + + :param status: The status of this SqlTuningSetAdminActionStatus. + :type: str + """ + allowed_values = ["SUCCEEDED", "FAILED"] + if not value_allowed_none_or_none_sentinel(status, allowed_values): + status = 'UNKNOWN_ENUM_VALUE' + self._status = status + + @property + def success_message(self): + """ + Gets the success_message of this SqlTuningSetAdminActionStatus. + The success message of the Sql tuning set admin action. The success message is \"null\" if the admin action is non successful. + + + :return: The success_message of this SqlTuningSetAdminActionStatus. + :rtype: str + """ + return self._success_message + + @success_message.setter + def success_message(self, success_message): + """ + Sets the success_message of this SqlTuningSetAdminActionStatus. + The success message of the Sql tuning set admin action. The success message is \"null\" if the admin action is non successful. + + + :param success_message: The success_message of this SqlTuningSetAdminActionStatus. + :type: str + """ + self._success_message = success_message + + @property + def error_code(self): + """ + Gets the error_code of this SqlTuningSetAdminActionStatus. + The error code that denotes failure if the Sql tuning set admin action is not successful. The error code is \"null\" if the admin action is successful. + + + :return: The error_code of this SqlTuningSetAdminActionStatus. + :rtype: int + """ + return self._error_code + + @error_code.setter + def error_code(self, error_code): + """ + Sets the error_code of this SqlTuningSetAdminActionStatus. + The error code that denotes failure if the Sql tuning set admin action is not successful. The error code is \"null\" if the admin action is successful. + + + :param error_code: The error_code of this SqlTuningSetAdminActionStatus. + :type: int + """ + self._error_code = error_code + + @property + def error_message(self): + """ + Gets the error_message of this SqlTuningSetAdminActionStatus. + The error message that indicates the reason for failure if the Sql tuning set admin action is not successful. The error message is \"null\" if the admin action is successful. + + + :return: The error_message of this SqlTuningSetAdminActionStatus. + :rtype: str + """ + return self._error_message + + @error_message.setter + def error_message(self, error_message): + """ + Sets the error_message of this SqlTuningSetAdminActionStatus. + The error message that indicates the reason for failure if the Sql tuning set admin action is not successful. The error message is \"null\" if the admin action is successful. + + + :param error_message: The error_message of this SqlTuningSetAdminActionStatus. + :type: str + """ + self._error_message = error_message + + @property + def show_sql_only(self): + """ + Gets the show_sql_only of this SqlTuningSetAdminActionStatus. + Flag to indicate whether to create the Sql tuning set or just display the plsql used for the selected user action. + + + :return: The show_sql_only of this SqlTuningSetAdminActionStatus. + :rtype: int + """ + return self._show_sql_only + + @show_sql_only.setter + def show_sql_only(self, show_sql_only): + """ + Sets the show_sql_only of this SqlTuningSetAdminActionStatus. + Flag to indicate whether to create the Sql tuning set or just display the plsql used for the selected user action. + + + :param show_sql_only: The show_sql_only of this SqlTuningSetAdminActionStatus. + :type: int + """ + self._show_sql_only = show_sql_only + + @property + def sql_statement(self): + """ + Gets the sql_statement of this SqlTuningSetAdminActionStatus. + When showSqlOnly is set to 1, this attribute displays the plsql generated for the selected user action. + When showSqlOnly is set to 0, this attribute will not be returned. + + + :return: The sql_statement of this SqlTuningSetAdminActionStatus. + :rtype: str + """ + return self._sql_statement + + @sql_statement.setter + def sql_statement(self, sql_statement): + """ + Sets the sql_statement of this SqlTuningSetAdminActionStatus. + When showSqlOnly is set to 1, this attribute displays the plsql generated for the selected user action. + When showSqlOnly is set to 0, this attribute will not be returned. + + + :param sql_statement: The sql_statement of this SqlTuningSetAdminActionStatus. + :type: str + """ + self._sql_statement = sql_statement + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/database_management/models/sql_tuning_set_admin_credential_details.py b/src/oci/database_management/models/sql_tuning_set_admin_credential_details.py new file mode 100644 index 0000000000..390c2eaa3b --- /dev/null +++ b/src/oci/database_management/models/sql_tuning_set_admin_credential_details.py @@ -0,0 +1,189 @@ +# coding: utf-8 +# Copyright (c) 2016, 2023, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20201101 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class SqlTuningSetAdminCredentialDetails(object): + """ + The credential to connect to the database to perform Sql tuning set administration tasks. + """ + + #: A constant which can be used with the sql_tuning_set_admin_credential_type property of a SqlTuningSetAdminCredentialDetails. + #: This constant has a value of "SECRET" + SQL_TUNING_SET_ADMIN_CREDENTIAL_TYPE_SECRET = "SECRET" + + #: A constant which can be used with the sql_tuning_set_admin_credential_type property of a SqlTuningSetAdminCredentialDetails. + #: This constant has a value of "PASSWORD" + SQL_TUNING_SET_ADMIN_CREDENTIAL_TYPE_PASSWORD = "PASSWORD" + + #: A constant which can be used with the role property of a SqlTuningSetAdminCredentialDetails. + #: This constant has a value of "NORMAL" + ROLE_NORMAL = "NORMAL" + + #: A constant which can be used with the role property of a SqlTuningSetAdminCredentialDetails. + #: This constant has a value of "SYSDBA" + ROLE_SYSDBA = "SYSDBA" + + def __init__(self, **kwargs): + """ + Initializes a new SqlTuningSetAdminCredentialDetails object with values from keyword arguments. This class has the following subclasses and if you are using this class as input + to a service operations then you should favor using a subclass over the base class: + + * :class:`~oci.database_management.models.SqlTuningSetAdminPasswordCredentialDetails` + * :class:`~oci.database_management.models.SqlTuningSetAdminSecretCredentialDetails` + + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param sql_tuning_set_admin_credential_type: + The value to assign to the sql_tuning_set_admin_credential_type property of this SqlTuningSetAdminCredentialDetails. + Allowed values for this property are: "SECRET", "PASSWORD" + :type sql_tuning_set_admin_credential_type: str + + :param username: + The value to assign to the username property of this SqlTuningSetAdminCredentialDetails. + :type username: str + + :param role: + The value to assign to the role property of this SqlTuningSetAdminCredentialDetails. + Allowed values for this property are: "NORMAL", "SYSDBA" + :type role: str + + """ + self.swagger_types = { + 'sql_tuning_set_admin_credential_type': 'str', + 'username': 'str', + 'role': 'str' + } + + self.attribute_map = { + 'sql_tuning_set_admin_credential_type': 'sqlTuningSetAdminCredentialType', + 'username': 'username', + 'role': 'role' + } + + self._sql_tuning_set_admin_credential_type = None + self._username = None + self._role = None + + @staticmethod + def get_subtype(object_dictionary): + """ + Given the hash representation of a subtype of this class, + use the info in the hash to return the class of the subtype. + """ + type = object_dictionary['sqlTuningSetAdminCredentialType'] + + if type == 'PASSWORD': + return 'SqlTuningSetAdminPasswordCredentialDetails' + + if type == 'SECRET': + return 'SqlTuningSetAdminSecretCredentialDetails' + else: + return 'SqlTuningSetAdminCredentialDetails' + + @property + def sql_tuning_set_admin_credential_type(self): + """ + **[Required]** Gets the sql_tuning_set_admin_credential_type of this SqlTuningSetAdminCredentialDetails. + The type of the credential for Sql tuning set administration tasks. + + Allowed values for this property are: "SECRET", "PASSWORD" + + + :return: The sql_tuning_set_admin_credential_type of this SqlTuningSetAdminCredentialDetails. + :rtype: str + """ + return self._sql_tuning_set_admin_credential_type + + @sql_tuning_set_admin_credential_type.setter + def sql_tuning_set_admin_credential_type(self, sql_tuning_set_admin_credential_type): + """ + Sets the sql_tuning_set_admin_credential_type of this SqlTuningSetAdminCredentialDetails. + The type of the credential for Sql tuning set administration tasks. + + + :param sql_tuning_set_admin_credential_type: The sql_tuning_set_admin_credential_type of this SqlTuningSetAdminCredentialDetails. + :type: str + """ + allowed_values = ["SECRET", "PASSWORD"] + if not value_allowed_none_or_none_sentinel(sql_tuning_set_admin_credential_type, allowed_values): + raise ValueError( + "Invalid value for `sql_tuning_set_admin_credential_type`, must be None or one of {0}" + .format(allowed_values) + ) + self._sql_tuning_set_admin_credential_type = sql_tuning_set_admin_credential_type + + @property + def username(self): + """ + **[Required]** Gets the username of this SqlTuningSetAdminCredentialDetails. + The user to connect to the database. + + + :return: The username of this SqlTuningSetAdminCredentialDetails. + :rtype: str + """ + return self._username + + @username.setter + def username(self, username): + """ + Sets the username of this SqlTuningSetAdminCredentialDetails. + The user to connect to the database. + + + :param username: The username of this SqlTuningSetAdminCredentialDetails. + :type: str + """ + self._username = username + + @property + def role(self): + """ + **[Required]** Gets the role of this SqlTuningSetAdminCredentialDetails. + The role of the database user. + + Allowed values for this property are: "NORMAL", "SYSDBA" + + + :return: The role of this SqlTuningSetAdminCredentialDetails. + :rtype: str + """ + return self._role + + @role.setter + def role(self, role): + """ + Sets the role of this SqlTuningSetAdminCredentialDetails. + The role of the database user. + + + :param role: The role of this SqlTuningSetAdminCredentialDetails. + :type: str + """ + allowed_values = ["NORMAL", "SYSDBA"] + if not value_allowed_none_or_none_sentinel(role, allowed_values): + raise ValueError( + "Invalid value for `role`, must be None or one of {0}" + .format(allowed_values) + ) + self._role = role + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/database_management/models/sql_tuning_set_admin_password_credential_details.py b/src/oci/database_management/models/sql_tuning_set_admin_password_credential_details.py new file mode 100644 index 0000000000..4257c156d6 --- /dev/null +++ b/src/oci/database_management/models/sql_tuning_set_admin_password_credential_details.py @@ -0,0 +1,97 @@ +# coding: utf-8 +# Copyright (c) 2016, 2023, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20201101 + +from .sql_tuning_set_admin_credential_details import SqlTuningSetAdminCredentialDetails +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class SqlTuningSetAdminPasswordCredentialDetails(SqlTuningSetAdminCredentialDetails): + """ + User provides a password to be used to connect to the database. + """ + + def __init__(self, **kwargs): + """ + Initializes a new SqlTuningSetAdminPasswordCredentialDetails object with values from keyword arguments. The default value of the :py:attr:`~oci.database_management.models.SqlTuningSetAdminPasswordCredentialDetails.sql_tuning_set_admin_credential_type` attribute + of this class is ``PASSWORD`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param sql_tuning_set_admin_credential_type: + The value to assign to the sql_tuning_set_admin_credential_type property of this SqlTuningSetAdminPasswordCredentialDetails. + Allowed values for this property are: "SECRET", "PASSWORD" + :type sql_tuning_set_admin_credential_type: str + + :param username: + The value to assign to the username property of this SqlTuningSetAdminPasswordCredentialDetails. + :type username: str + + :param role: + The value to assign to the role property of this SqlTuningSetAdminPasswordCredentialDetails. + Allowed values for this property are: "NORMAL", "SYSDBA" + :type role: str + + :param password: + The value to assign to the password property of this SqlTuningSetAdminPasswordCredentialDetails. + :type password: str + + """ + self.swagger_types = { + 'sql_tuning_set_admin_credential_type': 'str', + 'username': 'str', + 'role': 'str', + 'password': 'str' + } + + self.attribute_map = { + 'sql_tuning_set_admin_credential_type': 'sqlTuningSetAdminCredentialType', + 'username': 'username', + 'role': 'role', + 'password': 'password' + } + + self._sql_tuning_set_admin_credential_type = None + self._username = None + self._role = None + self._password = None + self._sql_tuning_set_admin_credential_type = 'PASSWORD' + + @property + def password(self): + """ + **[Required]** Gets the password of this SqlTuningSetAdminPasswordCredentialDetails. + The database user's password encoded using BASE64 scheme. + + + :return: The password of this SqlTuningSetAdminPasswordCredentialDetails. + :rtype: str + """ + return self._password + + @password.setter + def password(self, password): + """ + Sets the password of this SqlTuningSetAdminPasswordCredentialDetails. + The database user's password encoded using BASE64 scheme. + + + :param password: The password of this SqlTuningSetAdminPasswordCredentialDetails. + :type: str + """ + self._password = password + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/database_management/models/sql_tuning_set_admin_secret_credential_details.py b/src/oci/database_management/models/sql_tuning_set_admin_secret_credential_details.py new file mode 100644 index 0000000000..e8afafb543 --- /dev/null +++ b/src/oci/database_management/models/sql_tuning_set_admin_secret_credential_details.py @@ -0,0 +1,103 @@ +# coding: utf-8 +# Copyright (c) 2016, 2023, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20201101 + +from .sql_tuning_set_admin_credential_details import SqlTuningSetAdminCredentialDetails +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class SqlTuningSetAdminSecretCredentialDetails(SqlTuningSetAdminCredentialDetails): + """ + User provides a secret OCID, which will be used to retrieve the password to connect to the database. + """ + + def __init__(self, **kwargs): + """ + Initializes a new SqlTuningSetAdminSecretCredentialDetails object with values from keyword arguments. The default value of the :py:attr:`~oci.database_management.models.SqlTuningSetAdminSecretCredentialDetails.sql_tuning_set_admin_credential_type` attribute + of this class is ``SECRET`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param sql_tuning_set_admin_credential_type: + The value to assign to the sql_tuning_set_admin_credential_type property of this SqlTuningSetAdminSecretCredentialDetails. + Allowed values for this property are: "SECRET", "PASSWORD" + :type sql_tuning_set_admin_credential_type: str + + :param username: + The value to assign to the username property of this SqlTuningSetAdminSecretCredentialDetails. + :type username: str + + :param role: + The value to assign to the role property of this SqlTuningSetAdminSecretCredentialDetails. + Allowed values for this property are: "NORMAL", "SYSDBA" + :type role: str + + :param secret_id: + The value to assign to the secret_id property of this SqlTuningSetAdminSecretCredentialDetails. + :type secret_id: str + + """ + self.swagger_types = { + 'sql_tuning_set_admin_credential_type': 'str', + 'username': 'str', + 'role': 'str', + 'secret_id': 'str' + } + + self.attribute_map = { + 'sql_tuning_set_admin_credential_type': 'sqlTuningSetAdminCredentialType', + 'username': 'username', + 'role': 'role', + 'secret_id': 'secretId' + } + + self._sql_tuning_set_admin_credential_type = None + self._username = None + self._role = None + self._secret_id = None + self._sql_tuning_set_admin_credential_type = 'SECRET' + + @property + def secret_id(self): + """ + **[Required]** Gets the secret_id of this SqlTuningSetAdminSecretCredentialDetails. + The `OCID`__ of the Secret + where the database password is stored. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :return: The secret_id of this SqlTuningSetAdminSecretCredentialDetails. + :rtype: str + """ + return self._secret_id + + @secret_id.setter + def secret_id(self, secret_id): + """ + Sets the secret_id of this SqlTuningSetAdminSecretCredentialDetails. + The `OCID`__ of the Secret + where the database password is stored. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :param secret_id: The secret_id of this SqlTuningSetAdminSecretCredentialDetails. + :type: str + """ + self._secret_id = secret_id + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/database_management/models/sql_tuning_set_summary.py b/src/oci/database_management/models/sql_tuning_set_summary.py index 6d230cbc85..0692df0f64 100644 --- a/src/oci/database_management/models/sql_tuning_set_summary.py +++ b/src/oci/database_management/models/sql_tuning_set_summary.py @@ -15,6 +15,54 @@ class SqlTuningSetSummary(object): The summary information of a SQL tuning set. """ + #: A constant which can be used with the status property of a SqlTuningSetSummary. + #: This constant has a value of "DISABLED" + STATUS_DISABLED = "DISABLED" + + #: A constant which can be used with the status property of a SqlTuningSetSummary. + #: This constant has a value of "RETRY_SCHEDULED" + STATUS_RETRY_SCHEDULED = "RETRY_SCHEDULED" + + #: A constant which can be used with the status property of a SqlTuningSetSummary. + #: This constant has a value of "SCHEDULED" + STATUS_SCHEDULED = "SCHEDULED" + + #: A constant which can be used with the status property of a SqlTuningSetSummary. + #: This constant has a value of "BLOCKED" + STATUS_BLOCKED = "BLOCKED" + + #: A constant which can be used with the status property of a SqlTuningSetSummary. + #: This constant has a value of "RUNNING" + STATUS_RUNNING = "RUNNING" + + #: A constant which can be used with the status property of a SqlTuningSetSummary. + #: This constant has a value of "COMPLETED" + STATUS_COMPLETED = "COMPLETED" + + #: A constant which can be used with the status property of a SqlTuningSetSummary. + #: This constant has a value of "BROKEN" + STATUS_BROKEN = "BROKEN" + + #: A constant which can be used with the status property of a SqlTuningSetSummary. + #: This constant has a value of "FAILED" + STATUS_FAILED = "FAILED" + + #: A constant which can be used with the status property of a SqlTuningSetSummary. + #: This constant has a value of "REMOTE" + STATUS_REMOTE = "REMOTE" + + #: A constant which can be used with the status property of a SqlTuningSetSummary. + #: This constant has a value of "RESOURCE_UNAVAILABLE" + STATUS_RESOURCE_UNAVAILABLE = "RESOURCE_UNAVAILABLE" + + #: A constant which can be used with the status property of a SqlTuningSetSummary. + #: This constant has a value of "SUCCEEDED" + STATUS_SUCCEEDED = "SUCCEEDED" + + #: A constant which can be used with the status property of a SqlTuningSetSummary. + #: This constant has a value of "CHAIN_STALLED" + STATUS_CHAIN_STALLED = "CHAIN_STALLED" + def __init__(self, **kwargs): """ Initializes a new SqlTuningSetSummary object with values from keyword arguments. @@ -36,25 +84,69 @@ def __init__(self, **kwargs): The value to assign to the statement_counts property of this SqlTuningSetSummary. :type statement_counts: int + :param id: + The value to assign to the id property of this SqlTuningSetSummary. + :type id: int + + :param time_created: + The value to assign to the time_created property of this SqlTuningSetSummary. + :type time_created: datetime + + :param time_last_modified: + The value to assign to the time_last_modified property of this SqlTuningSetSummary. + :type time_last_modified: datetime + + :param status: + The value to assign to the status property of this SqlTuningSetSummary. + Allowed values for this property are: "DISABLED", "RETRY_SCHEDULED", "SCHEDULED", "BLOCKED", "RUNNING", "COMPLETED", "BROKEN", "FAILED", "REMOTE", "RESOURCE_UNAVAILABLE", "SUCCEEDED", "CHAIN_STALLED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type status: str + + :param scheduled_job_name: + The value to assign to the scheduled_job_name property of this SqlTuningSetSummary. + :type scheduled_job_name: str + + :param error_message: + The value to assign to the error_message property of this SqlTuningSetSummary. + :type error_message: str + """ self.swagger_types = { 'name': 'str', 'owner': 'str', 'description': 'str', - 'statement_counts': 'int' + 'statement_counts': 'int', + 'id': 'int', + 'time_created': 'datetime', + 'time_last_modified': 'datetime', + 'status': 'str', + 'scheduled_job_name': 'str', + 'error_message': 'str' } self.attribute_map = { 'name': 'name', 'owner': 'owner', 'description': 'description', - 'statement_counts': 'statementCounts' + 'statement_counts': 'statementCounts', + 'id': 'id', + 'time_created': 'timeCreated', + 'time_last_modified': 'timeLastModified', + 'status': 'status', + 'scheduled_job_name': 'scheduledJobName', + 'error_message': 'errorMessage' } self._name = None self._owner = None self._description = None self._statement_counts = None + self._id = None + self._time_created = None + self._time_last_modified = None + self._status = None + self._scheduled_job_name = None + self._error_message = None @property def name(self): @@ -152,6 +244,156 @@ def statement_counts(self, statement_counts): """ self._statement_counts = statement_counts + @property + def id(self): + """ + Gets the id of this SqlTuningSetSummary. + The unique Sql tuning set identifier. This is not OCID. + + + :return: The id of this SqlTuningSetSummary. + :rtype: int + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this SqlTuningSetSummary. + The unique Sql tuning set identifier. This is not OCID. + + + :param id: The id of this SqlTuningSetSummary. + :type: int + """ + self._id = id + + @property + def time_created(self): + """ + Gets the time_created of this SqlTuningSetSummary. + The created time of the Sql tuning set. + + + :return: The time_created of this SqlTuningSetSummary. + :rtype: datetime + """ + return self._time_created + + @time_created.setter + def time_created(self, time_created): + """ + Sets the time_created of this SqlTuningSetSummary. + The created time of the Sql tuning set. + + + :param time_created: The time_created of this SqlTuningSetSummary. + :type: datetime + """ + self._time_created = time_created + + @property + def time_last_modified(self): + """ + Gets the time_last_modified of this SqlTuningSetSummary. + Last modified time of the Sql tuning set. + + + :return: The time_last_modified of this SqlTuningSetSummary. + :rtype: datetime + """ + return self._time_last_modified + + @time_last_modified.setter + def time_last_modified(self, time_last_modified): + """ + Sets the time_last_modified of this SqlTuningSetSummary. + Last modified time of the Sql tuning set. + + + :param time_last_modified: The time_last_modified of this SqlTuningSetSummary. + :type: datetime + """ + self._time_last_modified = time_last_modified + + @property + def status(self): + """ + Gets the status of this SqlTuningSetSummary. + Current status of the Sql tuning set. + + Allowed values for this property are: "DISABLED", "RETRY_SCHEDULED", "SCHEDULED", "BLOCKED", "RUNNING", "COMPLETED", "BROKEN", "FAILED", "REMOTE", "RESOURCE_UNAVAILABLE", "SUCCEEDED", "CHAIN_STALLED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The status of this SqlTuningSetSummary. + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """ + Sets the status of this SqlTuningSetSummary. + Current status of the Sql tuning set. + + + :param status: The status of this SqlTuningSetSummary. + :type: str + """ + allowed_values = ["DISABLED", "RETRY_SCHEDULED", "SCHEDULED", "BLOCKED", "RUNNING", "COMPLETED", "BROKEN", "FAILED", "REMOTE", "RESOURCE_UNAVAILABLE", "SUCCEEDED", "CHAIN_STALLED"] + if not value_allowed_none_or_none_sentinel(status, allowed_values): + status = 'UNKNOWN_ENUM_VALUE' + self._status = status + + @property + def scheduled_job_name(self): + """ + Gets the scheduled_job_name of this SqlTuningSetSummary. + Name of the Sql tuning set scheduler job. + + + :return: The scheduled_job_name of this SqlTuningSetSummary. + :rtype: str + """ + return self._scheduled_job_name + + @scheduled_job_name.setter + def scheduled_job_name(self, scheduled_job_name): + """ + Sets the scheduled_job_name of this SqlTuningSetSummary. + Name of the Sql tuning set scheduler job. + + + :param scheduled_job_name: The scheduled_job_name of this SqlTuningSetSummary. + :type: str + """ + self._scheduled_job_name = scheduled_job_name + + @property + def error_message(self): + """ + Gets the error_message of this SqlTuningSetSummary. + Latest execution error of the plsql that was submitted as a scheduler job. + + + :return: The error_message of this SqlTuningSetSummary. + :rtype: str + """ + return self._error_message + + @error_message.setter + def error_message(self, error_message): + """ + Sets the error_message of this SqlTuningSetSummary. + Latest execution error of the plsql that was submitted as a scheduler job. + + + :param error_message: The error_message of this SqlTuningSetSummary. + :type: str + """ + self._error_message = error_message + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/database_management/models/update_external_db_system_macs_connector_details.py b/src/oci/database_management/models/update_external_db_system_macs_connector_details.py index b7587e5900..222d6cf06e 100644 --- a/src/oci/database_management/models/update_external_db_system_macs_connector_details.py +++ b/src/oci/database_management/models/update_external_db_system_macs_connector_details.py @@ -51,7 +51,7 @@ def __init__(self, **kwargs): @property def connection_info(self): """ - **[Required]** Gets the connection_info of this UpdateExternalDbSystemMacsConnectorDetails. + Gets the connection_info of this UpdateExternalDbSystemMacsConnectorDetails. :return: The connection_info of this UpdateExternalDbSystemMacsConnectorDetails. :rtype: oci.database_management.models.ExternalDbSystemConnectionInfo diff --git a/src/oci/database_management/models/validate_basic_filter_details.py b/src/oci/database_management/models/validate_basic_filter_details.py new file mode 100644 index 0000000000..bee172c7f0 --- /dev/null +++ b/src/oci/database_management/models/validate_basic_filter_details.py @@ -0,0 +1,165 @@ +# coding: utf-8 +# Copyright (c) 2016, 2023, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20201101 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ValidateBasicFilterDetails(object): + """ + Validate the basic filter criteria provided by the user. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ValidateBasicFilterDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param credential_details: + The value to assign to the credential_details property of this ValidateBasicFilterDetails. + :type credential_details: oci.database_management.models.SqlTuningSetAdminCredentialDetails + + :param owner: + The value to assign to the owner property of this ValidateBasicFilterDetails. + :type owner: str + + :param name: + The value to assign to the name property of this ValidateBasicFilterDetails. + :type name: str + + :param basic_filter: + The value to assign to the basic_filter property of this ValidateBasicFilterDetails. + :type basic_filter: str + + """ + self.swagger_types = { + 'credential_details': 'SqlTuningSetAdminCredentialDetails', + 'owner': 'str', + 'name': 'str', + 'basic_filter': 'str' + } + + self.attribute_map = { + 'credential_details': 'credentialDetails', + 'owner': 'owner', + 'name': 'name', + 'basic_filter': 'basicFilter' + } + + self._credential_details = None + self._owner = None + self._name = None + self._basic_filter = None + + @property + def credential_details(self): + """ + **[Required]** Gets the credential_details of this ValidateBasicFilterDetails. + + :return: The credential_details of this ValidateBasicFilterDetails. + :rtype: oci.database_management.models.SqlTuningSetAdminCredentialDetails + """ + return self._credential_details + + @credential_details.setter + def credential_details(self, credential_details): + """ + Sets the credential_details of this ValidateBasicFilterDetails. + + :param credential_details: The credential_details of this ValidateBasicFilterDetails. + :type: oci.database_management.models.SqlTuningSetAdminCredentialDetails + """ + self._credential_details = credential_details + + @property + def owner(self): + """ + **[Required]** Gets the owner of this ValidateBasicFilterDetails. + The owner of the Sql tuning set. + + + :return: The owner of this ValidateBasicFilterDetails. + :rtype: str + """ + return self._owner + + @owner.setter + def owner(self, owner): + """ + Sets the owner of this ValidateBasicFilterDetails. + The owner of the Sql tuning set. + + + :param owner: The owner of this ValidateBasicFilterDetails. + :type: str + """ + self._owner = owner + + @property + def name(self): + """ + **[Required]** Gets the name of this ValidateBasicFilterDetails. + The name of the Sql tuning set. + + + :return: The name of this ValidateBasicFilterDetails. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this ValidateBasicFilterDetails. + The name of the Sql tuning set. + + + :param name: The name of this ValidateBasicFilterDetails. + :type: str + """ + self._name = name + + @property + def basic_filter(self): + """ + **[Required]** Gets the basic_filter of this ValidateBasicFilterDetails. + Specifies the Sql predicate to filter the Sql from the Sql tuning set defined on attributes of the SQLSET_ROW. + User could use any combination of the following columns with appropriate values as Sql predicate + Refer to the documentation https://docs.oracle.com/en/database/oracle/oracle-database/18/arpls/DBMS_SQLTUNE.html#GUID-1F4AFB03-7B29-46FC-B3F2-CB01EC36326C + + + :return: The basic_filter of this ValidateBasicFilterDetails. + :rtype: str + """ + return self._basic_filter + + @basic_filter.setter + def basic_filter(self, basic_filter): + """ + Sets the basic_filter of this ValidateBasicFilterDetails. + Specifies the Sql predicate to filter the Sql from the Sql tuning set defined on attributes of the SQLSET_ROW. + User could use any combination of the following columns with appropriate values as Sql predicate + Refer to the documentation https://docs.oracle.com/en/database/oracle/oracle-database/18/arpls/DBMS_SQLTUNE.html#GUID-1F4AFB03-7B29-46FC-B3F2-CB01EC36326C + + + :param basic_filter: The basic_filter of this ValidateBasicFilterDetails. + :type: str + """ + self._basic_filter = basic_filter + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/database_management/models/work_request_resource.py b/src/oci/database_management/models/work_request_resource.py index 63218d9b78..e4d0762f34 100644 --- a/src/oci/database_management/models/work_request_resource.py +++ b/src/oci/database_management/models/work_request_resource.py @@ -39,6 +39,10 @@ class WorkRequestResource(object): #: This constant has a value of "FAILED" ACTION_TYPE_FAILED = "FAILED" + #: A constant which can be used with the action_type property of a WorkRequestResource. + #: This constant has a value of "ACCEPTED" + ACTION_TYPE_ACCEPTED = "ACCEPTED" + #: A constant which can be used with the action_type property of a WorkRequestResource. #: This constant has a value of "ENABLED" ACTION_TYPE_ENABLED = "ENABLED" @@ -58,7 +62,7 @@ def __init__(self, **kwargs): :param action_type: The value to assign to the action_type property of this WorkRequestResource. - Allowed values for this property are: "CREATED", "UPDATED", "DELETED", "IN_PROGRESS", "RELATED", "FAILED", "ENABLED", "DISABLED", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "CREATED", "UPDATED", "DELETED", "IN_PROGRESS", "RELATED", "FAILED", "ACCEPTED", "ENABLED", "DISABLED", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type action_type: str @@ -137,7 +141,7 @@ def action_type(self): work is complete for that resource at which point it will transition to CREATED, UPDATED, or DELETED, respectively. - Allowed values for this property are: "CREATED", "UPDATED", "DELETED", "IN_PROGRESS", "RELATED", "FAILED", "ENABLED", "DISABLED", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "CREATED", "UPDATED", "DELETED", "IN_PROGRESS", "RELATED", "FAILED", "ACCEPTED", "ENABLED", "DISABLED", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -159,7 +163,7 @@ def action_type(self, action_type): :param action_type: The action_type of this WorkRequestResource. :type: str """ - allowed_values = ["CREATED", "UPDATED", "DELETED", "IN_PROGRESS", "RELATED", "FAILED", "ENABLED", "DISABLED"] + allowed_values = ["CREATED", "UPDATED", "DELETED", "IN_PROGRESS", "RELATED", "FAILED", "ACCEPTED", "ENABLED", "DISABLED"] if not value_allowed_none_or_none_sentinel(action_type, allowed_values): action_type = 'UNKNOWN_ENUM_VALUE' self._action_type = action_type diff --git a/src/oci/database_management/models/work_request_sub_resource.py b/src/oci/database_management/models/work_request_sub_resource.py index a482ac2861..96cb11c4bd 100644 --- a/src/oci/database_management/models/work_request_sub_resource.py +++ b/src/oci/database_management/models/work_request_sub_resource.py @@ -39,6 +39,10 @@ class WorkRequestSubResource(object): #: This constant has a value of "FAILED" ACTION_TYPE_FAILED = "FAILED" + #: A constant which can be used with the action_type property of a WorkRequestSubResource. + #: This constant has a value of "ACCEPTED" + ACTION_TYPE_ACCEPTED = "ACCEPTED" + #: A constant which can be used with the action_type property of a WorkRequestSubResource. #: This constant has a value of "ENABLED" ACTION_TYPE_ENABLED = "ENABLED" @@ -62,7 +66,7 @@ def __init__(self, **kwargs): :param action_type: The value to assign to the action_type property of this WorkRequestSubResource. - Allowed values for this property are: "CREATED", "UPDATED", "DELETED", "IN_PROGRESS", "RELATED", "FAILED", "ENABLED", "DISABLED", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "CREATED", "UPDATED", "DELETED", "IN_PROGRESS", "RELATED", "FAILED", "ACCEPTED", "ENABLED", "DISABLED", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type action_type: str @@ -161,7 +165,7 @@ def action_type(self): work is complete for that resource at which point it will transition to CREATED, UPDATED, or DELETED, respectively. - Allowed values for this property are: "CREATED", "UPDATED", "DELETED", "IN_PROGRESS", "RELATED", "FAILED", "ENABLED", "DISABLED", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "CREATED", "UPDATED", "DELETED", "IN_PROGRESS", "RELATED", "FAILED", "ACCEPTED", "ENABLED", "DISABLED", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -183,7 +187,7 @@ def action_type(self, action_type): :param action_type: The action_type of this WorkRequestSubResource. :type: str """ - allowed_values = ["CREATED", "UPDATED", "DELETED", "IN_PROGRESS", "RELATED", "FAILED", "ENABLED", "DISABLED"] + allowed_values = ["CREATED", "UPDATED", "DELETED", "IN_PROGRESS", "RELATED", "FAILED", "ACCEPTED", "ENABLED", "DISABLED"] if not value_allowed_none_or_none_sentinel(action_type, allowed_values): action_type = 'UNKNOWN_ENUM_VALUE' self._action_type = action_type diff --git a/src/oci/database_management/perfhub_client.py b/src/oci/database_management/perfhub_client.py new file mode 100644 index 0000000000..532bf8982d --- /dev/null +++ b/src/oci/database_management/perfhub_client.py @@ -0,0 +1,220 @@ +# coding: utf-8 +# Copyright (c) 2016, 2023, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20201101 + +from __future__ import absolute_import + +from oci._vendor import requests # noqa: F401 +from oci._vendor import six + +from oci import retry, circuit_breaker # noqa: F401 +from oci.base_client import BaseClient +from oci.config import get_config_value_or_default, validate_config +from oci.signer import Signer +from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET +from .models import database_management_type_mapping +missing = Sentinel("Missing") + + +class PerfhubClient(object): + """ + Use the Database Management API to perform tasks such as obtaining performance and resource usage metrics + for a fleet of Managed Databases or a specific Managed Database, creating Managed Database Groups, and + running a SQL job on a Managed Database or Managed Database Group. + """ + + def __init__(self, config, **kwargs): + """ + Creates a new service client + + :param dict config: + Configuration keys and values as per `SDK and Tool Configuration `__. + The :py:meth:`~oci.config.from_file` method can be used to load configuration from a file. Alternatively, a ``dict`` can be passed. You can validate_config + the dict using :py:meth:`~oci.config.validate_config` + + :param str service_endpoint: (optional) + The endpoint of the service to call using this client. For example ``https://iaas.us-ashburn-1.oraclecloud.com``. If this keyword argument is + not provided then it will be derived using the region in the config parameter. You should only provide this keyword argument if you have an explicit + need to specify a service endpoint. + + :param timeout: (optional) + The connection and read timeouts for the client. The default values are connection timeout 10 seconds and read timeout 60 seconds. This keyword argument can be provided + as a single float, in which case the value provided is used for both the read and connection timeouts, or as a tuple of two floats. If + a tuple is provided then the first value is used as the connection timeout and the second value as the read timeout. + :type timeout: float or tuple(float, float) + + :param signer: (optional) + The signer to use when signing requests made by the service client. The default is to use a :py:class:`~oci.signer.Signer` based on the values + provided in the config parameter. + + One use case for this parameter is for `Instance Principals authentication `__ + by passing an instance of :py:class:`~oci.auth.signers.InstancePrincipalsSecurityTokenSigner` as the value for this keyword argument + :type signer: :py:class:`~oci.signer.AbstractBaseSigner` + + :param obj retry_strategy: (optional) + A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. + Retry strategies can also be applied at the operation level by passing a ``retry_strategy`` keyword argument as part of calling the operation. + Any value provided at the operation level will override whatever is specified at the client level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` + is also available. The specifics of the default retry strategy are described `here `__. + + :param obj circuit_breaker_strategy: (optional) + A circuit breaker strategy to apply to all calls made by this service client (i.e. at the client level). + This client uses :py:data:`~oci.circuit_breaker.DEFAULT_CIRCUIT_BREAKER_STRATEGY` as default if no circuit breaker strategy is provided. + The specifics of circuit breaker strategy are described `here `__. + + :param function circuit_breaker_callback: (optional) + Callback function to receive any exceptions triggerred by the circuit breaker. + + :param bool client_level_realm_specific_endpoint_template_enabled: (optional) + A boolean flag to indicate whether or not this client should be created with realm specific endpoint template enabled or disable. By default, this will be set as None. + + :param allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not + allow control characters to be in the response object. + """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("database_management"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + + validate_config(config, signer=kwargs.get('signer')) + if 'signer' in kwargs: + signer = kwargs['signer'] + + elif AUTHENTICATION_TYPE_FIELD_NAME in config: + signer = get_signer_from_authentication_type(config) + + else: + signer = Signer( + tenancy=config["tenancy"], + user=config["user"], + fingerprint=config["fingerprint"], + private_key_file_location=config.get("key_file"), + pass_phrase=get_config_value_or_default(config, "pass_phrase"), + private_key_content=config.get("key_content") + ) + + base_client_init_kwargs = { + 'regional_client': True, + 'service_endpoint': kwargs.get('service_endpoint'), + 'base_path': '/20201101', + 'service_endpoint_template': 'https://dbmgmt.{region}.oci.{secondLevelDomain}', + 'service_endpoint_template_per_realm': { }, # noqa: E201 E202 + 'skip_deserialization': kwargs.get('skip_deserialization', False), + 'circuit_breaker_strategy': kwargs.get('circuit_breaker_strategy', circuit_breaker.GLOBAL_CIRCUIT_BREAKER_STRATEGY), + 'client_level_realm_specific_endpoint_template_enabled': kwargs.get('client_level_realm_specific_endpoint_template_enabled') + } + if 'timeout' in kwargs: + base_client_init_kwargs['timeout'] = kwargs.get('timeout') + if base_client_init_kwargs.get('circuit_breaker_strategy') is None: + base_client_init_kwargs['circuit_breaker_strategy'] = circuit_breaker.DEFAULT_CIRCUIT_BREAKER_STRATEGY + if 'allow_control_chars' in kwargs: + base_client_init_kwargs['allow_control_chars'] = kwargs.get('allow_control_chars') + self.base_client = BaseClient("perfhub", config, signer, database_management_type_mapping, **base_client_init_kwargs) + self.retry_strategy = kwargs.get('retry_strategy') + self.circuit_breaker_callback = kwargs.get('circuit_breaker_callback') + + def modify_snapshot_settings(self, managed_database_id, modify_snapshot_settings_details, **kwargs): + """ + Modifies the snapshot settings for the specified Database. + + + :param str managed_database_id: (required) + The `OCID`__ of the Managed Database. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param oci.database_management.models.ModifySnapshotSettingsDetails modify_snapshot_settings_details: (required) + Request to modify snapshot settings for a Database. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use modify_snapshot_settings API. + """ + # Required path and query arguments. These are in camelCase to replace values in service endpoints. + required_arguments = ['managedDatabaseId'] + resource_path = "/managedDatabases/{managedDatabaseId}/actions/modifySnapshotSettings" + method = "POST" + operation_name = "modify_snapshot_settings" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/database-management/20201101/ManagedDatabase/ModifySnapshotSettings" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "modify_snapshot_settings got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "managedDatabaseId": managed_database_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=modify_snapshot_settings_details, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=modify_snapshot_settings_details, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) diff --git a/src/oci/database_management/perfhub_client_composite_operations.py b/src/oci/database_management/perfhub_client_composite_operations.py new file mode 100644 index 0000000000..1c27f884f1 --- /dev/null +++ b/src/oci/database_management/perfhub_client_composite_operations.py @@ -0,0 +1,26 @@ +# coding: utf-8 +# Copyright (c) 2016, 2023, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20201101 + +import oci # noqa: F401 +from oci.util import WAIT_RESOURCE_NOT_FOUND # noqa: F401 + + +class PerfhubClientCompositeOperations(object): + """ + This class provides a wrapper around :py:class:`~oci.database_management.PerfhubClient` and offers convenience methods + for operations that would otherwise need to be chained together. For example, instead of performing an action + on a resource (e.g. launching an instance, creating a load balancer) and then using a waiter to wait for the resource + to enter a given state, you can call a single method in this class to accomplish the same functionality + """ + + def __init__(self, client, **kwargs): + """ + Creates a new PerfhubClientCompositeOperations object + + :param PerfhubClient client: + The service client which will be wrapped by this object + """ + self.client = client diff --git a/src/oci/database_management/sql_tuning_client.py b/src/oci/database_management/sql_tuning_client.py index ded02da915..4637cf5f5e 100644 --- a/src/oci/database_management/sql_tuning_client.py +++ b/src/oci/database_management/sql_tuning_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import database_management_type_mapping missing = Sentinel("Missing") @@ -76,6 +78,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("database_management"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] @@ -226,9 +231,9 @@ def clone_sql_tuning_task(self, managed_database_id, clone_sql_tuning_task_detai api_reference_link=api_reference_link, required_arguments=required_arguments) - def drop_sql_tuning_task(self, managed_database_id, drop_sql_tuning_task_details, **kwargs): + def create_sql_tuning_set(self, managed_database_id, create_sql_tuning_set_details, **kwargs): """ - Drops a SQL tuning task and its related results from the database. + Creates an empty Sql tuning set within the Managed Database specified by managedDatabaseId. :param str managed_database_id: (required) @@ -236,8 +241,8 @@ def drop_sql_tuning_task(self, managed_database_id, drop_sql_tuning_task_details __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm - :param oci.database_management.models.DropSqlTuningTaskDetails drop_sql_tuning_task_details: (required) - The detailed inputs required to drop a SQL tuning task. + :param oci.database_management.models.CreateSqlTuningSetDetails create_sql_tuning_set_details: (required) + The details required to create a Sql tuning set. :param str opc_request_id: (optional) The client request ID for tracing. @@ -252,7 +257,7 @@ def drop_sql_tuning_task(self, managed_database_id, drop_sql_tuning_task_details :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -261,18 +266,18 @@ def drop_sql_tuning_task(self, managed_database_id, drop_sql_tuning_task_details allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings - :return: A :class:`~oci.response.Response` object with data of type None + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database_management.models.SqlTuningSet` :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use drop_sql_tuning_task API. + Click `here `__ to see an example of how to use create_sql_tuning_set API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. required_arguments = ['managedDatabaseId'] - resource_path = "/managedDatabases/{managedDatabaseId}/actions/dropSqlTuningTask" + resource_path = "/managedDatabases/{managedDatabaseId}/sqlTuningSets" method = "POST" - operation_name = "drop_sql_tuning_task" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/database-management/20201101/ManagedDatabase/DropSqlTuningTask" + operation_name = "create_sql_tuning_set" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/database-management/20201101/SqlTuningSet/CreateSqlTuningSet" # Don't accept unknown kwargs expected_kwargs = [ @@ -284,7 +289,7 @@ def drop_sql_tuning_task(self, managed_database_id, drop_sql_tuning_task_details extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - "drop_sql_tuning_task got unknown kwargs: {!r}".format(extra_kwargs)) + "create_sql_tuning_set got unknown kwargs: {!r}".format(extra_kwargs)) path_params = { "managedDatabaseId": managed_database_id @@ -308,6 +313,8 @@ def drop_sql_tuning_task(self, managed_database_id, drop_sql_tuning_task_details operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -320,7 +327,8 @@ def drop_sql_tuning_task(self, managed_database_id, drop_sql_tuning_task_details method=method, path_params=path_params, header_params=header_params, - body=drop_sql_tuning_task_details, + body=create_sql_tuning_set_details, + response_type="SqlTuningSet", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -331,17 +339,16 @@ def drop_sql_tuning_task(self, managed_database_id, drop_sql_tuning_task_details method=method, path_params=path_params, header_params=header_params, - body=drop_sql_tuning_task_details, + body=create_sql_tuning_set_details, + response_type="SqlTuningSet", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def get_execution_plan_stats_comparision(self, managed_database_id, sql_tuning_advisor_task_id, sql_object_id, execution_id, **kwargs): + def drop_sql_tuning_set(self, managed_database_id, sql_tuning_set_id, drop_sql_tuning_set_details, **kwargs): """ - Retrieves a comparison of the existing SQL execution plan and a new plan. - A SQL tuning task may suggest a new execution plan for a SQL, - and this API retrieves the comparison report of the statistics of the two plans. + Drops the Sql tuning set specified by sqlTuningSet within the Managed Database specified by managedDatabaseId. :param str managed_database_id: (required) @@ -349,28 +356,26 @@ def get_execution_plan_stats_comparision(self, managed_database_id, sql_tuning_a __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm - :param int sql_tuning_advisor_task_id: (required) - The SQL tuning task identifier. This is not the `OCID`__. - - __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm - - :param int sql_object_id: (required) - The SQL object ID for the SQL tuning task. This is not the `OCID`__. - - __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + :param int sql_tuning_set_id: (required) + The unique identifier of the Sql tuning set. This is not OCID. - :param int execution_id: (required) - The execution ID for an execution of a SQL tuning task. This is not the `OCID`__. - - __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + :param oci.database_management.models.DropSqlTuningSetDetails drop_sql_tuning_set_details: (required) + The details required to drop a Sql tuning set. :param str opc_request_id: (optional) The client request ID for tracing. + :param str opc_retry_token: (optional) + A token that uniquely identifies a request so it can be retried in case of a timeout or + server error without risk of executing that same action again. Retry tokens expire after 24 + hours, but can be invalidated before then due to conflicting operations. For example, if a resource + has been deleted and purged from the system, then a retry of the original creation request + might be rejected. + :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -379,33 +384,34 @@ def get_execution_plan_stats_comparision(self, managed_database_id, sql_tuning_a allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings - :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database_management.models.ExecutionPlanStatsComparision` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database_management.models.SqlTuningSetAdminActionStatus` :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use get_execution_plan_stats_comparision API. + Click `here `__ to see an example of how to use drop_sql_tuning_set API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['managedDatabaseId', 'sqlTuningAdvisorTaskId', 'sqlObjectId', 'executionId'] - resource_path = "/managedDatabases/{managedDatabaseId}/sqlTuningAdvisorTasks/{sqlTuningAdvisorTaskId}/executionPlanStatsComparision" - method = "GET" - operation_name = "get_execution_plan_stats_comparision" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/database-management/20201101/ManagedDatabase/GetExecutionPlanStatsComparision" + required_arguments = ['managedDatabaseId', 'sqlTuningSetId'] + resource_path = "/managedDatabases/{managedDatabaseId}/sqlTuningSets/{sqlTuningSetId}/actions/dropSqlTuningSet" + method = "POST" + operation_name = "drop_sql_tuning_set" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/database-management/20201101/SqlTuningSet/DropSqlTuningSet" # Don't accept unknown kwargs expected_kwargs = [ "allow_control_chars", "retry_strategy", - "opc_request_id" + "opc_request_id", + "opc_retry_token" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - "get_execution_plan_stats_comparision got unknown kwargs: {!r}".format(extra_kwargs)) + "drop_sql_tuning_set got unknown kwargs: {!r}".format(extra_kwargs)) path_params = { "managedDatabaseId": managed_database_id, - "sqlTuningAdvisorTaskId": sql_tuning_advisor_task_id + "sqlTuningSetId": sql_tuning_set_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -414,16 +420,11 @@ def get_execution_plan_stats_comparision(self, managed_database_id, sql_tuning_a if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) - query_params = { - "sqlObjectId": sql_object_id, - "executionId": execution_id - } - query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} - header_params = { "accept": "application/json", "content-type": "application/json", - "opc-request-id": kwargs.get("opc_request_id", missing) + "opc-request-id": kwargs.get("opc_request_id", missing), + "opc-retry-token": kwargs.get("opc_retry_token", missing) } header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} @@ -431,9 +432,12 @@ def get_execution_plan_stats_comparision(self, managed_database_id, sql_tuning_a operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_retry_token_if_needed(header_params) self.base_client.add_opc_client_retries_header(header_params) retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) return retry_strategy.make_retrying_call( @@ -441,9 +445,9 @@ def get_execution_plan_stats_comparision(self, managed_database_id, sql_tuning_a resource_path=resource_path, method=method, path_params=path_params, - query_params=query_params, header_params=header_params, - response_type="ExecutionPlanStatsComparision", + body=drop_sql_tuning_set_details, + response_type="SqlTuningSetAdminActionStatus", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -453,17 +457,17 @@ def get_execution_plan_stats_comparision(self, managed_database_id, sql_tuning_a resource_path=resource_path, method=method, path_params=path_params, - query_params=query_params, header_params=header_params, - response_type="ExecutionPlanStatsComparision", + body=drop_sql_tuning_set_details, + response_type="SqlTuningSetAdminActionStatus", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def get_sql_execution_plan(self, managed_database_id, sql_tuning_advisor_task_id, sql_object_id, attribute, **kwargs): + def drop_sql_tuning_task(self, managed_database_id, drop_sql_tuning_task_details, **kwargs): """ - Retrieves a SQL execution plan for the SQL being tuned. + Drops a SQL tuning task and its related results from the database. :param str managed_database_id: (required) @@ -471,24 +475,19 @@ def get_sql_execution_plan(self, managed_database_id, sql_tuning_advisor_task_id __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm - :param int sql_tuning_advisor_task_id: (required) - The SQL tuning task identifier. This is not the `OCID`__. - - __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm - - :param int sql_object_id: (required) - The SQL object ID for the SQL tuning task. This is not the `OCID`__. - - __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm - - :param str attribute: (required) - The attribute of the SQL execution plan. - - Allowed values are: "ORIGINAL", "ORIGINAL_WITH_ADJUSTED_COST", "USING_SQL_PROFILE", "USING_NEW_INDICES", "USING_PARALLEL_EXECUTION" + :param oci.database_management.models.DropSqlTuningTaskDetails drop_sql_tuning_task_details: (required) + The detailed inputs required to drop a SQL tuning task. :param str opc_request_id: (optional) The client request ID for tracing. + :param str opc_retry_token: (optional) + A token that uniquely identifies a request so it can be retried in case of a timeout or + server error without risk of executing that same action again. Retry tokens expire after 24 + hours, but can be invalidated before then due to conflicting operations. For example, if a resource + has been deleted and purged from the system, then a retry of the original creation request + might be rejected. + :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. @@ -501,33 +500,33 @@ def get_sql_execution_plan(self, managed_database_id, sql_tuning_advisor_task_id allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings - :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database_management.models.SqlTuningAdvisorTaskSqlExecutionPlan` + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use get_sql_execution_plan API. + Click `here `__ to see an example of how to use drop_sql_tuning_task API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['managedDatabaseId', 'sqlTuningAdvisorTaskId', 'sqlObjectId', 'attribute'] - resource_path = "/managedDatabases/{managedDatabaseId}/sqlTuningAdvisorTasks/{sqlTuningAdvisorTaskId}/sqlExecutionPlan" - method = "GET" - operation_name = "get_sql_execution_plan" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/database-management/20201101/ManagedDatabase/GetSqlExecutionPlan" + required_arguments = ['managedDatabaseId'] + resource_path = "/managedDatabases/{managedDatabaseId}/actions/dropSqlTuningTask" + method = "POST" + operation_name = "drop_sql_tuning_task" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/database-management/20201101/ManagedDatabase/DropSqlTuningTask" # Don't accept unknown kwargs expected_kwargs = [ "allow_control_chars", "retry_strategy", - "opc_request_id" + "opc_request_id", + "opc_retry_token" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - "get_sql_execution_plan got unknown kwargs: {!r}".format(extra_kwargs)) + "drop_sql_tuning_task got unknown kwargs: {!r}".format(extra_kwargs)) path_params = { - "managedDatabaseId": managed_database_id, - "sqlTuningAdvisorTaskId": sql_tuning_advisor_task_id + "managedDatabaseId": managed_database_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -536,22 +535,11 @@ def get_sql_execution_plan(self, managed_database_id, sql_tuning_advisor_task_id if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) - attribute_allowed_values = ["ORIGINAL", "ORIGINAL_WITH_ADJUSTED_COST", "USING_SQL_PROFILE", "USING_NEW_INDICES", "USING_PARALLEL_EXECUTION"] - if attribute not in attribute_allowed_values: - raise ValueError( - "Invalid value for `attribute`, must be one of {0}".format(attribute_allowed_values) - ) - - query_params = { - "sqlObjectId": sql_object_id, - "attribute": attribute - } - query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} - header_params = { "accept": "application/json", "content-type": "application/json", - "opc-request-id": kwargs.get("opc_request_id", missing) + "opc-request-id": kwargs.get("opc_request_id", missing), + "opc-retry-token": kwargs.get("opc_retry_token", missing) } header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} @@ -562,6 +550,7 @@ def get_sql_execution_plan(self, managed_database_id, sql_tuning_advisor_task_id if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_retry_token_if_needed(header_params) self.base_client.add_opc_client_retries_header(header_params) retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) return retry_strategy.make_retrying_call( @@ -569,9 +558,8 @@ def get_sql_execution_plan(self, managed_database_id, sql_tuning_advisor_task_id resource_path=resource_path, method=method, path_params=path_params, - query_params=query_params, header_params=header_params, - response_type="SqlTuningAdvisorTaskSqlExecutionPlan", + body=drop_sql_tuning_task_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -581,17 +569,17 @@ def get_sql_execution_plan(self, managed_database_id, sql_tuning_advisor_task_id resource_path=resource_path, method=method, path_params=path_params, - query_params=query_params, header_params=header_params, - response_type="SqlTuningAdvisorTaskSqlExecutionPlan", + body=drop_sql_tuning_task_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def get_sql_tuning_advisor_task_summary_report(self, managed_database_id, sql_tuning_advisor_task_id, **kwargs): + def drop_sqls_in_sql_tuning_set(self, managed_database_id, sql_tuning_set_id, drop_sqls_in_sql_tuning_set_details, **kwargs): """ - Gets the summary report for the specified SQL Tuning Advisor task. + Deletes the Sqls in the specified Sql tuning set that matches the filter criteria provided in the basicFilter. + If basicFilter criteria is not provided, then entire Sqls in the Sql tuning set is deleted. :param str managed_database_id: (required) @@ -599,35 +587,26 @@ def get_sql_tuning_advisor_task_summary_report(self, managed_database_id, sql_tu __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm - :param int sql_tuning_advisor_task_id: (required) - The SQL tuning task identifier. This is not the `OCID`__. - - __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm - - :param str search_period: (optional) - How far back the API will search for begin and end exec id. Unused if neither exec ids nor time filter query params are supplied. This is applicable only for Auto SQL Tuning tasks. - - Allowed values are: "LAST_24HR", "LAST_7DAY", "LAST_31DAY", "SINCE_LAST", "ALL" - - :param datetime time_greater_than_or_equal_to: (optional) - The optional greater than or equal to query parameter to filter the timestamp. This is applicable only for Auto SQL Tuning tasks. - - :param datetime time_less_than_or_equal_to: (optional) - The optional less than or equal to query parameter to filter the timestamp. This is applicable only for Auto SQL Tuning tasks. - - :param int begin_exec_id_greater_than_or_equal_to: (optional) - The optional greater than or equal to filter on the execution ID related to a specific SQL Tuning Advisor task. This is applicable only for Auto SQL Tuning tasks. + :param int sql_tuning_set_id: (required) + The unique identifier of the Sql tuning set. This is not OCID. - :param int end_exec_id_less_than_or_equal_to: (optional) - The optional less than or equal to query parameter to filter on the execution ID related to a specific SQL Tuning Advisor task. This is applicable only for Auto SQL Tuning tasks. + :param oci.database_management.models.DropSqlsInSqlTuningSetDetails drop_sqls_in_sql_tuning_set_details: (required) + Drops the selected list of Sql statements from the current Sql tuning set. :param str opc_request_id: (optional) The client request ID for tracing. + :param str opc_retry_token: (optional) + A token that uniquely identifies a request so it can be retried in case of a timeout or + server error without risk of executing that same action again. Retry tokens expire after 24 + hours, but can be invalidated before then due to conflicting operations. For example, if a resource + has been deleted and purged from the system, then a retry of the original creation request + might be rejected. + :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -636,38 +615,34 @@ def get_sql_tuning_advisor_task_summary_report(self, managed_database_id, sql_tu allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings - :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database_management.models.SqlTuningAdvisorTaskSummaryReport` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database_management.models.SqlTuningSetAdminActionStatus` :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use get_sql_tuning_advisor_task_summary_report API. + Click `here `__ to see an example of how to use drop_sqls_in_sql_tuning_set API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['managedDatabaseId', 'sqlTuningAdvisorTaskId'] - resource_path = "/managedDatabases/{managedDatabaseId}/sqlTuningAdvisorTasks/{sqlTuningAdvisorTaskId}/summaryReport" - method = "GET" - operation_name = "get_sql_tuning_advisor_task_summary_report" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/database-management/20201101/ManagedDatabase/GetSqlTuningAdvisorTaskSummaryReport" + required_arguments = ['managedDatabaseId', 'sqlTuningSetId'] + resource_path = "/managedDatabases/{managedDatabaseId}/sqlTuningSets/{sqlTuningSetId}/actions/dropSqlsInSqlTuningSet" + method = "POST" + operation_name = "drop_sqls_in_sql_tuning_set" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/database-management/20201101/SqlTuningSet/DropSqlsInSqlTuningSet" # Don't accept unknown kwargs expected_kwargs = [ "allow_control_chars", "retry_strategy", - "search_period", - "time_greater_than_or_equal_to", - "time_less_than_or_equal_to", - "begin_exec_id_greater_than_or_equal_to", - "end_exec_id_less_than_or_equal_to", - "opc_request_id" + "opc_request_id", + "opc_retry_token" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - "get_sql_tuning_advisor_task_summary_report got unknown kwargs: {!r}".format(extra_kwargs)) + "drop_sqls_in_sql_tuning_set got unknown kwargs: {!r}".format(extra_kwargs)) path_params = { "managedDatabaseId": managed_database_id, - "sqlTuningAdvisorTaskId": sql_tuning_advisor_task_id + "sqlTuningSetId": sql_tuning_set_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -676,26 +651,11 @@ def get_sql_tuning_advisor_task_summary_report(self, managed_database_id, sql_tu if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) - if 'search_period' in kwargs: - search_period_allowed_values = ["LAST_24HR", "LAST_7DAY", "LAST_31DAY", "SINCE_LAST", "ALL"] - if kwargs['search_period'] not in search_period_allowed_values: - raise ValueError( - "Invalid value for `search_period`, must be one of {0}".format(search_period_allowed_values) - ) - - query_params = { - "searchPeriod": kwargs.get("search_period", missing), - "timeGreaterThanOrEqualTo": kwargs.get("time_greater_than_or_equal_to", missing), - "timeLessThanOrEqualTo": kwargs.get("time_less_than_or_equal_to", missing), - "beginExecIdGreaterThanOrEqualTo": kwargs.get("begin_exec_id_greater_than_or_equal_to", missing), - "endExecIdLessThanOrEqualTo": kwargs.get("end_exec_id_less_than_or_equal_to", missing) - } - query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} - header_params = { "accept": "application/json", "content-type": "application/json", - "opc-request-id": kwargs.get("opc_request_id", missing) + "opc-request-id": kwargs.get("opc_request_id", missing), + "opc-retry-token": kwargs.get("opc_retry_token", missing) } header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} @@ -703,9 +663,12 @@ def get_sql_tuning_advisor_task_summary_report(self, managed_database_id, sql_tu operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_retry_token_if_needed(header_params) self.base_client.add_opc_client_retries_header(header_params) retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) return retry_strategy.make_retrying_call( @@ -713,9 +676,9 @@ def get_sql_tuning_advisor_task_summary_report(self, managed_database_id, sql_tu resource_path=resource_path, method=method, path_params=path_params, - query_params=query_params, header_params=header_params, - response_type="SqlTuningAdvisorTaskSummaryReport", + body=drop_sqls_in_sql_tuning_set_details, + response_type="SqlTuningSetAdminActionStatus", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -725,17 +688,17 @@ def get_sql_tuning_advisor_task_summary_report(self, managed_database_id, sql_tu resource_path=resource_path, method=method, path_params=path_params, - query_params=query_params, header_params=header_params, - response_type="SqlTuningAdvisorTaskSummaryReport", + body=drop_sqls_in_sql_tuning_set_details, + response_type="SqlTuningSetAdminActionStatus", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def list_sql_tuning_advisor_task_findings(self, managed_database_id, sql_tuning_advisor_task_id, **kwargs): + def fetch_sql_tuning_set(self, managed_database_id, sql_tuning_set_id, fetch_sql_tuning_set_details, **kwargs): """ - Gets an array of the details of the findings that match specific filters. + Fetch the details of Sql statements in the Sql tuning set specified by name, owner and optional filter parameters. :param str managed_database_id: (required) @@ -743,43 +706,894 @@ def list_sql_tuning_advisor_task_findings(self, managed_database_id, sql_tuning_ __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm - :param int sql_tuning_advisor_task_id: (required) - The SQL tuning task identifier. This is not the `OCID`__. - - __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm - - :param int begin_exec_id: (optional) - The optional greater than or equal to filter on the execution ID related to a specific SQL Tuning Advisor task. + :param int sql_tuning_set_id: (required) + The unique identifier of the Sql tuning set. This is not OCID. - :param int end_exec_id: (optional) - The optional less than or equal to query parameter to filter on the execution ID related to a specific SQL Tuning Advisor task. + :param oci.database_management.models.FetchSqlTuningSetDetails fetch_sql_tuning_set_details: (required) + The details required to fetch the Sql tuning set details. - :param str search_period: (optional) - The search period during which the API will search for begin and end exec id, if not supplied. - Unused if beginExecId and endExecId optional query params are both supplied. + :param str opc_request_id: (optional) + The client request ID for tracing. - Allowed values are: "LAST_24HR", "LAST_7DAY", "LAST_31DAY", "SINCE_LAST", "ALL" + :param str opc_retry_token: (optional) + A token that uniquely identifies a request so it can be retried in case of a timeout or + server error without risk of executing that same action again. Retry tokens expire after 24 + hours, but can be invalidated before then due to conflicting operations. For example, if a resource + has been deleted and purged from the system, then a retry of the original creation request + might be rejected. - :param str finding_filter: (optional) - The filter used to display specific findings in the report. + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - Allowed values are: "none", "FINDINGS", "NOFINDINGS", "ERRORS", "PROFILES", "INDICES", "STATS", "RESTRUCTURE", "ALTERNATIVE", "AUTO_PROFILES", "OTHER_PROFILES" + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. + The specifics of the default retry strategy are described `here `__. - :param str stats_hash_filter: (optional) - The hash value of the object for the statistic finding search. + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. - :param str index_hash_filter: (optional) - The hash value of the index table name. + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings - :param str sort_by: (optional) - The possible sortBy values of an object's recommendations. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database_management.models.SqlTuningSet` + :rtype: :class:`~oci.response.Response` - Allowed values are: "DBTIME_BENEFIT", "PARSING_SCHEMA", "SQL_ID", "STATS", "PROFILES", "SQL_BENEFIT", "DATE", "INDICES", "RESTRUCTURE", "ALTERNATIVE", "MISC", "ERROR", "TIMEOUTS" + :example: + Click `here `__ to see an example of how to use fetch_sql_tuning_set API. + """ + # Required path and query arguments. These are in camelCase to replace values in service endpoints. + required_arguments = ['managedDatabaseId', 'sqlTuningSetId'] + resource_path = "/managedDatabases/{managedDatabaseId}/sqlTuningSets/{sqlTuningSetId}" + method = "POST" + operation_name = "fetch_sql_tuning_set" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/database-management/20201101/SqlTuningSet/FetchSqlTuningSet" - :param str sort_order: (optional) + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id", + "opc_retry_token" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "fetch_sql_tuning_set got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "managedDatabaseId": managed_database_id, + "sqlTuningSetId": sql_tuning_set_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing), + "opc-retry-token": kwargs.get("opc_retry_token", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_retry_token_if_needed(header_params) + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=fetch_sql_tuning_set_details, + response_type="SqlTuningSet", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=fetch_sql_tuning_set_details, + response_type="SqlTuningSet", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + + def get_execution_plan_stats_comparision(self, managed_database_id, sql_tuning_advisor_task_id, sql_object_id, execution_id, **kwargs): + """ + Retrieves a comparison of the existing SQL execution plan and a new plan. + A SQL tuning task may suggest a new execution plan for a SQL, + and this API retrieves the comparison report of the statistics of the two plans. + + + :param str managed_database_id: (required) + The `OCID`__ of the Managed Database. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param int sql_tuning_advisor_task_id: (required) + The SQL tuning task identifier. This is not the `OCID`__. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param int sql_object_id: (required) + The SQL object ID for the SQL tuning task. This is not the `OCID`__. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param int execution_id: (required) + The execution ID for an execution of a SQL tuning task. This is not the `OCID`__. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database_management.models.ExecutionPlanStatsComparision` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_execution_plan_stats_comparision API. + """ + # Required path and query arguments. These are in camelCase to replace values in service endpoints. + required_arguments = ['managedDatabaseId', 'sqlTuningAdvisorTaskId', 'sqlObjectId', 'executionId'] + resource_path = "/managedDatabases/{managedDatabaseId}/sqlTuningAdvisorTasks/{sqlTuningAdvisorTaskId}/executionPlanStatsComparision" + method = "GET" + operation_name = "get_execution_plan_stats_comparision" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/database-management/20201101/ManagedDatabase/GetExecutionPlanStatsComparision" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "get_execution_plan_stats_comparision got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "managedDatabaseId": managed_database_id, + "sqlTuningAdvisorTaskId": sql_tuning_advisor_task_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + query_params = { + "sqlObjectId": sql_object_id, + "executionId": execution_id + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + query_params=query_params, + header_params=header_params, + response_type="ExecutionPlanStatsComparision", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + query_params=query_params, + header_params=header_params, + response_type="ExecutionPlanStatsComparision", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + + def get_sql_execution_plan(self, managed_database_id, sql_tuning_advisor_task_id, sql_object_id, attribute, **kwargs): + """ + Retrieves a SQL execution plan for the SQL being tuned. + + + :param str managed_database_id: (required) + The `OCID`__ of the Managed Database. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param int sql_tuning_advisor_task_id: (required) + The SQL tuning task identifier. This is not the `OCID`__. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param int sql_object_id: (required) + The SQL object ID for the SQL tuning task. This is not the `OCID`__. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param str attribute: (required) + The attribute of the SQL execution plan. + + Allowed values are: "ORIGINAL", "ORIGINAL_WITH_ADJUSTED_COST", "USING_SQL_PROFILE", "USING_NEW_INDICES", "USING_PARALLEL_EXECUTION" + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database_management.models.SqlTuningAdvisorTaskSqlExecutionPlan` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_sql_execution_plan API. + """ + # Required path and query arguments. These are in camelCase to replace values in service endpoints. + required_arguments = ['managedDatabaseId', 'sqlTuningAdvisorTaskId', 'sqlObjectId', 'attribute'] + resource_path = "/managedDatabases/{managedDatabaseId}/sqlTuningAdvisorTasks/{sqlTuningAdvisorTaskId}/sqlExecutionPlan" + method = "GET" + operation_name = "get_sql_execution_plan" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/database-management/20201101/ManagedDatabase/GetSqlExecutionPlan" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "get_sql_execution_plan got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "managedDatabaseId": managed_database_id, + "sqlTuningAdvisorTaskId": sql_tuning_advisor_task_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + attribute_allowed_values = ["ORIGINAL", "ORIGINAL_WITH_ADJUSTED_COST", "USING_SQL_PROFILE", "USING_NEW_INDICES", "USING_PARALLEL_EXECUTION"] + if attribute not in attribute_allowed_values: + raise ValueError( + "Invalid value for `attribute`, must be one of {0}".format(attribute_allowed_values) + ) + + query_params = { + "sqlObjectId": sql_object_id, + "attribute": attribute + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + query_params=query_params, + header_params=header_params, + response_type="SqlTuningAdvisorTaskSqlExecutionPlan", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + query_params=query_params, + header_params=header_params, + response_type="SqlTuningAdvisorTaskSqlExecutionPlan", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + + def get_sql_tuning_advisor_task_summary_report(self, managed_database_id, sql_tuning_advisor_task_id, **kwargs): + """ + Gets the summary report for the specified SQL Tuning Advisor task. + + + :param str managed_database_id: (required) + The `OCID`__ of the Managed Database. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param int sql_tuning_advisor_task_id: (required) + The SQL tuning task identifier. This is not the `OCID`__. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param str search_period: (optional) + How far back the API will search for begin and end exec id. Unused if neither exec ids nor time filter query params are supplied. This is applicable only for Auto SQL Tuning tasks. + + Allowed values are: "LAST_24HR", "LAST_7DAY", "LAST_31DAY", "SINCE_LAST", "ALL" + + :param datetime time_greater_than_or_equal_to: (optional) + The optional greater than or equal to query parameter to filter the timestamp. This is applicable only for Auto SQL Tuning tasks. + + :param datetime time_less_than_or_equal_to: (optional) + The optional less than or equal to query parameter to filter the timestamp. This is applicable only for Auto SQL Tuning tasks. + + :param int begin_exec_id_greater_than_or_equal_to: (optional) + The optional greater than or equal to filter on the execution ID related to a specific SQL Tuning Advisor task. This is applicable only for Auto SQL Tuning tasks. + + :param int end_exec_id_less_than_or_equal_to: (optional) + The optional less than or equal to query parameter to filter on the execution ID related to a specific SQL Tuning Advisor task. This is applicable only for Auto SQL Tuning tasks. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database_management.models.SqlTuningAdvisorTaskSummaryReport` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_sql_tuning_advisor_task_summary_report API. + """ + # Required path and query arguments. These are in camelCase to replace values in service endpoints. + required_arguments = ['managedDatabaseId', 'sqlTuningAdvisorTaskId'] + resource_path = "/managedDatabases/{managedDatabaseId}/sqlTuningAdvisorTasks/{sqlTuningAdvisorTaskId}/summaryReport" + method = "GET" + operation_name = "get_sql_tuning_advisor_task_summary_report" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/database-management/20201101/ManagedDatabase/GetSqlTuningAdvisorTaskSummaryReport" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "search_period", + "time_greater_than_or_equal_to", + "time_less_than_or_equal_to", + "begin_exec_id_greater_than_or_equal_to", + "end_exec_id_less_than_or_equal_to", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "get_sql_tuning_advisor_task_summary_report got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "managedDatabaseId": managed_database_id, + "sqlTuningAdvisorTaskId": sql_tuning_advisor_task_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + if 'search_period' in kwargs: + search_period_allowed_values = ["LAST_24HR", "LAST_7DAY", "LAST_31DAY", "SINCE_LAST", "ALL"] + if kwargs['search_period'] not in search_period_allowed_values: + raise ValueError( + "Invalid value for `search_period`, must be one of {0}".format(search_period_allowed_values) + ) + + query_params = { + "searchPeriod": kwargs.get("search_period", missing), + "timeGreaterThanOrEqualTo": kwargs.get("time_greater_than_or_equal_to", missing), + "timeLessThanOrEqualTo": kwargs.get("time_less_than_or_equal_to", missing), + "beginExecIdGreaterThanOrEqualTo": kwargs.get("begin_exec_id_greater_than_or_equal_to", missing), + "endExecIdLessThanOrEqualTo": kwargs.get("end_exec_id_less_than_or_equal_to", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + query_params=query_params, + header_params=header_params, + response_type="SqlTuningAdvisorTaskSummaryReport", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + query_params=query_params, + header_params=header_params, + response_type="SqlTuningAdvisorTaskSummaryReport", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + + def list_sql_tuning_advisor_task_findings(self, managed_database_id, sql_tuning_advisor_task_id, **kwargs): + """ + Gets an array of the details of the findings that match specific filters. + + + :param str managed_database_id: (required) + The `OCID`__ of the Managed Database. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param int sql_tuning_advisor_task_id: (required) + The SQL tuning task identifier. This is not the `OCID`__. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param int begin_exec_id: (optional) + The optional greater than or equal to filter on the execution ID related to a specific SQL Tuning Advisor task. + + :param int end_exec_id: (optional) + The optional less than or equal to query parameter to filter on the execution ID related to a specific SQL Tuning Advisor task. + + :param str search_period: (optional) + The search period during which the API will search for begin and end exec id, if not supplied. + Unused if beginExecId and endExecId optional query params are both supplied. + + Allowed values are: "LAST_24HR", "LAST_7DAY", "LAST_31DAY", "SINCE_LAST", "ALL" + + :param str finding_filter: (optional) + The filter used to display specific findings in the report. + + Allowed values are: "none", "FINDINGS", "NOFINDINGS", "ERRORS", "PROFILES", "INDICES", "STATS", "RESTRUCTURE", "ALTERNATIVE", "AUTO_PROFILES", "OTHER_PROFILES" + + :param str stats_hash_filter: (optional) + The hash value of the object for the statistic finding search. + + :param str index_hash_filter: (optional) + The hash value of the index table name. + + :param str sort_by: (optional) + The possible sortBy values of an object's recommendations. + + Allowed values are: "DBTIME_BENEFIT", "PARSING_SCHEMA", "SQL_ID", "STATS", "PROFILES", "SQL_BENEFIT", "DATE", "INDICES", "RESTRUCTURE", "ALTERNATIVE", "MISC", "ERROR", "TIMEOUTS" + + :param str sort_order: (optional) + The option to sort information in ascending (\u2018ASC\u2019) or descending (\u2018DESC\u2019) order. Descending order is the default order. + + Allowed values are: "ASC", "DESC" + + :param str page: (optional) + The page token representing the page from where the next set of paginated results + are retrieved. This is usually retrieved from a previous list call. + + :param int limit: (optional) + The maximum number of records returned in the paginated response. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database_management.models.SqlTuningAdvisorTaskFindingCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_sql_tuning_advisor_task_findings API. + """ + # Required path and query arguments. These are in camelCase to replace values in service endpoints. + required_arguments = ['managedDatabaseId', 'sqlTuningAdvisorTaskId'] + resource_path = "/managedDatabases/{managedDatabaseId}/sqlTuningAdvisorTasks/{sqlTuningAdvisorTaskId}/findings" + method = "GET" + operation_name = "list_sql_tuning_advisor_task_findings" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/database-management/20201101/ManagedDatabase/ListSqlTuningAdvisorTaskFindings" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "begin_exec_id", + "end_exec_id", + "search_period", + "finding_filter", + "stats_hash_filter", + "index_hash_filter", + "sort_by", + "sort_order", + "page", + "limit", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_sql_tuning_advisor_task_findings got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "managedDatabaseId": managed_database_id, + "sqlTuningAdvisorTaskId": sql_tuning_advisor_task_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + if 'search_period' in kwargs: + search_period_allowed_values = ["LAST_24HR", "LAST_7DAY", "LAST_31DAY", "SINCE_LAST", "ALL"] + if kwargs['search_period'] not in search_period_allowed_values: + raise ValueError( + "Invalid value for `search_period`, must be one of {0}".format(search_period_allowed_values) + ) + + if 'finding_filter' in kwargs: + finding_filter_allowed_values = ["none", "FINDINGS", "NOFINDINGS", "ERRORS", "PROFILES", "INDICES", "STATS", "RESTRUCTURE", "ALTERNATIVE", "AUTO_PROFILES", "OTHER_PROFILES"] + if kwargs['finding_filter'] not in finding_filter_allowed_values: + raise ValueError( + "Invalid value for `finding_filter`, must be one of {0}".format(finding_filter_allowed_values) + ) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["DBTIME_BENEFIT", "PARSING_SCHEMA", "SQL_ID", "STATS", "PROFILES", "SQL_BENEFIT", "DATE", "INDICES", "RESTRUCTURE", "ALTERNATIVE", "MISC", "ERROR", "TIMEOUTS"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) + ) + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + "Invalid value for `sort_order`, must be one of {0}".format(sort_order_allowed_values) + ) + + query_params = { + "beginExecId": kwargs.get("begin_exec_id", missing), + "endExecId": kwargs.get("end_exec_id", missing), + "searchPeriod": kwargs.get("search_period", missing), + "findingFilter": kwargs.get("finding_filter", missing), + "statsHashFilter": kwargs.get("stats_hash_filter", missing), + "indexHashFilter": kwargs.get("index_hash_filter", missing), + "sortBy": kwargs.get("sort_by", missing), + "sortOrder": kwargs.get("sort_order", missing), + "page": kwargs.get("page", missing), + "limit": kwargs.get("limit", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + query_params=query_params, + header_params=header_params, + response_type="SqlTuningAdvisorTaskFindingCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + query_params=query_params, + header_params=header_params, + response_type="SqlTuningAdvisorTaskFindingCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + + def list_sql_tuning_advisor_task_recommendations(self, managed_database_id, sql_tuning_advisor_task_id, sql_object_id, execution_id, **kwargs): + """ + Gets the findings and possible actions for a given object in a SQL tuning task. + The task ID and object ID are used to retrieve the findings and recommendations. + + + :param str managed_database_id: (required) + The `OCID`__ of the Managed Database. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param int sql_tuning_advisor_task_id: (required) + The SQL tuning task identifier. This is not the `OCID`__. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param int sql_object_id: (required) + The SQL object ID for the SQL tuning task. This is not the `OCID`__. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param int execution_id: (required) + The execution ID for an execution of a SQL tuning task. This is not the `OCID`__. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param str sort_by: (optional) + The possible sortBy values of an object's recommendations. + + Allowed values are: "RECOMMENDATION_TYPE", "BENEFIT" + + :param str sort_order: (optional) The option to sort information in ascending (\u2018ASC\u2019) or descending (\u2018DESC\u2019) order. Descending order is the default order. - Allowed values are: "ASC", "DESC" + Allowed values are: "ASC", "DESC" + + :param str page: (optional) + The page token representing the page from where the next set of paginated results + are retrieved. This is usually retrieved from a previous list call. + + :param int limit: (optional) + The maximum number of records returned in the paginated response. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database_management.models.SqlTuningAdvisorTaskRecommendationCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_sql_tuning_advisor_task_recommendations API. + """ + # Required path and query arguments. These are in camelCase to replace values in service endpoints. + required_arguments = ['managedDatabaseId', 'sqlTuningAdvisorTaskId', 'sqlObjectId', 'executionId'] + resource_path = "/managedDatabases/{managedDatabaseId}/sqlTuningAdvisorTasks/{sqlTuningAdvisorTaskId}/recommendations" + method = "GET" + operation_name = "list_sql_tuning_advisor_task_recommendations" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/database-management/20201101/ManagedDatabase/ListSqlTuningAdvisorTaskRecommendations" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "sort_by", + "sort_order", + "page", + "limit", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_sql_tuning_advisor_task_recommendations got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "managedDatabaseId": managed_database_id, + "sqlTuningAdvisorTaskId": sql_tuning_advisor_task_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["RECOMMENDATION_TYPE", "BENEFIT"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) + ) + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + "Invalid value for `sort_order`, must be one of {0}".format(sort_order_allowed_values) + ) + + query_params = { + "sqlObjectId": sql_object_id, + "executionId": execution_id, + "sortBy": kwargs.get("sort_by", missing), + "sortOrder": kwargs.get("sort_order", missing), + "page": kwargs.get("page", missing), + "limit": kwargs.get("limit", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + query_params=query_params, + header_params=header_params, + response_type="SqlTuningAdvisorTaskRecommendationCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + query_params=query_params, + header_params=header_params, + response_type="SqlTuningAdvisorTaskRecommendationCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + + def list_sql_tuning_advisor_tasks(self, managed_database_id, **kwargs): + """ + Lists the SQL Tuning Advisor tasks for the specified Managed Database. + + + :param str managed_database_id: (required) + The `OCID`__ of the Managed Database. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param str name: (optional) + The optional query parameter to filter the SQL Tuning Advisor task list by name. + + :param str status: (optional) + The optional query parameter to filter the SQL Tuning Advisor task list by status. + + Allowed values are: "INITIAL", "EXECUTING", "INTERRUPTED", "COMPLETED", "ERROR" + + :param datetime time_greater_than_or_equal_to: (optional) + The optional greater than or equal to query parameter to filter the timestamp. + + :param datetime time_less_than_or_equal_to: (optional) + The optional less than or equal to query parameter to filter the timestamp. :param str page: (optional) The page token representing the page from where the next set of paginated results @@ -788,6 +1602,16 @@ def list_sql_tuning_advisor_task_findings(self, managed_database_id, sql_tuning_ :param int limit: (optional) The maximum number of records returned in the paginated response. + :param str sort_by: (optional) + The option to sort the SQL Tuning Advisor task summary data. + + Allowed values are: "NAME", "START_TIME" + + :param str sort_order: (optional) + The option to sort information in ascending (\u2018ASC\u2019) or descending (\u2018DESC\u2019) order. Descending order is the default order. + + Allowed values are: "ASC", "DESC" + :param str opc_request_id: (optional) The client request ID for tracing. @@ -803,43 +1627,40 @@ def list_sql_tuning_advisor_task_findings(self, managed_database_id, sql_tuning_ allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings - :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database_management.models.SqlTuningAdvisorTaskFindingCollection` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database_management.models.SqlTuningAdvisorTaskCollection` :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use list_sql_tuning_advisor_task_findings API. + Click `here `__ to see an example of how to use list_sql_tuning_advisor_tasks API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['managedDatabaseId', 'sqlTuningAdvisorTaskId'] - resource_path = "/managedDatabases/{managedDatabaseId}/sqlTuningAdvisorTasks/{sqlTuningAdvisorTaskId}/findings" + required_arguments = ['managedDatabaseId'] + resource_path = "/managedDatabases/{managedDatabaseId}/sqlTuningAdvisorTasks" method = "GET" - operation_name = "list_sql_tuning_advisor_task_findings" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/database-management/20201101/ManagedDatabase/ListSqlTuningAdvisorTaskFindings" + operation_name = "list_sql_tuning_advisor_tasks" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/database-management/20201101/ManagedDatabase/ListSqlTuningAdvisorTasks" # Don't accept unknown kwargs expected_kwargs = [ "allow_control_chars", "retry_strategy", - "begin_exec_id", - "end_exec_id", - "search_period", - "finding_filter", - "stats_hash_filter", - "index_hash_filter", - "sort_by", - "sort_order", + "name", + "status", + "time_greater_than_or_equal_to", + "time_less_than_or_equal_to", "page", "limit", + "sort_by", + "sort_order", "opc_request_id" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - "list_sql_tuning_advisor_task_findings got unknown kwargs: {!r}".format(extra_kwargs)) + "list_sql_tuning_advisor_tasks got unknown kwargs: {!r}".format(extra_kwargs)) path_params = { - "managedDatabaseId": managed_database_id, - "sqlTuningAdvisorTaskId": sql_tuning_advisor_task_id + "managedDatabaseId": managed_database_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -848,22 +1669,15 @@ def list_sql_tuning_advisor_task_findings(self, managed_database_id, sql_tuning_ if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) - if 'search_period' in kwargs: - search_period_allowed_values = ["LAST_24HR", "LAST_7DAY", "LAST_31DAY", "SINCE_LAST", "ALL"] - if kwargs['search_period'] not in search_period_allowed_values: - raise ValueError( - "Invalid value for `search_period`, must be one of {0}".format(search_period_allowed_values) - ) - - if 'finding_filter' in kwargs: - finding_filter_allowed_values = ["none", "FINDINGS", "NOFINDINGS", "ERRORS", "PROFILES", "INDICES", "STATS", "RESTRUCTURE", "ALTERNATIVE", "AUTO_PROFILES", "OTHER_PROFILES"] - if kwargs['finding_filter'] not in finding_filter_allowed_values: + if 'status' in kwargs: + status_allowed_values = ["INITIAL", "EXECUTING", "INTERRUPTED", "COMPLETED", "ERROR"] + if kwargs['status'] not in status_allowed_values: raise ValueError( - "Invalid value for `finding_filter`, must be one of {0}".format(finding_filter_allowed_values) + "Invalid value for `status`, must be one of {0}".format(status_allowed_values) ) if 'sort_by' in kwargs: - sort_by_allowed_values = ["DBTIME_BENEFIT", "PARSING_SCHEMA", "SQL_ID", "STATS", "PROFILES", "SQL_BENEFIT", "DATE", "INDICES", "RESTRUCTURE", "ALTERNATIVE", "MISC", "ERROR", "TIMEOUTS"] + sort_by_allowed_values = ["NAME", "START_TIME"] if kwargs['sort_by'] not in sort_by_allowed_values: raise ValueError( "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) @@ -877,16 +1691,14 @@ def list_sql_tuning_advisor_task_findings(self, managed_database_id, sql_tuning_ ) query_params = { - "beginExecId": kwargs.get("begin_exec_id", missing), - "endExecId": kwargs.get("end_exec_id", missing), - "searchPeriod": kwargs.get("search_period", missing), - "findingFilter": kwargs.get("finding_filter", missing), - "statsHashFilter": kwargs.get("stats_hash_filter", missing), - "indexHashFilter": kwargs.get("index_hash_filter", missing), - "sortBy": kwargs.get("sort_by", missing), - "sortOrder": kwargs.get("sort_order", missing), + "name": kwargs.get("name", missing), + "status": kwargs.get("status", missing), + "timeGreaterThanOrEqualTo": kwargs.get("time_greater_than_or_equal_to", missing), + "timeLessThanOrEqualTo": kwargs.get("time_less_than_or_equal_to", missing), "page": kwargs.get("page", missing), - "limit": kwargs.get("limit", missing) + "limit": kwargs.get("limit", missing), + "sortBy": kwargs.get("sort_by", missing), + "sortOrder": kwargs.get("sort_order", missing) } query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} @@ -913,7 +1725,7 @@ def list_sql_tuning_advisor_task_findings(self, managed_database_id, sql_tuning_ path_params=path_params, query_params=query_params, header_params=header_params, - response_type="SqlTuningAdvisorTaskFindingCollection", + response_type="SqlTuningAdvisorTaskCollection", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -925,16 +1737,15 @@ def list_sql_tuning_advisor_task_findings(self, managed_database_id, sql_tuning_ path_params=path_params, query_params=query_params, header_params=header_params, - response_type="SqlTuningAdvisorTaskFindingCollection", + response_type="SqlTuningAdvisorTaskCollection", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def list_sql_tuning_advisor_task_recommendations(self, managed_database_id, sql_tuning_advisor_task_id, sql_object_id, execution_id, **kwargs): + def list_sql_tuning_sets(self, managed_database_id, **kwargs): """ - Gets the findings and possible actions for a given object in a SQL tuning task. - The task ID and object ID are used to retrieve the findings and recommendations. + Lists the SQL tuning sets for the specified Managed Database. :param str managed_database_id: (required) @@ -942,28 +1753,19 @@ def list_sql_tuning_advisor_task_recommendations(self, managed_database_id, sql_ __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm - :param int sql_tuning_advisor_task_id: (required) - The SQL tuning task identifier. This is not the `OCID`__. - - __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm - - :param int sql_object_id: (required) - The SQL object ID for the SQL tuning task. This is not the `OCID`__. - - __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm - - :param int execution_id: (required) - The execution ID for an execution of a SQL tuning task. This is not the `OCID`__. + :param str owner: (optional) + The owner of the SQL tuning set. - __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + :param str name_contains: (optional) + Allow searching the name of the SQL tuning set by partial matching. The search is case insensitive. :param str sort_by: (optional) - The possible sortBy values of an object's recommendations. + The option to sort the SQL tuning set summary data. - Allowed values are: "RECOMMENDATION_TYPE", "BENEFIT" + Allowed values are: "NAME" :param str sort_order: (optional) - The option to sort information in ascending (\u2018ASC\u2019) or descending (\u2018DESC\u2019) order. Descending order is the default order. + The option to sort information in ascending (\u2018ASC\u2019) or descending (\u2018DESC\u2019) order. Ascending order is the default order. Allowed values are: "ASC", "DESC" @@ -989,37 +1791,177 @@ def list_sql_tuning_advisor_task_recommendations(self, managed_database_id, sql_ allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings - :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database_management.models.SqlTuningAdvisorTaskRecommendationCollection` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database_management.models.SqlTuningSetCollection` :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use list_sql_tuning_advisor_task_recommendations API. + Click `here `__ to see an example of how to use list_sql_tuning_sets API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['managedDatabaseId', 'sqlTuningAdvisorTaskId', 'sqlObjectId', 'executionId'] - resource_path = "/managedDatabases/{managedDatabaseId}/sqlTuningAdvisorTasks/{sqlTuningAdvisorTaskId}/recommendations" + required_arguments = ['managedDatabaseId'] + resource_path = "/managedDatabases/{managedDatabaseId}/sqlTuningSets" method = "GET" - operation_name = "list_sql_tuning_advisor_task_recommendations" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/database-management/20201101/ManagedDatabase/ListSqlTuningAdvisorTaskRecommendations" + operation_name = "list_sql_tuning_sets" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/database-management/20201101/ManagedDatabase/ListSqlTuningSets" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "owner", + "name_contains", + "sort_by", + "sort_order", + "page", + "limit", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_sql_tuning_sets got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "managedDatabaseId": managed_database_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["NAME"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) + ) + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + "Invalid value for `sort_order`, must be one of {0}".format(sort_order_allowed_values) + ) + + query_params = { + "owner": kwargs.get("owner", missing), + "nameContains": kwargs.get("name_contains", missing), + "sortBy": kwargs.get("sort_by", missing), + "sortOrder": kwargs.get("sort_order", missing), + "page": kwargs.get("page", missing), + "limit": kwargs.get("limit", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + query_params=query_params, + header_params=header_params, + response_type="SqlTuningSetCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + query_params=query_params, + header_params=header_params, + response_type="SqlTuningSetCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + + def load_sql_tuning_set(self, managed_database_id, sql_tuning_set_id, load_sql_tuning_set_details, **kwargs): + """ + Load Sql statements into the Sql tuning set specified by name and optional filter parameters within the Managed Database specified by managedDatabaseId. + + + :param str managed_database_id: (required) + The `OCID`__ of the Managed Database. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param int sql_tuning_set_id: (required) + The unique identifier of the Sql tuning set. This is not OCID. + + :param oci.database_management.models.LoadSqlTuningSetDetails load_sql_tuning_set_details: (required) + The details required to load Sql statements into the Sql tuning set. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param str opc_retry_token: (optional) + A token that uniquely identifies a request so it can be retried in case of a timeout or + server error without risk of executing that same action again. Retry tokens expire after 24 + hours, but can be invalidated before then due to conflicting operations. For example, if a resource + has been deleted and purged from the system, then a retry of the original creation request + might be rejected. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database_management.models.SqlTuningSetAdminActionStatus` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use load_sql_tuning_set API. + """ + # Required path and query arguments. These are in camelCase to replace values in service endpoints. + required_arguments = ['managedDatabaseId', 'sqlTuningSetId'] + resource_path = "/managedDatabases/{managedDatabaseId}/sqlTuningSets/{sqlTuningSetId}/actions/loadSqlTuningSet" + method = "POST" + operation_name = "load_sql_tuning_set" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/database-management/20201101/SqlTuningSet/LoadSqlTuningSet" # Don't accept unknown kwargs expected_kwargs = [ "allow_control_chars", "retry_strategy", - "sort_by", - "sort_order", - "page", - "limit", - "opc_request_id" + "opc_request_id", + "opc_retry_token" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - "list_sql_tuning_advisor_task_recommendations got unknown kwargs: {!r}".format(extra_kwargs)) + "load_sql_tuning_set got unknown kwargs: {!r}".format(extra_kwargs)) path_params = { "managedDatabaseId": managed_database_id, - "sqlTuningAdvisorTaskId": sql_tuning_advisor_task_id + "sqlTuningSetId": sql_tuning_set_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -1028,34 +1970,11 @@ def list_sql_tuning_advisor_task_recommendations(self, managed_database_id, sql_ if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) - if 'sort_by' in kwargs: - sort_by_allowed_values = ["RECOMMENDATION_TYPE", "BENEFIT"] - if kwargs['sort_by'] not in sort_by_allowed_values: - raise ValueError( - "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) - ) - - if 'sort_order' in kwargs: - sort_order_allowed_values = ["ASC", "DESC"] - if kwargs['sort_order'] not in sort_order_allowed_values: - raise ValueError( - "Invalid value for `sort_order`, must be one of {0}".format(sort_order_allowed_values) - ) - - query_params = { - "sqlObjectId": sql_object_id, - "executionId": execution_id, - "sortBy": kwargs.get("sort_by", missing), - "sortOrder": kwargs.get("sort_order", missing), - "page": kwargs.get("page", missing), - "limit": kwargs.get("limit", missing) - } - query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} - header_params = { "accept": "application/json", "content-type": "application/json", - "opc-request-id": kwargs.get("opc_request_id", missing) + "opc-request-id": kwargs.get("opc_request_id", missing), + "opc-retry-token": kwargs.get("opc_retry_token", missing) } header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} @@ -1063,9 +1982,12 @@ def list_sql_tuning_advisor_task_recommendations(self, managed_database_id, sql_ operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_retry_token_if_needed(header_params) self.base_client.add_opc_client_retries_header(header_params) retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) return retry_strategy.make_retrying_call( @@ -1073,9 +1995,9 @@ def list_sql_tuning_advisor_task_recommendations(self, managed_database_id, sql_ resource_path=resource_path, method=method, path_params=path_params, - query_params=query_params, header_params=header_params, - response_type="SqlTuningAdvisorTaskRecommendationCollection", + body=load_sql_tuning_set_details, + response_type="SqlTuningSetAdminActionStatus", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -1085,17 +2007,17 @@ def list_sql_tuning_advisor_task_recommendations(self, managed_database_id, sql_ resource_path=resource_path, method=method, path_params=path_params, - query_params=query_params, header_params=header_params, - response_type="SqlTuningAdvisorTaskRecommendationCollection", + body=load_sql_tuning_set_details, + response_type="SqlTuningSetAdminActionStatus", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def list_sql_tuning_advisor_tasks(self, managed_database_id, **kwargs): + def save_sql_tuning_set_as(self, managed_database_id, sql_tuning_set_id, save_sql_tuning_set_as_details, **kwargs): """ - Lists the SQL Tuning Advisor tasks for the specified Managed Database. + Saves the specified list of Sqls statements into another new Sql tuning set or loads into an existing Sql tuning set'. :param str managed_database_id: (required) @@ -1103,44 +2025,26 @@ def list_sql_tuning_advisor_tasks(self, managed_database_id, **kwargs): __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm - :param str name: (optional) - The optional query parameter to filter the SQL Tuning Advisor task list by name. - - :param str status: (optional) - The optional query parameter to filter the SQL Tuning Advisor task list by status. - - Allowed values are: "INITIAL", "EXECUTING", "INTERRUPTED", "COMPLETED", "ERROR" - - :param datetime time_greater_than_or_equal_to: (optional) - The optional greater than or equal to query parameter to filter the timestamp. - - :param datetime time_less_than_or_equal_to: (optional) - The optional less than or equal to query parameter to filter the timestamp. - - :param str page: (optional) - The page token representing the page from where the next set of paginated results - are retrieved. This is usually retrieved from a previous list call. - - :param int limit: (optional) - The maximum number of records returned in the paginated response. - - :param str sort_by: (optional) - The option to sort the SQL Tuning Advisor task summary data. - - Allowed values are: "NAME", "START_TIME" + :param int sql_tuning_set_id: (required) + The unique identifier of the Sql tuning set. This is not OCID. - :param str sort_order: (optional) - The option to sort information in ascending (\u2018ASC\u2019) or descending (\u2018DESC\u2019) order. Descending order is the default order. - - Allowed values are: "ASC", "DESC" + :param oci.database_management.models.SaveSqlTuningSetAsDetails save_sql_tuning_set_as_details: (required) + The details required to save a Sql tuning set into another Sql tuning set. :param str opc_request_id: (optional) The client request ID for tracing. + :param str opc_retry_token: (optional) + A token that uniquely identifies a request so it can be retried in case of a timeout or + server error without risk of executing that same action again. Retry tokens expire after 24 + hours, but can be invalidated before then due to conflicting operations. For example, if a resource + has been deleted and purged from the system, then a retry of the original creation request + might be rejected. + :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -1149,40 +2053,34 @@ def list_sql_tuning_advisor_tasks(self, managed_database_id, **kwargs): allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings - :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database_management.models.SqlTuningAdvisorTaskCollection` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database_management.models.SqlTuningSetAdminActionStatus` :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use list_sql_tuning_advisor_tasks API. + Click `here `__ to see an example of how to use save_sql_tuning_set_as API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['managedDatabaseId'] - resource_path = "/managedDatabases/{managedDatabaseId}/sqlTuningAdvisorTasks" - method = "GET" - operation_name = "list_sql_tuning_advisor_tasks" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/database-management/20201101/ManagedDatabase/ListSqlTuningAdvisorTasks" + required_arguments = ['managedDatabaseId', 'sqlTuningSetId'] + resource_path = "/managedDatabases/{managedDatabaseId}/sqlTuningSets/{sqlTuningSetId}/actions/saveAs" + method = "POST" + operation_name = "save_sql_tuning_set_as" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/database-management/20201101/SqlTuningSet/SaveSqlTuningSetAs" # Don't accept unknown kwargs expected_kwargs = [ "allow_control_chars", "retry_strategy", - "name", - "status", - "time_greater_than_or_equal_to", - "time_less_than_or_equal_to", - "page", - "limit", - "sort_by", - "sort_order", - "opc_request_id" + "opc_request_id", + "opc_retry_token" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - "list_sql_tuning_advisor_tasks got unknown kwargs: {!r}".format(extra_kwargs)) + "save_sql_tuning_set_as got unknown kwargs: {!r}".format(extra_kwargs)) path_params = { - "managedDatabaseId": managed_database_id + "managedDatabaseId": managed_database_id, + "sqlTuningSetId": sql_tuning_set_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -1191,43 +2089,11 @@ def list_sql_tuning_advisor_tasks(self, managed_database_id, **kwargs): if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) - if 'status' in kwargs: - status_allowed_values = ["INITIAL", "EXECUTING", "INTERRUPTED", "COMPLETED", "ERROR"] - if kwargs['status'] not in status_allowed_values: - raise ValueError( - "Invalid value for `status`, must be one of {0}".format(status_allowed_values) - ) - - if 'sort_by' in kwargs: - sort_by_allowed_values = ["NAME", "START_TIME"] - if kwargs['sort_by'] not in sort_by_allowed_values: - raise ValueError( - "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) - ) - - if 'sort_order' in kwargs: - sort_order_allowed_values = ["ASC", "DESC"] - if kwargs['sort_order'] not in sort_order_allowed_values: - raise ValueError( - "Invalid value for `sort_order`, must be one of {0}".format(sort_order_allowed_values) - ) - - query_params = { - "name": kwargs.get("name", missing), - "status": kwargs.get("status", missing), - "timeGreaterThanOrEqualTo": kwargs.get("time_greater_than_or_equal_to", missing), - "timeLessThanOrEqualTo": kwargs.get("time_less_than_or_equal_to", missing), - "page": kwargs.get("page", missing), - "limit": kwargs.get("limit", missing), - "sortBy": kwargs.get("sort_by", missing), - "sortOrder": kwargs.get("sort_order", missing) - } - query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} - header_params = { "accept": "application/json", "content-type": "application/json", - "opc-request-id": kwargs.get("opc_request_id", missing) + "opc-request-id": kwargs.get("opc_request_id", missing), + "opc-retry-token": kwargs.get("opc_retry_token", missing) } header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} @@ -1235,9 +2101,12 @@ def list_sql_tuning_advisor_tasks(self, managed_database_id, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_retry_token_if_needed(header_params) self.base_client.add_opc_client_retries_header(header_params) retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) return retry_strategy.make_retrying_call( @@ -1245,9 +2114,9 @@ def list_sql_tuning_advisor_tasks(self, managed_database_id, **kwargs): resource_path=resource_path, method=method, path_params=path_params, - query_params=query_params, header_params=header_params, - response_type="SqlTuningAdvisorTaskCollection", + body=save_sql_tuning_set_as_details, + response_type="SqlTuningSetAdminActionStatus", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -1257,17 +2126,17 @@ def list_sql_tuning_advisor_tasks(self, managed_database_id, **kwargs): resource_path=resource_path, method=method, path_params=path_params, - query_params=query_params, header_params=header_params, - response_type="SqlTuningAdvisorTaskCollection", + body=save_sql_tuning_set_as_details, + response_type="SqlTuningSetAdminActionStatus", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def list_sql_tuning_sets(self, managed_database_id, **kwargs): + def start_sql_tuning_task(self, managed_database_id, start_sql_tuning_task_details, **kwargs): """ - Lists the SQL tuning sets for the specified Managed Database. + Starts a SQL tuning task for a given set of SQL statements from the active session history top SQL statements. :param str managed_database_id: (required) @@ -1275,32 +2144,19 @@ def list_sql_tuning_sets(self, managed_database_id, **kwargs): __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm - :param str owner: (optional) - The owner of the SQL tuning set. - - :param str name_contains: (optional) - Allow searching the name of the SQL tuning set by partial matching. The search is case insensitive. - - :param str sort_by: (optional) - The option to sort the SQL tuning set summary data. - - Allowed values are: "NAME" - - :param str sort_order: (optional) - The option to sort information in ascending (\u2018ASC\u2019) or descending (\u2018DESC\u2019) order. Ascending order is the default order. - - Allowed values are: "ASC", "DESC" - - :param str page: (optional) - The page token representing the page from where the next set of paginated results - are retrieved. This is usually retrieved from a previous list call. - - :param int limit: (optional) - The maximum number of records returned in the paginated response. + :param oci.database_management.models.StartSqlTuningTaskDetails start_sql_tuning_task_details: (required) + The detailed inputs required to start a SQL tuning task. :param str opc_request_id: (optional) The client request ID for tracing. + :param str opc_retry_token: (optional) + A token that uniquely identifies a request so it can be retried in case of a timeout or + server error without risk of executing that same action again. Retry tokens expire after 24 + hours, but can be invalidated before then due to conflicting operations. For example, if a resource + has been deleted and purged from the system, then a retry of the original creation request + might be rejected. + :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. @@ -1313,35 +2169,30 @@ def list_sql_tuning_sets(self, managed_database_id, **kwargs): allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings - :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database_management.models.SqlTuningSetCollection` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database_management.models.SqlTuningTaskReturn` :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use list_sql_tuning_sets API. + Click `here `__ to see an example of how to use start_sql_tuning_task API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. required_arguments = ['managedDatabaseId'] - resource_path = "/managedDatabases/{managedDatabaseId}/sqlTuningSets" - method = "GET" - operation_name = "list_sql_tuning_sets" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/database-management/20201101/ManagedDatabase/ListSqlTuningSets" + resource_path = "/managedDatabases/{managedDatabaseId}/actions/startSqlTuningTask" + method = "POST" + operation_name = "start_sql_tuning_task" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/database-management/20201101/ManagedDatabase/StartSqlTuningTask" # Don't accept unknown kwargs expected_kwargs = [ "allow_control_chars", "retry_strategy", - "owner", - "name_contains", - "sort_by", - "sort_order", - "page", - "limit", - "opc_request_id" + "opc_request_id", + "opc_retry_token" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - "list_sql_tuning_sets got unknown kwargs: {!r}".format(extra_kwargs)) + "start_sql_tuning_task got unknown kwargs: {!r}".format(extra_kwargs)) path_params = { "managedDatabaseId": managed_database_id @@ -1353,34 +2204,11 @@ def list_sql_tuning_sets(self, managed_database_id, **kwargs): if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) - if 'sort_by' in kwargs: - sort_by_allowed_values = ["NAME"] - if kwargs['sort_by'] not in sort_by_allowed_values: - raise ValueError( - "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) - ) - - if 'sort_order' in kwargs: - sort_order_allowed_values = ["ASC", "DESC"] - if kwargs['sort_order'] not in sort_order_allowed_values: - raise ValueError( - "Invalid value for `sort_order`, must be one of {0}".format(sort_order_allowed_values) - ) - - query_params = { - "owner": kwargs.get("owner", missing), - "nameContains": kwargs.get("name_contains", missing), - "sortBy": kwargs.get("sort_by", missing), - "sortOrder": kwargs.get("sort_order", missing), - "page": kwargs.get("page", missing), - "limit": kwargs.get("limit", missing) - } - query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} - header_params = { "accept": "application/json", "content-type": "application/json", - "opc-request-id": kwargs.get("opc_request_id", missing) + "opc-request-id": kwargs.get("opc_request_id", missing), + "opc-retry-token": kwargs.get("opc_retry_token", missing) } header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} @@ -1391,6 +2219,7 @@ def list_sql_tuning_sets(self, managed_database_id, **kwargs): if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_retry_token_if_needed(header_params) self.base_client.add_opc_client_retries_header(header_params) retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) return retry_strategy.make_retrying_call( @@ -1398,9 +2227,9 @@ def list_sql_tuning_sets(self, managed_database_id, **kwargs): resource_path=resource_path, method=method, path_params=path_params, - query_params=query_params, header_params=header_params, - response_type="SqlTuningSetCollection", + body=start_sql_tuning_task_details, + response_type="SqlTuningTaskReturn", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -1410,17 +2239,17 @@ def list_sql_tuning_sets(self, managed_database_id, **kwargs): resource_path=resource_path, method=method, path_params=path_params, - query_params=query_params, header_params=header_params, - response_type="SqlTuningSetCollection", + body=start_sql_tuning_task_details, + response_type="SqlTuningTaskReturn", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def start_sql_tuning_task(self, managed_database_id, start_sql_tuning_task_details, **kwargs): + def validate_basic_filter(self, managed_database_id, sql_tuning_set_id, validate_basic_filter_details, **kwargs): """ - Starts a SQL tuning task for a given set of SQL statements from the active session history top SQL statements. + Executes a SQL query to check whether user entered basic filter criteria is valid or not. :param str managed_database_id: (required) @@ -1428,8 +2257,11 @@ def start_sql_tuning_task(self, managed_database_id, start_sql_tuning_task_detai __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm - :param oci.database_management.models.StartSqlTuningTaskDetails start_sql_tuning_task_details: (required) - The detailed inputs required to start a SQL tuning task. + :param int sql_tuning_set_id: (required) + The unique identifier of the Sql tuning set. This is not OCID. + + :param oci.database_management.models.ValidateBasicFilterDetails validate_basic_filter_details: (required) + Validate the basic filter criteria provided by the user. :param str opc_request_id: (optional) The client request ID for tracing. @@ -1444,7 +2276,7 @@ def start_sql_tuning_task(self, managed_database_id, start_sql_tuning_task_detai :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -1453,18 +2285,18 @@ def start_sql_tuning_task(self, managed_database_id, start_sql_tuning_task_detai allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings - :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database_management.models.SqlTuningTaskReturn` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database_management.models.SqlTuningSetAdminActionStatus` :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use start_sql_tuning_task API. + Click `here `__ to see an example of how to use validate_basic_filter API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['managedDatabaseId'] - resource_path = "/managedDatabases/{managedDatabaseId}/actions/startSqlTuningTask" + required_arguments = ['managedDatabaseId', 'sqlTuningSetId'] + resource_path = "/managedDatabases/{managedDatabaseId}/sqlTuningSets/{sqlTuningSetId}/actions/validateBasicFilter" method = "POST" - operation_name = "start_sql_tuning_task" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/database-management/20201101/ManagedDatabase/StartSqlTuningTask" + operation_name = "validate_basic_filter" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/database-management/20201101/SqlTuningSet/ValidateBasicFilter" # Don't accept unknown kwargs expected_kwargs = [ @@ -1476,10 +2308,11 @@ def start_sql_tuning_task(self, managed_database_id, start_sql_tuning_task_detai extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - "start_sql_tuning_task got unknown kwargs: {!r}".format(extra_kwargs)) + "validate_basic_filter got unknown kwargs: {!r}".format(extra_kwargs)) path_params = { - "managedDatabaseId": managed_database_id + "managedDatabaseId": managed_database_id, + "sqlTuningSetId": sql_tuning_set_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -1500,6 +2333,8 @@ def start_sql_tuning_task(self, managed_database_id, start_sql_tuning_task_detai operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -1512,8 +2347,8 @@ def start_sql_tuning_task(self, managed_database_id, start_sql_tuning_task_detai method=method, path_params=path_params, header_params=header_params, - body=start_sql_tuning_task_details, - response_type="SqlTuningTaskReturn", + body=validate_basic_filter_details, + response_type="SqlTuningSetAdminActionStatus", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -1524,8 +2359,8 @@ def start_sql_tuning_task(self, managed_database_id, start_sql_tuning_task_detai method=method, path_params=path_params, header_params=header_params, - body=start_sql_tuning_task_details, - response_type="SqlTuningTaskReturn", + body=validate_basic_filter_details, + response_type="SqlTuningSetAdminActionStatus", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, diff --git a/src/oci/database_migration/database_migration_client.py b/src/oci/database_migration/database_migration_client.py index 2b6dd5243a..855465ba8a 100644 --- a/src/oci/database_migration/database_migration_client.py +++ b/src/oci/database_migration/database_migration_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import database_migration_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("database_migration"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/database_tools/database_tools_client.py b/src/oci/database_tools/database_tools_client.py index 55b97a3b64..9401b746a8 100644 --- a/src/oci/database_tools/database_tools_client.py +++ b/src/oci/database_tools/database_tools_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import database_tools_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("database_tools"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/devops/devops_client.py b/src/oci/devops/devops_client.py index 07d41ce6af..55f7cb813e 100644 --- a/src/oci/devops/devops_client.py +++ b/src/oci/devops/devops_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import devops_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("devops"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/disaster_recovery/disaster_recovery_client.py b/src/oci/disaster_recovery/disaster_recovery_client.py index 112b848463..5a6b5040d2 100644 --- a/src/oci/disaster_recovery/disaster_recovery_client.py +++ b/src/oci/disaster_recovery/disaster_recovery_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import disaster_recovery_type_mapping missing = Sentinel("Missing") @@ -76,6 +78,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("disaster_recovery"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/dns/dns_client.py b/src/oci/dns/dns_client.py index 5bbe94c0d5..339d7c919d 100644 --- a/src/oci/dns/dns_client.py +++ b/src/oci/dns/dns_client.py @@ -15,6 +15,8 @@ from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME from oci.util import back_up_body_calculate_stream_content_length, is_content_length_calculable_by_req_util +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import dns_type_mapping missing = Sentinel("Missing") @@ -76,6 +78,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("dns"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/dts/appliance_export_job_client.py b/src/oci/dts/appliance_export_job_client.py index 64c301f123..7a5e0fafc6 100644 --- a/src/oci/dts/appliance_export_job_client.py +++ b/src/oci/dts/appliance_export_job_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import dts_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("dts"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/dts/shipping_vendors_client.py b/src/oci/dts/shipping_vendors_client.py index 82668b861a..04e1587f20 100644 --- a/src/oci/dts/shipping_vendors_client.py +++ b/src/oci/dts/shipping_vendors_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import dts_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("dts"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/dts/transfer_appliance_client.py b/src/oci/dts/transfer_appliance_client.py index c33610652c..9ad4b775a3 100644 --- a/src/oci/dts/transfer_appliance_client.py +++ b/src/oci/dts/transfer_appliance_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import dts_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("dts"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/dts/transfer_appliance_entitlement_client.py b/src/oci/dts/transfer_appliance_entitlement_client.py index 94833be7d2..40e07a5694 100644 --- a/src/oci/dts/transfer_appliance_entitlement_client.py +++ b/src/oci/dts/transfer_appliance_entitlement_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import dts_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("dts"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/dts/transfer_device_client.py b/src/oci/dts/transfer_device_client.py index 20c8eb36d6..7612aa1473 100644 --- a/src/oci/dts/transfer_device_client.py +++ b/src/oci/dts/transfer_device_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import dts_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("dts"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/dts/transfer_job_client.py b/src/oci/dts/transfer_job_client.py index c33a3ff9b8..dccc408570 100644 --- a/src/oci/dts/transfer_job_client.py +++ b/src/oci/dts/transfer_job_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import dts_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("dts"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/dts/transfer_package_client.py b/src/oci/dts/transfer_package_client.py index 15c561da0b..4a75b597b9 100644 --- a/src/oci/dts/transfer_package_client.py +++ b/src/oci/dts/transfer_package_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import dts_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("dts"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/em_warehouse/em_warehouse_client.py b/src/oci/em_warehouse/em_warehouse_client.py index 2d57c0d6d4..6d2e4bc3b5 100644 --- a/src/oci/em_warehouse/em_warehouse_client.py +++ b/src/oci/em_warehouse/em_warehouse_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import em_warehouse_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("em_warehouse"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/email/email_client.py b/src/oci/email/email_client.py index 0550763669..6dbd594fcc 100644 --- a/src/oci/email/email_client.py +++ b/src/oci/email/email_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import email_type_mapping missing = Sentinel("Missing") @@ -79,6 +81,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("email"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/events/events_client.py b/src/oci/events/events_client.py index d4ae82c3ec..6c312845e0 100644 --- a/src/oci/events/events_client.py +++ b/src/oci/events/events_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import events_type_mapping missing = Sentinel("Missing") @@ -75,6 +77,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("events"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/exceptions.py b/src/oci/exceptions.py index c6f1040916..643951bcd3 100644 --- a/src/oci/exceptions.py +++ b/src/oci/exceptions.py @@ -29,7 +29,7 @@ def __init__(self, status, code, headers, message, **kwargs): self.client_version = kwargs.get('client_version') self.timestamp = kwargs.get('timestamp') - api_errors_info = "See https://docs.oracle.com/iaas/Content/API/References/apierrors.htm#apierrors_{}__{}_{} for more information about resolving this error.".format(str(self.status), str(self.status), str(self.code).lower()) + api_errors_info = "See https://docs.oracle.com/iaas/Content/API/References/apierrors.htm#apierrors_{}__{}_{} for more information about resolving this error.".format(str(self.status), str(self.status), str(code).lower()) contact_info = "If you are unable to resolve this {} issue, please contact Oracle support and provide them this full error message.".format(self.target_service) if not message: @@ -104,6 +104,10 @@ def __str__(self): return str(self.errors) +class InvalidAlloyConfig(ClientError): + """Alloy config is invalid, or is blocking a service""" + + class InvalidResourcePrincipalArguments(ClientError): """The ResourceId is missing.""" diff --git a/src/oci/file_storage/file_storage_client.py b/src/oci/file_storage/file_storage_client.py index 490d07900b..5fe0269935 100644 --- a/src/oci/file_storage/file_storage_client.py +++ b/src/oci/file_storage/file_storage_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import file_storage_type_mapping missing = Sentinel("Missing") @@ -75,6 +77,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("file_storage"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/fleet_software_update/fleet_software_update_client.py b/src/oci/fleet_software_update/fleet_software_update_client.py index 8792dfee0c..6070ce81fb 100644 --- a/src/oci/fleet_software_update/fleet_software_update_client.py +++ b/src/oci/fleet_software_update/fleet_software_update_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import fleet_software_update_type_mapping missing = Sentinel("Missing") @@ -75,6 +77,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("fleet_software_update"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/functions/functions_invoke_client.py b/src/oci/functions/functions_invoke_client.py index e4c50eb05d..3a729ba68e 100644 --- a/src/oci/functions/functions_invoke_client.py +++ b/src/oci/functions/functions_invoke_client.py @@ -15,6 +15,8 @@ from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME from oci.util import back_up_body_calculate_stream_content_length, is_content_length_calculable_by_req_util +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import functions_type_mapping missing = Sentinel("Missing") @@ -75,6 +77,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("functions"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/functions/functions_management_client.py b/src/oci/functions/functions_management_client.py index 17edca76fa..9624181777 100644 --- a/src/oci/functions/functions_management_client.py +++ b/src/oci/functions/functions_management_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import functions_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("functions"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/fusion_apps/fusion_applications_client.py b/src/oci/fusion_apps/fusion_applications_client.py index eb78162e34..ac9742cf71 100644 --- a/src/oci/fusion_apps/fusion_applications_client.py +++ b/src/oci/fusion_apps/fusion_applications_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import fusion_apps_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("fusion_apps"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/generic_artifacts_content/generic_artifacts_content_client.py b/src/oci/generic_artifacts_content/generic_artifacts_content_client.py index a3e0aabbb0..64f963af8a 100644 --- a/src/oci/generic_artifacts_content/generic_artifacts_content_client.py +++ b/src/oci/generic_artifacts_content/generic_artifacts_content_client.py @@ -15,6 +15,8 @@ from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME from oci.util import back_up_body_calculate_stream_content_length, is_content_length_calculable_by_req_util +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import generic_artifacts_content_type_mapping missing = Sentinel("Missing") @@ -76,6 +78,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("generic_artifacts_content"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/golden_gate/golden_gate_client.py b/src/oci/golden_gate/golden_gate_client.py index db3643677a..c683ed8b4a 100644 --- a/src/oci/golden_gate/golden_gate_client.py +++ b/src/oci/golden_gate/golden_gate_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import golden_gate_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("golden_gate"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/governance_rules_control_plane/governance_rule_client.py b/src/oci/governance_rules_control_plane/governance_rule_client.py index 390b43eb65..d4e924a373 100644 --- a/src/oci/governance_rules_control_plane/governance_rule_client.py +++ b/src/oci/governance_rules_control_plane/governance_rule_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import governance_rules_control_plane_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("governance_rules_control_plane"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/governance_rules_control_plane/work_request_client.py b/src/oci/governance_rules_control_plane/work_request_client.py index 756cbb9c89..8a8505ba6e 100644 --- a/src/oci/governance_rules_control_plane/work_request_client.py +++ b/src/oci/governance_rules_control_plane/work_request_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import governance_rules_control_plane_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("governance_rules_control_plane"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/healthchecks/health_checks_client.py b/src/oci/healthchecks/health_checks_client.py index e3160fca18..5d27cceed3 100644 --- a/src/oci/healthchecks/health_checks_client.py +++ b/src/oci/healthchecks/health_checks_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import healthchecks_type_mapping missing = Sentinel("Missing") @@ -76,6 +78,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("healthchecks"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/identity/identity_client.py b/src/oci/identity/identity_client.py index 006ed2e9c4..444d3d19b7 100644 --- a/src/oci/identity/identity_client.py +++ b/src/oci/identity/identity_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import identity_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("identity"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/identity_data_plane/dataplane_client.py b/src/oci/identity_data_plane/dataplane_client.py index 5d446c8bed..e9119465cd 100644 --- a/src/oci/identity_data_plane/dataplane_client.py +++ b/src/oci/identity_data_plane/dataplane_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import identity_data_plane_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("identity_data_plane"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/identity_domains/identity_domains_client.py b/src/oci/identity_domains/identity_domains_client.py index 234c87c859..9bf10b72b7 100644 --- a/src/oci/identity_domains/identity_domains_client.py +++ b/src/oci/identity_domains/identity_domains_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import identity_domains_type_mapping missing = Sentinel("Missing") @@ -73,6 +75,9 @@ def __init__(self, config, service_endpoint, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("identity_domains"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/integration/integration_instance_client.py b/src/oci/integration/integration_instance_client.py index 7c2429acac..143bd676d4 100644 --- a/src/oci/integration/integration_instance_client.py +++ b/src/oci/integration/integration_instance_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import integration_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("integration"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/jms/java_management_service_client.py b/src/oci/jms/java_management_service_client.py index 239c051452..d02cbb9a77 100644 --- a/src/oci/jms/java_management_service_client.py +++ b/src/oci/jms/java_management_service_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import jms_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("jms"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/key_management/kms_crypto_client.py b/src/oci/key_management/kms_crypto_client.py index 1711dccb52..c840f23183 100644 --- a/src/oci/key_management/kms_crypto_client.py +++ b/src/oci/key_management/kms_crypto_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import key_management_type_mapping missing = Sentinel("Missing") @@ -73,6 +75,9 @@ def __init__(self, config, service_endpoint, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("key_management"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/key_management/kms_management_client.py b/src/oci/key_management/kms_management_client.py index c3fe5a4ed7..17ea505ebf 100644 --- a/src/oci/key_management/kms_management_client.py +++ b/src/oci/key_management/kms_management_client.py @@ -15,6 +15,8 @@ from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME from oci.util import back_up_body_calculate_stream_content_length, is_content_length_calculable_by_req_util +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import key_management_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, service_endpoint, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("key_management"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/key_management/kms_vault_client.py b/src/oci/key_management/kms_vault_client.py index 79fd2dcc9d..d52e91b979 100644 --- a/src/oci/key_management/kms_vault_client.py +++ b/src/oci/key_management/kms_vault_client.py @@ -15,6 +15,8 @@ from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME from oci.util import back_up_body_calculate_stream_content_length, is_content_length_calculable_by_req_util +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import key_management_type_mapping missing = Sentinel("Missing") @@ -76,6 +78,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("key_management"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/license_manager/license_manager_client.py b/src/oci/license_manager/license_manager_client.py index c51c1d24b0..c4747bcebd 100644 --- a/src/oci/license_manager/license_manager_client.py +++ b/src/oci/license_manager/license_manager_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import license_manager_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("license_manager"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/limits/limits_client.py b/src/oci/limits/limits_client.py index e70cf1605c..f966903528 100644 --- a/src/oci/limits/limits_client.py +++ b/src/oci/limits/limits_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import limits_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("limits"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/limits/quotas_client.py b/src/oci/limits/quotas_client.py index e7f36c7b9e..efbc0a4895 100644 --- a/src/oci/limits/quotas_client.py +++ b/src/oci/limits/quotas_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import limits_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("limits"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/load_balancer/load_balancer_client.py b/src/oci/load_balancer/load_balancer_client.py index 100161cbfb..278c22da8f 100644 --- a/src/oci/load_balancer/load_balancer_client.py +++ b/src/oci/load_balancer/load_balancer_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import load_balancer_type_mapping missing = Sentinel("Missing") @@ -75,6 +77,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("load_balancer"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/lockbox/lockbox_client.py b/src/oci/lockbox/lockbox_client.py index 6eeab21a62..874f7a3439 100644 --- a/src/oci/lockbox/lockbox_client.py +++ b/src/oci/lockbox/lockbox_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import lockbox_type_mapping missing = Sentinel("Missing") @@ -76,6 +78,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("lockbox"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/log_analytics/log_analytics_client.py b/src/oci/log_analytics/log_analytics_client.py index 0a17e75ea9..e3523c6a39 100644 --- a/src/oci/log_analytics/log_analytics_client.py +++ b/src/oci/log_analytics/log_analytics_client.py @@ -15,6 +15,8 @@ from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME from oci.util import back_up_body_calculate_stream_content_length, is_content_length_calculable_by_req_util +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import log_analytics_type_mapping missing = Sentinel("Missing") @@ -75,6 +77,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("log_analytics"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/logging/logging_management_client.py b/src/oci/logging/logging_management_client.py index 9c2a627a0d..e7a9a259d4 100644 --- a/src/oci/logging/logging_management_client.py +++ b/src/oci/logging/logging_management_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import logging_type_mapping missing = Sentinel("Missing") @@ -78,6 +80,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("logging"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/loggingingestion/logging_client.py b/src/oci/loggingingestion/logging_client.py index 3f41f201fc..8e1c1f4968 100644 --- a/src/oci/loggingingestion/logging_client.py +++ b/src/oci/loggingingestion/logging_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import loggingingestion_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("loggingingestion"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/loggingsearch/log_search_client.py b/src/oci/loggingsearch/log_search_client.py index e3497de336..a6a7287e59 100644 --- a/src/oci/loggingsearch/log_search_client.py +++ b/src/oci/loggingsearch/log_search_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import loggingsearch_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("loggingsearch"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/management_agent/management_agent_client.py b/src/oci/management_agent/management_agent_client.py index f1859c7dc2..4c95d994cd 100644 --- a/src/oci/management_agent/management_agent_client.py +++ b/src/oci/management_agent/management_agent_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import management_agent_type_mapping missing = Sentinel("Missing") @@ -75,6 +77,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("management_agent"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/management_dashboard/dashx_apis_client.py b/src/oci/management_dashboard/dashx_apis_client.py index bf2618e405..8b962c6636 100644 --- a/src/oci/management_dashboard/dashx_apis_client.py +++ b/src/oci/management_dashboard/dashx_apis_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import management_dashboard_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("management_dashboard"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/marketplace/account_client.py b/src/oci/marketplace/account_client.py index e0b7396ef8..7fdb806738 100644 --- a/src/oci/marketplace/account_client.py +++ b/src/oci/marketplace/account_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import marketplace_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("marketplace"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/marketplace/marketplace_client.py b/src/oci/marketplace/marketplace_client.py index 18fdd4b633..9256dc6038 100644 --- a/src/oci/marketplace/marketplace_client.py +++ b/src/oci/marketplace/marketplace_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import marketplace_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("marketplace"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/media_services/media_services_client.py b/src/oci/media_services/media_services_client.py index 8a993970b2..d1dd502685 100644 --- a/src/oci/media_services/media_services_client.py +++ b/src/oci/media_services/media_services_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import media_services_type_mapping missing = Sentinel("Missing") @@ -76,6 +78,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("media_services"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/media_services/media_stream_client.py b/src/oci/media_services/media_stream_client.py index 29f5fed5ed..8caee1ed87 100644 --- a/src/oci/media_services/media_stream_client.py +++ b/src/oci/media_services/media_stream_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import media_services_type_mapping missing = Sentinel("Missing") @@ -76,6 +78,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("media_services"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/monitoring/monitoring_client.py b/src/oci/monitoring/monitoring_client.py index 65dcbb8273..c84653a363 100644 --- a/src/oci/monitoring/monitoring_client.py +++ b/src/oci/monitoring/monitoring_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import monitoring_type_mapping missing = Sentinel("Missing") @@ -76,6 +78,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("monitoring"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/mysql/channels_client.py b/src/oci/mysql/channels_client.py index b00ef7fda1..e14fad7638 100644 --- a/src/oci/mysql/channels_client.py +++ b/src/oci/mysql/channels_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import mysql_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("mysql"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/mysql/db_backups_client.py b/src/oci/mysql/db_backups_client.py index a852cd7837..afb0638025 100644 --- a/src/oci/mysql/db_backups_client.py +++ b/src/oci/mysql/db_backups_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import mysql_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("mysql"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/mysql/db_system_client.py b/src/oci/mysql/db_system_client.py index 47ce83526b..a7868f652c 100644 --- a/src/oci/mysql/db_system_client.py +++ b/src/oci/mysql/db_system_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import mysql_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("mysql"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/mysql/mysqlaas_client.py b/src/oci/mysql/mysqlaas_client.py index 0a3c0c6984..fd624c8cf6 100644 --- a/src/oci/mysql/mysqlaas_client.py +++ b/src/oci/mysql/mysqlaas_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import mysql_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("mysql"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/mysql/replicas_client.py b/src/oci/mysql/replicas_client.py index bc4e56f41e..ac92e96706 100644 --- a/src/oci/mysql/replicas_client.py +++ b/src/oci/mysql/replicas_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import mysql_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("mysql"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/mysql/work_requests_client.py b/src/oci/mysql/work_requests_client.py index 6e6c53315e..fae81411ec 100644 --- a/src/oci/mysql/work_requests_client.py +++ b/src/oci/mysql/work_requests_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import mysql_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("mysql"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/network_firewall/network_firewall_client.py b/src/oci/network_firewall/network_firewall_client.py index 2368c58ecd..82d17da75d 100644 --- a/src/oci/network_firewall/network_firewall_client.py +++ b/src/oci/network_firewall/network_firewall_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import network_firewall_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("network_firewall"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/network_load_balancer/network_load_balancer_client.py b/src/oci/network_load_balancer/network_load_balancer_client.py index a098ad7315..6048cdbbb2 100644 --- a/src/oci/network_load_balancer/network_load_balancer_client.py +++ b/src/oci/network_load_balancer/network_load_balancer_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import network_load_balancer_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("network_load_balancer"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/nosql/nosql_client.py b/src/oci/nosql/nosql_client.py index 20d000e651..bb7b07cc7d 100644 --- a/src/oci/nosql/nosql_client.py +++ b/src/oci/nosql/nosql_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import nosql_type_mapping missing = Sentinel("Missing") @@ -77,6 +79,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("nosql"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/object_storage/object_storage_client.py b/src/oci/object_storage/object_storage_client.py index 7587427c16..b02cc621b4 100644 --- a/src/oci/object_storage/object_storage_client.py +++ b/src/oci/object_storage/object_storage_client.py @@ -15,6 +15,8 @@ from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME from oci.util import back_up_body_calculate_stream_content_length, is_content_length_calculable_by_req_util +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import object_storage_type_mapping missing = Sentinel("Missing") @@ -77,6 +79,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("object_storage"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/oce/oce_instance_client.py b/src/oci/oce/oce_instance_client.py index bbe9f17835..36586c7841 100644 --- a/src/oci/oce/oce_instance_client.py +++ b/src/oci/oce/oce_instance_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import oce_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("oce"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/oci_control_center/occ_metrics_client.py b/src/oci/oci_control_center/occ_metrics_client.py index 58d630d84e..bf0dca15b9 100644 --- a/src/oci/oci_control_center/occ_metrics_client.py +++ b/src/oci/oci_control_center/occ_metrics_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import oci_control_center_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("oci_control_center"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/ocvp/esxi_host_client.py b/src/oci/ocvp/esxi_host_client.py index 4f20a132a5..957618ef03 100644 --- a/src/oci/ocvp/esxi_host_client.py +++ b/src/oci/ocvp/esxi_host_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import ocvp_type_mapping missing = Sentinel("Missing") @@ -75,6 +77,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("ocvp"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/ocvp/sddc_client.py b/src/oci/ocvp/sddc_client.py index 417f350282..758b2ad735 100644 --- a/src/oci/ocvp/sddc_client.py +++ b/src/oci/ocvp/sddc_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import ocvp_type_mapping missing = Sentinel("Missing") @@ -75,6 +77,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("ocvp"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/ocvp/work_request_client.py b/src/oci/ocvp/work_request_client.py index eaead4a81f..4e1c2191f1 100644 --- a/src/oci/ocvp/work_request_client.py +++ b/src/oci/ocvp/work_request_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import ocvp_type_mapping missing = Sentinel("Missing") @@ -75,6 +77,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("ocvp"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/oda/management_client.py b/src/oci/oda/management_client.py index 408213bfb1..84240bef21 100644 --- a/src/oci/oda/management_client.py +++ b/src/oci/oda/management_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import oda_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("oda"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/oda/oda_client.py b/src/oci/oda/oda_client.py index adbda056d0..6f48fb85ad 100644 --- a/src/oci/oda/oda_client.py +++ b/src/oci/oda/oda_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import oda_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("oda"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/oda/odapackage_client.py b/src/oci/oda/odapackage_client.py index 2986c3c3d3..26bbe15223 100644 --- a/src/oci/oda/odapackage_client.py +++ b/src/oci/oda/odapackage_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import oda_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("oda"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/onesubscription/billing_schedule_client.py b/src/oci/onesubscription/billing_schedule_client.py index 3f77cc0cfc..c2a2c6a19e 100644 --- a/src/oci/onesubscription/billing_schedule_client.py +++ b/src/oci/onesubscription/billing_schedule_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import onesubscription_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("onesubscription"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/onesubscription/commitment_client.py b/src/oci/onesubscription/commitment_client.py index 614cbe3842..b9532a6fcd 100644 --- a/src/oci/onesubscription/commitment_client.py +++ b/src/oci/onesubscription/commitment_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import onesubscription_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("onesubscription"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/onesubscription/computed_usage_client.py b/src/oci/onesubscription/computed_usage_client.py index f7509ed9de..7ed67849ce 100644 --- a/src/oci/onesubscription/computed_usage_client.py +++ b/src/oci/onesubscription/computed_usage_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import onesubscription_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("onesubscription"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/onesubscription/invoice_summary_client.py b/src/oci/onesubscription/invoice_summary_client.py index 38cef04d0b..b79d4b59af 100644 --- a/src/oci/onesubscription/invoice_summary_client.py +++ b/src/oci/onesubscription/invoice_summary_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import onesubscription_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("onesubscription"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/onesubscription/organization_subscription_client.py b/src/oci/onesubscription/organization_subscription_client.py index 169941a5db..e119986bc4 100644 --- a/src/oci/onesubscription/organization_subscription_client.py +++ b/src/oci/onesubscription/organization_subscription_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import onesubscription_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("onesubscription"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/onesubscription/ratecard_client.py b/src/oci/onesubscription/ratecard_client.py index 48de768a6e..9fee621131 100644 --- a/src/oci/onesubscription/ratecard_client.py +++ b/src/oci/onesubscription/ratecard_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import onesubscription_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("onesubscription"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/onesubscription/subscribed_service_client.py b/src/oci/onesubscription/subscribed_service_client.py index 7ffc14c7cb..2081f6d08f 100644 --- a/src/oci/onesubscription/subscribed_service_client.py +++ b/src/oci/onesubscription/subscribed_service_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import onesubscription_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("onesubscription"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/onesubscription/subscription_client.py b/src/oci/onesubscription/subscription_client.py index e66ac83ab6..e58b2be834 100644 --- a/src/oci/onesubscription/subscription_client.py +++ b/src/oci/onesubscription/subscription_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import onesubscription_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("onesubscription"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/ons/notification_control_plane_client.py b/src/oci/ons/notification_control_plane_client.py index 727d94720e..0ac409eb12 100644 --- a/src/oci/ons/notification_control_plane_client.py +++ b/src/oci/ons/notification_control_plane_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import ons_type_mapping missing = Sentinel("Missing") @@ -75,6 +77,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("ons"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/ons/notification_data_plane_client.py b/src/oci/ons/notification_data_plane_client.py index 5d33e18063..7dad9b26b0 100644 --- a/src/oci/ons/notification_data_plane_client.py +++ b/src/oci/ons/notification_data_plane_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import ons_type_mapping missing = Sentinel("Missing") @@ -75,6 +77,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("ons"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/opa/opa_instance_client.py b/src/oci/opa/opa_instance_client.py index 0c5efd6410..c8622b0e88 100644 --- a/src/oci/opa/opa_instance_client.py +++ b/src/oci/opa/opa_instance_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import opa_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("opa"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/opensearch/opensearch_cluster_backup_client.py b/src/oci/opensearch/opensearch_cluster_backup_client.py index 4c4c715462..a50b4cc5f9 100644 --- a/src/oci/opensearch/opensearch_cluster_backup_client.py +++ b/src/oci/opensearch/opensearch_cluster_backup_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import opensearch_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("opensearch"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/opensearch/opensearch_cluster_client.py b/src/oci/opensearch/opensearch_cluster_client.py index 8779510625..0ca7dfd4c0 100644 --- a/src/oci/opensearch/opensearch_cluster_client.py +++ b/src/oci/opensearch/opensearch_cluster_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import opensearch_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("opensearch"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/operator_access_control/access_requests_client.py b/src/oci/operator_access_control/access_requests_client.py index c2e247770e..258e0f8dd2 100644 --- a/src/oci/operator_access_control/access_requests_client.py +++ b/src/oci/operator_access_control/access_requests_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import operator_access_control_type_mapping missing = Sentinel("Missing") @@ -77,6 +79,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("operator_access_control"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/operator_access_control/operator_actions_client.py b/src/oci/operator_access_control/operator_actions_client.py index d077fb7d75..b3ae2a5384 100644 --- a/src/oci/operator_access_control/operator_actions_client.py +++ b/src/oci/operator_access_control/operator_actions_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import operator_access_control_type_mapping missing = Sentinel("Missing") @@ -77,6 +79,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("operator_access_control"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/operator_access_control/operator_control_assignment_client.py b/src/oci/operator_access_control/operator_control_assignment_client.py index 67179db56d..1e69d5676d 100644 --- a/src/oci/operator_access_control/operator_control_assignment_client.py +++ b/src/oci/operator_access_control/operator_control_assignment_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import operator_access_control_type_mapping missing = Sentinel("Missing") @@ -77,6 +79,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("operator_access_control"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/operator_access_control/operator_control_client.py b/src/oci/operator_access_control/operator_control_client.py index 37b7ddb982..c7ce09ab31 100644 --- a/src/oci/operator_access_control/operator_control_client.py +++ b/src/oci/operator_access_control/operator_control_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import operator_access_control_type_mapping missing = Sentinel("Missing") @@ -77,6 +79,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("operator_access_control"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/opsi/operations_insights_client.py b/src/oci/opsi/operations_insights_client.py index 63e4953590..afdc51d1e8 100644 --- a/src/oci/opsi/operations_insights_client.py +++ b/src/oci/opsi/operations_insights_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import opsi_type_mapping missing = Sentinel("Missing") @@ -76,6 +78,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("opsi"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/optimizer/optimizer_client.py b/src/oci/optimizer/optimizer_client.py index 90e4159231..7c4810ba5b 100644 --- a/src/oci/optimizer/optimizer_client.py +++ b/src/oci/optimizer/optimizer_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import optimizer_type_mapping missing = Sentinel("Missing") @@ -76,6 +78,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("optimizer"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/os_management/event_client.py b/src/oci/os_management/event_client.py index c46af298e4..5aac13afce 100644 --- a/src/oci/os_management/event_client.py +++ b/src/oci/os_management/event_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import os_management_type_mapping missing = Sentinel("Missing") @@ -75,6 +77,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("os_management"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/os_management/os_management_client.py b/src/oci/os_management/os_management_client.py index c7081c63b9..5fea456923 100644 --- a/src/oci/os_management/os_management_client.py +++ b/src/oci/os_management/os_management_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import os_management_type_mapping missing = Sentinel("Missing") @@ -75,6 +77,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("os_management"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/os_management_hub/lifecycle_environment_client.py b/src/oci/os_management_hub/lifecycle_environment_client.py index 1d316a34f7..18ce5ce1bd 100644 --- a/src/oci/os_management_hub/lifecycle_environment_client.py +++ b/src/oci/os_management_hub/lifecycle_environment_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import os_management_hub_type_mapping missing = Sentinel("Missing") @@ -21,7 +23,6 @@ class LifecycleEnvironmentClient(object): """ Use the OS Management Hub API to manage and monitor updates and patches for the operating system environments in your private data centers through a single management console. For more information, see [Overview of OS Management Hub](https://docs.cloud.oracle.com/iaas/osmh/doc/overview.htm). - Use the table of contents and search tool to explore the OS Management Hub API. """ def __init__(self, config, **kwargs): @@ -75,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("os_management_hub"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/os_management_hub/managed_instance_client.py b/src/oci/os_management_hub/managed_instance_client.py index 9e4cddfde2..2d01985d04 100644 --- a/src/oci/os_management_hub/managed_instance_client.py +++ b/src/oci/os_management_hub/managed_instance_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import os_management_hub_type_mapping missing = Sentinel("Missing") @@ -21,7 +23,6 @@ class ManagedInstanceClient(object): """ Use the OS Management Hub API to manage and monitor updates and patches for the operating system environments in your private data centers through a single management console. For more information, see [Overview of OS Management Hub](https://docs.cloud.oracle.com/iaas/osmh/doc/overview.htm). - Use the table of contents and search tool to explore the OS Management Hub API. """ def __init__(self, config, **kwargs): @@ -75,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("os_management_hub"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/os_management_hub/managed_instance_group_client.py b/src/oci/os_management_hub/managed_instance_group_client.py index e48f357b51..680a922aaa 100644 --- a/src/oci/os_management_hub/managed_instance_group_client.py +++ b/src/oci/os_management_hub/managed_instance_group_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import os_management_hub_type_mapping missing = Sentinel("Missing") @@ -21,7 +23,6 @@ class ManagedInstanceGroupClient(object): """ Use the OS Management Hub API to manage and monitor updates and patches for the operating system environments in your private data centers through a single management console. For more information, see [Overview of OS Management Hub](https://docs.cloud.oracle.com/iaas/osmh/doc/overview.htm). - Use the table of contents and search tool to explore the OS Management Hub API. """ def __init__(self, config, **kwargs): @@ -75,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("os_management_hub"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/os_management_hub/management_station_client.py b/src/oci/os_management_hub/management_station_client.py index d0cb2b2e4a..02843ad73d 100644 --- a/src/oci/os_management_hub/management_station_client.py +++ b/src/oci/os_management_hub/management_station_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import os_management_hub_type_mapping missing = Sentinel("Missing") @@ -21,7 +23,6 @@ class ManagementStationClient(object): """ Use the OS Management Hub API to manage and monitor updates and patches for the operating system environments in your private data centers through a single management console. For more information, see [Overview of OS Management Hub](https://docs.cloud.oracle.com/iaas/osmh/doc/overview.htm). - Use the table of contents and search tool to explore the OS Management Hub API. """ def __init__(self, config, **kwargs): @@ -75,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("os_management_hub"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/os_management_hub/models/managed_instance_group.py b/src/oci/os_management_hub/models/managed_instance_group.py index f86ff7f53f..0f2778ea98 100644 --- a/src/oci/os_management_hub/models/managed_instance_group.py +++ b/src/oci/os_management_hub/models/managed_instance_group.py @@ -132,6 +132,10 @@ def __init__(self, **kwargs): The value to assign to the software_source_ids property of this ManagedInstanceGroup. :type software_source_ids: list[oci.os_management_hub.models.SoftwareSourceDetails] + :param software_sources: + The value to assign to the software_sources property of this ManagedInstanceGroup. + :type software_sources: list[oci.os_management_hub.models.SoftwareSourceDetails] + :param managed_instance_ids: The value to assign to the managed_instance_ids property of this ManagedInstanceGroup. :type managed_instance_ids: list[str] @@ -169,6 +173,7 @@ def __init__(self, **kwargs): 'arch_type': 'str', 'vendor_name': 'str', 'software_source_ids': 'list[SoftwareSourceDetails]', + 'software_sources': 'list[SoftwareSourceDetails]', 'managed_instance_ids': 'list[str]', 'managed_instance_count': 'int', 'pending_job_count': 'int', @@ -189,6 +194,7 @@ def __init__(self, **kwargs): 'arch_type': 'archType', 'vendor_name': 'vendorName', 'software_source_ids': 'softwareSourceIds', + 'software_sources': 'softwareSources', 'managed_instance_ids': 'managedInstanceIds', 'managed_instance_count': 'managedInstanceCount', 'pending_job_count': 'pendingJobCount', @@ -208,6 +214,7 @@ def __init__(self, **kwargs): self._arch_type = None self._vendor_name = None self._software_source_ids = None + self._software_sources = None self._managed_instance_ids = None self._managed_instance_count = None self._pending_job_count = None @@ -503,6 +510,30 @@ def software_source_ids(self, software_source_ids): """ self._software_source_ids = software_source_ids + @property + def software_sources(self): + """ + Gets the software_sources of this ManagedInstanceGroup. + The list of software sources that the managed instance group will use. + + + :return: The software_sources of this ManagedInstanceGroup. + :rtype: list[oci.os_management_hub.models.SoftwareSourceDetails] + """ + return self._software_sources + + @software_sources.setter + def software_sources(self, software_sources): + """ + Sets the software_sources of this ManagedInstanceGroup. + The list of software sources that the managed instance group will use. + + + :param software_sources: The software_sources of this ManagedInstanceGroup. + :type: list[oci.os_management_hub.models.SoftwareSourceDetails] + """ + self._software_sources = software_sources + @property def managed_instance_ids(self): """ diff --git a/src/oci/os_management_hub/onboarding_client.py b/src/oci/os_management_hub/onboarding_client.py index 5193897359..664efde4d4 100644 --- a/src/oci/os_management_hub/onboarding_client.py +++ b/src/oci/os_management_hub/onboarding_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import os_management_hub_type_mapping missing = Sentinel("Missing") @@ -21,7 +23,6 @@ class OnboardingClient(object): """ Use the OS Management Hub API to manage and monitor updates and patches for the operating system environments in your private data centers through a single management console. For more information, see [Overview of OS Management Hub](https://docs.cloud.oracle.com/iaas/osmh/doc/overview.htm). - Use the table of contents and search tool to explore the OS Management Hub API. """ def __init__(self, config, **kwargs): @@ -75,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("os_management_hub"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/os_management_hub/reporting_managed_instance_client.py b/src/oci/os_management_hub/reporting_managed_instance_client.py index 98184f7b49..dfbcc1ca47 100644 --- a/src/oci/os_management_hub/reporting_managed_instance_client.py +++ b/src/oci/os_management_hub/reporting_managed_instance_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import os_management_hub_type_mapping missing = Sentinel("Missing") @@ -21,7 +23,6 @@ class ReportingManagedInstanceClient(object): """ Use the OS Management Hub API to manage and monitor updates and patches for the operating system environments in your private data centers through a single management console. For more information, see [Overview of OS Management Hub](https://docs.cloud.oracle.com/iaas/osmh/doc/overview.htm). - Use the table of contents and search tool to explore the OS Management Hub API. """ def __init__(self, config, **kwargs): @@ -75,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("os_management_hub"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/os_management_hub/scheduled_job_client.py b/src/oci/os_management_hub/scheduled_job_client.py index b4c60cde4a..139adbf650 100644 --- a/src/oci/os_management_hub/scheduled_job_client.py +++ b/src/oci/os_management_hub/scheduled_job_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import os_management_hub_type_mapping missing = Sentinel("Missing") @@ -21,7 +23,6 @@ class ScheduledJobClient(object): """ Use the OS Management Hub API to manage and monitor updates and patches for the operating system environments in your private data centers through a single management console. For more information, see [Overview of OS Management Hub](https://docs.cloud.oracle.com/iaas/osmh/doc/overview.htm). - Use the table of contents and search tool to explore the OS Management Hub API. """ def __init__(self, config, **kwargs): @@ -75,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("os_management_hub"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/os_management_hub/software_source_client.py b/src/oci/os_management_hub/software_source_client.py index 353076287c..92b4c1dcf3 100644 --- a/src/oci/os_management_hub/software_source_client.py +++ b/src/oci/os_management_hub/software_source_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import os_management_hub_type_mapping missing = Sentinel("Missing") @@ -21,7 +23,6 @@ class SoftwareSourceClient(object): """ Use the OS Management Hub API to manage and monitor updates and patches for the operating system environments in your private data centers through a single management console. For more information, see [Overview of OS Management Hub](https://docs.cloud.oracle.com/iaas/osmh/doc/overview.htm). - Use the table of contents and search tool to explore the OS Management Hub API. """ def __init__(self, config, **kwargs): @@ -75,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("os_management_hub"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/os_management_hub/work_request_client.py b/src/oci/os_management_hub/work_request_client.py index c957d58b24..a731d63f25 100644 --- a/src/oci/os_management_hub/work_request_client.py +++ b/src/oci/os_management_hub/work_request_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import os_management_hub_type_mapping missing = Sentinel("Missing") @@ -21,7 +23,6 @@ class WorkRequestClient(object): """ Use the OS Management Hub API to manage and monitor updates and patches for the operating system environments in your private data centers through a single management console. For more information, see [Overview of OS Management Hub](https://docs.cloud.oracle.com/iaas/osmh/doc/overview.htm). - Use the table of contents and search tool to explore the OS Management Hub API. """ def __init__(self, config, **kwargs): @@ -75,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("os_management_hub"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/osp_gateway/address_rule_service_client.py b/src/oci/osp_gateway/address_rule_service_client.py index b8bb98babe..2720a4e783 100644 --- a/src/oci/osp_gateway/address_rule_service_client.py +++ b/src/oci/osp_gateway/address_rule_service_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import osp_gateway_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("osp_gateway"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/osp_gateway/address_service_client.py b/src/oci/osp_gateway/address_service_client.py index 2cb1ca4c52..8c2f70d9cc 100644 --- a/src/oci/osp_gateway/address_service_client.py +++ b/src/oci/osp_gateway/address_service_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import osp_gateway_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("osp_gateway"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/osp_gateway/invoice_service_client.py b/src/oci/osp_gateway/invoice_service_client.py index 261919a757..cbb6975fbd 100644 --- a/src/oci/osp_gateway/invoice_service_client.py +++ b/src/oci/osp_gateway/invoice_service_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import osp_gateway_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("osp_gateway"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/osp_gateway/subscription_service_client.py b/src/oci/osp_gateway/subscription_service_client.py index eb5022defd..84f369ba8f 100644 --- a/src/oci/osp_gateway/subscription_service_client.py +++ b/src/oci/osp_gateway/subscription_service_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import osp_gateway_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("osp_gateway"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/osub_billing_schedule/billing_schedule_client.py b/src/oci/osub_billing_schedule/billing_schedule_client.py index 8e05382381..03c51de59e 100644 --- a/src/oci/osub_billing_schedule/billing_schedule_client.py +++ b/src/oci/osub_billing_schedule/billing_schedule_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import osub_billing_schedule_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("osub_billing_schedule"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/osub_organization_subscription/organization_subscription_client.py b/src/oci/osub_organization_subscription/organization_subscription_client.py index 88aef801e2..8305944d64 100644 --- a/src/oci/osub_organization_subscription/organization_subscription_client.py +++ b/src/oci/osub_organization_subscription/organization_subscription_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import osub_organization_subscription_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("osub_organization_subscription"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/osub_subscription/commitment_client.py b/src/oci/osub_subscription/commitment_client.py index f121f060a6..55379b68c4 100644 --- a/src/oci/osub_subscription/commitment_client.py +++ b/src/oci/osub_subscription/commitment_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import osub_subscription_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("osub_subscription"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/osub_subscription/ratecard_client.py b/src/oci/osub_subscription/ratecard_client.py index 4f3396b093..e29b141397 100644 --- a/src/oci/osub_subscription/ratecard_client.py +++ b/src/oci/osub_subscription/ratecard_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import osub_subscription_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("osub_subscription"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/osub_subscription/subscription_client.py b/src/oci/osub_subscription/subscription_client.py index c059a9499c..4d4d54cb83 100644 --- a/src/oci/osub_subscription/subscription_client.py +++ b/src/oci/osub_subscription/subscription_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import osub_subscription_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("osub_subscription"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/osub_usage/computed_usage_client.py b/src/oci/osub_usage/computed_usage_client.py index e25f93498b..57ac649b30 100644 --- a/src/oci/osub_usage/computed_usage_client.py +++ b/src/oci/osub_usage/computed_usage_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import osub_usage_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("osub_usage"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/queue/queue_admin_client.py b/src/oci/queue/queue_admin_client.py index d3f24deae3..bb680907d8 100644 --- a/src/oci/queue/queue_admin_client.py +++ b/src/oci/queue/queue_admin_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import queue_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("queue"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/queue/queue_client.py b/src/oci/queue/queue_client.py index cd4e4ef0c9..e5aba488c1 100644 --- a/src/oci/queue/queue_client.py +++ b/src/oci/queue/queue_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import queue_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("queue"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/recovery/database_recovery_client.py b/src/oci/recovery/database_recovery_client.py index 4c0fe4389d..e7a8ef922f 100644 --- a/src/oci/recovery/database_recovery_client.py +++ b/src/oci/recovery/database_recovery_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import recovery_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("recovery"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/regions.py b/src/oci/regions.py index 97ebf0ca87..b066ab83c2 100644 --- a/src/oci/regions.py +++ b/src/oci/regions.py @@ -10,6 +10,7 @@ from . import regions_definitions from . import service_endpoints +from oci.exceptions import InvalidAlloyConfig from oci._vendor import six from oci._vendor import requests from oci._vendor.requests.exceptions import HTTPError, ConnectionError, RetryError @@ -65,6 +66,13 @@ ExternalSources.SECOND_LEVEL_DOMAIN_FALLBACK: False } +# Alloy config +_IS_ALLOY_MODE = False +OCI_ALLOY_REGION_COEXIST_ENV_VAR_NAME = "OCI_ALLOY_REGION_COEXIST" +_IS_ALLOY_REGION_COEXIST = False + +ALLOY_PROVIDER_NAME = None + logger = logging.getLogger(__name__) @@ -145,7 +153,12 @@ def endpoint_for(service, region=None, endpoint=None, service_endpoint_template= "regionIdentifier" : "ap-sydney-1" } - If the region still cannot be resolved, we fall back to OC1 realm + If the region still cannot be resolved, we fall back to OC1 realm. + + If alloy mode is enabled, and OCI_ALLOY_REGION_COEXIST is not set, only the alloy regions are available. If you want + to access OCI and alloy regions at the same time, please set OCI_ALLOY_REGION_COEXIST to True. Fallback to OC1 realm + is not available when OCI_ALLOY_REGION_COEXIST is not set. + """ if not (endpoint or region): raise ValueError("Must supply either a region or an endpoint.") @@ -171,6 +184,21 @@ def enable_instance_metadata_service(): _set_source_has_been_read(ExternalSources.IMDS, False) +def add_region_schema_for_alloy(region_metadata): + """ + This method is called from the alloy_config.py file to register an alloy region. + Args: + region_metadata: dict + """ + # If we are here, then alloy-config.json has already been processed by _process_region_metadata_from_alloy_config, + # since that method is called while initialization. It also processes _IS_ALLOY_REGION_COEXIST and resets region info + # and external sources accordingly, except for regions added through alloy-config.json file. Check coexists and + # reset accordingly + if not _IS_ALLOY_REGION_COEXIST: + _reset_region_info() + _add_alloy_regions(region_metadata) + + def _set_source_has_been_read(source, value=True): _has_been_read_external_sources[source] = value @@ -179,6 +207,58 @@ def _get_source_has_been_read(source): return _has_been_read_external_sources[source] +def _reset_region_info(): + logger.debug("Resetting regions information") + global REGIONS_SHORT_NAMES, REGION_REALMS, REALMS, REGIONS + REGIONS_SHORT_NAMES = {} + REGION_REALMS = {} + REALMS = {} + REGIONS = [] + + +def _add_region_information_to_override(region_metadata): + if _check_valid_schema(region_metadata): + region_metadata = {k: v.lower() for k, v in six.iteritems(region_metadata)} + REGIONS_SHORT_NAMES[region_metadata[REGION_KEY_PROPERTY_NAME]] = region_metadata[ + REGION_IDENTIFIER_PROPERTY_NAME] + REGION_REALMS[region_metadata[REGION_IDENTIFIER_PROPERTY_NAME]] = region_metadata[REALM_KEY_PROPERTY_NAME] + REALMS[region_metadata[REALM_KEY_PROPERTY_NAME]] = region_metadata[REALM_DOMAIN_COMPONENT_PROPERTY_NAME] + REGIONS.append(region_metadata[REGION_IDENTIFIER_PROPERTY_NAME]) + + +def _add_alloy_regions(alloy_regions): + logger.debug("Adding alloy regions from {}".format(alloy_regions)) + if isinstance(alloy_regions, list): + for region_metadata in alloy_regions: + _add_region_information_to_override(region_metadata) + elif isinstance(alloy_regions, dict): + _add_region_information_to_override(alloy_regions) + else: + raise TypeError("Invalid type for alloy regions. Please use a dictionary or a list of dictionaries") + + +def _process_region_metadata_from_alloy_config(alloy_regions_list): + global _IS_ALLOY_REGION_COEXIST + _IS_ALLOY_REGION_COEXIST = os.getenv(OCI_ALLOY_REGION_COEXIST_ENV_VAR_NAME) + if _IS_ALLOY_REGION_COEXIST and _IS_ALLOY_REGION_COEXIST.lower() in ["true", "1"]: + _IS_ALLOY_REGION_COEXIST = True + else: + _IS_ALLOY_REGION_COEXIST = False + + # If IS_ALLOY_REGION_COEXIST is false and alloy is true then set all sources except OCI_DEFAULT_REALM has been read, + # reset regions data structures, add alloy regions + if _IS_ALLOY_MODE and not _IS_ALLOY_REGION_COEXIST: + _reset_region_info() + for source in _has_been_read_external_sources: + _set_source_has_been_read(source) + _set_source_has_been_read(ExternalSources.SECOND_LEVEL_DOMAIN_FALLBACK, False) + _add_alloy_regions(alloy_regions_list) + + # If coexist is true and alloy is true, add alloy regions and override existing regions with alloy config + if _IS_ALLOY_MODE and _IS_ALLOY_REGION_COEXIST: + _add_alloy_regions(alloy_regions_list) + + def _check_and_add_region_metadata(region): if not _get_source_has_been_read(ExternalSources.SECOND_LEVEL_DOMAIN_FALLBACK): global second_level_domain_fallback @@ -201,7 +281,14 @@ def _check_and_add_region_metadata(region): elif second_level_domain_fallback: logger.debug("Unknown regionId '{}', default realm is defined, will fallback to '{}'".format(region, second_level_domain_fallback)) return False - logger.debug("Unknown regionId '{}', will assume it's in Realm OC1".format(region)) + elif _IS_ALLOY_MODE and not _IS_ALLOY_REGION_COEXIST: + logger.debug("You're using the {provider} Alloy configuration file, the region you're targeting is not declared" + " in this config file. Please check if this is the correct region you're targeting or contact the {provider} " + "cloud provider for help. If you want to target both OCI regions and {provider} regions, please set the " + "OCI_ALLOY_REGION_COEXIST env var to True.".format(provider=ALLOY_PROVIDER_NAME)) + + else: + logger.debug("Unknown regionId '{}', will assume it's in Realm OC1".format(region)) return False @@ -332,7 +419,7 @@ def _check_valid_schema(region_metadata): return True -def _add_region_information_to_lookup(region_metadata, region): +def _add_region_information_to_lookup(region_metadata, region=None): # Check if the region metadata has information about the requested region # Add the region information from region_metadata to the existing lookups region_metadata = {k: v.lower() for k, v in six.iteritems(region_metadata)} @@ -398,9 +485,12 @@ def _second_level_domain(region): REALMS["unknown"] = second_level_domain_fallback realm = "unknown" else: - # default realm to OC1 + # default realm to OC1 when available + if 'oc1' not in REALMS: + raise InvalidAlloyConfig("Fallback to default OCI region is blocked. This is likely happening if you are " + "trying to access an alloy region not defined in the alloy region sources, and " + "the env var OCI_ALLOY_REGION_COEXIST is not set to True.") realm = 'oc1' - return REALMS[realm] diff --git a/src/oci/resource_manager/resource_manager_client.py b/src/oci/resource_manager/resource_manager_client.py index ffda97a6c8..42ce7b6a17 100644 --- a/src/oci/resource_manager/resource_manager_client.py +++ b/src/oci/resource_manager/resource_manager_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import resource_manager_type_mapping missing = Sentinel("Missing") @@ -77,6 +79,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("resource_manager"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/resource_search/resource_search_client.py b/src/oci/resource_search/resource_search_client.py index e203581fee..59a011aade 100644 --- a/src/oci/resource_search/resource_search_client.py +++ b/src/oci/resource_search/resource_search_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import resource_search_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("resource_search"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/retry/retry.py b/src/oci/retry/retry.py index 2340bc5286..4fc7833571 100644 --- a/src/oci/retry/retry.py +++ b/src/oci/retry/retry.py @@ -329,7 +329,7 @@ def make_retrying_call(self, func_ref, *func_args, **func_kwargs): raise if log_info["logger"] and log_info["debug"]: - log_info["logger"].debug("Retry attempt: {}, Http Status Code: {}, Error Code: {}".format(attempt, status_code, error_code)) + log_info["logger"].debug("Retry attempt: {}, Http Status Code: {}, Error Code: {}, Exception: {}".format(attempt, status_code, error_code, e)) else: raise diff --git a/src/oci/rover/rover_bundle_client.py b/src/oci/rover/rover_bundle_client.py index 5acefd9dde..dd98762044 100644 --- a/src/oci/rover/rover_bundle_client.py +++ b/src/oci/rover/rover_bundle_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import rover_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("rover"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/rover/rover_cluster_client.py b/src/oci/rover/rover_cluster_client.py index 36f677a10f..20d0534b03 100644 --- a/src/oci/rover/rover_cluster_client.py +++ b/src/oci/rover/rover_cluster_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import rover_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("rover"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/rover/rover_entitlement_client.py b/src/oci/rover/rover_entitlement_client.py index 68f529a806..be2e73269b 100644 --- a/src/oci/rover/rover_entitlement_client.py +++ b/src/oci/rover/rover_entitlement_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import rover_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("rover"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/rover/rover_node_client.py b/src/oci/rover/rover_node_client.py index 0133e787b4..ed1d360f79 100644 --- a/src/oci/rover/rover_node_client.py +++ b/src/oci/rover/rover_node_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import rover_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("rover"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/rover/shape_client.py b/src/oci/rover/shape_client.py index 82ffb5b7f4..145022277d 100644 --- a/src/oci/rover/shape_client.py +++ b/src/oci/rover/shape_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import rover_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("rover"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/rover/work_requests_client.py b/src/oci/rover/work_requests_client.py index d7f91288fc..55d62e86e3 100644 --- a/src/oci/rover/work_requests_client.py +++ b/src/oci/rover/work_requests_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import rover_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("rover"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/sch/service_connector_client.py b/src/oci/sch/service_connector_client.py index 3c3b797fc5..059e13514e 100644 --- a/src/oci/sch/service_connector_client.py +++ b/src/oci/sch/service_connector_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import sch_type_mapping missing = Sentinel("Missing") @@ -76,6 +78,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("sch"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/secrets/secrets_client.py b/src/oci/secrets/secrets_client.py index f18a3eb8d4..7327c2bf62 100644 --- a/src/oci/secrets/secrets_client.py +++ b/src/oci/secrets/secrets_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import secrets_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("secrets"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/service_catalog/service_catalog_client.py b/src/oci/service_catalog/service_catalog_client.py index 345b278cbe..b34285c3c2 100644 --- a/src/oci/service_catalog/service_catalog_client.py +++ b/src/oci/service_catalog/service_catalog_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import service_catalog_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("service_catalog"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/service_manager_proxy/service_manager_proxy_client.py b/src/oci/service_manager_proxy/service_manager_proxy_client.py index 9c7d3d650a..cb2ca3d21f 100644 --- a/src/oci/service_manager_proxy/service_manager_proxy_client.py +++ b/src/oci/service_manager_proxy/service_manager_proxy_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import service_manager_proxy_type_mapping missing = Sentinel("Missing") @@ -75,6 +77,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("service_manager_proxy"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/service_mesh/service_mesh_client.py b/src/oci/service_mesh/service_mesh_client.py index 92ca7c7f20..e833790c72 100644 --- a/src/oci/service_mesh/service_mesh_client.py +++ b/src/oci/service_mesh/service_mesh_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import service_mesh_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("service_mesh"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/stack_monitoring/models/__init__.py b/src/oci/stack_monitoring/models/__init__.py index 1f9492f4bb..7b53c74981 100644 --- a/src/oci/stack_monitoring/models/__init__.py +++ b/src/oci/stack_monitoring/models/__init__.py @@ -12,8 +12,16 @@ from .associated_resources_summary import AssociatedResourcesSummary from .association_details import AssociationDetails from .association_resource_details import AssociationResourceDetails +from .auto_promote_config_details import AutoPromoteConfigDetails +from .auto_promote_config_summary import AutoPromoteConfigSummary +from .change_config_compartment_details import ChangeConfigCompartmentDetails from .change_monitored_resource_compartment_details import ChangeMonitoredResourceCompartmentDetails +from .config import Config +from .config_collection import ConfigCollection +from .config_summary import ConfigSummary from .connection_details import ConnectionDetails +from .create_auto_promote_config_details import CreateAutoPromoteConfigDetails +from .create_config_details import CreateConfigDetails from .create_discovery_job_details import CreateDiscoveryJobDetails from .create_monitored_resource_details import CreateMonitoredResourceDetails from .credential_collection import CredentialCollection @@ -47,6 +55,8 @@ from .search_monitored_resource_members_details import SearchMonitoredResourceMembersDetails from .search_monitored_resources_details import SearchMonitoredResourcesDetails from .update_and_propagate_tags_details import UpdateAndPropagateTagsDetails +from .update_auto_promote_config_details import UpdateAutoPromoteConfigDetails +from .update_config_details import UpdateConfigDetails from .update_monitored_resource_details import UpdateMonitoredResourceDetails from .work_request import WorkRequest from .work_request_error import WorkRequestError @@ -65,8 +75,16 @@ "AssociatedResourcesSummary": AssociatedResourcesSummary, "AssociationDetails": AssociationDetails, "AssociationResourceDetails": AssociationResourceDetails, + "AutoPromoteConfigDetails": AutoPromoteConfigDetails, + "AutoPromoteConfigSummary": AutoPromoteConfigSummary, + "ChangeConfigCompartmentDetails": ChangeConfigCompartmentDetails, "ChangeMonitoredResourceCompartmentDetails": ChangeMonitoredResourceCompartmentDetails, + "Config": Config, + "ConfigCollection": ConfigCollection, + "ConfigSummary": ConfigSummary, "ConnectionDetails": ConnectionDetails, + "CreateAutoPromoteConfigDetails": CreateAutoPromoteConfigDetails, + "CreateConfigDetails": CreateConfigDetails, "CreateDiscoveryJobDetails": CreateDiscoveryJobDetails, "CreateMonitoredResourceDetails": CreateMonitoredResourceDetails, "CredentialCollection": CredentialCollection, @@ -100,6 +118,8 @@ "SearchMonitoredResourceMembersDetails": SearchMonitoredResourceMembersDetails, "SearchMonitoredResourcesDetails": SearchMonitoredResourcesDetails, "UpdateAndPropagateTagsDetails": UpdateAndPropagateTagsDetails, + "UpdateAutoPromoteConfigDetails": UpdateAutoPromoteConfigDetails, + "UpdateConfigDetails": UpdateConfigDetails, "UpdateMonitoredResourceDetails": UpdateMonitoredResourceDetails, "WorkRequest": WorkRequest, "WorkRequestError": WorkRequestError, diff --git a/src/oci/stack_monitoring/models/auto_promote_config_details.py b/src/oci/stack_monitoring/models/auto_promote_config_details.py new file mode 100644 index 0000000000..a7118fcd2a --- /dev/null +++ b/src/oci/stack_monitoring/models/auto_promote_config_details.py @@ -0,0 +1,194 @@ +# coding: utf-8 +# Copyright (c) 2016, 2023, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20210330 + +from .config import Config +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class AutoPromoteConfigDetails(Config): + """ + A configuration of the AUTO_PROMOTE type, consists of a resource type and a boolean value + that determines if this resource needs to be automatically promoted/discovered. + For example, when a Management Agent registration event occurs and if isEnabled is TRUE for + a HOST resource type, a HOST resource will be automatically discovered using that Management Agent. + """ + + #: A constant which can be used with the resource_type property of a AutoPromoteConfigDetails. + #: This constant has a value of "HOST" + RESOURCE_TYPE_HOST = "HOST" + + def __init__(self, **kwargs): + """ + Initializes a new AutoPromoteConfigDetails object with values from keyword arguments. The default value of the :py:attr:`~oci.stack_monitoring.models.AutoPromoteConfigDetails.config_type` attribute + of this class is ``AUTO_PROMOTE`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param id: + The value to assign to the id property of this AutoPromoteConfigDetails. + :type id: str + + :param compartment_id: + The value to assign to the compartment_id property of this AutoPromoteConfigDetails. + :type compartment_id: str + + :param display_name: + The value to assign to the display_name property of this AutoPromoteConfigDetails. + :type display_name: str + + :param time_created: + The value to assign to the time_created property of this AutoPromoteConfigDetails. + :type time_created: datetime + + :param time_updated: + The value to assign to the time_updated property of this AutoPromoteConfigDetails. + :type time_updated: datetime + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this AutoPromoteConfigDetails. + Allowed values for this property are: "CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type lifecycle_state: str + + :param config_type: + The value to assign to the config_type property of this AutoPromoteConfigDetails. + Allowed values for this property are: "AUTO_PROMOTE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type config_type: str + + :param freeform_tags: + The value to assign to the freeform_tags property of this AutoPromoteConfigDetails. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this AutoPromoteConfigDetails. + :type defined_tags: dict(str, dict(str, object)) + + :param system_tags: + The value to assign to the system_tags property of this AutoPromoteConfigDetails. + :type system_tags: dict(str, dict(str, object)) + + :param resource_type: + The value to assign to the resource_type property of this AutoPromoteConfigDetails. + Allowed values for this property are: "HOST", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type resource_type: str + + :param is_enabled: + The value to assign to the is_enabled property of this AutoPromoteConfigDetails. + :type is_enabled: bool + + """ + self.swagger_types = { + 'id': 'str', + 'compartment_id': 'str', + 'display_name': 'str', + 'time_created': 'datetime', + 'time_updated': 'datetime', + 'lifecycle_state': 'str', + 'config_type': 'str', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))', + 'system_tags': 'dict(str, dict(str, object))', + 'resource_type': 'str', + 'is_enabled': 'bool' + } + + self.attribute_map = { + 'id': 'id', + 'compartment_id': 'compartmentId', + 'display_name': 'displayName', + 'time_created': 'timeCreated', + 'time_updated': 'timeUpdated', + 'lifecycle_state': 'lifecycleState', + 'config_type': 'configType', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags', + 'system_tags': 'systemTags', + 'resource_type': 'resourceType', + 'is_enabled': 'isEnabled' + } + + self._id = None + self._compartment_id = None + self._display_name = None + self._time_created = None + self._time_updated = None + self._lifecycle_state = None + self._config_type = None + self._freeform_tags = None + self._defined_tags = None + self._system_tags = None + self._resource_type = None + self._is_enabled = None + self._config_type = 'AUTO_PROMOTE' + + @property + def resource_type(self): + """ + **[Required]** Gets the resource_type of this AutoPromoteConfigDetails. + The type of resource to configure for automatic promotion. + + Allowed values for this property are: "HOST", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The resource_type of this AutoPromoteConfigDetails. + :rtype: str + """ + return self._resource_type + + @resource_type.setter + def resource_type(self, resource_type): + """ + Sets the resource_type of this AutoPromoteConfigDetails. + The type of resource to configure for automatic promotion. + + + :param resource_type: The resource_type of this AutoPromoteConfigDetails. + :type: str + """ + allowed_values = ["HOST"] + if not value_allowed_none_or_none_sentinel(resource_type, allowed_values): + resource_type = 'UNKNOWN_ENUM_VALUE' + self._resource_type = resource_type + + @property + def is_enabled(self): + """ + **[Required]** Gets the is_enabled of this AutoPromoteConfigDetails. + True if automatic promotion is enabled, false if it is not enabled. + + + :return: The is_enabled of this AutoPromoteConfigDetails. + :rtype: bool + """ + return self._is_enabled + + @is_enabled.setter + def is_enabled(self, is_enabled): + """ + Sets the is_enabled of this AutoPromoteConfigDetails. + True if automatic promotion is enabled, false if it is not enabled. + + + :param is_enabled: The is_enabled of this AutoPromoteConfigDetails. + :type: bool + """ + self._is_enabled = is_enabled + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/stack_monitoring/models/auto_promote_config_summary.py b/src/oci/stack_monitoring/models/auto_promote_config_summary.py new file mode 100644 index 0000000000..d9b5a11ce4 --- /dev/null +++ b/src/oci/stack_monitoring/models/auto_promote_config_summary.py @@ -0,0 +1,187 @@ +# coding: utf-8 +# Copyright (c) 2016, 2023, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20210330 + +from .config_summary import ConfigSummary +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class AutoPromoteConfigSummary(ConfigSummary): + """ + Summary of an AUTO_PROMOTE config. + """ + + #: A constant which can be used with the resource_type property of a AutoPromoteConfigSummary. + #: This constant has a value of "HOST" + RESOURCE_TYPE_HOST = "HOST" + + def __init__(self, **kwargs): + """ + Initializes a new AutoPromoteConfigSummary object with values from keyword arguments. The default value of the :py:attr:`~oci.stack_monitoring.models.AutoPromoteConfigSummary.config_type` attribute + of this class is ``AUTO_PROMOTE`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param id: + The value to assign to the id property of this AutoPromoteConfigSummary. + :type id: str + + :param compartment_id: + The value to assign to the compartment_id property of this AutoPromoteConfigSummary. + :type compartment_id: str + + :param display_name: + The value to assign to the display_name property of this AutoPromoteConfigSummary. + :type display_name: str + + :param time_created: + The value to assign to the time_created property of this AutoPromoteConfigSummary. + :type time_created: datetime + + :param time_updated: + The value to assign to the time_updated property of this AutoPromoteConfigSummary. + :type time_updated: datetime + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this AutoPromoteConfigSummary. + :type lifecycle_state: str + + :param config_type: + The value to assign to the config_type property of this AutoPromoteConfigSummary. + :type config_type: str + + :param freeform_tags: + The value to assign to the freeform_tags property of this AutoPromoteConfigSummary. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this AutoPromoteConfigSummary. + :type defined_tags: dict(str, dict(str, object)) + + :param system_tags: + The value to assign to the system_tags property of this AutoPromoteConfigSummary. + :type system_tags: dict(str, dict(str, object)) + + :param resource_type: + The value to assign to the resource_type property of this AutoPromoteConfigSummary. + Allowed values for this property are: "HOST", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type resource_type: str + + :param is_enabled: + The value to assign to the is_enabled property of this AutoPromoteConfigSummary. + :type is_enabled: bool + + """ + self.swagger_types = { + 'id': 'str', + 'compartment_id': 'str', + 'display_name': 'str', + 'time_created': 'datetime', + 'time_updated': 'datetime', + 'lifecycle_state': 'str', + 'config_type': 'str', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))', + 'system_tags': 'dict(str, dict(str, object))', + 'resource_type': 'str', + 'is_enabled': 'bool' + } + + self.attribute_map = { + 'id': 'id', + 'compartment_id': 'compartmentId', + 'display_name': 'displayName', + 'time_created': 'timeCreated', + 'time_updated': 'timeUpdated', + 'lifecycle_state': 'lifecycleState', + 'config_type': 'configType', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags', + 'system_tags': 'systemTags', + 'resource_type': 'resourceType', + 'is_enabled': 'isEnabled' + } + + self._id = None + self._compartment_id = None + self._display_name = None + self._time_created = None + self._time_updated = None + self._lifecycle_state = None + self._config_type = None + self._freeform_tags = None + self._defined_tags = None + self._system_tags = None + self._resource_type = None + self._is_enabled = None + self._config_type = 'AUTO_PROMOTE' + + @property + def resource_type(self): + """ + **[Required]** Gets the resource_type of this AutoPromoteConfigSummary. + The type of resource to configure for automatic promotion. + + Allowed values for this property are: "HOST", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The resource_type of this AutoPromoteConfigSummary. + :rtype: str + """ + return self._resource_type + + @resource_type.setter + def resource_type(self, resource_type): + """ + Sets the resource_type of this AutoPromoteConfigSummary. + The type of resource to configure for automatic promotion. + + + :param resource_type: The resource_type of this AutoPromoteConfigSummary. + :type: str + """ + allowed_values = ["HOST"] + if not value_allowed_none_or_none_sentinel(resource_type, allowed_values): + resource_type = 'UNKNOWN_ENUM_VALUE' + self._resource_type = resource_type + + @property + def is_enabled(self): + """ + **[Required]** Gets the is_enabled of this AutoPromoteConfigSummary. + True if automatic promotion is enabled, false if it is not enabled. + + + :return: The is_enabled of this AutoPromoteConfigSummary. + :rtype: bool + """ + return self._is_enabled + + @is_enabled.setter + def is_enabled(self, is_enabled): + """ + Sets the is_enabled of this AutoPromoteConfigSummary. + True if automatic promotion is enabled, false if it is not enabled. + + + :param is_enabled: The is_enabled of this AutoPromoteConfigSummary. + :type: bool + """ + self._is_enabled = is_enabled + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/stack_monitoring/models/change_config_compartment_details.py b/src/oci/stack_monitoring/models/change_config_compartment_details.py new file mode 100644 index 0000000000..1dbc631ebb --- /dev/null +++ b/src/oci/stack_monitoring/models/change_config_compartment_details.py @@ -0,0 +1,78 @@ +# coding: utf-8 +# Copyright (c) 2016, 2023, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20210330 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ChangeConfigCompartmentDetails(object): + """ + Details for which compartment to move the resource to. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ChangeConfigCompartmentDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param compartment_id: + The value to assign to the compartment_id property of this ChangeConfigCompartmentDetails. + :type compartment_id: str + + """ + self.swagger_types = { + 'compartment_id': 'str' + } + + self.attribute_map = { + 'compartment_id': 'compartmentId' + } + + self._compartment_id = None + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this ChangeConfigCompartmentDetails. + The `OCID`__ of the compartment + into which the resource should be moved. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :return: The compartment_id of this ChangeConfigCompartmentDetails. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this ChangeConfigCompartmentDetails. + The `OCID`__ of the compartment + into which the resource should be moved. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :param compartment_id: The compartment_id of this ChangeConfigCompartmentDetails. + :type: str + """ + self._compartment_id = compartment_id + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/stack_monitoring/models/config.py b/src/oci/stack_monitoring/models/config.py new file mode 100644 index 0000000000..21a675672e --- /dev/null +++ b/src/oci/stack_monitoring/models/config.py @@ -0,0 +1,423 @@ +# coding: utf-8 +# Copyright (c) 2016, 2023, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20210330 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class Config(object): + """ + A configuration item that, for example defines whether resources of a specific type + should be discovered automatically. + + In this case, the 'configType' is set to 'AUTO_PROMOTE' and additional fields like + 'resourceType' and 'isEnabled' determine if such resources are to be discovered + automatically (also referred to as 'Automatic Promotion'). + """ + + #: A constant which can be used with the lifecycle_state property of a Config. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + #: A constant which can be used with the lifecycle_state property of a Config. + #: This constant has a value of "UPDATING" + LIFECYCLE_STATE_UPDATING = "UPDATING" + + #: A constant which can be used with the lifecycle_state property of a Config. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a Config. + #: This constant has a value of "DELETING" + LIFECYCLE_STATE_DELETING = "DELETING" + + #: A constant which can be used with the lifecycle_state property of a Config. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" + + #: A constant which can be used with the lifecycle_state property of a Config. + #: This constant has a value of "FAILED" + LIFECYCLE_STATE_FAILED = "FAILED" + + #: A constant which can be used with the config_type property of a Config. + #: This constant has a value of "AUTO_PROMOTE" + CONFIG_TYPE_AUTO_PROMOTE = "AUTO_PROMOTE" + + def __init__(self, **kwargs): + """ + Initializes a new Config object with values from keyword arguments. This class has the following subclasses and if you are using this class as input + to a service operations then you should favor using a subclass over the base class: + + * :class:`~oci.stack_monitoring.models.AutoPromoteConfigDetails` + + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param id: + The value to assign to the id property of this Config. + :type id: str + + :param compartment_id: + The value to assign to the compartment_id property of this Config. + :type compartment_id: str + + :param display_name: + The value to assign to the display_name property of this Config. + :type display_name: str + + :param time_created: + The value to assign to the time_created property of this Config. + :type time_created: datetime + + :param time_updated: + The value to assign to the time_updated property of this Config. + :type time_updated: datetime + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this Config. + Allowed values for this property are: "CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type lifecycle_state: str + + :param config_type: + The value to assign to the config_type property of this Config. + Allowed values for this property are: "AUTO_PROMOTE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type config_type: str + + :param freeform_tags: + The value to assign to the freeform_tags property of this Config. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this Config. + :type defined_tags: dict(str, dict(str, object)) + + :param system_tags: + The value to assign to the system_tags property of this Config. + :type system_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'id': 'str', + 'compartment_id': 'str', + 'display_name': 'str', + 'time_created': 'datetime', + 'time_updated': 'datetime', + 'lifecycle_state': 'str', + 'config_type': 'str', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))', + 'system_tags': 'dict(str, dict(str, object))' + } + + self.attribute_map = { + 'id': 'id', + 'compartment_id': 'compartmentId', + 'display_name': 'displayName', + 'time_created': 'timeCreated', + 'time_updated': 'timeUpdated', + 'lifecycle_state': 'lifecycleState', + 'config_type': 'configType', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags', + 'system_tags': 'systemTags' + } + + self._id = None + self._compartment_id = None + self._display_name = None + self._time_created = None + self._time_updated = None + self._lifecycle_state = None + self._config_type = None + self._freeform_tags = None + self._defined_tags = None + self._system_tags = None + + @staticmethod + def get_subtype(object_dictionary): + """ + Given the hash representation of a subtype of this class, + use the info in the hash to return the class of the subtype. + """ + type = object_dictionary['configType'] + + if type == 'AUTO_PROMOTE': + return 'AutoPromoteConfigDetails' + else: + return 'Config' + + @property + def id(self): + """ + **[Required]** Gets the id of this Config. + The Unique Oracle ID (OCID) that is immutable on creation. + + + :return: The id of this Config. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this Config. + The Unique Oracle ID (OCID) that is immutable on creation. + + + :param id: The id of this Config. + :type: str + """ + self._id = id + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this Config. + The OCID of the compartment containing the configuration. + + + :return: The compartment_id of this Config. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this Config. + The OCID of the compartment containing the configuration. + + + :param compartment_id: The compartment_id of this Config. + :type: str + """ + self._compartment_id = compartment_id + + @property + def display_name(self): + """ + Gets the display_name of this Config. + A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. + + + :return: The display_name of this Config. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this Config. + A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. + + + :param display_name: The display_name of this Config. + :type: str + """ + self._display_name = display_name + + @property + def time_created(self): + """ + Gets the time_created of this Config. + The time the configuration was created. An RFC3339 formatted datetime string. + + + :return: The time_created of this Config. + :rtype: datetime + """ + return self._time_created + + @time_created.setter + def time_created(self, time_created): + """ + Sets the time_created of this Config. + The time the configuration was created. An RFC3339 formatted datetime string. + + + :param time_created: The time_created of this Config. + :type: datetime + """ + self._time_created = time_created + + @property + def time_updated(self): + """ + Gets the time_updated of this Config. + The time the Config was updated. + + + :return: The time_updated of this Config. + :rtype: datetime + """ + return self._time_updated + + @time_updated.setter + def time_updated(self, time_updated): + """ + Sets the time_updated of this Config. + The time the Config was updated. + + + :param time_updated: The time_updated of this Config. + :type: datetime + """ + self._time_updated = time_updated + + @property + def lifecycle_state(self): + """ + **[Required]** Gets the lifecycle_state of this Config. + The current state of the configuration. + + Allowed values for this property are: "CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The lifecycle_state of this Config. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this Config. + The current state of the configuration. + + + :param lifecycle_state: The lifecycle_state of this Config. + :type: str + """ + allowed_values = ["CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED"] + if not value_allowed_none_or_none_sentinel(lifecycle_state, allowed_values): + lifecycle_state = 'UNKNOWN_ENUM_VALUE' + self._lifecycle_state = lifecycle_state + + @property + def config_type(self): + """ + **[Required]** Gets the config_type of this Config. + The type of configuration. + + Allowed values for this property are: "AUTO_PROMOTE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The config_type of this Config. + :rtype: str + """ + return self._config_type + + @config_type.setter + def config_type(self, config_type): + """ + Sets the config_type of this Config. + The type of configuration. + + + :param config_type: The config_type of this Config. + :type: str + """ + allowed_values = ["AUTO_PROMOTE"] + if not value_allowed_none_or_none_sentinel(config_type, allowed_values): + config_type = 'UNKNOWN_ENUM_VALUE' + self._config_type = config_type + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this Config. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :return: The freeform_tags of this Config. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this Config. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :param freeform_tags: The freeform_tags of this Config. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this Config. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this Config. + :rtype: dict(str, dict(str, object)) + """ + return self._defined_tags + + @defined_tags.setter + def defined_tags(self, defined_tags): + """ + Sets the defined_tags of this Config. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this Config. + :type: dict(str, dict(str, object)) + """ + self._defined_tags = defined_tags + + @property + def system_tags(self): + """ + Gets the system_tags of this Config. + Usage of system tag keys. These predefined keys are scoped to namespaces. + Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}` + + + :return: The system_tags of this Config. + :rtype: dict(str, dict(str, object)) + """ + return self._system_tags + + @system_tags.setter + def system_tags(self, system_tags): + """ + Sets the system_tags of this Config. + Usage of system tag keys. These predefined keys are scoped to namespaces. + Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}` + + + :param system_tags: The system_tags of this Config. + :type: dict(str, dict(str, object)) + """ + self._system_tags = system_tags + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/stack_monitoring/models/config_collection.py b/src/oci/stack_monitoring/models/config_collection.py new file mode 100644 index 0000000000..39cefa8749 --- /dev/null +++ b/src/oci/stack_monitoring/models/config_collection.py @@ -0,0 +1,72 @@ +# coding: utf-8 +# Copyright (c) 2016, 2023, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20210330 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ConfigCollection(object): + """ + Contains a list of configurations. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ConfigCollection object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param items: + The value to assign to the items property of this ConfigCollection. + :type items: list[oci.stack_monitoring.models.ConfigSummary] + + """ + self.swagger_types = { + 'items': 'list[ConfigSummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this ConfigCollection. + List of configurations. + + + :return: The items of this ConfigCollection. + :rtype: list[oci.stack_monitoring.models.ConfigSummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this ConfigCollection. + List of configurations. + + + :param items: The items of this ConfigCollection. + :type: list[oci.stack_monitoring.models.ConfigSummary] + """ + self._items = items + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/stack_monitoring/models/config_summary.py b/src/oci/stack_monitoring/models/config_summary.py new file mode 100644 index 0000000000..5ed88847e4 --- /dev/null +++ b/src/oci/stack_monitoring/models/config_summary.py @@ -0,0 +1,374 @@ +# coding: utf-8 +# Copyright (c) 2016, 2023, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20210330 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ConfigSummary(object): + """ + Summary of the configuration. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ConfigSummary object with values from keyword arguments. This class has the following subclasses and if you are using this class as input + to a service operations then you should favor using a subclass over the base class: + + * :class:`~oci.stack_monitoring.models.AutoPromoteConfigSummary` + + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param id: + The value to assign to the id property of this ConfigSummary. + :type id: str + + :param compartment_id: + The value to assign to the compartment_id property of this ConfigSummary. + :type compartment_id: str + + :param display_name: + The value to assign to the display_name property of this ConfigSummary. + :type display_name: str + + :param time_created: + The value to assign to the time_created property of this ConfigSummary. + :type time_created: datetime + + :param time_updated: + The value to assign to the time_updated property of this ConfigSummary. + :type time_updated: datetime + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this ConfigSummary. + :type lifecycle_state: str + + :param config_type: + The value to assign to the config_type property of this ConfigSummary. + :type config_type: str + + :param freeform_tags: + The value to assign to the freeform_tags property of this ConfigSummary. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this ConfigSummary. + :type defined_tags: dict(str, dict(str, object)) + + :param system_tags: + The value to assign to the system_tags property of this ConfigSummary. + :type system_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'id': 'str', + 'compartment_id': 'str', + 'display_name': 'str', + 'time_created': 'datetime', + 'time_updated': 'datetime', + 'lifecycle_state': 'str', + 'config_type': 'str', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))', + 'system_tags': 'dict(str, dict(str, object))' + } + + self.attribute_map = { + 'id': 'id', + 'compartment_id': 'compartmentId', + 'display_name': 'displayName', + 'time_created': 'timeCreated', + 'time_updated': 'timeUpdated', + 'lifecycle_state': 'lifecycleState', + 'config_type': 'configType', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags', + 'system_tags': 'systemTags' + } + + self._id = None + self._compartment_id = None + self._display_name = None + self._time_created = None + self._time_updated = None + self._lifecycle_state = None + self._config_type = None + self._freeform_tags = None + self._defined_tags = None + self._system_tags = None + + @staticmethod + def get_subtype(object_dictionary): + """ + Given the hash representation of a subtype of this class, + use the info in the hash to return the class of the subtype. + """ + type = object_dictionary['configType'] + + if type == 'AUTO_PROMOTE': + return 'AutoPromoteConfigSummary' + else: + return 'ConfigSummary' + + @property + def id(self): + """ + **[Required]** Gets the id of this ConfigSummary. + Unique identifier that is immutable on creation. + + + :return: The id of this ConfigSummary. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this ConfigSummary. + Unique identifier that is immutable on creation. + + + :param id: The id of this ConfigSummary. + :type: str + """ + self._id = id + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this ConfigSummary. + Compartment Identifier. + + + :return: The compartment_id of this ConfigSummary. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this ConfigSummary. + Compartment Identifier. + + + :param compartment_id: The compartment_id of this ConfigSummary. + :type: str + """ + self._compartment_id = compartment_id + + @property + def display_name(self): + """ + Gets the display_name of this ConfigSummary. + Config Identifier, can be renamed. + + + :return: The display_name of this ConfigSummary. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this ConfigSummary. + Config Identifier, can be renamed. + + + :param display_name: The display_name of this ConfigSummary. + :type: str + """ + self._display_name = display_name + + @property + def time_created(self): + """ + Gets the time_created of this ConfigSummary. + The time the the configuration was created. An RFC3339 formatted datetime string. + + + :return: The time_created of this ConfigSummary. + :rtype: datetime + """ + return self._time_created + + @time_created.setter + def time_created(self, time_created): + """ + Sets the time_created of this ConfigSummary. + The time the the configuration was created. An RFC3339 formatted datetime string. + + + :param time_created: The time_created of this ConfigSummary. + :type: datetime + """ + self._time_created = time_created + + @property + def time_updated(self): + """ + Gets the time_updated of this ConfigSummary. + The time the configuration was updated. + + + :return: The time_updated of this ConfigSummary. + :rtype: datetime + """ + return self._time_updated + + @time_updated.setter + def time_updated(self, time_updated): + """ + Sets the time_updated of this ConfigSummary. + The time the configuration was updated. + + + :param time_updated: The time_updated of this ConfigSummary. + :type: datetime + """ + self._time_updated = time_updated + + @property + def lifecycle_state(self): + """ + **[Required]** Gets the lifecycle_state of this ConfigSummary. + The current state of the configuration. + + + :return: The lifecycle_state of this ConfigSummary. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this ConfigSummary. + The current state of the configuration. + + + :param lifecycle_state: The lifecycle_state of this ConfigSummary. + :type: str + """ + self._lifecycle_state = lifecycle_state + + @property + def config_type(self): + """ + **[Required]** Gets the config_type of this ConfigSummary. + The type of configuration. + + + :return: The config_type of this ConfigSummary. + :rtype: str + """ + return self._config_type + + @config_type.setter + def config_type(self, config_type): + """ + Sets the config_type of this ConfigSummary. + The type of configuration. + + + :param config_type: The config_type of this ConfigSummary. + :type: str + """ + self._config_type = config_type + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this ConfigSummary. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :return: The freeform_tags of this ConfigSummary. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this ConfigSummary. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :param freeform_tags: The freeform_tags of this ConfigSummary. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this ConfigSummary. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this ConfigSummary. + :rtype: dict(str, dict(str, object)) + """ + return self._defined_tags + + @defined_tags.setter + def defined_tags(self, defined_tags): + """ + Sets the defined_tags of this ConfigSummary. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this ConfigSummary. + :type: dict(str, dict(str, object)) + """ + self._defined_tags = defined_tags + + @property + def system_tags(self): + """ + Gets the system_tags of this ConfigSummary. + Usage of system tag keys. These predefined keys are scoped to namespaces. + Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}` + + + :return: The system_tags of this ConfigSummary. + :rtype: dict(str, dict(str, object)) + """ + return self._system_tags + + @system_tags.setter + def system_tags(self, system_tags): + """ + Sets the system_tags of this ConfigSummary. + Usage of system tag keys. These predefined keys are scoped to namespaces. + Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}` + + + :param system_tags: The system_tags of this ConfigSummary. + :type: dict(str, dict(str, object)) + """ + self._system_tags = system_tags + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/stack_monitoring/models/create_auto_promote_config_details.py b/src/oci/stack_monitoring/models/create_auto_promote_config_details.py new file mode 100644 index 0000000000..414b82027e --- /dev/null +++ b/src/oci/stack_monitoring/models/create_auto_promote_config_details.py @@ -0,0 +1,153 @@ +# coding: utf-8 +# Copyright (c) 2016, 2023, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20210330 + +from .create_config_details import CreateConfigDetails +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class CreateAutoPromoteConfigDetails(CreateConfigDetails): + """ + The details of an AUTO_PROMOTE configuration. + """ + + #: A constant which can be used with the resource_type property of a CreateAutoPromoteConfigDetails. + #: This constant has a value of "HOST" + RESOURCE_TYPE_HOST = "HOST" + + def __init__(self, **kwargs): + """ + Initializes a new CreateAutoPromoteConfigDetails object with values from keyword arguments. The default value of the :py:attr:`~oci.stack_monitoring.models.CreateAutoPromoteConfigDetails.config_type` attribute + of this class is ``AUTO_PROMOTE`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param display_name: + The value to assign to the display_name property of this CreateAutoPromoteConfigDetails. + :type display_name: str + + :param compartment_id: + The value to assign to the compartment_id property of this CreateAutoPromoteConfigDetails. + :type compartment_id: str + + :param config_type: + The value to assign to the config_type property of this CreateAutoPromoteConfigDetails. + :type config_type: str + + :param freeform_tags: + The value to assign to the freeform_tags property of this CreateAutoPromoteConfigDetails. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this CreateAutoPromoteConfigDetails. + :type defined_tags: dict(str, dict(str, object)) + + :param resource_type: + The value to assign to the resource_type property of this CreateAutoPromoteConfigDetails. + Allowed values for this property are: "HOST" + :type resource_type: str + + :param is_enabled: + The value to assign to the is_enabled property of this CreateAutoPromoteConfigDetails. + :type is_enabled: bool + + """ + self.swagger_types = { + 'display_name': 'str', + 'compartment_id': 'str', + 'config_type': 'str', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))', + 'resource_type': 'str', + 'is_enabled': 'bool' + } + + self.attribute_map = { + 'display_name': 'displayName', + 'compartment_id': 'compartmentId', + 'config_type': 'configType', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags', + 'resource_type': 'resourceType', + 'is_enabled': 'isEnabled' + } + + self._display_name = None + self._compartment_id = None + self._config_type = None + self._freeform_tags = None + self._defined_tags = None + self._resource_type = None + self._is_enabled = None + self._config_type = 'AUTO_PROMOTE' + + @property + def resource_type(self): + """ + **[Required]** Gets the resource_type of this CreateAutoPromoteConfigDetails. + The type of resource to configure for automatic promotion. + + Allowed values for this property are: "HOST" + + + :return: The resource_type of this CreateAutoPromoteConfigDetails. + :rtype: str + """ + return self._resource_type + + @resource_type.setter + def resource_type(self, resource_type): + """ + Sets the resource_type of this CreateAutoPromoteConfigDetails. + The type of resource to configure for automatic promotion. + + + :param resource_type: The resource_type of this CreateAutoPromoteConfigDetails. + :type: str + """ + allowed_values = ["HOST"] + if not value_allowed_none_or_none_sentinel(resource_type, allowed_values): + raise ValueError( + "Invalid value for `resource_type`, must be None or one of {0}" + .format(allowed_values) + ) + self._resource_type = resource_type + + @property + def is_enabled(self): + """ + **[Required]** Gets the is_enabled of this CreateAutoPromoteConfigDetails. + True if automatic promotion is enabled, false if it is not enabled. + + + :return: The is_enabled of this CreateAutoPromoteConfigDetails. + :rtype: bool + """ + return self._is_enabled + + @is_enabled.setter + def is_enabled(self, is_enabled): + """ + Sets the is_enabled of this CreateAutoPromoteConfigDetails. + True if automatic promotion is enabled, false if it is not enabled. + + + :param is_enabled: The is_enabled of this CreateAutoPromoteConfigDetails. + :type: bool + """ + self._is_enabled = is_enabled + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/stack_monitoring/models/create_config_details.py b/src/oci/stack_monitoring/models/create_config_details.py new file mode 100644 index 0000000000..5f25c0927d --- /dev/null +++ b/src/oci/stack_monitoring/models/create_config_details.py @@ -0,0 +1,217 @@ +# coding: utf-8 +# Copyright (c) 2016, 2023, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20210330 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class CreateConfigDetails(object): + """ + Create a configuration. + """ + + def __init__(self, **kwargs): + """ + Initializes a new CreateConfigDetails object with values from keyword arguments. This class has the following subclasses and if you are using this class as input + to a service operations then you should favor using a subclass over the base class: + + * :class:`~oci.stack_monitoring.models.CreateAutoPromoteConfigDetails` + + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param display_name: + The value to assign to the display_name property of this CreateConfigDetails. + :type display_name: str + + :param compartment_id: + The value to assign to the compartment_id property of this CreateConfigDetails. + :type compartment_id: str + + :param config_type: + The value to assign to the config_type property of this CreateConfigDetails. + :type config_type: str + + :param freeform_tags: + The value to assign to the freeform_tags property of this CreateConfigDetails. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this CreateConfigDetails. + :type defined_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'display_name': 'str', + 'compartment_id': 'str', + 'config_type': 'str', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))' + } + + self.attribute_map = { + 'display_name': 'displayName', + 'compartment_id': 'compartmentId', + 'config_type': 'configType', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags' + } + + self._display_name = None + self._compartment_id = None + self._config_type = None + self._freeform_tags = None + self._defined_tags = None + + @staticmethod + def get_subtype(object_dictionary): + """ + Given the hash representation of a subtype of this class, + use the info in the hash to return the class of the subtype. + """ + type = object_dictionary['configType'] + + if type == 'AUTO_PROMOTE': + return 'CreateAutoPromoteConfigDetails' + else: + return 'CreateConfigDetails' + + @property + def display_name(self): + """ + Gets the display_name of this CreateConfigDetails. + The display name of the configuration. + + + :return: The display_name of this CreateConfigDetails. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this CreateConfigDetails. + The display name of the configuration. + + + :param display_name: The display_name of this CreateConfigDetails. + :type: str + """ + self._display_name = display_name + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this CreateConfigDetails. + Compartment in which the configuration is created. + + + :return: The compartment_id of this CreateConfigDetails. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this CreateConfigDetails. + Compartment in which the configuration is created. + + + :param compartment_id: The compartment_id of this CreateConfigDetails. + :type: str + """ + self._compartment_id = compartment_id + + @property + def config_type(self): + """ + **[Required]** Gets the config_type of this CreateConfigDetails. + The type of configuration. + + + :return: The config_type of this CreateConfigDetails. + :rtype: str + """ + return self._config_type + + @config_type.setter + def config_type(self, config_type): + """ + Sets the config_type of this CreateConfigDetails. + The type of configuration. + + + :param config_type: The config_type of this CreateConfigDetails. + :type: str + """ + self._config_type = config_type + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this CreateConfigDetails. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :return: The freeform_tags of this CreateConfigDetails. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this CreateConfigDetails. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :param freeform_tags: The freeform_tags of this CreateConfigDetails. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this CreateConfigDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this CreateConfigDetails. + :rtype: dict(str, dict(str, object)) + """ + return self._defined_tags + + @defined_tags.setter + def defined_tags(self, defined_tags): + """ + Sets the defined_tags of this CreateConfigDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this CreateConfigDetails. + :type: dict(str, dict(str, object)) + """ + self._defined_tags = defined_tags + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/stack_monitoring/models/update_auto_promote_config_details.py b/src/oci/stack_monitoring/models/update_auto_promote_config_details.py new file mode 100644 index 0000000000..27757b8cd9 --- /dev/null +++ b/src/oci/stack_monitoring/models/update_auto_promote_config_details.py @@ -0,0 +1,102 @@ +# coding: utf-8 +# Copyright (c) 2016, 2023, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20210330 + +from .update_config_details import UpdateConfigDetails +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class UpdateAutoPromoteConfigDetails(UpdateConfigDetails): + """ + Change the details of an AUTO_PROMOTE config + """ + + def __init__(self, **kwargs): + """ + Initializes a new UpdateAutoPromoteConfigDetails object with values from keyword arguments. The default value of the :py:attr:`~oci.stack_monitoring.models.UpdateAutoPromoteConfigDetails.config_type` attribute + of this class is ``AUTO_PROMOTE`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param display_name: + The value to assign to the display_name property of this UpdateAutoPromoteConfigDetails. + :type display_name: str + + :param config_type: + The value to assign to the config_type property of this UpdateAutoPromoteConfigDetails. + :type config_type: str + + :param freeform_tags: + The value to assign to the freeform_tags property of this UpdateAutoPromoteConfigDetails. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this UpdateAutoPromoteConfigDetails. + :type defined_tags: dict(str, dict(str, object)) + + :param is_enabled: + The value to assign to the is_enabled property of this UpdateAutoPromoteConfigDetails. + :type is_enabled: bool + + """ + self.swagger_types = { + 'display_name': 'str', + 'config_type': 'str', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))', + 'is_enabled': 'bool' + } + + self.attribute_map = { + 'display_name': 'displayName', + 'config_type': 'configType', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags', + 'is_enabled': 'isEnabled' + } + + self._display_name = None + self._config_type = None + self._freeform_tags = None + self._defined_tags = None + self._is_enabled = None + self._config_type = 'AUTO_PROMOTE' + + @property + def is_enabled(self): + """ + Gets the is_enabled of this UpdateAutoPromoteConfigDetails. + True if automatic promotion is enabled, false if it is not enabled. + + + :return: The is_enabled of this UpdateAutoPromoteConfigDetails. + :rtype: bool + """ + return self._is_enabled + + @is_enabled.setter + def is_enabled(self, is_enabled): + """ + Sets the is_enabled of this UpdateAutoPromoteConfigDetails. + True if automatic promotion is enabled, false if it is not enabled. + + + :param is_enabled: The is_enabled of this UpdateAutoPromoteConfigDetails. + :type: bool + """ + self._is_enabled = is_enabled + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/stack_monitoring/models/update_config_details.py b/src/oci/stack_monitoring/models/update_config_details.py new file mode 100644 index 0000000000..5f50a43c4a --- /dev/null +++ b/src/oci/stack_monitoring/models/update_config_details.py @@ -0,0 +1,186 @@ +# coding: utf-8 +# Copyright (c) 2016, 2023, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20210330 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class UpdateConfigDetails(object): + """ + Change the configuration. + """ + + def __init__(self, **kwargs): + """ + Initializes a new UpdateConfigDetails object with values from keyword arguments. This class has the following subclasses and if you are using this class as input + to a service operations then you should favor using a subclass over the base class: + + * :class:`~oci.stack_monitoring.models.UpdateAutoPromoteConfigDetails` + + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param display_name: + The value to assign to the display_name property of this UpdateConfigDetails. + :type display_name: str + + :param config_type: + The value to assign to the config_type property of this UpdateConfigDetails. + :type config_type: str + + :param freeform_tags: + The value to assign to the freeform_tags property of this UpdateConfigDetails. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this UpdateConfigDetails. + :type defined_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'display_name': 'str', + 'config_type': 'str', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))' + } + + self.attribute_map = { + 'display_name': 'displayName', + 'config_type': 'configType', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags' + } + + self._display_name = None + self._config_type = None + self._freeform_tags = None + self._defined_tags = None + + @staticmethod + def get_subtype(object_dictionary): + """ + Given the hash representation of a subtype of this class, + use the info in the hash to return the class of the subtype. + """ + type = object_dictionary['configType'] + + if type == 'AUTO_PROMOTE': + return 'UpdateAutoPromoteConfigDetails' + else: + return 'UpdateConfigDetails' + + @property + def display_name(self): + """ + Gets the display_name of this UpdateConfigDetails. + The display name of the configuration. + + + :return: The display_name of this UpdateConfigDetails. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this UpdateConfigDetails. + The display name of the configuration. + + + :param display_name: The display_name of this UpdateConfigDetails. + :type: str + """ + self._display_name = display_name + + @property + def config_type(self): + """ + Gets the config_type of this UpdateConfigDetails. + The type of configuration. + + + :return: The config_type of this UpdateConfigDetails. + :rtype: str + """ + return self._config_type + + @config_type.setter + def config_type(self, config_type): + """ + Sets the config_type of this UpdateConfigDetails. + The type of configuration. + + + :param config_type: The config_type of this UpdateConfigDetails. + :type: str + """ + self._config_type = config_type + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this UpdateConfigDetails. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :return: The freeform_tags of this UpdateConfigDetails. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this UpdateConfigDetails. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :param freeform_tags: The freeform_tags of this UpdateConfigDetails. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this UpdateConfigDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this UpdateConfigDetails. + :rtype: dict(str, dict(str, object)) + """ + return self._defined_tags + + @defined_tags.setter + def defined_tags(self, defined_tags): + """ + Sets the defined_tags of this UpdateConfigDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this UpdateConfigDetails. + :type: dict(str, dict(str, object)) + """ + self._defined_tags = defined_tags + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/stack_monitoring/stack_monitoring_client.py b/src/oci/stack_monitoring/stack_monitoring_client.py index 30e557a789..33680d9d2f 100644 --- a/src/oci/stack_monitoring/stack_monitoring_client.py +++ b/src/oci/stack_monitoring/stack_monitoring_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import stack_monitoring_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("stack_monitoring"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] @@ -219,6 +224,137 @@ def associate_monitored_resources(self, associate_monitored_resources_details, * api_reference_link=api_reference_link, required_arguments=required_arguments) + def change_config_compartment(self, config_id, change_config_compartment_details, **kwargs): + """ + Moves the configuration item to another compartment. + Basically, this will disable any configuration for this configuration type in thie compartment, + and will enable it in the new one. + + For example, if for a HOST resource type, the configuration with AUTO_PROMOTE in the configuration type + and TRUE as value is moved, automatic discovery will not take place in this compartment any more, but in the new one. + + So this operation will have the same effect as deleting the configuration item in the old compartment and + recreating it in another compartment. + + When provided, If-Match is checked against ETag values of the resource. + + + :param str config_id: (required) + Unique Config identifier. + + :param oci.stack_monitoring.models.ChangeConfigCompartmentDetails change_config_compartment_details: (required) + Details for the compartment move. + + :param str if_match: (optional) + For optimistic concurrency control. In the PUT or DELETE call + for a resource, set the `if-match` parameter to the value of the + etag from a previous GET or POST response for that resource. + The resource will be updated or deleted only if the etag you + provide matches the resource's current etag value. + + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a + particular request, please provide the request ID. + + :param str opc_retry_token: (optional) + A token that uniquely identifies a request so it can be retried in case of a timeout or + server error without risk of executing that same action again. Retry tokens expire after 24 + hours, but can be invalidated before then due to conflicting operations. For example, if a resource + has been deleted and purged from the system, then a retry of the original creation request + might be rejected. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use change_config_compartment API. + """ + # Required path and query arguments. These are in camelCase to replace values in service endpoints. + required_arguments = ['configId'] + resource_path = "/configs/{configId}/actions/changeCompartment" + method = "POST" + operation_name = "change_config_compartment" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/stack-monitoring/20210330/Config/ChangeConfigCompartment" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "if_match", + "opc_request_id", + "opc_retry_token" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "change_config_compartment got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "configId": config_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "if-match": kwargs.get("if_match", missing), + "opc-request-id": kwargs.get("opc_request_id", missing), + "opc-retry-token": kwargs.get("opc_retry_token", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_retry_token_if_needed(header_params) + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=change_config_compartment_details, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=change_config_compartment_details, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + def change_monitored_resource_compartment(self, monitored_resource_id, change_monitored_resource_compartment_details, **kwargs): """ Moves a monitored resource from one compartment to another. @@ -341,6 +477,111 @@ def change_monitored_resource_compartment(self, monitored_resource_id, change_mo api_reference_link=api_reference_link, required_arguments=required_arguments) + def create_config(self, create_config_details, **kwargs): + """ + Creates a configuration item, for example to define + whether resources of a specific type should be discovered automatically. + + For example, when a new Management Agent gets registered in a certain compartment, + this Management Agent can potentially get promoted to a HOST resource. + The configuration item will determine if HOST resources in the selected compartment will be + discovered automatically. + + + :param oci.stack_monitoring.models.CreateConfigDetails create_config_details: (required) + Details for the new configuration. + + :param str opc_retry_token: (optional) + A token that uniquely identifies a request so it can be retried in case of a timeout or + server error without risk of executing that same action again. Retry tokens expire after 24 + hours, but can be invalidated before then due to conflicting operations. For example, if a resource + has been deleted and purged from the system, then a retry of the original creation request + might be rejected. + + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a + particular request, please provide the request ID. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.stack_monitoring.models.Config` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use create_config API. + """ + # Required path and query arguments. These are in camelCase to replace values in service endpoints. + required_arguments = [] + resource_path = "/configs" + method = "POST" + operation_name = "create_config" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/stack-monitoring/20210330/Config/CreateConfig" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_retry_token", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "create_config got unknown kwargs: {!r}".format(extra_kwargs)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-retry-token": kwargs.get("opc_retry_token", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_retry_token_if_needed(header_params) + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + header_params=header_params, + body=create_config_details, + response_type="Config", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + header_params=header_params, + body=create_config_details, + response_type="Config", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + def create_discovery_job(self, create_discovery_job_details, **kwargs): """ API to create discovery Job and submit discovery Details to agent. @@ -545,6 +786,112 @@ def create_monitored_resource(self, create_monitored_resource_details, **kwargs) api_reference_link=api_reference_link, required_arguments=required_arguments) + def delete_config(self, config_id, **kwargs): + """ + Deletes a configuration identified by the id. + + + :param str config_id: (required) + Unique Config identifier. + + :param str if_match: (optional) + For optimistic concurrency control. In the PUT or DELETE call + for a resource, set the `if-match` parameter to the value of the + etag from a previous GET or POST response for that resource. + The resource will be updated or deleted only if the etag you + provide matches the resource's current etag value. + + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a + particular request, please provide the request ID. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use delete_config API. + """ + # Required path and query arguments. These are in camelCase to replace values in service endpoints. + required_arguments = ['configId'] + resource_path = "/configs/{configId}" + method = "DELETE" + operation_name = "delete_config" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/stack-monitoring/20210330/Config/DeleteConfig" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "if_match", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "delete_config got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "configId": config_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "if-match": kwargs.get("if_match", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + def delete_discovery_job(self, discovery_job_id, **kwargs): """ Deletes a DiscoveryJob by identifier @@ -953,14 +1300,110 @@ def disassociate_monitored_resources(self, disassociate_monitored_resources_deta extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - "disassociate_monitored_resources got unknown kwargs: {!r}".format(extra_kwargs)) + "disassociate_monitored_resources got unknown kwargs: {!r}".format(extra_kwargs)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing), + "opc-retry-token": kwargs.get("opc_retry_token", missing), + "if-match": kwargs.get("if_match", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_retry_token_if_needed(header_params) + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + header_params=header_params, + body=disassociate_monitored_resources_details, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + header_params=header_params, + body=disassociate_monitored_resources_details, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + + def get_config(self, config_id, **kwargs): + """ + Gets the details of a configuration. + + + :param str config_id: (required) + Unique Config identifier. + + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a + particular request, please provide the request ID. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.stack_monitoring.models.Config` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_config API. + """ + # Required path and query arguments. These are in camelCase to replace values in service endpoints. + required_arguments = ['configId'] + resource_path = "/configs/{configId}" + method = "GET" + operation_name = "get_config" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/stack-monitoring/20210330/Config/GetConfig" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "get_config got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "configId": config_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) header_params = { "accept": "application/json", "content-type": "application/json", - "opc-request-id": kwargs.get("opc_request_id", missing), - "opc-retry-token": kwargs.get("opc_retry_token", missing), - "if-match": kwargs.get("if_match", missing) + "opc-request-id": kwargs.get("opc_request_id", missing) } header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} @@ -968,18 +1411,20 @@ def disassociate_monitored_resources(self, disassociate_monitored_resources_deta operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): - self.base_client.add_opc_retry_token_if_needed(header_params) self.base_client.add_opc_client_retries_header(header_params) retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) return retry_strategy.make_retrying_call( self.base_client.call_api, resource_path=resource_path, method=method, + path_params=path_params, header_params=header_params, - body=disassociate_monitored_resources_details, + response_type="Config", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -988,8 +1433,9 @@ def disassociate_monitored_resources(self, disassociate_monitored_resources_deta return self.base_client.call_api( resource_path=resource_path, method=method, + path_params=path_params, header_params=header_params, - body=disassociate_monitored_resources_details, + response_type="Config", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -1298,6 +1744,181 @@ def get_work_request(self, work_request_id, **kwargs): api_reference_link=api_reference_link, required_arguments=required_arguments) + def list_configs(self, compartment_id, **kwargs): + """ + Get a list of configurations in a compartment. + + + :param str compartment_id: (required) + The ID of the compartment in which data is listed. + + :param str display_name: (optional) + A filter to return only resources that match the entire display name given. + + :param str type: (optional) + A filter to return only configuration items for a given config type. + + Allowed values are: "AUTO_PROMOTE" + + :param int limit: (optional) + For list pagination. The maximum number of results per page, or items to return in a + paginated \"List\" call. For important details about how pagination works, see + `List Pagination`__. + + __ https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine + + :param str page: (optional) + For list pagination. The value of the `opc-next-page` response header from the + previous \"List\" call. For important details about how pagination works, see + `List Pagination`__. + + __ https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine + + :param str lifecycle_state: (optional) + The current state of the Config. + + Allowed values are: "CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED" + + :param str sort_order: (optional) + The sort order to use, either ascending (`ASC`) or descending (`DESC`). + + Allowed values are: "ASC", "DESC" + + :param str sort_by: (optional) + The field to sort by. Only one sort order may be provided. + Default order for 'timeCreated' is descending. + Default order for 'displayName' and 'configType' is ascending. + + Allowed values are: "timeCreated", "configType", "displayName" + + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a + particular request, please provide the request ID. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.stack_monitoring.models.ConfigCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_configs API. + """ + # Required path and query arguments. These are in camelCase to replace values in service endpoints. + required_arguments = ['compartmentId'] + resource_path = "/configs" + method = "GET" + operation_name = "list_configs" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/stack-monitoring/20210330/ConfigCollection/ListConfigs" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "display_name", + "type", + "limit", + "page", + "lifecycle_state", + "sort_order", + "sort_by", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_configs got unknown kwargs: {!r}".format(extra_kwargs)) + + if 'type' in kwargs: + type_allowed_values = ["AUTO_PROMOTE"] + if kwargs['type'] not in type_allowed_values: + raise ValueError( + "Invalid value for `type`, must be one of {0}".format(type_allowed_values) + ) + + if 'lifecycle_state' in kwargs: + lifecycle_state_allowed_values = ["CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED"] + if kwargs['lifecycle_state'] not in lifecycle_state_allowed_values: + raise ValueError( + "Invalid value for `lifecycle_state`, must be one of {0}".format(lifecycle_state_allowed_values) + ) + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + "Invalid value for `sort_order`, must be one of {0}".format(sort_order_allowed_values) + ) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["timeCreated", "configType", "displayName"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) + ) + + query_params = { + "compartmentId": compartment_id, + "displayName": kwargs.get("display_name", missing), + "type": kwargs.get("type", missing), + "limit": kwargs.get("limit", missing), + "page": kwargs.get("page", missing), + "lifecycleState": kwargs.get("lifecycle_state", missing), + "sortOrder": kwargs.get("sort_order", missing), + "sortBy": kwargs.get("sort_by", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + query_params=query_params, + header_params=header_params, + response_type="ConfigCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + query_params=query_params, + header_params=header_params, + response_type="ConfigCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + def list_discovery_job_logs(self, discovery_job_id, **kwargs): """ API to get all the logs of a Discovery Job. @@ -2838,6 +3459,119 @@ def update_and_propagate_tags(self, monitored_resource_id, update_and_propagate_ api_reference_link=api_reference_link, required_arguments=required_arguments) + def update_config(self, config_id, update_config_details, **kwargs): + """ + Updates the configuration identified by the id given. + + + :param str config_id: (required) + Unique Config identifier. + + :param oci.stack_monitoring.models.UpdateConfigDetails update_config_details: (required) + The details of the configuration to be updated. + + :param str if_match: (optional) + For optimistic concurrency control. In the PUT or DELETE call + for a resource, set the `if-match` parameter to the value of the + etag from a previous GET or POST response for that resource. + The resource will be updated or deleted only if the etag you + provide matches the resource's current etag value. + + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a + particular request, please provide the request ID. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.stack_monitoring.models.Config` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use update_config API. + """ + # Required path and query arguments. These are in camelCase to replace values in service endpoints. + required_arguments = ['configId'] + resource_path = "/configs/{configId}" + method = "PUT" + operation_name = "update_config" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/stack-monitoring/20210330/Config/UpdateConfig" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "if_match", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "update_config got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "configId": config_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "if-match": kwargs.get("if_match", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=update_config_details, + response_type="Config", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=update_config_details, + response_type="Config", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + def update_monitored_resource(self, monitored_resource_id, update_monitored_resource_details, **kwargs): """ Update monitored resource by the given identifier `OCID`__. diff --git a/src/oci/stack_monitoring/stack_monitoring_client_composite_operations.py b/src/oci/stack_monitoring/stack_monitoring_client_composite_operations.py index 7397e59cab..480ad7efb7 100644 --- a/src/oci/stack_monitoring/stack_monitoring_client_composite_operations.py +++ b/src/oci/stack_monitoring/stack_monitoring_client_composite_operations.py @@ -68,6 +68,49 @@ def change_monitored_resource_compartment_and_wait_for_state(self, monitored_res except Exception as e: raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def create_config_and_wait_for_state(self, create_config_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.stack_monitoring.StackMonitoringClient.create_config` and waits for the :py:class:`~oci.stack_monitoring.models.Config` acted upon + to enter the given state(s). + + :param oci.stack_monitoring.models.CreateConfigDetails create_config_details: (required) + Details for the new configuration. + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.stack_monitoring.models.Config.lifecycle_state` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.stack_monitoring.StackMonitoringClient.create_config` + + :param dict waiter_kwargs: + A dictionary of keyword arguments to pass to the :py:func:`oci.wait_until` function. For example, you could pass ``max_interval_seconds`` or ``max_interval_seconds`` + as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait + """ + operation_result = self.client.create_config(create_config_details, **operation_kwargs) + if not wait_for_states: + return operation_result + + lowered_wait_for_states = [w.lower() for w in wait_for_states] + config_id = operation_result.data.id + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_config(config_id), # noqa: F821 + evaluate_response=lambda r: getattr(r.data, 'lifecycle_state') and getattr(r.data, 'lifecycle_state').lower() in lowered_wait_for_states, + **waiter_kwargs + ) + result_to_return = waiter_result + + return result_to_return + except (NameError, TypeError) as e: + if not e.args: + e.args = ('',) + e.args = e.args + ('This composite operation is currently not supported in the SDK. Please use the operation from the service client and use waiters as an alternative. For more information on waiters, visit: "https://docs.oracle.com/en-us/iaas/tools/python/latest/api/waiters.html"', ) + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + except Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def create_discovery_job_and_wait_for_state(self, create_discovery_job_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): """ Calls :py:func:`~oci.stack_monitoring.StackMonitoringClient.create_discovery_job` and waits for the :py:class:`~oci.stack_monitoring.models.DiscoveryJob` acted upon @@ -149,6 +192,66 @@ def create_monitored_resource_and_wait_for_state(self, create_monitored_resource except Exception as e: raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def delete_config_and_wait_for_state(self, config_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.stack_monitoring.StackMonitoringClient.delete_config` and waits for the :py:class:`~oci.stack_monitoring.models.Config` acted upon + to enter the given state(s). + + :param str config_id: (required) + Unique Config identifier. + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.stack_monitoring.models.Config.lifecycle_state` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.stack_monitoring.StackMonitoringClient.delete_config` + + :param dict waiter_kwargs: + A dictionary of keyword arguments to pass to the :py:func:`oci.wait_until` function. For example, you could pass ``max_interval_seconds`` or ``max_interval_seconds`` + as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait + """ + initial_get_result = self.client.get_config(config_id) + operation_result = None + try: + operation_result = self.client.delete_config(config_id, **operation_kwargs) + except oci.exceptions.ServiceError as e: + if e.status == 404: + return WAIT_RESOURCE_NOT_FOUND + else: + raise e + + if not wait_for_states: + return operation_result + + lowered_wait_for_states = [w.lower() for w in wait_for_states] + + try: + if ("succeed_on_not_found" in waiter_kwargs) and (waiter_kwargs["succeed_on_not_found"] is False): + self.client.base_client.logger.warning("The waiter kwarg succeed_on_not_found was passed as False for the delete composite operation delete_config, this would result in the operation to fail if the resource is not found! Please, do not pass this kwarg if this was not intended") + else: + """ + If the user does not send in this value, we set it to True by default. + We are doing this because during a delete resource scenario and waiting on its state, the service can + return a 404 NOT FOUND exception as the resource was deleted and a get on its state would fail + """ + waiter_kwargs["succeed_on_not_found"] = True + waiter_result = oci.wait_until( + self.client, + initial_get_result, # noqa: F821 + evaluate_response=lambda r: getattr(r.data, 'lifecycle_state') and getattr(r.data, 'lifecycle_state').lower() in lowered_wait_for_states, + **waiter_kwargs + ) + result_to_return = waiter_result + + return result_to_return + except (NameError, TypeError) as e: + if not e.args: + e.args = ('',) + e.args = e.args + ('This composite operation is currently not supported in the SDK. Please use the operation from the service client and use waiters as an alternative. For more information on waiters, visit: "https://docs.oracle.com/en-us/iaas/tools/python/latest/api/waiters.html"', ) + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + except Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def delete_discovery_job_and_wait_for_state(self, discovery_job_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): """ Calls :py:func:`~oci.stack_monitoring.StackMonitoringClient.delete_discovery_job` and waits for the :py:class:`~oci.stack_monitoring.models.DiscoveryJob` acted upon @@ -340,6 +443,52 @@ def update_and_propagate_tags_and_wait_for_state(self, monitored_resource_id, up except Exception as e: raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def update_config_and_wait_for_state(self, config_id, update_config_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.stack_monitoring.StackMonitoringClient.update_config` and waits for the :py:class:`~oci.stack_monitoring.models.Config` acted upon + to enter the given state(s). + + :param str config_id: (required) + Unique Config identifier. + + :param oci.stack_monitoring.models.UpdateConfigDetails update_config_details: (required) + The details of the configuration to be updated. + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.stack_monitoring.models.Config.lifecycle_state` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.stack_monitoring.StackMonitoringClient.update_config` + + :param dict waiter_kwargs: + A dictionary of keyword arguments to pass to the :py:func:`oci.wait_until` function. For example, you could pass ``max_interval_seconds`` or ``max_interval_seconds`` + as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait + """ + operation_result = self.client.update_config(config_id, update_config_details, **operation_kwargs) + if not wait_for_states: + return operation_result + + lowered_wait_for_states = [w.lower() for w in wait_for_states] + config_id = operation_result.data.id + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_config(config_id), # noqa: F821 + evaluate_response=lambda r: getattr(r.data, 'lifecycle_state') and getattr(r.data, 'lifecycle_state').lower() in lowered_wait_for_states, + **waiter_kwargs + ) + result_to_return = waiter_result + + return result_to_return + except (NameError, TypeError) as e: + if not e.args: + e.args = ('',) + e.args = e.args + ('This composite operation is currently not supported in the SDK. Please use the operation from the service client and use waiters as an alternative. For more information on waiters, visit: "https://docs.oracle.com/en-us/iaas/tools/python/latest/api/waiters.html"', ) + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + except Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def update_monitored_resource_and_wait_for_state(self, monitored_resource_id, update_monitored_resource_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): """ Calls :py:func:`~oci.stack_monitoring.StackMonitoringClient.update_monitored_resource` and waits for the :py:class:`~oci.stack_monitoring.models.WorkRequest` diff --git a/src/oci/streaming/stream_admin_client.py b/src/oci/streaming/stream_admin_client.py index c756d330a8..a4e2d7714b 100644 --- a/src/oci/streaming/stream_admin_client.py +++ b/src/oci/streaming/stream_admin_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import streaming_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("streaming"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/streaming/stream_client.py b/src/oci/streaming/stream_client.py index 44ae7a953c..b4113447bd 100644 --- a/src/oci/streaming/stream_client.py +++ b/src/oci/streaming/stream_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import streaming_type_mapping missing = Sentinel("Missing") @@ -72,6 +74,9 @@ def __init__(self, config, service_endpoint, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("streaming"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/tenant_manager_control_plane/domain_client.py b/src/oci/tenant_manager_control_plane/domain_client.py index ea288da832..8da8b4ae82 100644 --- a/src/oci/tenant_manager_control_plane/domain_client.py +++ b/src/oci/tenant_manager_control_plane/domain_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import tenant_manager_control_plane_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("tenant_manager_control_plane"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/tenant_manager_control_plane/domain_governance_client.py b/src/oci/tenant_manager_control_plane/domain_governance_client.py index aedab73f34..8f28dbfa5c 100644 --- a/src/oci/tenant_manager_control_plane/domain_governance_client.py +++ b/src/oci/tenant_manager_control_plane/domain_governance_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import tenant_manager_control_plane_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("tenant_manager_control_plane"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/tenant_manager_control_plane/governance_client.py b/src/oci/tenant_manager_control_plane/governance_client.py index 06e1858446..01c91265d3 100644 --- a/src/oci/tenant_manager_control_plane/governance_client.py +++ b/src/oci/tenant_manager_control_plane/governance_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import tenant_manager_control_plane_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("tenant_manager_control_plane"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/tenant_manager_control_plane/link_client.py b/src/oci/tenant_manager_control_plane/link_client.py index 7fbaac32d0..d9f952038a 100644 --- a/src/oci/tenant_manager_control_plane/link_client.py +++ b/src/oci/tenant_manager_control_plane/link_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import tenant_manager_control_plane_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("tenant_manager_control_plane"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/tenant_manager_control_plane/orders_client.py b/src/oci/tenant_manager_control_plane/orders_client.py index 0724f1580f..71960ea58f 100644 --- a/src/oci/tenant_manager_control_plane/orders_client.py +++ b/src/oci/tenant_manager_control_plane/orders_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import tenant_manager_control_plane_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("tenant_manager_control_plane"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/tenant_manager_control_plane/organization_client.py b/src/oci/tenant_manager_control_plane/organization_client.py index 9b4ca411d4..088785720b 100644 --- a/src/oci/tenant_manager_control_plane/organization_client.py +++ b/src/oci/tenant_manager_control_plane/organization_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import tenant_manager_control_plane_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("tenant_manager_control_plane"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/tenant_manager_control_plane/recipient_invitation_client.py b/src/oci/tenant_manager_control_plane/recipient_invitation_client.py index 32d8bab3e8..c12556ac63 100644 --- a/src/oci/tenant_manager_control_plane/recipient_invitation_client.py +++ b/src/oci/tenant_manager_control_plane/recipient_invitation_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import tenant_manager_control_plane_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("tenant_manager_control_plane"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/tenant_manager_control_plane/sender_invitation_client.py b/src/oci/tenant_manager_control_plane/sender_invitation_client.py index 6b9971ed73..4ae3aaeb96 100644 --- a/src/oci/tenant_manager_control_plane/sender_invitation_client.py +++ b/src/oci/tenant_manager_control_plane/sender_invitation_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import tenant_manager_control_plane_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("tenant_manager_control_plane"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/tenant_manager_control_plane/subscription_client.py b/src/oci/tenant_manager_control_plane/subscription_client.py index 420f441f2e..fcf9591f7b 100644 --- a/src/oci/tenant_manager_control_plane/subscription_client.py +++ b/src/oci/tenant_manager_control_plane/subscription_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import tenant_manager_control_plane_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("tenant_manager_control_plane"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/tenant_manager_control_plane/work_request_client.py b/src/oci/tenant_manager_control_plane/work_request_client.py index 1260479cda..488f69a6c7 100644 --- a/src/oci/tenant_manager_control_plane/work_request_client.py +++ b/src/oci/tenant_manager_control_plane/work_request_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import tenant_manager_control_plane_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("tenant_manager_control_plane"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/threat_intelligence/threatintel_client.py b/src/oci/threat_intelligence/threatintel_client.py index bc546ad764..18746f6765 100644 --- a/src/oci/threat_intelligence/threatintel_client.py +++ b/src/oci/threat_intelligence/threatintel_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import threat_intelligence_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("threat_intelligence"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/usage/resources_client.py b/src/oci/usage/resources_client.py index 458f83131c..de7b7affc6 100644 --- a/src/oci/usage/resources_client.py +++ b/src/oci/usage/resources_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import usage_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("usage"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/usage/rewards_client.py b/src/oci/usage/rewards_client.py index f29e15d1b9..1e4b6859ac 100644 --- a/src/oci/usage/rewards_client.py +++ b/src/oci/usage/rewards_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import usage_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("usage"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/usage/usagelimits_client.py b/src/oci/usage/usagelimits_client.py index 5b0c3dbf78..93abbd9044 100644 --- a/src/oci/usage/usagelimits_client.py +++ b/src/oci/usage/usagelimits_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import usage_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("usage"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/usage_api/usageapi_client.py b/src/oci/usage_api/usageapi_client.py index ae91857304..b31566174c 100644 --- a/src/oci/usage_api/usageapi_client.py +++ b/src/oci/usage_api/usageapi_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import usage_api_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("usage_api"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/vault/vaults_client.py b/src/oci/vault/vaults_client.py index bf4c13ea90..85c49a5c87 100644 --- a/src/oci/vault/vaults_client.py +++ b/src/oci/vault/vaults_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import vault_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("vault"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/vbs_inst/vbs_instance_client.py b/src/oci/vbs_inst/vbs_instance_client.py index 6568754dad..e69911ade8 100644 --- a/src/oci/vbs_inst/vbs_instance_client.py +++ b/src/oci/vbs_inst/vbs_instance_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import vbs_inst_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("vbs_inst"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/version.py b/src/oci/version.py index 162d608856..47517d9194 100644 --- a/src/oci/version.py +++ b/src/oci/version.py @@ -2,4 +2,4 @@ # Copyright (c) 2016, 2023, Oracle and/or its affiliates. All rights reserved. # This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. -__version__ = "2.112.0" +__version__ = "2.112.1" diff --git a/src/oci/visual_builder/vb_instance_client.py b/src/oci/visual_builder/vb_instance_client.py index eec6ff7e2e..0f449f5305 100644 --- a/src/oci/visual_builder/vb_instance_client.py +++ b/src/oci/visual_builder/vb_instance_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import visual_builder_type_mapping missing = Sentinel("Missing") @@ -75,6 +77,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("visual_builder"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/vn_monitoring/vn_monitoring_client.py b/src/oci/vn_monitoring/vn_monitoring_client.py index 8330bfbf69..1c97a368f1 100644 --- a/src/oci/vn_monitoring/vn_monitoring_client.py +++ b/src/oci/vn_monitoring/vn_monitoring_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import vn_monitoring_type_mapping missing = Sentinel("Missing") @@ -75,6 +77,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("vn_monitoring"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/vulnerability_scanning/vulnerability_scanning_client.py b/src/oci/vulnerability_scanning/vulnerability_scanning_client.py index 8d590d9a9c..dc43b1238b 100644 --- a/src/oci/vulnerability_scanning/vulnerability_scanning_client.py +++ b/src/oci/vulnerability_scanning/vulnerability_scanning_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import vulnerability_scanning_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("vulnerability_scanning"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/waa/waa_client.py b/src/oci/waa/waa_client.py index 9c2f459e4f..9a438c363b 100644 --- a/src/oci/waa/waa_client.py +++ b/src/oci/waa/waa_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import waa_type_mapping missing = Sentinel("Missing") @@ -76,6 +78,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("waa"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/waa/work_request_client.py b/src/oci/waa/work_request_client.py index fb186d6979..ed44d58c06 100644 --- a/src/oci/waa/work_request_client.py +++ b/src/oci/waa/work_request_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import waa_type_mapping missing = Sentinel("Missing") @@ -76,6 +78,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("waa"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/waas/redirect_client.py b/src/oci/waas/redirect_client.py index 8e186e3500..4bcfc5c990 100644 --- a/src/oci/waas/redirect_client.py +++ b/src/oci/waas/redirect_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import waas_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("waas"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/waas/waas_client.py b/src/oci/waas/waas_client.py index f5856f15ef..892a487412 100644 --- a/src/oci/waas/waas_client.py +++ b/src/oci/waas/waas_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import waas_type_mapping missing = Sentinel("Missing") @@ -74,6 +76,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("waas"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/waf/waf_client.py b/src/oci/waf/waf_client.py index b3bf5a5678..3c8e5c1a54 100644 --- a/src/oci/waf/waf_client.py +++ b/src/oci/waf/waf_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import waf_type_mapping missing = Sentinel("Missing") @@ -75,6 +77,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("waf"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer'] diff --git a/src/oci/work_requests/work_request_client.py b/src/oci/work_requests/work_request_client.py index d510a74bdc..9268f6e418 100644 --- a/src/oci/work_requests/work_request_client.py +++ b/src/oci/work_requests/work_request_client.py @@ -14,6 +14,8 @@ from oci.config import get_config_value_or_default, validate_config from oci.signer import Signer from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from oci.exceptions import InvalidAlloyConfig +from oci.alloy import OCI_SDK_ENABLED_SERVICES_SET from .models import work_requests_type_mapping missing = Sentinel("Missing") @@ -79,6 +81,9 @@ def __init__(self, config, **kwargs): allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. """ + if not OCI_SDK_ENABLED_SERVICES_SET.is_service_enabled("work_requests"): + raise InvalidAlloyConfig("The Alloy configuration has disabled this service, this behavior is controlled by OCI_SDK_ENABLED_SERVICES_SET variable. Please check if your local alloy-config file configured the service you're targeting or contact the cloud provider on the availability of this service") + validate_config(config, signer=kwargs.get('signer')) if 'signer' in kwargs: signer = kwargs['signer']