diff --git a/CHANGELOG.rst b/CHANGELOG.rst index c3240083c9..5da91798be 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -4,6 +4,28 @@ All notable changes to this project will be documented in this file. The format is based on `Keep a Changelog `_. +==================== +2.144.0 - 2025-02-04 +==================== + +Added +----- +* Support for Cohere Embed v3 in the Generative AI Inference service +* Support for Llama 3.2 tools in the Generative AI Inference service +* Support for nginx discovery and monitoring in the Stack Monitoring service +* Support for Oracle JVM runtime discovery and monitoring in the Stack Monitoring service +* Support for JBoss discovery and monitoring in the Stack Monitoring service +* Support for Service Managed Container(SMC) endpoints on list service operation in the Data Science service +* Support for schedulers in the Data Science service +* Support for DB system database and access modes in the HeatWave service +* Support for DB system read endpoints in the HeatWave service +* Support for sensitive types for data discovery in the Data Safe service +* Support for referential relation APIs in the Data Safe service + +Breaking +-------- +* The models `CreateAuditPolicyDetails` and `CreateAuditProfileDetails` were removed in the Data Safe service + ==================== 2.143.1 - 2025-01-28 ==================== diff --git a/docs/api/data_safe.rst b/docs/api/data_safe.rst index 523b416d3a..bf3d25dbfc 100644 --- a/docs/api/data_safe.rst +++ b/docs/api/data_safe.rst @@ -90,6 +90,7 @@ Data Safe oci.data_safe.models.ChangeSecurityPolicyDeploymentCompartmentDetails oci.data_safe.models.ChangeSensitiveDataModelCompartmentDetails oci.data_safe.models.ChangeSensitiveTypeCompartmentDetails + oci.data_safe.models.ChangeSensitiveTypesExportCompartmentDetails oci.data_safe.models.ChangeSqlCollectionCompartmentDetails oci.data_safe.models.ChangeSqlFirewallPolicyCompartmentDetails oci.data_safe.models.ChangeTargetAlertPolicyAssociationCompartmentDetails @@ -104,6 +105,7 @@ Data Safe oci.data_safe.models.ColumnSourceFromSdmDetails oci.data_safe.models.ColumnSourceFromTargetDetails oci.data_safe.models.ColumnSummary + oci.data_safe.models.ColumnsInfo oci.data_safe.models.CompareSecurityAssessmentDetails oci.data_safe.models.CompareUserAssessmentDetails oci.data_safe.models.CompatibleFormatsForDataTypes @@ -112,8 +114,6 @@ Data Safe oci.data_safe.models.CreateAlertPolicyDetails oci.data_safe.models.CreateAlertPolicyRuleDetails oci.data_safe.models.CreateAuditArchiveRetrievalDetails - oci.data_safe.models.CreateAuditPolicyDetails - oci.data_safe.models.CreateAuditProfileDetails oci.data_safe.models.CreateColumnSourceDetails oci.data_safe.models.CreateColumnSourceFromSdmDetails oci.data_safe.models.CreateColumnSourceFromTargetDetails @@ -124,6 +124,7 @@ Data Safe oci.data_safe.models.CreateMaskingPolicyDetails oci.data_safe.models.CreateOnPremConnectorDetails oci.data_safe.models.CreatePeerTargetDatabaseDetails + oci.data_safe.models.CreateReferentialRelationDetails oci.data_safe.models.CreateReportDefinitionDetails oci.data_safe.models.CreateSdmMaskingPolicyDifferenceDetails oci.data_safe.models.CreateSecurityAssessmentDetails @@ -132,6 +133,7 @@ Data Safe oci.data_safe.models.CreateSensitiveDataModelDetails oci.data_safe.models.CreateSensitiveTypeDetails oci.data_safe.models.CreateSensitiveTypePatternDetails + oci.data_safe.models.CreateSensitiveTypesExportDetails oci.data_safe.models.CreateSqlCollectionDetails oci.data_safe.models.CreateTargetAlertPolicyAssociationDetails oci.data_safe.models.CreateTargetDatabaseDetails @@ -173,6 +175,7 @@ Data Safe oci.data_safe.models.DownloadMaskingReportDetails oci.data_safe.models.DownloadSecurityAssessmentReportDetails oci.data_safe.models.DownloadSensitiveDataModelDetails + oci.data_safe.models.DownloadSensitiveTypesExportDetails oci.data_safe.models.DownloadUserAssessmentReportDetails oci.data_safe.models.EnableConditions oci.data_safe.models.EnableDataSafeConfigurationDetails @@ -223,11 +226,14 @@ Data Safe oci.data_safe.models.MaskingObjectSummary oci.data_safe.models.MaskingPolicy oci.data_safe.models.MaskingPolicyCollection + oci.data_safe.models.MaskingPolicyColumnsInfo oci.data_safe.models.MaskingPolicyHealthReport oci.data_safe.models.MaskingPolicyHealthReportCollection oci.data_safe.models.MaskingPolicyHealthReportLogCollection oci.data_safe.models.MaskingPolicyHealthReportLogSummary oci.data_safe.models.MaskingPolicyHealthReportSummary + oci.data_safe.models.MaskingPolicyReferentialRelationCollection + oci.data_safe.models.MaskingPolicyReferentialRelationSummary oci.data_safe.models.MaskingPolicySummary oci.data_safe.models.MaskingReport oci.data_safe.models.MaskingReportCollection @@ -273,6 +279,9 @@ Data Safe oci.data_safe.models.RandomStringFormatEntry oci.data_safe.models.RandomSubstitutionFormatEntry oci.data_safe.models.References + oci.data_safe.models.ReferentialRelation + oci.data_safe.models.ReferentialRelationCollection + oci.data_safe.models.ReferentialRelationSummary oci.data_safe.models.RegularExpressionFormatEntry oci.data_safe.models.Report oci.data_safe.models.ReportCollection @@ -337,6 +346,9 @@ Data Safe oci.data_safe.models.SensitiveTypeCollection oci.data_safe.models.SensitiveTypePattern oci.data_safe.models.SensitiveTypeSummary + oci.data_safe.models.SensitiveTypesExport + oci.data_safe.models.SensitiveTypesExportCollection + oci.data_safe.models.SensitiveTypesExportSummary oci.data_safe.models.ShuffleFormatEntry oci.data_safe.models.SqlCollection oci.data_safe.models.SqlCollectionAggregation @@ -410,6 +422,7 @@ Data Safe oci.data_safe.models.UpdateSensitiveDataModelDetails oci.data_safe.models.UpdateSensitiveTypeDetails oci.data_safe.models.UpdateSensitiveTypePatternDetails + oci.data_safe.models.UpdateSensitiveTypesExportDetails oci.data_safe.models.UpdateSqlCollectionDetails oci.data_safe.models.UpdateSqlFirewallConfigDetails oci.data_safe.models.UpdateSqlFirewallPolicyDetails diff --git a/docs/api/data_safe/models/oci.data_safe.models.ChangeSensitiveTypesExportCompartmentDetails.rst b/docs/api/data_safe/models/oci.data_safe.models.ChangeSensitiveTypesExportCompartmentDetails.rst new file mode 100644 index 0000000000..0d9e4acca5 --- /dev/null +++ b/docs/api/data_safe/models/oci.data_safe.models.ChangeSensitiveTypesExportCompartmentDetails.rst @@ -0,0 +1,11 @@ +ChangeSensitiveTypesExportCompartmentDetails +============================================ + +.. currentmodule:: oci.data_safe.models + +.. autoclass:: ChangeSensitiveTypesExportCompartmentDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_safe/models/oci.data_safe.models.CreateAuditProfileDetails.rst b/docs/api/data_safe/models/oci.data_safe.models.ColumnsInfo.rst similarity index 62% rename from docs/api/data_safe/models/oci.data_safe.models.CreateAuditProfileDetails.rst rename to docs/api/data_safe/models/oci.data_safe.models.ColumnsInfo.rst index b8f6e70f60..cede2a306d 100644 --- a/docs/api/data_safe/models/oci.data_safe.models.CreateAuditProfileDetails.rst +++ b/docs/api/data_safe/models/oci.data_safe.models.ColumnsInfo.rst @@ -1,9 +1,9 @@ -CreateAuditProfileDetails -========================= +ColumnsInfo +=========== .. currentmodule:: oci.data_safe.models -.. autoclass:: CreateAuditProfileDetails +.. autoclass:: ColumnsInfo :show-inheritance: :special-members: __init__ :members: diff --git a/docs/api/data_safe/models/oci.data_safe.models.CreateReferentialRelationDetails.rst b/docs/api/data_safe/models/oci.data_safe.models.CreateReferentialRelationDetails.rst new file mode 100644 index 0000000000..763522888e --- /dev/null +++ b/docs/api/data_safe/models/oci.data_safe.models.CreateReferentialRelationDetails.rst @@ -0,0 +1,11 @@ +CreateReferentialRelationDetails +================================ + +.. currentmodule:: oci.data_safe.models + +.. autoclass:: CreateReferentialRelationDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_safe/models/oci.data_safe.models.CreateSensitiveTypesExportDetails.rst b/docs/api/data_safe/models/oci.data_safe.models.CreateSensitiveTypesExportDetails.rst new file mode 100644 index 0000000000..24327b3341 --- /dev/null +++ b/docs/api/data_safe/models/oci.data_safe.models.CreateSensitiveTypesExportDetails.rst @@ -0,0 +1,11 @@ +CreateSensitiveTypesExportDetails +================================= + +.. currentmodule:: oci.data_safe.models + +.. autoclass:: CreateSensitiveTypesExportDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_safe/models/oci.data_safe.models.DownloadSensitiveTypesExportDetails.rst b/docs/api/data_safe/models/oci.data_safe.models.DownloadSensitiveTypesExportDetails.rst new file mode 100644 index 0000000000..fbfd50d1eb --- /dev/null +++ b/docs/api/data_safe/models/oci.data_safe.models.DownloadSensitiveTypesExportDetails.rst @@ -0,0 +1,11 @@ +DownloadSensitiveTypesExportDetails +=================================== + +.. currentmodule:: oci.data_safe.models + +.. autoclass:: DownloadSensitiveTypesExportDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_safe/models/oci.data_safe.models.CreateAuditPolicyDetails.rst b/docs/api/data_safe/models/oci.data_safe.models.MaskingPolicyColumnsInfo.rst similarity index 73% rename from docs/api/data_safe/models/oci.data_safe.models.CreateAuditPolicyDetails.rst rename to docs/api/data_safe/models/oci.data_safe.models.MaskingPolicyColumnsInfo.rst index 31f3106f8f..a9acc8b874 100644 --- a/docs/api/data_safe/models/oci.data_safe.models.CreateAuditPolicyDetails.rst +++ b/docs/api/data_safe/models/oci.data_safe.models.MaskingPolicyColumnsInfo.rst @@ -1,9 +1,9 @@ -CreateAuditPolicyDetails +MaskingPolicyColumnsInfo ======================== .. currentmodule:: oci.data_safe.models -.. autoclass:: CreateAuditPolicyDetails +.. autoclass:: MaskingPolicyColumnsInfo :show-inheritance: :special-members: __init__ :members: diff --git a/docs/api/data_safe/models/oci.data_safe.models.MaskingPolicyReferentialRelationCollection.rst b/docs/api/data_safe/models/oci.data_safe.models.MaskingPolicyReferentialRelationCollection.rst new file mode 100644 index 0000000000..8d5c3ca132 --- /dev/null +++ b/docs/api/data_safe/models/oci.data_safe.models.MaskingPolicyReferentialRelationCollection.rst @@ -0,0 +1,11 @@ +MaskingPolicyReferentialRelationCollection +========================================== + +.. currentmodule:: oci.data_safe.models + +.. autoclass:: MaskingPolicyReferentialRelationCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_safe/models/oci.data_safe.models.MaskingPolicyReferentialRelationSummary.rst b/docs/api/data_safe/models/oci.data_safe.models.MaskingPolicyReferentialRelationSummary.rst new file mode 100644 index 0000000000..4d3eed18a0 --- /dev/null +++ b/docs/api/data_safe/models/oci.data_safe.models.MaskingPolicyReferentialRelationSummary.rst @@ -0,0 +1,11 @@ +MaskingPolicyReferentialRelationSummary +======================================= + +.. currentmodule:: oci.data_safe.models + +.. autoclass:: MaskingPolicyReferentialRelationSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_safe/models/oci.data_safe.models.ReferentialRelation.rst b/docs/api/data_safe/models/oci.data_safe.models.ReferentialRelation.rst new file mode 100644 index 0000000000..6a3e355cbd --- /dev/null +++ b/docs/api/data_safe/models/oci.data_safe.models.ReferentialRelation.rst @@ -0,0 +1,11 @@ +ReferentialRelation +=================== + +.. currentmodule:: oci.data_safe.models + +.. autoclass:: ReferentialRelation + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_safe/models/oci.data_safe.models.ReferentialRelationCollection.rst b/docs/api/data_safe/models/oci.data_safe.models.ReferentialRelationCollection.rst new file mode 100644 index 0000000000..d8b4be7371 --- /dev/null +++ b/docs/api/data_safe/models/oci.data_safe.models.ReferentialRelationCollection.rst @@ -0,0 +1,11 @@ +ReferentialRelationCollection +============================= + +.. currentmodule:: oci.data_safe.models + +.. autoclass:: ReferentialRelationCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_safe/models/oci.data_safe.models.ReferentialRelationSummary.rst b/docs/api/data_safe/models/oci.data_safe.models.ReferentialRelationSummary.rst new file mode 100644 index 0000000000..0a2ce531cb --- /dev/null +++ b/docs/api/data_safe/models/oci.data_safe.models.ReferentialRelationSummary.rst @@ -0,0 +1,11 @@ +ReferentialRelationSummary +========================== + +.. currentmodule:: oci.data_safe.models + +.. autoclass:: ReferentialRelationSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_safe/models/oci.data_safe.models.SensitiveTypesExport.rst b/docs/api/data_safe/models/oci.data_safe.models.SensitiveTypesExport.rst new file mode 100644 index 0000000000..55d2e62561 --- /dev/null +++ b/docs/api/data_safe/models/oci.data_safe.models.SensitiveTypesExport.rst @@ -0,0 +1,11 @@ +SensitiveTypesExport +==================== + +.. currentmodule:: oci.data_safe.models + +.. autoclass:: SensitiveTypesExport + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_safe/models/oci.data_safe.models.SensitiveTypesExportCollection.rst b/docs/api/data_safe/models/oci.data_safe.models.SensitiveTypesExportCollection.rst new file mode 100644 index 0000000000..53d89e8eed --- /dev/null +++ b/docs/api/data_safe/models/oci.data_safe.models.SensitiveTypesExportCollection.rst @@ -0,0 +1,11 @@ +SensitiveTypesExportCollection +============================== + +.. currentmodule:: oci.data_safe.models + +.. autoclass:: SensitiveTypesExportCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_safe/models/oci.data_safe.models.SensitiveTypesExportSummary.rst b/docs/api/data_safe/models/oci.data_safe.models.SensitiveTypesExportSummary.rst new file mode 100644 index 0000000000..4677733281 --- /dev/null +++ b/docs/api/data_safe/models/oci.data_safe.models.SensitiveTypesExportSummary.rst @@ -0,0 +1,11 @@ +SensitiveTypesExportSummary +=========================== + +.. currentmodule:: oci.data_safe.models + +.. autoclass:: SensitiveTypesExportSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_safe/models/oci.data_safe.models.UpdateSensitiveTypesExportDetails.rst b/docs/api/data_safe/models/oci.data_safe.models.UpdateSensitiveTypesExportDetails.rst new file mode 100644 index 0000000000..97d37c109e --- /dev/null +++ b/docs/api/data_safe/models/oci.data_safe.models.UpdateSensitiveTypesExportDetails.rst @@ -0,0 +1,11 @@ +UpdateSensitiveTypesExportDetails +================================= + +.. currentmodule:: oci.data_safe.models + +.. autoclass:: UpdateSensitiveTypesExportDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_science.rst b/docs/api/data_science.rst index dab5106f05..f31cc6b97f 100644 --- a/docs/api/data_science.rst +++ b/docs/api/data_science.rst @@ -37,9 +37,12 @@ Data Science oci.data_science.models.ChangePipelineCompartmentDetails oci.data_science.models.ChangePipelineRunCompartmentDetails oci.data_science.models.ChangeProjectCompartmentDetails + oci.data_science.models.ChangeScheduleCompartmentDetails + oci.data_science.models.ContainerSummary oci.data_science.models.CreateDataSciencePrivateEndpointDetails oci.data_science.models.CreateJobDetails oci.data_science.models.CreateJobRunDetails + oci.data_science.models.CreateJobRunScheduleActionDetails oci.data_science.models.CreateModelDeploymentDetails oci.data_science.models.CreateModelDetails oci.data_science.models.CreateModelProvenanceDetails @@ -47,7 +50,9 @@ Data Science oci.data_science.models.CreateNotebookSessionDetails oci.data_science.models.CreatePipelineDetails oci.data_science.models.CreatePipelineRunDetails + oci.data_science.models.CreatePipelineRunScheduleActionDetails oci.data_science.models.CreateProjectDetails + oci.data_science.models.CreateScheduleDetails oci.data_science.models.CustomExpressionQueryScalingConfiguration oci.data_science.models.CustomMetricExpressionRule oci.data_science.models.DataSciencePrivateEndpoint @@ -58,9 +63,11 @@ Data Science oci.data_science.models.FastLaunchJobConfigSummary oci.data_science.models.FileStorageMountConfigurationDetails oci.data_science.models.FixedSizeScalingPolicy + oci.data_science.models.GenericJobRunUseCaseConfigurationDetails oci.data_science.models.ImportModelArtifactDetails oci.data_science.models.InstanceConfiguration oci.data_science.models.InstancePoolModelDeploymentSystemData + oci.data_science.models.InvokeMlApplicationProviderTriggerScheduleActionDetails oci.data_science.models.Job oci.data_science.models.JobConfigurationDetails oci.data_science.models.JobEnvironmentConfigurationDetails @@ -69,6 +76,8 @@ Data Science oci.data_science.models.JobRun oci.data_science.models.JobRunLogDetails oci.data_science.models.JobRunSummary + oci.data_science.models.JobRunUseCaseConfigurationDetails + oci.data_science.models.JobRunWorkloadConfigurationDetails oci.data_science.models.JobShapeConfigDetails oci.data_science.models.JobShapeSummary oci.data_science.models.JobSummary @@ -78,6 +87,7 @@ Data Science oci.data_science.models.MetricExpressionRule oci.data_science.models.Model oci.data_science.models.ModelConfigurationDetails + oci.data_science.models.ModelDeployWorkloadConfigurationDetails oci.data_science.models.ModelDeployment oci.data_science.models.ModelDeploymentConfigurationDetails oci.data_science.models.ModelDeploymentEnvironmentConfigurationDetails @@ -135,10 +145,23 @@ Data Science oci.data_science.models.RetentionSetting oci.data_science.models.ScalingConfiguration oci.data_science.models.ScalingPolicy + oci.data_science.models.Schedule + oci.data_science.models.ScheduleAction + oci.data_science.models.ScheduleCronTrigger + oci.data_science.models.ScheduleHttpAction + oci.data_science.models.ScheduleHttpActionDetails + oci.data_science.models.ScheduleICalTrigger + oci.data_science.models.ScheduleIntervalTrigger + oci.data_science.models.ScheduleLogDetails + oci.data_science.models.ScheduleSummary + oci.data_science.models.ScheduleTrigger oci.data_science.models.SingleModelDeploymentConfigurationDetails oci.data_science.models.StandaloneJobInfrastructureConfigurationDetails oci.data_science.models.StorageMountConfigurationDetails + oci.data_science.models.TagConfiguration oci.data_science.models.ThresholdBasedAutoScalingPolicyDetails + oci.data_science.models.TriggerMlApplicationInstanceViewFlowDetails + oci.data_science.models.TriggerParameter oci.data_science.models.UpdateCategoryLogDetails oci.data_science.models.UpdateDataSciencePrivateEndpointDetails oci.data_science.models.UpdateDefaultModelDeploymentEnvironmentConfigurationDetails @@ -156,9 +179,11 @@ Data Science oci.data_science.models.UpdatePipelineDetails oci.data_science.models.UpdatePipelineRunDetails oci.data_science.models.UpdateProjectDetails + oci.data_science.models.UpdateScheduleDetails oci.data_science.models.UpdateSingleModelDeploymentConfigurationDetails oci.data_science.models.WorkRequest oci.data_science.models.WorkRequestError oci.data_science.models.WorkRequestLogEntry oci.data_science.models.WorkRequestResource oci.data_science.models.WorkRequestSummary + oci.data_science.models.WorkloadConfigurationDetails diff --git a/docs/api/data_science/models/oci.data_science.models.ChangeScheduleCompartmentDetails.rst b/docs/api/data_science/models/oci.data_science.models.ChangeScheduleCompartmentDetails.rst new file mode 100644 index 0000000000..3c67a7cdc1 --- /dev/null +++ b/docs/api/data_science/models/oci.data_science.models.ChangeScheduleCompartmentDetails.rst @@ -0,0 +1,11 @@ +ChangeScheduleCompartmentDetails +================================ + +.. currentmodule:: oci.data_science.models + +.. autoclass:: ChangeScheduleCompartmentDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_science/models/oci.data_science.models.ContainerSummary.rst b/docs/api/data_science/models/oci.data_science.models.ContainerSummary.rst new file mode 100644 index 0000000000..603c47709a --- /dev/null +++ b/docs/api/data_science/models/oci.data_science.models.ContainerSummary.rst @@ -0,0 +1,11 @@ +ContainerSummary +================ + +.. currentmodule:: oci.data_science.models + +.. autoclass:: ContainerSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_science/models/oci.data_science.models.CreateJobRunScheduleActionDetails.rst b/docs/api/data_science/models/oci.data_science.models.CreateJobRunScheduleActionDetails.rst new file mode 100644 index 0000000000..81693729e2 --- /dev/null +++ b/docs/api/data_science/models/oci.data_science.models.CreateJobRunScheduleActionDetails.rst @@ -0,0 +1,11 @@ +CreateJobRunScheduleActionDetails +================================= + +.. currentmodule:: oci.data_science.models + +.. autoclass:: CreateJobRunScheduleActionDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_science/models/oci.data_science.models.CreatePipelineRunScheduleActionDetails.rst b/docs/api/data_science/models/oci.data_science.models.CreatePipelineRunScheduleActionDetails.rst new file mode 100644 index 0000000000..1b4e2139f3 --- /dev/null +++ b/docs/api/data_science/models/oci.data_science.models.CreatePipelineRunScheduleActionDetails.rst @@ -0,0 +1,11 @@ +CreatePipelineRunScheduleActionDetails +====================================== + +.. currentmodule:: oci.data_science.models + +.. autoclass:: CreatePipelineRunScheduleActionDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_science/models/oci.data_science.models.CreateScheduleDetails.rst b/docs/api/data_science/models/oci.data_science.models.CreateScheduleDetails.rst new file mode 100644 index 0000000000..df20da1c94 --- /dev/null +++ b/docs/api/data_science/models/oci.data_science.models.CreateScheduleDetails.rst @@ -0,0 +1,11 @@ +CreateScheduleDetails +===================== + +.. currentmodule:: oci.data_science.models + +.. autoclass:: CreateScheduleDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_science/models/oci.data_science.models.GenericJobRunUseCaseConfigurationDetails.rst b/docs/api/data_science/models/oci.data_science.models.GenericJobRunUseCaseConfigurationDetails.rst new file mode 100644 index 0000000000..3c839044b4 --- /dev/null +++ b/docs/api/data_science/models/oci.data_science.models.GenericJobRunUseCaseConfigurationDetails.rst @@ -0,0 +1,11 @@ +GenericJobRunUseCaseConfigurationDetails +======================================== + +.. currentmodule:: oci.data_science.models + +.. autoclass:: GenericJobRunUseCaseConfigurationDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_science/models/oci.data_science.models.InvokeMlApplicationProviderTriggerScheduleActionDetails.rst b/docs/api/data_science/models/oci.data_science.models.InvokeMlApplicationProviderTriggerScheduleActionDetails.rst new file mode 100644 index 0000000000..0ec8112347 --- /dev/null +++ b/docs/api/data_science/models/oci.data_science.models.InvokeMlApplicationProviderTriggerScheduleActionDetails.rst @@ -0,0 +1,11 @@ +InvokeMlApplicationProviderTriggerScheduleActionDetails +======================================================= + +.. currentmodule:: oci.data_science.models + +.. autoclass:: InvokeMlApplicationProviderTriggerScheduleActionDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_science/models/oci.data_science.models.JobRunUseCaseConfigurationDetails.rst b/docs/api/data_science/models/oci.data_science.models.JobRunUseCaseConfigurationDetails.rst new file mode 100644 index 0000000000..e978f45dbf --- /dev/null +++ b/docs/api/data_science/models/oci.data_science.models.JobRunUseCaseConfigurationDetails.rst @@ -0,0 +1,11 @@ +JobRunUseCaseConfigurationDetails +================================= + +.. currentmodule:: oci.data_science.models + +.. autoclass:: JobRunUseCaseConfigurationDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_science/models/oci.data_science.models.JobRunWorkloadConfigurationDetails.rst b/docs/api/data_science/models/oci.data_science.models.JobRunWorkloadConfigurationDetails.rst new file mode 100644 index 0000000000..aa22dae666 --- /dev/null +++ b/docs/api/data_science/models/oci.data_science.models.JobRunWorkloadConfigurationDetails.rst @@ -0,0 +1,11 @@ +JobRunWorkloadConfigurationDetails +================================== + +.. currentmodule:: oci.data_science.models + +.. autoclass:: JobRunWorkloadConfigurationDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_science/models/oci.data_science.models.ModelDeployWorkloadConfigurationDetails.rst b/docs/api/data_science/models/oci.data_science.models.ModelDeployWorkloadConfigurationDetails.rst new file mode 100644 index 0000000000..a8f7defcae --- /dev/null +++ b/docs/api/data_science/models/oci.data_science.models.ModelDeployWorkloadConfigurationDetails.rst @@ -0,0 +1,11 @@ +ModelDeployWorkloadConfigurationDetails +======================================= + +.. currentmodule:: oci.data_science.models + +.. autoclass:: ModelDeployWorkloadConfigurationDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_science/models/oci.data_science.models.Schedule.rst b/docs/api/data_science/models/oci.data_science.models.Schedule.rst new file mode 100644 index 0000000000..3efb6e452f --- /dev/null +++ b/docs/api/data_science/models/oci.data_science.models.Schedule.rst @@ -0,0 +1,11 @@ +Schedule +======== + +.. currentmodule:: oci.data_science.models + +.. autoclass:: Schedule + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_science/models/oci.data_science.models.ScheduleAction.rst b/docs/api/data_science/models/oci.data_science.models.ScheduleAction.rst new file mode 100644 index 0000000000..c77f5f9807 --- /dev/null +++ b/docs/api/data_science/models/oci.data_science.models.ScheduleAction.rst @@ -0,0 +1,11 @@ +ScheduleAction +============== + +.. currentmodule:: oci.data_science.models + +.. autoclass:: ScheduleAction + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_science/models/oci.data_science.models.ScheduleCronTrigger.rst b/docs/api/data_science/models/oci.data_science.models.ScheduleCronTrigger.rst new file mode 100644 index 0000000000..691252c068 --- /dev/null +++ b/docs/api/data_science/models/oci.data_science.models.ScheduleCronTrigger.rst @@ -0,0 +1,11 @@ +ScheduleCronTrigger +=================== + +.. currentmodule:: oci.data_science.models + +.. autoclass:: ScheduleCronTrigger + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_science/models/oci.data_science.models.ScheduleHttpAction.rst b/docs/api/data_science/models/oci.data_science.models.ScheduleHttpAction.rst new file mode 100644 index 0000000000..4872d2881f --- /dev/null +++ b/docs/api/data_science/models/oci.data_science.models.ScheduleHttpAction.rst @@ -0,0 +1,11 @@ +ScheduleHttpAction +================== + +.. currentmodule:: oci.data_science.models + +.. autoclass:: ScheduleHttpAction + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_science/models/oci.data_science.models.ScheduleHttpActionDetails.rst b/docs/api/data_science/models/oci.data_science.models.ScheduleHttpActionDetails.rst new file mode 100644 index 0000000000..5dd2b41505 --- /dev/null +++ b/docs/api/data_science/models/oci.data_science.models.ScheduleHttpActionDetails.rst @@ -0,0 +1,11 @@ +ScheduleHttpActionDetails +========================= + +.. currentmodule:: oci.data_science.models + +.. autoclass:: ScheduleHttpActionDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_science/models/oci.data_science.models.ScheduleICalTrigger.rst b/docs/api/data_science/models/oci.data_science.models.ScheduleICalTrigger.rst new file mode 100644 index 0000000000..cc3dcd0db5 --- /dev/null +++ b/docs/api/data_science/models/oci.data_science.models.ScheduleICalTrigger.rst @@ -0,0 +1,11 @@ +ScheduleICalTrigger +=================== + +.. currentmodule:: oci.data_science.models + +.. autoclass:: ScheduleICalTrigger + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_science/models/oci.data_science.models.ScheduleIntervalTrigger.rst b/docs/api/data_science/models/oci.data_science.models.ScheduleIntervalTrigger.rst new file mode 100644 index 0000000000..6c91ed7c06 --- /dev/null +++ b/docs/api/data_science/models/oci.data_science.models.ScheduleIntervalTrigger.rst @@ -0,0 +1,11 @@ +ScheduleIntervalTrigger +======================= + +.. currentmodule:: oci.data_science.models + +.. autoclass:: ScheduleIntervalTrigger + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_science/models/oci.data_science.models.ScheduleLogDetails.rst b/docs/api/data_science/models/oci.data_science.models.ScheduleLogDetails.rst new file mode 100644 index 0000000000..89c8d507f3 --- /dev/null +++ b/docs/api/data_science/models/oci.data_science.models.ScheduleLogDetails.rst @@ -0,0 +1,11 @@ +ScheduleLogDetails +================== + +.. currentmodule:: oci.data_science.models + +.. autoclass:: ScheduleLogDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_science/models/oci.data_science.models.ScheduleSummary.rst b/docs/api/data_science/models/oci.data_science.models.ScheduleSummary.rst new file mode 100644 index 0000000000..326fa8def4 --- /dev/null +++ b/docs/api/data_science/models/oci.data_science.models.ScheduleSummary.rst @@ -0,0 +1,11 @@ +ScheduleSummary +=============== + +.. currentmodule:: oci.data_science.models + +.. autoclass:: ScheduleSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_science/models/oci.data_science.models.ScheduleTrigger.rst b/docs/api/data_science/models/oci.data_science.models.ScheduleTrigger.rst new file mode 100644 index 0000000000..4ee88d1ca0 --- /dev/null +++ b/docs/api/data_science/models/oci.data_science.models.ScheduleTrigger.rst @@ -0,0 +1,11 @@ +ScheduleTrigger +=============== + +.. currentmodule:: oci.data_science.models + +.. autoclass:: ScheduleTrigger + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_science/models/oci.data_science.models.TagConfiguration.rst b/docs/api/data_science/models/oci.data_science.models.TagConfiguration.rst new file mode 100644 index 0000000000..582d65dd47 --- /dev/null +++ b/docs/api/data_science/models/oci.data_science.models.TagConfiguration.rst @@ -0,0 +1,11 @@ +TagConfiguration +================ + +.. currentmodule:: oci.data_science.models + +.. autoclass:: TagConfiguration + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_science/models/oci.data_science.models.TriggerMlApplicationInstanceViewFlowDetails.rst b/docs/api/data_science/models/oci.data_science.models.TriggerMlApplicationInstanceViewFlowDetails.rst new file mode 100644 index 0000000000..84941b0d2a --- /dev/null +++ b/docs/api/data_science/models/oci.data_science.models.TriggerMlApplicationInstanceViewFlowDetails.rst @@ -0,0 +1,11 @@ +TriggerMlApplicationInstanceViewFlowDetails +=========================================== + +.. currentmodule:: oci.data_science.models + +.. autoclass:: TriggerMlApplicationInstanceViewFlowDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_science/models/oci.data_science.models.TriggerParameter.rst b/docs/api/data_science/models/oci.data_science.models.TriggerParameter.rst new file mode 100644 index 0000000000..17463c200b --- /dev/null +++ b/docs/api/data_science/models/oci.data_science.models.TriggerParameter.rst @@ -0,0 +1,11 @@ +TriggerParameter +================ + +.. currentmodule:: oci.data_science.models + +.. autoclass:: TriggerParameter + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_science/models/oci.data_science.models.UpdateScheduleDetails.rst b/docs/api/data_science/models/oci.data_science.models.UpdateScheduleDetails.rst new file mode 100644 index 0000000000..b8686fea4d --- /dev/null +++ b/docs/api/data_science/models/oci.data_science.models.UpdateScheduleDetails.rst @@ -0,0 +1,11 @@ +UpdateScheduleDetails +===================== + +.. currentmodule:: oci.data_science.models + +.. autoclass:: UpdateScheduleDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_science/models/oci.data_science.models.WorkloadConfigurationDetails.rst b/docs/api/data_science/models/oci.data_science.models.WorkloadConfigurationDetails.rst new file mode 100644 index 0000000000..3a86b030c1 --- /dev/null +++ b/docs/api/data_science/models/oci.data_science.models.WorkloadConfigurationDetails.rst @@ -0,0 +1,11 @@ +WorkloadConfigurationDetails +============================ + +.. currentmodule:: oci.data_science.models + +.. autoclass:: WorkloadConfigurationDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/generative_ai_inference.rst b/docs/api/generative_ai_inference.rst index 4696b1b872..0b581e2d1c 100644 --- a/docs/api/generative_ai_inference.rst +++ b/docs/api/generative_ai_inference.rst @@ -44,8 +44,12 @@ Generative Ai Inference oci.generative_ai_inference.models.CohereToolResult oci.generative_ai_inference.models.CohereUserMessage oci.generative_ai_inference.models.DedicatedServingMode + oci.generative_ai_inference.models.Document + oci.generative_ai_inference.models.DocumentRank oci.generative_ai_inference.models.EmbedTextDetails oci.generative_ai_inference.models.EmbedTextResult + oci.generative_ai_inference.models.FunctionCall + oci.generative_ai_inference.models.FunctionDefinition oci.generative_ai_inference.models.GenerateTextDetails oci.generative_ai_inference.models.GenerateTextResult oci.generative_ai_inference.models.GeneratedText @@ -60,6 +64,8 @@ Generative Ai Inference oci.generative_ai_inference.models.Logprobs oci.generative_ai_inference.models.Message oci.generative_ai_inference.models.OnDemandServingMode + oci.generative_ai_inference.models.RerankTextDetails + oci.generative_ai_inference.models.RerankTextResult oci.generative_ai_inference.models.SearchQuery oci.generative_ai_inference.models.ServingMode oci.generative_ai_inference.models.SummarizeTextDetails @@ -67,4 +73,12 @@ Generative Ai Inference oci.generative_ai_inference.models.SystemMessage oci.generative_ai_inference.models.TextContent oci.generative_ai_inference.models.TokenLikelihood + oci.generative_ai_inference.models.ToolCall + oci.generative_ai_inference.models.ToolChoice + oci.generative_ai_inference.models.ToolChoiceAuto + oci.generative_ai_inference.models.ToolChoiceFunction + oci.generative_ai_inference.models.ToolChoiceNone + oci.generative_ai_inference.models.ToolChoiceRequired + oci.generative_ai_inference.models.ToolDefinition + oci.generative_ai_inference.models.ToolMessage oci.generative_ai_inference.models.UserMessage diff --git a/docs/api/generative_ai_inference/models/oci.generative_ai_inference.models.Document.rst b/docs/api/generative_ai_inference/models/oci.generative_ai_inference.models.Document.rst new file mode 100644 index 0000000000..c6770817bf --- /dev/null +++ b/docs/api/generative_ai_inference/models/oci.generative_ai_inference.models.Document.rst @@ -0,0 +1,11 @@ +Document +======== + +.. currentmodule:: oci.generative_ai_inference.models + +.. autoclass:: Document + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/generative_ai_inference/models/oci.generative_ai_inference.models.DocumentRank.rst b/docs/api/generative_ai_inference/models/oci.generative_ai_inference.models.DocumentRank.rst new file mode 100644 index 0000000000..14d381fc78 --- /dev/null +++ b/docs/api/generative_ai_inference/models/oci.generative_ai_inference.models.DocumentRank.rst @@ -0,0 +1,11 @@ +DocumentRank +============ + +.. currentmodule:: oci.generative_ai_inference.models + +.. autoclass:: DocumentRank + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/generative_ai_inference/models/oci.generative_ai_inference.models.FunctionCall.rst b/docs/api/generative_ai_inference/models/oci.generative_ai_inference.models.FunctionCall.rst new file mode 100644 index 0000000000..86fe9b4743 --- /dev/null +++ b/docs/api/generative_ai_inference/models/oci.generative_ai_inference.models.FunctionCall.rst @@ -0,0 +1,11 @@ +FunctionCall +============ + +.. currentmodule:: oci.generative_ai_inference.models + +.. autoclass:: FunctionCall + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/generative_ai_inference/models/oci.generative_ai_inference.models.FunctionDefinition.rst b/docs/api/generative_ai_inference/models/oci.generative_ai_inference.models.FunctionDefinition.rst new file mode 100644 index 0000000000..5375491ff8 --- /dev/null +++ b/docs/api/generative_ai_inference/models/oci.generative_ai_inference.models.FunctionDefinition.rst @@ -0,0 +1,11 @@ +FunctionDefinition +================== + +.. currentmodule:: oci.generative_ai_inference.models + +.. autoclass:: FunctionDefinition + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/generative_ai_inference/models/oci.generative_ai_inference.models.RerankTextDetails.rst b/docs/api/generative_ai_inference/models/oci.generative_ai_inference.models.RerankTextDetails.rst new file mode 100644 index 0000000000..7646700e1e --- /dev/null +++ b/docs/api/generative_ai_inference/models/oci.generative_ai_inference.models.RerankTextDetails.rst @@ -0,0 +1,11 @@ +RerankTextDetails +================= + +.. currentmodule:: oci.generative_ai_inference.models + +.. autoclass:: RerankTextDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/generative_ai_inference/models/oci.generative_ai_inference.models.RerankTextResult.rst b/docs/api/generative_ai_inference/models/oci.generative_ai_inference.models.RerankTextResult.rst new file mode 100644 index 0000000000..d262398d56 --- /dev/null +++ b/docs/api/generative_ai_inference/models/oci.generative_ai_inference.models.RerankTextResult.rst @@ -0,0 +1,11 @@ +RerankTextResult +================ + +.. currentmodule:: oci.generative_ai_inference.models + +.. autoclass:: RerankTextResult + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/generative_ai_inference/models/oci.generative_ai_inference.models.ToolCall.rst b/docs/api/generative_ai_inference/models/oci.generative_ai_inference.models.ToolCall.rst new file mode 100644 index 0000000000..009979f296 --- /dev/null +++ b/docs/api/generative_ai_inference/models/oci.generative_ai_inference.models.ToolCall.rst @@ -0,0 +1,11 @@ +ToolCall +======== + +.. currentmodule:: oci.generative_ai_inference.models + +.. autoclass:: ToolCall + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/generative_ai_inference/models/oci.generative_ai_inference.models.ToolChoice.rst b/docs/api/generative_ai_inference/models/oci.generative_ai_inference.models.ToolChoice.rst new file mode 100644 index 0000000000..92b450217a --- /dev/null +++ b/docs/api/generative_ai_inference/models/oci.generative_ai_inference.models.ToolChoice.rst @@ -0,0 +1,11 @@ +ToolChoice +========== + +.. currentmodule:: oci.generative_ai_inference.models + +.. autoclass:: ToolChoice + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/generative_ai_inference/models/oci.generative_ai_inference.models.ToolChoiceAuto.rst b/docs/api/generative_ai_inference/models/oci.generative_ai_inference.models.ToolChoiceAuto.rst new file mode 100644 index 0000000000..c505556bfa --- /dev/null +++ b/docs/api/generative_ai_inference/models/oci.generative_ai_inference.models.ToolChoiceAuto.rst @@ -0,0 +1,11 @@ +ToolChoiceAuto +============== + +.. currentmodule:: oci.generative_ai_inference.models + +.. autoclass:: ToolChoiceAuto + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/generative_ai_inference/models/oci.generative_ai_inference.models.ToolChoiceFunction.rst b/docs/api/generative_ai_inference/models/oci.generative_ai_inference.models.ToolChoiceFunction.rst new file mode 100644 index 0000000000..10a01d09bb --- /dev/null +++ b/docs/api/generative_ai_inference/models/oci.generative_ai_inference.models.ToolChoiceFunction.rst @@ -0,0 +1,11 @@ +ToolChoiceFunction +================== + +.. currentmodule:: oci.generative_ai_inference.models + +.. autoclass:: ToolChoiceFunction + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/generative_ai_inference/models/oci.generative_ai_inference.models.ToolChoiceNone.rst b/docs/api/generative_ai_inference/models/oci.generative_ai_inference.models.ToolChoiceNone.rst new file mode 100644 index 0000000000..73a6529cf9 --- /dev/null +++ b/docs/api/generative_ai_inference/models/oci.generative_ai_inference.models.ToolChoiceNone.rst @@ -0,0 +1,11 @@ +ToolChoiceNone +============== + +.. currentmodule:: oci.generative_ai_inference.models + +.. autoclass:: ToolChoiceNone + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/generative_ai_inference/models/oci.generative_ai_inference.models.ToolChoiceRequired.rst b/docs/api/generative_ai_inference/models/oci.generative_ai_inference.models.ToolChoiceRequired.rst new file mode 100644 index 0000000000..5dd358afe2 --- /dev/null +++ b/docs/api/generative_ai_inference/models/oci.generative_ai_inference.models.ToolChoiceRequired.rst @@ -0,0 +1,11 @@ +ToolChoiceRequired +================== + +.. currentmodule:: oci.generative_ai_inference.models + +.. autoclass:: ToolChoiceRequired + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/generative_ai_inference/models/oci.generative_ai_inference.models.ToolDefinition.rst b/docs/api/generative_ai_inference/models/oci.generative_ai_inference.models.ToolDefinition.rst new file mode 100644 index 0000000000..d0e5df47d5 --- /dev/null +++ b/docs/api/generative_ai_inference/models/oci.generative_ai_inference.models.ToolDefinition.rst @@ -0,0 +1,11 @@ +ToolDefinition +============== + +.. currentmodule:: oci.generative_ai_inference.models + +.. autoclass:: ToolDefinition + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/generative_ai_inference/models/oci.generative_ai_inference.models.ToolMessage.rst b/docs/api/generative_ai_inference/models/oci.generative_ai_inference.models.ToolMessage.rst new file mode 100644 index 0000000000..c03b275a3c --- /dev/null +++ b/docs/api/generative_ai_inference/models/oci.generative_ai_inference.models.ToolMessage.rst @@ -0,0 +1,11 @@ +ToolMessage +=========== + +.. currentmodule:: oci.generative_ai_inference.models + +.. autoclass:: ToolMessage + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/mysql.rst b/docs/api/mysql.rst index 3b01113851..fda69df61b 100644 --- a/docs/api/mysql.rst +++ b/docs/api/mysql.rst @@ -64,6 +64,7 @@ Mysql oci.mysql.models.CreateDbSystemSourceImportFromUrlDetails oci.mysql.models.CreateDeletionPolicyDetails oci.mysql.models.CreateMaintenanceDetails + oci.mysql.models.CreateReadEndpointDetails oci.mysql.models.CreateReplicaDetails oci.mysql.models.CustomerContact oci.mysql.models.DataStorage @@ -92,6 +93,7 @@ Mysql oci.mysql.models.PemCaCertificate oci.mysql.models.PitrPolicy oci.mysql.models.PointInTimeRecoveryDetails + oci.mysql.models.ReadEndpointDetails oci.mysql.models.Replica oci.mysql.models.ReplicaOverrides oci.mysql.models.ReplicaSummary @@ -111,6 +113,7 @@ Mysql oci.mysql.models.UpdateDeletionPolicyDetails oci.mysql.models.UpdateHeatWaveClusterDetails oci.mysql.models.UpdateMaintenanceDetails + oci.mysql.models.UpdateReadEndpointDetails oci.mysql.models.UpdateReplicaDetails oci.mysql.models.Version oci.mysql.models.VersionSummary diff --git a/docs/api/mysql/models/oci.mysql.models.CreateReadEndpointDetails.rst b/docs/api/mysql/models/oci.mysql.models.CreateReadEndpointDetails.rst new file mode 100644 index 0000000000..bdca593faf --- /dev/null +++ b/docs/api/mysql/models/oci.mysql.models.CreateReadEndpointDetails.rst @@ -0,0 +1,11 @@ +CreateReadEndpointDetails +========================= + +.. currentmodule:: oci.mysql.models + +.. autoclass:: CreateReadEndpointDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/mysql/models/oci.mysql.models.ReadEndpointDetails.rst b/docs/api/mysql/models/oci.mysql.models.ReadEndpointDetails.rst new file mode 100644 index 0000000000..555d0e2c95 --- /dev/null +++ b/docs/api/mysql/models/oci.mysql.models.ReadEndpointDetails.rst @@ -0,0 +1,11 @@ +ReadEndpointDetails +=================== + +.. currentmodule:: oci.mysql.models + +.. autoclass:: ReadEndpointDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/mysql/models/oci.mysql.models.UpdateReadEndpointDetails.rst b/docs/api/mysql/models/oci.mysql.models.UpdateReadEndpointDetails.rst new file mode 100644 index 0000000000..269ae5c111 --- /dev/null +++ b/docs/api/mysql/models/oci.mysql.models.UpdateReadEndpointDetails.rst @@ -0,0 +1,11 @@ +UpdateReadEndpointDetails +========================= + +.. currentmodule:: oci.mysql.models + +.. autoclass:: UpdateReadEndpointDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/src/oci/data_safe/data_safe_client.py b/src/oci/data_safe/data_safe_client.py index c6b92ff080..ae33064937 100644 --- a/src/oci/data_safe/data_safe_client.py +++ b/src/oci/data_safe/data_safe_client.py @@ -714,6 +714,124 @@ def apply_sdm_masking_policy_difference(self, masking_policy_id, apply_sdm_maski api_reference_link=api_reference_link, required_arguments=required_arguments) + def bulk_create_sensitive_types(self, bulk_create_sensitive_types_details, opc_compartment_id, **kwargs): + """ + Uploads a sensitive types xml file (also called template) to create new sensitive types. + + + :param stream bulk_create_sensitive_types_details: (required) + Details to upload a sensitive types file and create all. + + :param str opc_compartment_id: (required) + A header param to create bulk resources in the specified compartment OCID. + + :param str opc_request_id: (optional) + Unique identifier for the request. + + :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 + :param int buffer_limit: (optional) + A buffer limit for the stream to be buffered. buffer_limit is used to set the buffer size capacity. Streams will be read until the size of the buffer reaches the buffer_limit. + If the stream size is greater than the buffer_limit, a BufferError exception will be thrown. + + The buffer_limit parameter is used when the stream object does not have a `seek`, `tell`, or `fileno` property for the Python Request library to calculate out the content length. + If buffer_limit is not passed, then the buffer_limit will be defaulted to 100MB. + Large streams can cause the process to freeze, consider passing in content-length for large streams instead. + + :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 bulk_create_sensitive_types API. + """ + # Required path and query arguments. These are in camelCase to replace values in service endpoints. + required_arguments = [] + resource_path = "/sensitiveTypes/actions/bulkCreateSensitiveTypes" + method = "POST" + operation_name = "bulk_create_sensitive_types" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/SensitiveType/BulkCreateSensitiveTypes" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "buffer_limit", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + f"bulk_create_sensitive_types got unknown kwargs: {extra_kwargs!r}") + + header_params = { + "accept": "application/json", + "opc-compartment-id": opc_compartment_id, + "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} + + # If the body parameter is optional we need to assign it to a variable so additional type checking can be performed. + try: + bulk_create_sensitive_types_details + except NameError: + bulk_create_sensitive_types_details = kwargs.get("bulk_create_sensitive_types_details", missing) + + if bulk_create_sensitive_types_details is not missing and bulk_create_sensitive_types_details is not None: + if (not isinstance(bulk_create_sensitive_types_details, (six.binary_type, six.string_types)) and + not hasattr(bulk_create_sensitive_types_details, "read")): + raise TypeError('The body must be a string, bytes, or provide a read() method.') + + if hasattr(bulk_create_sensitive_types_details, 'fileno') and hasattr(bulk_create_sensitive_types_details, 'name') and bulk_create_sensitive_types_details.name != '': + if requests.utils.super_len(bulk_create_sensitive_types_details) == 0: + header_params['Content-Length'] = '0' + + # If content length is not given and stream object have no 'fileno' and is not a string or bytes, try to calculate content length + elif 'Content-Length' not in header_params and not is_content_length_calculable_by_req_util(bulk_create_sensitive_types_details): + calculated_obj = back_up_body_calculate_stream_content_length(bulk_create_sensitive_types_details, kwargs.get("buffer_limit")) + header_params['Content-Length'] = calculated_obj["content_length"] + bulk_create_sensitive_types_details = calculated_obj["byte_content"] + + 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, + header_params=header_params, + body=bulk_create_sensitive_types_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=bulk_create_sensitive_types_details, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + def bulk_create_sql_firewall_allowed_sqls(self, bulk_create_sql_firewall_allowed_sqls_details, **kwargs): """ Appends the allowedSqls with entries from the logs. @@ -3741,16 +3859,16 @@ def change_sensitive_type_compartment(self, sensitive_type_id, change_sensitive_ api_reference_link=api_reference_link, required_arguments=required_arguments) - def change_sql_collection_compartment(self, sql_collection_id, change_sql_collection_compartment_details, **kwargs): + def change_sensitive_types_export_compartment(self, sensitive_types_export_id, change_sensitive_types_export_compartment_details, **kwargs): """ - Moves the specified SQL collection and its dependent resources into a different compartment. + Moves the specified sensitive types export into a different compartment. - :param str sql_collection_id: (required) - The OCID of the SQL collection resource. + :param str sensitive_types_export_id: (required) + The OCID of the sensitive types export. - :param oci.data_safe.models.ChangeSqlCollectionCompartmentDetails change_sql_collection_compartment_details: (required) - Details for the compartment move. + :param oci.data_safe.models.ChangeSensitiveTypesExportCompartmentDetails change_sensitive_types_export_compartment_details: (required) + Details to change the compartment of a sensitive types export. :param str if_match: (optional) For optimistic concurrency control. In the PUT or DELETE call @@ -3784,14 +3902,14 @@ def change_sql_collection_compartment(self, sql_collection_id, change_sql_collec :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use change_sql_collection_compartment API. + Click `here `__ to see an example of how to use change_sensitive_types_export_compartment API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['sqlCollectionId'] - resource_path = "/sqlCollections/{sqlCollectionId}/actions/changeCompartment" + required_arguments = ['sensitiveTypesExportId'] + resource_path = "/sensitiveTypesExports/{sensitiveTypesExportId}/actions/changeCompartment" method = "POST" - operation_name = "change_sql_collection_compartment" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/SqlCollection/ChangeSqlCollectionCompartment" + operation_name = "change_sensitive_types_export_compartment" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/SensitiveTypesExport/ChangeSensitiveTypesExportCompartment" # Don't accept unknown kwargs expected_kwargs = [ @@ -3804,10 +3922,10 @@ def change_sql_collection_compartment(self, sql_collection_id, change_sql_collec extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"change_sql_collection_compartment got unknown kwargs: {extra_kwargs!r}") + f"change_sensitive_types_export_compartment got unknown kwargs: {extra_kwargs!r}") path_params = { - "sqlCollectionId": sql_collection_id + "sensitiveTypesExportId": sensitive_types_export_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -3843,7 +3961,7 @@ def change_sql_collection_compartment(self, sql_collection_id, change_sql_collec method=method, path_params=path_params, header_params=header_params, - body=change_sql_collection_compartment_details, + body=change_sensitive_types_export_compartment_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -3854,21 +3972,21 @@ def change_sql_collection_compartment(self, sql_collection_id, change_sql_collec method=method, path_params=path_params, header_params=header_params, - body=change_sql_collection_compartment_details, + body=change_sensitive_types_export_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_sql_firewall_policy_compartment(self, sql_firewall_policy_id, change_sql_firewall_policy_compartment_details, **kwargs): + def change_sql_collection_compartment(self, sql_collection_id, change_sql_collection_compartment_details, **kwargs): """ - Moves the specified SQL Firewall policy and its dependent resources into a different compartment. + Moves the specified SQL collection and its dependent resources into a different compartment. - :param str sql_firewall_policy_id: (required) - The OCID of the SQL Firewall policy resource. + :param str sql_collection_id: (required) + The OCID of the SQL collection resource. - :param oci.data_safe.models.ChangeSqlFirewallPolicyCompartmentDetails change_sql_firewall_policy_compartment_details: (required) + :param oci.data_safe.models.ChangeSqlCollectionCompartmentDetails change_sql_collection_compartment_details: (required) Details for the compartment move. :param str if_match: (optional) @@ -3903,14 +4021,14 @@ def change_sql_firewall_policy_compartment(self, sql_firewall_policy_id, change_ :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use change_sql_firewall_policy_compartment API. + Click `here `__ to see an example of how to use change_sql_collection_compartment API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['sqlFirewallPolicyId'] - resource_path = "/sqlFirewallPolicies/{sqlFirewallPolicyId}/actions/changeCompartment" + required_arguments = ['sqlCollectionId'] + resource_path = "/sqlCollections/{sqlCollectionId}/actions/changeCompartment" method = "POST" - operation_name = "change_sql_firewall_policy_compartment" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/SqlFirewallPolicy/ChangeSqlFirewallPolicyCompartment" + operation_name = "change_sql_collection_compartment" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/SqlCollection/ChangeSqlCollectionCompartment" # Don't accept unknown kwargs expected_kwargs = [ @@ -3923,10 +4041,10 @@ def change_sql_firewall_policy_compartment(self, sql_firewall_policy_id, change_ extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"change_sql_firewall_policy_compartment got unknown kwargs: {extra_kwargs!r}") + f"change_sql_collection_compartment got unknown kwargs: {extra_kwargs!r}") path_params = { - "sqlFirewallPolicyId": sql_firewall_policy_id + "sqlCollectionId": sql_collection_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -3962,7 +4080,7 @@ def change_sql_firewall_policy_compartment(self, sql_firewall_policy_id, change_ method=method, path_params=path_params, header_params=header_params, - body=change_sql_firewall_policy_compartment_details, + body=change_sql_collection_compartment_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -3973,25 +4091,22 @@ def change_sql_firewall_policy_compartment(self, sql_firewall_policy_id, change_ method=method, path_params=path_params, header_params=header_params, - body=change_sql_firewall_policy_compartment_details, + body=change_sql_collection_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_target_alert_policy_association_compartment(self, target_alert_policy_association_id, change_target_alert_policy_association_compartment_details, **kwargs): + def change_sql_firewall_policy_compartment(self, sql_firewall_policy_id, change_sql_firewall_policy_compartment_details, **kwargs): """ - Moves the specified target-alert policy Association into a different compartment. - + Moves the specified SQL Firewall policy and its dependent resources into a different compartment. - :param str target_alert_policy_association_id: (required) - The OCID of the target-alert policy association. - :param oci.data_safe.models.ChangeTargetAlertPolicyAssociationCompartmentDetails change_target_alert_policy_association_compartment_details: (required) - The details used to change the compartment of a target-alert policy association. + :param str sql_firewall_policy_id: (required) + The OCID of the SQL Firewall policy resource. - :param str opc_request_id: (optional) - Unique identifier for the request. + :param oci.data_safe.models.ChangeSqlFirewallPolicyCompartmentDetails change_sql_firewall_policy_compartment_details: (required) + Details for the compartment move. :param str if_match: (optional) For optimistic concurrency control. In the PUT or DELETE call @@ -4000,6 +4115,9 @@ def change_target_alert_policy_association_compartment(self, target_alert_policy 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 identifier for the request. + :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 @@ -4022,30 +4140,30 @@ def change_target_alert_policy_association_compartment(self, target_alert_policy :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use change_target_alert_policy_association_compartment API. + Click `here `__ to see an example of how to use change_sql_firewall_policy_compartment API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['targetAlertPolicyAssociationId'] - resource_path = "/targetAlertPolicyAssociations/{targetAlertPolicyAssociationId}/actions/changeCompartment" + required_arguments = ['sqlFirewallPolicyId'] + resource_path = "/sqlFirewallPolicies/{sqlFirewallPolicyId}/actions/changeCompartment" method = "POST" - operation_name = "change_target_alert_policy_association_compartment" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/TargetAlertPolicyAssociation/ChangeTargetAlertPolicyAssociationCompartment" + operation_name = "change_sql_firewall_policy_compartment" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/SqlFirewallPolicy/ChangeSqlFirewallPolicyCompartment" # Don't accept unknown kwargs expected_kwargs = [ "allow_control_chars", "retry_strategy", - "opc_request_id", "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( - f"change_target_alert_policy_association_compartment got unknown kwargs: {extra_kwargs!r}") + f"change_sql_firewall_policy_compartment got unknown kwargs: {extra_kwargs!r}") path_params = { - "targetAlertPolicyAssociationId": target_alert_policy_association_id + "sqlFirewallPolicyId": sql_firewall_policy_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -4057,8 +4175,8 @@ def change_target_alert_policy_association_compartment(self, target_alert_policy header_params = { "accept": "application/json", "content-type": "application/json", - "opc-request-id": kwargs.get("opc_request_id", missing), "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} @@ -4081,7 +4199,7 @@ def change_target_alert_policy_association_compartment(self, target_alert_policy method=method, path_params=path_params, header_params=header_params, - body=change_target_alert_policy_association_compartment_details, + body=change_sql_firewall_policy_compartment_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -4092,22 +4210,25 @@ def change_target_alert_policy_association_compartment(self, target_alert_policy method=method, path_params=path_params, header_params=header_params, - body=change_target_alert_policy_association_compartment_details, + body=change_sql_firewall_policy_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_target_database_compartment(self, target_database_id, change_target_database_compartment_details, **kwargs): + def change_target_alert_policy_association_compartment(self, target_alert_policy_association_id, change_target_alert_policy_association_compartment_details, **kwargs): """ - Moves the Data Safe target database to the specified compartment. + Moves the specified target-alert policy Association into a different compartment. - :param str target_database_id: (required) - The OCID of the Data Safe target database. + :param str target_alert_policy_association_id: (required) + The OCID of the target-alert policy association. - :param oci.data_safe.models.ChangeTargetDatabaseCompartmentDetails change_target_database_compartment_details: (required) - Details of the move compartment request. + :param oci.data_safe.models.ChangeTargetAlertPolicyAssociationCompartmentDetails change_target_alert_policy_association_compartment_details: (required) + The details used to change the compartment of a target-alert policy association. + + :param str opc_request_id: (optional) + Unique identifier for the request. :param str if_match: (optional) For optimistic concurrency control. In the PUT or DELETE call @@ -4116,9 +4237,6 @@ def change_target_database_compartment(self, target_database_id, change_target_d 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 identifier for the request. - :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 @@ -4141,30 +4259,30 @@ def change_target_database_compartment(self, target_database_id, change_target_d :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use change_target_database_compartment API. + Click `here `__ to see an example of how to use change_target_alert_policy_association_compartment API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['targetDatabaseId'] - resource_path = "/targetDatabases/{targetDatabaseId}/actions/changeCompartment" + required_arguments = ['targetAlertPolicyAssociationId'] + resource_path = "/targetAlertPolicyAssociations/{targetAlertPolicyAssociationId}/actions/changeCompartment" method = "POST" - operation_name = "change_target_database_compartment" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/TargetDatabase/ChangeTargetDatabaseCompartment" + operation_name = "change_target_alert_policy_association_compartment" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/TargetAlertPolicyAssociation/ChangeTargetAlertPolicyAssociationCompartment" # Don't accept unknown kwargs expected_kwargs = [ "allow_control_chars", "retry_strategy", - "if_match", "opc_request_id", + "if_match", "opc_retry_token" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"change_target_database_compartment got unknown kwargs: {extra_kwargs!r}") + f"change_target_alert_policy_association_compartment got unknown kwargs: {extra_kwargs!r}") path_params = { - "targetDatabaseId": target_database_id + "targetAlertPolicyAssociationId": target_alert_policy_association_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -4176,8 +4294,8 @@ def change_target_database_compartment(self, target_database_id, change_target_d 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), + "if-match": kwargs.get("if_match", 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} @@ -4200,7 +4318,7 @@ def change_target_database_compartment(self, target_database_id, change_target_d method=method, path_params=path_params, header_params=header_params, - body=change_target_database_compartment_details, + body=change_target_alert_policy_association_compartment_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -4211,26 +4329,22 @@ def change_target_database_compartment(self, target_database_id, change_target_d method=method, path_params=path_params, header_params=header_params, - body=change_target_database_compartment_details, + body=change_target_alert_policy_association_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_user_assessment_compartment(self, user_assessment_id, change_user_assessment_compartment_details, **kwargs): + def change_target_database_compartment(self, target_database_id, change_target_database_compartment_details, **kwargs): """ - Moves the specified saved user assessment or future scheduled assessments into a different compartment. - To start storing scheduled user assessments on a different compartment, first call the operation ListUserAssessments with - the filters \"type = save_schedule\". That call returns the scheduleAssessmentId. Then call - ChangeUserAssessmentCompartment with the scheduleAssessmentId. The existing saved user assessments created per the schedule - are not be moved. However, all new saves will be associated with the new compartment. + Moves the Data Safe target database to the specified compartment. - :param str user_assessment_id: (required) - The OCID of the user assessment. + :param str target_database_id: (required) + The OCID of the Data Safe target database. - :param oci.data_safe.models.ChangeUserAssessmentCompartmentDetails change_user_assessment_compartment_details: (required) - The details used to change the compartment of a user assessment. + :param oci.data_safe.models.ChangeTargetDatabaseCompartmentDetails change_target_database_compartment_details: (required) + Details of the move compartment request. :param str if_match: (optional) For optimistic concurrency control. In the PUT or DELETE call @@ -4239,15 +4353,15 @@ def change_user_assessment_compartment(self, user_assessment_id, change_user_ass 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 identifier for the request. + :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 identifier for the request. - :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. @@ -4264,30 +4378,30 @@ def change_user_assessment_compartment(self, user_assessment_id, change_user_ass :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use change_user_assessment_compartment API. + Click `here `__ to see an example of how to use change_target_database_compartment API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['userAssessmentId'] - resource_path = "/userAssessments/{userAssessmentId}/actions/changeCompartment" + required_arguments = ['targetDatabaseId'] + resource_path = "/targetDatabases/{targetDatabaseId}/actions/changeCompartment" method = "POST" - operation_name = "change_user_assessment_compartment" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/UserAssessment/ChangeUserAssessmentCompartment" + operation_name = "change_target_database_compartment" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/TargetDatabase/ChangeTargetDatabaseCompartment" # Don't accept unknown kwargs expected_kwargs = [ "allow_control_chars", "retry_strategy", "if_match", - "opc_retry_token", - "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( - f"change_user_assessment_compartment got unknown kwargs: {extra_kwargs!r}") + f"change_target_database_compartment got unknown kwargs: {extra_kwargs!r}") path_params = { - "userAssessmentId": user_assessment_id + "targetDatabaseId": target_database_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -4300,8 +4414,131 @@ def change_user_assessment_compartment(self, user_assessment_id, change_user_ass "accept": "application/json", "content-type": "application/json", "if-match": kwargs.get("if_match", missing), - "opc-retry-token": kwargs.get("opc_retry_token", missing), - "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} + + 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_target_database_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_target_database_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_user_assessment_compartment(self, user_assessment_id, change_user_assessment_compartment_details, **kwargs): + """ + Moves the specified saved user assessment or future scheduled assessments into a different compartment. + To start storing scheduled user assessments on a different compartment, first call the operation ListUserAssessments with + the filters \"type = save_schedule\". That call returns the scheduleAssessmentId. Then call + ChangeUserAssessmentCompartment with the scheduleAssessmentId. The existing saved user assessments created per the schedule + are not be moved. However, all new saves will be associated with the new compartment. + + + :param str user_assessment_id: (required) + The OCID of the user assessment. + + :param oci.data_safe.models.ChangeUserAssessmentCompartmentDetails change_user_assessment_compartment_details: (required) + The details used to change the compartment of a user assessment. + + :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_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 identifier for the request. + + :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_user_assessment_compartment API. + """ + # Required path and query arguments. These are in camelCase to replace values in service endpoints. + required_arguments = ['userAssessmentId'] + resource_path = "/userAssessments/{userAssessmentId}/actions/changeCompartment" + method = "POST" + operation_name = "change_user_assessment_compartment" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/UserAssessment/ChangeUserAssessmentCompartment" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "if_match", + "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( + f"change_user_assessment_compartment got unknown kwargs: {extra_kwargs!r}") + + path_params = { + "userAssessmentId": user_assessment_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(f'Parameter {k} cannot be None, whitespace or empty string') + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "if-match": kwargs.get("if_match", missing), + "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} @@ -5647,13 +5884,16 @@ def create_peer_target_database(self, target_database_id, create_peer_target_dat api_reference_link=api_reference_link, required_arguments=required_arguments) - def create_report_definition(self, create_report_definition_details, **kwargs): + def create_referential_relation(self, sensitive_data_model_id, create_referential_relation_details, **kwargs): """ - Creates a new report definition with parameters specified in the body. The report definition is stored in the specified compartment. + Creates a new referential relation in the specified sensitive data model. - :param oci.data_safe.models.CreateReportDefinitionDetails create_report_definition_details: (required) - Details for the new report definition. + :param str sensitive_data_model_id: (required) + The OCID of the sensitive data model. + + :param oci.data_safe.models.CreateReferentialRelationDetails create_referential_relation_details: (required) + Details to create a new referential relation. :param str opc_retry_token: (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or @@ -5676,18 +5916,18 @@ def create_report_definition(self, create_report_definition_details, **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.data_safe.models.ReportDefinition` + :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 create_report_definition API. + Click `here `__ to see an example of how to use create_referential_relation API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = [] - resource_path = "/reportDefinitions" + required_arguments = ['sensitiveDataModelId'] + resource_path = "/sensitiveDataModels/{sensitiveDataModelId}/referentialRelations" method = "POST" - operation_name = "create_report_definition" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/ReportDefinition/CreateReportDefinition" + operation_name = "create_referential_relation" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/ReferentialRelation/CreateReferentialRelation" # Don't accept unknown kwargs expected_kwargs = [ @@ -5699,7 +5939,17 @@ def create_report_definition(self, create_report_definition_details, **kwargs): extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"create_report_definition got unknown kwargs: {extra_kwargs!r}") + f"create_referential_relation got unknown kwargs: {extra_kwargs!r}") + + path_params = { + "sensitiveDataModelId": sensitive_data_model_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(f'Parameter {k} cannot be None, whitespace or empty string') header_params = { "accept": "application/json", @@ -5725,9 +5975,9 @@ def create_report_definition(self, create_report_definition_details, **kwargs): self.base_client.call_api, resource_path=resource_path, method=method, + path_params=path_params, header_params=header_params, - body=create_report_definition_details, - response_type="ReportDefinition", + body=create_referential_relation_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -5736,25 +5986,21 @@ def create_report_definition(self, create_report_definition_details, **kwargs): return self.base_client.call_api( resource_path=resource_path, method=method, + path_params=path_params, header_params=header_params, - body=create_report_definition_details, - response_type="ReportDefinition", + body=create_referential_relation_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def create_sdm_masking_policy_difference(self, create_sdm_masking_policy_difference_details, **kwargs): + def create_report_definition(self, create_report_definition_details, **kwargs): """ - Creates SDM masking policy difference for the specified masking policy. It finds the difference between - masking columns of the masking policy and sensitive columns of the SDM. After performing this operation, - you can use ListDifferenceColumns to view the difference columns, PatchSdmMaskingPolicyDifferenceColumns - to specify the action you want perform on these columns, and then ApplySdmMaskingPolicyDifference to process the - difference columns and apply them to the masking policy. + Creates a new report definition with parameters specified in the body. The report definition is stored in the specified compartment. - :param oci.data_safe.models.CreateSdmMaskingPolicyDifferenceDetails create_sdm_masking_policy_difference_details: (required) - The details used to create a SDM masking policy difference resource + :param oci.data_safe.models.CreateReportDefinitionDetails create_report_definition_details: (required) + Details for the new report definition. :param str opc_retry_token: (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or @@ -5777,18 +6023,18 @@ def create_sdm_masking_policy_difference(self, create_sdm_masking_policy_differe 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.data_safe.models.SdmMaskingPolicyDifference` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.data_safe.models.ReportDefinition` :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use create_sdm_masking_policy_difference API. + Click `here `__ to see an example of how to use create_report_definition API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. required_arguments = [] - resource_path = "/sdmMaskingPolicyDifferences" + resource_path = "/reportDefinitions" method = "POST" - operation_name = "create_sdm_masking_policy_difference" - api_reference_link = "" + operation_name = "create_report_definition" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/ReportDefinition/CreateReportDefinition" # Don't accept unknown kwargs expected_kwargs = [ @@ -5800,7 +6046,7 @@ def create_sdm_masking_policy_difference(self, create_sdm_masking_policy_differe extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"create_sdm_masking_policy_difference got unknown kwargs: {extra_kwargs!r}") + f"create_report_definition got unknown kwargs: {extra_kwargs!r}") header_params = { "accept": "application/json", @@ -5827,8 +6073,8 @@ def create_sdm_masking_policy_difference(self, create_sdm_masking_policy_differe resource_path=resource_path, method=method, header_params=header_params, - body=create_sdm_masking_policy_difference_details, - response_type="SdmMaskingPolicyDifference", + body=create_report_definition_details, + response_type="ReportDefinition", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -5838,24 +6084,24 @@ def create_sdm_masking_policy_difference(self, create_sdm_masking_policy_differe resource_path=resource_path, method=method, header_params=header_params, - body=create_sdm_masking_policy_difference_details, - response_type="SdmMaskingPolicyDifference", + body=create_report_definition_details, + response_type="ReportDefinition", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def create_security_assessment(self, create_security_assessment_details, **kwargs): + def create_sdm_masking_policy_difference(self, create_sdm_masking_policy_difference_details, **kwargs): """ - Creates a new saved security assessment for one or multiple targets in a compartment. When this operation is performed, - it will save the latest assessments in the specified compartment. If a schedule is passed, it will persist the latest assessments, - at the defined date and time, in the format defined by `RFC3339`__. - - __ https://tools.ietf.org/html/rfc3339 + Creates SDM masking policy difference for the specified masking policy. It finds the difference between + masking columns of the masking policy and sensitive columns of the SDM. After performing this operation, + you can use ListDifferenceColumns to view the difference columns, PatchSdmMaskingPolicyDifferenceColumns + to specify the action you want perform on these columns, and then ApplySdmMaskingPolicyDifference to process the + difference columns and apply them to the masking policy. - :param oci.data_safe.models.CreateSecurityAssessmentDetails create_security_assessment_details: (required) - The details used to create a new saved security assessment. + :param oci.data_safe.models.CreateSdmMaskingPolicyDifferenceDetails create_sdm_masking_policy_difference_details: (required) + The details used to create a SDM masking policy difference resource :param str opc_retry_token: (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or @@ -5878,18 +6124,18 @@ def create_security_assessment(self, create_security_assessment_details, **kwarg 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.data_safe.models.SecurityAssessment` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.data_safe.models.SdmMaskingPolicyDifference` :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use create_security_assessment API. + Click `here `__ to see an example of how to use create_sdm_masking_policy_difference API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. required_arguments = [] - resource_path = "/securityAssessments" + resource_path = "/sdmMaskingPolicyDifferences" method = "POST" - operation_name = "create_security_assessment" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/SecurityAssessment/CreateSecurityAssessment" + operation_name = "create_sdm_masking_policy_difference" + api_reference_link = "" # Don't accept unknown kwargs expected_kwargs = [ @@ -5901,7 +6147,7 @@ def create_security_assessment(self, create_security_assessment_details, **kwarg extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"create_security_assessment got unknown kwargs: {extra_kwargs!r}") + f"create_sdm_masking_policy_difference got unknown kwargs: {extra_kwargs!r}") header_params = { "accept": "application/json", @@ -5928,8 +6174,8 @@ def create_security_assessment(self, create_security_assessment_details, **kwarg resource_path=resource_path, method=method, header_params=header_params, - body=create_security_assessment_details, - response_type="SecurityAssessment", + body=create_sdm_masking_policy_difference_details, + response_type="SdmMaskingPolicyDifference", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -5939,23 +6185,24 @@ def create_security_assessment(self, create_security_assessment_details, **kwarg resource_path=resource_path, method=method, header_params=header_params, - body=create_security_assessment_details, - response_type="SecurityAssessment", + body=create_sdm_masking_policy_difference_details, + response_type="SdmMaskingPolicyDifference", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def create_sensitive_column(self, sensitive_data_model_id, create_sensitive_column_details, **kwargs): + def create_security_assessment(self, create_security_assessment_details, **kwargs): """ - Creates a new sensitive column in the specified sensitive data model. + Creates a new saved security assessment for one or multiple targets in a compartment. When this operation is performed, + it will save the latest assessments in the specified compartment. If a schedule is passed, it will persist the latest assessments, + at the defined date and time, in the format defined by `RFC3339`__. + __ https://tools.ietf.org/html/rfc3339 - :param str sensitive_data_model_id: (required) - The OCID of the sensitive data model. - :param oci.data_safe.models.CreateSensitiveColumnDetails create_sensitive_column_details: (required) - Details to create a new sensitive column. + :param oci.data_safe.models.CreateSecurityAssessmentDetails create_security_assessment_details: (required) + The details used to create a new saved security assessment. :param str opc_retry_token: (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or @@ -5978,18 +6225,18 @@ def create_sensitive_column(self, sensitive_data_model_id, create_sensitive_colu 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.data_safe.models.SecurityAssessment` :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use create_sensitive_column API. + Click `here `__ to see an example of how to use create_security_assessment API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['sensitiveDataModelId'] - resource_path = "/sensitiveDataModels/{sensitiveDataModelId}/sensitiveColumns" + required_arguments = [] + resource_path = "/securityAssessments" method = "POST" - operation_name = "create_sensitive_column" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/SensitiveColumn/CreateSensitiveColumn" + operation_name = "create_security_assessment" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/SecurityAssessment/CreateSecurityAssessment" # Don't accept unknown kwargs expected_kwargs = [ @@ -6001,17 +6248,117 @@ def create_sensitive_column(self, sensitive_data_model_id, create_sensitive_colu extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"create_sensitive_column got unknown kwargs: {extra_kwargs!r}") - - path_params = { - "sensitiveDataModelId": sensitive_data_model_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(f'Parameter {k} cannot be None, whitespace or empty string') + f"create_security_assessment got unknown kwargs: {extra_kwargs!r}") + + 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_security_assessment_details, + response_type="SecurityAssessment", + 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_security_assessment_details, + response_type="SecurityAssessment", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + + def create_sensitive_column(self, sensitive_data_model_id, create_sensitive_column_details, **kwargs): + """ + Creates a new sensitive column in the specified sensitive data model. + + + :param str sensitive_data_model_id: (required) + The OCID of the sensitive data model. + + :param oci.data_safe.models.CreateSensitiveColumnDetails create_sensitive_column_details: (required) + Details to create a new sensitive column. + + :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 identifier for the request. + + :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 create_sensitive_column API. + """ + # Required path and query arguments. These are in camelCase to replace values in service endpoints. + required_arguments = ['sensitiveDataModelId'] + resource_path = "/sensitiveDataModels/{sensitiveDataModelId}/sensitiveColumns" + method = "POST" + operation_name = "create_sensitive_column" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/SensitiveColumn/CreateSensitiveColumn" + + # 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( + f"create_sensitive_column got unknown kwargs: {extra_kwargs!r}") + + path_params = { + "sensitiveDataModelId": sensitive_data_model_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(f'Parameter {k} cannot be None, whitespace or empty string') header_params = { "accept": "application/json", @@ -6254,6 +6601,105 @@ def create_sensitive_type(self, create_sensitive_type_details, **kwargs): api_reference_link=api_reference_link, required_arguments=required_arguments) + def create_sensitive_types_export(self, create_sensitive_types_export_details, **kwargs): + """ + Generates a downloadable file corresponding to the specified list of sensitive types. It's a prerequisite for the + DownloadSensitiveTypesExport operation. Use this endpoint to generate a sensitive Types Export file and then use + DownloadSensitiveTypesExport to download the generated file. + + + :param oci.data_safe.models.CreateSensitiveTypesExportDetails create_sensitive_types_export_details: (required) + Details to create a new sensitive types export resource. + + :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 identifier for the request. + + :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.data_safe.models.SensitiveTypesExport` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use create_sensitive_types_export API. + """ + # Required path and query arguments. These are in camelCase to replace values in service endpoints. + required_arguments = [] + resource_path = "/sensitiveTypesExports" + method = "POST" + operation_name = "create_sensitive_types_export" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/SensitiveTypesExport/CreateSensitiveTypesExport" + + # 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( + f"create_sensitive_types_export got unknown kwargs: {extra_kwargs!r}") + + 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_sensitive_types_export_details, + response_type="SensitiveTypesExport", + 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_sensitive_types_export_details, + response_type="SensitiveTypesExport", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + def create_sql_collection(self, create_sql_collection_details, **kwargs): """ Creates a new SQL collection resource. @@ -8142,13 +8588,16 @@ def delete_peer_target_database(self, target_database_id, peer_target_database_i api_reference_link=api_reference_link, required_arguments=required_arguments) - def delete_report_definition(self, report_definition_id, **kwargs): + def delete_referential_relation(self, sensitive_data_model_id, referential_relation_key, **kwargs): """ - Deletes the specified report definition. Only the user created report definition can be deleted. The seeded report definitions cannot be deleted. + Deletes the specified referential relation. - :param str report_definition_id: (required) - Unique report definition identifier + :param str sensitive_data_model_id: (required) + The OCID of the sensitive data model. + + :param str referential_relation_key: (required) + The unique key that identifies the referential relation. It's numeric and unique within a sensitive data model. :param str if_match: (optional) For optimistic concurrency control. In the PUT or DELETE call @@ -8176,14 +8625,14 @@ def delete_report_definition(self, report_definition_id, **kwargs): :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use delete_report_definition API. + Click `here `__ to see an example of how to use delete_referential_relation API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['reportDefinitionId'] - resource_path = "/reportDefinitions/{reportDefinitionId}" + required_arguments = ['sensitiveDataModelId', 'referentialRelationKey'] + resource_path = "/sensitiveDataModels/{sensitiveDataModelId}/referentialRelations/{referentialRelationKey}" method = "DELETE" - operation_name = "delete_report_definition" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/ReportDefinition/DeleteReportDefinition" + operation_name = "delete_referential_relation" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/ReferentialRelation/DeleteReferentialRelation" # Don't accept unknown kwargs expected_kwargs = [ @@ -8195,10 +8644,11 @@ def delete_report_definition(self, report_definition_id, **kwargs): extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"delete_report_definition got unknown kwargs: {extra_kwargs!r}") + f"delete_referential_relation got unknown kwargs: {extra_kwargs!r}") path_params = { - "reportDefinitionId": report_definition_id + "sensitiveDataModelId": sensitive_data_model_id, + "referentialRelationKey": referential_relation_key } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -8247,13 +8697,13 @@ def delete_report_definition(self, report_definition_id, **kwargs): api_reference_link=api_reference_link, required_arguments=required_arguments) - def delete_sdm_masking_policy_difference(self, sdm_masking_policy_difference_id, **kwargs): + def delete_report_definition(self, report_definition_id, **kwargs): """ - Deletes the specified SDM Masking policy difference. + Deletes the specified report definition. Only the user created report definition can be deleted. The seeded report definitions cannot be deleted. - :param str sdm_masking_policy_difference_id: (required) - The OCID of the SDM masking policy difference. + :param str report_definition_id: (required) + Unique report definition identifier :param str if_match: (optional) For optimistic concurrency control. In the PUT or DELETE call @@ -8281,14 +8731,14 @@ def delete_sdm_masking_policy_difference(self, sdm_masking_policy_difference_id, :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use delete_sdm_masking_policy_difference API. + Click `here `__ to see an example of how to use delete_report_definition API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['sdmMaskingPolicyDifferenceId'] - resource_path = "/sdmMaskingPolicyDifferences/{sdmMaskingPolicyDifferenceId}" + required_arguments = ['reportDefinitionId'] + resource_path = "/reportDefinitions/{reportDefinitionId}" method = "DELETE" - operation_name = "delete_sdm_masking_policy_difference" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/SdmMaskingPolicyDifference/DeleteSdmMaskingPolicyDifference" + operation_name = "delete_report_definition" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/ReportDefinition/DeleteReportDefinition" # Don't accept unknown kwargs expected_kwargs = [ @@ -8300,10 +8750,10 @@ def delete_sdm_masking_policy_difference(self, sdm_masking_policy_difference_id, extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"delete_sdm_masking_policy_difference got unknown kwargs: {extra_kwargs!r}") + f"delete_report_definition got unknown kwargs: {extra_kwargs!r}") path_params = { - "sdmMaskingPolicyDifferenceId": sdm_masking_policy_difference_id + "reportDefinitionId": report_definition_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -8352,19 +8802,13 @@ def delete_sdm_masking_policy_difference(self, sdm_masking_policy_difference_id, api_reference_link=api_reference_link, required_arguments=required_arguments) - def delete_security_assessment(self, security_assessment_id, **kwargs): + def delete_sdm_masking_policy_difference(self, sdm_masking_policy_difference_id, **kwargs): """ - Deletes the specified saved security assessment or schedule. To delete a security assessment schedule, - first call the operation ListSecurityAssessments with filters \"type = save_schedule\". - That operation returns the scheduleAssessmentId. Then, call DeleteSecurityAssessment with the scheduleAssessmentId. - If the assessment being deleted is the baseline for that compartment, then it will impact all baselines in the compartment. + Deletes the specified SDM Masking policy difference. - :param str security_assessment_id: (required) - The OCID of the security assessment. - - :param str opc_request_id: (optional) - Unique identifier for the request. + :param str sdm_masking_policy_difference_id: (required) + The OCID of the SDM masking policy difference. :param str if_match: (optional) For optimistic concurrency control. In the PUT or DELETE call @@ -8373,6 +8817,9 @@ def delete_security_assessment(self, security_assessment_id, **kwargs): 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 identifier for the request. + :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. @@ -8389,29 +8836,29 @@ def delete_security_assessment(self, security_assessment_id, **kwargs): :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use delete_security_assessment API. + Click `here `__ to see an example of how to use delete_sdm_masking_policy_difference API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['securityAssessmentId'] - resource_path = "/securityAssessments/{securityAssessmentId}" + required_arguments = ['sdmMaskingPolicyDifferenceId'] + resource_path = "/sdmMaskingPolicyDifferences/{sdmMaskingPolicyDifferenceId}" method = "DELETE" - operation_name = "delete_security_assessment" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/SecurityAssessment/DeleteSecurityAssessment" + operation_name = "delete_sdm_masking_policy_difference" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/SdmMaskingPolicyDifference/DeleteSdmMaskingPolicyDifference" # Don't accept unknown kwargs expected_kwargs = [ "allow_control_chars", "retry_strategy", - "opc_request_id", - "if_match" + "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( - f"delete_security_assessment got unknown kwargs: {extra_kwargs!r}") + f"delete_sdm_masking_policy_difference got unknown kwargs: {extra_kwargs!r}") path_params = { - "securityAssessmentId": security_assessment_id + "sdmMaskingPolicyDifferenceId": sdm_masking_policy_difference_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -8423,8 +8870,8 @@ def delete_security_assessment(self, security_assessment_id, **kwargs): header_params = { "accept": "application/json", "content-type": "application/json", - "opc-request-id": kwargs.get("opc_request_id", missing), - "if-match": kwargs.get("if_match", 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} @@ -8460,16 +8907,19 @@ def delete_security_assessment(self, security_assessment_id, **kwargs): api_reference_link=api_reference_link, required_arguments=required_arguments) - def delete_sensitive_column(self, sensitive_data_model_id, sensitive_column_key, **kwargs): + def delete_security_assessment(self, security_assessment_id, **kwargs): """ - Deletes the specified sensitive column. + Deletes the specified saved security assessment or schedule. To delete a security assessment schedule, + first call the operation ListSecurityAssessments with filters \"type = save_schedule\". + That operation returns the scheduleAssessmentId. Then, call DeleteSecurityAssessment with the scheduleAssessmentId. + If the assessment being deleted is the baseline for that compartment, then it will impact all baselines in the compartment. - :param str sensitive_data_model_id: (required) - The OCID of the sensitive data model. + :param str security_assessment_id: (required) + The OCID of the security assessment. - :param str sensitive_column_key: (required) - The unique key that identifies the sensitive column. It's numeric and unique within a sensitive data model. + :param str opc_request_id: (optional) + Unique identifier for the request. :param str if_match: (optional) For optimistic concurrency control. In the PUT or DELETE call @@ -8478,9 +8928,6 @@ def delete_sensitive_column(self, sensitive_data_model_id, sensitive_column_key, 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 identifier for the request. - :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. @@ -8497,30 +8944,29 @@ def delete_sensitive_column(self, sensitive_data_model_id, sensitive_column_key, :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use delete_sensitive_column API. + Click `here `__ to see an example of how to use delete_security_assessment API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['sensitiveDataModelId', 'sensitiveColumnKey'] - resource_path = "/sensitiveDataModels/{sensitiveDataModelId}/sensitiveColumns/{sensitiveColumnKey}" + required_arguments = ['securityAssessmentId'] + resource_path = "/securityAssessments/{securityAssessmentId}" method = "DELETE" - operation_name = "delete_sensitive_column" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/SensitiveColumn/DeleteSensitiveColumn" + operation_name = "delete_security_assessment" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/SecurityAssessment/DeleteSecurityAssessment" # Don't accept unknown kwargs expected_kwargs = [ "allow_control_chars", "retry_strategy", - "if_match", - "opc_request_id" + "opc_request_id", + "if_match" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"delete_sensitive_column got unknown kwargs: {extra_kwargs!r}") + f"delete_security_assessment got unknown kwargs: {extra_kwargs!r}") path_params = { - "sensitiveDataModelId": sensitive_data_model_id, - "sensitiveColumnKey": sensitive_column_key + "securityAssessmentId": security_assessment_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -8532,8 +8978,8 @@ def delete_sensitive_column(self, sensitive_data_model_id, sensitive_column_key, 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-request-id": kwargs.get("opc_request_id", 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} @@ -8569,118 +9015,16 @@ def delete_sensitive_column(self, sensitive_data_model_id, sensitive_column_key, api_reference_link=api_reference_link, required_arguments=required_arguments) - def delete_sensitive_data_model(self, sensitive_data_model_id, **kwargs): + def delete_sensitive_column(self, sensitive_data_model_id, sensitive_column_key, **kwargs): """ - Deletes the specified sensitive data model. + Deletes the specified sensitive column. :param str sensitive_data_model_id: (required) The OCID of the sensitive data model. - :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 identifier for the request. - - :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_sensitive_data_model API. - """ - # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['sensitiveDataModelId'] - resource_path = "/sensitiveDataModels/{sensitiveDataModelId}" - method = "DELETE" - operation_name = "delete_sensitive_data_model" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/SensitiveDataModel/DeleteSensitiveDataModel" - - # 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( - f"delete_sensitive_data_model got unknown kwargs: {extra_kwargs!r}") - - path_params = { - "sensitiveDataModelId": sensitive_data_model_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(f'Parameter {k} cannot be None, whitespace or empty string') - - 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_sensitive_type(self, sensitive_type_id, **kwargs): - """ - Deletes the specified sensitive type. - - - :param str sensitive_type_id: (required) - The OCID of the sensitive type. + :param str sensitive_column_key: (required) + The unique key that identifies the sensitive column. It's numeric and unique within a sensitive data model. :param str if_match: (optional) For optimistic concurrency control. In the PUT or DELETE call @@ -8708,14 +9052,14 @@ def delete_sensitive_type(self, sensitive_type_id, **kwargs): :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use delete_sensitive_type API. + Click `here `__ to see an example of how to use delete_sensitive_column API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['sensitiveTypeId'] - resource_path = "/sensitiveTypes/{sensitiveTypeId}" + required_arguments = ['sensitiveDataModelId', 'sensitiveColumnKey'] + resource_path = "/sensitiveDataModels/{sensitiveDataModelId}/sensitiveColumns/{sensitiveColumnKey}" method = "DELETE" - operation_name = "delete_sensitive_type" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/SensitiveType/DeleteSensitiveType" + operation_name = "delete_sensitive_column" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/SensitiveColumn/DeleteSensitiveColumn" # Don't accept unknown kwargs expected_kwargs = [ @@ -8727,10 +9071,11 @@ def delete_sensitive_type(self, sensitive_type_id, **kwargs): extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"delete_sensitive_type got unknown kwargs: {extra_kwargs!r}") + f"delete_sensitive_column got unknown kwargs: {extra_kwargs!r}") path_params = { - "sensitiveTypeId": sensitive_type_id + "sensitiveDataModelId": sensitive_data_model_id, + "sensitiveColumnKey": sensitive_column_key } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -8779,13 +9124,13 @@ def delete_sensitive_type(self, sensitive_type_id, **kwargs): api_reference_link=api_reference_link, required_arguments=required_arguments) - def delete_sql_collection(self, sql_collection_id, **kwargs): + def delete_sensitive_data_model(self, sensitive_data_model_id, **kwargs): """ - Deletes the specified SQL collection. + Deletes the specified sensitive data model. - :param str sql_collection_id: (required) - The OCID of the SQL collection resource. + :param str sensitive_data_model_id: (required) + The OCID of the sensitive data model. :param str if_match: (optional) For optimistic concurrency control. In the PUT or DELETE call @@ -8813,14 +9158,14 @@ def delete_sql_collection(self, sql_collection_id, **kwargs): :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use delete_sql_collection API. + Click `here `__ to see an example of how to use delete_sensitive_data_model API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['sqlCollectionId'] - resource_path = "/sqlCollections/{sqlCollectionId}" + required_arguments = ['sensitiveDataModelId'] + resource_path = "/sensitiveDataModels/{sensitiveDataModelId}" method = "DELETE" - operation_name = "delete_sql_collection" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/SqlCollection/DeleteSqlCollection" + operation_name = "delete_sensitive_data_model" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/SensitiveDataModel/DeleteSensitiveDataModel" # Don't accept unknown kwargs expected_kwargs = [ @@ -8832,10 +9177,10 @@ def delete_sql_collection(self, sql_collection_id, **kwargs): extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"delete_sql_collection got unknown kwargs: {extra_kwargs!r}") + f"delete_sensitive_data_model got unknown kwargs: {extra_kwargs!r}") path_params = { - "sqlCollectionId": sql_collection_id + "sensitiveDataModelId": sensitive_data_model_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -8884,13 +9229,13 @@ def delete_sql_collection(self, sql_collection_id, **kwargs): api_reference_link=api_reference_link, required_arguments=required_arguments) - def delete_sql_firewall_allowed_sql(self, sql_firewall_allowed_sql_id, **kwargs): + def delete_sensitive_type(self, sensitive_type_id, **kwargs): """ - Deletes the specified allowed sql. + Deletes the specified sensitive type. - :param str sql_firewall_allowed_sql_id: (required) - The OCID of the sqlFirewallAllowedSql resource. + :param str sensitive_type_id: (required) + The OCID of the sensitive type. :param str if_match: (optional) For optimistic concurrency control. In the PUT or DELETE call @@ -8918,14 +9263,14 @@ def delete_sql_firewall_allowed_sql(self, sql_firewall_allowed_sql_id, **kwargs) :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use delete_sql_firewall_allowed_sql API. + Click `here `__ to see an example of how to use delete_sensitive_type API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['sqlFirewallAllowedSqlId'] - resource_path = "/sqlFirewallAllowedSqls/{sqlFirewallAllowedSqlId}" + required_arguments = ['sensitiveTypeId'] + resource_path = "/sensitiveTypes/{sensitiveTypeId}" method = "DELETE" - operation_name = "delete_sql_firewall_allowed_sql" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/SqlFirewallAllowedSql/DeleteSqlFirewallAllowedSql" + operation_name = "delete_sensitive_type" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/SensitiveType/DeleteSensitiveType" # Don't accept unknown kwargs expected_kwargs = [ @@ -8937,10 +9282,10 @@ def delete_sql_firewall_allowed_sql(self, sql_firewall_allowed_sql_id, **kwargs) extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"delete_sql_firewall_allowed_sql got unknown kwargs: {extra_kwargs!r}") + f"delete_sensitive_type got unknown kwargs: {extra_kwargs!r}") path_params = { - "sqlFirewallAllowedSqlId": sql_firewall_allowed_sql_id + "sensitiveTypeId": sensitive_type_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -8989,13 +9334,13 @@ def delete_sql_firewall_allowed_sql(self, sql_firewall_allowed_sql_id, **kwargs) api_reference_link=api_reference_link, required_arguments=required_arguments) - def delete_sql_firewall_policy(self, sql_firewall_policy_id, **kwargs): + def delete_sensitive_types_export(self, sensitive_types_export_id, **kwargs): """ - Deletes the SQL Firewall policy resource. + Deletes the specified sensitive types export. - :param str sql_firewall_policy_id: (required) - The OCID of the SQL Firewall policy resource. + :param str sensitive_types_export_id: (required) + The OCID of the sensitive types export. :param str if_match: (optional) For optimistic concurrency control. In the PUT or DELETE call @@ -9023,14 +9368,14 @@ def delete_sql_firewall_policy(self, sql_firewall_policy_id, **kwargs): :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use delete_sql_firewall_policy API. + Click `here `__ to see an example of how to use delete_sensitive_types_export API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['sqlFirewallPolicyId'] - resource_path = "/sqlFirewallPolicies/{sqlFirewallPolicyId}" + required_arguments = ['sensitiveTypesExportId'] + resource_path = "/sensitiveTypesExports/{sensitiveTypesExportId}" method = "DELETE" - operation_name = "delete_sql_firewall_policy" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/SqlFirewallPolicy/DeleteSqlFirewallPolicy" + operation_name = "delete_sensitive_types_export" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/SensitiveTypesExport/DeleteSensitiveTypesExport" # Don't accept unknown kwargs expected_kwargs = [ @@ -9042,10 +9387,10 @@ def delete_sql_firewall_policy(self, sql_firewall_policy_id, **kwargs): extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"delete_sql_firewall_policy got unknown kwargs: {extra_kwargs!r}") + f"delete_sensitive_types_export got unknown kwargs: {extra_kwargs!r}") path_params = { - "sqlFirewallPolicyId": sql_firewall_policy_id + "sensitiveTypesExportId": sensitive_types_export_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -9094,13 +9439,13 @@ def delete_sql_firewall_policy(self, sql_firewall_policy_id, **kwargs): api_reference_link=api_reference_link, required_arguments=required_arguments) - def delete_target_alert_policy_association(self, target_alert_policy_association_id, **kwargs): + def delete_sql_collection(self, sql_collection_id, **kwargs): """ - Deletes the specified target-alert policy Association. + Deletes the specified SQL collection. - :param str target_alert_policy_association_id: (required) - The OCID of the target-alert policy association. + :param str sql_collection_id: (required) + The OCID of the SQL collection resource. :param str if_match: (optional) For optimistic concurrency control. In the PUT or DELETE call @@ -9128,14 +9473,14 @@ def delete_target_alert_policy_association(self, target_alert_policy_association :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use delete_target_alert_policy_association API. + Click `here `__ to see an example of how to use delete_sql_collection API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['targetAlertPolicyAssociationId'] - resource_path = "/targetAlertPolicyAssociations/{targetAlertPolicyAssociationId}" + required_arguments = ['sqlCollectionId'] + resource_path = "/sqlCollections/{sqlCollectionId}" method = "DELETE" - operation_name = "delete_target_alert_policy_association" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/TargetAlertPolicyAssociation/DeleteTargetAlertPolicyAssociation" + operation_name = "delete_sql_collection" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/SqlCollection/DeleteSqlCollection" # Don't accept unknown kwargs expected_kwargs = [ @@ -9147,10 +9492,10 @@ def delete_target_alert_policy_association(self, target_alert_policy_association extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"delete_target_alert_policy_association got unknown kwargs: {extra_kwargs!r}") + f"delete_sql_collection got unknown kwargs: {extra_kwargs!r}") path_params = { - "targetAlertPolicyAssociationId": target_alert_policy_association_id + "sqlCollectionId": sql_collection_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -9199,13 +9544,13 @@ def delete_target_alert_policy_association(self, target_alert_policy_association api_reference_link=api_reference_link, required_arguments=required_arguments) - def delete_target_database(self, target_database_id, **kwargs): + def delete_sql_firewall_allowed_sql(self, sql_firewall_allowed_sql_id, **kwargs): """ - Deregisters the specified database from Data Safe and removes the target database from the Data Safe Console. + Deletes the specified allowed sql. - :param str target_database_id: (required) - The OCID of the Data Safe target database. + :param str sql_firewall_allowed_sql_id: (required) + The OCID of the sqlFirewallAllowedSql resource. :param str if_match: (optional) For optimistic concurrency control. In the PUT or DELETE call @@ -9233,14 +9578,14 @@ def delete_target_database(self, target_database_id, **kwargs): :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use delete_target_database API. + Click `here `__ to see an example of how to use delete_sql_firewall_allowed_sql API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['targetDatabaseId'] - resource_path = "/targetDatabases/{targetDatabaseId}" + required_arguments = ['sqlFirewallAllowedSqlId'] + resource_path = "/sqlFirewallAllowedSqls/{sqlFirewallAllowedSqlId}" method = "DELETE" - operation_name = "delete_target_database" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/TargetDatabase/DeleteTargetDatabase" + operation_name = "delete_sql_firewall_allowed_sql" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/SqlFirewallAllowedSql/DeleteSqlFirewallAllowedSql" # Don't accept unknown kwargs expected_kwargs = [ @@ -9252,10 +9597,325 @@ def delete_target_database(self, target_database_id, **kwargs): extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"delete_target_database got unknown kwargs: {extra_kwargs!r}") + f"delete_sql_firewall_allowed_sql got unknown kwargs: {extra_kwargs!r}") path_params = { - "targetDatabaseId": target_database_id + "sqlFirewallAllowedSqlId": sql_firewall_allowed_sql_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(f'Parameter {k} cannot be None, whitespace or empty string') + + 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_sql_firewall_policy(self, sql_firewall_policy_id, **kwargs): + """ + Deletes the SQL Firewall policy resource. + + + :param str sql_firewall_policy_id: (required) + The OCID of the SQL Firewall policy resource. + + :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 identifier for the request. + + :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_sql_firewall_policy API. + """ + # Required path and query arguments. These are in camelCase to replace values in service endpoints. + required_arguments = ['sqlFirewallPolicyId'] + resource_path = "/sqlFirewallPolicies/{sqlFirewallPolicyId}" + method = "DELETE" + operation_name = "delete_sql_firewall_policy" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/SqlFirewallPolicy/DeleteSqlFirewallPolicy" + + # 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( + f"delete_sql_firewall_policy got unknown kwargs: {extra_kwargs!r}") + + path_params = { + "sqlFirewallPolicyId": sql_firewall_policy_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(f'Parameter {k} cannot be None, whitespace or empty string') + + 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_target_alert_policy_association(self, target_alert_policy_association_id, **kwargs): + """ + Deletes the specified target-alert policy Association. + + + :param str target_alert_policy_association_id: (required) + The OCID of the target-alert policy association. + + :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 identifier for the request. + + :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_target_alert_policy_association API. + """ + # Required path and query arguments. These are in camelCase to replace values in service endpoints. + required_arguments = ['targetAlertPolicyAssociationId'] + resource_path = "/targetAlertPolicyAssociations/{targetAlertPolicyAssociationId}" + method = "DELETE" + operation_name = "delete_target_alert_policy_association" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/TargetAlertPolicyAssociation/DeleteTargetAlertPolicyAssociation" + + # 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( + f"delete_target_alert_policy_association got unknown kwargs: {extra_kwargs!r}") + + path_params = { + "targetAlertPolicyAssociationId": target_alert_policy_association_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(f'Parameter {k} cannot be None, whitespace or empty string') + + 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_target_database(self, target_database_id, **kwargs): + """ + Deregisters the specified database from Data Safe and removes the target database from the Data Safe Console. + + + :param str target_database_id: (required) + The OCID of the Data Safe target database. + + :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 identifier for the request. + + :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_target_database API. + """ + # Required path and query arguments. These are in camelCase to replace values in service endpoints. + required_arguments = ['targetDatabaseId'] + resource_path = "/targetDatabases/{targetDatabaseId}" + method = "DELETE" + operation_name = "delete_target_database" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/TargetDatabase/DeleteTargetDatabase" + + # 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( + f"delete_target_database got unknown kwargs: {extra_kwargs!r}") + + path_params = { + "targetDatabaseId": target_database_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -10278,6 +10938,111 @@ def download_sensitive_data_model(self, sensitive_data_model_id, download_sensit api_reference_link=api_reference_link, required_arguments=required_arguments) + def download_sensitive_types_export(self, sensitive_types_export_id, download_sensitive_types_export_details, **kwargs): + """ + Downloads an already-generated file corresponding to the specified sensitive types export. + Use CreateSensitiveTypesExport to generate an XML file and then use DownloadSensitiveTypesExport + to download the generated file. + + + :param str sensitive_types_export_id: (required) + The OCID of the sensitive types export. + + :param oci.data_safe.models.DownloadSensitiveTypesExportDetails download_sensitive_types_export_details: (required) + Details to download a sensitive types export file. + + :param str opc_request_id: (optional) + Unique identifier for the request. + + :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 stream + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use download_sensitive_types_export API. + """ + # Required path and query arguments. These are in camelCase to replace values in service endpoints. + required_arguments = ['sensitiveTypesExportId'] + resource_path = "/sensitiveTypesExports/{sensitiveTypesExportId}/actions/download" + method = "POST" + operation_name = "download_sensitive_types_export" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/SensitiveTypesExport/DownloadSensitiveTypesExport" + + # 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( + f"download_sensitive_types_export got unknown kwargs: {extra_kwargs!r}") + + path_params = { + "sensitiveTypesExportId": sensitive_types_export_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(f'Parameter {k} cannot be None, whitespace or empty string') + + header_params = { + "accept": "application/octet-stream", + "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, + path_params=path_params, + header_params=header_params, + body=download_sensitive_types_export_details, + response_type="stream", + 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=download_sensitive_types_export_details, + response_type="stream", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + def download_user_assessment_report(self, user_assessment_id, download_user_assessment_report_details, **kwargs): """ Downloads the report of the specified user assessment. To download the user assessment report, it needs to be generated first. @@ -14182,6 +14947,108 @@ def get_profile(self, user_assessment_id, profile_name, **kwargs): api_reference_link=api_reference_link, required_arguments=required_arguments) + def get_referential_relation(self, sensitive_data_model_id, referential_relation_key, **kwargs): + """ + Gets the details of the specified referential relation. + + + :param str sensitive_data_model_id: (required) + The OCID of the sensitive data model. + + :param str referential_relation_key: (required) + The unique key that identifies the referential relation. It's numeric and unique within a sensitive data model. + + :param str opc_request_id: (optional) + Unique identifier for the request. + + :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.data_safe.models.ReferentialRelation` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_referential_relation API. + """ + # Required path and query arguments. These are in camelCase to replace values in service endpoints. + required_arguments = ['sensitiveDataModelId', 'referentialRelationKey'] + resource_path = "/sensitiveDataModels/{sensitiveDataModelId}/referentialRelations/{referentialRelationKey}" + method = "GET" + operation_name = "get_referential_relation" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/ReferentialRelation/GetReferentialRelation" + + # 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( + f"get_referential_relation got unknown kwargs: {extra_kwargs!r}") + + path_params = { + "sensitiveDataModelId": sensitive_data_model_id, + "referentialRelationKey": referential_relation_key + } + + 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(f'Parameter {k} cannot be None, whitespace or empty string') + + 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, + path_params=path_params, + header_params=header_params, + response_type="ReferentialRelation", + 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, + response_type="ReferentialRelation", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + def get_report(self, report_id, **kwargs): """ Gets a report by identifier @@ -15471,6 +16338,104 @@ def get_sensitive_type(self, sensitive_type_id, **kwargs): api_reference_link=api_reference_link, required_arguments=required_arguments) + def get_sensitive_types_export(self, sensitive_types_export_id, **kwargs): + """ + Gets the details of the specified sensitive types export by identifier. + + + :param str sensitive_types_export_id: (required) + The OCID of the sensitive types export. + + :param str opc_request_id: (optional) + Unique identifier for the request. + + :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.data_safe.models.SensitiveTypesExport` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_sensitive_types_export API. + """ + # Required path and query arguments. These are in camelCase to replace values in service endpoints. + required_arguments = ['sensitiveTypesExportId'] + resource_path = "/sensitiveTypesExports/{sensitiveTypesExportId}" + method = "GET" + operation_name = "get_sensitive_types_export" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/SensitiveTypesExport/GetSensitiveTypesExport" + + # 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( + f"get_sensitive_types_export got unknown kwargs: {extra_kwargs!r}") + + path_params = { + "sensitiveTypesExportId": sensitive_types_export_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(f'Parameter {k} cannot be None, whitespace or empty string') + + 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, + path_params=path_params, + header_params=header_params, + response_type="SensitiveTypesExport", + 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, + response_type="SensitiveTypesExport", + 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_collection(self, sql_collection_id, **kwargs): """ Gets a SQL collection by identifier. @@ -17262,14 +18227,14 @@ def list_audit_event_analytics(self, compartment_id, **kwargs): it in the `summaryField` query parameter. **Example:** - /ListAuditEventAnalytics?summaryField=targetName&summaryField=userName&summaryField=clientHostname + /auditEventAnalytics?summaryField=targetName&summaryField=userName&summaryField=clientHostname &summaryField=dmls&summaryField=privilegeChanges&summaryField=ddls&summaryField=loginFailure&summaryField=loginSuccess - &summaryField=allRecord&q=(auditEventTime ge \"2021-06-13T23:49:14\") + &summaryField=allRecord&scimQuery=(auditEventTime ge \"2021-06-13T23:49:14\") - /ListAuditEventAnalytics?timeStarted=2022-08-18T11:02:26.000Z&timeEnded=2022-08-24T11:02:26.000Z + /auditEventAnalytics?timeStarted=2022-08-18T11:02:26.000Z&timeEnded=2022-08-24T11:02:26.000Z This will give number of events grouped by periods. Period can be 1 day, 1 week, etc. - /ListAuditEventAnalytics?summaryField=targetName&groupBy=targetName + /auditEventAnalytics?summaryField=targetName&groupBy=targetName This will give the number of events group by targetName. Only targetName summary column would be returned. @@ -17316,7 +18281,11 @@ def list_audit_event_analytics(self, compartment_id, **kwargs): text, date, and time values must be enclosed in quotation marks, with date and time values using ISO-8601 format. (Numeric and boolean values should not be quoted.) - **Example:** (operationTime ge \"2021-06-04T12:00:00.000Z\") and (eventName eq \"LOGON\") + **Example:** (operationTime ge \"2021-06-04T01-00-26\") and (eventName eq \"LOGON\") + The attrExp or the field (for example, operationTime and eventName in above example) which is used to filter can be any of the fields returned by AuditEventSummary. + adminUser, commonUser, sensitiveActivity, dsActivity can only have eq operation and value 1. + These define admin user activity, common user activity, sensitive data activity and data safe activity + **Example:** (adminUser eq 1) __ https://tools.ietf.org/html/draft-ietf-scim-api-12 @@ -17563,7 +18532,11 @@ def list_audit_events(self, compartment_id, **kwargs): text, date, and time values must be enclosed in quotation marks, with date and time values using ISO-8601 format. (Numeric and boolean values should not be quoted.) - **Example:** (operationTime ge \"2021-06-04T12:00:00.000Z\") and (eventName eq \"LOGON\") + **Example:** (operationTime ge \"2021-06-04T01-00-26\") and (eventName eq \"LOGON\") + The attrExp or the field (for example, operationTime and eventName in above example) which is used to filter can be any of the fields returned by AuditEventSummary. + adminUser, commonUser, sensitiveActivity, dsActivity can only have eq operation and value 1. + These define admin user activity, common user activity, sensitive data activity and data safe activity + **Example:** (adminUser eq 1) __ https://tools.ietf.org/html/draft-ietf-scim-api-12 @@ -21735,7 +22708,7 @@ def list_library_masking_formats(self, compartment_id, **kwargs): The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for timeCreated is descending. The default order for displayName is ascending. The displayName sort order is case sensitive. - Allowed values are: "displayName", "timeCreated" + Allowed values are: "displayName", "timeCreated", "timeUpdated", "lifecycleState" :param str opc_request_id: (optional) Unique identifier for the request. @@ -21817,7 +22790,7 @@ def list_library_masking_formats(self, compartment_id, **kwargs): ) if 'sort_by' in kwargs: - sort_by_allowed_values = ["displayName", "timeCreated"] + sort_by_allowed_values = ["displayName", "timeCreated", "timeUpdated", "lifecycleState"] if kwargs['sort_by'] not in sort_by_allowed_values: raise ValueError( f"Invalid value for `sort_by`, must be one of { sort_by_allowed_values }" @@ -21907,7 +22880,7 @@ def list_masked_columns(self, masking_report_id, **kwargs): :param str sort_by: (optional) The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for all the fields is ascending. - Allowed values are: "schemaName", "objectName" + Allowed values are: "schemaName", "objectName", "sensitiveTypeId", "maskingColumnGroupId" :param list[str] schema_name: (optional) A filter to return only items related to specific schema name. @@ -21996,7 +22969,7 @@ def list_masked_columns(self, masking_report_id, **kwargs): ) if 'sort_by' in kwargs: - sort_by_allowed_values = ["schemaName", "objectName"] + sort_by_allowed_values = ["schemaName", "objectName", "sensitiveTypeId", "maskingColumnGroupId"] if kwargs['sort_by'] not in sort_by_allowed_values: raise ValueError( f"Invalid value for `sort_by`, must be one of { sort_by_allowed_values }" @@ -23213,181 +24186,31 @@ def list_masking_policy_health_reports(self, compartment_id, **kwargs): api_reference_link=api_reference_link, required_arguments=required_arguments) - def list_masking_reports(self, compartment_id, **kwargs): + def list_masking_policy_referential_relations(self, masking_policy_id, **kwargs): """ - Gets a list of masking reports based on the specified query parameters. - - - :param str compartment_id: (required) - A filter to return only resources that match the specified compartment OCID. - - :param int limit: (optional) - For list pagination. The maximum number of items to return per page in a paginated \"List\" call. For details about how pagination works, see `List Pagination`__. - - __ https://docs.cloud.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine - - :param str page: (optional) - For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous \"List\" call. For details about how pagination works, see `List Pagination`__. - - __ https://docs.cloud.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine - - :param str masking_policy_id: (optional) - A filter to return only the resources that match the specified masking policy OCID. - - :param str target_id: (optional) - A filter to return only items related to a specific target OCID. - - :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. You can specify only one sorting parameter (sortOrder). The default order for timeMaskingFinished is descending. - - Allowed values are: "timeMaskingFinished" - - :param str opc_request_id: (optional) - Unique identifier for the request. - - :param bool compartment_id_in_subtree: (optional) - Default is false. - When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. - - :param str access_level: (optional) - Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. - Setting this to ACCESSIBLE returns only those compartments for which the - user has INSPECT permissions directly or indirectly (permissions can be on a - resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. - - Allowed values are: "RESTRICTED", "ACCESSIBLE" - - :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.data_safe.models.MaskingReportCollection` - :rtype: :class:`~oci.response.Response` - - :example: - Click `here `__ to see an example of how to use list_masking_reports API. - """ - # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['compartmentId'] - resource_path = "/maskingReports" - method = "GET" - operation_name = "list_masking_reports" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/MaskingPolicy/ListMaskingReports" + Gets a list of referential relations present in the specified masking policy based on the specified query parameters. - # Don't accept unknown kwargs - expected_kwargs = [ - "allow_control_chars", - "retry_strategy", - "limit", - "page", - "masking_policy_id", - "target_id", - "sort_order", - "sort_by", - "opc_request_id", - "compartment_id_in_subtree", - "access_level" - ] - extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] - if extra_kwargs: - raise ValueError( - f"list_masking_reports got unknown kwargs: {extra_kwargs!r}") - if 'sort_order' in kwargs: - sort_order_allowed_values = ["ASC", "DESC"] - if kwargs['sort_order'] not in sort_order_allowed_values: - raise ValueError( - f"Invalid value for `sort_order`, must be one of { sort_order_allowed_values }" - ) - - if 'sort_by' in kwargs: - sort_by_allowed_values = ["timeMaskingFinished"] - if kwargs['sort_by'] not in sort_by_allowed_values: - raise ValueError( - f"Invalid value for `sort_by`, must be one of { sort_by_allowed_values }" - ) - - if 'access_level' in kwargs: - access_level_allowed_values = ["RESTRICTED", "ACCESSIBLE"] - if kwargs['access_level'] not in access_level_allowed_values: - raise ValueError( - f"Invalid value for `access_level`, must be one of { access_level_allowed_values }" - ) - - query_params = { - "limit": kwargs.get("limit", missing), - "page": kwargs.get("page", missing), - "maskingPolicyId": kwargs.get("masking_policy_id", missing), - "targetId": kwargs.get("target_id", missing), - "sortOrder": kwargs.get("sort_order", missing), - "sortBy": kwargs.get("sort_by", missing), - "compartmentId": compartment_id, - "compartmentIdInSubtree": kwargs.get("compartment_id_in_subtree", missing), - "accessLevel": kwargs.get("access_level", 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} + :param str masking_policy_id: (required) + The OCID of the masking policy. - 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 + :param list[str] schema_name: (optional) + A filter to return only items related to specific schema name. - 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="MaskingReportCollection", - 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="MaskingReportCollection", - allow_control_chars=kwargs.get('allow_control_chars'), - operation_name=operation_name, - api_reference_link=api_reference_link, - required_arguments=required_arguments) + :param list[str] object_name: (optional) + A filter to return only items related to a specific object name. - def list_masking_schemas(self, masking_policy_id, **kwargs): - """ - Gets a list of masking schemas present in the specified masking policy and based on the specified query parameters. + :param list[str] column_name: (optional) + A filter to return only a specific column based on column name. + :param list[str] relation_type: (optional) + A filter to return columns based on their relationship with their parent columns. If set to NONE, + it returns the columns that do not have any parent. The response includes the parent columns as + well as the independent columns that are not in any relationship. If set to APP_DEFINED, it returns all the + child columns that have application-level (non-dictionary) relationship with their parents. If set to DB_DEFINED, + it returns all the child columns that have database-level (dictionary-defined) relationship with their parents. - :param str masking_policy_id: (required) - The OCID of the masking policy. + Allowed values are: "NONE", "APP_DEFINED", "DB_DEFINED" :param int limit: (optional) For list pagination. The maximum number of items to return per page in a paginated \"List\" call. For details about how pagination works, see `List Pagination`__. @@ -23406,12 +24229,8 @@ def list_masking_schemas(self, masking_policy_id, **kwargs): :param str sort_by: (optional) The field to sort by. You can specify only one sorting parameter (sortOrder). - The default order is ascending. - - Allowed values are: "schemaName" - :param list[str] schema_name: (optional) - A filter to return only items related to specific schema name. + Allowed values are: "relationType", "schemaName", "tableName", "columnName" :param str opc_request_id: (optional) Unique identifier for the request. @@ -23428,34 +24247,37 @@ def list_masking_schemas(self, masking_policy_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.data_safe.models.MaskingSchemaCollection` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.data_safe.models.MaskingPolicyReferentialRelationCollection` :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use list_masking_schemas API. + Click `here `__ to see an example of how to use list_masking_policy_referential_relations API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. required_arguments = ['maskingPolicyId'] - resource_path = "/maskingPolicies/{maskingPolicyId}/maskingSchemas" + resource_path = "/maskingPolicies/{maskingPolicyId}/referentialRelations" method = "GET" - operation_name = "list_masking_schemas" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/MaskingSchemaCollection/ListMaskingSchemas" + operation_name = "list_masking_policy_referential_relations" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/MaskingPolicyReferentialRelationSummary/ListMaskingPolicyReferentialRelations" # Don't accept unknown kwargs expected_kwargs = [ "allow_control_chars", "retry_strategy", + "schema_name", + "object_name", + "column_name", + "relation_type", "limit", "page", "sort_order", "sort_by", - "schema_name", "opc_request_id" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"list_masking_schemas got unknown kwargs: {extra_kwargs!r}") + f"list_masking_policy_referential_relations got unknown kwargs: {extra_kwargs!r}") path_params = { "maskingPolicyId": masking_policy_id @@ -23467,6 +24289,14 @@ def list_masking_schemas(self, masking_policy_id, **kwargs): if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): raise ValueError(f'Parameter {k} cannot be None, whitespace or empty string') + if 'relation_type' in kwargs: + relation_type_allowed_values = ["NONE", "APP_DEFINED", "DB_DEFINED"] + for relation_type_item in kwargs['relation_type']: + if relation_type_item not in relation_type_allowed_values: + raise ValueError( + f"Invalid value for `relation_type`, must be one of { relation_type_allowed_values }" + ) + if 'sort_order' in kwargs: sort_order_allowed_values = ["ASC", "DESC"] if kwargs['sort_order'] not in sort_order_allowed_values: @@ -23475,18 +24305,21 @@ def list_masking_schemas(self, masking_policy_id, **kwargs): ) if 'sort_by' in kwargs: - sort_by_allowed_values = ["schemaName"] + sort_by_allowed_values = ["relationType", "schemaName", "tableName", "columnName"] if kwargs['sort_by'] not in sort_by_allowed_values: raise ValueError( f"Invalid value for `sort_by`, must be one of { sort_by_allowed_values }" ) query_params = { + "schemaName": self.base_client.generate_collection_format_param(kwargs.get("schema_name", missing), 'multi'), + "objectName": self.base_client.generate_collection_format_param(kwargs.get("object_name", missing), 'multi'), + "columnName": self.base_client.generate_collection_format_param(kwargs.get("column_name", missing), 'multi'), + "relationType": self.base_client.generate_collection_format_param(kwargs.get("relation_type", missing), 'multi'), "limit": kwargs.get("limit", missing), "page": kwargs.get("page", missing), "sortOrder": kwargs.get("sort_order", missing), - "sortBy": kwargs.get("sort_by", missing), - "schemaName": self.base_client.generate_collection_format_param(kwargs.get("schema_name", missing), 'multi') + "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} @@ -23515,7 +24348,7 @@ def list_masking_schemas(self, masking_policy_id, **kwargs): path_params=path_params, query_params=query_params, header_params=header_params, - response_type="MaskingSchemaCollection", + response_type="MaskingPolicyReferentialRelationCollection", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -23527,31 +24360,20 @@ def list_masking_schemas(self, masking_policy_id, **kwargs): path_params=path_params, query_params=query_params, header_params=header_params, - response_type="MaskingSchemaCollection", + response_type="MaskingPolicyReferentialRelationCollection", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def list_on_prem_connectors(self, compartment_id, **kwargs): + def list_masking_reports(self, compartment_id, **kwargs): """ - Gets a list of on-premises connectors. + Gets a list of masking reports based on the specified query parameters. :param str compartment_id: (required) A filter to return only resources that match the specified compartment OCID. - :param str on_prem_connector_id: (optional) - A filter to return only the on-premises connector that matches the specified id. - - :param str display_name: (optional) - A filter to return only resources that match the specified display name. - - :param str on_prem_connector_lifecycle_state: (optional) - A filter to return only on-premises connector resources that match the specified lifecycle state. - - Allowed values are: "CREATING", "UPDATING", "ACTIVE", "INACTIVE", "DELETING", "DELETED", "FAILED", "NEEDS_ATTENTION" - :param int limit: (optional) For list pagination. The maximum number of items to return per page in a paginated \"List\" call. For details about how pagination works, see `List Pagination`__. @@ -23562,17 +24384,21 @@ def list_on_prem_connectors(self, compartment_id, **kwargs): __ https://docs.cloud.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine + :param str masking_policy_id: (optional) + A filter to return only the resources that match the specified masking policy OCID. + + :param str target_id: (optional) + A filter to return only items related to a specific target OCID. + :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 used for sorting. Only one sorting order (sortOrder) can be specified. - The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending. - The DISPLAYNAME sort order is case sensitive. + The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for timeMaskingFinished is descending. - Allowed values are: "TIMECREATED", "DISPLAYNAME" + Allowed values are: "timeMaskingFinished" :param str opc_request_id: (optional) Unique identifier for the request. @@ -23601,28 +24427,27 @@ def list_on_prem_connectors(self, compartment_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 list of :class:`~oci.data_safe.models.OnPremConnectorSummary` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.data_safe.models.MaskingReportCollection` :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use list_on_prem_connectors API. + Click `here `__ to see an example of how to use list_masking_reports API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. required_arguments = ['compartmentId'] - resource_path = "/onPremConnectors" + resource_path = "/maskingReports" method = "GET" - operation_name = "list_on_prem_connectors" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/OnPremConnectorSummary/ListOnPremConnectors" + operation_name = "list_masking_reports" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/MaskingPolicy/ListMaskingReports" # Don't accept unknown kwargs expected_kwargs = [ "allow_control_chars", "retry_strategy", - "on_prem_connector_id", - "display_name", - "on_prem_connector_lifecycle_state", "limit", "page", + "masking_policy_id", + "target_id", "sort_order", "sort_by", "opc_request_id", @@ -23632,14 +24457,7 @@ def list_on_prem_connectors(self, compartment_id, **kwargs): extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"list_on_prem_connectors got unknown kwargs: {extra_kwargs!r}") - - if 'on_prem_connector_lifecycle_state' in kwargs: - on_prem_connector_lifecycle_state_allowed_values = ["CREATING", "UPDATING", "ACTIVE", "INACTIVE", "DELETING", "DELETED", "FAILED", "NEEDS_ATTENTION"] - if kwargs['on_prem_connector_lifecycle_state'] not in on_prem_connector_lifecycle_state_allowed_values: - raise ValueError( - f"Invalid value for `on_prem_connector_lifecycle_state`, must be one of { on_prem_connector_lifecycle_state_allowed_values }" - ) + f"list_masking_reports got unknown kwargs: {extra_kwargs!r}") if 'sort_order' in kwargs: sort_order_allowed_values = ["ASC", "DESC"] @@ -23649,7 +24467,7 @@ def list_on_prem_connectors(self, compartment_id, **kwargs): ) if 'sort_by' in kwargs: - sort_by_allowed_values = ["TIMECREATED", "DISPLAYNAME"] + sort_by_allowed_values = ["timeMaskingFinished"] if kwargs['sort_by'] not in sort_by_allowed_values: raise ValueError( f"Invalid value for `sort_by`, must be one of { sort_by_allowed_values }" @@ -23663,10 +24481,345 @@ def list_on_prem_connectors(self, compartment_id, **kwargs): ) query_params = { - "compartmentId": compartment_id, - "onPremConnectorId": kwargs.get("on_prem_connector_id", missing), - "displayName": kwargs.get("display_name", missing), - "onPremConnectorLifecycleState": kwargs.get("on_prem_connector_lifecycle_state", missing), + "limit": kwargs.get("limit", missing), + "page": kwargs.get("page", missing), + "maskingPolicyId": kwargs.get("masking_policy_id", missing), + "targetId": kwargs.get("target_id", missing), + "sortOrder": kwargs.get("sort_order", missing), + "sortBy": kwargs.get("sort_by", missing), + "compartmentId": compartment_id, + "compartmentIdInSubtree": kwargs.get("compartment_id_in_subtree", missing), + "accessLevel": kwargs.get("access_level", 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="MaskingReportCollection", + 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="MaskingReportCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + + def list_masking_schemas(self, masking_policy_id, **kwargs): + """ + Gets a list of masking schemas present in the specified masking policy and based on the specified query parameters. + + + :param str masking_policy_id: (required) + The OCID of the masking policy. + + :param int limit: (optional) + For list pagination. The maximum number of items to return per page in a paginated \"List\" call. For details about how pagination works, see `List Pagination`__. + + __ https://docs.cloud.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine + + :param str page: (optional) + For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous \"List\" call. For details about how pagination works, see `List Pagination`__. + + __ https://docs.cloud.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine + + :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. You can specify only one sorting parameter (sortOrder). + The default order is ascending. + + Allowed values are: "schemaName" + + :param list[str] schema_name: (optional) + A filter to return only items related to specific schema name. + + :param str opc_request_id: (optional) + Unique identifier for the request. + + :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.data_safe.models.MaskingSchemaCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_masking_schemas API. + """ + # Required path and query arguments. These are in camelCase to replace values in service endpoints. + required_arguments = ['maskingPolicyId'] + resource_path = "/maskingPolicies/{maskingPolicyId}/maskingSchemas" + method = "GET" + operation_name = "list_masking_schemas" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/MaskingSchemaCollection/ListMaskingSchemas" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "limit", + "page", + "sort_order", + "sort_by", + "schema_name", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + f"list_masking_schemas got unknown kwargs: {extra_kwargs!r}") + + path_params = { + "maskingPolicyId": masking_policy_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(f'Parameter {k} cannot be None, whitespace or empty string') + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + f"Invalid value for `sort_order`, must be one of { sort_order_allowed_values }" + ) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["schemaName"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + f"Invalid value for `sort_by`, must be one of { sort_by_allowed_values }" + ) + + query_params = { + "limit": kwargs.get("limit", missing), + "page": kwargs.get("page", missing), + "sortOrder": kwargs.get("sort_order", missing), + "sortBy": kwargs.get("sort_by", missing), + "schemaName": self.base_client.generate_collection_format_param(kwargs.get("schema_name", missing), 'multi') + } + 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, + path_params=path_params, + query_params=query_params, + header_params=header_params, + response_type="MaskingSchemaCollection", + 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="MaskingSchemaCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + + def list_on_prem_connectors(self, compartment_id, **kwargs): + """ + Gets a list of on-premises connectors. + + + :param str compartment_id: (required) + A filter to return only resources that match the specified compartment OCID. + + :param str on_prem_connector_id: (optional) + A filter to return only the on-premises connector that matches the specified id. + + :param str display_name: (optional) + A filter to return only resources that match the specified display name. + + :param str on_prem_connector_lifecycle_state: (optional) + A filter to return only on-premises connector resources that match the specified lifecycle state. + + Allowed values are: "CREATING", "UPDATING", "ACTIVE", "INACTIVE", "DELETING", "DELETED", "FAILED", "NEEDS_ATTENTION" + + :param int limit: (optional) + For list pagination. The maximum number of items to return per page in a paginated \"List\" call. For details about how pagination works, see `List Pagination`__. + + __ https://docs.cloud.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine + + :param str page: (optional) + For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous \"List\" call. For details about how pagination works, see `List Pagination`__. + + __ https://docs.cloud.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine + + :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 used for sorting. Only one sorting order (sortOrder) can be specified. + The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending. + The DISPLAYNAME sort order is case sensitive. + + Allowed values are: "TIMECREATED", "DISPLAYNAME" + + :param str opc_request_id: (optional) + Unique identifier for the request. + + :param bool compartment_id_in_subtree: (optional) + Default is false. + When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. + + :param str access_level: (optional) + Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. + Setting this to ACCESSIBLE returns only those compartments for which the + user has INSPECT permissions directly or indirectly (permissions can be on a + resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. + + Allowed values are: "RESTRICTED", "ACCESSIBLE" + + :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 list of :class:`~oci.data_safe.models.OnPremConnectorSummary` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_on_prem_connectors API. + """ + # Required path and query arguments. These are in camelCase to replace values in service endpoints. + required_arguments = ['compartmentId'] + resource_path = "/onPremConnectors" + method = "GET" + operation_name = "list_on_prem_connectors" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/OnPremConnectorSummary/ListOnPremConnectors" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "on_prem_connector_id", + "display_name", + "on_prem_connector_lifecycle_state", + "limit", + "page", + "sort_order", + "sort_by", + "opc_request_id", + "compartment_id_in_subtree", + "access_level" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + f"list_on_prem_connectors got unknown kwargs: {extra_kwargs!r}") + + if 'on_prem_connector_lifecycle_state' in kwargs: + on_prem_connector_lifecycle_state_allowed_values = ["CREATING", "UPDATING", "ACTIVE", "INACTIVE", "DELETING", "DELETED", "FAILED", "NEEDS_ATTENTION"] + if kwargs['on_prem_connector_lifecycle_state'] not in on_prem_connector_lifecycle_state_allowed_values: + raise ValueError( + f"Invalid value for `on_prem_connector_lifecycle_state`, must be one of { on_prem_connector_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( + f"Invalid value for `sort_order`, must be one of { sort_order_allowed_values }" + ) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["TIMECREATED", "DISPLAYNAME"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + f"Invalid value for `sort_by`, must be one of { sort_by_allowed_values }" + ) + + if 'access_level' in kwargs: + access_level_allowed_values = ["RESTRICTED", "ACCESSIBLE"] + if kwargs['access_level'] not in access_level_allowed_values: + raise ValueError( + f"Invalid value for `access_level`, must be one of { access_level_allowed_values }" + ) + + query_params = { + "compartmentId": compartment_id, + "onPremConnectorId": kwargs.get("on_prem_connector_id", missing), + "displayName": kwargs.get("display_name", missing), + "onPremConnectorLifecycleState": kwargs.get("on_prem_connector_lifecycle_state", missing), "limit": kwargs.get("limit", missing), "page": kwargs.get("page", missing), "sortOrder": kwargs.get("sort_order", missing), @@ -23717,6 +24870,156 @@ def list_on_prem_connectors(self, compartment_id, **kwargs): api_reference_link=api_reference_link, required_arguments=required_arguments) + def list_password_expiry_date_analytics(self, user_assessment_id, **kwargs): + """ + Gets a list of count of the users with password expiry dates in next 30 days, between next 30-90 days, and beyond 90 days based on specified user assessment. + It internally uses the aforementioned userAnalytics api. + + When you perform the ListPasswordExpiryDateAnalytics operation, if the parameter compartmentIdInSubtree is set to \"true,\" and if the + parameter accessLevel is set to ACCESSIBLE, then the operation returns compartments in which the requestor has READ + permissions on at least one resource, directly or indirectly (in subcompartments). If the operation is performed at the + root compartment and the requestor does not have access to at least one subcompartment of the compartment specified by + compartmentId, then \"Not Authorized\" is returned. + + To use ListPasswordExpiryDateAnalytics to get a full list of all compartments and subcompartments in the tenancy from the root compartment, + set the parameter compartmentIdInSubtree to true and accessLevel to ACCESSIBLE. + + + :param str user_assessment_id: (required) + The OCID of the user assessment. + + :param bool compartment_id_in_subtree: (optional) + Default is false. + When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. + + :param str access_level: (optional) + Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. + Setting this to ACCESSIBLE returns only those compartments for which the + user has INSPECT permissions directly or indirectly (permissions can be on a + resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. + + Allowed values are: "RESTRICTED", "ACCESSIBLE" + + :param str user_category: (optional) + A filter to return only items that match the specified user category. + + :param datetime time_password_expiry_less_than: (optional) + A filter to return users whose password expiry date in the database is less than the date and time specified, in the format defined by `RFC3339`__. + **Example:** 2016-12-19T16:39:57.600Z + + __ https://tools.ietf.org/html/rfc3339 + + :param str opc_request_id: (optional) + Unique identifier for the request. + + :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 list of :class:`~oci.data_safe.models.UserAggregation` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_password_expiry_date_analytics API. + """ + # Required path and query arguments. These are in camelCase to replace values in service endpoints. + required_arguments = ['userAssessmentId'] + resource_path = "/userAssessments/{userAssessmentId}/passwordExpiryDateAnalytics" + method = "GET" + operation_name = "list_password_expiry_date_analytics" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/UserAssessment/ListPasswordExpiryDateAnalytics" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "compartment_id_in_subtree", + "access_level", + "user_category", + "time_password_expiry_less_than", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + f"list_password_expiry_date_analytics got unknown kwargs: {extra_kwargs!r}") + + path_params = { + "userAssessmentId": user_assessment_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(f'Parameter {k} cannot be None, whitespace or empty string') + + if 'access_level' in kwargs: + access_level_allowed_values = ["RESTRICTED", "ACCESSIBLE"] + if kwargs['access_level'] not in access_level_allowed_values: + raise ValueError( + f"Invalid value for `access_level`, must be one of { access_level_allowed_values }" + ) + + query_params = { + "compartmentIdInSubtree": kwargs.get("compartment_id_in_subtree", missing), + "accessLevel": kwargs.get("access_level", missing), + "userCategory": kwargs.get("user_category", missing), + "timePasswordExpiryLessThan": kwargs.get("time_password_expiry_less_than", 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, + path_params=path_params, + query_params=query_params, + header_params=header_params, + response_type="list[UserAggregation]", + 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="list[UserAggregation]", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + def list_peer_target_databases(self, target_database_id, **kwargs): """ Lists all the peer target databases under the primary target database identified by the OCID passed as path parameter. @@ -24317,6 +25620,192 @@ def list_profile_summaries(self, user_assessment_id, compartment_id, **kwargs): api_reference_link=api_reference_link, required_arguments=required_arguments) + def list_referential_relations(self, sensitive_data_model_id, **kwargs): + """ + Gets a list of referential relations present in the specified sensitive data model based on the specified query parameters. + + + :param str sensitive_data_model_id: (required) + The OCID of the sensitive data model. + + :param list[str] schema_name: (optional) + A filter to return only items related to specific schema name. + + :param list[str] object_name: (optional) + A filter to return only items related to a specific object name. + + :param list[str] column_name: (optional) + A filter to return only a specific column based on column name. + + :param bool is_sensitive: (optional) + Returns referential relations containing sensitive columns when true. + Returns referential relations containing non sensitive columns when false. + + :param list[str] relation_type: (optional) + A filter to return sensitive columns based on their relationship with their parent columns. If set to NONE, + it returns the sensitive columns that do not have any parent. The response includes the parent columns as + well as the independent columns that are not in any relationship. If set to APP_DEFINED, it returns all the + child columns that have application-level (non-dictionary) relationship with their parents. If set to DB_DEFINED, + it returns all the child columns that have database-level (dictionary-defined) relationship with their parents. + + Allowed values are: "NONE", "APP_DEFINED", "DB_DEFINED" + + :param int limit: (optional) + For list pagination. The maximum number of items to return per page in a paginated \"List\" call. For details about how pagination works, see `List Pagination`__. + + __ https://docs.cloud.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine + + :param str page: (optional) + For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous \"List\" call. For details about how pagination works, see `List Pagination`__. + + __ https://docs.cloud.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine + + :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. You can specify only one sorting parameter (sortOrder). The default order for key is descending. + + Allowed values are: "key", "relationType", "schemaName", "tableName" + + :param str opc_request_id: (optional) + Unique identifier for the request. + + :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.data_safe.models.ReferentialRelationCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_referential_relations API. + """ + # Required path and query arguments. These are in camelCase to replace values in service endpoints. + required_arguments = ['sensitiveDataModelId'] + resource_path = "/sensitiveDataModels/{sensitiveDataModelId}/referentialRelations" + method = "GET" + operation_name = "list_referential_relations" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/ReferentialRelation/ListReferentialRelations" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "schema_name", + "object_name", + "column_name", + "is_sensitive", + "relation_type", + "limit", + "page", + "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( + f"list_referential_relations got unknown kwargs: {extra_kwargs!r}") + + path_params = { + "sensitiveDataModelId": sensitive_data_model_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(f'Parameter {k} cannot be None, whitespace or empty string') + + if 'relation_type' in kwargs: + relation_type_allowed_values = ["NONE", "APP_DEFINED", "DB_DEFINED"] + for relation_type_item in kwargs['relation_type']: + if relation_type_item not in relation_type_allowed_values: + raise ValueError( + f"Invalid value for `relation_type`, must be one of { relation_type_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( + f"Invalid value for `sort_order`, must be one of { sort_order_allowed_values }" + ) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["key", "relationType", "schemaName", "tableName"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + f"Invalid value for `sort_by`, must be one of { sort_by_allowed_values }" + ) + + query_params = { + "schemaName": self.base_client.generate_collection_format_param(kwargs.get("schema_name", missing), 'multi'), + "objectName": self.base_client.generate_collection_format_param(kwargs.get("object_name", missing), 'multi'), + "columnName": self.base_client.generate_collection_format_param(kwargs.get("column_name", missing), 'multi'), + "isSensitive": kwargs.get("is_sensitive", missing), + "relationType": self.base_client.generate_collection_format_param(kwargs.get("relation_type", missing), 'multi'), + "limit": kwargs.get("limit", missing), + "page": kwargs.get("page", 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, + path_params=path_params, + query_params=query_params, + header_params=header_params, + response_type="ReferentialRelationCollection", + 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="ReferentialRelationCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + def list_report_definitions(self, compartment_id, **kwargs): """ Gets a list of report definitions. @@ -27632,7 +29121,159 @@ def list_sensitive_objects(self, sensitive_data_model_id, **kwargs): path_params=path_params, query_params=query_params, header_params=header_params, - response_type="SensitiveObjectCollection", + response_type="SensitiveObjectCollection", + 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="SensitiveObjectCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + + def list_sensitive_schemas(self, sensitive_data_model_id, **kwargs): + """ + Gets a list of sensitive schemas present in the specified sensitive data model based on the specified query parameters. + + + :param str sensitive_data_model_id: (required) + The OCID of the sensitive data model. + + :param list[str] schema_name: (optional) + A filter to return only items related to specific schema name. + + :param int limit: (optional) + For list pagination. The maximum number of items to return per page in a paginated \"List\" call. For details about how pagination works, see `List Pagination`__. + + __ https://docs.cloud.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine + + :param str page: (optional) + For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous \"List\" call. For details about how pagination works, see `List Pagination`__. + + __ https://docs.cloud.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine + + :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. You can specify only one sorting parameter (sortOrder). + The default order is ascending. + + Allowed values are: "schemaName" + + :param str opc_request_id: (optional) + Unique identifier for the request. + + :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.data_safe.models.SensitiveSchemaCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_sensitive_schemas API. + """ + # Required path and query arguments. These are in camelCase to replace values in service endpoints. + required_arguments = ['sensitiveDataModelId'] + resource_path = "/sensitiveDataModels/{sensitiveDataModelId}/sensitiveSchemas" + method = "GET" + operation_name = "list_sensitive_schemas" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/SensitiveSchemaCollection/ListSensitiveSchemas" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "schema_name", + "limit", + "page", + "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( + f"list_sensitive_schemas got unknown kwargs: {extra_kwargs!r}") + + path_params = { + "sensitiveDataModelId": sensitive_data_model_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(f'Parameter {k} cannot be None, whitespace or empty string') + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + f"Invalid value for `sort_order`, must be one of { sort_order_allowed_values }" + ) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["schemaName"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + f"Invalid value for `sort_by`, must be one of { sort_by_allowed_values }" + ) + + query_params = { + "schemaName": self.base_client.generate_collection_format_param(kwargs.get("schema_name", missing), 'multi'), + "limit": kwargs.get("limit", missing), + "page": kwargs.get("page", 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, + path_params=path_params, + query_params=query_params, + header_params=header_params, + response_type="SensitiveSchemaCollection", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -27644,32 +29285,70 @@ def list_sensitive_objects(self, sensitive_data_model_id, **kwargs): path_params=path_params, query_params=query_params, header_params=header_params, - response_type="SensitiveObjectCollection", + response_type="SensitiveSchemaCollection", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def list_sensitive_schemas(self, sensitive_data_model_id, **kwargs): + def list_sensitive_types(self, compartment_id, **kwargs): """ - Gets a list of sensitive schemas present in the specified sensitive data model based on the specified query parameters. + Gets a list of sensitive types based on the specified query parameters. - :param str sensitive_data_model_id: (required) - The OCID of the sensitive data model. + :param str compartment_id: (required) + A filter to return only resources that match the specified compartment OCID. - :param list[str] schema_name: (optional) - A filter to return only items related to specific schema name. + :param bool compartment_id_in_subtree: (optional) + Default is false. + When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. - :param int limit: (optional) - For list pagination. The maximum number of items to return per page in a paginated \"List\" call. For details about how pagination works, see `List Pagination`__. + :param str access_level: (optional) + Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. + Setting this to ACCESSIBLE returns only those compartments for which the + user has INSPECT permissions directly or indirectly (permissions can be on a + resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. - __ https://docs.cloud.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine + Allowed values are: "RESTRICTED", "ACCESSIBLE" - :param str page: (optional) - For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous \"List\" call. For details about how pagination works, see `List Pagination`__. + :param str display_name: (optional) + A filter to return only resources that match the specified display name. - __ https://docs.cloud.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine + :param str sensitive_type_id: (optional) + A filter to return only items related to a specific sensitive type OCID. + + :param str sensitive_type_source: (optional) + A filter to return the sensitive type resources based on the value of their source attribute. + + Allowed values are: "ORACLE", "USER" + + :param str entity_type: (optional) + A filter to return the sensitive type resources based on the value of their entityType attribute. + + Allowed values are: "SENSITIVE_TYPE", "SENSITIVE_CATEGORY" + + :param str parent_category_id: (optional) + A filter to return only the sensitive types that are children of the sensitive category identified by the specified OCID. + + :param str default_masking_format_id: (optional) + A filter to return only the sensitive types that have the default masking format identified by the specified OCID. + + :param datetime time_created_greater_than_or_equal_to: (optional) + A filter to return only the resources that were created after the specified date and time, as defined by `RFC3339`__. + Using TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date. + + **Example:** 2016-12-19T16:39:57.600Z + + __ https://tools.ietf.org/html/rfc3339 + + :param datetime time_created_less_than: (optional) + Search for resources that were created before a specific date. + Specifying this parameter corresponding `timeCreatedLessThan` + parameter will retrieve all resources created before the + specified created date, in \"YYYY-MM-ddThh:mmZ\" format with a Z offset, as + defined by RFC 3339. + + **Example:** 2016-12-19T16:39:57.600Z :param str sort_order: (optional) The sort order to use, either ascending (ASC) or descending (DESC). @@ -27677,14 +29356,33 @@ def list_sensitive_schemas(self, sensitive_data_model_id, **kwargs): Allowed values are: "ASC", "DESC" :param str sort_by: (optional) - The field to sort by. You can specify only one sorting parameter (sortOrder). - The default order is ascending. + The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for timeCreated is descending. + The default order for displayName is ascending. - Allowed values are: "schemaName" + Allowed values are: "timeCreated", "displayName" :param str opc_request_id: (optional) Unique identifier for the request. + :param int limit: (optional) + For list pagination. The maximum number of items to return per page in a paginated \"List\" call. For details about how pagination works, see `List Pagination`__. + + __ https://docs.cloud.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine + + :param str page: (optional) + For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous \"List\" call. For details about how pagination works, see `List Pagination`__. + + __ https://docs.cloud.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine + + :param str lifecycle_state: (optional) + A filter to return only the resources that match the specified lifecycle state. + + Allowed values are: "CREATING", "ACTIVE", "UPDATING", "DELETING", "DELETED", "FAILED" + + :param bool is_common: (optional) + A filter to return only the common sensitive type resources. Common sensitive types belong to + library sensitive types which are frequently used to perform sensitive data discovery. + :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. @@ -27697,44 +29395,66 @@ def list_sensitive_schemas(self, sensitive_data_model_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.data_safe.models.SensitiveSchemaCollection` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.data_safe.models.SensitiveTypeCollection` :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use list_sensitive_schemas API. + Click `here `__ to see an example of how to use list_sensitive_types API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['sensitiveDataModelId'] - resource_path = "/sensitiveDataModels/{sensitiveDataModelId}/sensitiveSchemas" + required_arguments = ['compartmentId'] + resource_path = "/sensitiveTypes" method = "GET" - operation_name = "list_sensitive_schemas" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/SensitiveSchemaCollection/ListSensitiveSchemas" + operation_name = "list_sensitive_types" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/SensitiveType/ListSensitiveTypes" # Don't accept unknown kwargs expected_kwargs = [ "allow_control_chars", "retry_strategy", - "schema_name", - "limit", - "page", + "compartment_id_in_subtree", + "access_level", + "display_name", + "sensitive_type_id", + "sensitive_type_source", + "entity_type", + "parent_category_id", + "default_masking_format_id", + "time_created_greater_than_or_equal_to", + "time_created_less_than", "sort_order", "sort_by", - "opc_request_id" + "opc_request_id", + "limit", + "page", + "lifecycle_state", + "is_common" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"list_sensitive_schemas got unknown kwargs: {extra_kwargs!r}") + f"list_sensitive_types got unknown kwargs: {extra_kwargs!r}") - path_params = { - "sensitiveDataModelId": sensitive_data_model_id - } + if 'access_level' in kwargs: + access_level_allowed_values = ["RESTRICTED", "ACCESSIBLE"] + if kwargs['access_level'] not in access_level_allowed_values: + raise ValueError( + f"Invalid value for `access_level`, must be one of { access_level_allowed_values }" + ) - path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + if 'sensitive_type_source' in kwargs: + sensitive_type_source_allowed_values = ["ORACLE", "USER"] + if kwargs['sensitive_type_source'] not in sensitive_type_source_allowed_values: + raise ValueError( + f"Invalid value for `sensitive_type_source`, must be one of { sensitive_type_source_allowed_values }" + ) - 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(f'Parameter {k} cannot be None, whitespace or empty string') + if 'entity_type' in kwargs: + entity_type_allowed_values = ["SENSITIVE_TYPE", "SENSITIVE_CATEGORY"] + if kwargs['entity_type'] not in entity_type_allowed_values: + raise ValueError( + f"Invalid value for `entity_type`, must be one of { entity_type_allowed_values }" + ) if 'sort_order' in kwargs: sort_order_allowed_values = ["ASC", "DESC"] @@ -27744,18 +29464,37 @@ def list_sensitive_schemas(self, sensitive_data_model_id, **kwargs): ) if 'sort_by' in kwargs: - sort_by_allowed_values = ["schemaName"] + sort_by_allowed_values = ["timeCreated", "displayName"] if kwargs['sort_by'] not in sort_by_allowed_values: raise ValueError( f"Invalid value for `sort_by`, must be one of { sort_by_allowed_values }" ) + if 'lifecycle_state' in kwargs: + lifecycle_state_allowed_values = ["CREATING", "ACTIVE", "UPDATING", "DELETING", "DELETED", "FAILED"] + if kwargs['lifecycle_state'] not in lifecycle_state_allowed_values: + raise ValueError( + f"Invalid value for `lifecycle_state`, must be one of { lifecycle_state_allowed_values }" + ) + query_params = { - "schemaName": self.base_client.generate_collection_format_param(kwargs.get("schema_name", missing), 'multi'), + "compartmentId": compartment_id, + "compartmentIdInSubtree": kwargs.get("compartment_id_in_subtree", missing), + "accessLevel": kwargs.get("access_level", missing), + "displayName": kwargs.get("display_name", missing), + "sensitiveTypeId": kwargs.get("sensitive_type_id", missing), + "sensitiveTypeSource": kwargs.get("sensitive_type_source", missing), + "entityType": kwargs.get("entity_type", missing), + "parentCategoryId": kwargs.get("parent_category_id", missing), + "defaultMaskingFormatId": kwargs.get("default_masking_format_id", missing), + "timeCreatedGreaterThanOrEqualTo": kwargs.get("time_created_greater_than_or_equal_to", missing), + "timeCreatedLessThan": kwargs.get("time_created_less_than", missing), + "sortOrder": kwargs.get("sort_order", missing), + "sortBy": kwargs.get("sort_by", missing), "limit": kwargs.get("limit", missing), "page": kwargs.get("page", missing), - "sortOrder": kwargs.get("sort_order", missing), - "sortBy": kwargs.get("sort_by", missing) + "lifecycleState": kwargs.get("lifecycle_state", missing), + "isCommon": kwargs.get("is_common", missing) } query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} @@ -27781,10 +29520,9 @@ def list_sensitive_schemas(self, sensitive_data_model_id, **kwargs): 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="SensitiveSchemaCollection", + response_type="SensitiveTypeCollection", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -27793,18 +29531,18 @@ def list_sensitive_schemas(self, sensitive_data_model_id, **kwargs): 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="SensitiveSchemaCollection", + response_type="SensitiveTypeCollection", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def list_sensitive_types(self, compartment_id, **kwargs): + def list_sensitive_types_exports(self, compartment_id, **kwargs): """ - Gets a list of sensitive types based on the specified query parameters. + Retrieves a list of all sensitive types export in Data Safe based on the specified query parameters. + The ListSensitiveTypesExports operation returns only the sensitive types export in the specified `compartmentId`. :param str compartment_id: (required) @@ -27825,24 +29563,23 @@ def list_sensitive_types(self, compartment_id, **kwargs): :param str display_name: (optional) A filter to return only resources that match the specified display name. - :param str sensitive_type_id: (optional) - A filter to return only items related to a specific sensitive type OCID. + :param int limit: (optional) + For list pagination. The maximum number of items to return per page in a paginated \"List\" call. For details about how pagination works, see `List Pagination`__. - :param str sensitive_type_source: (optional) - A filter to return the sensitive type resources based on the value of their source attribute. + __ https://docs.cloud.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine - Allowed values are: "ORACLE", "USER" + :param str page: (optional) + For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous \"List\" call. For details about how pagination works, see `List Pagination`__. - :param str entity_type: (optional) - A filter to return the sensitive type resources based on the value of their entityType attribute. + __ https://docs.cloud.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine - Allowed values are: "SENSITIVE_TYPE", "SENSITIVE_CATEGORY" + :param str lifecycle_state: (optional) + A filter to return only the resources that match the specified lifecycle state. - :param str parent_category_id: (optional) - A filter to return only the sensitive types that are children of the sensitive category identified by the specified OCID. + Allowed values are: "CREATING", "ACTIVE", "UPDATING", "DELETING", "DELETED", "FAILED" - :param str default_masking_format_id: (optional) - A filter to return only the sensitive types that have the default masking format identified by the specified OCID. + :param str sensitive_types_export_id: (optional) + An optional filter to return only resources that match the specified OCID of the sensitive types export resource. :param datetime time_created_greater_than_or_equal_to: (optional) A filter to return only the resources that were created after the specified date and time, as defined by `RFC3339`__. @@ -27867,33 +29604,15 @@ def list_sensitive_types(self, compartment_id, **kwargs): Allowed values are: "ASC", "DESC" :param str sort_by: (optional) - The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for timeCreated is descending. - The default order for displayName is ascending. + The field used for sorting. Only one sorting order (sortOrder) can be specified. + The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending. + The DISPLAYNAME sort order is case sensitive. - Allowed values are: "timeCreated", "displayName" + Allowed values are: "TIMECREATED", "DISPLAYNAME" :param str opc_request_id: (optional) Unique identifier for the request. - :param int limit: (optional) - For list pagination. The maximum number of items to return per page in a paginated \"List\" call. For details about how pagination works, see `List Pagination`__. - - __ https://docs.cloud.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine - - :param str page: (optional) - For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous \"List\" call. For details about how pagination works, see `List Pagination`__. - - __ https://docs.cloud.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine - - :param str lifecycle_state: (optional) - A filter to return only the resources that match the specified lifecycle state. - - Allowed values are: "CREATING", "ACTIVE", "UPDATING", "DELETING", "DELETED", "FAILED" - - :param bool is_common: (optional) - A filter to return only the common sensitive type resources. Common sensitive types belong to - library sensitive types which are frequently used to perform sensitive data discovery. - :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. @@ -27906,18 +29625,18 @@ def list_sensitive_types(self, compartment_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.data_safe.models.SensitiveTypeCollection` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.data_safe.models.SensitiveTypesExportCollection` :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use list_sensitive_types API. + Click `here `__ to see an example of how to use list_sensitive_types_exports API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. required_arguments = ['compartmentId'] - resource_path = "/sensitiveTypes" + resource_path = "/sensitiveTypesExports" method = "GET" - operation_name = "list_sensitive_types" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/SensitiveType/ListSensitiveTypes" + operation_name = "list_sensitive_types_exports" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/SensitiveTypesExportCollection/ListSensitiveTypesExports" # Don't accept unknown kwargs expected_kwargs = [ @@ -27926,25 +29645,20 @@ def list_sensitive_types(self, compartment_id, **kwargs): "compartment_id_in_subtree", "access_level", "display_name", - "sensitive_type_id", - "sensitive_type_source", - "entity_type", - "parent_category_id", - "default_masking_format_id", + "limit", + "page", + "lifecycle_state", + "sensitive_types_export_id", "time_created_greater_than_or_equal_to", "time_created_less_than", "sort_order", "sort_by", - "opc_request_id", - "limit", - "page", - "lifecycle_state", - "is_common" + "opc_request_id" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"list_sensitive_types got unknown kwargs: {extra_kwargs!r}") + f"list_sensitive_types_exports got unknown kwargs: {extra_kwargs!r}") if 'access_level' in kwargs: access_level_allowed_values = ["RESTRICTED", "ACCESSIBLE"] @@ -27953,18 +29667,11 @@ def list_sensitive_types(self, compartment_id, **kwargs): f"Invalid value for `access_level`, must be one of { access_level_allowed_values }" ) - if 'sensitive_type_source' in kwargs: - sensitive_type_source_allowed_values = ["ORACLE", "USER"] - if kwargs['sensitive_type_source'] not in sensitive_type_source_allowed_values: - raise ValueError( - f"Invalid value for `sensitive_type_source`, must be one of { sensitive_type_source_allowed_values }" - ) - - if 'entity_type' in kwargs: - entity_type_allowed_values = ["SENSITIVE_TYPE", "SENSITIVE_CATEGORY"] - if kwargs['entity_type'] not in entity_type_allowed_values: + if 'lifecycle_state' in kwargs: + lifecycle_state_allowed_values = ["CREATING", "ACTIVE", "UPDATING", "DELETING", "DELETED", "FAILED"] + if kwargs['lifecycle_state'] not in lifecycle_state_allowed_values: raise ValueError( - f"Invalid value for `entity_type`, must be one of { entity_type_allowed_values }" + f"Invalid value for `lifecycle_state`, must be one of { lifecycle_state_allowed_values }" ) if 'sort_order' in kwargs: @@ -27975,37 +29682,25 @@ def list_sensitive_types(self, compartment_id, **kwargs): ) if 'sort_by' in kwargs: - sort_by_allowed_values = ["timeCreated", "displayName"] + sort_by_allowed_values = ["TIMECREATED", "DISPLAYNAME"] if kwargs['sort_by'] not in sort_by_allowed_values: raise ValueError( f"Invalid value for `sort_by`, must be one of { sort_by_allowed_values }" ) - if 'lifecycle_state' in kwargs: - lifecycle_state_allowed_values = ["CREATING", "ACTIVE", "UPDATING", "DELETING", "DELETED", "FAILED"] - if kwargs['lifecycle_state'] not in lifecycle_state_allowed_values: - raise ValueError( - f"Invalid value for `lifecycle_state`, must be one of { lifecycle_state_allowed_values }" - ) - query_params = { "compartmentId": compartment_id, "compartmentIdInSubtree": kwargs.get("compartment_id_in_subtree", missing), "accessLevel": kwargs.get("access_level", missing), "displayName": kwargs.get("display_name", missing), - "sensitiveTypeId": kwargs.get("sensitive_type_id", missing), - "sensitiveTypeSource": kwargs.get("sensitive_type_source", missing), - "entityType": kwargs.get("entity_type", missing), - "parentCategoryId": kwargs.get("parent_category_id", missing), - "defaultMaskingFormatId": kwargs.get("default_masking_format_id", missing), - "timeCreatedGreaterThanOrEqualTo": kwargs.get("time_created_greater_than_or_equal_to", missing), - "timeCreatedLessThan": kwargs.get("time_created_less_than", missing), - "sortOrder": kwargs.get("sort_order", missing), - "sortBy": kwargs.get("sort_by", missing), "limit": kwargs.get("limit", missing), "page": kwargs.get("page", missing), "lifecycleState": kwargs.get("lifecycle_state", missing), - "isCommon": kwargs.get("is_common", missing) + "sensitiveTypesExportId": kwargs.get("sensitive_types_export_id", missing), + "timeCreatedGreaterThanOrEqualTo": kwargs.get("time_created_greater_than_or_equal_to", missing), + "timeCreatedLessThan": kwargs.get("time_created_less_than", 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} @@ -28033,7 +29728,7 @@ def list_sensitive_types(self, compartment_id, **kwargs): method=method, query_params=query_params, header_params=header_params, - response_type="SensitiveTypeCollection", + response_type="SensitiveTypesExportCollection", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -28044,7 +29739,7 @@ def list_sensitive_types(self, compartment_id, **kwargs): method=method, query_params=query_params, header_params=header_params, - response_type="SensitiveTypeCollection", + response_type="SensitiveTypesExportCollection", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -30551,7 +32246,7 @@ def list_user_analytics(self, user_assessment_id, **kwargs): the critical category. This data is especially useful content for dashboards or to support analytics. When you perform the ListUserAnalytics operation, if the parameter compartmentIdInSubtree is set to \"true,\" and if the - parameter accessLevel is set to ACCESSIBLE, then the operation returns compartments in which the requestor has INSPECT + parameter accessLevel is set to ACCESSIBLE, then the operation returns compartments in which the requestor has READ permissions on at least one resource, directly or indirectly (in subcompartments). If the operation is performed at the root compartment and the requestor does not have access to at least one subcompartment of the compartment specified by compartmentId, then \"Not Authorized\" is returned. @@ -30640,6 +32335,18 @@ def list_user_analytics(self, user_assessment_id, **kwargs): __ https://tools.ietf.org/html/rfc3339 + :param datetime time_password_expiry_greater_than_or_equal_to: (optional) + A filter to return users whose password expiry date in the database is greater than or equal to the date and time specified, in the format defined by `RFC3339`__. + **Example:** 2016-12-19T16:39:57.600Z + + __ https://tools.ietf.org/html/rfc3339 + + :param datetime time_password_expiry_less_than: (optional) + A filter to return users whose password expiry date in the database is less than the date and time specified, in the format defined by `RFC3339`__. + **Example:** 2016-12-19T16:39:57.600Z + + __ https://tools.ietf.org/html/rfc3339 + :param str page: (optional) For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous \"List\" call. For details about how pagination works, see `List Pagination`__. @@ -30702,6 +32409,8 @@ def list_user_analytics(self, user_assessment_id, **kwargs): "time_user_created_less_than", "time_password_last_changed_greater_than_or_equal_to", "time_password_last_changed_less_than", + "time_password_expiry_greater_than_or_equal_to", + "time_password_expiry_less_than", "page", "sort_order", "sort_by", @@ -30759,6 +32468,8 @@ def list_user_analytics(self, user_assessment_id, **kwargs): "timeUserCreatedLessThan": kwargs.get("time_user_created_less_than", missing), "timePasswordLastChangedGreaterThanOrEqualTo": kwargs.get("time_password_last_changed_greater_than_or_equal_to", missing), "timePasswordLastChangedLessThan": kwargs.get("time_password_last_changed_less_than", missing), + "timePasswordExpiryGreaterThanOrEqualTo": kwargs.get("time_password_expiry_greater_than_or_equal_to", missing), + "timePasswordExpiryLessThan": kwargs.get("time_password_expiry_less_than", missing), "page": kwargs.get("page", missing), "sortOrder": kwargs.get("sort_order", missing), "sortBy": kwargs.get("sort_by", missing) @@ -31168,6 +32879,18 @@ def list_users(self, user_assessment_id, **kwargs): __ https://tools.ietf.org/html/rfc3339 + :param datetime time_password_expiry_greater_than_or_equal_to: (optional) + A filter to return users whose password expiry date in the database is greater than or equal to the date and time specified, in the format defined by `RFC3339`__. + **Example:** 2016-12-19T16:39:57.600Z + + __ https://tools.ietf.org/html/rfc3339 + + :param datetime time_password_expiry_less_than: (optional) + A filter to return users whose password expiry date in the database is less than the date and time specified, in the format defined by `RFC3339`__. + **Example:** 2016-12-19T16:39:57.600Z + + __ https://tools.ietf.org/html/rfc3339 + :param str page: (optional) For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous \"List\" call. For details about how pagination works, see `List Pagination`__. @@ -31239,6 +32962,8 @@ def list_users(self, user_assessment_id, **kwargs): "time_user_created_less_than", "time_password_last_changed_greater_than_or_equal_to", "time_password_last_changed_less_than", + "time_password_expiry_greater_than_or_equal_to", + "time_password_expiry_less_than", "page", "sort_order", "sort_by", @@ -31301,6 +33026,8 @@ def list_users(self, user_assessment_id, **kwargs): "timeUserCreatedLessThan": kwargs.get("time_user_created_less_than", missing), "timePasswordLastChangedGreaterThanOrEqualTo": kwargs.get("time_password_last_changed_greater_than_or_equal_to", missing), "timePasswordLastChangedLessThan": kwargs.get("time_password_last_changed_less_than", missing), + "timePasswordExpiryGreaterThanOrEqualTo": kwargs.get("time_password_expiry_greater_than_or_equal_to", missing), + "timePasswordExpiryLessThan": kwargs.get("time_password_expiry_less_than", missing), "page": kwargs.get("page", missing), "sortOrder": kwargs.get("sort_order", missing), "sortBy": kwargs.get("sort_by", missing), @@ -34931,15 +36658,260 @@ def suspend_work_request(self, work_request_id, **kwargs): api_reference_link=api_reference_link, required_arguments=required_arguments) - def unset_security_assessment_baseline(self, security_assessment_id, **kwargs): + def unset_security_assessment_baseline(self, security_assessment_id, **kwargs): + """ + Removes the baseline setting for the saved security assessment associated with the targetId passed via body. + If no body or empty body is passed then the baseline settings of all the saved security assessments pertaining to the baseline assessment OCID provided in the path will be removed. + Sets the if-match parameter to the value of the etag from a previous GET or POST response for that resource. + + + :param str security_assessment_id: (required) + The OCID of the security assessment. + + :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_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 identifier for the request. + + :param oci.data_safe.models.UnsetSecurityAssessmentBaselineDetails unset_security_assessment_baseline_details: (optional) + Details of the target associated with the security assessment for which the user intents to unset the baseline. + + :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 unset_security_assessment_baseline API. + """ + # Required path and query arguments. These are in camelCase to replace values in service endpoints. + required_arguments = ['securityAssessmentId'] + resource_path = "/securityAssessments/{securityAssessmentId}/actions/unsetBaseline" + method = "POST" + operation_name = "unset_security_assessment_baseline" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/SecurityAssessment/UnsetSecurityAssessmentBaseline" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "if_match", + "opc_retry_token", + "opc_request_id", + "unset_security_assessment_baseline_details" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + f"unset_security_assessment_baseline got unknown kwargs: {extra_kwargs!r}") + + path_params = { + "securityAssessmentId": security_assessment_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(f'Parameter {k} cannot be None, whitespace or empty string') + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "if-match": kwargs.get("if_match", missing), + "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, + path_params=path_params, + header_params=header_params, + body=kwargs.get('unset_security_assessment_baseline_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=kwargs.get('unset_security_assessment_baseline_details'), + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + + def unset_user_assessment_baseline(self, user_assessment_id, **kwargs): + """ + Removes the baseline setting for the saved user assessment associated with the targetId passed via body. + If no body or empty body is passed then the baseline settings of all the saved user assessments pertaining to the baseline assessment OCID provided in the path will be removed. + Sets the if-match parameter to the value of the etag from a previous GET or POST response for that resource. + + + :param str user_assessment_id: (required) + The OCID of the user assessment. + + :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_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 identifier for the request. + + :param oci.data_safe.models.UnsetUserAssessmentBaselineDetails unset_user_assessment_baseline_details: (optional) + Details of the target associated with the user assessment for which the user intents to unset the baseline. + + :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 unset_user_assessment_baseline API. + """ + # Required path and query arguments. These are in camelCase to replace values in service endpoints. + required_arguments = ['userAssessmentId'] + resource_path = "/userAssessments/{userAssessmentId}/actions/unsetBaseline" + method = "POST" + operation_name = "unset_user_assessment_baseline" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/UserAssessment/UnsetUserAssessmentBaseline" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "if_match", + "opc_retry_token", + "opc_request_id", + "unset_user_assessment_baseline_details" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + f"unset_user_assessment_baseline got unknown kwargs: {extra_kwargs!r}") + + path_params = { + "userAssessmentId": user_assessment_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(f'Parameter {k} cannot be None, whitespace or empty string') + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "if-match": kwargs.get("if_match", missing), + "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, + path_params=path_params, + header_params=header_params, + body=kwargs.get('unset_user_assessment_baseline_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=kwargs.get('unset_user_assessment_baseline_details'), + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + + def update_alert(self, alert_id, update_alert_details, **kwargs): """ - Removes the baseline setting for the saved security assessment associated with the targetId passed via body. - If no body or empty body is passed then the baseline settings of all the saved security assessments pertaining to the baseline assessment OCID provided in the path will be removed. - Sets the if-match parameter to the value of the etag from a previous GET or POST response for that resource. + Updates the status of the specified alert. - :param str security_assessment_id: (required) - The OCID of the security assessment. + :param str alert_id: (required) + The OCID of alert. + + :param oci.data_safe.models.UpdateAlertDetails update_alert_details: (required) + The details used to update alert status. :param str if_match: (optional) For optimistic concurrency control. In the PUT or DELETE call @@ -34948,18 +36920,9 @@ def unset_security_assessment_baseline(self, security_assessment_id, **kwargs): The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. - :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 identifier for the request. - :param oci.data_safe.models.UnsetSecurityAssessmentBaselineDetails unset_security_assessment_baseline_details: (optional) - Details of the target associated with the security assessment for which the user intents to unset the baseline. - :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. @@ -34972,35 +36935,33 @@ def unset_security_assessment_baseline(self, security_assessment_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 None + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.data_safe.models.Alert` :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use unset_security_assessment_baseline API. + Click `here `__ to see an example of how to use update_alert API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['securityAssessmentId'] - resource_path = "/securityAssessments/{securityAssessmentId}/actions/unsetBaseline" - method = "POST" - operation_name = "unset_security_assessment_baseline" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/SecurityAssessment/UnsetSecurityAssessmentBaseline" + required_arguments = ['alertId'] + resource_path = "/alerts/{alertId}" + method = "PUT" + operation_name = "update_alert" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/Alert/UpdateAlert" # Don't accept unknown kwargs expected_kwargs = [ "allow_control_chars", "retry_strategy", "if_match", - "opc_retry_token", - "opc_request_id", - "unset_security_assessment_baseline_details" + "opc_request_id" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"unset_security_assessment_baseline got unknown kwargs: {extra_kwargs!r}") + f"update_alert got unknown kwargs: {extra_kwargs!r}") path_params = { - "securityAssessmentId": security_assessment_id + "alertId": alert_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -35013,7 +36974,6 @@ def unset_security_assessment_baseline(self, security_assessment_id, **kwargs): "accept": "application/json", "content-type": "application/json", "if-match": kwargs.get("if_match", missing), - "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} @@ -35027,7 +36987,6 @@ def unset_security_assessment_baseline(self, security_assessment_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( @@ -35036,7 +36995,8 @@ def unset_security_assessment_baseline(self, security_assessment_id, **kwargs): method=method, path_params=path_params, header_params=header_params, - body=kwargs.get('unset_security_assessment_baseline_details'), + body=update_alert_details, + response_type="Alert", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -35047,21 +37007,23 @@ def unset_security_assessment_baseline(self, security_assessment_id, **kwargs): method=method, path_params=path_params, header_params=header_params, - body=kwargs.get('unset_security_assessment_baseline_details'), + body=update_alert_details, + response_type="Alert", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def unset_user_assessment_baseline(self, user_assessment_id, **kwargs): + def update_alert_policy(self, alert_policy_id, update_alert_policy_details, **kwargs): """ - Removes the baseline setting for the saved user assessment associated with the targetId passed via body. - If no body or empty body is passed then the baseline settings of all the saved user assessments pertaining to the baseline assessment OCID provided in the path will be removed. - Sets the if-match parameter to the value of the etag from a previous GET or POST response for that resource. + Updates the specified alert policy . - :param str user_assessment_id: (required) - The OCID of the user assessment. + :param str alert_policy_id: (required) + The OCID of the alert policy. + + :param oci.data_safe.models.UpdateAlertPolicyDetails update_alert_policy_details: (required) + The details used to update the alert policy. :param str if_match: (optional) For optimistic concurrency control. In the PUT or DELETE call @@ -35070,18 +37032,9 @@ def unset_user_assessment_baseline(self, user_assessment_id, **kwargs): The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. - :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 identifier for the request. - :param oci.data_safe.models.UnsetUserAssessmentBaselineDetails unset_user_assessment_baseline_details: (optional) - Details of the target associated with the user assessment for which the user intents to unset the baseline. - :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. @@ -35098,31 +37051,29 @@ def unset_user_assessment_baseline(self, user_assessment_id, **kwargs): :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use unset_user_assessment_baseline API. + Click `here `__ to see an example of how to use update_alert_policy API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['userAssessmentId'] - resource_path = "/userAssessments/{userAssessmentId}/actions/unsetBaseline" - method = "POST" - operation_name = "unset_user_assessment_baseline" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/UserAssessment/UnsetUserAssessmentBaseline" + required_arguments = ['alertPolicyId'] + resource_path = "/alertPolicies/{alertPolicyId}" + method = "PUT" + operation_name = "update_alert_policy" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/AlertPolicy/UpdateAlertPolicy" # Don't accept unknown kwargs expected_kwargs = [ "allow_control_chars", "retry_strategy", "if_match", - "opc_retry_token", - "opc_request_id", - "unset_user_assessment_baseline_details" + "opc_request_id" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"unset_user_assessment_baseline got unknown kwargs: {extra_kwargs!r}") + f"update_alert_policy got unknown kwargs: {extra_kwargs!r}") path_params = { - "userAssessmentId": user_assessment_id + "alertPolicyId": alert_policy_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -35135,7 +37086,6 @@ def unset_user_assessment_baseline(self, user_assessment_id, **kwargs): "accept": "application/json", "content-type": "application/json", "if-match": kwargs.get("if_match", missing), - "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} @@ -35149,7 +37099,6 @@ def unset_user_assessment_baseline(self, user_assessment_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( @@ -35158,7 +37107,7 @@ def unset_user_assessment_baseline(self, user_assessment_id, **kwargs): method=method, path_params=path_params, header_params=header_params, - body=kwargs.get('unset_user_assessment_baseline_details'), + body=update_alert_policy_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -35169,22 +37118,25 @@ def unset_user_assessment_baseline(self, user_assessment_id, **kwargs): method=method, path_params=path_params, header_params=header_params, - body=kwargs.get('unset_user_assessment_baseline_details'), + body=update_alert_policy_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def update_alert(self, alert_id, update_alert_details, **kwargs): + def update_alert_policy_rule(self, alert_policy_id, rule_key, update_alert_policy_rule_details, **kwargs): """ - Updates the status of the specified alert. + Updates the specified alert policy rule. - :param str alert_id: (required) - The OCID of alert. + :param str alert_policy_id: (required) + The OCID of the alert policy. - :param oci.data_safe.models.UpdateAlertDetails update_alert_details: (required) - The details used to update alert status. + :param str rule_key: (required) + The key of the alert policy rule. + + :param oci.data_safe.models.UpdateAlertPolicyRuleDetails update_alert_policy_rule_details: (required) + The details used to update the alert policy rule. :param str if_match: (optional) For optimistic concurrency control. In the PUT or DELETE call @@ -35208,18 +37160,18 @@ def update_alert(self, alert_id, update_alert_details, **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.data_safe.models.Alert` + :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 update_alert API. + Click `here `__ to see an example of how to use update_alert_policy_rule API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['alertId'] - resource_path = "/alerts/{alertId}" + required_arguments = ['alertPolicyId', 'ruleKey'] + resource_path = "/alertPolicies/{alertPolicyId}/rules/{ruleKey}" method = "PUT" - operation_name = "update_alert" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/Alert/UpdateAlert" + operation_name = "update_alert_policy_rule" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/AlertPolicyRule/UpdateAlertPolicyRule" # Don't accept unknown kwargs expected_kwargs = [ @@ -35231,10 +37183,11 @@ def update_alert(self, alert_id, update_alert_details, **kwargs): extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"update_alert got unknown kwargs: {extra_kwargs!r}") + f"update_alert_policy_rule got unknown kwargs: {extra_kwargs!r}") path_params = { - "alertId": alert_id + "alertPolicyId": alert_policy_id, + "ruleKey": rule_key } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -35268,8 +37221,7 @@ def update_alert(self, alert_id, update_alert_details, **kwargs): method=method, path_params=path_params, header_params=header_params, - body=update_alert_details, - response_type="Alert", + body=update_alert_policy_rule_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -35280,23 +37232,22 @@ def update_alert(self, alert_id, update_alert_details, **kwargs): method=method, path_params=path_params, header_params=header_params, - body=update_alert_details, - response_type="Alert", + body=update_alert_policy_rule_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def update_alert_policy(self, alert_policy_id, update_alert_policy_details, **kwargs): + def update_audit_archive_retrieval(self, audit_archive_retrieval_id, update_audit_archive_retrieval_details, **kwargs): """ - Updates the specified alert policy . + Updates the audit archive retrieval. - :param str alert_policy_id: (required) - The OCID of the alert policy. + :param str audit_archive_retrieval_id: (required) + OCID of the archive retrieval. - :param oci.data_safe.models.UpdateAlertPolicyDetails update_alert_policy_details: (required) - The details used to update the alert policy. + :param oci.data_safe.models.UpdateAuditArchiveRetrievalDetails update_audit_archive_retrieval_details: (required) + Details to update the audit archive retrieval. :param str if_match: (optional) For optimistic concurrency control. In the PUT or DELETE call @@ -35324,14 +37275,14 @@ def update_alert_policy(self, alert_policy_id, update_alert_policy_details, **kw :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use update_alert_policy API. + Click `here `__ to see an example of how to use update_audit_archive_retrieval API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['alertPolicyId'] - resource_path = "/alertPolicies/{alertPolicyId}" + required_arguments = ['auditArchiveRetrievalId'] + resource_path = "/auditArchiveRetrievals/{auditArchiveRetrievalId}" method = "PUT" - operation_name = "update_alert_policy" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/AlertPolicy/UpdateAlertPolicy" + operation_name = "update_audit_archive_retrieval" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/AuditArchiveRetrieval/UpdateAuditArchiveRetrieval" # Don't accept unknown kwargs expected_kwargs = [ @@ -35343,10 +37294,10 @@ def update_alert_policy(self, alert_policy_id, update_alert_policy_details, **kw extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"update_alert_policy got unknown kwargs: {extra_kwargs!r}") + f"update_audit_archive_retrieval got unknown kwargs: {extra_kwargs!r}") path_params = { - "alertPolicyId": alert_policy_id + "auditArchiveRetrievalId": audit_archive_retrieval_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -35380,7 +37331,7 @@ def update_alert_policy(self, alert_policy_id, update_alert_policy_details, **kw method=method, path_params=path_params, header_params=header_params, - body=update_alert_policy_details, + body=update_audit_archive_retrieval_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -35391,25 +37342,22 @@ def update_alert_policy(self, alert_policy_id, update_alert_policy_details, **kw method=method, path_params=path_params, header_params=header_params, - body=update_alert_policy_details, + body=update_audit_archive_retrieval_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def update_alert_policy_rule(self, alert_policy_id, rule_key, update_alert_policy_rule_details, **kwargs): + def update_audit_policy(self, audit_policy_id, update_audit_policy_details, **kwargs): """ - Updates the specified alert policy rule. - + Updates the audit policy. - :param str alert_policy_id: (required) - The OCID of the alert policy. - :param str rule_key: (required) - The key of the alert policy rule. + :param str audit_policy_id: (required) + Unique audit policy identifier. - :param oci.data_safe.models.UpdateAlertPolicyRuleDetails update_alert_policy_rule_details: (required) - The details used to update the alert policy rule. + :param oci.data_safe.models.UpdateAuditPolicyDetails update_audit_policy_details: (required) + Details to update the audit policy. :param str if_match: (optional) For optimistic concurrency control. In the PUT or DELETE call @@ -35437,14 +37385,14 @@ def update_alert_policy_rule(self, alert_policy_id, rule_key, update_alert_polic :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use update_alert_policy_rule API. + Click `here `__ to see an example of how to use update_audit_policy API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['alertPolicyId', 'ruleKey'] - resource_path = "/alertPolicies/{alertPolicyId}/rules/{ruleKey}" + required_arguments = ['auditPolicyId'] + resource_path = "/auditPolicies/{auditPolicyId}" method = "PUT" - operation_name = "update_alert_policy_rule" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/AlertPolicyRule/UpdateAlertPolicyRule" + operation_name = "update_audit_policy" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/AuditPolicy/UpdateAuditPolicy" # Don't accept unknown kwargs expected_kwargs = [ @@ -35456,11 +37404,10 @@ def update_alert_policy_rule(self, alert_policy_id, rule_key, update_alert_polic extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"update_alert_policy_rule got unknown kwargs: {extra_kwargs!r}") + f"update_audit_policy got unknown kwargs: {extra_kwargs!r}") path_params = { - "alertPolicyId": alert_policy_id, - "ruleKey": rule_key + "auditPolicyId": audit_policy_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -35494,7 +37441,7 @@ def update_alert_policy_rule(self, alert_policy_id, rule_key, update_alert_polic method=method, path_params=path_params, header_params=header_params, - body=update_alert_policy_rule_details, + body=update_audit_policy_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -35505,22 +37452,22 @@ def update_alert_policy_rule(self, alert_policy_id, rule_key, update_alert_polic method=method, path_params=path_params, header_params=header_params, - body=update_alert_policy_rule_details, + body=update_audit_policy_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def update_audit_archive_retrieval(self, audit_archive_retrieval_id, update_audit_archive_retrieval_details, **kwargs): + def update_audit_profile(self, audit_profile_id, update_audit_profile_details, **kwargs): """ - Updates the audit archive retrieval. + Updates one or more attributes of the specified audit profile. - :param str audit_archive_retrieval_id: (required) - OCID of the archive retrieval. + :param str audit_profile_id: (required) + The OCID of the audit. - :param oci.data_safe.models.UpdateAuditArchiveRetrievalDetails update_audit_archive_retrieval_details: (required) - Details to update the audit archive retrieval. + :param oci.data_safe.models.UpdateAuditProfileDetails update_audit_profile_details: (required) + The information to be updated. :param str if_match: (optional) For optimistic concurrency control. In the PUT or DELETE call @@ -35548,14 +37495,14 @@ def update_audit_archive_retrieval(self, audit_archive_retrieval_id, update_audi :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use update_audit_archive_retrieval API. + Click `here `__ to see an example of how to use update_audit_profile API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['auditArchiveRetrievalId'] - resource_path = "/auditArchiveRetrievals/{auditArchiveRetrievalId}" + required_arguments = ['auditProfileId'] + resource_path = "/auditProfiles/{auditProfileId}" method = "PUT" - operation_name = "update_audit_archive_retrieval" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/AuditArchiveRetrieval/UpdateAuditArchiveRetrieval" + operation_name = "update_audit_profile" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/AuditProfile/UpdateAuditProfile" # Don't accept unknown kwargs expected_kwargs = [ @@ -35567,10 +37514,10 @@ def update_audit_archive_retrieval(self, audit_archive_retrieval_id, update_audi extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"update_audit_archive_retrieval got unknown kwargs: {extra_kwargs!r}") + f"update_audit_profile got unknown kwargs: {extra_kwargs!r}") path_params = { - "auditArchiveRetrievalId": audit_archive_retrieval_id + "auditProfileId": audit_profile_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -35604,7 +37551,7 @@ def update_audit_archive_retrieval(self, audit_archive_retrieval_id, update_audi method=method, path_params=path_params, header_params=header_params, - body=update_audit_archive_retrieval_details, + body=update_audit_profile_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -35615,22 +37562,22 @@ def update_audit_archive_retrieval(self, audit_archive_retrieval_id, update_audi method=method, path_params=path_params, header_params=header_params, - body=update_audit_archive_retrieval_details, + body=update_audit_profile_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def update_audit_policy(self, audit_policy_id, update_audit_policy_details, **kwargs): + def update_audit_trail(self, audit_trail_id, update_audit_trail_details, **kwargs): """ - Updates the audit policy. + Updates one or more attributes of the specified audit trail. - :param str audit_policy_id: (required) - Unique audit policy identifier. + :param str audit_trail_id: (required) + The OCID of the audit trail. - :param oci.data_safe.models.UpdateAuditPolicyDetails update_audit_policy_details: (required) - Details to update the audit policy. + :param oci.data_safe.models.UpdateAuditTrailDetails update_audit_trail_details: (required) + The information to be updated. :param str if_match: (optional) For optimistic concurrency control. In the PUT or DELETE call @@ -35658,14 +37605,14 @@ def update_audit_policy(self, audit_policy_id, update_audit_policy_details, **kw :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use update_audit_policy API. + Click `here `__ to see an example of how to use update_audit_trail API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['auditPolicyId'] - resource_path = "/auditPolicies/{auditPolicyId}" + required_arguments = ['auditTrailId'] + resource_path = "/auditTrails/{auditTrailId}" method = "PUT" - operation_name = "update_audit_policy" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/AuditPolicy/UpdateAuditPolicy" + operation_name = "update_audit_trail" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/AuditTrail/UpdateAuditTrail" # Don't accept unknown kwargs expected_kwargs = [ @@ -35677,10 +37624,10 @@ def update_audit_policy(self, audit_policy_id, update_audit_policy_details, **kw extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"update_audit_policy got unknown kwargs: {extra_kwargs!r}") + f"update_audit_trail got unknown kwargs: {extra_kwargs!r}") path_params = { - "auditPolicyId": audit_policy_id + "auditTrailId": audit_trail_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -35714,7 +37661,7 @@ def update_audit_policy(self, audit_policy_id, update_audit_policy_details, **kw method=method, path_params=path_params, header_params=header_params, - body=update_audit_policy_details, + body=update_audit_trail_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -35725,22 +37672,22 @@ def update_audit_policy(self, audit_policy_id, update_audit_policy_details, **kw method=method, path_params=path_params, header_params=header_params, - body=update_audit_policy_details, + body=update_audit_trail_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def update_audit_profile(self, audit_profile_id, update_audit_profile_details, **kwargs): + def update_data_safe_private_endpoint(self, data_safe_private_endpoint_id, update_data_safe_private_endpoint_details, **kwargs): """ - Updates one or more attributes of the specified audit profile. + Updates one or more attributes of the specified Data Safe private endpoint. - :param str audit_profile_id: (required) - The OCID of the audit. + :param str data_safe_private_endpoint_id: (required) + The OCID of the private endpoint. - :param oci.data_safe.models.UpdateAuditProfileDetails update_audit_profile_details: (required) - The information to be updated. + :param oci.data_safe.models.UpdateDataSafePrivateEndpointDetails update_data_safe_private_endpoint_details: (required) + The details used to update a Data Safe private endpoint. :param str if_match: (optional) For optimistic concurrency control. In the PUT or DELETE call @@ -35768,14 +37715,14 @@ def update_audit_profile(self, audit_profile_id, update_audit_profile_details, * :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use update_audit_profile API. + Click `here `__ to see an example of how to use update_data_safe_private_endpoint API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['auditProfileId'] - resource_path = "/auditProfiles/{auditProfileId}" + required_arguments = ['dataSafePrivateEndpointId'] + resource_path = "/dataSafePrivateEndpoints/{dataSafePrivateEndpointId}" method = "PUT" - operation_name = "update_audit_profile" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/AuditProfile/UpdateAuditProfile" + operation_name = "update_data_safe_private_endpoint" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/DataSafePrivateEndpoint/UpdateDataSafePrivateEndpoint" # Don't accept unknown kwargs expected_kwargs = [ @@ -35787,10 +37734,10 @@ def update_audit_profile(self, audit_profile_id, update_audit_profile_details, * extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"update_audit_profile got unknown kwargs: {extra_kwargs!r}") + f"update_data_safe_private_endpoint got unknown kwargs: {extra_kwargs!r}") path_params = { - "auditProfileId": audit_profile_id + "dataSafePrivateEndpointId": data_safe_private_endpoint_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -35824,7 +37771,7 @@ def update_audit_profile(self, audit_profile_id, update_audit_profile_details, * method=method, path_params=path_params, header_params=header_params, - body=update_audit_profile_details, + body=update_data_safe_private_endpoint_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -35835,22 +37782,22 @@ def update_audit_profile(self, audit_profile_id, update_audit_profile_details, * method=method, path_params=path_params, header_params=header_params, - body=update_audit_profile_details, + body=update_data_safe_private_endpoint_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def update_audit_trail(self, audit_trail_id, update_audit_trail_details, **kwargs): + def update_database_security_config(self, database_security_config_id, update_database_security_config_details, **kwargs): """ - Updates one or more attributes of the specified audit trail. + Updates the database security configuration. - :param str audit_trail_id: (required) - The OCID of the audit trail. + :param str database_security_config_id: (required) + The OCID of the database security configuration resource. - :param oci.data_safe.models.UpdateAuditTrailDetails update_audit_trail_details: (required) - The information to be updated. + :param oci.data_safe.models.UpdateDatabaseSecurityConfigDetails update_database_security_config_details: (required) + Details to update the database security configuration. :param str if_match: (optional) For optimistic concurrency control. In the PUT or DELETE call @@ -35878,14 +37825,14 @@ def update_audit_trail(self, audit_trail_id, update_audit_trail_details, **kwarg :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use update_audit_trail API. + Click `here `__ to see an example of how to use update_database_security_config API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['auditTrailId'] - resource_path = "/auditTrails/{auditTrailId}" + required_arguments = ['databaseSecurityConfigId'] + resource_path = "/databaseSecurityConfigs/{databaseSecurityConfigId}" method = "PUT" - operation_name = "update_audit_trail" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/AuditTrail/UpdateAuditTrail" + operation_name = "update_database_security_config" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/DatabaseSecurityConfig/UpdateDatabaseSecurityConfig" # Don't accept unknown kwargs expected_kwargs = [ @@ -35897,10 +37844,10 @@ def update_audit_trail(self, audit_trail_id, update_audit_trail_details, **kwarg extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"update_audit_trail got unknown kwargs: {extra_kwargs!r}") + f"update_database_security_config got unknown kwargs: {extra_kwargs!r}") path_params = { - "auditTrailId": audit_trail_id + "databaseSecurityConfigId": database_security_config_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -35934,7 +37881,7 @@ def update_audit_trail(self, audit_trail_id, update_audit_trail_details, **kwarg method=method, path_params=path_params, header_params=header_params, - body=update_audit_trail_details, + body=update_database_security_config_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -35945,22 +37892,34 @@ def update_audit_trail(self, audit_trail_id, update_audit_trail_details, **kwarg method=method, path_params=path_params, header_params=header_params, - body=update_audit_trail_details, + body=update_database_security_config_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def update_data_safe_private_endpoint(self, data_safe_private_endpoint_id, update_data_safe_private_endpoint_details, **kwargs): + def update_finding(self, security_assessment_id, finding_key, update_finding_details, **kwargs): """ - Updates one or more attributes of the specified Data Safe private endpoint. + Updates one or more attributes of the specified finding. - :param str data_safe_private_endpoint_id: (required) - The OCID of the private endpoint. + :param str security_assessment_id: (required) + The OCID of the security assessment. - :param oci.data_safe.models.UpdateDataSafePrivateEndpointDetails update_data_safe_private_endpoint_details: (required) - The details used to update a Data Safe private endpoint. + :param str finding_key: (required) + The unique key that identifies the finding. It is a string and unique within a security assessment. + + :param oci.data_safe.models.UpdateFindingDetails update_finding_details: (required) + Details to change risk of a finding. + + :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 identifier for the request. :param str if_match: (optional) For optimistic concurrency control. In the PUT or DELETE call @@ -35969,9 +37928,6 @@ def update_data_safe_private_endpoint(self, data_safe_private_endpoint_id, updat 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 identifier for the request. - :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. @@ -35988,29 +37944,31 @@ def update_data_safe_private_endpoint(self, data_safe_private_endpoint_id, updat :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use update_data_safe_private_endpoint API. + Click `here `__ to see an example of how to use update_finding API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['dataSafePrivateEndpointId'] - resource_path = "/dataSafePrivateEndpoints/{dataSafePrivateEndpointId}" + required_arguments = ['securityAssessmentId', 'findingKey'] + resource_path = "/securityAssessments/{securityAssessmentId}/findings/{findingKey}" method = "PUT" - operation_name = "update_data_safe_private_endpoint" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/DataSafePrivateEndpoint/UpdateDataSafePrivateEndpoint" + operation_name = "update_finding" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/Finding/UpdateFinding" # Don't accept unknown kwargs expected_kwargs = [ "allow_control_chars", "retry_strategy", - "if_match", - "opc_request_id" + "opc_retry_token", + "opc_request_id", + "if_match" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"update_data_safe_private_endpoint got unknown kwargs: {extra_kwargs!r}") + f"update_finding got unknown kwargs: {extra_kwargs!r}") path_params = { - "dataSafePrivateEndpointId": data_safe_private_endpoint_id + "securityAssessmentId": security_assessment_id, + "findingKey": finding_key } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -36022,8 +37980,9 @@ def update_data_safe_private_endpoint(self, data_safe_private_endpoint_id, updat 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), + "opc-request-id": kwargs.get("opc_request_id", 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} @@ -36036,6 +37995,7 @@ def update_data_safe_private_endpoint(self, data_safe_private_endpoint_id, updat 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( @@ -36044,7 +38004,7 @@ def update_data_safe_private_endpoint(self, data_safe_private_endpoint_id, updat method=method, path_params=path_params, header_params=header_params, - body=update_data_safe_private_endpoint_details, + body=update_finding_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -36055,22 +38015,22 @@ def update_data_safe_private_endpoint(self, data_safe_private_endpoint_id, updat method=method, path_params=path_params, header_params=header_params, - body=update_data_safe_private_endpoint_details, + body=update_finding_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def update_database_security_config(self, database_security_config_id, update_database_security_config_details, **kwargs): + def update_library_masking_format(self, library_masking_format_id, update_library_masking_format_details, **kwargs): """ - Updates the database security configuration. + Updates one or more attributes of the specified library masking format. Note that updating the formatEntries attribute replaces all the existing masking format entries with the specified format entries. - :param str database_security_config_id: (required) - The OCID of the database security configuration resource. + :param str library_masking_format_id: (required) + The OCID of the library masking format. - :param oci.data_safe.models.UpdateDatabaseSecurityConfigDetails update_database_security_config_details: (required) - Details to update the database security configuration. + :param oci.data_safe.models.UpdateLibraryMaskingFormatDetails update_library_masking_format_details: (required) + Details to update a library masking format. :param str if_match: (optional) For optimistic concurrency control. In the PUT or DELETE call @@ -36098,14 +38058,14 @@ def update_database_security_config(self, database_security_config_id, update_da :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use update_database_security_config API. + Click `here `__ to see an example of how to use update_library_masking_format API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['databaseSecurityConfigId'] - resource_path = "/databaseSecurityConfigs/{databaseSecurityConfigId}" + required_arguments = ['libraryMaskingFormatId'] + resource_path = "/libraryMaskingFormats/{libraryMaskingFormatId}" method = "PUT" - operation_name = "update_database_security_config" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/DatabaseSecurityConfig/UpdateDatabaseSecurityConfig" + operation_name = "update_library_masking_format" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/LibraryMaskingFormat/UpdateLibraryMaskingFormat" # Don't accept unknown kwargs expected_kwargs = [ @@ -36117,10 +38077,10 @@ def update_database_security_config(self, database_security_config_id, update_da extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"update_database_security_config got unknown kwargs: {extra_kwargs!r}") + f"update_library_masking_format got unknown kwargs: {extra_kwargs!r}") path_params = { - "databaseSecurityConfigId": database_security_config_id + "libraryMaskingFormatId": library_masking_format_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -36154,7 +38114,7 @@ def update_database_security_config(self, database_security_config_id, update_da method=method, path_params=path_params, header_params=header_params, - body=update_database_security_config_details, + body=update_library_masking_format_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -36165,34 +38125,26 @@ def update_database_security_config(self, database_security_config_id, update_da method=method, path_params=path_params, header_params=header_params, - body=update_database_security_config_details, + body=update_library_masking_format_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def update_finding(self, security_assessment_id, finding_key, update_finding_details, **kwargs): + def update_masking_column(self, masking_column_key, masking_policy_id, update_masking_column_details, **kwargs): """ - Updates one or more attributes of the specified finding. - - - :param str security_assessment_id: (required) - The OCID of the security assessment. + Updates one or more attributes of the specified masking column. Note that updating the maskingFormats + attribute replaces the currently assigned masking formats with the specified masking formats. - :param str finding_key: (required) - The unique key that identifies the finding. It is a string and unique within a security assessment. - :param oci.data_safe.models.UpdateFindingDetails update_finding_details: (required) - Details to change risk of a finding. + :param str masking_column_key: (required) + The unique key that identifies the masking column. It's numeric and unique within a masking policy. - :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 masking_policy_id: (required) + The OCID of the masking policy. - :param str opc_request_id: (optional) - Unique identifier for the request. + :param oci.data_safe.models.UpdateMaskingColumnDetails update_masking_column_details: (required) + Details to update a masking column. :param str if_match: (optional) For optimistic concurrency control. In the PUT or DELETE call @@ -36201,6 +38153,9 @@ def update_finding(self, security_assessment_id, finding_key, update_finding_det 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 identifier for the request. + :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. @@ -36217,31 +38172,30 @@ def update_finding(self, security_assessment_id, finding_key, update_finding_det :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use update_finding API. + Click `here `__ to see an example of how to use update_masking_column API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['securityAssessmentId', 'findingKey'] - resource_path = "/securityAssessments/{securityAssessmentId}/findings/{findingKey}" + required_arguments = ['maskingColumnKey', 'maskingPolicyId'] + resource_path = "/maskingPolicies/{maskingPolicyId}/maskingColumns/{maskingColumnKey}" method = "PUT" - operation_name = "update_finding" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/Finding/UpdateFinding" + operation_name = "update_masking_column" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/MaskingColumn/UpdateMaskingColumn" # Don't accept unknown kwargs expected_kwargs = [ "allow_control_chars", "retry_strategy", - "opc_retry_token", - "opc_request_id", - "if_match" + "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( - f"update_finding got unknown kwargs: {extra_kwargs!r}") + f"update_masking_column got unknown kwargs: {extra_kwargs!r}") path_params = { - "securityAssessmentId": security_assessment_id, - "findingKey": finding_key + "maskingColumnKey": masking_column_key, + "maskingPolicyId": masking_policy_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -36253,9 +38207,8 @@ def update_finding(self, security_assessment_id, finding_key, update_finding_det 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), - "if-match": kwargs.get("if_match", 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} @@ -36268,7 +38221,6 @@ def update_finding(self, security_assessment_id, finding_key, update_finding_det 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( @@ -36277,7 +38229,7 @@ def update_finding(self, security_assessment_id, finding_key, update_finding_det method=method, path_params=path_params, header_params=header_params, - body=update_finding_details, + body=update_masking_column_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -36288,22 +38240,22 @@ def update_finding(self, security_assessment_id, finding_key, update_finding_det method=method, path_params=path_params, header_params=header_params, - body=update_finding_details, + body=update_masking_column_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def update_library_masking_format(self, library_masking_format_id, update_library_masking_format_details, **kwargs): + def update_masking_policy(self, masking_policy_id, update_masking_policy_details, **kwargs): """ - Updates one or more attributes of the specified library masking format. Note that updating the formatEntries attribute replaces all the existing masking format entries with the specified format entries. + Updates one or more attributes of the specified masking policy. - :param str library_masking_format_id: (required) - The OCID of the library masking format. + :param str masking_policy_id: (required) + The OCID of the masking policy. - :param oci.data_safe.models.UpdateLibraryMaskingFormatDetails update_library_masking_format_details: (required) - Details to update a library masking format. + :param oci.data_safe.models.UpdateMaskingPolicyDetails update_masking_policy_details: (required) + Details to update a masking policy. :param str if_match: (optional) For optimistic concurrency control. In the PUT or DELETE call @@ -36331,14 +38283,14 @@ def update_library_masking_format(self, library_masking_format_id, update_librar :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use update_library_masking_format API. + Click `here `__ to see an example of how to use update_masking_policy API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['libraryMaskingFormatId'] - resource_path = "/libraryMaskingFormats/{libraryMaskingFormatId}" + required_arguments = ['maskingPolicyId'] + resource_path = "/maskingPolicies/{maskingPolicyId}" method = "PUT" - operation_name = "update_library_masking_format" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/LibraryMaskingFormat/UpdateLibraryMaskingFormat" + operation_name = "update_masking_policy" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/MaskingPolicy/UpdateMaskingPolicy" # Don't accept unknown kwargs expected_kwargs = [ @@ -36350,10 +38302,10 @@ def update_library_masking_format(self, library_masking_format_id, update_librar extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"update_library_masking_format got unknown kwargs: {extra_kwargs!r}") + f"update_masking_policy got unknown kwargs: {extra_kwargs!r}") path_params = { - "libraryMaskingFormatId": library_masking_format_id + "maskingPolicyId": masking_policy_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -36387,7 +38339,7 @@ def update_library_masking_format(self, library_masking_format_id, update_librar method=method, path_params=path_params, header_params=header_params, - body=update_library_masking_format_details, + body=update_masking_policy_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -36398,26 +38350,22 @@ def update_library_masking_format(self, library_masking_format_id, update_librar method=method, path_params=path_params, header_params=header_params, - body=update_library_masking_format_details, + body=update_masking_policy_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def update_masking_column(self, masking_column_key, masking_policy_id, update_masking_column_details, **kwargs): + def update_on_prem_connector(self, on_prem_connector_id, update_on_prem_connector_details, **kwargs): """ - Updates one or more attributes of the specified masking column. Note that updating the maskingFormats - attribute replaces the currently assigned masking formats with the specified masking formats. + Updates one or more attributes of the specified on-premises connector. - :param str masking_column_key: (required) - The unique key that identifies the masking column. It's numeric and unique within a masking policy. - - :param str masking_policy_id: (required) - The OCID of the masking policy. + :param str on_prem_connector_id: (required) + The OCID of the on-premises connector. - :param oci.data_safe.models.UpdateMaskingColumnDetails update_masking_column_details: (required) - Details to update a masking column. + :param oci.data_safe.models.UpdateOnPremConnectorDetails update_on_prem_connector_details: (required) + The details used to update a on-premises connector. :param str if_match: (optional) For optimistic concurrency control. In the PUT or DELETE call @@ -36445,14 +38393,14 @@ def update_masking_column(self, masking_column_key, masking_policy_id, update_ma :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use update_masking_column API. + Click `here `__ to see an example of how to use update_on_prem_connector API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['maskingColumnKey', 'maskingPolicyId'] - resource_path = "/maskingPolicies/{maskingPolicyId}/maskingColumns/{maskingColumnKey}" + required_arguments = ['onPremConnectorId'] + resource_path = "/onPremConnectors/{onPremConnectorId}" method = "PUT" - operation_name = "update_masking_column" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/MaskingColumn/UpdateMaskingColumn" + operation_name = "update_on_prem_connector" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/OnPremConnector/UpdateOnPremConnector" # Don't accept unknown kwargs expected_kwargs = [ @@ -36464,11 +38412,10 @@ def update_masking_column(self, masking_column_key, masking_policy_id, update_ma extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"update_masking_column got unknown kwargs: {extra_kwargs!r}") + f"update_on_prem_connector got unknown kwargs: {extra_kwargs!r}") path_params = { - "maskingColumnKey": masking_column_key, - "maskingPolicyId": masking_policy_id + "onPremConnectorId": on_prem_connector_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -36502,7 +38449,7 @@ def update_masking_column(self, masking_column_key, masking_policy_id, update_ma method=method, path_params=path_params, header_params=header_params, - body=update_masking_column_details, + body=update_on_prem_connector_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -36513,22 +38460,28 @@ def update_masking_column(self, masking_column_key, masking_policy_id, update_ma method=method, path_params=path_params, header_params=header_params, - body=update_masking_column_details, + body=update_on_prem_connector_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def update_masking_policy(self, masking_policy_id, update_masking_policy_details, **kwargs): + def update_on_prem_connector_wallet(self, update_on_prem_connector_wallet_details, on_prem_connector_id, **kwargs): """ - Updates one or more attributes of the specified masking policy. + Updates the wallet for the specified on-premises connector to a new version. - :param str masking_policy_id: (required) - The OCID of the masking policy. + :param oci.data_safe.models.UpdateOnPremConnectorWalletDetails update_on_prem_connector_wallet_details: (required) + The details used to update an on-premises connector's wallet. - :param oci.data_safe.models.UpdateMaskingPolicyDetails update_masking_policy_details: (required) - Details to update a masking policy. + :param str on_prem_connector_id: (required) + The OCID of the on-premises connector. + + :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 if_match: (optional) For optimistic concurrency control. In the PUT or DELETE call @@ -36556,29 +38509,30 @@ def update_masking_policy(self, masking_policy_id, update_masking_policy_details :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use update_masking_policy API. + Click `here `__ to see an example of how to use update_on_prem_connector_wallet API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['maskingPolicyId'] - resource_path = "/maskingPolicies/{maskingPolicyId}" + required_arguments = ['onPremConnectorId'] + resource_path = "/onPremConnectors/{onPremConnectorId}/wallet" method = "PUT" - operation_name = "update_masking_policy" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/MaskingPolicy/UpdateMaskingPolicy" + operation_name = "update_on_prem_connector_wallet" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/OnPremConnector/UpdateOnPremConnectorWallet" # Don't accept unknown kwargs expected_kwargs = [ "allow_control_chars", "retry_strategy", + "opc_retry_token", "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( - f"update_masking_policy got unknown kwargs: {extra_kwargs!r}") + f"update_on_prem_connector_wallet got unknown kwargs: {extra_kwargs!r}") path_params = { - "maskingPolicyId": masking_policy_id + "onPremConnectorId": on_prem_connector_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -36590,6 +38544,7 @@ def update_masking_policy(self, masking_policy_id, update_masking_policy_details header_params = { "accept": "application/json", "content-type": "application/json", + "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) } @@ -36604,6 +38559,7 @@ def update_masking_policy(self, masking_policy_id, update_masking_policy_details 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( @@ -36612,7 +38568,7 @@ def update_masking_policy(self, masking_policy_id, update_masking_policy_details method=method, path_params=path_params, header_params=header_params, - body=update_masking_policy_details, + body=update_on_prem_connector_wallet_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -36623,22 +38579,25 @@ def update_masking_policy(self, masking_policy_id, update_masking_policy_details method=method, path_params=path_params, header_params=header_params, - body=update_masking_policy_details, + body=update_on_prem_connector_wallet_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def update_on_prem_connector(self, on_prem_connector_id, update_on_prem_connector_details, **kwargs): + def update_peer_target_database(self, target_database_id, peer_target_database_id, update_peer_target_database_details, **kwargs): """ - Updates one or more attributes of the specified on-premises connector. + Updates one or more attributes of the specified Data Safe peer target database. - :param str on_prem_connector_id: (required) - The OCID of the on-premises connector. + :param str target_database_id: (required) + The OCID of the Data Safe target database. - :param oci.data_safe.models.UpdateOnPremConnectorDetails update_on_prem_connector_details: (required) - The details used to update a on-premises connector. + :param int peer_target_database_id: (required) + The unique id of the peer target database. + + :param oci.data_safe.models.UpdatePeerTargetDatabaseDetails update_peer_target_database_details: (required) + Database details to be used to update the peer target database. :param str if_match: (optional) For optimistic concurrency control. In the PUT or DELETE call @@ -36650,6 +38609,12 @@ def update_on_prem_connector(self, on_prem_connector_id, update_on_prem_connecto :param str opc_request_id: (optional) Unique identifier for the request. + :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. @@ -36666,29 +38631,31 @@ def update_on_prem_connector(self, on_prem_connector_id, update_on_prem_connecto :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use update_on_prem_connector API. + Click `here `__ to see an example of how to use update_peer_target_database API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['onPremConnectorId'] - resource_path = "/onPremConnectors/{onPremConnectorId}" + required_arguments = ['targetDatabaseId', 'peerTargetDatabaseId'] + resource_path = "/targetDatabases/{targetDatabaseId}/peerTargetDatabases/{peerTargetDatabaseId}" method = "PUT" - operation_name = "update_on_prem_connector" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/OnPremConnector/UpdateOnPremConnector" + operation_name = "update_peer_target_database" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/PeerTargetDatabase/UpdatePeerTargetDatabase" # Don't accept unknown kwargs expected_kwargs = [ "allow_control_chars", "retry_strategy", "if_match", - "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( - f"update_on_prem_connector got unknown kwargs: {extra_kwargs!r}") + f"update_peer_target_database got unknown kwargs: {extra_kwargs!r}") path_params = { - "onPremConnectorId": on_prem_connector_id + "targetDatabaseId": target_database_id, + "peerTargetDatabaseId": peer_target_database_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -36701,7 +38668,8 @@ def update_on_prem_connector(self, on_prem_connector_id, update_on_prem_connecto "accept": "application/json", "content-type": "application/json", "if-match": kwargs.get("if_match", missing), - "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} @@ -36714,6 +38682,7 @@ def update_on_prem_connector(self, on_prem_connector_id, update_on_prem_connecto 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( @@ -36722,7 +38691,7 @@ def update_on_prem_connector(self, on_prem_connector_id, update_on_prem_connecto method=method, path_params=path_params, header_params=header_params, - body=update_on_prem_connector_details, + body=update_peer_target_database_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -36733,28 +38702,22 @@ def update_on_prem_connector(self, on_prem_connector_id, update_on_prem_connecto method=method, path_params=path_params, header_params=header_params, - body=update_on_prem_connector_details, + body=update_peer_target_database_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def update_on_prem_connector_wallet(self, update_on_prem_connector_wallet_details, on_prem_connector_id, **kwargs): + def update_report(self, report_id, update_report_details, **kwargs): """ - Updates the wallet for the specified on-premises connector to a new version. - + Updates the specified report. Only tags can be updated. - :param oci.data_safe.models.UpdateOnPremConnectorWalletDetails update_on_prem_connector_wallet_details: (required) - The details used to update an on-premises connector's wallet. - :param str on_prem_connector_id: (required) - The OCID of the on-premises connector. + :param str report_id: (required) + Unique report identifier - :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 oci.data_safe.models.UpdateReportDetails update_report_details: (required) + Details for the modified report. :param str if_match: (optional) For optimistic concurrency control. In the PUT or DELETE call @@ -36766,6 +38729,12 @@ def update_on_prem_connector_wallet(self, update_on_prem_connector_wallet_detail :param str opc_request_id: (optional) Unique identifier for the request. + :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. @@ -36782,30 +38751,30 @@ def update_on_prem_connector_wallet(self, update_on_prem_connector_wallet_detail :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use update_on_prem_connector_wallet API. + Click `here `__ to see an example of how to use update_report API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['onPremConnectorId'] - resource_path = "/onPremConnectors/{onPremConnectorId}/wallet" + required_arguments = ['reportId'] + resource_path = "/reports/{reportId}" method = "PUT" - operation_name = "update_on_prem_connector_wallet" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/OnPremConnector/UpdateOnPremConnectorWallet" + operation_name = "update_report" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/Report/UpdateReport" # Don't accept unknown kwargs expected_kwargs = [ "allow_control_chars", "retry_strategy", - "opc_retry_token", "if_match", - "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( - f"update_on_prem_connector_wallet got unknown kwargs: {extra_kwargs!r}") + f"update_report got unknown kwargs: {extra_kwargs!r}") path_params = { - "onPremConnectorId": on_prem_connector_id + "reportId": report_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -36817,9 +38786,9 @@ def update_on_prem_connector_wallet(self, update_on_prem_connector_wallet_detail header_params = { "accept": "application/json", "content-type": "application/json", - "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) + "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} @@ -36841,7 +38810,7 @@ def update_on_prem_connector_wallet(self, update_on_prem_connector_wallet_detail method=method, path_params=path_params, header_params=header_params, - body=update_on_prem_connector_wallet_details, + body=update_report_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -36852,25 +38821,22 @@ def update_on_prem_connector_wallet(self, update_on_prem_connector_wallet_detail method=method, path_params=path_params, header_params=header_params, - body=update_on_prem_connector_wallet_details, + body=update_report_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def update_peer_target_database(self, target_database_id, peer_target_database_id, update_peer_target_database_details, **kwargs): + def update_report_definition(self, report_definition_id, update_report_definition_details, **kwargs): """ - Updates one or more attributes of the specified Data Safe peer target database. - + Updates the specified report definition. Only user created report definition can be updated. Seeded report definitions need to be saved as new report definition first. - :param str target_database_id: (required) - The OCID of the Data Safe target database. - :param int peer_target_database_id: (required) - The unique id of the peer target database. + :param str report_definition_id: (required) + Unique report definition identifier - :param oci.data_safe.models.UpdatePeerTargetDatabaseDetails update_peer_target_database_details: (required) - Database details to be used to update the peer target database. + :param oci.data_safe.models.UpdateReportDefinitionDetails update_report_definition_details: (required) + Details for the modified report definition. :param str if_match: (optional) For optimistic concurrency control. In the PUT or DELETE call @@ -36904,14 +38870,14 @@ def update_peer_target_database(self, target_database_id, peer_target_database_i :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use update_peer_target_database API. + Click `here `__ to see an example of how to use update_report_definition API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['targetDatabaseId', 'peerTargetDatabaseId'] - resource_path = "/targetDatabases/{targetDatabaseId}/peerTargetDatabases/{peerTargetDatabaseId}" + required_arguments = ['reportDefinitionId'] + resource_path = "/reportDefinitions/{reportDefinitionId}" method = "PUT" - operation_name = "update_peer_target_database" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/PeerTargetDatabase/UpdatePeerTargetDatabase" + operation_name = "update_report_definition" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/ReportDefinition/UpdateReportDefinition" # Don't accept unknown kwargs expected_kwargs = [ @@ -36924,11 +38890,10 @@ def update_peer_target_database(self, target_database_id, peer_target_database_i extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"update_peer_target_database got unknown kwargs: {extra_kwargs!r}") + f"update_report_definition got unknown kwargs: {extra_kwargs!r}") path_params = { - "targetDatabaseId": target_database_id, - "peerTargetDatabaseId": peer_target_database_id + "reportDefinitionId": report_definition_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -36964,7 +38929,7 @@ def update_peer_target_database(self, target_database_id, peer_target_database_i method=method, path_params=path_params, header_params=header_params, - body=update_peer_target_database_details, + body=update_report_definition_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -36975,22 +38940,22 @@ def update_peer_target_database(self, target_database_id, peer_target_database_i method=method, path_params=path_params, header_params=header_params, - body=update_peer_target_database_details, + body=update_report_definition_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def update_report(self, report_id, update_report_details, **kwargs): + def update_sdm_masking_policy_difference(self, sdm_masking_policy_difference_id, update_sdm_masking_policy_difference_details, **kwargs): """ - Updates the specified report. Only tags can be updated. + Updates one or more attributes of the specified sdm masking policy difference. - :param str report_id: (required) - Unique report identifier + :param str sdm_masking_policy_difference_id: (required) + The OCID of the SDM masking policy difference. - :param oci.data_safe.models.UpdateReportDetails update_report_details: (required) - Details for the modified report. + :param oci.data_safe.models.UpdateSdmMaskingPolicyDifferenceDetails update_sdm_masking_policy_difference_details: (required) + Details to update a sdm masking policy difference. :param str if_match: (optional) For optimistic concurrency control. In the PUT or DELETE call @@ -37002,12 +38967,6 @@ def update_report(self, report_id, update_report_details, **kwargs): :param str opc_request_id: (optional) Unique identifier for the request. - :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. @@ -37024,30 +38983,29 @@ def update_report(self, report_id, update_report_details, **kwargs): :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use update_report API. + Click `here `__ to see an example of how to use update_sdm_masking_policy_difference API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['reportId'] - resource_path = "/reports/{reportId}" + required_arguments = ['sdmMaskingPolicyDifferenceId'] + resource_path = "/sdmMaskingPolicyDifferences/{sdmMaskingPolicyDifferenceId}" method = "PUT" - operation_name = "update_report" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/Report/UpdateReport" + operation_name = "update_sdm_masking_policy_difference" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/SdmMaskingPolicyDifference/UpdateSdmMaskingPolicyDifference" # Don't accept unknown kwargs expected_kwargs = [ "allow_control_chars", "retry_strategy", "if_match", - "opc_request_id", - "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( - f"update_report got unknown kwargs: {extra_kwargs!r}") + f"update_sdm_masking_policy_difference got unknown kwargs: {extra_kwargs!r}") path_params = { - "reportId": report_id + "sdmMaskingPolicyDifferenceId": sdm_masking_policy_difference_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -37060,8 +39018,7 @@ def update_report(self, report_id, update_report_details, **kwargs): "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) + "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} @@ -37074,7 +39031,6 @@ def update_report(self, report_id, update_report_details, **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( @@ -37083,7 +39039,7 @@ def update_report(self, report_id, update_report_details, **kwargs): method=method, path_params=path_params, header_params=header_params, - body=update_report_details, + body=update_sdm_masking_policy_difference_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -37094,22 +39050,25 @@ def update_report(self, report_id, update_report_details, **kwargs): method=method, path_params=path_params, header_params=header_params, - body=update_report_details, + body=update_sdm_masking_policy_difference_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def update_report_definition(self, report_definition_id, update_report_definition_details, **kwargs): + def update_security_assessment(self, security_assessment_id, update_security_assessment_details, **kwargs): """ - Updates the specified report definition. Only user created report definition can be updated. Seeded report definitions need to be saved as new report definition first. + Updates one or more attributes of the specified security assessment. This operation allows to update the security assessment displayName, description, or schedule. - :param str report_definition_id: (required) - Unique report definition identifier + :param str security_assessment_id: (required) + The OCID of the security assessment. - :param oci.data_safe.models.UpdateReportDefinitionDetails update_report_definition_details: (required) - Details for the modified report definition. + :param oci.data_safe.models.UpdateSecurityAssessmentDetails update_security_assessment_details: (required) + The information to be updated. + + :param str opc_request_id: (optional) + Unique identifier for the request. :param str if_match: (optional) For optimistic concurrency control. In the PUT or DELETE call @@ -37118,15 +39077,6 @@ def update_report_definition(self, report_definition_id, update_report_definitio 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 identifier for the request. - - :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. @@ -37143,30 +39093,29 @@ def update_report_definition(self, report_definition_id, update_report_definitio :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use update_report_definition API. + Click `here `__ to see an example of how to use update_security_assessment API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['reportDefinitionId'] - resource_path = "/reportDefinitions/{reportDefinitionId}" + required_arguments = ['securityAssessmentId'] + resource_path = "/securityAssessments/{securityAssessmentId}" method = "PUT" - operation_name = "update_report_definition" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/ReportDefinition/UpdateReportDefinition" + operation_name = "update_security_assessment" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/SecurityAssessment/UpdateSecurityAssessment" # Don't accept unknown kwargs expected_kwargs = [ "allow_control_chars", "retry_strategy", - "if_match", "opc_request_id", - "opc_retry_token" + "if_match" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"update_report_definition got unknown kwargs: {extra_kwargs!r}") + f"update_security_assessment got unknown kwargs: {extra_kwargs!r}") path_params = { - "reportDefinitionId": report_definition_id + "securityAssessmentId": security_assessment_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -37178,9 +39127,8 @@ def update_report_definition(self, report_definition_id, update_report_definitio 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) + "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} @@ -37193,7 +39141,6 @@ def update_report_definition(self, report_definition_id, update_report_definitio 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( @@ -37202,7 +39149,7 @@ def update_report_definition(self, report_definition_id, update_report_definitio method=method, path_params=path_params, header_params=header_params, - body=update_report_definition_details, + body=update_security_assessment_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -37213,22 +39160,22 @@ def update_report_definition(self, report_definition_id, update_report_definitio method=method, path_params=path_params, header_params=header_params, - body=update_report_definition_details, + body=update_security_assessment_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def update_sdm_masking_policy_difference(self, sdm_masking_policy_difference_id, update_sdm_masking_policy_difference_details, **kwargs): + def update_security_policy(self, security_policy_id, update_security_policy_details, **kwargs): """ - Updates one or more attributes of the specified sdm masking policy difference. + Updates the security policy. - :param str sdm_masking_policy_difference_id: (required) - The OCID of the SDM masking policy difference. + :param str security_policy_id: (required) + The OCID of the security policy resource. - :param oci.data_safe.models.UpdateSdmMaskingPolicyDifferenceDetails update_sdm_masking_policy_difference_details: (required) - Details to update a sdm masking policy difference. + :param oci.data_safe.models.UpdateSecurityPolicyDetails update_security_policy_details: (required) + Details to update the security policy. :param str if_match: (optional) For optimistic concurrency control. In the PUT or DELETE call @@ -37256,14 +39203,14 @@ def update_sdm_masking_policy_difference(self, sdm_masking_policy_difference_id, :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use update_sdm_masking_policy_difference API. + Click `here `__ to see an example of how to use update_security_policy API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['sdmMaskingPolicyDifferenceId'] - resource_path = "/sdmMaskingPolicyDifferences/{sdmMaskingPolicyDifferenceId}" + required_arguments = ['securityPolicyId'] + resource_path = "/securityPolicies/{securityPolicyId}" method = "PUT" - operation_name = "update_sdm_masking_policy_difference" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/SdmMaskingPolicyDifference/UpdateSdmMaskingPolicyDifference" + operation_name = "update_security_policy" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/SecurityPolicy/UpdateSecurityPolicy" # Don't accept unknown kwargs expected_kwargs = [ @@ -37275,10 +39222,10 @@ def update_sdm_masking_policy_difference(self, sdm_masking_policy_difference_id, extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"update_sdm_masking_policy_difference got unknown kwargs: {extra_kwargs!r}") + f"update_security_policy got unknown kwargs: {extra_kwargs!r}") path_params = { - "sdmMaskingPolicyDifferenceId": sdm_masking_policy_difference_id + "securityPolicyId": security_policy_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -37312,117 +39259,7 @@ def update_sdm_masking_policy_difference(self, sdm_masking_policy_difference_id, method=method, path_params=path_params, header_params=header_params, - body=update_sdm_masking_policy_difference_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=update_sdm_masking_policy_difference_details, - allow_control_chars=kwargs.get('allow_control_chars'), - operation_name=operation_name, - api_reference_link=api_reference_link, - required_arguments=required_arguments) - - def update_security_assessment(self, security_assessment_id, update_security_assessment_details, **kwargs): - """ - Updates one or more attributes of the specified security assessment. This operation allows to update the security assessment displayName, description, or schedule. - - - :param str security_assessment_id: (required) - The OCID of the security assessment. - - :param oci.data_safe.models.UpdateSecurityAssessmentDetails update_security_assessment_details: (required) - The information to be updated. - - :param str opc_request_id: (optional) - Unique identifier for the request. - - :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 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 update_security_assessment API. - """ - # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['securityAssessmentId'] - resource_path = "/securityAssessments/{securityAssessmentId}" - method = "PUT" - operation_name = "update_security_assessment" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/SecurityAssessment/UpdateSecurityAssessment" - - # Don't accept unknown kwargs - expected_kwargs = [ - "allow_control_chars", - "retry_strategy", - "opc_request_id", - "if_match" - ] - extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] - if extra_kwargs: - raise ValueError( - f"update_security_assessment got unknown kwargs: {extra_kwargs!r}") - - path_params = { - "securityAssessmentId": security_assessment_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(f'Parameter {k} cannot be None, whitespace or empty string') - - header_params = { - "accept": "application/json", - "content-type": "application/json", - "opc-request-id": kwargs.get("opc_request_id", 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 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_security_assessment_details, + body=update_security_policy_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -37433,22 +39270,22 @@ def update_security_assessment(self, security_assessment_id, update_security_ass method=method, path_params=path_params, header_params=header_params, - body=update_security_assessment_details, + body=update_security_policy_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def update_security_policy(self, security_policy_id, update_security_policy_details, **kwargs): + def update_security_policy_deployment(self, security_policy_deployment_id, update_security_policy_deployment_details, **kwargs): """ - Updates the security policy. + Updates the security policy deployment. - :param str security_policy_id: (required) - The OCID of the security policy resource. + :param str security_policy_deployment_id: (required) + The OCID of the security policy deployment resource. - :param oci.data_safe.models.UpdateSecurityPolicyDetails update_security_policy_details: (required) - Details to update the security policy. + :param oci.data_safe.models.UpdateSecurityPolicyDeploymentDetails update_security_policy_deployment_details: (required) + Details to update the security policy deployment. :param str if_match: (optional) For optimistic concurrency control. In the PUT or DELETE call @@ -37476,14 +39313,14 @@ def update_security_policy(self, security_policy_id, update_security_policy_deta :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use update_security_policy API. + Click `here `__ to see an example of how to use update_security_policy_deployment API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['securityPolicyId'] - resource_path = "/securityPolicies/{securityPolicyId}" + required_arguments = ['securityPolicyDeploymentId'] + resource_path = "/securityPolicyDeployments/{securityPolicyDeploymentId}" method = "PUT" - operation_name = "update_security_policy" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/SecurityPolicy/UpdateSecurityPolicy" + operation_name = "update_security_policy_deployment" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/SecurityPolicyDeployment/UpdateSecurityPolicyDeployment" # Don't accept unknown kwargs expected_kwargs = [ @@ -37495,10 +39332,10 @@ def update_security_policy(self, security_policy_id, update_security_policy_deta extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"update_security_policy got unknown kwargs: {extra_kwargs!r}") + f"update_security_policy_deployment got unknown kwargs: {extra_kwargs!r}") path_params = { - "securityPolicyId": security_policy_id + "securityPolicyDeploymentId": security_policy_deployment_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -37532,7 +39369,7 @@ def update_security_policy(self, security_policy_id, update_security_policy_deta method=method, path_params=path_params, header_params=header_params, - body=update_security_policy_details, + body=update_security_policy_deployment_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -37543,22 +39380,25 @@ def update_security_policy(self, security_policy_id, update_security_policy_deta method=method, path_params=path_params, header_params=header_params, - body=update_security_policy_details, + body=update_security_policy_deployment_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def update_security_policy_deployment(self, security_policy_deployment_id, update_security_policy_deployment_details, **kwargs): + def update_sensitive_column(self, sensitive_data_model_id, sensitive_column_key, update_sensitive_column_details, **kwargs): """ - Updates the security policy deployment. + Updates one or more attributes of the specified sensitive column. - :param str security_policy_deployment_id: (required) - The OCID of the security policy deployment resource. + :param str sensitive_data_model_id: (required) + The OCID of the sensitive data model. - :param oci.data_safe.models.UpdateSecurityPolicyDeploymentDetails update_security_policy_deployment_details: (required) - Details to update the security policy deployment. + :param str sensitive_column_key: (required) + The unique key that identifies the sensitive column. It's numeric and unique within a sensitive data model. + + :param oci.data_safe.models.UpdateSensitiveColumnDetails update_sensitive_column_details: (required) + Details to update a sensitive column. :param str if_match: (optional) For optimistic concurrency control. In the PUT or DELETE call @@ -37586,14 +39426,14 @@ def update_security_policy_deployment(self, security_policy_deployment_id, updat :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use update_security_policy_deployment API. + Click `here `__ to see an example of how to use update_sensitive_column API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['securityPolicyDeploymentId'] - resource_path = "/securityPolicyDeployments/{securityPolicyDeploymentId}" + required_arguments = ['sensitiveDataModelId', 'sensitiveColumnKey'] + resource_path = "/sensitiveDataModels/{sensitiveDataModelId}/sensitiveColumns/{sensitiveColumnKey}" method = "PUT" - operation_name = "update_security_policy_deployment" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/SecurityPolicyDeployment/UpdateSecurityPolicyDeployment" + operation_name = "update_sensitive_column" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/SensitiveColumn/UpdateSensitiveColumn" # Don't accept unknown kwargs expected_kwargs = [ @@ -37605,10 +39445,11 @@ def update_security_policy_deployment(self, security_policy_deployment_id, updat extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"update_security_policy_deployment got unknown kwargs: {extra_kwargs!r}") + f"update_sensitive_column got unknown kwargs: {extra_kwargs!r}") path_params = { - "securityPolicyDeploymentId": security_policy_deployment_id + "sensitiveDataModelId": sensitive_data_model_id, + "sensitiveColumnKey": sensitive_column_key } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -37642,7 +39483,7 @@ def update_security_policy_deployment(self, security_policy_deployment_id, updat method=method, path_params=path_params, header_params=header_params, - body=update_security_policy_deployment_details, + body=update_sensitive_column_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -37653,25 +39494,23 @@ def update_security_policy_deployment(self, security_policy_deployment_id, updat method=method, path_params=path_params, header_params=header_params, - body=update_security_policy_deployment_details, + body=update_sensitive_column_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def update_sensitive_column(self, sensitive_data_model_id, sensitive_column_key, update_sensitive_column_details, **kwargs): + def update_sensitive_data_model(self, sensitive_data_model_id, update_sensitive_data_model_details, **kwargs): """ - Updates one or more attributes of the specified sensitive column. + Updates one or more attributes of the specified sensitive data model. Note that updating any attribute of a sensitive + data model does not perform data discovery. :param str sensitive_data_model_id: (required) The OCID of the sensitive data model. - :param str sensitive_column_key: (required) - The unique key that identifies the sensitive column. It's numeric and unique within a sensitive data model. - - :param oci.data_safe.models.UpdateSensitiveColumnDetails update_sensitive_column_details: (required) - Details to update a sensitive column. + :param oci.data_safe.models.UpdateSensitiveDataModelDetails update_sensitive_data_model_details: (required) + Details to update a sensitive data model. :param str if_match: (optional) For optimistic concurrency control. In the PUT or DELETE call @@ -37699,14 +39538,14 @@ def update_sensitive_column(self, sensitive_data_model_id, sensitive_column_key, :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use update_sensitive_column API. + Click `here `__ to see an example of how to use update_sensitive_data_model API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['sensitiveDataModelId', 'sensitiveColumnKey'] - resource_path = "/sensitiveDataModels/{sensitiveDataModelId}/sensitiveColumns/{sensitiveColumnKey}" + required_arguments = ['sensitiveDataModelId'] + resource_path = "/sensitiveDataModels/{sensitiveDataModelId}" method = "PUT" - operation_name = "update_sensitive_column" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/SensitiveColumn/UpdateSensitiveColumn" + operation_name = "update_sensitive_data_model" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/SensitiveDataModel/UpdateSensitiveDataModel" # Don't accept unknown kwargs expected_kwargs = [ @@ -37718,11 +39557,10 @@ def update_sensitive_column(self, sensitive_data_model_id, sensitive_column_key, extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"update_sensitive_column got unknown kwargs: {extra_kwargs!r}") + f"update_sensitive_data_model got unknown kwargs: {extra_kwargs!r}") path_params = { - "sensitiveDataModelId": sensitive_data_model_id, - "sensitiveColumnKey": sensitive_column_key + "sensitiveDataModelId": sensitive_data_model_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -37756,7 +39594,7 @@ def update_sensitive_column(self, sensitive_data_model_id, sensitive_column_key, method=method, path_params=path_params, header_params=header_params, - body=update_sensitive_column_details, + body=update_sensitive_data_model_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -37767,23 +39605,22 @@ def update_sensitive_column(self, sensitive_data_model_id, sensitive_column_key, method=method, path_params=path_params, header_params=header_params, - body=update_sensitive_column_details, + body=update_sensitive_data_model_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def update_sensitive_data_model(self, sensitive_data_model_id, update_sensitive_data_model_details, **kwargs): + def update_sensitive_type(self, sensitive_type_id, update_sensitive_type_details, **kwargs): """ - Updates one or more attributes of the specified sensitive data model. Note that updating any attribute of a sensitive - data model does not perform data discovery. + Updates one or more attributes of the specified sensitive type. - :param str sensitive_data_model_id: (required) - The OCID of the sensitive data model. + :param str sensitive_type_id: (required) + The OCID of the sensitive type. - :param oci.data_safe.models.UpdateSensitiveDataModelDetails update_sensitive_data_model_details: (required) - Details to update a sensitive data model. + :param oci.data_safe.models.UpdateSensitiveTypeDetails update_sensitive_type_details: (required) + Details to update a sensitive type. :param str if_match: (optional) For optimistic concurrency control. In the PUT or DELETE call @@ -37811,14 +39648,14 @@ def update_sensitive_data_model(self, sensitive_data_model_id, update_sensitive_ :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use update_sensitive_data_model API. + Click `here `__ to see an example of how to use update_sensitive_type API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['sensitiveDataModelId'] - resource_path = "/sensitiveDataModels/{sensitiveDataModelId}" + required_arguments = ['sensitiveTypeId'] + resource_path = "/sensitiveTypes/{sensitiveTypeId}" method = "PUT" - operation_name = "update_sensitive_data_model" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/SensitiveDataModel/UpdateSensitiveDataModel" + operation_name = "update_sensitive_type" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/SensitiveType/UpdateSensitiveType" # Don't accept unknown kwargs expected_kwargs = [ @@ -37830,10 +39667,10 @@ def update_sensitive_data_model(self, sensitive_data_model_id, update_sensitive_ extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"update_sensitive_data_model got unknown kwargs: {extra_kwargs!r}") + f"update_sensitive_type got unknown kwargs: {extra_kwargs!r}") path_params = { - "sensitiveDataModelId": sensitive_data_model_id + "sensitiveTypeId": sensitive_type_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -37867,7 +39704,7 @@ def update_sensitive_data_model(self, sensitive_data_model_id, update_sensitive_ method=method, path_params=path_params, header_params=header_params, - body=update_sensitive_data_model_details, + body=update_sensitive_type_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -37878,21 +39715,21 @@ def update_sensitive_data_model(self, sensitive_data_model_id, update_sensitive_ method=method, path_params=path_params, header_params=header_params, - body=update_sensitive_data_model_details, + body=update_sensitive_type_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def update_sensitive_type(self, sensitive_type_id, update_sensitive_type_details, **kwargs): + def update_sensitive_types_export(self, sensitive_types_export_id, update_sensitive_types_export_details, **kwargs): """ - Updates one or more attributes of the specified sensitive type. + Updates one or more attributes of the specified sensitive types export. - :param str sensitive_type_id: (required) - The OCID of the sensitive type. + :param str sensitive_types_export_id: (required) + The OCID of the sensitive types export. - :param oci.data_safe.models.UpdateSensitiveTypeDetails update_sensitive_type_details: (required) + :param oci.data_safe.models.UpdateSensitiveTypesExportDetails update_sensitive_types_export_details: (required) Details to update a sensitive type. :param str if_match: (optional) @@ -37921,14 +39758,14 @@ def update_sensitive_type(self, sensitive_type_id, update_sensitive_type_details :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use update_sensitive_type API. + Click `here `__ to see an example of how to use update_sensitive_types_export API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['sensitiveTypeId'] - resource_path = "/sensitiveTypes/{sensitiveTypeId}" + required_arguments = ['sensitiveTypesExportId'] + resource_path = "/sensitiveTypesExports/{sensitiveTypesExportId}" method = "PUT" - operation_name = "update_sensitive_type" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/SensitiveType/UpdateSensitiveType" + operation_name = "update_sensitive_types_export" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-safe/20181201/SensitiveTypesExport/UpdateSensitiveTypesExport" # Don't accept unknown kwargs expected_kwargs = [ @@ -37940,10 +39777,10 @@ def update_sensitive_type(self, sensitive_type_id, update_sensitive_type_details extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"update_sensitive_type got unknown kwargs: {extra_kwargs!r}") + f"update_sensitive_types_export got unknown kwargs: {extra_kwargs!r}") path_params = { - "sensitiveTypeId": sensitive_type_id + "sensitiveTypesExportId": sensitive_types_export_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -37977,7 +39814,7 @@ def update_sensitive_type(self, sensitive_type_id, update_sensitive_type_details method=method, path_params=path_params, header_params=header_params, - body=update_sensitive_type_details, + body=update_sensitive_types_export_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -37988,7 +39825,7 @@ def update_sensitive_type(self, sensitive_type_id, update_sensitive_type_details method=method, path_params=path_params, header_params=header_params, - body=update_sensitive_type_details, + body=update_sensitive_types_export_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, diff --git a/src/oci/data_safe/data_safe_client_composite_operations.py b/src/oci/data_safe/data_safe_client_composite_operations.py index 711352b443..1c490371ad 100644 --- a/src/oci/data_safe/data_safe_client_composite_operations.py +++ b/src/oci/data_safe/data_safe_client_composite_operations.py @@ -229,6 +229,48 @@ def apply_sdm_masking_policy_difference_and_wait_for_state(self, masking_policy_ except Exception as e: raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def bulk_create_sensitive_types_and_wait_for_state(self, bulk_create_sensitive_types_details, opc_compartment_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.data_safe.DataSafeClient.bulk_create_sensitive_types` and waits for the :py:class:`~oci.data_safe.models.WorkRequest` + to enter the given state(s). + + :param stream bulk_create_sensitive_types_details: (required) + Details to upload a sensitive types file and create all. + + :param str opc_compartment_id: (required) + A header param to create bulk resources in the specified compartment OCID. + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.data_safe.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.data_safe.DataSafeClient.bulk_create_sensitive_types` + + :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.bulk_create_sensitive_types(bulk_create_sensitive_types_details, opc_compartment_id, **operation_kwargs) + if not wait_for_states: + return operation_result + lowered_wait_for_states = [w.lower() for w in wait_for_states] + if 'opc-work-request-id' not in operation_result.headers: + return operation_result + wait_for_resource_id = operation_result.headers['opc-work-request-id'] + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_work_request(wait_for_resource_id), + evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_wait_for_states, + **waiter_kwargs + ) + result_to_return = waiter_result + + return result_to_return + except Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def bulk_create_sql_firewall_allowed_sqls_and_wait_for_state(self, bulk_create_sql_firewall_allowed_sqls_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): """ Calls :py:func:`~oci.data_safe.DataSafeClient.bulk_create_sql_firewall_allowed_sqls` and waits for the :py:class:`~oci.data_safe.models.WorkRequest` @@ -1420,6 +1462,48 @@ def create_peer_target_database_and_wait_for_state(self, target_database_id, cre except Exception as e: raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def create_referential_relation_and_wait_for_state(self, sensitive_data_model_id, create_referential_relation_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.data_safe.DataSafeClient.create_referential_relation` and waits for the :py:class:`~oci.data_safe.models.WorkRequest` + to enter the given state(s). + + :param str sensitive_data_model_id: (required) + The OCID of the sensitive data model. + + :param oci.data_safe.models.CreateReferentialRelationDetails create_referential_relation_details: (required) + Details to create a new referential relation. + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.data_safe.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.data_safe.DataSafeClient.create_referential_relation` + + :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_referential_relation(sensitive_data_model_id, create_referential_relation_details, **operation_kwargs) + if not wait_for_states: + return operation_result + lowered_wait_for_states = [w.lower() for w in wait_for_states] + if 'opc-work-request-id' not in operation_result.headers: + return operation_result + wait_for_resource_id = operation_result.headers['opc-work-request-id'] + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_work_request(wait_for_resource_id), + evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_wait_for_states, + **waiter_kwargs + ) + result_to_return = waiter_result + + return result_to_return + except Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def create_report_definition_and_wait_for_state(self, create_report_definition_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): """ Calls :py:func:`~oci.data_safe.DataSafeClient.create_report_definition` and waits for the :py:class:`~oci.data_safe.models.WorkRequest` @@ -1657,6 +1741,45 @@ def create_sensitive_type_and_wait_for_state(self, create_sensitive_type_details except Exception as e: raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def create_sensitive_types_export_and_wait_for_state(self, create_sensitive_types_export_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.data_safe.DataSafeClient.create_sensitive_types_export` and waits for the :py:class:`~oci.data_safe.models.WorkRequest` + to enter the given state(s). + + :param oci.data_safe.models.CreateSensitiveTypesExportDetails create_sensitive_types_export_details: (required) + Details to create a new sensitive types export resource. + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.data_safe.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.data_safe.DataSafeClient.create_sensitive_types_export` + + :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_sensitive_types_export(create_sensitive_types_export_details, **operation_kwargs) + if not wait_for_states: + return operation_result + lowered_wait_for_states = [w.lower() for w in wait_for_states] + if 'opc-work-request-id' not in operation_result.headers: + return operation_result + wait_for_resource_id = operation_result.headers['opc-work-request-id'] + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_work_request(wait_for_resource_id), + evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_wait_for_states, + **waiter_kwargs + ) + result_to_return = waiter_result + + return result_to_return + except Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def create_sql_collection_and_wait_for_state(self, create_sql_collection_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): """ Calls :py:func:`~oci.data_safe.DataSafeClient.create_sql_collection` and waits for the :py:class:`~oci.data_safe.models.WorkRequest` @@ -2634,6 +2757,65 @@ def delete_sensitive_type_and_wait_for_state(self, sensitive_type_id, wait_for_s except Exception as e: raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def delete_sensitive_types_export_and_wait_for_state(self, sensitive_types_export_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.data_safe.DataSafeClient.delete_sensitive_types_export` and waits for the :py:class:`~oci.data_safe.models.SensitiveTypesExport` acted upon + to enter the given state(s). + + :param str sensitive_types_export_id: (required) + The OCID of the sensitive types export. + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.data_safe.models.SensitiveTypesExport.lifecycle_state` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.data_safe.DataSafeClient.delete_sensitive_types_export` + + :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_sensitive_types_export(sensitive_types_export_id) + operation_result = None + try: + operation_result = self.client.delete_sensitive_types_export(sensitive_types_export_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_sensitive_types_export, 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_sql_collection_and_wait_for_state(self, sql_collection_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): """ Calls :py:func:`~oci.data_safe.DataSafeClient.delete_sql_collection` and waits for the :py:class:`~oci.data_safe.models.WorkRequest` @@ -5562,6 +5744,48 @@ def update_sensitive_type_and_wait_for_state(self, sensitive_type_id, update_sen except Exception as e: raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def update_sensitive_types_export_and_wait_for_state(self, sensitive_types_export_id, update_sensitive_types_export_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.data_safe.DataSafeClient.update_sensitive_types_export` and waits for the :py:class:`~oci.data_safe.models.WorkRequest` + to enter the given state(s). + + :param str sensitive_types_export_id: (required) + The OCID of the sensitive types export. + + :param oci.data_safe.models.UpdateSensitiveTypesExportDetails update_sensitive_types_export_details: (required) + Details to update a sensitive type. + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.data_safe.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.data_safe.DataSafeClient.update_sensitive_types_export` + + :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_sensitive_types_export(sensitive_types_export_id, update_sensitive_types_export_details, **operation_kwargs) + if not wait_for_states: + return operation_result + lowered_wait_for_states = [w.lower() for w in wait_for_states] + if 'opc-work-request-id' not in operation_result.headers: + return operation_result + wait_for_resource_id = operation_result.headers['opc-work-request-id'] + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_work_request(wait_for_resource_id), + evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_wait_for_states, + **waiter_kwargs + ) + result_to_return = waiter_result + + return result_to_return + except Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def update_sql_collection_and_wait_for_state(self, sql_collection_id, update_sql_collection_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): """ Calls :py:func:`~oci.data_safe.DataSafeClient.update_sql_collection` and waits for the :py:class:`~oci.data_safe.models.WorkRequest` diff --git a/src/oci/data_safe/models/__init__.py b/src/oci/data_safe/models/__init__.py index 1a547aed4c..9f23dfda14 100644 --- a/src/oci/data_safe/models/__init__.py +++ b/src/oci/data_safe/models/__init__.py @@ -78,6 +78,7 @@ from .change_security_policy_deployment_compartment_details import ChangeSecurityPolicyDeploymentCompartmentDetails from .change_sensitive_data_model_compartment_details import ChangeSensitiveDataModelCompartmentDetails from .change_sensitive_type_compartment_details import ChangeSensitiveTypeCompartmentDetails +from .change_sensitive_types_export_compartment_details import ChangeSensitiveTypesExportCompartmentDetails from .change_sql_collection_compartment_details import ChangeSqlCollectionCompartmentDetails from .change_sql_firewall_policy_compartment_details import ChangeSqlFirewallPolicyCompartmentDetails from .change_target_alert_policy_association_compartment_details import ChangeTargetAlertPolicyAssociationCompartmentDetails @@ -92,6 +93,7 @@ from .column_source_from_sdm_details import ColumnSourceFromSdmDetails from .column_source_from_target_details import ColumnSourceFromTargetDetails from .column_summary import ColumnSummary +from .columns_info import ColumnsInfo from .compare_security_assessment_details import CompareSecurityAssessmentDetails from .compare_user_assessment_details import CompareUserAssessmentDetails from .compatible_formats_for_data_types import CompatibleFormatsForDataTypes @@ -100,8 +102,6 @@ from .create_alert_policy_details import CreateAlertPolicyDetails from .create_alert_policy_rule_details import CreateAlertPolicyRuleDetails from .create_audit_archive_retrieval_details import CreateAuditArchiveRetrievalDetails -from .create_audit_policy_details import CreateAuditPolicyDetails -from .create_audit_profile_details import CreateAuditProfileDetails from .create_column_source_details import CreateColumnSourceDetails from .create_column_source_from_sdm_details import CreateColumnSourceFromSdmDetails from .create_column_source_from_target_details import CreateColumnSourceFromTargetDetails @@ -112,6 +112,7 @@ from .create_masking_policy_details import CreateMaskingPolicyDetails from .create_on_prem_connector_details import CreateOnPremConnectorDetails from .create_peer_target_database_details import CreatePeerTargetDatabaseDetails +from .create_referential_relation_details import CreateReferentialRelationDetails from .create_report_definition_details import CreateReportDefinitionDetails from .create_sdm_masking_policy_difference_details import CreateSdmMaskingPolicyDifferenceDetails from .create_security_assessment_details import CreateSecurityAssessmentDetails @@ -120,6 +121,7 @@ from .create_sensitive_data_model_details import CreateSensitiveDataModelDetails from .create_sensitive_type_details import CreateSensitiveTypeDetails from .create_sensitive_type_pattern_details import CreateSensitiveTypePatternDetails +from .create_sensitive_types_export_details import CreateSensitiveTypesExportDetails from .create_sql_collection_details import CreateSqlCollectionDetails from .create_target_alert_policy_association_details import CreateTargetAlertPolicyAssociationDetails from .create_target_database_details import CreateTargetDatabaseDetails @@ -161,6 +163,7 @@ from .download_masking_report_details import DownloadMaskingReportDetails from .download_security_assessment_report_details import DownloadSecurityAssessmentReportDetails from .download_sensitive_data_model_details import DownloadSensitiveDataModelDetails +from .download_sensitive_types_export_details import DownloadSensitiveTypesExportDetails from .download_user_assessment_report_details import DownloadUserAssessmentReportDetails from .enable_conditions import EnableConditions from .enable_data_safe_configuration_details import EnableDataSafeConfigurationDetails @@ -211,11 +214,14 @@ from .masking_object_summary import MaskingObjectSummary from .masking_policy import MaskingPolicy from .masking_policy_collection import MaskingPolicyCollection +from .masking_policy_columns_info import MaskingPolicyColumnsInfo from .masking_policy_health_report import MaskingPolicyHealthReport from .masking_policy_health_report_collection import MaskingPolicyHealthReportCollection from .masking_policy_health_report_log_collection import MaskingPolicyHealthReportLogCollection from .masking_policy_health_report_log_summary import MaskingPolicyHealthReportLogSummary from .masking_policy_health_report_summary import MaskingPolicyHealthReportSummary +from .masking_policy_referential_relation_collection import MaskingPolicyReferentialRelationCollection +from .masking_policy_referential_relation_summary import MaskingPolicyReferentialRelationSummary from .masking_policy_summary import MaskingPolicySummary from .masking_report import MaskingReport from .masking_report_collection import MaskingReportCollection @@ -261,6 +267,9 @@ from .random_string_format_entry import RandomStringFormatEntry from .random_substitution_format_entry import RandomSubstitutionFormatEntry from .references import References +from .referential_relation import ReferentialRelation +from .referential_relation_collection import ReferentialRelationCollection +from .referential_relation_summary import ReferentialRelationSummary from .regular_expression_format_entry import RegularExpressionFormatEntry from .report import Report from .report_collection import ReportCollection @@ -325,6 +334,9 @@ from .sensitive_type_collection import SensitiveTypeCollection from .sensitive_type_pattern import SensitiveTypePattern from .sensitive_type_summary import SensitiveTypeSummary +from .sensitive_types_export import SensitiveTypesExport +from .sensitive_types_export_collection import SensitiveTypesExportCollection +from .sensitive_types_export_summary import SensitiveTypesExportSummary from .shuffle_format_entry import ShuffleFormatEntry from .sql_collection import SqlCollection from .sql_collection_aggregation import SqlCollectionAggregation @@ -398,6 +410,7 @@ from .update_sensitive_data_model_details import UpdateSensitiveDataModelDetails from .update_sensitive_type_details import UpdateSensitiveTypeDetails from .update_sensitive_type_pattern_details import UpdateSensitiveTypePatternDetails +from .update_sensitive_types_export_details import UpdateSensitiveTypesExportDetails from .update_sql_collection_details import UpdateSqlCollectionDetails from .update_sql_firewall_config_details import UpdateSqlFirewallConfigDetails from .update_sql_firewall_policy_details import UpdateSqlFirewallPolicyDetails @@ -493,6 +506,7 @@ "ChangeSecurityPolicyDeploymentCompartmentDetails": ChangeSecurityPolicyDeploymentCompartmentDetails, "ChangeSensitiveDataModelCompartmentDetails": ChangeSensitiveDataModelCompartmentDetails, "ChangeSensitiveTypeCompartmentDetails": ChangeSensitiveTypeCompartmentDetails, + "ChangeSensitiveTypesExportCompartmentDetails": ChangeSensitiveTypesExportCompartmentDetails, "ChangeSqlCollectionCompartmentDetails": ChangeSqlCollectionCompartmentDetails, "ChangeSqlFirewallPolicyCompartmentDetails": ChangeSqlFirewallPolicyCompartmentDetails, "ChangeTargetAlertPolicyAssociationCompartmentDetails": ChangeTargetAlertPolicyAssociationCompartmentDetails, @@ -507,6 +521,7 @@ "ColumnSourceFromSdmDetails": ColumnSourceFromSdmDetails, "ColumnSourceFromTargetDetails": ColumnSourceFromTargetDetails, "ColumnSummary": ColumnSummary, + "ColumnsInfo": ColumnsInfo, "CompareSecurityAssessmentDetails": CompareSecurityAssessmentDetails, "CompareUserAssessmentDetails": CompareUserAssessmentDetails, "CompatibleFormatsForDataTypes": CompatibleFormatsForDataTypes, @@ -515,8 +530,6 @@ "CreateAlertPolicyDetails": CreateAlertPolicyDetails, "CreateAlertPolicyRuleDetails": CreateAlertPolicyRuleDetails, "CreateAuditArchiveRetrievalDetails": CreateAuditArchiveRetrievalDetails, - "CreateAuditPolicyDetails": CreateAuditPolicyDetails, - "CreateAuditProfileDetails": CreateAuditProfileDetails, "CreateColumnSourceDetails": CreateColumnSourceDetails, "CreateColumnSourceFromSdmDetails": CreateColumnSourceFromSdmDetails, "CreateColumnSourceFromTargetDetails": CreateColumnSourceFromTargetDetails, @@ -527,6 +540,7 @@ "CreateMaskingPolicyDetails": CreateMaskingPolicyDetails, "CreateOnPremConnectorDetails": CreateOnPremConnectorDetails, "CreatePeerTargetDatabaseDetails": CreatePeerTargetDatabaseDetails, + "CreateReferentialRelationDetails": CreateReferentialRelationDetails, "CreateReportDefinitionDetails": CreateReportDefinitionDetails, "CreateSdmMaskingPolicyDifferenceDetails": CreateSdmMaskingPolicyDifferenceDetails, "CreateSecurityAssessmentDetails": CreateSecurityAssessmentDetails, @@ -535,6 +549,7 @@ "CreateSensitiveDataModelDetails": CreateSensitiveDataModelDetails, "CreateSensitiveTypeDetails": CreateSensitiveTypeDetails, "CreateSensitiveTypePatternDetails": CreateSensitiveTypePatternDetails, + "CreateSensitiveTypesExportDetails": CreateSensitiveTypesExportDetails, "CreateSqlCollectionDetails": CreateSqlCollectionDetails, "CreateTargetAlertPolicyAssociationDetails": CreateTargetAlertPolicyAssociationDetails, "CreateTargetDatabaseDetails": CreateTargetDatabaseDetails, @@ -576,6 +591,7 @@ "DownloadMaskingReportDetails": DownloadMaskingReportDetails, "DownloadSecurityAssessmentReportDetails": DownloadSecurityAssessmentReportDetails, "DownloadSensitiveDataModelDetails": DownloadSensitiveDataModelDetails, + "DownloadSensitiveTypesExportDetails": DownloadSensitiveTypesExportDetails, "DownloadUserAssessmentReportDetails": DownloadUserAssessmentReportDetails, "EnableConditions": EnableConditions, "EnableDataSafeConfigurationDetails": EnableDataSafeConfigurationDetails, @@ -626,11 +642,14 @@ "MaskingObjectSummary": MaskingObjectSummary, "MaskingPolicy": MaskingPolicy, "MaskingPolicyCollection": MaskingPolicyCollection, + "MaskingPolicyColumnsInfo": MaskingPolicyColumnsInfo, "MaskingPolicyHealthReport": MaskingPolicyHealthReport, "MaskingPolicyHealthReportCollection": MaskingPolicyHealthReportCollection, "MaskingPolicyHealthReportLogCollection": MaskingPolicyHealthReportLogCollection, "MaskingPolicyHealthReportLogSummary": MaskingPolicyHealthReportLogSummary, "MaskingPolicyHealthReportSummary": MaskingPolicyHealthReportSummary, + "MaskingPolicyReferentialRelationCollection": MaskingPolicyReferentialRelationCollection, + "MaskingPolicyReferentialRelationSummary": MaskingPolicyReferentialRelationSummary, "MaskingPolicySummary": MaskingPolicySummary, "MaskingReport": MaskingReport, "MaskingReportCollection": MaskingReportCollection, @@ -676,6 +695,9 @@ "RandomStringFormatEntry": RandomStringFormatEntry, "RandomSubstitutionFormatEntry": RandomSubstitutionFormatEntry, "References": References, + "ReferentialRelation": ReferentialRelation, + "ReferentialRelationCollection": ReferentialRelationCollection, + "ReferentialRelationSummary": ReferentialRelationSummary, "RegularExpressionFormatEntry": RegularExpressionFormatEntry, "Report": Report, "ReportCollection": ReportCollection, @@ -740,6 +762,9 @@ "SensitiveTypeCollection": SensitiveTypeCollection, "SensitiveTypePattern": SensitiveTypePattern, "SensitiveTypeSummary": SensitiveTypeSummary, + "SensitiveTypesExport": SensitiveTypesExport, + "SensitiveTypesExportCollection": SensitiveTypesExportCollection, + "SensitiveTypesExportSummary": SensitiveTypesExportSummary, "ShuffleFormatEntry": ShuffleFormatEntry, "SqlCollection": SqlCollection, "SqlCollectionAggregation": SqlCollectionAggregation, @@ -813,6 +838,7 @@ "UpdateSensitiveDataModelDetails": UpdateSensitiveDataModelDetails, "UpdateSensitiveTypeDetails": UpdateSensitiveTypeDetails, "UpdateSensitiveTypePatternDetails": UpdateSensitiveTypePatternDetails, + "UpdateSensitiveTypesExportDetails": UpdateSensitiveTypesExportDetails, "UpdateSqlCollectionDetails": UpdateSqlCollectionDetails, "UpdateSqlFirewallConfigDetails": UpdateSqlFirewallConfigDetails, "UpdateSqlFirewallPolicyDetails": UpdateSqlFirewallPolicyDetails, diff --git a/src/oci/data_safe/models/alert.py b/src/oci/data_safe/models/alert.py index ddc1280540..77d645a114 100644 --- a/src/oci/data_safe/models/alert.py +++ b/src/oci/data_safe/models/alert.py @@ -851,7 +851,6 @@ def defined_tags(self): """ Gets the defined_tags of this Alert. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -867,7 +866,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this Alert. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/alert_policy.py b/src/oci/data_safe/models/alert_policy.py index a99e2df775..a542e3a3f2 100644 --- a/src/oci/data_safe/models/alert_policy.py +++ b/src/oci/data_safe/models/alert_policy.py @@ -517,7 +517,6 @@ def defined_tags(self): """ Gets the defined_tags of this AlertPolicy. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -533,7 +532,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this AlertPolicy. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/alert_policy_summary.py b/src/oci/data_safe/models/alert_policy_summary.py index c7ebdda78d..748d8100ed 100644 --- a/src/oci/data_safe/models/alert_policy_summary.py +++ b/src/oci/data_safe/models/alert_policy_summary.py @@ -508,7 +508,6 @@ def defined_tags(self): """ Gets the defined_tags of this AlertPolicySummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -524,7 +523,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this AlertPolicySummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/alert_summary.py b/src/oci/data_safe/models/alert_summary.py index 396c015d7b..77885fc052 100644 --- a/src/oci/data_safe/models/alert_summary.py +++ b/src/oci/data_safe/models/alert_summary.py @@ -782,7 +782,6 @@ def defined_tags(self): """ Gets the defined_tags of this AlertSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -798,7 +797,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this AlertSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/audit_archive_retrieval.py b/src/oci/data_safe/models/audit_archive_retrieval.py index 2e2ede42f8..60410b8362 100644 --- a/src/oci/data_safe/models/audit_archive_retrieval.py +++ b/src/oci/data_safe/models/audit_archive_retrieval.py @@ -559,7 +559,6 @@ def defined_tags(self): """ Gets the defined_tags of this AuditArchiveRetrieval. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -575,7 +574,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this AuditArchiveRetrieval. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/audit_archive_retrieval_summary.py b/src/oci/data_safe/models/audit_archive_retrieval_summary.py index 5f4abb166e..b763722425 100644 --- a/src/oci/data_safe/models/audit_archive_retrieval_summary.py +++ b/src/oci/data_safe/models/audit_archive_retrieval_summary.py @@ -549,7 +549,6 @@ def defined_tags(self): """ Gets the defined_tags of this AuditArchiveRetrievalSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -565,7 +564,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this AuditArchiveRetrievalSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/audit_event_summary.py b/src/oci/data_safe/models/audit_event_summary.py index aa013df20e..66ea6bc045 100644 --- a/src/oci/data_safe/models/audit_event_summary.py +++ b/src/oci/data_safe/models/audit_event_summary.py @@ -1348,7 +1348,6 @@ def defined_tags(self): """ Gets the defined_tags of this AuditEventSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -1364,7 +1363,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this AuditEventSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/audit_policy.py b/src/oci/data_safe/models/audit_policy.py index 4deeacdd0f..927747d8d3 100644 --- a/src/oci/data_safe/models/audit_policy.py +++ b/src/oci/data_safe/models/audit_policy.py @@ -567,7 +567,6 @@ def defined_tags(self): """ Gets the defined_tags of this AuditPolicy. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -583,7 +582,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this AuditPolicy. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/audit_policy_summary.py b/src/oci/data_safe/models/audit_policy_summary.py index a4a57f01a1..19fd8eddf5 100644 --- a/src/oci/data_safe/models/audit_policy_summary.py +++ b/src/oci/data_safe/models/audit_policy_summary.py @@ -529,7 +529,6 @@ def defined_tags(self): """ Gets the defined_tags of this AuditPolicySummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -545,7 +544,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this AuditPolicySummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/audit_profile.py b/src/oci/data_safe/models/audit_profile.py index 9c235353ca..e547708bf5 100644 --- a/src/oci/data_safe/models/audit_profile.py +++ b/src/oci/data_safe/models/audit_profile.py @@ -463,7 +463,7 @@ def online_months(self): """ **[Required]** Gets the online_months of this AuditProfile. Indicates the number of months the audit records will be stored online in Oracle Data Safe audit repository for immediate reporting and analysis. - Minimum: 1; Maximum:12 months + Minimum: 1; Maximum: 12 months :return: The online_months of this AuditProfile. @@ -476,7 +476,7 @@ def online_months(self, online_months): """ Sets the online_months of this AuditProfile. Indicates the number of months the audit records will be stored online in Oracle Data Safe audit repository for immediate reporting and analysis. - Minimum: 1; Maximum:12 months + Minimum: 1; Maximum: 12 months :param online_months: The online_months of this AuditProfile. @@ -601,7 +601,6 @@ def defined_tags(self): """ Gets the defined_tags of this AuditProfile. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -617,7 +616,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this AuditProfile. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/audit_profile_summary.py b/src/oci/data_safe/models/audit_profile_summary.py index 4d76ab3e63..fe6e8af9ee 100644 --- a/src/oci/data_safe/models/audit_profile_summary.py +++ b/src/oci/data_safe/models/audit_profile_summary.py @@ -425,7 +425,7 @@ def online_months(self): """ **[Required]** Gets the online_months of this AuditProfileSummary. Indicates the number of months the audit records will be stored online in Oracle Data Safe audit repository for immediate reporting and analysis. - Minimum: 1; Maximum:12 months + Minimum: 1; Maximum: 12 months :return: The online_months of this AuditProfileSummary. @@ -438,7 +438,7 @@ def online_months(self, online_months): """ Sets the online_months of this AuditProfileSummary. Indicates the number of months the audit records will be stored online in Oracle Data Safe audit repository for immediate reporting and analysis. - Minimum: 1; Maximum:12 months + Minimum: 1; Maximum: 12 months :param online_months: The online_months of this AuditProfileSummary. @@ -565,7 +565,6 @@ def defined_tags(self): """ Gets the defined_tags of this AuditProfileSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -581,7 +580,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this AuditProfileSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/audit_trail.py b/src/oci/data_safe/models/audit_trail.py index a4de88e38a..445c59b46c 100644 --- a/src/oci/data_safe/models/audit_trail.py +++ b/src/oci/data_safe/models/audit_trail.py @@ -866,7 +866,6 @@ def defined_tags(self): """ Gets the defined_tags of this AuditTrail. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -882,7 +881,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this AuditTrail. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/audit_trail_summary.py b/src/oci/data_safe/models/audit_trail_summary.py index 300dc1e221..2e104b578e 100644 --- a/src/oci/data_safe/models/audit_trail_summary.py +++ b/src/oci/data_safe/models/audit_trail_summary.py @@ -630,7 +630,6 @@ def defined_tags(self): """ Gets the defined_tags of this AuditTrailSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -646,7 +645,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this AuditTrailSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/change_retention_details.py b/src/oci/data_safe/models/change_retention_details.py index 3011e7e122..29e90980fc 100644 --- a/src/oci/data_safe/models/change_retention_details.py +++ b/src/oci/data_safe/models/change_retention_details.py @@ -54,7 +54,7 @@ def online_months(self): """ Gets the online_months of this ChangeRetentionDetails. Indicates the number of months the audit records will be stored online in Oracle Data Safe audit repository for - immediate reporting and analysis. Minimum: 1; Maximum:12 months + immediate reporting and analysis. Minimum: 1; Maximum: 12 months :return: The online_months of this ChangeRetentionDetails. @@ -67,7 +67,7 @@ def online_months(self, online_months): """ Sets the online_months of this ChangeRetentionDetails. Indicates the number of months the audit records will be stored online in Oracle Data Safe audit repository for - immediate reporting and analysis. Minimum: 1; Maximum:12 months + immediate reporting and analysis. Minimum: 1; Maximum: 12 months :param online_months: The online_months of this ChangeRetentionDetails. diff --git a/src/oci/data_safe/models/change_sensitive_types_export_compartment_details.py b/src/oci/data_safe/models/change_sensitive_types_export_compartment_details.py new file mode 100644 index 0000000000..2a74769777 --- /dev/null +++ b/src/oci/data_safe/models/change_sensitive_types_export_compartment_details.py @@ -0,0 +1,72 @@ +# coding: utf-8 +# Copyright (c) 2016, 2025, 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: 20181201 + + +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 ChangeSensitiveTypesExportCompartmentDetails(object): + """ + Details for which compartment to move the resource to. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ChangeSensitiveTypesExportCompartmentDetails 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 ChangeSensitiveTypesExportCompartmentDetails. + :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 ChangeSensitiveTypesExportCompartmentDetails. + The OCID of the compartment where you want to move the sensitive types export. + + + :return: The compartment_id of this ChangeSensitiveTypesExportCompartmentDetails. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this ChangeSensitiveTypesExportCompartmentDetails. + The OCID of the compartment where you want to move the sensitive types export. + + + :param compartment_id: The compartment_id of this ChangeSensitiveTypesExportCompartmentDetails. + :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/data_safe/models/column_filter.py b/src/oci/data_safe/models/column_filter.py index 32f2ab4321..1580ac1129 100644 --- a/src/oci/data_safe/models/column_filter.py +++ b/src/oci/data_safe/models/column_filter.py @@ -23,6 +23,10 @@ class ColumnFilter(object): #: This constant has a value of "EQ" OPERATOR_EQ = "EQ" + #: A constant which can be used with the operator property of a ColumnFilter. + #: This constant has a value of "EQ_CS" + OPERATOR_EQ_CS = "EQ_CS" + #: A constant which can be used with the operator property of a ColumnFilter. #: This constant has a value of "GT" OPERATOR_GT = "GT" @@ -55,6 +59,10 @@ class ColumnFilter(object): #: This constant has a value of "CO" OPERATOR_CO = "CO" + #: A constant which can be used with the operator property of a ColumnFilter. + #: This constant has a value of "CO_CS" + OPERATOR_CO_CS = "CO_CS" + #: A constant which can be used with the operator property of a ColumnFilter. #: This constant has a value of "NOT" OPERATOR_NOT = "NOT" @@ -74,7 +82,7 @@ def __init__(self, **kwargs): :param operator: The value to assign to the operator property of this ColumnFilter. - Allowed values for this property are: "IN", "EQ", "GT", "GE", "LT", "LE", "AND", "OR", "NE", "CO", "NOT", "NOT_IN", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "IN", "EQ", "EQ_CS", "GT", "GE", "LT", "LE", "AND", "OR", "NE", "CO", "CO_CS", "NOT", "NOT_IN", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type operator: str @@ -143,7 +151,7 @@ def operator(self): **[Required]** Gets the operator of this ColumnFilter. Specifies the type of operator that must be applied for example in, eq etc. - Allowed values for this property are: "IN", "EQ", "GT", "GE", "LT", "LE", "AND", "OR", "NE", "CO", "NOT", "NOT_IN", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "IN", "EQ", "EQ_CS", "GT", "GE", "LT", "LE", "AND", "OR", "NE", "CO", "CO_CS", "NOT", "NOT_IN", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -162,7 +170,7 @@ def operator(self, operator): :param operator: The operator of this ColumnFilter. :type: str """ - allowed_values = ["IN", "EQ", "GT", "GE", "LT", "LE", "AND", "OR", "NE", "CO", "NOT", "NOT_IN"] + allowed_values = ["IN", "EQ", "EQ_CS", "GT", "GE", "LT", "LE", "AND", "OR", "NE", "CO", "CO_CS", "NOT", "NOT_IN"] if not value_allowed_none_or_none_sentinel(operator, allowed_values): operator = 'UNKNOWN_ENUM_VALUE' self._operator = operator diff --git a/src/oci/data_safe/models/columns_info.py b/src/oci/data_safe/models/columns_info.py new file mode 100644 index 0000000000..278010f958 --- /dev/null +++ b/src/oci/data_safe/models/columns_info.py @@ -0,0 +1,243 @@ +# coding: utf-8 +# Copyright (c) 2016, 2025, 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: 20181201 + + +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 ColumnsInfo(object): + """ + columnsInfo object has details of column group with schema details. + """ + + #: A constant which can be used with the object_type property of a ColumnsInfo. + #: This constant has a value of "TABLE" + OBJECT_TYPE_TABLE = "TABLE" + + def __init__(self, **kwargs): + """ + Initializes a new ColumnsInfo object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param schema_name: + The value to assign to the schema_name property of this ColumnsInfo. + :type schema_name: str + + :param object_type: + The value to assign to the object_type property of this ColumnsInfo. + Allowed values for this property are: "TABLE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type object_type: str + + :param object_name: + The value to assign to the object_name property of this ColumnsInfo. + :type object_name: str + + :param app_name: + The value to assign to the app_name property of this ColumnsInfo. + :type app_name: str + + :param column_group: + The value to assign to the column_group property of this ColumnsInfo. + :type column_group: list[str] + + :param sensitive_type_ids: + The value to assign to the sensitive_type_ids property of this ColumnsInfo. + :type sensitive_type_ids: list[str] + + """ + self.swagger_types = { + 'schema_name': 'str', + 'object_type': 'str', + 'object_name': 'str', + 'app_name': 'str', + 'column_group': 'list[str]', + 'sensitive_type_ids': 'list[str]' + } + + self.attribute_map = { + 'schema_name': 'schemaName', + 'object_type': 'objectType', + 'object_name': 'objectName', + 'app_name': 'appName', + 'column_group': 'columnGroup', + 'sensitive_type_ids': 'sensitiveTypeIds' + } + + self._schema_name = None + self._object_type = None + self._object_name = None + self._app_name = None + self._column_group = None + self._sensitive_type_ids = None + + @property + def schema_name(self): + """ + **[Required]** Gets the schema_name of this ColumnsInfo. + The schema name. + + + :return: The schema_name of this ColumnsInfo. + :rtype: str + """ + return self._schema_name + + @schema_name.setter + def schema_name(self, schema_name): + """ + Sets the schema_name of this ColumnsInfo. + The schema name. + + + :param schema_name: The schema_name of this ColumnsInfo. + :type: str + """ + self._schema_name = schema_name + + @property + def object_type(self): + """ + **[Required]** Gets the object_type of this ColumnsInfo. + The type of the database object that contains the sensitive column. + + Allowed values for this property are: "TABLE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The object_type of this ColumnsInfo. + :rtype: str + """ + return self._object_type + + @object_type.setter + def object_type(self, object_type): + """ + Sets the object_type of this ColumnsInfo. + The type of the database object that contains the sensitive column. + + + :param object_type: The object_type of this ColumnsInfo. + :type: str + """ + allowed_values = ["TABLE"] + if not value_allowed_none_or_none_sentinel(object_type, allowed_values): + object_type = 'UNKNOWN_ENUM_VALUE' + self._object_type = object_type + + @property + def object_name(self): + """ + **[Required]** Gets the object_name of this ColumnsInfo. + The database object that contains the columns. + + + :return: The object_name of this ColumnsInfo. + :rtype: str + """ + return self._object_name + + @object_name.setter + def object_name(self, object_name): + """ + Sets the object_name of this ColumnsInfo. + The database object that contains the columns. + + + :param object_name: The object_name of this ColumnsInfo. + :type: str + """ + self._object_name = object_name + + @property + def app_name(self): + """ + **[Required]** Gets the app_name of this ColumnsInfo. + The application name. + + + :return: The app_name of this ColumnsInfo. + :rtype: str + """ + return self._app_name + + @app_name.setter + def app_name(self, app_name): + """ + Sets the app_name of this ColumnsInfo. + The application name. + + + :param app_name: The app_name of this ColumnsInfo. + :type: str + """ + self._app_name = app_name + + @property + def column_group(self): + """ + **[Required]** Gets the column_group of this ColumnsInfo. + Group of columns in referential relation. Order needs to be maintained in the elements of the parent/child array listing. + + + :return: The column_group of this ColumnsInfo. + :rtype: list[str] + """ + return self._column_group + + @column_group.setter + def column_group(self, column_group): + """ + Sets the column_group of this ColumnsInfo. + Group of columns in referential relation. Order needs to be maintained in the elements of the parent/child array listing. + + + :param column_group: The column_group of this ColumnsInfo. + :type: list[str] + """ + self._column_group = column_group + + @property + def sensitive_type_ids(self): + """ + Gets the sensitive_type_ids of this ColumnsInfo. + Sensitive type ocids of each column groups. Order needs to be maintained with the parent column group. + For the DB defined referential relations identified during SDM creation, we cannot add sensitive types. + Instead use the sensitiveColumn POST API to mark the columns sensitive. + + + :return: The sensitive_type_ids of this ColumnsInfo. + :rtype: list[str] + """ + return self._sensitive_type_ids + + @sensitive_type_ids.setter + def sensitive_type_ids(self, sensitive_type_ids): + """ + Sets the sensitive_type_ids of this ColumnsInfo. + Sensitive type ocids of each column groups. Order needs to be maintained with the parent column group. + For the DB defined referential relations identified during SDM creation, we cannot add sensitive types. + Instead use the sensitiveColumn POST API to mark the columns sensitive. + + + :param sensitive_type_ids: The sensitive_type_ids of this ColumnsInfo. + :type: list[str] + """ + self._sensitive_type_ids = sensitive_type_ids + + 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/data_safe/models/create_alert_policy_details.py b/src/oci/data_safe/models/create_alert_policy_details.py index 5316dca2e2..b4f7ae062c 100644 --- a/src/oci/data_safe/models/create_alert_policy_details.py +++ b/src/oci/data_safe/models/create_alert_policy_details.py @@ -313,7 +313,6 @@ def defined_tags(self): """ Gets the defined_tags of this CreateAlertPolicyDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -329,7 +328,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this CreateAlertPolicyDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/create_audit_archive_retrieval_details.py b/src/oci/data_safe/models/create_audit_archive_retrieval_details.py index f4ed660e70..e045989737 100644 --- a/src/oci/data_safe/models/create_audit_archive_retrieval_details.py +++ b/src/oci/data_safe/models/create_audit_archive_retrieval_details.py @@ -265,7 +265,6 @@ def defined_tags(self): """ Gets the defined_tags of this CreateAuditArchiveRetrievalDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -281,7 +280,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this CreateAuditArchiveRetrievalDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/create_audit_profile_details.py b/src/oci/data_safe/models/create_audit_profile_details.py deleted file mode 100644 index 1eee331c7b..0000000000 --- a/src/oci/data_safe/models/create_audit_profile_details.py +++ /dev/null @@ -1,278 +0,0 @@ -# coding: utf-8 -# Copyright (c) 2016, 2025, 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: 20181201 - - -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 CreateAuditProfileDetails(object): - """ - The details used to create a new audit profile. - """ - - def __init__(self, **kwargs): - """ - Initializes a new CreateAuditProfileDetails object with values from keyword arguments. - 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 CreateAuditProfileDetails. - :type display_name: str - - :param compartment_id: - The value to assign to the compartment_id property of this CreateAuditProfileDetails. - :type compartment_id: str - - :param target_id: - The value to assign to the target_id property of this CreateAuditProfileDetails. - :type target_id: str - - :param description: - The value to assign to the description property of this CreateAuditProfileDetails. - :type description: str - - :param is_paid_usage_enabled: - The value to assign to the is_paid_usage_enabled property of this CreateAuditProfileDetails. - :type is_paid_usage_enabled: bool - - :param freeform_tags: - The value to assign to the freeform_tags property of this CreateAuditProfileDetails. - :type freeform_tags: dict(str, str) - - :param defined_tags: - The value to assign to the defined_tags property of this CreateAuditProfileDetails. - :type defined_tags: dict(str, dict(str, object)) - - """ - self.swagger_types = { - 'display_name': 'str', - 'compartment_id': 'str', - 'target_id': 'str', - 'description': 'str', - 'is_paid_usage_enabled': 'bool', - 'freeform_tags': 'dict(str, str)', - 'defined_tags': 'dict(str, dict(str, object))' - } - - self.attribute_map = { - 'display_name': 'displayName', - 'compartment_id': 'compartmentId', - 'target_id': 'targetId', - 'description': 'description', - 'is_paid_usage_enabled': 'isPaidUsageEnabled', - 'freeform_tags': 'freeformTags', - 'defined_tags': 'definedTags' - } - - self._display_name = None - self._compartment_id = None - self._target_id = None - self._description = None - self._is_paid_usage_enabled = None - self._freeform_tags = None - self._defined_tags = None - - @property - def display_name(self): - """ - Gets the display_name of this CreateAuditProfileDetails. - The display name of the audit profile. The name does not have to be unique, and it's changeable. - - - :return: The display_name of this CreateAuditProfileDetails. - :rtype: str - """ - return self._display_name - - @display_name.setter - def display_name(self, display_name): - """ - Sets the display_name of this CreateAuditProfileDetails. - The display name of the audit profile. The name does not have to be unique, and it's changeable. - - - :param display_name: The display_name of this CreateAuditProfileDetails. - :type: str - """ - self._display_name = display_name - - @property - def compartment_id(self): - """ - **[Required]** Gets the compartment_id of this CreateAuditProfileDetails. - The OCID of the compartment where you want to create the audit profile. - - - :return: The compartment_id of this CreateAuditProfileDetails. - :rtype: str - """ - return self._compartment_id - - @compartment_id.setter - def compartment_id(self, compartment_id): - """ - Sets the compartment_id of this CreateAuditProfileDetails. - The OCID of the compartment where you want to create the audit profile. - - - :param compartment_id: The compartment_id of this CreateAuditProfileDetails. - :type: str - """ - self._compartment_id = compartment_id - - @property - def target_id(self): - """ - **[Required]** Gets the target_id of this CreateAuditProfileDetails. - The OCID of the Data Safe target for which the audit profile is created. - - - :return: The target_id of this CreateAuditProfileDetails. - :rtype: str - """ - return self._target_id - - @target_id.setter - def target_id(self, target_id): - """ - Sets the target_id of this CreateAuditProfileDetails. - The OCID of the Data Safe target for which the audit profile is created. - - - :param target_id: The target_id of this CreateAuditProfileDetails. - :type: str - """ - self._target_id = target_id - - @property - def description(self): - """ - Gets the description of this CreateAuditProfileDetails. - The description of the audit profile. - - - :return: The description of this CreateAuditProfileDetails. - :rtype: str - """ - return self._description - - @description.setter - def description(self, description): - """ - Sets the description of this CreateAuditProfileDetails. - The description of the audit profile. - - - :param description: The description of this CreateAuditProfileDetails. - :type: str - """ - self._description = description - - @property - def is_paid_usage_enabled(self): - """ - Gets the is_paid_usage_enabled of this CreateAuditProfileDetails. - Indicates if you want to continue collecting audit records beyond the free limit of one million audit records per month per target database, - potentially incurring additional charges. The default value is inherited from the global settings. - You can change at the global level or at the target level. - - - :return: The is_paid_usage_enabled of this CreateAuditProfileDetails. - :rtype: bool - """ - return self._is_paid_usage_enabled - - @is_paid_usage_enabled.setter - def is_paid_usage_enabled(self, is_paid_usage_enabled): - """ - Sets the is_paid_usage_enabled of this CreateAuditProfileDetails. - Indicates if you want to continue collecting audit records beyond the free limit of one million audit records per month per target database, - potentially incurring additional charges. The default value is inherited from the global settings. - You can change at the global level or at the target level. - - - :param is_paid_usage_enabled: The is_paid_usage_enabled of this CreateAuditProfileDetails. - :type: bool - """ - self._is_paid_usage_enabled = is_paid_usage_enabled - - @property - def freeform_tags(self): - """ - Gets the freeform_tags of this CreateAuditProfileDetails. - Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see `Resource Tags`__ - - Example: `{\"Department\": \"Finance\"}` - - __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm - - - :return: The freeform_tags of this CreateAuditProfileDetails. - :rtype: dict(str, str) - """ - return self._freeform_tags - - @freeform_tags.setter - def freeform_tags(self, freeform_tags): - """ - Sets the freeform_tags of this CreateAuditProfileDetails. - Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see `Resource Tags`__ - - Example: `{\"Department\": \"Finance\"}` - - __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm - - - :param freeform_tags: The freeform_tags of this CreateAuditProfileDetails. - :type: dict(str, str) - """ - self._freeform_tags = freeform_tags - - @property - def defined_tags(self): - """ - Gets the defined_tags of this CreateAuditProfileDetails. - Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` - - __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm - - - :return: The defined_tags of this CreateAuditProfileDetails. - :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 CreateAuditProfileDetails. - Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` - - __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm - - - :param defined_tags: The defined_tags of this CreateAuditProfileDetails. - :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/data_safe/models/create_data_safe_private_endpoint_details.py b/src/oci/data_safe/models/create_data_safe_private_endpoint_details.py index 3f802ff260..dc2ee186a7 100644 --- a/src/oci/data_safe/models/create_data_safe_private_endpoint_details.py +++ b/src/oci/data_safe/models/create_data_safe_private_endpoint_details.py @@ -296,7 +296,6 @@ def defined_tags(self): """ Gets the defined_tags of this CreateDataSafePrivateEndpointDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -312,7 +311,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this CreateDataSafePrivateEndpointDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/create_discovery_job_details.py b/src/oci/data_safe/models/create_discovery_job_details.py index bffc4fc2c6..ee8ad3684b 100644 --- a/src/oci/data_safe/models/create_discovery_job_details.py +++ b/src/oci/data_safe/models/create_discovery_job_details.py @@ -460,7 +460,6 @@ def defined_tags(self): """ Gets the defined_tags of this CreateDiscoveryJobDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -476,7 +475,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this CreateDiscoveryJobDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/create_library_masking_format_details.py b/src/oci/data_safe/models/create_library_masking_format_details.py index 56a364726e..6818db5a16 100644 --- a/src/oci/data_safe/models/create_library_masking_format_details.py +++ b/src/oci/data_safe/models/create_library_masking_format_details.py @@ -239,7 +239,6 @@ def defined_tags(self): """ Gets the defined_tags of this CreateLibraryMaskingFormatDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -255,7 +254,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this CreateLibraryMaskingFormatDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/create_masking_policy_details.py b/src/oci/data_safe/models/create_masking_policy_details.py index 0ca9892051..08f63a3fbe 100644 --- a/src/oci/data_safe/models/create_masking_policy_details.py +++ b/src/oci/data_safe/models/create_masking_policy_details.py @@ -467,7 +467,6 @@ def defined_tags(self): """ Gets the defined_tags of this CreateMaskingPolicyDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -483,7 +482,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this CreateMaskingPolicyDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/create_on_prem_connector_details.py b/src/oci/data_safe/models/create_on_prem_connector_details.py index 1e89e925f7..c280565427 100644 --- a/src/oci/data_safe/models/create_on_prem_connector_details.py +++ b/src/oci/data_safe/models/create_on_prem_connector_details.py @@ -172,7 +172,6 @@ def defined_tags(self): """ Gets the defined_tags of this CreateOnPremConnectorDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -188,7 +187,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this CreateOnPremConnectorDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/create_referential_relation_details.py b/src/oci/data_safe/models/create_referential_relation_details.py new file mode 100644 index 0000000000..fafa7ee788 --- /dev/null +++ b/src/oci/data_safe/models/create_referential_relation_details.py @@ -0,0 +1,185 @@ +# coding: utf-8 +# Copyright (c) 2016, 2025, 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: 20181201 + + +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 CreateReferentialRelationDetails(object): + """ + A sensitive column is a resource corresponding to a database column that is considered sensitive. + It's a subresource of sensitive data model resource and is always associated with a sensitive data model. + Note that referential relationships are also managed as part of sensitive columns. + """ + + #: A constant which can be used with the relation_type property of a CreateReferentialRelationDetails. + #: This constant has a value of "APP_DEFINED" + RELATION_TYPE_APP_DEFINED = "APP_DEFINED" + + #: A constant which can be used with the relation_type property of a CreateReferentialRelationDetails. + #: This constant has a value of "DB_DEFINED" + RELATION_TYPE_DB_DEFINED = "DB_DEFINED" + + def __init__(self, **kwargs): + """ + Initializes a new CreateReferentialRelationDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param relation_type: + The value to assign to the relation_type property of this CreateReferentialRelationDetails. + Allowed values for this property are: "APP_DEFINED", "DB_DEFINED" + :type relation_type: str + + :param parent: + The value to assign to the parent property of this CreateReferentialRelationDetails. + :type parent: oci.data_safe.models.ColumnsInfo + + :param child: + The value to assign to the child property of this CreateReferentialRelationDetails. + :type child: oci.data_safe.models.ColumnsInfo + + :param is_sensitive: + The value to assign to the is_sensitive property of this CreateReferentialRelationDetails. + :type is_sensitive: bool + + """ + self.swagger_types = { + 'relation_type': 'str', + 'parent': 'ColumnsInfo', + 'child': 'ColumnsInfo', + 'is_sensitive': 'bool' + } + + self.attribute_map = { + 'relation_type': 'relationType', + 'parent': 'parent', + 'child': 'child', + 'is_sensitive': 'isSensitive' + } + + self._relation_type = None + self._parent = None + self._child = None + self._is_sensitive = None + + @property + def relation_type(self): + """ + **[Required]** Gets the relation_type of this CreateReferentialRelationDetails. + The type of referential relationship the sensitive column has with its parent. + DB_DEFINED indicates that the relationship is defined in the database dictionary. + APP_DEFINED indicates that the relationship is defined at the application level and not in the database dictionary. + + Allowed values for this property are: "APP_DEFINED", "DB_DEFINED" + + + :return: The relation_type of this CreateReferentialRelationDetails. + :rtype: str + """ + return self._relation_type + + @relation_type.setter + def relation_type(self, relation_type): + """ + Sets the relation_type of this CreateReferentialRelationDetails. + The type of referential relationship the sensitive column has with its parent. + DB_DEFINED indicates that the relationship is defined in the database dictionary. + APP_DEFINED indicates that the relationship is defined at the application level and not in the database dictionary. + + + :param relation_type: The relation_type of this CreateReferentialRelationDetails. + :type: str + """ + allowed_values = ["APP_DEFINED", "DB_DEFINED"] + if not value_allowed_none_or_none_sentinel(relation_type, allowed_values): + raise ValueError( + f"Invalid value for `relation_type`, must be None or one of {allowed_values}" + ) + self._relation_type = relation_type + + @property + def parent(self): + """ + **[Required]** Gets the parent of this CreateReferentialRelationDetails. + + :return: The parent of this CreateReferentialRelationDetails. + :rtype: oci.data_safe.models.ColumnsInfo + """ + return self._parent + + @parent.setter + def parent(self, parent): + """ + Sets the parent of this CreateReferentialRelationDetails. + + :param parent: The parent of this CreateReferentialRelationDetails. + :type: oci.data_safe.models.ColumnsInfo + """ + self._parent = parent + + @property + def child(self): + """ + **[Required]** Gets the child of this CreateReferentialRelationDetails. + + :return: The child of this CreateReferentialRelationDetails. + :rtype: oci.data_safe.models.ColumnsInfo + """ + return self._child + + @child.setter + def child(self, child): + """ + Sets the child of this CreateReferentialRelationDetails. + + :param child: The child of this CreateReferentialRelationDetails. + :type: oci.data_safe.models.ColumnsInfo + """ + self._child = child + + @property + def is_sensitive(self): + """ + Gets the is_sensitive of this CreateReferentialRelationDetails. + Add to sensitive data model if passed true. If false is passed, then the + columns will not be added in the sensitive data model as sensitive columns and + if sensitive type OCIDs are assigned to the columns, then the sensitive type + OCIDs will not be retained. + + + :return: The is_sensitive of this CreateReferentialRelationDetails. + :rtype: bool + """ + return self._is_sensitive + + @is_sensitive.setter + def is_sensitive(self, is_sensitive): + """ + Sets the is_sensitive of this CreateReferentialRelationDetails. + Add to sensitive data model if passed true. If false is passed, then the + columns will not be added in the sensitive data model as sensitive columns and + if sensitive type OCIDs are assigned to the columns, then the sensitive type + OCIDs will not be retained. + + + :param is_sensitive: The is_sensitive of this CreateReferentialRelationDetails. + :type: bool + """ + self._is_sensitive = is_sensitive + + 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/data_safe/models/create_report_definition_details.py b/src/oci/data_safe/models/create_report_definition_details.py index d9c7cf5d5d..070e79e7b1 100644 --- a/src/oci/data_safe/models/create_report_definition_details.py +++ b/src/oci/data_safe/models/create_report_definition_details.py @@ -327,7 +327,6 @@ def defined_tags(self): """ Gets the defined_tags of this CreateReportDefinitionDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -343,7 +342,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this CreateReportDefinitionDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/create_sdm_masking_policy_difference_details.py b/src/oci/data_safe/models/create_sdm_masking_policy_difference_details.py index 6e81a58895..1ecbd11850 100644 --- a/src/oci/data_safe/models/create_sdm_masking_policy_difference_details.py +++ b/src/oci/data_safe/models/create_sdm_masking_policy_difference_details.py @@ -213,7 +213,6 @@ def defined_tags(self): """ Gets the defined_tags of this CreateSdmMaskingPolicyDifferenceDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -229,7 +228,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this CreateSdmMaskingPolicyDifferenceDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/create_security_assessment_details.py b/src/oci/data_safe/models/create_security_assessment_details.py index b4b3104327..ac0a073d34 100644 --- a/src/oci/data_safe/models/create_security_assessment_details.py +++ b/src/oci/data_safe/models/create_security_assessment_details.py @@ -159,7 +159,7 @@ def description(self, description): @property def target_id(self): """ - **[Required]** Gets the target_id of this CreateSecurityAssessmentDetails. + Gets the target_id of this CreateSecurityAssessmentDetails. The OCID of the target database on which security assessment is to be run. @@ -295,7 +295,6 @@ def defined_tags(self): """ Gets the defined_tags of this CreateSecurityAssessmentDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -311,7 +310,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this CreateSecurityAssessmentDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/create_sensitive_data_model_details.py b/src/oci/data_safe/models/create_sensitive_data_model_details.py index 11b473a09b..db730f0c68 100644 --- a/src/oci/data_safe/models/create_sensitive_data_model_details.py +++ b/src/oci/data_safe/models/create_sensitive_data_model_details.py @@ -485,7 +485,6 @@ def defined_tags(self): """ Gets the defined_tags of this CreateSensitiveDataModelDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -501,7 +500,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this CreateSensitiveDataModelDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/create_sensitive_type_details.py b/src/oci/data_safe/models/create_sensitive_type_details.py index 3a6b1588f8..324f0b019b 100644 --- a/src/oci/data_safe/models/create_sensitive_type_details.py +++ b/src/oci/data_safe/models/create_sensitive_type_details.py @@ -304,7 +304,6 @@ def defined_tags(self): """ Gets the defined_tags of this CreateSensitiveTypeDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -320,7 +319,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this CreateSensitiveTypeDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/create_sensitive_types_export_details.py b/src/oci/data_safe/models/create_sensitive_types_export_details.py new file mode 100644 index 0000000000..d652514fd3 --- /dev/null +++ b/src/oci/data_safe/models/create_sensitive_types_export_details.py @@ -0,0 +1,277 @@ +# coding: utf-8 +# Copyright (c) 2016, 2025, 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: 20181201 + + +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 CreateSensitiveTypesExportDetails(object): + """ + Details to create a new sensitive types export. To specify some sensitive types for export, use + sensitiveTypeIdsForExport attribute. But if you want to include all sensitive types, you can set + isIncludeAllSensitiveTypes attributes to true. In the latter case, you do not need to list all + sensitive types. + """ + + def __init__(self, **kwargs): + """ + Initializes a new CreateSensitiveTypesExportDetails object with values from keyword arguments. + 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 CreateSensitiveTypesExportDetails. + :type display_name: str + + :param description: + The value to assign to the description property of this CreateSensitiveTypesExportDetails. + :type description: str + + :param compartment_id: + The value to assign to the compartment_id property of this CreateSensitiveTypesExportDetails. + :type compartment_id: str + + :param sensitive_type_ids_for_export: + The value to assign to the sensitive_type_ids_for_export property of this CreateSensitiveTypesExportDetails. + :type sensitive_type_ids_for_export: list[str] + + :param is_include_all_sensitive_types: + The value to assign to the is_include_all_sensitive_types property of this CreateSensitiveTypesExportDetails. + :type is_include_all_sensitive_types: bool + + :param freeform_tags: + The value to assign to the freeform_tags property of this CreateSensitiveTypesExportDetails. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this CreateSensitiveTypesExportDetails. + :type defined_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'display_name': 'str', + 'description': 'str', + 'compartment_id': 'str', + 'sensitive_type_ids_for_export': 'list[str]', + 'is_include_all_sensitive_types': 'bool', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))' + } + + self.attribute_map = { + 'display_name': 'displayName', + 'description': 'description', + 'compartment_id': 'compartmentId', + 'sensitive_type_ids_for_export': 'sensitiveTypeIdsForExport', + 'is_include_all_sensitive_types': 'isIncludeAllSensitiveTypes', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags' + } + + self._display_name = None + self._description = None + self._compartment_id = None + self._sensitive_type_ids_for_export = None + self._is_include_all_sensitive_types = None + self._freeform_tags = None + self._defined_tags = None + + @property + def display_name(self): + """ + Gets the display_name of this CreateSensitiveTypesExportDetails. + The display name of the sensitive types export. The name does not have to be unique, and it's changeable. + + + :return: The display_name of this CreateSensitiveTypesExportDetails. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this CreateSensitiveTypesExportDetails. + The display name of the sensitive types export. The name does not have to be unique, and it's changeable. + + + :param display_name: The display_name of this CreateSensitiveTypesExportDetails. + :type: str + """ + self._display_name = display_name + + @property + def description(self): + """ + Gets the description of this CreateSensitiveTypesExportDetails. + The description of the sensitive types export. + + + :return: The description of this CreateSensitiveTypesExportDetails. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this CreateSensitiveTypesExportDetails. + The description of the sensitive types export. + + + :param description: The description of this CreateSensitiveTypesExportDetails. + :type: str + """ + self._description = description + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this CreateSensitiveTypesExportDetails. + The OCID of the compartment where the sensitive types export should be created. + + + :return: The compartment_id of this CreateSensitiveTypesExportDetails. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this CreateSensitiveTypesExportDetails. + The OCID of the compartment where the sensitive types export should be created. + + + :param compartment_id: The compartment_id of this CreateSensitiveTypesExportDetails. + :type: str + """ + self._compartment_id = compartment_id + + @property + def sensitive_type_ids_for_export(self): + """ + Gets the sensitive_type_ids_for_export of this CreateSensitiveTypesExportDetails. + The OCIDs of the sensitive types used to create sensitive types export. + + + :return: The sensitive_type_ids_for_export of this CreateSensitiveTypesExportDetails. + :rtype: list[str] + """ + return self._sensitive_type_ids_for_export + + @sensitive_type_ids_for_export.setter + def sensitive_type_ids_for_export(self, sensitive_type_ids_for_export): + """ + Sets the sensitive_type_ids_for_export of this CreateSensitiveTypesExportDetails. + The OCIDs of the sensitive types used to create sensitive types export. + + + :param sensitive_type_ids_for_export: The sensitive_type_ids_for_export of this CreateSensitiveTypesExportDetails. + :type: list[str] + """ + self._sensitive_type_ids_for_export = sensitive_type_ids_for_export + + @property + def is_include_all_sensitive_types(self): + """ + Gets the is_include_all_sensitive_types of this CreateSensitiveTypesExportDetails. + Indicates if all the existing user-defined sensitive types are used for export. If it's set to true, the + sensitiveTypeIdsForExport attribute is ignored and all user-defined sensitive types are used. + + + :return: The is_include_all_sensitive_types of this CreateSensitiveTypesExportDetails. + :rtype: bool + """ + return self._is_include_all_sensitive_types + + @is_include_all_sensitive_types.setter + def is_include_all_sensitive_types(self, is_include_all_sensitive_types): + """ + Sets the is_include_all_sensitive_types of this CreateSensitiveTypesExportDetails. + Indicates if all the existing user-defined sensitive types are used for export. If it's set to true, the + sensitiveTypeIdsForExport attribute is ignored and all user-defined sensitive types are used. + + + :param is_include_all_sensitive_types: The is_include_all_sensitive_types of this CreateSensitiveTypesExportDetails. + :type: bool + """ + self._is_include_all_sensitive_types = is_include_all_sensitive_types + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this CreateSensitiveTypesExportDetails. + Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see `Resource Tags`__ + + Example: `{\"Department\": \"Finance\"}` + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm + + + :return: The freeform_tags of this CreateSensitiveTypesExportDetails. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this CreateSensitiveTypesExportDetails. + Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see `Resource Tags`__ + + Example: `{\"Department\": \"Finance\"}` + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm + + + :param freeform_tags: The freeform_tags of this CreateSensitiveTypesExportDetails. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this CreateSensitiveTypesExportDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ + Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm + + + :return: The defined_tags of this CreateSensitiveTypesExportDetails. + :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 CreateSensitiveTypesExportDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ + Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm + + + :param defined_tags: The defined_tags of this CreateSensitiveTypesExportDetails. + :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/data_safe/models/create_sql_collection_details.py b/src/oci/data_safe/models/create_sql_collection_details.py index 4830e6424f..fcf2ca0f30 100644 --- a/src/oci/data_safe/models/create_sql_collection_details.py +++ b/src/oci/data_safe/models/create_sql_collection_details.py @@ -332,7 +332,6 @@ def defined_tags(self): """ Gets the defined_tags of this CreateSqlCollectionDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -348,7 +347,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this CreateSqlCollectionDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/create_target_alert_policy_association_details.py b/src/oci/data_safe/models/create_target_alert_policy_association_details.py index c327f51f1e..c96f332372 100644 --- a/src/oci/data_safe/models/create_target_alert_policy_association_details.py +++ b/src/oci/data_safe/models/create_target_alert_policy_association_details.py @@ -265,7 +265,6 @@ def defined_tags(self): """ Gets the defined_tags of this CreateTargetAlertPolicyAssociationDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -281,7 +280,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this CreateTargetAlertPolicyAssociationDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/create_target_database_details.py b/src/oci/data_safe/models/create_target_database_details.py index 648f1a5ca7..4e82652945 100644 --- a/src/oci/data_safe/models/create_target_database_details.py +++ b/src/oci/data_safe/models/create_target_database_details.py @@ -311,7 +311,6 @@ def defined_tags(self): """ Gets the defined_tags of this CreateTargetDatabaseDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -327,7 +326,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this CreateTargetDatabaseDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/create_user_assessment_details.py b/src/oci/data_safe/models/create_user_assessment_details.py index c377c9ac95..805164b01e 100644 --- a/src/oci/data_safe/models/create_user_assessment_details.py +++ b/src/oci/data_safe/models/create_user_assessment_details.py @@ -295,7 +295,6 @@ def defined_tags(self): """ Gets the defined_tags of this CreateUserAssessmentDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -311,7 +310,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this CreateUserAssessmentDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/data_safe_configuration.py b/src/oci/data_safe/models/data_safe_configuration.py index 9bd48c3d8a..ea19fd0117 100644 --- a/src/oci/data_safe/models/data_safe_configuration.py +++ b/src/oci/data_safe/models/data_safe_configuration.py @@ -332,7 +332,6 @@ def defined_tags(self): """ Gets the defined_tags of this DataSafeConfiguration. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -348,7 +347,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this DataSafeConfiguration. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/data_safe_private_endpoint.py b/src/oci/data_safe/models/data_safe_private_endpoint.py index ed62c08c4f..398ebe2ed0 100644 --- a/src/oci/data_safe/models/data_safe_private_endpoint.py +++ b/src/oci/data_safe/models/data_safe_private_endpoint.py @@ -498,7 +498,6 @@ def defined_tags(self): """ Gets the defined_tags of this DataSafePrivateEndpoint. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -514,7 +513,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this DataSafePrivateEndpoint. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/data_safe_private_endpoint_summary.py b/src/oci/data_safe/models/data_safe_private_endpoint_summary.py index d832b66736..7bf6b633a3 100644 --- a/src/oci/data_safe/models/data_safe_private_endpoint_summary.py +++ b/src/oci/data_safe/models/data_safe_private_endpoint_summary.py @@ -405,7 +405,6 @@ def defined_tags(self): """ Gets the defined_tags of this DataSafePrivateEndpointSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -421,7 +420,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this DataSafePrivateEndpointSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/database_security_config.py b/src/oci/data_safe/models/database_security_config.py index 35b9894cf3..75a979340f 100644 --- a/src/oci/data_safe/models/database_security_config.py +++ b/src/oci/data_safe/models/database_security_config.py @@ -461,7 +461,6 @@ def defined_tags(self): """ Gets the defined_tags of this DatabaseSecurityConfig. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -477,7 +476,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this DatabaseSecurityConfig. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/database_security_config_summary.py b/src/oci/data_safe/models/database_security_config_summary.py index bbdbe9f26d..a25681d98c 100644 --- a/src/oci/data_safe/models/database_security_config_summary.py +++ b/src/oci/data_safe/models/database_security_config_summary.py @@ -454,7 +454,6 @@ def defined_tags(self): """ Gets the defined_tags of this DatabaseSecurityConfigSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -470,7 +469,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this DatabaseSecurityConfigSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/discovery_job.py b/src/oci/data_safe/models/discovery_job.py index 0ebbe0272e..264543b47b 100644 --- a/src/oci/data_safe/models/discovery_job.py +++ b/src/oci/data_safe/models/discovery_job.py @@ -860,7 +860,6 @@ def defined_tags(self): """ Gets the defined_tags of this DiscoveryJob. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -876,7 +875,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this DiscoveryJob. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/discovery_job_summary.py b/src/oci/data_safe/models/discovery_job_summary.py index 2483d39938..ae770f6227 100644 --- a/src/oci/data_safe/models/discovery_job_summary.py +++ b/src/oci/data_safe/models/discovery_job_summary.py @@ -398,7 +398,6 @@ def defined_tags(self): """ Gets the defined_tags of this DiscoveryJobSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -414,7 +413,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this DiscoveryJobSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/download_sensitive_types_export_details.py b/src/oci/data_safe/models/download_sensitive_types_export_details.py new file mode 100644 index 0000000000..21aff3864e --- /dev/null +++ b/src/oci/data_safe/models/download_sensitive_types_export_details.py @@ -0,0 +1,84 @@ +# coding: utf-8 +# Copyright (c) 2016, 2025, 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: 20181201 + + +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 DownloadSensitiveTypesExportDetails(object): + """ + Details to download a sensitive types export. + """ + + #: A constant which can be used with the data_model_format property of a DownloadSensitiveTypesExportDetails. + #: This constant has a value of "XML" + DATA_MODEL_FORMAT_XML = "XML" + + def __init__(self, **kwargs): + """ + Initializes a new DownloadSensitiveTypesExportDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param data_model_format: + The value to assign to the data_model_format property of this DownloadSensitiveTypesExportDetails. + Allowed values for this property are: "XML" + :type data_model_format: str + + """ + self.swagger_types = { + 'data_model_format': 'str' + } + + self.attribute_map = { + 'data_model_format': 'dataModelFormat' + } + + self._data_model_format = None + + @property + def data_model_format(self): + """ + Gets the data_model_format of this DownloadSensitiveTypesExportDetails. + The format of the sensitive types export file. + + Allowed values for this property are: "XML" + + + :return: The data_model_format of this DownloadSensitiveTypesExportDetails. + :rtype: str + """ + return self._data_model_format + + @data_model_format.setter + def data_model_format(self, data_model_format): + """ + Sets the data_model_format of this DownloadSensitiveTypesExportDetails. + The format of the sensitive types export file. + + + :param data_model_format: The data_model_format of this DownloadSensitiveTypesExportDetails. + :type: str + """ + allowed_values = ["XML"] + if not value_allowed_none_or_none_sentinel(data_model_format, allowed_values): + raise ValueError( + f"Invalid value for `data_model_format`, must be None or one of {allowed_values}" + ) + self._data_model_format = data_model_format + + 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/data_safe/models/generate_health_report_details.py b/src/oci/data_safe/models/generate_health_report_details.py index 1aaa421bbe..624ff5ac0e 100644 --- a/src/oci/data_safe/models/generate_health_report_details.py +++ b/src/oci/data_safe/models/generate_health_report_details.py @@ -221,7 +221,6 @@ def defined_tags(self): """ Gets the defined_tags of this GenerateHealthReportDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -237,7 +236,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this GenerateHealthReportDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/library_masking_format.py b/src/oci/data_safe/models/library_masking_format.py index 4e5b2d56b9..fbf190cbd1 100644 --- a/src/oci/data_safe/models/library_masking_format.py +++ b/src/oci/data_safe/models/library_masking_format.py @@ -456,7 +456,6 @@ def defined_tags(self): """ Gets the defined_tags of this LibraryMaskingFormat. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -472,7 +471,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this LibraryMaskingFormat. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/library_masking_format_summary.py b/src/oci/data_safe/models/library_masking_format_summary.py index 887c4d3a88..bfc2148e9e 100644 --- a/src/oci/data_safe/models/library_masking_format_summary.py +++ b/src/oci/data_safe/models/library_masking_format_summary.py @@ -418,7 +418,6 @@ def defined_tags(self): """ Gets the defined_tags of this LibraryMaskingFormatSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -434,7 +433,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this LibraryMaskingFormatSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/masking_analytics_dimensions.py b/src/oci/data_safe/models/masking_analytics_dimensions.py index 8a728df567..7cc8b44d53 100644 --- a/src/oci/data_safe/models/masking_analytics_dimensions.py +++ b/src/oci/data_safe/models/masking_analytics_dimensions.py @@ -70,7 +70,7 @@ def target_id(self, target_id): def policy_id(self): """ Gets the policy_id of this MaskingAnalyticsDimensions. - The OCID of the masking policy.. + The OCID of the masking policy. :return: The policy_id of this MaskingAnalyticsDimensions. @@ -82,7 +82,7 @@ def policy_id(self): def policy_id(self, policy_id): """ Sets the policy_id of this MaskingAnalyticsDimensions. - The OCID of the masking policy.. + The OCID of the masking policy. :param policy_id: The policy_id of this MaskingAnalyticsDimensions. diff --git a/src/oci/data_safe/models/masking_policy.py b/src/oci/data_safe/models/masking_policy.py index f85dfe61a2..41729a1b11 100644 --- a/src/oci/data_safe/models/masking_policy.py +++ b/src/oci/data_safe/models/masking_policy.py @@ -643,7 +643,6 @@ def defined_tags(self): """ Gets the defined_tags of this MaskingPolicy. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -659,7 +658,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this MaskingPolicy. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/masking_policy_columns_info.py b/src/oci/data_safe/models/masking_policy_columns_info.py new file mode 100644 index 0000000000..07de0d0667 --- /dev/null +++ b/src/oci/data_safe/models/masking_policy_columns_info.py @@ -0,0 +1,177 @@ +# coding: utf-8 +# Copyright (c) 2016, 2025, 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: 20181201 + + +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 MaskingPolicyColumnsInfo(object): + """ + maskingPolicyColumnsInfo object has details of column group with schema details. + """ + + #: A constant which can be used with the object_type property of a MaskingPolicyColumnsInfo. + #: This constant has a value of "TABLE" + OBJECT_TYPE_TABLE = "TABLE" + + def __init__(self, **kwargs): + """ + Initializes a new MaskingPolicyColumnsInfo object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param schema_name: + The value to assign to the schema_name property of this MaskingPolicyColumnsInfo. + :type schema_name: str + + :param object_type: + The value to assign to the object_type property of this MaskingPolicyColumnsInfo. + Allowed values for this property are: "TABLE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type object_type: str + + :param object_name: + The value to assign to the object_name property of this MaskingPolicyColumnsInfo. + :type object_name: str + + :param referential_column_group: + The value to assign to the referential_column_group property of this MaskingPolicyColumnsInfo. + :type referential_column_group: list[str] + + """ + self.swagger_types = { + 'schema_name': 'str', + 'object_type': 'str', + 'object_name': 'str', + 'referential_column_group': 'list[str]' + } + + self.attribute_map = { + 'schema_name': 'schemaName', + 'object_type': 'objectType', + 'object_name': 'objectName', + 'referential_column_group': 'referentialColumnGroup' + } + + self._schema_name = None + self._object_type = None + self._object_name = None + self._referential_column_group = None + + @property + def schema_name(self): + """ + **[Required]** Gets the schema_name of this MaskingPolicyColumnsInfo. + The name of the schema that contains the database column(s). + + + :return: The schema_name of this MaskingPolicyColumnsInfo. + :rtype: str + """ + return self._schema_name + + @schema_name.setter + def schema_name(self, schema_name): + """ + Sets the schema_name of this MaskingPolicyColumnsInfo. + The name of the schema that contains the database column(s). + + + :param schema_name: The schema_name of this MaskingPolicyColumnsInfo. + :type: str + """ + self._schema_name = schema_name + + @property + def object_type(self): + """ + **[Required]** Gets the object_type of this MaskingPolicyColumnsInfo. + The type of the database object that contains the masking policy. + + Allowed values for this property are: "TABLE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The object_type of this MaskingPolicyColumnsInfo. + :rtype: str + """ + return self._object_type + + @object_type.setter + def object_type(self, object_type): + """ + Sets the object_type of this MaskingPolicyColumnsInfo. + The type of the database object that contains the masking policy. + + + :param object_type: The object_type of this MaskingPolicyColumnsInfo. + :type: str + """ + allowed_values = ["TABLE"] + if not value_allowed_none_or_none_sentinel(object_type, allowed_values): + object_type = 'UNKNOWN_ENUM_VALUE' + self._object_type = object_type + + @property + def object_name(self): + """ + **[Required]** Gets the object_name of this MaskingPolicyColumnsInfo. + The name of the object (table or editioning view) that contains the database column(s). + + + :return: The object_name of this MaskingPolicyColumnsInfo. + :rtype: str + """ + return self._object_name + + @object_name.setter + def object_name(self, object_name): + """ + Sets the object_name of this MaskingPolicyColumnsInfo. + The name of the object (table or editioning view) that contains the database column(s). + + + :param object_name: The object_name of this MaskingPolicyColumnsInfo. + :type: str + """ + self._object_name = object_name + + @property + def referential_column_group(self): + """ + **[Required]** Gets the referential_column_group of this MaskingPolicyColumnsInfo. + Group of columns in referential relation. Order needs to be maintained in the elements of the parent/child array listing. + + + :return: The referential_column_group of this MaskingPolicyColumnsInfo. + :rtype: list[str] + """ + return self._referential_column_group + + @referential_column_group.setter + def referential_column_group(self, referential_column_group): + """ + Sets the referential_column_group of this MaskingPolicyColumnsInfo. + Group of columns in referential relation. Order needs to be maintained in the elements of the parent/child array listing. + + + :param referential_column_group: The referential_column_group of this MaskingPolicyColumnsInfo. + :type: list[str] + """ + self._referential_column_group = referential_column_group + + 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/data_safe/models/masking_policy_health_report.py b/src/oci/data_safe/models/masking_policy_health_report.py index fa06868533..99f788d65f 100644 --- a/src/oci/data_safe/models/masking_policy_health_report.py +++ b/src/oci/data_safe/models/masking_policy_health_report.py @@ -78,6 +78,14 @@ def __init__(self, **kwargs): The value to assign to the description property of this MaskingPolicyHealthReport. :type description: str + :param error_count: + The value to assign to the error_count property of this MaskingPolicyHealthReport. + :type error_count: int + + :param warning_count: + The value to assign to the warning_count property of this MaskingPolicyHealthReport. + :type warning_count: int + :param freeform_tags: The value to assign to the freeform_tags property of this MaskingPolicyHealthReport. :type freeform_tags: dict(str, str) @@ -97,6 +105,8 @@ def __init__(self, **kwargs): 'time_updated': 'datetime', 'lifecycle_state': 'str', 'description': 'str', + 'error_count': 'int', + 'warning_count': 'int', 'freeform_tags': 'dict(str, str)', 'defined_tags': 'dict(str, dict(str, object))' } @@ -111,6 +121,8 @@ def __init__(self, **kwargs): 'time_updated': 'timeUpdated', 'lifecycle_state': 'lifecycleState', 'description': 'description', + 'error_count': 'errorCount', + 'warning_count': 'warningCount', 'freeform_tags': 'freeformTags', 'defined_tags': 'definedTags' } @@ -124,6 +136,8 @@ def __init__(self, **kwargs): self._time_updated = None self._lifecycle_state = None self._description = None + self._error_count = None + self._warning_count = None self._freeform_tags = None self._defined_tags = None @@ -357,6 +371,54 @@ def description(self, description): """ self._description = description + @property + def error_count(self): + """ + Gets the error_count of this MaskingPolicyHealthReport. + The count of errors in the masking health report. + + + :return: The error_count of this MaskingPolicyHealthReport. + :rtype: int + """ + return self._error_count + + @error_count.setter + def error_count(self, error_count): + """ + Sets the error_count of this MaskingPolicyHealthReport. + The count of errors in the masking health report. + + + :param error_count: The error_count of this MaskingPolicyHealthReport. + :type: int + """ + self._error_count = error_count + + @property + def warning_count(self): + """ + Gets the warning_count of this MaskingPolicyHealthReport. + The count of warnings in the masking health report. + + + :return: The warning_count of this MaskingPolicyHealthReport. + :rtype: int + """ + return self._warning_count + + @warning_count.setter + def warning_count(self, warning_count): + """ + Sets the warning_count of this MaskingPolicyHealthReport. + The count of warnings in the masking health report. + + + :param warning_count: The warning_count of this MaskingPolicyHealthReport. + :type: int + """ + self._warning_count = warning_count + @property def freeform_tags(self): """ @@ -394,7 +456,6 @@ def defined_tags(self): """ **[Required]** Gets the defined_tags of this MaskingPolicyHealthReport. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -410,7 +471,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this MaskingPolicyHealthReport. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/masking_policy_health_report_log_summary.py b/src/oci/data_safe/models/masking_policy_health_report_log_summary.py index d5df3a9217..5fc80be095 100644 --- a/src/oci/data_safe/models/masking_policy_health_report_log_summary.py +++ b/src/oci/data_safe/models/masking_policy_health_report_log_summary.py @@ -27,6 +27,66 @@ class MaskingPolicyHealthReportLogSummary(object): #: This constant has a value of "ERROR" MESSAGE_TYPE_ERROR = "ERROR" + #: A constant which can be used with the health_check_type property of a MaskingPolicyHealthReportLogSummary. + #: This constant has a value of "INVALID_OBJECT_CHECK" + HEALTH_CHECK_TYPE_INVALID_OBJECT_CHECK = "INVALID_OBJECT_CHECK" + + #: A constant which can be used with the health_check_type property of a MaskingPolicyHealthReportLogSummary. + #: This constant has a value of "PRIVILEGE_CHECK" + HEALTH_CHECK_TYPE_PRIVILEGE_CHECK = "PRIVILEGE_CHECK" + + #: A constant which can be used with the health_check_type property of a MaskingPolicyHealthReportLogSummary. + #: This constant has a value of "TABLESPACE_CHECK" + HEALTH_CHECK_TYPE_TABLESPACE_CHECK = "TABLESPACE_CHECK" + + #: A constant which can be used with the health_check_type property of a MaskingPolicyHealthReportLogSummary. + #: This constant has a value of "DATABASE_OR_SYSTEM_TRIGGERS_CHECK" + HEALTH_CHECK_TYPE_DATABASE_OR_SYSTEM_TRIGGERS_CHECK = "DATABASE_OR_SYSTEM_TRIGGERS_CHECK" + + #: A constant which can be used with the health_check_type property of a MaskingPolicyHealthReportLogSummary. + #: This constant has a value of "UNDO_TABLESPACE_CHECK" + HEALTH_CHECK_TYPE_UNDO_TABLESPACE_CHECK = "UNDO_TABLESPACE_CHECK" + + #: A constant which can be used with the health_check_type property of a MaskingPolicyHealthReportLogSummary. + #: This constant has a value of "STATE_STATS_CHECK" + HEALTH_CHECK_TYPE_STATE_STATS_CHECK = "STATE_STATS_CHECK" + + #: A constant which can be used with the health_check_type property of a MaskingPolicyHealthReportLogSummary. + #: This constant has a value of "OLS_POLICY_CHECK" + HEALTH_CHECK_TYPE_OLS_POLICY_CHECK = "OLS_POLICY_CHECK" + + #: A constant which can be used with the health_check_type property of a MaskingPolicyHealthReportLogSummary. + #: This constant has a value of "VPD_POLICY_CHECK" + HEALTH_CHECK_TYPE_VPD_POLICY_CHECK = "VPD_POLICY_CHECK" + + #: A constant which can be used with the health_check_type property of a MaskingPolicyHealthReportLogSummary. + #: This constant has a value of "DV_ENABLE_CHECK" + HEALTH_CHECK_TYPE_DV_ENABLE_CHECK = "DV_ENABLE_CHECK" + + #: A constant which can be used with the health_check_type property of a MaskingPolicyHealthReportLogSummary. + #: This constant has a value of "DE_COL_SIZE_CHECK" + HEALTH_CHECK_TYPE_DE_COL_SIZE_CHECK = "DE_COL_SIZE_CHECK" + + #: A constant which can be used with the health_check_type property of a MaskingPolicyHealthReportLogSummary. + #: This constant has a value of "REDACTION_POLICY_CHECK" + HEALTH_CHECK_TYPE_REDACTION_POLICY_CHECK = "REDACTION_POLICY_CHECK" + + #: A constant which can be used with the health_check_type property of a MaskingPolicyHealthReportLogSummary. + #: This constant has a value of "ACTIVE_MASK_JOB_CHECK" + HEALTH_CHECK_TYPE_ACTIVE_MASK_JOB_CHECK = "ACTIVE_MASK_JOB_CHECK" + + #: A constant which can be used with the health_check_type property of a MaskingPolicyHealthReportLogSummary. + #: This constant has a value of "TARGET_VALIDATION_CHECK" + HEALTH_CHECK_TYPE_TARGET_VALIDATION_CHECK = "TARGET_VALIDATION_CHECK" + + #: A constant which can be used with the health_check_type property of a MaskingPolicyHealthReportLogSummary. + #: This constant has a value of "DETERMINISTIC_ENCRYPTION_FORMAT_CHECK" + HEALTH_CHECK_TYPE_DETERMINISTIC_ENCRYPTION_FORMAT_CHECK = "DETERMINISTIC_ENCRYPTION_FORMAT_CHECK" + + #: A constant which can be used with the health_check_type property of a MaskingPolicyHealthReportLogSummary. + #: This constant has a value of "COLUMN_EXIST_CHECK" + HEALTH_CHECK_TYPE_COLUMN_EXIST_CHECK = "COLUMN_EXIST_CHECK" + def __init__(self, **kwargs): """ Initializes a new MaskingPolicyHealthReportLogSummary object with values from keyword arguments. @@ -54,13 +114,20 @@ def __init__(self, **kwargs): The value to assign to the description property of this MaskingPolicyHealthReportLogSummary. :type description: str + :param health_check_type: + The value to assign to the health_check_type property of this MaskingPolicyHealthReportLogSummary. + Allowed values for this property are: "INVALID_OBJECT_CHECK", "PRIVILEGE_CHECK", "TABLESPACE_CHECK", "DATABASE_OR_SYSTEM_TRIGGERS_CHECK", "UNDO_TABLESPACE_CHECK", "STATE_STATS_CHECK", "OLS_POLICY_CHECK", "VPD_POLICY_CHECK", "DV_ENABLE_CHECK", "DE_COL_SIZE_CHECK", "REDACTION_POLICY_CHECK", "ACTIVE_MASK_JOB_CHECK", "TARGET_VALIDATION_CHECK", "DETERMINISTIC_ENCRYPTION_FORMAT_CHECK", "COLUMN_EXIST_CHECK", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type health_check_type: str + """ self.swagger_types = { 'message_type': 'str', 'timestamp': 'datetime', 'message': 'str', 'remediation': 'str', - 'description': 'str' + 'description': 'str', + 'health_check_type': 'str' } self.attribute_map = { @@ -68,7 +135,8 @@ def __init__(self, **kwargs): 'timestamp': 'timestamp', 'message': 'message', 'remediation': 'remediation', - 'description': 'description' + 'description': 'description', + 'health_check_type': 'healthCheckType' } self._message_type = None @@ -76,6 +144,7 @@ def __init__(self, **kwargs): self._message = None self._remediation = None self._description = None + self._health_check_type = None @property def message_type(self): @@ -207,6 +276,60 @@ def description(self, description): """ self._description = description + @property + def health_check_type(self): + """ + Gets the health_check_type of this MaskingPolicyHealthReportLogSummary. + An enum type entry for each health check in the masking policy. Each enum describes a type of health check. + INVALID_OBJECT_CHECK checks if there exist any invalid objects in the masking tables. + PRIVILEGE_CHECK checks if the masking user has sufficient privilege to run masking. + TABLESPACE_CHECK checks if the user has sufficient default and TEMP tablespace. + DATABASE_OR_SYSTEM_TRIGGERS_CHECK checks if there exist any database/system triggers available. + UNDO_TABLESPACE_CHECK checks if the AUTOEXTEND feature is enabled for the undo tablespace. If it's not enabled, it further checks if the undo tablespace has any space remaining + STATE_STATS_CHECK checks if all the statistics of the masking table is upto date or not. + OLS_POLICY_CHECK , VPD_POLICY_CHECK and REDACTION_POLICY_CHECK checks if the masking tables has Oracle Label Security (OLS) or Virtual Private Database (VPD) or Redaction policies enabled. + DV_ENABLE_CHECK checks if database has Database Vault(DV) enabled + DE_COL_SIZE_CHECK checks if any masking column with DETERMINISTIC ENCRYPTION as masking format has average column size greater than 27 or not. + ACTIVE_MASK_JOB_CHECK checks if there is any active masking job running on the target database. + DETERMINISTIC_ENCRYPTION_FORMAT_CHECK checks if any masking column has deterministic encryption masking format. + COLUMN_EXIST_CHECK checks if the masking columns are available in the target database. + + Allowed values for this property are: "INVALID_OBJECT_CHECK", "PRIVILEGE_CHECK", "TABLESPACE_CHECK", "DATABASE_OR_SYSTEM_TRIGGERS_CHECK", "UNDO_TABLESPACE_CHECK", "STATE_STATS_CHECK", "OLS_POLICY_CHECK", "VPD_POLICY_CHECK", "DV_ENABLE_CHECK", "DE_COL_SIZE_CHECK", "REDACTION_POLICY_CHECK", "ACTIVE_MASK_JOB_CHECK", "TARGET_VALIDATION_CHECK", "DETERMINISTIC_ENCRYPTION_FORMAT_CHECK", "COLUMN_EXIST_CHECK", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The health_check_type of this MaskingPolicyHealthReportLogSummary. + :rtype: str + """ + return self._health_check_type + + @health_check_type.setter + def health_check_type(self, health_check_type): + """ + Sets the health_check_type of this MaskingPolicyHealthReportLogSummary. + An enum type entry for each health check in the masking policy. Each enum describes a type of health check. + INVALID_OBJECT_CHECK checks if there exist any invalid objects in the masking tables. + PRIVILEGE_CHECK checks if the masking user has sufficient privilege to run masking. + TABLESPACE_CHECK checks if the user has sufficient default and TEMP tablespace. + DATABASE_OR_SYSTEM_TRIGGERS_CHECK checks if there exist any database/system triggers available. + UNDO_TABLESPACE_CHECK checks if the AUTOEXTEND feature is enabled for the undo tablespace. If it's not enabled, it further checks if the undo tablespace has any space remaining + STATE_STATS_CHECK checks if all the statistics of the masking table is upto date or not. + OLS_POLICY_CHECK , VPD_POLICY_CHECK and REDACTION_POLICY_CHECK checks if the masking tables has Oracle Label Security (OLS) or Virtual Private Database (VPD) or Redaction policies enabled. + DV_ENABLE_CHECK checks if database has Database Vault(DV) enabled + DE_COL_SIZE_CHECK checks if any masking column with DETERMINISTIC ENCRYPTION as masking format has average column size greater than 27 or not. + ACTIVE_MASK_JOB_CHECK checks if there is any active masking job running on the target database. + DETERMINISTIC_ENCRYPTION_FORMAT_CHECK checks if any masking column has deterministic encryption masking format. + COLUMN_EXIST_CHECK checks if the masking columns are available in the target database. + + + :param health_check_type: The health_check_type of this MaskingPolicyHealthReportLogSummary. + :type: str + """ + allowed_values = ["INVALID_OBJECT_CHECK", "PRIVILEGE_CHECK", "TABLESPACE_CHECK", "DATABASE_OR_SYSTEM_TRIGGERS_CHECK", "UNDO_TABLESPACE_CHECK", "STATE_STATS_CHECK", "OLS_POLICY_CHECK", "VPD_POLICY_CHECK", "DV_ENABLE_CHECK", "DE_COL_SIZE_CHECK", "REDACTION_POLICY_CHECK", "ACTIVE_MASK_JOB_CHECK", "TARGET_VALIDATION_CHECK", "DETERMINISTIC_ENCRYPTION_FORMAT_CHECK", "COLUMN_EXIST_CHECK"] + if not value_allowed_none_or_none_sentinel(health_check_type, allowed_values): + health_check_type = 'UNKNOWN_ENUM_VALUE' + self._health_check_type = health_check_type + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/data_safe/models/masking_policy_health_report_summary.py b/src/oci/data_safe/models/masking_policy_health_report_summary.py index 4eddec1103..66b3752960 100644 --- a/src/oci/data_safe/models/masking_policy_health_report_summary.py +++ b/src/oci/data_safe/models/masking_policy_health_report_summary.py @@ -52,6 +52,14 @@ def __init__(self, **kwargs): The value to assign to the description property of this MaskingPolicyHealthReportSummary. :type description: str + :param error_count: + The value to assign to the error_count property of this MaskingPolicyHealthReportSummary. + :type error_count: int + + :param warning_count: + The value to assign to the warning_count property of this MaskingPolicyHealthReportSummary. + :type warning_count: int + :param freeform_tags: The value to assign to the freeform_tags property of this MaskingPolicyHealthReportSummary. :type freeform_tags: dict(str, str) @@ -70,6 +78,8 @@ def __init__(self, **kwargs): 'time_created': 'datetime', 'lifecycle_state': 'str', 'description': 'str', + 'error_count': 'int', + 'warning_count': 'int', 'freeform_tags': 'dict(str, str)', 'defined_tags': 'dict(str, dict(str, object))' } @@ -83,6 +93,8 @@ def __init__(self, **kwargs): 'time_created': 'timeCreated', 'lifecycle_state': 'lifecycleState', 'description': 'description', + 'error_count': 'errorCount', + 'warning_count': 'warningCount', 'freeform_tags': 'freeformTags', 'defined_tags': 'definedTags' } @@ -95,6 +107,8 @@ def __init__(self, **kwargs): self._time_created = None self._lifecycle_state = None self._description = None + self._error_count = None + self._warning_count = None self._freeform_tags = None self._defined_tags = None @@ -294,6 +308,54 @@ def description(self, description): """ self._description = description + @property + def error_count(self): + """ + Gets the error_count of this MaskingPolicyHealthReportSummary. + The count of errors in the masking health report. + + + :return: The error_count of this MaskingPolicyHealthReportSummary. + :rtype: int + """ + return self._error_count + + @error_count.setter + def error_count(self, error_count): + """ + Sets the error_count of this MaskingPolicyHealthReportSummary. + The count of errors in the masking health report. + + + :param error_count: The error_count of this MaskingPolicyHealthReportSummary. + :type: int + """ + self._error_count = error_count + + @property + def warning_count(self): + """ + Gets the warning_count of this MaskingPolicyHealthReportSummary. + The count of warnings in the masking health report. + + + :return: The warning_count of this MaskingPolicyHealthReportSummary. + :rtype: int + """ + return self._warning_count + + @warning_count.setter + def warning_count(self, warning_count): + """ + Sets the warning_count of this MaskingPolicyHealthReportSummary. + The count of warnings in the masking health report. + + + :param warning_count: The warning_count of this MaskingPolicyHealthReportSummary. + :type: int + """ + self._warning_count = warning_count + @property def freeform_tags(self): """ @@ -331,7 +393,6 @@ def defined_tags(self): """ **[Required]** Gets the defined_tags of this MaskingPolicyHealthReportSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -347,7 +408,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this MaskingPolicyHealthReportSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/masking_policy_referential_relation_collection.py b/src/oci/data_safe/models/masking_policy_referential_relation_collection.py new file mode 100644 index 0000000000..f6eced682c --- /dev/null +++ b/src/oci/data_safe/models/masking_policy_referential_relation_collection.py @@ -0,0 +1,72 @@ +# coding: utf-8 +# Copyright (c) 2016, 2025, 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: 20181201 + + +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 MaskingPolicyReferentialRelationCollection(object): + """ + A collection of referential relation summary objects. + """ + + def __init__(self, **kwargs): + """ + Initializes a new MaskingPolicyReferentialRelationCollection 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 MaskingPolicyReferentialRelationCollection. + :type items: list[oci.data_safe.models.MaskingPolicyReferentialRelationSummary] + + """ + self.swagger_types = { + 'items': 'list[MaskingPolicyReferentialRelationSummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this MaskingPolicyReferentialRelationCollection. + An array of referential relation summary objects. + + + :return: The items of this MaskingPolicyReferentialRelationCollection. + :rtype: list[oci.data_safe.models.MaskingPolicyReferentialRelationSummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this MaskingPolicyReferentialRelationCollection. + An array of referential relation summary objects. + + + :param items: The items of this MaskingPolicyReferentialRelationCollection. + :type: list[oci.data_safe.models.MaskingPolicyReferentialRelationSummary] + """ + 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/data_safe/models/masking_policy_referential_relation_summary.py b/src/oci/data_safe/models/masking_policy_referential_relation_summary.py new file mode 100644 index 0000000000..b915f45848 --- /dev/null +++ b/src/oci/data_safe/models/masking_policy_referential_relation_summary.py @@ -0,0 +1,211 @@ +# coding: utf-8 +# Copyright (c) 2016, 2025, 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: 20181201 + + +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 MaskingPolicyReferentialRelationSummary(object): + """ + A referential relation is a resource corresponding to database columns. + It is always associated with a masking policy. + """ + + #: A constant which can be used with the relation_type property of a MaskingPolicyReferentialRelationSummary. + #: This constant has a value of "NONE" + RELATION_TYPE_NONE = "NONE" + + #: A constant which can be used with the relation_type property of a MaskingPolicyReferentialRelationSummary. + #: This constant has a value of "APP_DEFINED" + RELATION_TYPE_APP_DEFINED = "APP_DEFINED" + + #: A constant which can be used with the relation_type property of a MaskingPolicyReferentialRelationSummary. + #: This constant has a value of "DB_DEFINED" + RELATION_TYPE_DB_DEFINED = "DB_DEFINED" + + def __init__(self, **kwargs): + """ + Initializes a new MaskingPolicyReferentialRelationSummary object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param masking_policy_id: + The value to assign to the masking_policy_id property of this MaskingPolicyReferentialRelationSummary. + :type masking_policy_id: str + + :param relation_type: + The value to assign to the relation_type property of this MaskingPolicyReferentialRelationSummary. + Allowed values for this property are: "NONE", "APP_DEFINED", "DB_DEFINED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type relation_type: str + + :param parent: + The value to assign to the parent property of this MaskingPolicyReferentialRelationSummary. + :type parent: oci.data_safe.models.MaskingPolicyColumnsInfo + + :param child: + The value to assign to the child property of this MaskingPolicyReferentialRelationSummary. + :type child: oci.data_safe.models.MaskingPolicyColumnsInfo + + :param masking_format: + The value to assign to the masking_format property of this MaskingPolicyReferentialRelationSummary. + :type masking_format: list[str] + + """ + self.swagger_types = { + 'masking_policy_id': 'str', + 'relation_type': 'str', + 'parent': 'MaskingPolicyColumnsInfo', + 'child': 'MaskingPolicyColumnsInfo', + 'masking_format': 'list[str]' + } + + self.attribute_map = { + 'masking_policy_id': 'maskingPolicyId', + 'relation_type': 'relationType', + 'parent': 'parent', + 'child': 'child', + 'masking_format': 'maskingFormat' + } + + self._masking_policy_id = None + self._relation_type = None + self._parent = None + self._child = None + self._masking_format = None + + @property + def masking_policy_id(self): + """ + **[Required]** Gets the masking_policy_id of this MaskingPolicyReferentialRelationSummary. + The OCID of the masking policy that contains the column. + + + :return: The masking_policy_id of this MaskingPolicyReferentialRelationSummary. + :rtype: str + """ + return self._masking_policy_id + + @masking_policy_id.setter + def masking_policy_id(self, masking_policy_id): + """ + Sets the masking_policy_id of this MaskingPolicyReferentialRelationSummary. + The OCID of the masking policy that contains the column. + + + :param masking_policy_id: The masking_policy_id of this MaskingPolicyReferentialRelationSummary. + :type: str + """ + self._masking_policy_id = masking_policy_id + + @property + def relation_type(self): + """ + **[Required]** Gets the relation_type of this MaskingPolicyReferentialRelationSummary. + The type of referential relationship the column has with its parent. DB_DEFINED indicates that the relationship is defined in the database + dictionary. APP_DEFINED indicates that the relationship is defined at the application level and not in the database dictionary. + + Allowed values for this property are: "NONE", "APP_DEFINED", "DB_DEFINED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The relation_type of this MaskingPolicyReferentialRelationSummary. + :rtype: str + """ + return self._relation_type + + @relation_type.setter + def relation_type(self, relation_type): + """ + Sets the relation_type of this MaskingPolicyReferentialRelationSummary. + The type of referential relationship the column has with its parent. DB_DEFINED indicates that the relationship is defined in the database + dictionary. APP_DEFINED indicates that the relationship is defined at the application level and not in the database dictionary. + + + :param relation_type: The relation_type of this MaskingPolicyReferentialRelationSummary. + :type: str + """ + allowed_values = ["NONE", "APP_DEFINED", "DB_DEFINED"] + if not value_allowed_none_or_none_sentinel(relation_type, allowed_values): + relation_type = 'UNKNOWN_ENUM_VALUE' + self._relation_type = relation_type + + @property + def parent(self): + """ + **[Required]** Gets the parent of this MaskingPolicyReferentialRelationSummary. + + :return: The parent of this MaskingPolicyReferentialRelationSummary. + :rtype: oci.data_safe.models.MaskingPolicyColumnsInfo + """ + return self._parent + + @parent.setter + def parent(self, parent): + """ + Sets the parent of this MaskingPolicyReferentialRelationSummary. + + :param parent: The parent of this MaskingPolicyReferentialRelationSummary. + :type: oci.data_safe.models.MaskingPolicyColumnsInfo + """ + self._parent = parent + + @property + def child(self): + """ + **[Required]** Gets the child of this MaskingPolicyReferentialRelationSummary. + + :return: The child of this MaskingPolicyReferentialRelationSummary. + :rtype: oci.data_safe.models.MaskingPolicyColumnsInfo + """ + return self._child + + @child.setter + def child(self, child): + """ + Sets the child of this MaskingPolicyReferentialRelationSummary. + + :param child: The child of this MaskingPolicyReferentialRelationSummary. + :type: oci.data_safe.models.MaskingPolicyColumnsInfo + """ + self._child = child + + @property + def masking_format(self): + """ + Gets the masking_format of this MaskingPolicyReferentialRelationSummary. + The masking format associated with the parent column. + + + :return: The masking_format of this MaskingPolicyReferentialRelationSummary. + :rtype: list[str] + """ + return self._masking_format + + @masking_format.setter + def masking_format(self, masking_format): + """ + Sets the masking_format of this MaskingPolicyReferentialRelationSummary. + The masking format associated with the parent column. + + + :param masking_format: The masking_format of this MaskingPolicyReferentialRelationSummary. + :type: list[str] + """ + self._masking_format = masking_format + + 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/data_safe/models/masking_policy_summary.py b/src/oci/data_safe/models/masking_policy_summary.py index 49453a9ecf..499b2430ce 100644 --- a/src/oci/data_safe/models/masking_policy_summary.py +++ b/src/oci/data_safe/models/masking_policy_summary.py @@ -367,7 +367,6 @@ def defined_tags(self): """ Gets the defined_tags of this MaskingPolicySummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -383,7 +382,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this MaskingPolicySummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/on_prem_connector.py b/src/oci/data_safe/models/on_prem_connector.py index 23d6d965e8..25edc5dd18 100644 --- a/src/oci/data_safe/models/on_prem_connector.py +++ b/src/oci/data_safe/models/on_prem_connector.py @@ -361,7 +361,6 @@ def defined_tags(self): """ Gets the defined_tags of this OnPremConnector. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -377,7 +376,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this OnPremConnector. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/on_prem_connector_summary.py b/src/oci/data_safe/models/on_prem_connector_summary.py index 95122d20c5..db0e2bf3db 100644 --- a/src/oci/data_safe/models/on_prem_connector_summary.py +++ b/src/oci/data_safe/models/on_prem_connector_summary.py @@ -354,7 +354,6 @@ def defined_tags(self): """ Gets the defined_tags of this OnPremConnectorSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -370,7 +369,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this OnPremConnectorSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/profile.py b/src/oci/data_safe/models/profile.py index 096621e1ce..d4ada635ef 100644 --- a/src/oci/data_safe/models/profile.py +++ b/src/oci/data_safe/models/profile.py @@ -863,7 +863,6 @@ def defined_tags(self): """ Gets the defined_tags of this Profile. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -879,7 +878,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this Profile. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/profile_aggregation.py b/src/oci/data_safe/models/profile_aggregation.py index 07656e203e..5af59cf72e 100644 --- a/src/oci/data_safe/models/profile_aggregation.py +++ b/src/oci/data_safe/models/profile_aggregation.py @@ -55,7 +55,8 @@ def __init__(self, **kwargs): def items(self): """ **[Required]** Gets the items of this ProfileAggregation. - The array of profile aggregation data. + List containing maps as values. + Example: `{\"Operations\": [ {\"CostCenter\": \"42\"} ] }` :return: The items of this ProfileAggregation. @@ -67,7 +68,8 @@ def items(self): def items(self, items): """ Sets the items of this ProfileAggregation. - The array of profile aggregation data. + List containing maps as values. + Example: `{\"Operations\": [ {\"CostCenter\": \"42\"} ] }` :param items: The items of this ProfileAggregation. @@ -112,7 +114,6 @@ def defined_tags(self): """ Gets the defined_tags of this ProfileAggregation. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -128,7 +129,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this ProfileAggregation. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/profile_summary.py b/src/oci/data_safe/models/profile_summary.py index 253aeb6faf..fc0d124aad 100644 --- a/src/oci/data_safe/models/profile_summary.py +++ b/src/oci/data_safe/models/profile_summary.py @@ -425,7 +425,6 @@ def defined_tags(self): """ Gets the defined_tags of this ProfileSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -441,7 +440,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this ProfileSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/referential_relation.py b/src/oci/data_safe/models/referential_relation.py new file mode 100644 index 0000000000..6190ecd05b --- /dev/null +++ b/src/oci/data_safe/models/referential_relation.py @@ -0,0 +1,303 @@ +# coding: utf-8 +# Copyright (c) 2016, 2025, 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: 20181201 + + +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 ReferentialRelation(object): + """ + A referential relation is a resource corresponding to database columns. + It's a subresource of sensitive data model resource and is always associated with a sensitive data model. + """ + + #: A constant which can be used with the lifecycle_state property of a ReferentialRelation. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + #: A constant which can be used with the lifecycle_state property of a ReferentialRelation. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a ReferentialRelation. + #: This constant has a value of "UPDATING" + LIFECYCLE_STATE_UPDATING = "UPDATING" + + #: A constant which can be used with the lifecycle_state property of a ReferentialRelation. + #: This constant has a value of "DELETING" + LIFECYCLE_STATE_DELETING = "DELETING" + + #: A constant which can be used with the lifecycle_state property of a ReferentialRelation. + #: This constant has a value of "FAILED" + LIFECYCLE_STATE_FAILED = "FAILED" + + #: A constant which can be used with the relation_type property of a ReferentialRelation. + #: This constant has a value of "NONE" + RELATION_TYPE_NONE = "NONE" + + #: A constant which can be used with the relation_type property of a ReferentialRelation. + #: This constant has a value of "APP_DEFINED" + RELATION_TYPE_APP_DEFINED = "APP_DEFINED" + + #: A constant which can be used with the relation_type property of a ReferentialRelation. + #: This constant has a value of "DB_DEFINED" + RELATION_TYPE_DB_DEFINED = "DB_DEFINED" + + def __init__(self, **kwargs): + """ + Initializes a new ReferentialRelation object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param key: + The value to assign to the key property of this ReferentialRelation. + :type key: str + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this ReferentialRelation. + Allowed values for this property are: "CREATING", "ACTIVE", "UPDATING", "DELETING", "FAILED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type lifecycle_state: str + + :param sensitive_data_model_id: + The value to assign to the sensitive_data_model_id property of this ReferentialRelation. + :type sensitive_data_model_id: str + + :param relation_type: + The value to assign to the relation_type property of this ReferentialRelation. + Allowed values for this property are: "NONE", "APP_DEFINED", "DB_DEFINED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type relation_type: str + + :param parent: + The value to assign to the parent property of this ReferentialRelation. + :type parent: oci.data_safe.models.ColumnsInfo + + :param child: + The value to assign to the child property of this ReferentialRelation. + :type child: oci.data_safe.models.ColumnsInfo + + :param is_sensitive: + The value to assign to the is_sensitive property of this ReferentialRelation. + :type is_sensitive: bool + + """ + self.swagger_types = { + 'key': 'str', + 'lifecycle_state': 'str', + 'sensitive_data_model_id': 'str', + 'relation_type': 'str', + 'parent': 'ColumnsInfo', + 'child': 'ColumnsInfo', + 'is_sensitive': 'bool' + } + + self.attribute_map = { + 'key': 'key', + 'lifecycle_state': 'lifecycleState', + 'sensitive_data_model_id': 'sensitiveDataModelId', + 'relation_type': 'relationType', + 'parent': 'parent', + 'child': 'child', + 'is_sensitive': 'isSensitive' + } + + self._key = None + self._lifecycle_state = None + self._sensitive_data_model_id = None + self._relation_type = None + self._parent = None + self._child = None + self._is_sensitive = None + + @property + def key(self): + """ + **[Required]** Gets the key of this ReferentialRelation. + The unique key that identifies the referential relation. It's numeric and unique within a sensitive data model. + + + :return: The key of this ReferentialRelation. + :rtype: str + """ + return self._key + + @key.setter + def key(self, key): + """ + Sets the key of this ReferentialRelation. + The unique key that identifies the referential relation. It's numeric and unique within a sensitive data model. + + + :param key: The key of this ReferentialRelation. + :type: str + """ + self._key = key + + @property + def lifecycle_state(self): + """ + **[Required]** Gets the lifecycle_state of this ReferentialRelation. + The current state of the referential relation. + + Allowed values for this property are: "CREATING", "ACTIVE", "UPDATING", "DELETING", "FAILED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The lifecycle_state of this ReferentialRelation. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this ReferentialRelation. + The current state of the referential relation. + + + :param lifecycle_state: The lifecycle_state of this ReferentialRelation. + :type: str + """ + allowed_values = ["CREATING", "ACTIVE", "UPDATING", "DELETING", "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 sensitive_data_model_id(self): + """ + **[Required]** Gets the sensitive_data_model_id of this ReferentialRelation. + The OCID of the sensitive data model that contains the sensitive column. + + + :return: The sensitive_data_model_id of this ReferentialRelation. + :rtype: str + """ + return self._sensitive_data_model_id + + @sensitive_data_model_id.setter + def sensitive_data_model_id(self, sensitive_data_model_id): + """ + Sets the sensitive_data_model_id of this ReferentialRelation. + The OCID of the sensitive data model that contains the sensitive column. + + + :param sensitive_data_model_id: The sensitive_data_model_id of this ReferentialRelation. + :type: str + """ + self._sensitive_data_model_id = sensitive_data_model_id + + @property + def relation_type(self): + """ + **[Required]** Gets the relation_type of this ReferentialRelation. + The type of referential relationship the sensitive column has with its parent. NONE indicates that the + sensitive column does not have a parent. DB_DEFINED indicates that the relationship is defined in the database + dictionary. APP_DEFINED indicates that the relationship is defined at the application level and not in the database dictionary. + + Allowed values for this property are: "NONE", "APP_DEFINED", "DB_DEFINED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The relation_type of this ReferentialRelation. + :rtype: str + """ + return self._relation_type + + @relation_type.setter + def relation_type(self, relation_type): + """ + Sets the relation_type of this ReferentialRelation. + The type of referential relationship the sensitive column has with its parent. NONE indicates that the + sensitive column does not have a parent. DB_DEFINED indicates that the relationship is defined in the database + dictionary. APP_DEFINED indicates that the relationship is defined at the application level and not in the database dictionary. + + + :param relation_type: The relation_type of this ReferentialRelation. + :type: str + """ + allowed_values = ["NONE", "APP_DEFINED", "DB_DEFINED"] + if not value_allowed_none_or_none_sentinel(relation_type, allowed_values): + relation_type = 'UNKNOWN_ENUM_VALUE' + self._relation_type = relation_type + + @property + def parent(self): + """ + **[Required]** Gets the parent of this ReferentialRelation. + + :return: The parent of this ReferentialRelation. + :rtype: oci.data_safe.models.ColumnsInfo + """ + return self._parent + + @parent.setter + def parent(self, parent): + """ + Sets the parent of this ReferentialRelation. + + :param parent: The parent of this ReferentialRelation. + :type: oci.data_safe.models.ColumnsInfo + """ + self._parent = parent + + @property + def child(self): + """ + **[Required]** Gets the child of this ReferentialRelation. + + :return: The child of this ReferentialRelation. + :rtype: oci.data_safe.models.ColumnsInfo + """ + return self._child + + @child.setter + def child(self, child): + """ + Sets the child of this ReferentialRelation. + + :param child: The child of this ReferentialRelation. + :type: oci.data_safe.models.ColumnsInfo + """ + self._child = child + + @property + def is_sensitive(self): + """ + Gets the is_sensitive of this ReferentialRelation. + Determines if the columns present in the referential relation is present in the sensitive data model + + + :return: The is_sensitive of this ReferentialRelation. + :rtype: bool + """ + return self._is_sensitive + + @is_sensitive.setter + def is_sensitive(self, is_sensitive): + """ + Sets the is_sensitive of this ReferentialRelation. + Determines if the columns present in the referential relation is present in the sensitive data model + + + :param is_sensitive: The is_sensitive of this ReferentialRelation. + :type: bool + """ + self._is_sensitive = is_sensitive + + 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/data_safe/models/referential_relation_collection.py b/src/oci/data_safe/models/referential_relation_collection.py new file mode 100644 index 0000000000..e0c97c5a07 --- /dev/null +++ b/src/oci/data_safe/models/referential_relation_collection.py @@ -0,0 +1,72 @@ +# coding: utf-8 +# Copyright (c) 2016, 2025, 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: 20181201 + + +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 ReferentialRelationCollection(object): + """ + A collection of referential relation summary objects. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ReferentialRelationCollection 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 ReferentialRelationCollection. + :type items: list[oci.data_safe.models.ReferentialRelationSummary] + + """ + self.swagger_types = { + 'items': 'list[ReferentialRelationSummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this ReferentialRelationCollection. + An array of referential relation summary objects. + + + :return: The items of this ReferentialRelationCollection. + :rtype: list[oci.data_safe.models.ReferentialRelationSummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this ReferentialRelationCollection. + An array of referential relation summary objects. + + + :param items: The items of this ReferentialRelationCollection. + :type: list[oci.data_safe.models.ReferentialRelationSummary] + """ + 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/data_safe/models/referential_relation_summary.py b/src/oci/data_safe/models/referential_relation_summary.py new file mode 100644 index 0000000000..f085245eac --- /dev/null +++ b/src/oci/data_safe/models/referential_relation_summary.py @@ -0,0 +1,303 @@ +# coding: utf-8 +# Copyright (c) 2016, 2025, 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: 20181201 + + +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 ReferentialRelationSummary(object): + """ + A referential relation is a resource corresponding to a database columns. + It's a subresource of sensitive data model resource and is always associated with a sensitive data model. + """ + + #: A constant which can be used with the lifecycle_state property of a ReferentialRelationSummary. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + #: A constant which can be used with the lifecycle_state property of a ReferentialRelationSummary. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a ReferentialRelationSummary. + #: This constant has a value of "UPDATING" + LIFECYCLE_STATE_UPDATING = "UPDATING" + + #: A constant which can be used with the lifecycle_state property of a ReferentialRelationSummary. + #: This constant has a value of "DELETING" + LIFECYCLE_STATE_DELETING = "DELETING" + + #: A constant which can be used with the lifecycle_state property of a ReferentialRelationSummary. + #: This constant has a value of "FAILED" + LIFECYCLE_STATE_FAILED = "FAILED" + + #: A constant which can be used with the relation_type property of a ReferentialRelationSummary. + #: This constant has a value of "NONE" + RELATION_TYPE_NONE = "NONE" + + #: A constant which can be used with the relation_type property of a ReferentialRelationSummary. + #: This constant has a value of "APP_DEFINED" + RELATION_TYPE_APP_DEFINED = "APP_DEFINED" + + #: A constant which can be used with the relation_type property of a ReferentialRelationSummary. + #: This constant has a value of "DB_DEFINED" + RELATION_TYPE_DB_DEFINED = "DB_DEFINED" + + def __init__(self, **kwargs): + """ + Initializes a new ReferentialRelationSummary object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param key: + The value to assign to the key property of this ReferentialRelationSummary. + :type key: str + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this ReferentialRelationSummary. + Allowed values for this property are: "CREATING", "ACTIVE", "UPDATING", "DELETING", "FAILED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type lifecycle_state: str + + :param sensitive_data_model_id: + The value to assign to the sensitive_data_model_id property of this ReferentialRelationSummary. + :type sensitive_data_model_id: str + + :param relation_type: + The value to assign to the relation_type property of this ReferentialRelationSummary. + Allowed values for this property are: "NONE", "APP_DEFINED", "DB_DEFINED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type relation_type: str + + :param parent: + The value to assign to the parent property of this ReferentialRelationSummary. + :type parent: oci.data_safe.models.ColumnsInfo + + :param child: + The value to assign to the child property of this ReferentialRelationSummary. + :type child: oci.data_safe.models.ColumnsInfo + + :param is_sensitive: + The value to assign to the is_sensitive property of this ReferentialRelationSummary. + :type is_sensitive: bool + + """ + self.swagger_types = { + 'key': 'str', + 'lifecycle_state': 'str', + 'sensitive_data_model_id': 'str', + 'relation_type': 'str', + 'parent': 'ColumnsInfo', + 'child': 'ColumnsInfo', + 'is_sensitive': 'bool' + } + + self.attribute_map = { + 'key': 'key', + 'lifecycle_state': 'lifecycleState', + 'sensitive_data_model_id': 'sensitiveDataModelId', + 'relation_type': 'relationType', + 'parent': 'parent', + 'child': 'child', + 'is_sensitive': 'isSensitive' + } + + self._key = None + self._lifecycle_state = None + self._sensitive_data_model_id = None + self._relation_type = None + self._parent = None + self._child = None + self._is_sensitive = None + + @property + def key(self): + """ + **[Required]** Gets the key of this ReferentialRelationSummary. + The unique key that identifies the referential relation. It's numeric and unique within a sensitive data model. + + + :return: The key of this ReferentialRelationSummary. + :rtype: str + """ + return self._key + + @key.setter + def key(self, key): + """ + Sets the key of this ReferentialRelationSummary. + The unique key that identifies the referential relation. It's numeric and unique within a sensitive data model. + + + :param key: The key of this ReferentialRelationSummary. + :type: str + """ + self._key = key + + @property + def lifecycle_state(self): + """ + **[Required]** Gets the lifecycle_state of this ReferentialRelationSummary. + The current state of the referential relation. + + Allowed values for this property are: "CREATING", "ACTIVE", "UPDATING", "DELETING", "FAILED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The lifecycle_state of this ReferentialRelationSummary. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this ReferentialRelationSummary. + The current state of the referential relation. + + + :param lifecycle_state: The lifecycle_state of this ReferentialRelationSummary. + :type: str + """ + allowed_values = ["CREATING", "ACTIVE", "UPDATING", "DELETING", "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 sensitive_data_model_id(self): + """ + **[Required]** Gets the sensitive_data_model_id of this ReferentialRelationSummary. + The OCID of the sensitive data model that contains the sensitive column. + + + :return: The sensitive_data_model_id of this ReferentialRelationSummary. + :rtype: str + """ + return self._sensitive_data_model_id + + @sensitive_data_model_id.setter + def sensitive_data_model_id(self, sensitive_data_model_id): + """ + Sets the sensitive_data_model_id of this ReferentialRelationSummary. + The OCID of the sensitive data model that contains the sensitive column. + + + :param sensitive_data_model_id: The sensitive_data_model_id of this ReferentialRelationSummary. + :type: str + """ + self._sensitive_data_model_id = sensitive_data_model_id + + @property + def relation_type(self): + """ + **[Required]** Gets the relation_type of this ReferentialRelationSummary. + The type of referential relationship the sensitive column has with its parent. NONE indicates that the + sensitive column does not have a parent. DB_DEFINED indicates that the relationship is defined in the database + dictionary. APP_DEFINED indicates that the relationship is defined at the application level and not in the database dictionary. + + Allowed values for this property are: "NONE", "APP_DEFINED", "DB_DEFINED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The relation_type of this ReferentialRelationSummary. + :rtype: str + """ + return self._relation_type + + @relation_type.setter + def relation_type(self, relation_type): + """ + Sets the relation_type of this ReferentialRelationSummary. + The type of referential relationship the sensitive column has with its parent. NONE indicates that the + sensitive column does not have a parent. DB_DEFINED indicates that the relationship is defined in the database + dictionary. APP_DEFINED indicates that the relationship is defined at the application level and not in the database dictionary. + + + :param relation_type: The relation_type of this ReferentialRelationSummary. + :type: str + """ + allowed_values = ["NONE", "APP_DEFINED", "DB_DEFINED"] + if not value_allowed_none_or_none_sentinel(relation_type, allowed_values): + relation_type = 'UNKNOWN_ENUM_VALUE' + self._relation_type = relation_type + + @property + def parent(self): + """ + **[Required]** Gets the parent of this ReferentialRelationSummary. + + :return: The parent of this ReferentialRelationSummary. + :rtype: oci.data_safe.models.ColumnsInfo + """ + return self._parent + + @parent.setter + def parent(self, parent): + """ + Sets the parent of this ReferentialRelationSummary. + + :param parent: The parent of this ReferentialRelationSummary. + :type: oci.data_safe.models.ColumnsInfo + """ + self._parent = parent + + @property + def child(self): + """ + **[Required]** Gets the child of this ReferentialRelationSummary. + + :return: The child of this ReferentialRelationSummary. + :rtype: oci.data_safe.models.ColumnsInfo + """ + return self._child + + @child.setter + def child(self, child): + """ + Sets the child of this ReferentialRelationSummary. + + :param child: The child of this ReferentialRelationSummary. + :type: oci.data_safe.models.ColumnsInfo + """ + self._child = child + + @property + def is_sensitive(self): + """ + Gets the is_sensitive of this ReferentialRelationSummary. + Determines if the columns present in the referential relation is present in the sensitive data model + + + :return: The is_sensitive of this ReferentialRelationSummary. + :rtype: bool + """ + return self._is_sensitive + + @is_sensitive.setter + def is_sensitive(self, is_sensitive): + """ + Sets the is_sensitive of this ReferentialRelationSummary. + Determines if the columns present in the referential relation is present in the sensitive data model + + + :param is_sensitive: The is_sensitive of this ReferentialRelationSummary. + :type: bool + """ + self._is_sensitive = is_sensitive + + 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/data_safe/models/regular_expression_format_entry.py b/src/oci/data_safe/models/regular_expression_format_entry.py index edcc36da0d..c7d7c5a256 100644 --- a/src/oci/data_safe/models/regular_expression_format_entry.py +++ b/src/oci/data_safe/models/regular_expression_format_entry.py @@ -93,8 +93,7 @@ def replace_with(self): """ **[Required]** Gets the replace_with of this RegularExpressionFormatEntry. The value that should be used to replace the data matching the regular - expression. It can be a fixed string, fixed number, null value, or - SQL expression. + expression. It can be a fixed string, fixed number or null value. :return: The replace_with of this RegularExpressionFormatEntry. @@ -107,8 +106,7 @@ def replace_with(self, replace_with): """ Sets the replace_with of this RegularExpressionFormatEntry. The value that should be used to replace the data matching the regular - expression. It can be a fixed string, fixed number, null value, or - SQL expression. + expression. It can be a fixed string, fixed number or null value. :param replace_with: The replace_with of this RegularExpressionFormatEntry. diff --git a/src/oci/data_safe/models/report.py b/src/oci/data_safe/models/report.py index 562af28d87..9fbe726480 100644 --- a/src/oci/data_safe/models/report.py +++ b/src/oci/data_safe/models/report.py @@ -456,7 +456,6 @@ def defined_tags(self): """ Gets the defined_tags of this Report. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -472,7 +471,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this Report. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/report_definition.py b/src/oci/data_safe/models/report_definition.py index 864f845dae..44536889bd 100644 --- a/src/oci/data_safe/models/report_definition.py +++ b/src/oci/data_safe/models/report_definition.py @@ -1007,7 +1007,6 @@ def defined_tags(self): """ Gets the defined_tags of this ReportDefinition. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -1023,7 +1022,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this ReportDefinition. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/report_definition_summary.py b/src/oci/data_safe/models/report_definition_summary.py index 4e9a21b66d..686230e937 100644 --- a/src/oci/data_safe/models/report_definition_summary.py +++ b/src/oci/data_safe/models/report_definition_summary.py @@ -592,7 +592,6 @@ def defined_tags(self): """ Gets the defined_tags of this ReportDefinitionSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -608,7 +607,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this ReportDefinitionSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/report_summary.py b/src/oci/data_safe/models/report_summary.py index a795823f58..fab042e485 100644 --- a/src/oci/data_safe/models/report_summary.py +++ b/src/oci/data_safe/models/report_summary.py @@ -418,7 +418,6 @@ def defined_tags(self): """ Gets the defined_tags of this ReportSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -434,7 +433,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this ReportSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/run_security_assessment_details.py b/src/oci/data_safe/models/run_security_assessment_details.py index 30cc5ff5a4..6bc71db9bc 100644 --- a/src/oci/data_safe/models/run_security_assessment_details.py +++ b/src/oci/data_safe/models/run_security_assessment_details.py @@ -141,7 +141,6 @@ def defined_tags(self): """ Gets the defined_tags of this RunSecurityAssessmentDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -157,7 +156,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this RunSecurityAssessmentDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/run_user_assessment_details.py b/src/oci/data_safe/models/run_user_assessment_details.py index 892effed74..dd8677688e 100644 --- a/src/oci/data_safe/models/run_user_assessment_details.py +++ b/src/oci/data_safe/models/run_user_assessment_details.py @@ -172,7 +172,6 @@ def defined_tags(self): """ Gets the defined_tags of this RunUserAssessmentDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -188,7 +187,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this RunUserAssessmentDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/sdm_masking_policy_difference.py b/src/oci/data_safe/models/sdm_masking_policy_difference.py index 612108004f..4b3d59c644 100644 --- a/src/oci/data_safe/models/sdm_masking_policy_difference.py +++ b/src/oci/data_safe/models/sdm_masking_policy_difference.py @@ -437,7 +437,6 @@ def defined_tags(self): """ Gets the defined_tags of this SdmMaskingPolicyDifference. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -453,7 +452,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this SdmMaskingPolicyDifference. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/sdm_masking_policy_difference_summary.py b/src/oci/data_safe/models/sdm_masking_policy_difference_summary.py index c3476c4b4f..1ef7744de4 100644 --- a/src/oci/data_safe/models/sdm_masking_policy_difference_summary.py +++ b/src/oci/data_safe/models/sdm_masking_policy_difference_summary.py @@ -366,7 +366,6 @@ def defined_tags(self): """ Gets the defined_tags of this SdmMaskingPolicyDifferenceSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -382,7 +381,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this SdmMaskingPolicyDifferenceSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/security_assessment.py b/src/oci/data_safe/models/security_assessment.py index 836a5c0ce0..5312bea66c 100644 --- a/src/oci/data_safe/models/security_assessment.py +++ b/src/oci/data_safe/models/security_assessment.py @@ -927,7 +927,6 @@ def defined_tags(self): """ Gets the defined_tags of this SecurityAssessment. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -943,7 +942,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this SecurityAssessment. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/security_assessment_summary.py b/src/oci/data_safe/models/security_assessment_summary.py index 01bd451d9c..03e8525346 100644 --- a/src/oci/data_safe/models/security_assessment_summary.py +++ b/src/oci/data_safe/models/security_assessment_summary.py @@ -852,7 +852,6 @@ def defined_tags(self): """ Gets the defined_tags of this SecurityAssessmentSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -868,7 +867,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this SecurityAssessmentSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/security_feature_summary.py b/src/oci/data_safe/models/security_feature_summary.py index 5d5a635cde..25cf16596a 100644 --- a/src/oci/data_safe/models/security_feature_summary.py +++ b/src/oci/data_safe/models/security_feature_summary.py @@ -733,7 +733,6 @@ def defined_tags(self): """ Gets the defined_tags of this SecurityFeatureSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -749,7 +748,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this SecurityFeatureSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/security_policy.py b/src/oci/data_safe/models/security_policy.py index 3ca4641bbd..ac54aa44d5 100644 --- a/src/oci/data_safe/models/security_policy.py +++ b/src/oci/data_safe/models/security_policy.py @@ -366,7 +366,6 @@ def defined_tags(self): """ Gets the defined_tags of this SecurityPolicy. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -382,7 +381,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this SecurityPolicy. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/security_policy_deployment.py b/src/oci/data_safe/models/security_policy_deployment.py index c517e6826d..adbd22b4fa 100644 --- a/src/oci/data_safe/models/security_policy_deployment.py +++ b/src/oci/data_safe/models/security_policy_deployment.py @@ -432,7 +432,6 @@ def defined_tags(self): """ Gets the defined_tags of this SecurityPolicyDeployment. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -448,7 +447,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this SecurityPolicyDeployment. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/security_policy_deployment_summary.py b/src/oci/data_safe/models/security_policy_deployment_summary.py index d95a24e7bb..bbcc7d7ad7 100644 --- a/src/oci/data_safe/models/security_policy_deployment_summary.py +++ b/src/oci/data_safe/models/security_policy_deployment_summary.py @@ -432,7 +432,6 @@ def defined_tags(self): """ Gets the defined_tags of this SecurityPolicyDeploymentSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -448,7 +447,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this SecurityPolicyDeploymentSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/security_policy_report.py b/src/oci/data_safe/models/security_policy_report.py index 54dece1f0f..e25550e57b 100644 --- a/src/oci/data_safe/models/security_policy_report.py +++ b/src/oci/data_safe/models/security_policy_report.py @@ -409,7 +409,6 @@ def defined_tags(self): """ Gets the defined_tags of this SecurityPolicyReport. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -425,7 +424,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this SecurityPolicyReport. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/security_policy_report_summary.py b/src/oci/data_safe/models/security_policy_report_summary.py index 1d0bed84ec..496961b24c 100644 --- a/src/oci/data_safe/models/security_policy_report_summary.py +++ b/src/oci/data_safe/models/security_policy_report_summary.py @@ -402,7 +402,6 @@ def defined_tags(self): """ Gets the defined_tags of this SecurityPolicyReportSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -418,7 +417,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this SecurityPolicyReportSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/security_policy_summary.py b/src/oci/data_safe/models/security_policy_summary.py index 4739701d6a..4c25ec9fc0 100644 --- a/src/oci/data_safe/models/security_policy_summary.py +++ b/src/oci/data_safe/models/security_policy_summary.py @@ -366,7 +366,6 @@ def defined_tags(self): """ Gets the defined_tags of this SecurityPolicySummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -382,7 +381,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this SecurityPolicySummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/sensitive_data_model.py b/src/oci/data_safe/models/sensitive_data_model.py index 4ff3501d20..81a106c5fb 100644 --- a/src/oci/data_safe/models/sensitive_data_model.py +++ b/src/oci/data_safe/models/sensitive_data_model.py @@ -655,7 +655,6 @@ def defined_tags(self): """ Gets the defined_tags of this SensitiveDataModel. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -671,7 +670,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this SensitiveDataModel. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/sensitive_data_model_summary.py b/src/oci/data_safe/models/sensitive_data_model_summary.py index 8aa70de26c..7d1d631beb 100644 --- a/src/oci/data_safe/models/sensitive_data_model_summary.py +++ b/src/oci/data_safe/models/sensitive_data_model_summary.py @@ -402,7 +402,6 @@ def defined_tags(self): """ Gets the defined_tags of this SensitiveDataModelSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -418,7 +417,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this SensitiveDataModelSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/sensitive_type.py b/src/oci/data_safe/models/sensitive_type.py index 1c63f9addd..f3dfb9d39c 100644 --- a/src/oci/data_safe/models/sensitive_type.py +++ b/src/oci/data_safe/models/sensitive_type.py @@ -559,7 +559,6 @@ def defined_tags(self): """ Gets the defined_tags of this SensitiveType. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -575,7 +574,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this SensitiveType. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/sensitive_type_summary.py b/src/oci/data_safe/models/sensitive_type_summary.py index 292c81cfb5..a251ac44eb 100644 --- a/src/oci/data_safe/models/sensitive_type_summary.py +++ b/src/oci/data_safe/models/sensitive_type_summary.py @@ -558,7 +558,6 @@ def defined_tags(self): """ Gets the defined_tags of this SensitiveTypeSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -574,7 +573,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this SensitiveTypeSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/sensitive_types_export.py b/src/oci/data_safe/models/sensitive_types_export.py new file mode 100644 index 0000000000..020133c8ec --- /dev/null +++ b/src/oci/data_safe/models/sensitive_types_export.py @@ -0,0 +1,471 @@ +# coding: utf-8 +# Copyright (c) 2016, 2025, 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: 20181201 + + +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 SensitiveTypesExport(object): + """ + The resource represents sensitive types to be exported in Data Safe. + """ + + #: A constant which can be used with the lifecycle_state property of a SensitiveTypesExport. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + #: A constant which can be used with the lifecycle_state property of a SensitiveTypesExport. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a SensitiveTypesExport. + #: This constant has a value of "UPDATING" + LIFECYCLE_STATE_UPDATING = "UPDATING" + + #: A constant which can be used with the lifecycle_state property of a SensitiveTypesExport. + #: This constant has a value of "DELETING" + LIFECYCLE_STATE_DELETING = "DELETING" + + #: A constant which can be used with the lifecycle_state property of a SensitiveTypesExport. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" + + #: A constant which can be used with the lifecycle_state property of a SensitiveTypesExport. + #: This constant has a value of "FAILED" + LIFECYCLE_STATE_FAILED = "FAILED" + + def __init__(self, **kwargs): + """ + Initializes a new SensitiveTypesExport 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 SensitiveTypesExport. + :type id: str + + :param display_name: + The value to assign to the display_name property of this SensitiveTypesExport. + :type display_name: str + + :param description: + The value to assign to the description property of this SensitiveTypesExport. + :type description: str + + :param compartment_id: + The value to assign to the compartment_id property of this SensitiveTypesExport. + :type compartment_id: str + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this SensitiveTypesExport. + Allowed values for this property are: "CREATING", "ACTIVE", "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 + + :param time_created: + The value to assign to the time_created property of this SensitiveTypesExport. + :type time_created: datetime + + :param time_updated: + The value to assign to the time_updated property of this SensitiveTypesExport. + :type time_updated: datetime + + :param sensitive_type_ids_for_export: + The value to assign to the sensitive_type_ids_for_export property of this SensitiveTypesExport. + :type sensitive_type_ids_for_export: list[str] + + :param is_include_all_sensitive_types: + The value to assign to the is_include_all_sensitive_types property of this SensitiveTypesExport. + :type is_include_all_sensitive_types: bool + + :param freeform_tags: + The value to assign to the freeform_tags property of this SensitiveTypesExport. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this SensitiveTypesExport. + :type defined_tags: dict(str, dict(str, object)) + + :param system_tags: + The value to assign to the system_tags property of this SensitiveTypesExport. + :type system_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'id': 'str', + 'display_name': 'str', + 'description': 'str', + 'compartment_id': 'str', + 'lifecycle_state': 'str', + 'time_created': 'datetime', + 'time_updated': 'datetime', + 'sensitive_type_ids_for_export': 'list[str]', + 'is_include_all_sensitive_types': 'bool', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))', + 'system_tags': 'dict(str, dict(str, object))' + } + + self.attribute_map = { + 'id': 'id', + 'display_name': 'displayName', + 'description': 'description', + 'compartment_id': 'compartmentId', + 'lifecycle_state': 'lifecycleState', + 'time_created': 'timeCreated', + 'time_updated': 'timeUpdated', + 'sensitive_type_ids_for_export': 'sensitiveTypeIdsForExport', + 'is_include_all_sensitive_types': 'isIncludeAllSensitiveTypes', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags', + 'system_tags': 'systemTags' + } + + self._id = None + self._display_name = None + self._description = None + self._compartment_id = None + self._lifecycle_state = None + self._time_created = None + self._time_updated = None + self._sensitive_type_ids_for_export = None + self._is_include_all_sensitive_types = None + self._freeform_tags = None + self._defined_tags = None + self._system_tags = None + + @property + def id(self): + """ + **[Required]** Gets the id of this SensitiveTypesExport. + The OCID of the sensitive types export. + + + :return: The id of this SensitiveTypesExport. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this SensitiveTypesExport. + The OCID of the sensitive types export. + + + :param id: The id of this SensitiveTypesExport. + :type: str + """ + self._id = id + + @property + def display_name(self): + """ + **[Required]** Gets the display_name of this SensitiveTypesExport. + The display name of the sensitive types export. + + + :return: The display_name of this SensitiveTypesExport. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this SensitiveTypesExport. + The display name of the sensitive types export. + + + :param display_name: The display_name of this SensitiveTypesExport. + :type: str + """ + self._display_name = display_name + + @property + def description(self): + """ + Gets the description of this SensitiveTypesExport. + The description of the sensitive types export. + + + :return: The description of this SensitiveTypesExport. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this SensitiveTypesExport. + The description of the sensitive types export. + + + :param description: The description of this SensitiveTypesExport. + :type: str + """ + self._description = description + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this SensitiveTypesExport. + The OCID of the compartment that contains the sensitive types export. + + + :return: The compartment_id of this SensitiveTypesExport. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this SensitiveTypesExport. + The OCID of the compartment that contains the sensitive types export. + + + :param compartment_id: The compartment_id of this SensitiveTypesExport. + :type: str + """ + self._compartment_id = compartment_id + + @property + def lifecycle_state(self): + """ + **[Required]** Gets the lifecycle_state of this SensitiveTypesExport. + The current state of the sensitive types export. + + Allowed values for this property are: "CREATING", "ACTIVE", "UPDATING", "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 SensitiveTypesExport. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this SensitiveTypesExport. + The current state of the sensitive types export. + + + :param lifecycle_state: The lifecycle_state of this SensitiveTypesExport. + :type: str + """ + allowed_values = ["CREATING", "ACTIVE", "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 + + @property + def time_created(self): + """ + **[Required]** Gets the time_created of this SensitiveTypesExport. + The date and time the sensitive types export was created, in the format defined by `RFC3339`__. + + __ https://tools.ietf.org/html/rfc3339 + + + :return: The time_created of this SensitiveTypesExport. + :rtype: datetime + """ + return self._time_created + + @time_created.setter + def time_created(self, time_created): + """ + Sets the time_created of this SensitiveTypesExport. + The date and time the sensitive types export was created, in the format defined by `RFC3339`__. + + __ https://tools.ietf.org/html/rfc3339 + + + :param time_created: The time_created of this SensitiveTypesExport. + :type: datetime + """ + self._time_created = time_created + + @property + def time_updated(self): + """ + Gets the time_updated of this SensitiveTypesExport. + The date and time the sensitive types export was last updated, in the format defined by `RFC3339`__. + + __ https://tools.ietf.org/html/rfc3339 + + + :return: The time_updated of this SensitiveTypesExport. + :rtype: datetime + """ + return self._time_updated + + @time_updated.setter + def time_updated(self, time_updated): + """ + Sets the time_updated of this SensitiveTypesExport. + The date and time the sensitive types export was last updated, in the format defined by `RFC3339`__. + + __ https://tools.ietf.org/html/rfc3339 + + + :param time_updated: The time_updated of this SensitiveTypesExport. + :type: datetime + """ + self._time_updated = time_updated + + @property + def sensitive_type_ids_for_export(self): + """ + Gets the sensitive_type_ids_for_export of this SensitiveTypesExport. + The OCIDs of the sensitive types used to create sensitive types export. + + + :return: The sensitive_type_ids_for_export of this SensitiveTypesExport. + :rtype: list[str] + """ + return self._sensitive_type_ids_for_export + + @sensitive_type_ids_for_export.setter + def sensitive_type_ids_for_export(self, sensitive_type_ids_for_export): + """ + Sets the sensitive_type_ids_for_export of this SensitiveTypesExport. + The OCIDs of the sensitive types used to create sensitive types export. + + + :param sensitive_type_ids_for_export: The sensitive_type_ids_for_export of this SensitiveTypesExport. + :type: list[str] + """ + self._sensitive_type_ids_for_export = sensitive_type_ids_for_export + + @property + def is_include_all_sensitive_types(self): + """ + **[Required]** Gets the is_include_all_sensitive_types of this SensitiveTypesExport. + Indicates if all the existing user-defined sensitive types are used for export. If it's set to true, the + sensitiveTypeIdsForExport attribute is ignored and all user-defined sensitive types are exported. + + + :return: The is_include_all_sensitive_types of this SensitiveTypesExport. + :rtype: bool + """ + return self._is_include_all_sensitive_types + + @is_include_all_sensitive_types.setter + def is_include_all_sensitive_types(self, is_include_all_sensitive_types): + """ + Sets the is_include_all_sensitive_types of this SensitiveTypesExport. + Indicates if all the existing user-defined sensitive types are used for export. If it's set to true, the + sensitiveTypeIdsForExport attribute is ignored and all user-defined sensitive types are exported. + + + :param is_include_all_sensitive_types: The is_include_all_sensitive_types of this SensitiveTypesExport. + :type: bool + """ + self._is_include_all_sensitive_types = is_include_all_sensitive_types + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this SensitiveTypesExport. + Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see `Resource Tags`__ + + Example: `{\"Department\": \"Finance\"}` + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm + + + :return: The freeform_tags of this SensitiveTypesExport. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this SensitiveTypesExport. + Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see `Resource Tags`__ + + Example: `{\"Department\": \"Finance\"}` + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm + + + :param freeform_tags: The freeform_tags of this SensitiveTypesExport. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this SensitiveTypesExport. + Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ + Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm + + + :return: The defined_tags of this SensitiveTypesExport. + :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 SensitiveTypesExport. + Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ + Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm + + + :param defined_tags: The defined_tags of this SensitiveTypesExport. + :type: dict(str, dict(str, object)) + """ + self._defined_tags = defined_tags + + @property + def system_tags(self): + """ + Gets the system_tags of this SensitiveTypesExport. + System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. + Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}` + + + :return: The system_tags of this SensitiveTypesExport. + :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 SensitiveTypesExport. + System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. + Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}` + + + :param system_tags: The system_tags of this SensitiveTypesExport. + :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/data_safe/models/sensitive_types_export_collection.py b/src/oci/data_safe/models/sensitive_types_export_collection.py new file mode 100644 index 0000000000..1a3b8ea588 --- /dev/null +++ b/src/oci/data_safe/models/sensitive_types_export_collection.py @@ -0,0 +1,72 @@ +# coding: utf-8 +# Copyright (c) 2016, 2025, 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: 20181201 + + +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 SensitiveTypesExportCollection(object): + """ + A collection of sensitive types export summary objects. + """ + + def __init__(self, **kwargs): + """ + Initializes a new SensitiveTypesExportCollection 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 SensitiveTypesExportCollection. + :type items: list[oci.data_safe.models.SensitiveTypesExportSummary] + + """ + self.swagger_types = { + 'items': 'list[SensitiveTypesExportSummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this SensitiveTypesExportCollection. + An array of sensitive types export summary objects. + + + :return: The items of this SensitiveTypesExportCollection. + :rtype: list[oci.data_safe.models.SensitiveTypesExportSummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this SensitiveTypesExportCollection. + An array of sensitive types export summary objects. + + + :param items: The items of this SensitiveTypesExportCollection. + :type: list[oci.data_safe.models.SensitiveTypesExportSummary] + """ + 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/data_safe/models/sensitive_types_export_summary.py b/src/oci/data_safe/models/sensitive_types_export_summary.py new file mode 100644 index 0000000000..ce1ce1e37d --- /dev/null +++ b/src/oci/data_safe/models/sensitive_types_export_summary.py @@ -0,0 +1,374 @@ +# coding: utf-8 +# Copyright (c) 2016, 2025, 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: 20181201 + + +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 SensitiveTypesExportSummary(object): + """ + The resource represents collection of sensitive types needed to be exported. + """ + + #: A constant which can be used with the lifecycle_state property of a SensitiveTypesExportSummary. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + #: A constant which can be used with the lifecycle_state property of a SensitiveTypesExportSummary. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a SensitiveTypesExportSummary. + #: This constant has a value of "UPDATING" + LIFECYCLE_STATE_UPDATING = "UPDATING" + + #: A constant which can be used with the lifecycle_state property of a SensitiveTypesExportSummary. + #: This constant has a value of "DELETING" + LIFECYCLE_STATE_DELETING = "DELETING" + + #: A constant which can be used with the lifecycle_state property of a SensitiveTypesExportSummary. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" + + #: A constant which can be used with the lifecycle_state property of a SensitiveTypesExportSummary. + #: This constant has a value of "FAILED" + LIFECYCLE_STATE_FAILED = "FAILED" + + def __init__(self, **kwargs): + """ + Initializes a new SensitiveTypesExportSummary 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 SensitiveTypesExportSummary. + :type id: str + + :param display_name: + The value to assign to the display_name property of this SensitiveTypesExportSummary. + :type display_name: str + + :param compartment_id: + The value to assign to the compartment_id property of this SensitiveTypesExportSummary. + :type compartment_id: str + + :param time_created: + The value to assign to the time_created property of this SensitiveTypesExportSummary. + :type time_created: datetime + + :param time_updated: + The value to assign to the time_updated property of this SensitiveTypesExportSummary. + :type time_updated: datetime + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this SensitiveTypesExportSummary. + Allowed values for this property are: "CREATING", "ACTIVE", "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 + + :param description: + The value to assign to the description property of this SensitiveTypesExportSummary. + :type description: str + + :param freeform_tags: + The value to assign to the freeform_tags property of this SensitiveTypesExportSummary. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this SensitiveTypesExportSummary. + :type defined_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'id': 'str', + 'display_name': 'str', + 'compartment_id': 'str', + 'time_created': 'datetime', + 'time_updated': 'datetime', + 'lifecycle_state': 'str', + 'description': 'str', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))' + } + + self.attribute_map = { + 'id': 'id', + 'display_name': 'displayName', + 'compartment_id': 'compartmentId', + 'time_created': 'timeCreated', + 'time_updated': 'timeUpdated', + 'lifecycle_state': 'lifecycleState', + 'description': 'description', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags' + } + + self._id = None + self._display_name = None + self._compartment_id = None + self._time_created = None + self._time_updated = None + self._lifecycle_state = None + self._description = None + self._freeform_tags = None + self._defined_tags = None + + @property + def id(self): + """ + **[Required]** Gets the id of this SensitiveTypesExportSummary. + The OCID of the sensitive types export. + + + :return: The id of this SensitiveTypesExportSummary. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this SensitiveTypesExportSummary. + The OCID of the sensitive types export. + + + :param id: The id of this SensitiveTypesExportSummary. + :type: str + """ + self._id = id + + @property + def display_name(self): + """ + **[Required]** Gets the display_name of this SensitiveTypesExportSummary. + The display name of the sensitive types export. + + + :return: The display_name of this SensitiveTypesExportSummary. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this SensitiveTypesExportSummary. + The display name of the sensitive types export. + + + :param display_name: The display_name of this SensitiveTypesExportSummary. + :type: str + """ + self._display_name = display_name + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this SensitiveTypesExportSummary. + The OCID of the compartment that contains sensitive types export. + + + :return: The compartment_id of this SensitiveTypesExportSummary. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this SensitiveTypesExportSummary. + The OCID of the compartment that contains sensitive types export. + + + :param compartment_id: The compartment_id of this SensitiveTypesExportSummary. + :type: str + """ + self._compartment_id = compartment_id + + @property + def time_created(self): + """ + **[Required]** Gets the time_created of this SensitiveTypesExportSummary. + The date and time the sensitive types export was created, in the format defined by `RFC3339`__. + + __ https://tools.ietf.org/html/rfc3339 + + + :return: The time_created of this SensitiveTypesExportSummary. + :rtype: datetime + """ + return self._time_created + + @time_created.setter + def time_created(self, time_created): + """ + Sets the time_created of this SensitiveTypesExportSummary. + The date and time the sensitive types export was created, in the format defined by `RFC3339`__. + + __ https://tools.ietf.org/html/rfc3339 + + + :param time_created: The time_created of this SensitiveTypesExportSummary. + :type: datetime + """ + self._time_created = time_created + + @property + def time_updated(self): + """ + Gets the time_updated of this SensitiveTypesExportSummary. + The date and time the sensitive types export was last updated, in the format defined by `RFC3339`__. + + __ https://tools.ietf.org/html/rfc3339 + + + :return: The time_updated of this SensitiveTypesExportSummary. + :rtype: datetime + """ + return self._time_updated + + @time_updated.setter + def time_updated(self, time_updated): + """ + Sets the time_updated of this SensitiveTypesExportSummary. + The date and time the sensitive types export was last updated, in the format defined by `RFC3339`__. + + __ https://tools.ietf.org/html/rfc3339 + + + :param time_updated: The time_updated of this SensitiveTypesExportSummary. + :type: datetime + """ + self._time_updated = time_updated + + @property + def lifecycle_state(self): + """ + **[Required]** Gets the lifecycle_state of this SensitiveTypesExportSummary. + The current state of the sensitive types export. + + Allowed values for this property are: "CREATING", "ACTIVE", "UPDATING", "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 SensitiveTypesExportSummary. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this SensitiveTypesExportSummary. + The current state of the sensitive types export. + + + :param lifecycle_state: The lifecycle_state of this SensitiveTypesExportSummary. + :type: str + """ + allowed_values = ["CREATING", "ACTIVE", "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 + + @property + def description(self): + """ + Gets the description of this SensitiveTypesExportSummary. + The description of the sensitive types export. + + + :return: The description of this SensitiveTypesExportSummary. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this SensitiveTypesExportSummary. + The description of the sensitive types export. + + + :param description: The description of this SensitiveTypesExportSummary. + :type: str + """ + self._description = description + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this SensitiveTypesExportSummary. + Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see `Resource Tags`__ + + Example: `{\"Department\": \"Finance\"}` + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm + + + :return: The freeform_tags of this SensitiveTypesExportSummary. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this SensitiveTypesExportSummary. + Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see `Resource Tags`__ + + Example: `{\"Department\": \"Finance\"}` + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm + + + :param freeform_tags: The freeform_tags of this SensitiveTypesExportSummary. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this SensitiveTypesExportSummary. + Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ + Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm + + + :return: The defined_tags of this SensitiveTypesExportSummary. + :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 SensitiveTypesExportSummary. + Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ + Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm + + + :param defined_tags: The defined_tags of this SensitiveTypesExportSummary. + :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/data_safe/models/sql_collection.py b/src/oci/data_safe/models/sql_collection.py index 2cde7957f7..53a2cd63df 100644 --- a/src/oci/data_safe/models/sql_collection.py +++ b/src/oci/data_safe/models/sql_collection.py @@ -601,7 +601,6 @@ def defined_tags(self): """ Gets the defined_tags of this SqlCollection. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -617,7 +616,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this SqlCollection. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/sql_collection_summary.py b/src/oci/data_safe/models/sql_collection_summary.py index caaebdd5c7..d5d7c4e739 100644 --- a/src/oci/data_safe/models/sql_collection_summary.py +++ b/src/oci/data_safe/models/sql_collection_summary.py @@ -594,7 +594,6 @@ def defined_tags(self): """ Gets the defined_tags of this SqlCollectionSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -610,7 +609,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this SqlCollectionSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/sql_firewall_allowed_sql.py b/src/oci/data_safe/models/sql_firewall_allowed_sql.py index 3be56ffc8a..dfb7d57a49 100644 --- a/src/oci/data_safe/models/sql_firewall_allowed_sql.py +++ b/src/oci/data_safe/models/sql_firewall_allowed_sql.py @@ -560,7 +560,6 @@ def defined_tags(self): """ Gets the defined_tags of this SqlFirewallAllowedSql. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -576,7 +575,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this SqlFirewallAllowedSql. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/sql_firewall_allowed_sql_summary.py b/src/oci/data_safe/models/sql_firewall_allowed_sql_summary.py index 61978f0845..d363db4629 100644 --- a/src/oci/data_safe/models/sql_firewall_allowed_sql_summary.py +++ b/src/oci/data_safe/models/sql_firewall_allowed_sql_summary.py @@ -560,7 +560,6 @@ def defined_tags(self): """ Gets the defined_tags of this SqlFirewallAllowedSqlSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -576,7 +575,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this SqlFirewallAllowedSqlSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/sql_firewall_policy.py b/src/oci/data_safe/models/sql_firewall_policy.py index 4bfafdec51..882ad15b72 100644 --- a/src/oci/data_safe/models/sql_firewall_policy.py +++ b/src/oci/data_safe/models/sql_firewall_policy.py @@ -772,7 +772,6 @@ def defined_tags(self): """ Gets the defined_tags of this SqlFirewallPolicy. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -788,7 +787,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this SqlFirewallPolicy. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/sql_firewall_policy_summary.py b/src/oci/data_safe/models/sql_firewall_policy_summary.py index 50be808c26..cb3d4ee7bf 100644 --- a/src/oci/data_safe/models/sql_firewall_policy_summary.py +++ b/src/oci/data_safe/models/sql_firewall_policy_summary.py @@ -672,7 +672,6 @@ def defined_tags(self): """ Gets the defined_tags of this SqlFirewallPolicySummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -688,7 +687,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this SqlFirewallPolicySummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/target_alert_policy_association.py b/src/oci/data_safe/models/target_alert_policy_association.py index cad713b9c4..ebc5b1c5ae 100644 --- a/src/oci/data_safe/models/target_alert_policy_association.py +++ b/src/oci/data_safe/models/target_alert_policy_association.py @@ -467,7 +467,6 @@ def defined_tags(self): """ Gets the defined_tags of this TargetAlertPolicyAssociation. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -483,7 +482,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this TargetAlertPolicyAssociation. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/target_alert_policy_association_summary.py b/src/oci/data_safe/models/target_alert_policy_association_summary.py index f39138f252..793c9e0595 100644 --- a/src/oci/data_safe/models/target_alert_policy_association_summary.py +++ b/src/oci/data_safe/models/target_alert_policy_association_summary.py @@ -460,7 +460,6 @@ def defined_tags(self): """ Gets the defined_tags of this TargetAlertPolicyAssociationSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -476,7 +475,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this TargetAlertPolicyAssociationSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/target_database.py b/src/oci/data_safe/models/target_database.py index f1aa26ba11..7a3c1a1b80 100644 --- a/src/oci/data_safe/models/target_database.py +++ b/src/oci/data_safe/models/target_database.py @@ -544,7 +544,6 @@ def defined_tags(self): """ Gets the defined_tags of this TargetDatabase. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -560,7 +559,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this TargetDatabase. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/target_database_summary.py b/src/oci/data_safe/models/target_database_summary.py index 751525079e..1b3d6a0611 100644 --- a/src/oci/data_safe/models/target_database_summary.py +++ b/src/oci/data_safe/models/target_database_summary.py @@ -473,7 +473,6 @@ def defined_tags(self): """ Gets the defined_tags of this TargetDatabaseSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -489,7 +488,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this TargetDatabaseSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/update_alert_details.py b/src/oci/data_safe/models/update_alert_details.py index 7b27376748..fd0e73aa54 100644 --- a/src/oci/data_safe/models/update_alert_details.py +++ b/src/oci/data_safe/models/update_alert_details.py @@ -157,7 +157,6 @@ def defined_tags(self): """ Gets the defined_tags of this UpdateAlertDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -173,7 +172,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this UpdateAlertDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/update_alert_policy_details.py b/src/oci/data_safe/models/update_alert_policy_details.py index 04e80af01a..e717d0bac6 100644 --- a/src/oci/data_safe/models/update_alert_policy_details.py +++ b/src/oci/data_safe/models/update_alert_policy_details.py @@ -200,7 +200,6 @@ def defined_tags(self): """ Gets the defined_tags of this UpdateAlertPolicyDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -216,7 +215,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this UpdateAlertPolicyDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/update_audit_archive_retrieval_details.py b/src/oci/data_safe/models/update_audit_archive_retrieval_details.py index bafd86bd4f..88e8bb8cd4 100644 --- a/src/oci/data_safe/models/update_audit_archive_retrieval_details.py +++ b/src/oci/data_safe/models/update_audit_archive_retrieval_details.py @@ -141,7 +141,6 @@ def defined_tags(self): """ Gets the defined_tags of this UpdateAuditArchiveRetrievalDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -157,7 +156,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this UpdateAuditArchiveRetrievalDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/update_audit_policy_details.py b/src/oci/data_safe/models/update_audit_policy_details.py index 23885cb58d..d762f28bd0 100644 --- a/src/oci/data_safe/models/update_audit_policy_details.py +++ b/src/oci/data_safe/models/update_audit_policy_details.py @@ -141,7 +141,6 @@ def defined_tags(self): """ Gets the defined_tags of this UpdateAuditPolicyDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -157,7 +156,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this UpdateAuditPolicyDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/update_audit_profile_details.py b/src/oci/data_safe/models/update_audit_profile_details.py index 29cfb53b6e..e0acb6c5c2 100644 --- a/src/oci/data_safe/models/update_audit_profile_details.py +++ b/src/oci/data_safe/models/update_audit_profile_details.py @@ -91,7 +91,7 @@ def description(self, description): def display_name(self): """ Gets the display_name of this UpdateAuditProfileDetails. - The display name of the audit profile. The name does not have to be unique, and it's changeable. + The display name of the audit profile. The name does not have to be unique, and it's updatable. :return: The display_name of this UpdateAuditProfileDetails. @@ -103,7 +103,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this UpdateAuditProfileDetails. - The display name of the audit profile. The name does not have to be unique, and it's changeable. + The display name of the audit profile. The name does not have to be unique, and it's updatable. :param display_name: The display_name of this UpdateAuditProfileDetails. @@ -176,7 +176,6 @@ def defined_tags(self): """ Gets the defined_tags of this UpdateAuditProfileDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -192,7 +191,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this UpdateAuditProfileDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/update_audit_trail_details.py b/src/oci/data_safe/models/update_audit_trail_details.py index 544ff396a9..2cecf3fad8 100644 --- a/src/oci/data_safe/models/update_audit_trail_details.py +++ b/src/oci/data_safe/models/update_audit_trail_details.py @@ -91,7 +91,7 @@ def description(self, description): def display_name(self): """ Gets the display_name of this UpdateAuditTrailDetails. - The display name of the audit trail. The name does not have to be unique, and it's changeable. + The display name of the audit trail. The name does not have to be unique, and it's updatable. :return: The display_name of this UpdateAuditTrailDetails. @@ -103,7 +103,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this UpdateAuditTrailDetails. - The display name of the audit trail. The name does not have to be unique, and it's changeable. + The display name of the audit trail. The name does not have to be unique, and it's updatable. :param display_name: The display_name of this UpdateAuditTrailDetails. @@ -174,7 +174,6 @@ def defined_tags(self): """ Gets the defined_tags of this UpdateAuditTrailDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -190,7 +189,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this UpdateAuditTrailDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/update_data_safe_private_endpoint_details.py b/src/oci/data_safe/models/update_data_safe_private_endpoint_details.py index 82888d6324..db42ac5bac 100644 --- a/src/oci/data_safe/models/update_data_safe_private_endpoint_details.py +++ b/src/oci/data_safe/models/update_data_safe_private_endpoint_details.py @@ -172,7 +172,6 @@ def defined_tags(self): """ Gets the defined_tags of this UpdateDataSafePrivateEndpointDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -188,7 +187,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this UpdateDataSafePrivateEndpointDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/update_database_security_config_details.py b/src/oci/data_safe/models/update_database_security_config_details.py index 978f39567d..ebfc2133fa 100644 --- a/src/oci/data_safe/models/update_database_security_config_details.py +++ b/src/oci/data_safe/models/update_database_security_config_details.py @@ -168,7 +168,6 @@ def defined_tags(self): """ Gets the defined_tags of this UpdateDatabaseSecurityConfigDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -184,7 +183,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this UpdateDatabaseSecurityConfigDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/update_library_masking_format_details.py b/src/oci/data_safe/models/update_library_masking_format_details.py index d2e376cb52..814f239136 100644 --- a/src/oci/data_safe/models/update_library_masking_format_details.py +++ b/src/oci/data_safe/models/update_library_masking_format_details.py @@ -204,7 +204,6 @@ def defined_tags(self): """ Gets the defined_tags of this UpdateLibraryMaskingFormatDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -220,7 +219,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this UpdateLibraryMaskingFormatDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/update_masking_policy_details.py b/src/oci/data_safe/models/update_masking_policy_details.py index 41b3b0ef71..a4c89c933d 100644 --- a/src/oci/data_safe/models/update_masking_policy_details.py +++ b/src/oci/data_safe/models/update_masking_policy_details.py @@ -419,7 +419,6 @@ def defined_tags(self): """ Gets the defined_tags of this UpdateMaskingPolicyDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -435,7 +434,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this UpdateMaskingPolicyDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/update_on_prem_connector_details.py b/src/oci/data_safe/models/update_on_prem_connector_details.py index 1c1b156c59..88880a44a5 100644 --- a/src/oci/data_safe/models/update_on_prem_connector_details.py +++ b/src/oci/data_safe/models/update_on_prem_connector_details.py @@ -141,7 +141,6 @@ def defined_tags(self): """ Gets the defined_tags of this UpdateOnPremConnectorDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -157,7 +156,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this UpdateOnPremConnectorDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/update_report_definition_details.py b/src/oci/data_safe/models/update_report_definition_details.py index 7c2c257ae6..7d9842f12d 100644 --- a/src/oci/data_safe/models/update_report_definition_details.py +++ b/src/oci/data_safe/models/update_report_definition_details.py @@ -265,7 +265,6 @@ def defined_tags(self): """ Gets the defined_tags of this UpdateReportDefinitionDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -281,7 +280,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this UpdateReportDefinitionDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/update_report_details.py b/src/oci/data_safe/models/update_report_details.py index 49882dfad3..5ad1e1d3ae 100644 --- a/src/oci/data_safe/models/update_report_details.py +++ b/src/oci/data_safe/models/update_report_details.py @@ -79,7 +79,6 @@ def defined_tags(self): """ Gets the defined_tags of this UpdateReportDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -95,7 +94,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this UpdateReportDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/update_sdm_masking_policy_difference_details.py b/src/oci/data_safe/models/update_sdm_masking_policy_difference_details.py index 6e78aeacf1..5025c80651 100644 --- a/src/oci/data_safe/models/update_sdm_masking_policy_difference_details.py +++ b/src/oci/data_safe/models/update_sdm_masking_policy_difference_details.py @@ -110,7 +110,6 @@ def defined_tags(self): """ Gets the defined_tags of this UpdateSdmMaskingPolicyDifferenceDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -126,7 +125,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this UpdateSdmMaskingPolicyDifferenceDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/update_security_assessment_details.py b/src/oci/data_safe/models/update_security_assessment_details.py index 08b5e5917a..7c5d9b4ab6 100644 --- a/src/oci/data_safe/models/update_security_assessment_details.py +++ b/src/oci/data_safe/models/update_security_assessment_details.py @@ -229,7 +229,6 @@ def defined_tags(self): """ Gets the defined_tags of this UpdateSecurityAssessmentDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -245,7 +244,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this UpdateSecurityAssessmentDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/update_security_policy_deployment_details.py b/src/oci/data_safe/models/update_security_policy_deployment_details.py index ae2d3262eb..6866596b8b 100644 --- a/src/oci/data_safe/models/update_security_policy_deployment_details.py +++ b/src/oci/data_safe/models/update_security_policy_deployment_details.py @@ -141,7 +141,6 @@ def defined_tags(self): """ Gets the defined_tags of this UpdateSecurityPolicyDeploymentDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -157,7 +156,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this UpdateSecurityPolicyDeploymentDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/update_security_policy_details.py b/src/oci/data_safe/models/update_security_policy_details.py index 1d7332a80b..02cedc3e99 100644 --- a/src/oci/data_safe/models/update_security_policy_details.py +++ b/src/oci/data_safe/models/update_security_policy_details.py @@ -141,7 +141,6 @@ def defined_tags(self): """ Gets the defined_tags of this UpdateSecurityPolicyDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -157,7 +156,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this UpdateSecurityPolicyDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/update_sensitive_data_model_details.py b/src/oci/data_safe/models/update_sensitive_data_model_details.py index 10ab0d8e24..e63a3b4c06 100644 --- a/src/oci/data_safe/models/update_sensitive_data_model_details.py +++ b/src/oci/data_safe/models/update_sensitive_data_model_details.py @@ -386,7 +386,6 @@ def defined_tags(self): """ Gets the defined_tags of this UpdateSensitiveDataModelDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -402,7 +401,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this UpdateSensitiveDataModelDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/update_sensitive_type_details.py b/src/oci/data_safe/models/update_sensitive_type_details.py index 2dbba9114c..7f5774112a 100644 --- a/src/oci/data_safe/models/update_sensitive_type_details.py +++ b/src/oci/data_safe/models/update_sensitive_type_details.py @@ -273,7 +273,6 @@ def defined_tags(self): """ Gets the defined_tags of this UpdateSensitiveTypeDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -289,7 +288,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this UpdateSensitiveTypeDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/create_audit_policy_details.py b/src/oci/data_safe/models/update_sensitive_types_export_details.py similarity index 55% rename from src/oci/data_safe/models/create_audit_policy_details.py rename to src/oci/data_safe/models/update_sensitive_types_export_details.py index 00f0198e48..69a39ace3e 100644 --- a/src/oci/data_safe/models/create_audit_policy_details.py +++ b/src/oci/data_safe/models/update_sensitive_types_export_details.py @@ -10,46 +10,36 @@ @init_model_state_from_kwargs -class CreateAuditPolicyDetails(object): +class UpdateSensitiveTypesExportDetails(object): """ - Details for the new audit policy. + Details to update a sensitive types export. """ def __init__(self, **kwargs): """ - Initializes a new CreateAuditPolicyDetails object with values from keyword arguments. + Initializes a new UpdateSensitiveTypesExportDetails object with values from keyword arguments. 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 CreateAuditPolicyDetails. + The value to assign to the display_name property of this UpdateSensitiveTypesExportDetails. :type display_name: str :param description: - The value to assign to the description property of this CreateAuditPolicyDetails. + The value to assign to the description property of this UpdateSensitiveTypesExportDetails. :type description: str - :param compartment_id: - The value to assign to the compartment_id property of this CreateAuditPolicyDetails. - :type compartment_id: str - - :param target_id: - The value to assign to the target_id property of this CreateAuditPolicyDetails. - :type target_id: str - :param freeform_tags: - The value to assign to the freeform_tags property of this CreateAuditPolicyDetails. + The value to assign to the freeform_tags property of this UpdateSensitiveTypesExportDetails. :type freeform_tags: dict(str, str) :param defined_tags: - The value to assign to the defined_tags property of this CreateAuditPolicyDetails. + The value to assign to the defined_tags property of this UpdateSensitiveTypesExportDetails. :type defined_tags: dict(str, dict(str, object)) """ self.swagger_types = { 'display_name': 'str', 'description': 'str', - 'compartment_id': 'str', - 'target_id': 'str', 'freeform_tags': 'dict(str, str)', 'defined_tags': 'dict(str, dict(str, object))' } @@ -57,27 +47,23 @@ def __init__(self, **kwargs): self.attribute_map = { 'display_name': 'displayName', 'description': 'description', - 'compartment_id': 'compartmentId', - 'target_id': 'targetId', 'freeform_tags': 'freeformTags', 'defined_tags': 'definedTags' } self._display_name = None self._description = None - self._compartment_id = None - self._target_id = None self._freeform_tags = None self._defined_tags = None @property def display_name(self): """ - Gets the display_name of this CreateAuditPolicyDetails. - The display name of the audit policy. The name does not have to be unique, and it is changeable. + Gets the display_name of this UpdateSensitiveTypesExportDetails. + The display name of the sensitive types export. The name does not have to be unique, and it's changeable. - :return: The display_name of this CreateAuditPolicyDetails. + :return: The display_name of this UpdateSensitiveTypesExportDetails. :rtype: str """ return self._display_name @@ -85,11 +71,11 @@ def display_name(self): @display_name.setter def display_name(self, display_name): """ - Sets the display_name of this CreateAuditPolicyDetails. - The display name of the audit policy. The name does not have to be unique, and it is changeable. + Sets the display_name of this UpdateSensitiveTypesExportDetails. + The display name of the sensitive types export. The name does not have to be unique, and it's changeable. - :param display_name: The display_name of this CreateAuditPolicyDetails. + :param display_name: The display_name of this UpdateSensitiveTypesExportDetails. :type: str """ self._display_name = display_name @@ -97,11 +83,11 @@ def display_name(self, display_name): @property def description(self): """ - Gets the description of this CreateAuditPolicyDetails. - The description of the audit policy. + Gets the description of this UpdateSensitiveTypesExportDetails. + The description of the sensitive types export. - :return: The description of this CreateAuditPolicyDetails. + :return: The description of this UpdateSensitiveTypesExportDetails. :rtype: str """ return self._description @@ -109,67 +95,19 @@ def description(self): @description.setter def description(self, description): """ - Sets the description of this CreateAuditPolicyDetails. - The description of the audit policy. + Sets the description of this UpdateSensitiveTypesExportDetails. + The description of the sensitive types export. - :param description: The description of this CreateAuditPolicyDetails. + :param description: The description of this UpdateSensitiveTypesExportDetails. :type: str """ self._description = description - @property - def compartment_id(self): - """ - **[Required]** Gets the compartment_id of this CreateAuditPolicyDetails. - The OCID of the compartment where you want to create the audit policy. - - - :return: The compartment_id of this CreateAuditPolicyDetails. - :rtype: str - """ - return self._compartment_id - - @compartment_id.setter - def compartment_id(self, compartment_id): - """ - Sets the compartment_id of this CreateAuditPolicyDetails. - The OCID of the compartment where you want to create the audit policy. - - - :param compartment_id: The compartment_id of this CreateAuditPolicyDetails. - :type: str - """ - self._compartment_id = compartment_id - - @property - def target_id(self): - """ - **[Required]** Gets the target_id of this CreateAuditPolicyDetails. - The OCID of the target for which the audit policy has to be created. - - - :return: The target_id of this CreateAuditPolicyDetails. - :rtype: str - """ - return self._target_id - - @target_id.setter - def target_id(self, target_id): - """ - Sets the target_id of this CreateAuditPolicyDetails. - The OCID of the target for which the audit policy has to be created. - - - :param target_id: The target_id of this CreateAuditPolicyDetails. - :type: str - """ - self._target_id = target_id - @property def freeform_tags(self): """ - Gets the freeform_tags of this CreateAuditPolicyDetails. + Gets the freeform_tags of this UpdateSensitiveTypesExportDetails. Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see `Resource Tags`__ Example: `{\"Department\": \"Finance\"}` @@ -177,7 +115,7 @@ def freeform_tags(self): __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm - :return: The freeform_tags of this CreateAuditPolicyDetails. + :return: The freeform_tags of this UpdateSensitiveTypesExportDetails. :rtype: dict(str, str) """ return self._freeform_tags @@ -185,7 +123,7 @@ def freeform_tags(self): @freeform_tags.setter def freeform_tags(self, freeform_tags): """ - Sets the freeform_tags of this CreateAuditPolicyDetails. + Sets the freeform_tags of this UpdateSensitiveTypesExportDetails. Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see `Resource Tags`__ Example: `{\"Department\": \"Finance\"}` @@ -193,7 +131,7 @@ def freeform_tags(self, freeform_tags): __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm - :param freeform_tags: The freeform_tags of this CreateAuditPolicyDetails. + :param freeform_tags: The freeform_tags of this UpdateSensitiveTypesExportDetails. :type: dict(str, str) """ self._freeform_tags = freeform_tags @@ -201,15 +139,14 @@ def freeform_tags(self, freeform_tags): @property def defined_tags(self): """ - Gets the defined_tags of this CreateAuditPolicyDetails. + Gets the defined_tags of this UpdateSensitiveTypesExportDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm - :return: The defined_tags of this CreateAuditPolicyDetails. + :return: The defined_tags of this UpdateSensitiveTypesExportDetails. :rtype: dict(str, dict(str, object)) """ return self._defined_tags @@ -217,15 +154,14 @@ def defined_tags(self): @defined_tags.setter def defined_tags(self, defined_tags): """ - Sets the defined_tags of this CreateAuditPolicyDetails. + Sets the defined_tags of this UpdateSensitiveTypesExportDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm - :param defined_tags: The defined_tags of this CreateAuditPolicyDetails. + :param defined_tags: The defined_tags of this UpdateSensitiveTypesExportDetails. :type: dict(str, dict(str, object)) """ self._defined_tags = defined_tags diff --git a/src/oci/data_safe/models/update_sql_collection_details.py b/src/oci/data_safe/models/update_sql_collection_details.py index 48fbc48c5d..7d97ca97a2 100644 --- a/src/oci/data_safe/models/update_sql_collection_details.py +++ b/src/oci/data_safe/models/update_sql_collection_details.py @@ -141,7 +141,6 @@ def defined_tags(self): """ Gets the defined_tags of this UpdateSqlCollectionDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -157,7 +156,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this UpdateSqlCollectionDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/update_sql_firewall_policy_details.py b/src/oci/data_safe/models/update_sql_firewall_policy_details.py index 1ccef6e5f5..21f8b350aa 100644 --- a/src/oci/data_safe/models/update_sql_firewall_policy_details.py +++ b/src/oci/data_safe/models/update_sql_firewall_policy_details.py @@ -426,7 +426,6 @@ def defined_tags(self): """ Gets the defined_tags of this UpdateSqlFirewallPolicyDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -442,7 +441,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this UpdateSqlFirewallPolicyDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/update_target_alert_policy_association_details.py b/src/oci/data_safe/models/update_target_alert_policy_association_details.py index 0efcfbf700..a9ef8ca054 100644 --- a/src/oci/data_safe/models/update_target_alert_policy_association_details.py +++ b/src/oci/data_safe/models/update_target_alert_policy_association_details.py @@ -172,7 +172,6 @@ def defined_tags(self): """ Gets the defined_tags of this UpdateTargetAlertPolicyAssociationDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -188,7 +187,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this UpdateTargetAlertPolicyAssociationDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/update_target_database_details.py b/src/oci/data_safe/models/update_target_database_details.py index 578ff78a59..3839fe45d5 100644 --- a/src/oci/data_safe/models/update_target_database_details.py +++ b/src/oci/data_safe/models/update_target_database_details.py @@ -249,7 +249,6 @@ def defined_tags(self): """ Gets the defined_tags of this UpdateTargetDatabaseDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -265,7 +264,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this UpdateTargetDatabaseDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/update_user_assessment_details.py b/src/oci/data_safe/models/update_user_assessment_details.py index 8f639ba9e6..df5153ca0e 100644 --- a/src/oci/data_safe/models/update_user_assessment_details.py +++ b/src/oci/data_safe/models/update_user_assessment_details.py @@ -229,7 +229,6 @@ def defined_tags(self): """ Gets the defined_tags of this UpdateUserAssessmentDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -245,7 +244,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this UpdateUserAssessmentDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/user_aggregation.py b/src/oci/data_safe/models/user_aggregation.py index bf86bafa79..54469357e2 100644 --- a/src/oci/data_safe/models/user_aggregation.py +++ b/src/oci/data_safe/models/user_aggregation.py @@ -40,7 +40,8 @@ def __init__(self, **kwargs): def items(self): """ **[Required]** Gets the items of this UserAggregation. - The array of user aggregation data. + List containing maps as values. + Example: `{\"Operations\": [ {\"CostCenter\": \"42\"} ] }` :return: The items of this UserAggregation. @@ -52,7 +53,8 @@ def items(self): def items(self, items): """ Sets the items of this UserAggregation. - The array of user aggregation data. + List containing maps as values. + Example: `{\"Operations\": [ {\"CostCenter\": \"42\"} ] }` :param items: The items of this UserAggregation. diff --git a/src/oci/data_safe/models/user_assessment.py b/src/oci/data_safe/models/user_assessment.py index 3ad0f6b307..c70da83ed3 100644 --- a/src/oci/data_safe/models/user_assessment.py +++ b/src/oci/data_safe/models/user_assessment.py @@ -867,7 +867,6 @@ def defined_tags(self): """ Gets the defined_tags of this UserAssessment. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -883,7 +882,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this UserAssessment. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/user_assessment_summary.py b/src/oci/data_safe/models/user_assessment_summary.py index 7331c954af..9c3ca296d9 100644 --- a/src/oci/data_safe/models/user_assessment_summary.py +++ b/src/oci/data_safe/models/user_assessment_summary.py @@ -858,7 +858,6 @@ def defined_tags(self): """ Gets the defined_tags of this UserAssessmentSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm @@ -874,7 +873,6 @@ def defined_tags(self, defined_tags): """ Sets the defined_tags of this UserAssessmentSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__ - Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm diff --git a/src/oci/data_safe/models/user_summary.py b/src/oci/data_safe/models/user_summary.py index beefb0aa0e..15101a5f66 100644 --- a/src/oci/data_safe/models/user_summary.py +++ b/src/oci/data_safe/models/user_summary.py @@ -13,7 +13,8 @@ class UserSummary(object): """ The summary of information about the database user. It includes details such as user type, account status, - last login time, user creation time, authentication type, user profile, and time and date of the last password change. + last login time, user creation time, authentication type, user profile, and time and date of the last password change and + the date and time of the expiration of the password. It also contains the user category derived from these user details, as well as granted privileges. """ @@ -148,6 +149,10 @@ def __init__(self, **kwargs): The value to assign to the time_password_changed property of this UserSummary. :type time_password_changed: datetime + :param time_password_expiry: + The value to assign to the time_password_expiry property of this UserSummary. + :type time_password_expiry: datetime + :param user_types: The value to assign to the user_types property of this UserSummary. Allowed values for items in this list are: "ADMIN_PRIVILEGED", "APPLICATION", "PRIVILEGED", "SCHEMA", "NON_PRIVILEGED", 'UNKNOWN_ENUM_VALUE'. @@ -180,6 +185,7 @@ def __init__(self, **kwargs): 'authentication_type': 'str', 'user_profile': 'str', 'time_password_changed': 'datetime', + 'time_password_expiry': 'datetime', 'user_types': 'list[str]', 'admin_roles': 'list[str]', 'are_all_schemas_accessible': 'bool', @@ -197,6 +203,7 @@ def __init__(self, **kwargs): 'authentication_type': 'authenticationType', 'user_profile': 'userProfile', 'time_password_changed': 'timePasswordChanged', + 'time_password_expiry': 'timePasswordExpiry', 'user_types': 'userTypes', 'admin_roles': 'adminRoles', 'are_all_schemas_accessible': 'areAllSchemasAccessible', @@ -213,6 +220,7 @@ def __init__(self, **kwargs): self._authentication_type = None self._user_profile = None self._time_password_changed = None + self._time_password_expiry = None self._user_types = None self._admin_roles = None self._are_all_schemas_accessible = None @@ -488,6 +496,34 @@ def time_password_changed(self, time_password_changed): """ self._time_password_changed = time_password_changed + @property + def time_password_expiry(self): + """ + Gets the time_password_expiry of this UserSummary. + The date and time the user's password will expire, in the format defined by `RFC3339`__. + + __ https://tools.ietf.org/html/rfc3339 + + + :return: The time_password_expiry of this UserSummary. + :rtype: datetime + """ + return self._time_password_expiry + + @time_password_expiry.setter + def time_password_expiry(self, time_password_expiry): + """ + Sets the time_password_expiry of this UserSummary. + The date and time the user's password will expire, in the format defined by `RFC3339`__. + + __ https://tools.ietf.org/html/rfc3339 + + + :param time_password_expiry: The time_password_expiry of this UserSummary. + :type: datetime + """ + self._time_password_expiry = time_password_expiry + @property def user_types(self): """ diff --git a/src/oci/data_safe/models/work_request.py b/src/oci/data_safe/models/work_request.py index 27ffa857d1..98fc794524 100644 --- a/src/oci/data_safe/models/work_request.py +++ b/src/oci/data_safe/models/work_request.py @@ -531,6 +531,18 @@ class WorkRequest(object): #: This constant has a value of "MASK_POLICY_DELETE_HEALTH_REPORT" OPERATION_TYPE_MASK_POLICY_DELETE_HEALTH_REPORT = "MASK_POLICY_DELETE_HEALTH_REPORT" + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "CREATE_SENSITIVE_TYPES_EXPORT" + OPERATION_TYPE_CREATE_SENSITIVE_TYPES_EXPORT = "CREATE_SENSITIVE_TYPES_EXPORT" + + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "UPDATE_SENSITIVE_TYPES_EXPORT" + OPERATION_TYPE_UPDATE_SENSITIVE_TYPES_EXPORT = "UPDATE_SENSITIVE_TYPES_EXPORT" + + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "BULK_CREATE_SENSITIVE_TYPES" + OPERATION_TYPE_BULK_CREATE_SENSITIVE_TYPES = "BULK_CREATE_SENSITIVE_TYPES" + #: A constant which can be used with the operation_type property of a WorkRequest. #: This constant has a value of "ABORT_MASKING" OPERATION_TYPE_ABORT_MASKING = "ABORT_MASKING" @@ -630,7 +642,7 @@ def __init__(self, **kwargs): :param operation_type: The value to assign to the operation_type property of this WorkRequest. - Allowed values for this property are: "ENABLE_DATA_SAFE_CONFIGURATION", "CREATE_PRIVATE_ENDPOINT", "UPDATE_PRIVATE_ENDPOINT", "DELETE_PRIVATE_ENDPOINT", "CHANGE_PRIVATE_ENDPOINT_COMPARTMENT", "CREATE_ONPREM_CONNECTOR", "UPDATE_ONPREM_CONNECTOR", "DELETE_ONPREM_CONNECTOR", "UPDATE_ONPREM_CONNECTOR_WALLET", "CHANGE_ONPREM_CONNECTOR_COMPARTMENT", "CREATE_TARGET_DATABASE", "UPDATE_TARGET_DATABASE", "ACTIVATE_TARGET_DATABASE", "DEACTIVATE_TARGET_DATABASE", "DELETE_TARGET_DATABASE", "CHANGE_TARGET_DATABASE_COMPARTMENT", "CREATE_PEER_TARGET_DATABASE", "UPDATE_PEER_TARGET_DATABASE", "DELETE_PEER_TARGET_DATABASE", "REFRESH_TARGET_DATABASE", "PROVISION_POLICY", "RETRIEVE_POLICY", "UPDATE_POLICY", "CHANGE_POLICY_COMPARTMENT", "CREATE_USER_ASSESSMENT", "ASSESS_USER_ASSESSMENT", "CREATE_SNAPSHOT_USER_ASSESSMENT", "CREATE_SCHEDULE_USER_ASSESSMENT", "COMPARE_WITH_BASELINE_USER_ASSESSMENT", "DELETE_USER_ASSESSMENT", "UPDATE_USER_ASSESSMENT", "CHANGE_USER_ASSESSMENT_COMPARTMENT", "SET_USER_ASSESSMENT_BASELINE", "UNSET_USER_ASSESSMENT_BASELINE", "GENERATE_USER_ASSESSMENT_REPORT", "CREATE_SECURITY_ASSESSMENT", "CREATE_SECURITY_ASSESSMENT_NOW", "ASSESS_SECURITY_ASSESSMENT", "CREATE_SNAPSHOT_SECURITY_ASSESSMENT", "CREATE_SCHEDULE_SECURITY_ASSESSMENT", "COMPARE_WITH_BASELINE_SECURITY_ASSESSMENT", "DELETE_SECURITY_ASSESSMENT", "UPDATE_SECURITY_ASSESSMENT", "UPDATE_FINDING_RISK", "CHANGE_SECURITY_ASSESSMENT_COMPARTMENT", "SET_SECURITY_ASSESSMENT_BASELINE", "UNSET_SECURITY_ASSESSMENT_BASELINE", "GENERATE_SECURITY_ASSESSMENT_REPORT", "DELETE_SQL_FIREWALL_ALLOWED_SQL", "BULK_CREATE_SQL_FIREWALL_ALLOWED_SQL", "BULK_DELETE_SQL_FIREWALL_ALLOWED_SQL", "CREATE_AUDIT_PROFILE", "CALCULATE_VOLUME", "CALCULATE_COLLECTED_VOLUME", "CREATE_DB_SECURITY_CONFIG", "REFRESH_DB_SECURITY_CONFIG", "UPDATE_DB_SECURITY_CONFIG", "CHANGE_DB_SECURITY_CONFIG_COMPARTMENT", "GENERATE_FIREWALL_POLICY", "UPDATE_FIREWALL_POLICY", "CHANGE_FIREWALL_POLICY_COMPARTMENT", "DELETE_FIREWALL_POLICY", "CREATE_SQL_COLLECTION", "UPDATE_SQL_COLLECTION", "START_SQL_COLLECTION", "STOP_SQL_COLLECTION", "DELETE_SQL_COLLECTION", "CHANGE_SQL_COLLECTION_COMPARTMENT", "REFRESH_SQL_COLLECTION_LOG_INSIGHTS", "PURGE_SQL_COLLECTION_LOGS", "REFRESH_VIOLATIONS", "CREATE_ARCHIVAL", "UPDATE_SECURITY_POLICY", "CHANGE_SECURITY_POLICY_COMPARTMENT", "UPDATE_SECURITY_POLICY_DEPLOYMENT", "CHANGE_SECURITY_POLICY_DEPLOYMENT_COMPARTMENT", "AUDIT_TRAIL", "DELETE_AUDIT_TRAIL", "DISCOVER_AUDIT_TRAILS", "UPDATE_AUDIT_TRAIL", "UPDATE_AUDIT_PROFILE", "AUDIT_CHANGE_COMPARTMENT", "CREATE_REPORT_DEFINITION", "UPDATE_REPORT_DEFINITION", "CHANGE_REPORT_DEFINITION_COMPARTMENT", "DELETE_REPORT_DEFINITION", "GENERATE_REPORT", "CHANGE_REPORT_COMPARTMENT", "DELETE_ARCHIVE_RETRIEVAL", "CREATE_ARCHIVE_RETRIEVAL", "UPDATE_ARCHIVE_RETRIEVAL", "CHANGE_ARCHIVE_RETRIEVAL_COMPARTMENT", "UPDATE_ALERT", "TARGET_ALERT_POLICY_ASSOCIATION", "CREATE_SENSITIVE_DATA_MODEL", "UPDATE_SENSITIVE_DATA_MODEL", "DELETE_SENSITIVE_DATA_MODEL", "UPLOAD_SENSITIVE_DATA_MODEL", "GENERATE_SENSITIVE_DATA_MODEL_FOR_DOWNLOAD", "CREATE_SENSITIVE_COLUMN", "UPDATE_SENSITIVE_COLUMN", "PATCH_SENSITIVE_COLUMNS", "CREATE_DISCOVERY_JOB", "DELETE_DISCOVERY_JOB", "PATCH_DISCOVERY_JOB_RESULT", "APPLY_DISCOVERY_JOB_RESULT", "GENERATE_DISCOVERY_REPORT", "CREATE_SENSITIVE_TYPE", "UPDATE_SENSITIVE_TYPE", "CREATE_MASKING_POLICY", "UPDATE_MASKING_POLICY", "DELETE_MASKING_POLICY", "UPLOAD_MASKING_POLICY", "GENERATE_MASKING_POLICY_FOR_DOWNLOAD", "CREATE_MASKING_COLUMN", "UPDATE_MASKING_COLUMN", "PATCH_MASKING_COLUMNS", "GENERATE_MASKING_REPORT", "CREATE_LIBRARY_MASKING_FORMAT", "UPDATE_LIBRARY_MASKING_FORMAT", "ADD_COLUMNS_FROM_SDM", "MASKING_JOB", "CREATE_DIFFERENCE", "DELETE_DIFFERENCE", "UPDATE_DIFFERENCE", "PATCH_DIFFERENCE", "APPLY_DIFFERENCE", "MASK_POLICY_GENERATE_HEALTH_REPORT", "MASK_POLICY_DELETE_HEALTH_REPORT", "ABORT_MASKING", "CREATE_SECURITY_POLICY_REPORT", "REFRESH_SECURITY_POLICY_CACHE", "DELETE_SECURITY_POLICY_CACHE", "CREATE_SCHEDULE", "REMOVE_SCHEDULE_REPORT", "UPDATE_ALL_ALERT", "PATCH_TARGET_ALERT_POLICY_ASSOCIATION", "CREATE_ALERT_POLICY", "UPDATE_ALERT_POLICY", "DELETE_ALERT_POLICY", "CREATE_ALERT_POLICY_RULE", "UPDATE_ALERT_POLICY_RULE", "DELETE_ALERT_POLICY_RULE", "CHANGE_ALERT_POLICY_COMPARTMENT", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "ENABLE_DATA_SAFE_CONFIGURATION", "CREATE_PRIVATE_ENDPOINT", "UPDATE_PRIVATE_ENDPOINT", "DELETE_PRIVATE_ENDPOINT", "CHANGE_PRIVATE_ENDPOINT_COMPARTMENT", "CREATE_ONPREM_CONNECTOR", "UPDATE_ONPREM_CONNECTOR", "DELETE_ONPREM_CONNECTOR", "UPDATE_ONPREM_CONNECTOR_WALLET", "CHANGE_ONPREM_CONNECTOR_COMPARTMENT", "CREATE_TARGET_DATABASE", "UPDATE_TARGET_DATABASE", "ACTIVATE_TARGET_DATABASE", "DEACTIVATE_TARGET_DATABASE", "DELETE_TARGET_DATABASE", "CHANGE_TARGET_DATABASE_COMPARTMENT", "CREATE_PEER_TARGET_DATABASE", "UPDATE_PEER_TARGET_DATABASE", "DELETE_PEER_TARGET_DATABASE", "REFRESH_TARGET_DATABASE", "PROVISION_POLICY", "RETRIEVE_POLICY", "UPDATE_POLICY", "CHANGE_POLICY_COMPARTMENT", "CREATE_USER_ASSESSMENT", "ASSESS_USER_ASSESSMENT", "CREATE_SNAPSHOT_USER_ASSESSMENT", "CREATE_SCHEDULE_USER_ASSESSMENT", "COMPARE_WITH_BASELINE_USER_ASSESSMENT", "DELETE_USER_ASSESSMENT", "UPDATE_USER_ASSESSMENT", "CHANGE_USER_ASSESSMENT_COMPARTMENT", "SET_USER_ASSESSMENT_BASELINE", "UNSET_USER_ASSESSMENT_BASELINE", "GENERATE_USER_ASSESSMENT_REPORT", "CREATE_SECURITY_ASSESSMENT", "CREATE_SECURITY_ASSESSMENT_NOW", "ASSESS_SECURITY_ASSESSMENT", "CREATE_SNAPSHOT_SECURITY_ASSESSMENT", "CREATE_SCHEDULE_SECURITY_ASSESSMENT", "COMPARE_WITH_BASELINE_SECURITY_ASSESSMENT", "DELETE_SECURITY_ASSESSMENT", "UPDATE_SECURITY_ASSESSMENT", "UPDATE_FINDING_RISK", "CHANGE_SECURITY_ASSESSMENT_COMPARTMENT", "SET_SECURITY_ASSESSMENT_BASELINE", "UNSET_SECURITY_ASSESSMENT_BASELINE", "GENERATE_SECURITY_ASSESSMENT_REPORT", "DELETE_SQL_FIREWALL_ALLOWED_SQL", "BULK_CREATE_SQL_FIREWALL_ALLOWED_SQL", "BULK_DELETE_SQL_FIREWALL_ALLOWED_SQL", "CREATE_AUDIT_PROFILE", "CALCULATE_VOLUME", "CALCULATE_COLLECTED_VOLUME", "CREATE_DB_SECURITY_CONFIG", "REFRESH_DB_SECURITY_CONFIG", "UPDATE_DB_SECURITY_CONFIG", "CHANGE_DB_SECURITY_CONFIG_COMPARTMENT", "GENERATE_FIREWALL_POLICY", "UPDATE_FIREWALL_POLICY", "CHANGE_FIREWALL_POLICY_COMPARTMENT", "DELETE_FIREWALL_POLICY", "CREATE_SQL_COLLECTION", "UPDATE_SQL_COLLECTION", "START_SQL_COLLECTION", "STOP_SQL_COLLECTION", "DELETE_SQL_COLLECTION", "CHANGE_SQL_COLLECTION_COMPARTMENT", "REFRESH_SQL_COLLECTION_LOG_INSIGHTS", "PURGE_SQL_COLLECTION_LOGS", "REFRESH_VIOLATIONS", "CREATE_ARCHIVAL", "UPDATE_SECURITY_POLICY", "CHANGE_SECURITY_POLICY_COMPARTMENT", "UPDATE_SECURITY_POLICY_DEPLOYMENT", "CHANGE_SECURITY_POLICY_DEPLOYMENT_COMPARTMENT", "AUDIT_TRAIL", "DELETE_AUDIT_TRAIL", "DISCOVER_AUDIT_TRAILS", "UPDATE_AUDIT_TRAIL", "UPDATE_AUDIT_PROFILE", "AUDIT_CHANGE_COMPARTMENT", "CREATE_REPORT_DEFINITION", "UPDATE_REPORT_DEFINITION", "CHANGE_REPORT_DEFINITION_COMPARTMENT", "DELETE_REPORT_DEFINITION", "GENERATE_REPORT", "CHANGE_REPORT_COMPARTMENT", "DELETE_ARCHIVE_RETRIEVAL", "CREATE_ARCHIVE_RETRIEVAL", "UPDATE_ARCHIVE_RETRIEVAL", "CHANGE_ARCHIVE_RETRIEVAL_COMPARTMENT", "UPDATE_ALERT", "TARGET_ALERT_POLICY_ASSOCIATION", "CREATE_SENSITIVE_DATA_MODEL", "UPDATE_SENSITIVE_DATA_MODEL", "DELETE_SENSITIVE_DATA_MODEL", "UPLOAD_SENSITIVE_DATA_MODEL", "GENERATE_SENSITIVE_DATA_MODEL_FOR_DOWNLOAD", "CREATE_SENSITIVE_COLUMN", "UPDATE_SENSITIVE_COLUMN", "PATCH_SENSITIVE_COLUMNS", "CREATE_DISCOVERY_JOB", "DELETE_DISCOVERY_JOB", "PATCH_DISCOVERY_JOB_RESULT", "APPLY_DISCOVERY_JOB_RESULT", "GENERATE_DISCOVERY_REPORT", "CREATE_SENSITIVE_TYPE", "UPDATE_SENSITIVE_TYPE", "CREATE_MASKING_POLICY", "UPDATE_MASKING_POLICY", "DELETE_MASKING_POLICY", "UPLOAD_MASKING_POLICY", "GENERATE_MASKING_POLICY_FOR_DOWNLOAD", "CREATE_MASKING_COLUMN", "UPDATE_MASKING_COLUMN", "PATCH_MASKING_COLUMNS", "GENERATE_MASKING_REPORT", "CREATE_LIBRARY_MASKING_FORMAT", "UPDATE_LIBRARY_MASKING_FORMAT", "ADD_COLUMNS_FROM_SDM", "MASKING_JOB", "CREATE_DIFFERENCE", "DELETE_DIFFERENCE", "UPDATE_DIFFERENCE", "PATCH_DIFFERENCE", "APPLY_DIFFERENCE", "MASK_POLICY_GENERATE_HEALTH_REPORT", "MASK_POLICY_DELETE_HEALTH_REPORT", "CREATE_SENSITIVE_TYPES_EXPORT", "UPDATE_SENSITIVE_TYPES_EXPORT", "BULK_CREATE_SENSITIVE_TYPES", "ABORT_MASKING", "CREATE_SECURITY_POLICY_REPORT", "REFRESH_SECURITY_POLICY_CACHE", "DELETE_SECURITY_POLICY_CACHE", "CREATE_SCHEDULE", "REMOVE_SCHEDULE_REPORT", "UPDATE_ALL_ALERT", "PATCH_TARGET_ALERT_POLICY_ASSOCIATION", "CREATE_ALERT_POLICY", "UPDATE_ALERT_POLICY", "DELETE_ALERT_POLICY", "CREATE_ALERT_POLICY_RULE", "UPDATE_ALERT_POLICY_RULE", "DELETE_ALERT_POLICY_RULE", "CHANGE_ALERT_POLICY_COMPARTMENT", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type operation_type: str @@ -709,7 +721,7 @@ def operation_type(self): **[Required]** Gets the operation_type of this WorkRequest. The resources that are affected by the work request. - Allowed values for this property are: "ENABLE_DATA_SAFE_CONFIGURATION", "CREATE_PRIVATE_ENDPOINT", "UPDATE_PRIVATE_ENDPOINT", "DELETE_PRIVATE_ENDPOINT", "CHANGE_PRIVATE_ENDPOINT_COMPARTMENT", "CREATE_ONPREM_CONNECTOR", "UPDATE_ONPREM_CONNECTOR", "DELETE_ONPREM_CONNECTOR", "UPDATE_ONPREM_CONNECTOR_WALLET", "CHANGE_ONPREM_CONNECTOR_COMPARTMENT", "CREATE_TARGET_DATABASE", "UPDATE_TARGET_DATABASE", "ACTIVATE_TARGET_DATABASE", "DEACTIVATE_TARGET_DATABASE", "DELETE_TARGET_DATABASE", "CHANGE_TARGET_DATABASE_COMPARTMENT", "CREATE_PEER_TARGET_DATABASE", "UPDATE_PEER_TARGET_DATABASE", "DELETE_PEER_TARGET_DATABASE", "REFRESH_TARGET_DATABASE", "PROVISION_POLICY", "RETRIEVE_POLICY", "UPDATE_POLICY", "CHANGE_POLICY_COMPARTMENT", "CREATE_USER_ASSESSMENT", "ASSESS_USER_ASSESSMENT", "CREATE_SNAPSHOT_USER_ASSESSMENT", "CREATE_SCHEDULE_USER_ASSESSMENT", "COMPARE_WITH_BASELINE_USER_ASSESSMENT", "DELETE_USER_ASSESSMENT", "UPDATE_USER_ASSESSMENT", "CHANGE_USER_ASSESSMENT_COMPARTMENT", "SET_USER_ASSESSMENT_BASELINE", "UNSET_USER_ASSESSMENT_BASELINE", "GENERATE_USER_ASSESSMENT_REPORT", "CREATE_SECURITY_ASSESSMENT", "CREATE_SECURITY_ASSESSMENT_NOW", "ASSESS_SECURITY_ASSESSMENT", "CREATE_SNAPSHOT_SECURITY_ASSESSMENT", "CREATE_SCHEDULE_SECURITY_ASSESSMENT", "COMPARE_WITH_BASELINE_SECURITY_ASSESSMENT", "DELETE_SECURITY_ASSESSMENT", "UPDATE_SECURITY_ASSESSMENT", "UPDATE_FINDING_RISK", "CHANGE_SECURITY_ASSESSMENT_COMPARTMENT", "SET_SECURITY_ASSESSMENT_BASELINE", "UNSET_SECURITY_ASSESSMENT_BASELINE", "GENERATE_SECURITY_ASSESSMENT_REPORT", "DELETE_SQL_FIREWALL_ALLOWED_SQL", "BULK_CREATE_SQL_FIREWALL_ALLOWED_SQL", "BULK_DELETE_SQL_FIREWALL_ALLOWED_SQL", "CREATE_AUDIT_PROFILE", "CALCULATE_VOLUME", "CALCULATE_COLLECTED_VOLUME", "CREATE_DB_SECURITY_CONFIG", "REFRESH_DB_SECURITY_CONFIG", "UPDATE_DB_SECURITY_CONFIG", "CHANGE_DB_SECURITY_CONFIG_COMPARTMENT", "GENERATE_FIREWALL_POLICY", "UPDATE_FIREWALL_POLICY", "CHANGE_FIREWALL_POLICY_COMPARTMENT", "DELETE_FIREWALL_POLICY", "CREATE_SQL_COLLECTION", "UPDATE_SQL_COLLECTION", "START_SQL_COLLECTION", "STOP_SQL_COLLECTION", "DELETE_SQL_COLLECTION", "CHANGE_SQL_COLLECTION_COMPARTMENT", "REFRESH_SQL_COLLECTION_LOG_INSIGHTS", "PURGE_SQL_COLLECTION_LOGS", "REFRESH_VIOLATIONS", "CREATE_ARCHIVAL", "UPDATE_SECURITY_POLICY", "CHANGE_SECURITY_POLICY_COMPARTMENT", "UPDATE_SECURITY_POLICY_DEPLOYMENT", "CHANGE_SECURITY_POLICY_DEPLOYMENT_COMPARTMENT", "AUDIT_TRAIL", "DELETE_AUDIT_TRAIL", "DISCOVER_AUDIT_TRAILS", "UPDATE_AUDIT_TRAIL", "UPDATE_AUDIT_PROFILE", "AUDIT_CHANGE_COMPARTMENT", "CREATE_REPORT_DEFINITION", "UPDATE_REPORT_DEFINITION", "CHANGE_REPORT_DEFINITION_COMPARTMENT", "DELETE_REPORT_DEFINITION", "GENERATE_REPORT", "CHANGE_REPORT_COMPARTMENT", "DELETE_ARCHIVE_RETRIEVAL", "CREATE_ARCHIVE_RETRIEVAL", "UPDATE_ARCHIVE_RETRIEVAL", "CHANGE_ARCHIVE_RETRIEVAL_COMPARTMENT", "UPDATE_ALERT", "TARGET_ALERT_POLICY_ASSOCIATION", "CREATE_SENSITIVE_DATA_MODEL", "UPDATE_SENSITIVE_DATA_MODEL", "DELETE_SENSITIVE_DATA_MODEL", "UPLOAD_SENSITIVE_DATA_MODEL", "GENERATE_SENSITIVE_DATA_MODEL_FOR_DOWNLOAD", "CREATE_SENSITIVE_COLUMN", "UPDATE_SENSITIVE_COLUMN", "PATCH_SENSITIVE_COLUMNS", "CREATE_DISCOVERY_JOB", "DELETE_DISCOVERY_JOB", "PATCH_DISCOVERY_JOB_RESULT", "APPLY_DISCOVERY_JOB_RESULT", "GENERATE_DISCOVERY_REPORT", "CREATE_SENSITIVE_TYPE", "UPDATE_SENSITIVE_TYPE", "CREATE_MASKING_POLICY", "UPDATE_MASKING_POLICY", "DELETE_MASKING_POLICY", "UPLOAD_MASKING_POLICY", "GENERATE_MASKING_POLICY_FOR_DOWNLOAD", "CREATE_MASKING_COLUMN", "UPDATE_MASKING_COLUMN", "PATCH_MASKING_COLUMNS", "GENERATE_MASKING_REPORT", "CREATE_LIBRARY_MASKING_FORMAT", "UPDATE_LIBRARY_MASKING_FORMAT", "ADD_COLUMNS_FROM_SDM", "MASKING_JOB", "CREATE_DIFFERENCE", "DELETE_DIFFERENCE", "UPDATE_DIFFERENCE", "PATCH_DIFFERENCE", "APPLY_DIFFERENCE", "MASK_POLICY_GENERATE_HEALTH_REPORT", "MASK_POLICY_DELETE_HEALTH_REPORT", "ABORT_MASKING", "CREATE_SECURITY_POLICY_REPORT", "REFRESH_SECURITY_POLICY_CACHE", "DELETE_SECURITY_POLICY_CACHE", "CREATE_SCHEDULE", "REMOVE_SCHEDULE_REPORT", "UPDATE_ALL_ALERT", "PATCH_TARGET_ALERT_POLICY_ASSOCIATION", "CREATE_ALERT_POLICY", "UPDATE_ALERT_POLICY", "DELETE_ALERT_POLICY", "CREATE_ALERT_POLICY_RULE", "UPDATE_ALERT_POLICY_RULE", "DELETE_ALERT_POLICY_RULE", "CHANGE_ALERT_POLICY_COMPARTMENT", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "ENABLE_DATA_SAFE_CONFIGURATION", "CREATE_PRIVATE_ENDPOINT", "UPDATE_PRIVATE_ENDPOINT", "DELETE_PRIVATE_ENDPOINT", "CHANGE_PRIVATE_ENDPOINT_COMPARTMENT", "CREATE_ONPREM_CONNECTOR", "UPDATE_ONPREM_CONNECTOR", "DELETE_ONPREM_CONNECTOR", "UPDATE_ONPREM_CONNECTOR_WALLET", "CHANGE_ONPREM_CONNECTOR_COMPARTMENT", "CREATE_TARGET_DATABASE", "UPDATE_TARGET_DATABASE", "ACTIVATE_TARGET_DATABASE", "DEACTIVATE_TARGET_DATABASE", "DELETE_TARGET_DATABASE", "CHANGE_TARGET_DATABASE_COMPARTMENT", "CREATE_PEER_TARGET_DATABASE", "UPDATE_PEER_TARGET_DATABASE", "DELETE_PEER_TARGET_DATABASE", "REFRESH_TARGET_DATABASE", "PROVISION_POLICY", "RETRIEVE_POLICY", "UPDATE_POLICY", "CHANGE_POLICY_COMPARTMENT", "CREATE_USER_ASSESSMENT", "ASSESS_USER_ASSESSMENT", "CREATE_SNAPSHOT_USER_ASSESSMENT", "CREATE_SCHEDULE_USER_ASSESSMENT", "COMPARE_WITH_BASELINE_USER_ASSESSMENT", "DELETE_USER_ASSESSMENT", "UPDATE_USER_ASSESSMENT", "CHANGE_USER_ASSESSMENT_COMPARTMENT", "SET_USER_ASSESSMENT_BASELINE", "UNSET_USER_ASSESSMENT_BASELINE", "GENERATE_USER_ASSESSMENT_REPORT", "CREATE_SECURITY_ASSESSMENT", "CREATE_SECURITY_ASSESSMENT_NOW", "ASSESS_SECURITY_ASSESSMENT", "CREATE_SNAPSHOT_SECURITY_ASSESSMENT", "CREATE_SCHEDULE_SECURITY_ASSESSMENT", "COMPARE_WITH_BASELINE_SECURITY_ASSESSMENT", "DELETE_SECURITY_ASSESSMENT", "UPDATE_SECURITY_ASSESSMENT", "UPDATE_FINDING_RISK", "CHANGE_SECURITY_ASSESSMENT_COMPARTMENT", "SET_SECURITY_ASSESSMENT_BASELINE", "UNSET_SECURITY_ASSESSMENT_BASELINE", "GENERATE_SECURITY_ASSESSMENT_REPORT", "DELETE_SQL_FIREWALL_ALLOWED_SQL", "BULK_CREATE_SQL_FIREWALL_ALLOWED_SQL", "BULK_DELETE_SQL_FIREWALL_ALLOWED_SQL", "CREATE_AUDIT_PROFILE", "CALCULATE_VOLUME", "CALCULATE_COLLECTED_VOLUME", "CREATE_DB_SECURITY_CONFIG", "REFRESH_DB_SECURITY_CONFIG", "UPDATE_DB_SECURITY_CONFIG", "CHANGE_DB_SECURITY_CONFIG_COMPARTMENT", "GENERATE_FIREWALL_POLICY", "UPDATE_FIREWALL_POLICY", "CHANGE_FIREWALL_POLICY_COMPARTMENT", "DELETE_FIREWALL_POLICY", "CREATE_SQL_COLLECTION", "UPDATE_SQL_COLLECTION", "START_SQL_COLLECTION", "STOP_SQL_COLLECTION", "DELETE_SQL_COLLECTION", "CHANGE_SQL_COLLECTION_COMPARTMENT", "REFRESH_SQL_COLLECTION_LOG_INSIGHTS", "PURGE_SQL_COLLECTION_LOGS", "REFRESH_VIOLATIONS", "CREATE_ARCHIVAL", "UPDATE_SECURITY_POLICY", "CHANGE_SECURITY_POLICY_COMPARTMENT", "UPDATE_SECURITY_POLICY_DEPLOYMENT", "CHANGE_SECURITY_POLICY_DEPLOYMENT_COMPARTMENT", "AUDIT_TRAIL", "DELETE_AUDIT_TRAIL", "DISCOVER_AUDIT_TRAILS", "UPDATE_AUDIT_TRAIL", "UPDATE_AUDIT_PROFILE", "AUDIT_CHANGE_COMPARTMENT", "CREATE_REPORT_DEFINITION", "UPDATE_REPORT_DEFINITION", "CHANGE_REPORT_DEFINITION_COMPARTMENT", "DELETE_REPORT_DEFINITION", "GENERATE_REPORT", "CHANGE_REPORT_COMPARTMENT", "DELETE_ARCHIVE_RETRIEVAL", "CREATE_ARCHIVE_RETRIEVAL", "UPDATE_ARCHIVE_RETRIEVAL", "CHANGE_ARCHIVE_RETRIEVAL_COMPARTMENT", "UPDATE_ALERT", "TARGET_ALERT_POLICY_ASSOCIATION", "CREATE_SENSITIVE_DATA_MODEL", "UPDATE_SENSITIVE_DATA_MODEL", "DELETE_SENSITIVE_DATA_MODEL", "UPLOAD_SENSITIVE_DATA_MODEL", "GENERATE_SENSITIVE_DATA_MODEL_FOR_DOWNLOAD", "CREATE_SENSITIVE_COLUMN", "UPDATE_SENSITIVE_COLUMN", "PATCH_SENSITIVE_COLUMNS", "CREATE_DISCOVERY_JOB", "DELETE_DISCOVERY_JOB", "PATCH_DISCOVERY_JOB_RESULT", "APPLY_DISCOVERY_JOB_RESULT", "GENERATE_DISCOVERY_REPORT", "CREATE_SENSITIVE_TYPE", "UPDATE_SENSITIVE_TYPE", "CREATE_MASKING_POLICY", "UPDATE_MASKING_POLICY", "DELETE_MASKING_POLICY", "UPLOAD_MASKING_POLICY", "GENERATE_MASKING_POLICY_FOR_DOWNLOAD", "CREATE_MASKING_COLUMN", "UPDATE_MASKING_COLUMN", "PATCH_MASKING_COLUMNS", "GENERATE_MASKING_REPORT", "CREATE_LIBRARY_MASKING_FORMAT", "UPDATE_LIBRARY_MASKING_FORMAT", "ADD_COLUMNS_FROM_SDM", "MASKING_JOB", "CREATE_DIFFERENCE", "DELETE_DIFFERENCE", "UPDATE_DIFFERENCE", "PATCH_DIFFERENCE", "APPLY_DIFFERENCE", "MASK_POLICY_GENERATE_HEALTH_REPORT", "MASK_POLICY_DELETE_HEALTH_REPORT", "CREATE_SENSITIVE_TYPES_EXPORT", "UPDATE_SENSITIVE_TYPES_EXPORT", "BULK_CREATE_SENSITIVE_TYPES", "ABORT_MASKING", "CREATE_SECURITY_POLICY_REPORT", "REFRESH_SECURITY_POLICY_CACHE", "DELETE_SECURITY_POLICY_CACHE", "CREATE_SCHEDULE", "REMOVE_SCHEDULE_REPORT", "UPDATE_ALL_ALERT", "PATCH_TARGET_ALERT_POLICY_ASSOCIATION", "CREATE_ALERT_POLICY", "UPDATE_ALERT_POLICY", "DELETE_ALERT_POLICY", "CREATE_ALERT_POLICY_RULE", "UPDATE_ALERT_POLICY_RULE", "DELETE_ALERT_POLICY_RULE", "CHANGE_ALERT_POLICY_COMPARTMENT", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -728,7 +740,7 @@ def operation_type(self, operation_type): :param operation_type: The operation_type of this WorkRequest. :type: str """ - allowed_values = ["ENABLE_DATA_SAFE_CONFIGURATION", "CREATE_PRIVATE_ENDPOINT", "UPDATE_PRIVATE_ENDPOINT", "DELETE_PRIVATE_ENDPOINT", "CHANGE_PRIVATE_ENDPOINT_COMPARTMENT", "CREATE_ONPREM_CONNECTOR", "UPDATE_ONPREM_CONNECTOR", "DELETE_ONPREM_CONNECTOR", "UPDATE_ONPREM_CONNECTOR_WALLET", "CHANGE_ONPREM_CONNECTOR_COMPARTMENT", "CREATE_TARGET_DATABASE", "UPDATE_TARGET_DATABASE", "ACTIVATE_TARGET_DATABASE", "DEACTIVATE_TARGET_DATABASE", "DELETE_TARGET_DATABASE", "CHANGE_TARGET_DATABASE_COMPARTMENT", "CREATE_PEER_TARGET_DATABASE", "UPDATE_PEER_TARGET_DATABASE", "DELETE_PEER_TARGET_DATABASE", "REFRESH_TARGET_DATABASE", "PROVISION_POLICY", "RETRIEVE_POLICY", "UPDATE_POLICY", "CHANGE_POLICY_COMPARTMENT", "CREATE_USER_ASSESSMENT", "ASSESS_USER_ASSESSMENT", "CREATE_SNAPSHOT_USER_ASSESSMENT", "CREATE_SCHEDULE_USER_ASSESSMENT", "COMPARE_WITH_BASELINE_USER_ASSESSMENT", "DELETE_USER_ASSESSMENT", "UPDATE_USER_ASSESSMENT", "CHANGE_USER_ASSESSMENT_COMPARTMENT", "SET_USER_ASSESSMENT_BASELINE", "UNSET_USER_ASSESSMENT_BASELINE", "GENERATE_USER_ASSESSMENT_REPORT", "CREATE_SECURITY_ASSESSMENT", "CREATE_SECURITY_ASSESSMENT_NOW", "ASSESS_SECURITY_ASSESSMENT", "CREATE_SNAPSHOT_SECURITY_ASSESSMENT", "CREATE_SCHEDULE_SECURITY_ASSESSMENT", "COMPARE_WITH_BASELINE_SECURITY_ASSESSMENT", "DELETE_SECURITY_ASSESSMENT", "UPDATE_SECURITY_ASSESSMENT", "UPDATE_FINDING_RISK", "CHANGE_SECURITY_ASSESSMENT_COMPARTMENT", "SET_SECURITY_ASSESSMENT_BASELINE", "UNSET_SECURITY_ASSESSMENT_BASELINE", "GENERATE_SECURITY_ASSESSMENT_REPORT", "DELETE_SQL_FIREWALL_ALLOWED_SQL", "BULK_CREATE_SQL_FIREWALL_ALLOWED_SQL", "BULK_DELETE_SQL_FIREWALL_ALLOWED_SQL", "CREATE_AUDIT_PROFILE", "CALCULATE_VOLUME", "CALCULATE_COLLECTED_VOLUME", "CREATE_DB_SECURITY_CONFIG", "REFRESH_DB_SECURITY_CONFIG", "UPDATE_DB_SECURITY_CONFIG", "CHANGE_DB_SECURITY_CONFIG_COMPARTMENT", "GENERATE_FIREWALL_POLICY", "UPDATE_FIREWALL_POLICY", "CHANGE_FIREWALL_POLICY_COMPARTMENT", "DELETE_FIREWALL_POLICY", "CREATE_SQL_COLLECTION", "UPDATE_SQL_COLLECTION", "START_SQL_COLLECTION", "STOP_SQL_COLLECTION", "DELETE_SQL_COLLECTION", "CHANGE_SQL_COLLECTION_COMPARTMENT", "REFRESH_SQL_COLLECTION_LOG_INSIGHTS", "PURGE_SQL_COLLECTION_LOGS", "REFRESH_VIOLATIONS", "CREATE_ARCHIVAL", "UPDATE_SECURITY_POLICY", "CHANGE_SECURITY_POLICY_COMPARTMENT", "UPDATE_SECURITY_POLICY_DEPLOYMENT", "CHANGE_SECURITY_POLICY_DEPLOYMENT_COMPARTMENT", "AUDIT_TRAIL", "DELETE_AUDIT_TRAIL", "DISCOVER_AUDIT_TRAILS", "UPDATE_AUDIT_TRAIL", "UPDATE_AUDIT_PROFILE", "AUDIT_CHANGE_COMPARTMENT", "CREATE_REPORT_DEFINITION", "UPDATE_REPORT_DEFINITION", "CHANGE_REPORT_DEFINITION_COMPARTMENT", "DELETE_REPORT_DEFINITION", "GENERATE_REPORT", "CHANGE_REPORT_COMPARTMENT", "DELETE_ARCHIVE_RETRIEVAL", "CREATE_ARCHIVE_RETRIEVAL", "UPDATE_ARCHIVE_RETRIEVAL", "CHANGE_ARCHIVE_RETRIEVAL_COMPARTMENT", "UPDATE_ALERT", "TARGET_ALERT_POLICY_ASSOCIATION", "CREATE_SENSITIVE_DATA_MODEL", "UPDATE_SENSITIVE_DATA_MODEL", "DELETE_SENSITIVE_DATA_MODEL", "UPLOAD_SENSITIVE_DATA_MODEL", "GENERATE_SENSITIVE_DATA_MODEL_FOR_DOWNLOAD", "CREATE_SENSITIVE_COLUMN", "UPDATE_SENSITIVE_COLUMN", "PATCH_SENSITIVE_COLUMNS", "CREATE_DISCOVERY_JOB", "DELETE_DISCOVERY_JOB", "PATCH_DISCOVERY_JOB_RESULT", "APPLY_DISCOVERY_JOB_RESULT", "GENERATE_DISCOVERY_REPORT", "CREATE_SENSITIVE_TYPE", "UPDATE_SENSITIVE_TYPE", "CREATE_MASKING_POLICY", "UPDATE_MASKING_POLICY", "DELETE_MASKING_POLICY", "UPLOAD_MASKING_POLICY", "GENERATE_MASKING_POLICY_FOR_DOWNLOAD", "CREATE_MASKING_COLUMN", "UPDATE_MASKING_COLUMN", "PATCH_MASKING_COLUMNS", "GENERATE_MASKING_REPORT", "CREATE_LIBRARY_MASKING_FORMAT", "UPDATE_LIBRARY_MASKING_FORMAT", "ADD_COLUMNS_FROM_SDM", "MASKING_JOB", "CREATE_DIFFERENCE", "DELETE_DIFFERENCE", "UPDATE_DIFFERENCE", "PATCH_DIFFERENCE", "APPLY_DIFFERENCE", "MASK_POLICY_GENERATE_HEALTH_REPORT", "MASK_POLICY_DELETE_HEALTH_REPORT", "ABORT_MASKING", "CREATE_SECURITY_POLICY_REPORT", "REFRESH_SECURITY_POLICY_CACHE", "DELETE_SECURITY_POLICY_CACHE", "CREATE_SCHEDULE", "REMOVE_SCHEDULE_REPORT", "UPDATE_ALL_ALERT", "PATCH_TARGET_ALERT_POLICY_ASSOCIATION", "CREATE_ALERT_POLICY", "UPDATE_ALERT_POLICY", "DELETE_ALERT_POLICY", "CREATE_ALERT_POLICY_RULE", "UPDATE_ALERT_POLICY_RULE", "DELETE_ALERT_POLICY_RULE", "CHANGE_ALERT_POLICY_COMPARTMENT"] + allowed_values = ["ENABLE_DATA_SAFE_CONFIGURATION", "CREATE_PRIVATE_ENDPOINT", "UPDATE_PRIVATE_ENDPOINT", "DELETE_PRIVATE_ENDPOINT", "CHANGE_PRIVATE_ENDPOINT_COMPARTMENT", "CREATE_ONPREM_CONNECTOR", "UPDATE_ONPREM_CONNECTOR", "DELETE_ONPREM_CONNECTOR", "UPDATE_ONPREM_CONNECTOR_WALLET", "CHANGE_ONPREM_CONNECTOR_COMPARTMENT", "CREATE_TARGET_DATABASE", "UPDATE_TARGET_DATABASE", "ACTIVATE_TARGET_DATABASE", "DEACTIVATE_TARGET_DATABASE", "DELETE_TARGET_DATABASE", "CHANGE_TARGET_DATABASE_COMPARTMENT", "CREATE_PEER_TARGET_DATABASE", "UPDATE_PEER_TARGET_DATABASE", "DELETE_PEER_TARGET_DATABASE", "REFRESH_TARGET_DATABASE", "PROVISION_POLICY", "RETRIEVE_POLICY", "UPDATE_POLICY", "CHANGE_POLICY_COMPARTMENT", "CREATE_USER_ASSESSMENT", "ASSESS_USER_ASSESSMENT", "CREATE_SNAPSHOT_USER_ASSESSMENT", "CREATE_SCHEDULE_USER_ASSESSMENT", "COMPARE_WITH_BASELINE_USER_ASSESSMENT", "DELETE_USER_ASSESSMENT", "UPDATE_USER_ASSESSMENT", "CHANGE_USER_ASSESSMENT_COMPARTMENT", "SET_USER_ASSESSMENT_BASELINE", "UNSET_USER_ASSESSMENT_BASELINE", "GENERATE_USER_ASSESSMENT_REPORT", "CREATE_SECURITY_ASSESSMENT", "CREATE_SECURITY_ASSESSMENT_NOW", "ASSESS_SECURITY_ASSESSMENT", "CREATE_SNAPSHOT_SECURITY_ASSESSMENT", "CREATE_SCHEDULE_SECURITY_ASSESSMENT", "COMPARE_WITH_BASELINE_SECURITY_ASSESSMENT", "DELETE_SECURITY_ASSESSMENT", "UPDATE_SECURITY_ASSESSMENT", "UPDATE_FINDING_RISK", "CHANGE_SECURITY_ASSESSMENT_COMPARTMENT", "SET_SECURITY_ASSESSMENT_BASELINE", "UNSET_SECURITY_ASSESSMENT_BASELINE", "GENERATE_SECURITY_ASSESSMENT_REPORT", "DELETE_SQL_FIREWALL_ALLOWED_SQL", "BULK_CREATE_SQL_FIREWALL_ALLOWED_SQL", "BULK_DELETE_SQL_FIREWALL_ALLOWED_SQL", "CREATE_AUDIT_PROFILE", "CALCULATE_VOLUME", "CALCULATE_COLLECTED_VOLUME", "CREATE_DB_SECURITY_CONFIG", "REFRESH_DB_SECURITY_CONFIG", "UPDATE_DB_SECURITY_CONFIG", "CHANGE_DB_SECURITY_CONFIG_COMPARTMENT", "GENERATE_FIREWALL_POLICY", "UPDATE_FIREWALL_POLICY", "CHANGE_FIREWALL_POLICY_COMPARTMENT", "DELETE_FIREWALL_POLICY", "CREATE_SQL_COLLECTION", "UPDATE_SQL_COLLECTION", "START_SQL_COLLECTION", "STOP_SQL_COLLECTION", "DELETE_SQL_COLLECTION", "CHANGE_SQL_COLLECTION_COMPARTMENT", "REFRESH_SQL_COLLECTION_LOG_INSIGHTS", "PURGE_SQL_COLLECTION_LOGS", "REFRESH_VIOLATIONS", "CREATE_ARCHIVAL", "UPDATE_SECURITY_POLICY", "CHANGE_SECURITY_POLICY_COMPARTMENT", "UPDATE_SECURITY_POLICY_DEPLOYMENT", "CHANGE_SECURITY_POLICY_DEPLOYMENT_COMPARTMENT", "AUDIT_TRAIL", "DELETE_AUDIT_TRAIL", "DISCOVER_AUDIT_TRAILS", "UPDATE_AUDIT_TRAIL", "UPDATE_AUDIT_PROFILE", "AUDIT_CHANGE_COMPARTMENT", "CREATE_REPORT_DEFINITION", "UPDATE_REPORT_DEFINITION", "CHANGE_REPORT_DEFINITION_COMPARTMENT", "DELETE_REPORT_DEFINITION", "GENERATE_REPORT", "CHANGE_REPORT_COMPARTMENT", "DELETE_ARCHIVE_RETRIEVAL", "CREATE_ARCHIVE_RETRIEVAL", "UPDATE_ARCHIVE_RETRIEVAL", "CHANGE_ARCHIVE_RETRIEVAL_COMPARTMENT", "UPDATE_ALERT", "TARGET_ALERT_POLICY_ASSOCIATION", "CREATE_SENSITIVE_DATA_MODEL", "UPDATE_SENSITIVE_DATA_MODEL", "DELETE_SENSITIVE_DATA_MODEL", "UPLOAD_SENSITIVE_DATA_MODEL", "GENERATE_SENSITIVE_DATA_MODEL_FOR_DOWNLOAD", "CREATE_SENSITIVE_COLUMN", "UPDATE_SENSITIVE_COLUMN", "PATCH_SENSITIVE_COLUMNS", "CREATE_DISCOVERY_JOB", "DELETE_DISCOVERY_JOB", "PATCH_DISCOVERY_JOB_RESULT", "APPLY_DISCOVERY_JOB_RESULT", "GENERATE_DISCOVERY_REPORT", "CREATE_SENSITIVE_TYPE", "UPDATE_SENSITIVE_TYPE", "CREATE_MASKING_POLICY", "UPDATE_MASKING_POLICY", "DELETE_MASKING_POLICY", "UPLOAD_MASKING_POLICY", "GENERATE_MASKING_POLICY_FOR_DOWNLOAD", "CREATE_MASKING_COLUMN", "UPDATE_MASKING_COLUMN", "PATCH_MASKING_COLUMNS", "GENERATE_MASKING_REPORT", "CREATE_LIBRARY_MASKING_FORMAT", "UPDATE_LIBRARY_MASKING_FORMAT", "ADD_COLUMNS_FROM_SDM", "MASKING_JOB", "CREATE_DIFFERENCE", "DELETE_DIFFERENCE", "UPDATE_DIFFERENCE", "PATCH_DIFFERENCE", "APPLY_DIFFERENCE", "MASK_POLICY_GENERATE_HEALTH_REPORT", "MASK_POLICY_DELETE_HEALTH_REPORT", "CREATE_SENSITIVE_TYPES_EXPORT", "UPDATE_SENSITIVE_TYPES_EXPORT", "BULK_CREATE_SENSITIVE_TYPES", "ABORT_MASKING", "CREATE_SECURITY_POLICY_REPORT", "REFRESH_SECURITY_POLICY_CACHE", "DELETE_SECURITY_POLICY_CACHE", "CREATE_SCHEDULE", "REMOVE_SCHEDULE_REPORT", "UPDATE_ALL_ALERT", "PATCH_TARGET_ALERT_POLICY_ASSOCIATION", "CREATE_ALERT_POLICY", "UPDATE_ALERT_POLICY", "DELETE_ALERT_POLICY", "CREATE_ALERT_POLICY_RULE", "UPDATE_ALERT_POLICY_RULE", "DELETE_ALERT_POLICY_RULE", "CHANGE_ALERT_POLICY_COMPARTMENT"] if not value_allowed_none_or_none_sentinel(operation_type, allowed_values): operation_type = 'UNKNOWN_ENUM_VALUE' self._operation_type = operation_type diff --git a/src/oci/data_safe/models/work_request_summary.py b/src/oci/data_safe/models/work_request_summary.py index 08a0798877..7853065cc4 100644 --- a/src/oci/data_safe/models/work_request_summary.py +++ b/src/oci/data_safe/models/work_request_summary.py @@ -527,6 +527,18 @@ class WorkRequestSummary(object): #: This constant has a value of "MASK_POLICY_DELETE_HEALTH_REPORT" OPERATION_TYPE_MASK_POLICY_DELETE_HEALTH_REPORT = "MASK_POLICY_DELETE_HEALTH_REPORT" + #: A constant which can be used with the operation_type property of a WorkRequestSummary. + #: This constant has a value of "CREATE_SENSITIVE_TYPES_EXPORT" + OPERATION_TYPE_CREATE_SENSITIVE_TYPES_EXPORT = "CREATE_SENSITIVE_TYPES_EXPORT" + + #: A constant which can be used with the operation_type property of a WorkRequestSummary. + #: This constant has a value of "UPDATE_SENSITIVE_TYPES_EXPORT" + OPERATION_TYPE_UPDATE_SENSITIVE_TYPES_EXPORT = "UPDATE_SENSITIVE_TYPES_EXPORT" + + #: A constant which can be used with the operation_type property of a WorkRequestSummary. + #: This constant has a value of "BULK_CREATE_SENSITIVE_TYPES" + OPERATION_TYPE_BULK_CREATE_SENSITIVE_TYPES = "BULK_CREATE_SENSITIVE_TYPES" + #: A constant which can be used with the operation_type property of a WorkRequestSummary. #: This constant has a value of "ABORT_MASKING" OPERATION_TYPE_ABORT_MASKING = "ABORT_MASKING" @@ -626,7 +638,7 @@ def __init__(self, **kwargs): :param operation_type: The value to assign to the operation_type property of this WorkRequestSummary. - Allowed values for this property are: "ENABLE_DATA_SAFE_CONFIGURATION", "CREATE_PRIVATE_ENDPOINT", "UPDATE_PRIVATE_ENDPOINT", "DELETE_PRIVATE_ENDPOINT", "CHANGE_PRIVATE_ENDPOINT_COMPARTMENT", "CREATE_ONPREM_CONNECTOR", "UPDATE_ONPREM_CONNECTOR", "DELETE_ONPREM_CONNECTOR", "UPDATE_ONPREM_CONNECTOR_WALLET", "CHANGE_ONPREM_CONNECTOR_COMPARTMENT", "PROVISION_POLICY", "RETRIEVE_POLICY", "UPDATE_POLICY", "CHANGE_POLICY_COMPARTMENT", "CREATE_TARGET_DATABASE", "UPDATE_TARGET_DATABASE", "ACTIVATE_TARGET_DATABASE", "DEACTIVATE_TARGET_DATABASE", "DELETE_TARGET_DATABASE", "CHANGE_TARGET_DATABASE_COMPARTMENT", "CREATE_PEER_TARGET_DATABASE", "UPDATE_PEER_TARGET_DATABASE", "DELETE_PEER_TARGET_DATABASE", "REFRESH_TARGET_DATABASE", "CREATE_USER_ASSESSMENT", "ASSESS_USER_ASSESSMENT", "CREATE_SNAPSHOT_USER_ASSESSMENT", "CREATE_SCHEDULE_USER_ASSESSMENT", "COMPARE_WITH_BASELINE_USER_ASSESSMENT", "DELETE_USER_ASSESSMENT", "UPDATE_USER_ASSESSMENT", "CHANGE_USER_ASSESSMENT_COMPARTMENT", "SET_USER_ASSESSMENT_BASELINE", "UNSET_USER_ASSESSMENT_BASELINE", "GENERATE_USER_ASSESSMENT_REPORT", "CREATE_SECURITY_ASSESSMENT", "CREATE_SECURITY_ASSESSMENT_NOW", "ASSESS_SECURITY_ASSESSMENT", "CREATE_SNAPSHOT_SECURITY_ASSESSMENT", "CREATE_SCHEDULE_SECURITY_ASSESSMENT", "COMPARE_WITH_BASELINE_SECURITY_ASSESSMENT", "DELETE_SECURITY_ASSESSMENT", "UPDATE_SECURITY_ASSESSMENT", "UPDATE_FINDING_RISK", "CHANGE_SECURITY_ASSESSMENT_COMPARTMENT", "SET_SECURITY_ASSESSMENT_BASELINE", "UNSET_SECURITY_ASSESSMENT_BASELINE", "GENERATE_SECURITY_ASSESSMENT_REPORT", "DELETE_SQL_FIREWALL_ALLOWED_SQL", "BULK_CREATE_SQL_FIREWALL_ALLOWED_SQL", "BULK_DELETE_SQL_FIREWALL_ALLOWED_SQL", "CALCULATE_VOLUME", "CALCULATE_COLLECTED_VOLUME", "CREATE_DB_SECURITY_CONFIG", "REFRESH_DB_SECURITY_CONFIG", "UPDATE_DB_SECURITY_CONFIG", "CHANGE_DB_SECURITY_CONFIG_COMPARTMENT", "GENERATE_FIREWALL_POLICY", "UPDATE_FIREWALL_POLICY", "CHANGE_FIREWALL_POLICY_COMPARTMENT", "DELETE_FIREWALL_POLICY", "CREATE_SQL_COLLECTION", "UPDATE_SQL_COLLECTION", "START_SQL_COLLECTION", "STOP_SQL_COLLECTION", "DELETE_SQL_COLLECTION", "CHANGE_SQL_COLLECTION_COMPARTMENT", "REFRESH_SQL_COLLECTION_LOG_INSIGHTS", "PURGE_SQL_COLLECTION_LOGS", "REFRESH_VIOLATIONS", "CREATE_ARCHIVAL", "UPDATE_SECURITY_POLICY", "CHANGE_SECURITY_POLICY_COMPARTMENT", "UPDATE_SECURITY_POLICY_DEPLOYMENT", "CHANGE_SECURITY_POLICY_DEPLOYMENT_COMPARTMENT", "AUDIT_TRAIL", "DELETE_AUDIT_TRAIL", "DISCOVER_AUDIT_TRAILS", "UPDATE_AUDIT_TRAIL", "UPDATE_AUDIT_PROFILE", "AUDIT_CHANGE_COMPARTMENT", "CREATE_REPORT_DEFINITION", "UPDATE_REPORT_DEFINITION", "CHANGE_REPORT_DEFINITION_COMPARTMENT", "DELETE_REPORT_DEFINITION", "GENERATE_REPORT", "CHANGE_REPORT_COMPARTMENT", "DELETE_ARCHIVE_RETRIEVAL", "CREATE_ARCHIVE_RETRIEVAL", "UPDATE_ARCHIVE_RETRIEVAL", "CHANGE_ARCHIVE_RETRIEVAL_COMPARTMENT", "UPDATE_ALERT", "TARGET_ALERT_POLICY_ASSOCIATION", "CREATE_SENSITIVE_DATA_MODEL", "UPDATE_SENSITIVE_DATA_MODEL", "DELETE_SENSITIVE_DATA_MODEL", "UPLOAD_SENSITIVE_DATA_MODEL", "GENERATE_SENSITIVE_DATA_MODEL_FOR_DOWNLOAD", "CREATE_SENSITIVE_COLUMN", "UPDATE_SENSITIVE_COLUMN", "PATCH_SENSITIVE_COLUMNS", "CREATE_DISCOVERY_JOB", "DELETE_DISCOVERY_JOB", "PATCH_DISCOVERY_JOB_RESULT", "APPLY_DISCOVERY_JOB_RESULT", "GENERATE_DISCOVERY_REPORT", "CREATE_SENSITIVE_TYPE", "UPDATE_SENSITIVE_TYPE", "CREATE_MASKING_POLICY", "UPDATE_MASKING_POLICY", "DELETE_MASKING_POLICY", "UPLOAD_MASKING_POLICY", "GENERATE_MASKING_POLICY_FOR_DOWNLOAD", "CREATE_MASKING_COLUMN", "UPDATE_MASKING_COLUMN", "PATCH_MASKING_COLUMNS", "GENERATE_MASKING_REPORT", "CREATE_LIBRARY_MASKING_FORMAT", "UPDATE_LIBRARY_MASKING_FORMAT", "ADD_COLUMNS_FROM_SDM", "MASKING_JOB", "CREATE_DIFFERENCE", "DELETE_DIFFERENCE", "UPDATE_DIFFERENCE", "PATCH_DIFFERENCE", "APPLY_DIFFERENCE", "MASK_POLICY_GENERATE_HEALTH_REPORT", "MASK_POLICY_DELETE_HEALTH_REPORT", "ABORT_MASKING", "CREATE_SECURITY_POLICY_REPORT", "REFRESH_SECURITY_POLICY_CACHE", "DELETE_SECURITY_POLICY_CACHE", "CREATE_SCHEDULE", "REMOVE_SCHEDULE_REPORT", "UPDATE_ALL_ALERT", "PATCH_TARGET_ALERT_POLICY_ASSOCIATION", "CREATE_ALERT_POLICY", "UPDATE_ALERT_POLICY", "DELETE_ALERT_POLICY", "CREATE_ALERT_POLICY_RULE", "UPDATE_ALERT_POLICY_RULE", "DELETE_ALERT_POLICY_RULE", "CHANGE_ALERT_POLICY_COMPARTMENT", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "ENABLE_DATA_SAFE_CONFIGURATION", "CREATE_PRIVATE_ENDPOINT", "UPDATE_PRIVATE_ENDPOINT", "DELETE_PRIVATE_ENDPOINT", "CHANGE_PRIVATE_ENDPOINT_COMPARTMENT", "CREATE_ONPREM_CONNECTOR", "UPDATE_ONPREM_CONNECTOR", "DELETE_ONPREM_CONNECTOR", "UPDATE_ONPREM_CONNECTOR_WALLET", "CHANGE_ONPREM_CONNECTOR_COMPARTMENT", "PROVISION_POLICY", "RETRIEVE_POLICY", "UPDATE_POLICY", "CHANGE_POLICY_COMPARTMENT", "CREATE_TARGET_DATABASE", "UPDATE_TARGET_DATABASE", "ACTIVATE_TARGET_DATABASE", "DEACTIVATE_TARGET_DATABASE", "DELETE_TARGET_DATABASE", "CHANGE_TARGET_DATABASE_COMPARTMENT", "CREATE_PEER_TARGET_DATABASE", "UPDATE_PEER_TARGET_DATABASE", "DELETE_PEER_TARGET_DATABASE", "REFRESH_TARGET_DATABASE", "CREATE_USER_ASSESSMENT", "ASSESS_USER_ASSESSMENT", "CREATE_SNAPSHOT_USER_ASSESSMENT", "CREATE_SCHEDULE_USER_ASSESSMENT", "COMPARE_WITH_BASELINE_USER_ASSESSMENT", "DELETE_USER_ASSESSMENT", "UPDATE_USER_ASSESSMENT", "CHANGE_USER_ASSESSMENT_COMPARTMENT", "SET_USER_ASSESSMENT_BASELINE", "UNSET_USER_ASSESSMENT_BASELINE", "GENERATE_USER_ASSESSMENT_REPORT", "CREATE_SECURITY_ASSESSMENT", "CREATE_SECURITY_ASSESSMENT_NOW", "ASSESS_SECURITY_ASSESSMENT", "CREATE_SNAPSHOT_SECURITY_ASSESSMENT", "CREATE_SCHEDULE_SECURITY_ASSESSMENT", "COMPARE_WITH_BASELINE_SECURITY_ASSESSMENT", "DELETE_SECURITY_ASSESSMENT", "UPDATE_SECURITY_ASSESSMENT", "UPDATE_FINDING_RISK", "CHANGE_SECURITY_ASSESSMENT_COMPARTMENT", "SET_SECURITY_ASSESSMENT_BASELINE", "UNSET_SECURITY_ASSESSMENT_BASELINE", "GENERATE_SECURITY_ASSESSMENT_REPORT", "DELETE_SQL_FIREWALL_ALLOWED_SQL", "BULK_CREATE_SQL_FIREWALL_ALLOWED_SQL", "BULK_DELETE_SQL_FIREWALL_ALLOWED_SQL", "CALCULATE_VOLUME", "CALCULATE_COLLECTED_VOLUME", "CREATE_DB_SECURITY_CONFIG", "REFRESH_DB_SECURITY_CONFIG", "UPDATE_DB_SECURITY_CONFIG", "CHANGE_DB_SECURITY_CONFIG_COMPARTMENT", "GENERATE_FIREWALL_POLICY", "UPDATE_FIREWALL_POLICY", "CHANGE_FIREWALL_POLICY_COMPARTMENT", "DELETE_FIREWALL_POLICY", "CREATE_SQL_COLLECTION", "UPDATE_SQL_COLLECTION", "START_SQL_COLLECTION", "STOP_SQL_COLLECTION", "DELETE_SQL_COLLECTION", "CHANGE_SQL_COLLECTION_COMPARTMENT", "REFRESH_SQL_COLLECTION_LOG_INSIGHTS", "PURGE_SQL_COLLECTION_LOGS", "REFRESH_VIOLATIONS", "CREATE_ARCHIVAL", "UPDATE_SECURITY_POLICY", "CHANGE_SECURITY_POLICY_COMPARTMENT", "UPDATE_SECURITY_POLICY_DEPLOYMENT", "CHANGE_SECURITY_POLICY_DEPLOYMENT_COMPARTMENT", "AUDIT_TRAIL", "DELETE_AUDIT_TRAIL", "DISCOVER_AUDIT_TRAILS", "UPDATE_AUDIT_TRAIL", "UPDATE_AUDIT_PROFILE", "AUDIT_CHANGE_COMPARTMENT", "CREATE_REPORT_DEFINITION", "UPDATE_REPORT_DEFINITION", "CHANGE_REPORT_DEFINITION_COMPARTMENT", "DELETE_REPORT_DEFINITION", "GENERATE_REPORT", "CHANGE_REPORT_COMPARTMENT", "DELETE_ARCHIVE_RETRIEVAL", "CREATE_ARCHIVE_RETRIEVAL", "UPDATE_ARCHIVE_RETRIEVAL", "CHANGE_ARCHIVE_RETRIEVAL_COMPARTMENT", "UPDATE_ALERT", "TARGET_ALERT_POLICY_ASSOCIATION", "CREATE_SENSITIVE_DATA_MODEL", "UPDATE_SENSITIVE_DATA_MODEL", "DELETE_SENSITIVE_DATA_MODEL", "UPLOAD_SENSITIVE_DATA_MODEL", "GENERATE_SENSITIVE_DATA_MODEL_FOR_DOWNLOAD", "CREATE_SENSITIVE_COLUMN", "UPDATE_SENSITIVE_COLUMN", "PATCH_SENSITIVE_COLUMNS", "CREATE_DISCOVERY_JOB", "DELETE_DISCOVERY_JOB", "PATCH_DISCOVERY_JOB_RESULT", "APPLY_DISCOVERY_JOB_RESULT", "GENERATE_DISCOVERY_REPORT", "CREATE_SENSITIVE_TYPE", "UPDATE_SENSITIVE_TYPE", "CREATE_MASKING_POLICY", "UPDATE_MASKING_POLICY", "DELETE_MASKING_POLICY", "UPLOAD_MASKING_POLICY", "GENERATE_MASKING_POLICY_FOR_DOWNLOAD", "CREATE_MASKING_COLUMN", "UPDATE_MASKING_COLUMN", "PATCH_MASKING_COLUMNS", "GENERATE_MASKING_REPORT", "CREATE_LIBRARY_MASKING_FORMAT", "UPDATE_LIBRARY_MASKING_FORMAT", "ADD_COLUMNS_FROM_SDM", "MASKING_JOB", "CREATE_DIFFERENCE", "DELETE_DIFFERENCE", "UPDATE_DIFFERENCE", "PATCH_DIFFERENCE", "APPLY_DIFFERENCE", "MASK_POLICY_GENERATE_HEALTH_REPORT", "MASK_POLICY_DELETE_HEALTH_REPORT", "CREATE_SENSITIVE_TYPES_EXPORT", "UPDATE_SENSITIVE_TYPES_EXPORT", "BULK_CREATE_SENSITIVE_TYPES", "ABORT_MASKING", "CREATE_SECURITY_POLICY_REPORT", "REFRESH_SECURITY_POLICY_CACHE", "DELETE_SECURITY_POLICY_CACHE", "CREATE_SCHEDULE", "REMOVE_SCHEDULE_REPORT", "UPDATE_ALL_ALERT", "PATCH_TARGET_ALERT_POLICY_ASSOCIATION", "CREATE_ALERT_POLICY", "UPDATE_ALERT_POLICY", "DELETE_ALERT_POLICY", "CREATE_ALERT_POLICY_RULE", "UPDATE_ALERT_POLICY_RULE", "DELETE_ALERT_POLICY_RULE", "CHANGE_ALERT_POLICY_COMPARTMENT", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type operation_type: str @@ -705,7 +717,7 @@ def operation_type(self): **[Required]** Gets the operation_type of this WorkRequestSummary. The asynchronous operation tracked by this work request. - Allowed values for this property are: "ENABLE_DATA_SAFE_CONFIGURATION", "CREATE_PRIVATE_ENDPOINT", "UPDATE_PRIVATE_ENDPOINT", "DELETE_PRIVATE_ENDPOINT", "CHANGE_PRIVATE_ENDPOINT_COMPARTMENT", "CREATE_ONPREM_CONNECTOR", "UPDATE_ONPREM_CONNECTOR", "DELETE_ONPREM_CONNECTOR", "UPDATE_ONPREM_CONNECTOR_WALLET", "CHANGE_ONPREM_CONNECTOR_COMPARTMENT", "PROVISION_POLICY", "RETRIEVE_POLICY", "UPDATE_POLICY", "CHANGE_POLICY_COMPARTMENT", "CREATE_TARGET_DATABASE", "UPDATE_TARGET_DATABASE", "ACTIVATE_TARGET_DATABASE", "DEACTIVATE_TARGET_DATABASE", "DELETE_TARGET_DATABASE", "CHANGE_TARGET_DATABASE_COMPARTMENT", "CREATE_PEER_TARGET_DATABASE", "UPDATE_PEER_TARGET_DATABASE", "DELETE_PEER_TARGET_DATABASE", "REFRESH_TARGET_DATABASE", "CREATE_USER_ASSESSMENT", "ASSESS_USER_ASSESSMENT", "CREATE_SNAPSHOT_USER_ASSESSMENT", "CREATE_SCHEDULE_USER_ASSESSMENT", "COMPARE_WITH_BASELINE_USER_ASSESSMENT", "DELETE_USER_ASSESSMENT", "UPDATE_USER_ASSESSMENT", "CHANGE_USER_ASSESSMENT_COMPARTMENT", "SET_USER_ASSESSMENT_BASELINE", "UNSET_USER_ASSESSMENT_BASELINE", "GENERATE_USER_ASSESSMENT_REPORT", "CREATE_SECURITY_ASSESSMENT", "CREATE_SECURITY_ASSESSMENT_NOW", "ASSESS_SECURITY_ASSESSMENT", "CREATE_SNAPSHOT_SECURITY_ASSESSMENT", "CREATE_SCHEDULE_SECURITY_ASSESSMENT", "COMPARE_WITH_BASELINE_SECURITY_ASSESSMENT", "DELETE_SECURITY_ASSESSMENT", "UPDATE_SECURITY_ASSESSMENT", "UPDATE_FINDING_RISK", "CHANGE_SECURITY_ASSESSMENT_COMPARTMENT", "SET_SECURITY_ASSESSMENT_BASELINE", "UNSET_SECURITY_ASSESSMENT_BASELINE", "GENERATE_SECURITY_ASSESSMENT_REPORT", "DELETE_SQL_FIREWALL_ALLOWED_SQL", "BULK_CREATE_SQL_FIREWALL_ALLOWED_SQL", "BULK_DELETE_SQL_FIREWALL_ALLOWED_SQL", "CALCULATE_VOLUME", "CALCULATE_COLLECTED_VOLUME", "CREATE_DB_SECURITY_CONFIG", "REFRESH_DB_SECURITY_CONFIG", "UPDATE_DB_SECURITY_CONFIG", "CHANGE_DB_SECURITY_CONFIG_COMPARTMENT", "GENERATE_FIREWALL_POLICY", "UPDATE_FIREWALL_POLICY", "CHANGE_FIREWALL_POLICY_COMPARTMENT", "DELETE_FIREWALL_POLICY", "CREATE_SQL_COLLECTION", "UPDATE_SQL_COLLECTION", "START_SQL_COLLECTION", "STOP_SQL_COLLECTION", "DELETE_SQL_COLLECTION", "CHANGE_SQL_COLLECTION_COMPARTMENT", "REFRESH_SQL_COLLECTION_LOG_INSIGHTS", "PURGE_SQL_COLLECTION_LOGS", "REFRESH_VIOLATIONS", "CREATE_ARCHIVAL", "UPDATE_SECURITY_POLICY", "CHANGE_SECURITY_POLICY_COMPARTMENT", "UPDATE_SECURITY_POLICY_DEPLOYMENT", "CHANGE_SECURITY_POLICY_DEPLOYMENT_COMPARTMENT", "AUDIT_TRAIL", "DELETE_AUDIT_TRAIL", "DISCOVER_AUDIT_TRAILS", "UPDATE_AUDIT_TRAIL", "UPDATE_AUDIT_PROFILE", "AUDIT_CHANGE_COMPARTMENT", "CREATE_REPORT_DEFINITION", "UPDATE_REPORT_DEFINITION", "CHANGE_REPORT_DEFINITION_COMPARTMENT", "DELETE_REPORT_DEFINITION", "GENERATE_REPORT", "CHANGE_REPORT_COMPARTMENT", "DELETE_ARCHIVE_RETRIEVAL", "CREATE_ARCHIVE_RETRIEVAL", "UPDATE_ARCHIVE_RETRIEVAL", "CHANGE_ARCHIVE_RETRIEVAL_COMPARTMENT", "UPDATE_ALERT", "TARGET_ALERT_POLICY_ASSOCIATION", "CREATE_SENSITIVE_DATA_MODEL", "UPDATE_SENSITIVE_DATA_MODEL", "DELETE_SENSITIVE_DATA_MODEL", "UPLOAD_SENSITIVE_DATA_MODEL", "GENERATE_SENSITIVE_DATA_MODEL_FOR_DOWNLOAD", "CREATE_SENSITIVE_COLUMN", "UPDATE_SENSITIVE_COLUMN", "PATCH_SENSITIVE_COLUMNS", "CREATE_DISCOVERY_JOB", "DELETE_DISCOVERY_JOB", "PATCH_DISCOVERY_JOB_RESULT", "APPLY_DISCOVERY_JOB_RESULT", "GENERATE_DISCOVERY_REPORT", "CREATE_SENSITIVE_TYPE", "UPDATE_SENSITIVE_TYPE", "CREATE_MASKING_POLICY", "UPDATE_MASKING_POLICY", "DELETE_MASKING_POLICY", "UPLOAD_MASKING_POLICY", "GENERATE_MASKING_POLICY_FOR_DOWNLOAD", "CREATE_MASKING_COLUMN", "UPDATE_MASKING_COLUMN", "PATCH_MASKING_COLUMNS", "GENERATE_MASKING_REPORT", "CREATE_LIBRARY_MASKING_FORMAT", "UPDATE_LIBRARY_MASKING_FORMAT", "ADD_COLUMNS_FROM_SDM", "MASKING_JOB", "CREATE_DIFFERENCE", "DELETE_DIFFERENCE", "UPDATE_DIFFERENCE", "PATCH_DIFFERENCE", "APPLY_DIFFERENCE", "MASK_POLICY_GENERATE_HEALTH_REPORT", "MASK_POLICY_DELETE_HEALTH_REPORT", "ABORT_MASKING", "CREATE_SECURITY_POLICY_REPORT", "REFRESH_SECURITY_POLICY_CACHE", "DELETE_SECURITY_POLICY_CACHE", "CREATE_SCHEDULE", "REMOVE_SCHEDULE_REPORT", "UPDATE_ALL_ALERT", "PATCH_TARGET_ALERT_POLICY_ASSOCIATION", "CREATE_ALERT_POLICY", "UPDATE_ALERT_POLICY", "DELETE_ALERT_POLICY", "CREATE_ALERT_POLICY_RULE", "UPDATE_ALERT_POLICY_RULE", "DELETE_ALERT_POLICY_RULE", "CHANGE_ALERT_POLICY_COMPARTMENT", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "ENABLE_DATA_SAFE_CONFIGURATION", "CREATE_PRIVATE_ENDPOINT", "UPDATE_PRIVATE_ENDPOINT", "DELETE_PRIVATE_ENDPOINT", "CHANGE_PRIVATE_ENDPOINT_COMPARTMENT", "CREATE_ONPREM_CONNECTOR", "UPDATE_ONPREM_CONNECTOR", "DELETE_ONPREM_CONNECTOR", "UPDATE_ONPREM_CONNECTOR_WALLET", "CHANGE_ONPREM_CONNECTOR_COMPARTMENT", "PROVISION_POLICY", "RETRIEVE_POLICY", "UPDATE_POLICY", "CHANGE_POLICY_COMPARTMENT", "CREATE_TARGET_DATABASE", "UPDATE_TARGET_DATABASE", "ACTIVATE_TARGET_DATABASE", "DEACTIVATE_TARGET_DATABASE", "DELETE_TARGET_DATABASE", "CHANGE_TARGET_DATABASE_COMPARTMENT", "CREATE_PEER_TARGET_DATABASE", "UPDATE_PEER_TARGET_DATABASE", "DELETE_PEER_TARGET_DATABASE", "REFRESH_TARGET_DATABASE", "CREATE_USER_ASSESSMENT", "ASSESS_USER_ASSESSMENT", "CREATE_SNAPSHOT_USER_ASSESSMENT", "CREATE_SCHEDULE_USER_ASSESSMENT", "COMPARE_WITH_BASELINE_USER_ASSESSMENT", "DELETE_USER_ASSESSMENT", "UPDATE_USER_ASSESSMENT", "CHANGE_USER_ASSESSMENT_COMPARTMENT", "SET_USER_ASSESSMENT_BASELINE", "UNSET_USER_ASSESSMENT_BASELINE", "GENERATE_USER_ASSESSMENT_REPORT", "CREATE_SECURITY_ASSESSMENT", "CREATE_SECURITY_ASSESSMENT_NOW", "ASSESS_SECURITY_ASSESSMENT", "CREATE_SNAPSHOT_SECURITY_ASSESSMENT", "CREATE_SCHEDULE_SECURITY_ASSESSMENT", "COMPARE_WITH_BASELINE_SECURITY_ASSESSMENT", "DELETE_SECURITY_ASSESSMENT", "UPDATE_SECURITY_ASSESSMENT", "UPDATE_FINDING_RISK", "CHANGE_SECURITY_ASSESSMENT_COMPARTMENT", "SET_SECURITY_ASSESSMENT_BASELINE", "UNSET_SECURITY_ASSESSMENT_BASELINE", "GENERATE_SECURITY_ASSESSMENT_REPORT", "DELETE_SQL_FIREWALL_ALLOWED_SQL", "BULK_CREATE_SQL_FIREWALL_ALLOWED_SQL", "BULK_DELETE_SQL_FIREWALL_ALLOWED_SQL", "CALCULATE_VOLUME", "CALCULATE_COLLECTED_VOLUME", "CREATE_DB_SECURITY_CONFIG", "REFRESH_DB_SECURITY_CONFIG", "UPDATE_DB_SECURITY_CONFIG", "CHANGE_DB_SECURITY_CONFIG_COMPARTMENT", "GENERATE_FIREWALL_POLICY", "UPDATE_FIREWALL_POLICY", "CHANGE_FIREWALL_POLICY_COMPARTMENT", "DELETE_FIREWALL_POLICY", "CREATE_SQL_COLLECTION", "UPDATE_SQL_COLLECTION", "START_SQL_COLLECTION", "STOP_SQL_COLLECTION", "DELETE_SQL_COLLECTION", "CHANGE_SQL_COLLECTION_COMPARTMENT", "REFRESH_SQL_COLLECTION_LOG_INSIGHTS", "PURGE_SQL_COLLECTION_LOGS", "REFRESH_VIOLATIONS", "CREATE_ARCHIVAL", "UPDATE_SECURITY_POLICY", "CHANGE_SECURITY_POLICY_COMPARTMENT", "UPDATE_SECURITY_POLICY_DEPLOYMENT", "CHANGE_SECURITY_POLICY_DEPLOYMENT_COMPARTMENT", "AUDIT_TRAIL", "DELETE_AUDIT_TRAIL", "DISCOVER_AUDIT_TRAILS", "UPDATE_AUDIT_TRAIL", "UPDATE_AUDIT_PROFILE", "AUDIT_CHANGE_COMPARTMENT", "CREATE_REPORT_DEFINITION", "UPDATE_REPORT_DEFINITION", "CHANGE_REPORT_DEFINITION_COMPARTMENT", "DELETE_REPORT_DEFINITION", "GENERATE_REPORT", "CHANGE_REPORT_COMPARTMENT", "DELETE_ARCHIVE_RETRIEVAL", "CREATE_ARCHIVE_RETRIEVAL", "UPDATE_ARCHIVE_RETRIEVAL", "CHANGE_ARCHIVE_RETRIEVAL_COMPARTMENT", "UPDATE_ALERT", "TARGET_ALERT_POLICY_ASSOCIATION", "CREATE_SENSITIVE_DATA_MODEL", "UPDATE_SENSITIVE_DATA_MODEL", "DELETE_SENSITIVE_DATA_MODEL", "UPLOAD_SENSITIVE_DATA_MODEL", "GENERATE_SENSITIVE_DATA_MODEL_FOR_DOWNLOAD", "CREATE_SENSITIVE_COLUMN", "UPDATE_SENSITIVE_COLUMN", "PATCH_SENSITIVE_COLUMNS", "CREATE_DISCOVERY_JOB", "DELETE_DISCOVERY_JOB", "PATCH_DISCOVERY_JOB_RESULT", "APPLY_DISCOVERY_JOB_RESULT", "GENERATE_DISCOVERY_REPORT", "CREATE_SENSITIVE_TYPE", "UPDATE_SENSITIVE_TYPE", "CREATE_MASKING_POLICY", "UPDATE_MASKING_POLICY", "DELETE_MASKING_POLICY", "UPLOAD_MASKING_POLICY", "GENERATE_MASKING_POLICY_FOR_DOWNLOAD", "CREATE_MASKING_COLUMN", "UPDATE_MASKING_COLUMN", "PATCH_MASKING_COLUMNS", "GENERATE_MASKING_REPORT", "CREATE_LIBRARY_MASKING_FORMAT", "UPDATE_LIBRARY_MASKING_FORMAT", "ADD_COLUMNS_FROM_SDM", "MASKING_JOB", "CREATE_DIFFERENCE", "DELETE_DIFFERENCE", "UPDATE_DIFFERENCE", "PATCH_DIFFERENCE", "APPLY_DIFFERENCE", "MASK_POLICY_GENERATE_HEALTH_REPORT", "MASK_POLICY_DELETE_HEALTH_REPORT", "CREATE_SENSITIVE_TYPES_EXPORT", "UPDATE_SENSITIVE_TYPES_EXPORT", "BULK_CREATE_SENSITIVE_TYPES", "ABORT_MASKING", "CREATE_SECURITY_POLICY_REPORT", "REFRESH_SECURITY_POLICY_CACHE", "DELETE_SECURITY_POLICY_CACHE", "CREATE_SCHEDULE", "REMOVE_SCHEDULE_REPORT", "UPDATE_ALL_ALERT", "PATCH_TARGET_ALERT_POLICY_ASSOCIATION", "CREATE_ALERT_POLICY", "UPDATE_ALERT_POLICY", "DELETE_ALERT_POLICY", "CREATE_ALERT_POLICY_RULE", "UPDATE_ALERT_POLICY_RULE", "DELETE_ALERT_POLICY_RULE", "CHANGE_ALERT_POLICY_COMPARTMENT", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -724,7 +736,7 @@ def operation_type(self, operation_type): :param operation_type: The operation_type of this WorkRequestSummary. :type: str """ - allowed_values = ["ENABLE_DATA_SAFE_CONFIGURATION", "CREATE_PRIVATE_ENDPOINT", "UPDATE_PRIVATE_ENDPOINT", "DELETE_PRIVATE_ENDPOINT", "CHANGE_PRIVATE_ENDPOINT_COMPARTMENT", "CREATE_ONPREM_CONNECTOR", "UPDATE_ONPREM_CONNECTOR", "DELETE_ONPREM_CONNECTOR", "UPDATE_ONPREM_CONNECTOR_WALLET", "CHANGE_ONPREM_CONNECTOR_COMPARTMENT", "PROVISION_POLICY", "RETRIEVE_POLICY", "UPDATE_POLICY", "CHANGE_POLICY_COMPARTMENT", "CREATE_TARGET_DATABASE", "UPDATE_TARGET_DATABASE", "ACTIVATE_TARGET_DATABASE", "DEACTIVATE_TARGET_DATABASE", "DELETE_TARGET_DATABASE", "CHANGE_TARGET_DATABASE_COMPARTMENT", "CREATE_PEER_TARGET_DATABASE", "UPDATE_PEER_TARGET_DATABASE", "DELETE_PEER_TARGET_DATABASE", "REFRESH_TARGET_DATABASE", "CREATE_USER_ASSESSMENT", "ASSESS_USER_ASSESSMENT", "CREATE_SNAPSHOT_USER_ASSESSMENT", "CREATE_SCHEDULE_USER_ASSESSMENT", "COMPARE_WITH_BASELINE_USER_ASSESSMENT", "DELETE_USER_ASSESSMENT", "UPDATE_USER_ASSESSMENT", "CHANGE_USER_ASSESSMENT_COMPARTMENT", "SET_USER_ASSESSMENT_BASELINE", "UNSET_USER_ASSESSMENT_BASELINE", "GENERATE_USER_ASSESSMENT_REPORT", "CREATE_SECURITY_ASSESSMENT", "CREATE_SECURITY_ASSESSMENT_NOW", "ASSESS_SECURITY_ASSESSMENT", "CREATE_SNAPSHOT_SECURITY_ASSESSMENT", "CREATE_SCHEDULE_SECURITY_ASSESSMENT", "COMPARE_WITH_BASELINE_SECURITY_ASSESSMENT", "DELETE_SECURITY_ASSESSMENT", "UPDATE_SECURITY_ASSESSMENT", "UPDATE_FINDING_RISK", "CHANGE_SECURITY_ASSESSMENT_COMPARTMENT", "SET_SECURITY_ASSESSMENT_BASELINE", "UNSET_SECURITY_ASSESSMENT_BASELINE", "GENERATE_SECURITY_ASSESSMENT_REPORT", "DELETE_SQL_FIREWALL_ALLOWED_SQL", "BULK_CREATE_SQL_FIREWALL_ALLOWED_SQL", "BULK_DELETE_SQL_FIREWALL_ALLOWED_SQL", "CALCULATE_VOLUME", "CALCULATE_COLLECTED_VOLUME", "CREATE_DB_SECURITY_CONFIG", "REFRESH_DB_SECURITY_CONFIG", "UPDATE_DB_SECURITY_CONFIG", "CHANGE_DB_SECURITY_CONFIG_COMPARTMENT", "GENERATE_FIREWALL_POLICY", "UPDATE_FIREWALL_POLICY", "CHANGE_FIREWALL_POLICY_COMPARTMENT", "DELETE_FIREWALL_POLICY", "CREATE_SQL_COLLECTION", "UPDATE_SQL_COLLECTION", "START_SQL_COLLECTION", "STOP_SQL_COLLECTION", "DELETE_SQL_COLLECTION", "CHANGE_SQL_COLLECTION_COMPARTMENT", "REFRESH_SQL_COLLECTION_LOG_INSIGHTS", "PURGE_SQL_COLLECTION_LOGS", "REFRESH_VIOLATIONS", "CREATE_ARCHIVAL", "UPDATE_SECURITY_POLICY", "CHANGE_SECURITY_POLICY_COMPARTMENT", "UPDATE_SECURITY_POLICY_DEPLOYMENT", "CHANGE_SECURITY_POLICY_DEPLOYMENT_COMPARTMENT", "AUDIT_TRAIL", "DELETE_AUDIT_TRAIL", "DISCOVER_AUDIT_TRAILS", "UPDATE_AUDIT_TRAIL", "UPDATE_AUDIT_PROFILE", "AUDIT_CHANGE_COMPARTMENT", "CREATE_REPORT_DEFINITION", "UPDATE_REPORT_DEFINITION", "CHANGE_REPORT_DEFINITION_COMPARTMENT", "DELETE_REPORT_DEFINITION", "GENERATE_REPORT", "CHANGE_REPORT_COMPARTMENT", "DELETE_ARCHIVE_RETRIEVAL", "CREATE_ARCHIVE_RETRIEVAL", "UPDATE_ARCHIVE_RETRIEVAL", "CHANGE_ARCHIVE_RETRIEVAL_COMPARTMENT", "UPDATE_ALERT", "TARGET_ALERT_POLICY_ASSOCIATION", "CREATE_SENSITIVE_DATA_MODEL", "UPDATE_SENSITIVE_DATA_MODEL", "DELETE_SENSITIVE_DATA_MODEL", "UPLOAD_SENSITIVE_DATA_MODEL", "GENERATE_SENSITIVE_DATA_MODEL_FOR_DOWNLOAD", "CREATE_SENSITIVE_COLUMN", "UPDATE_SENSITIVE_COLUMN", "PATCH_SENSITIVE_COLUMNS", "CREATE_DISCOVERY_JOB", "DELETE_DISCOVERY_JOB", "PATCH_DISCOVERY_JOB_RESULT", "APPLY_DISCOVERY_JOB_RESULT", "GENERATE_DISCOVERY_REPORT", "CREATE_SENSITIVE_TYPE", "UPDATE_SENSITIVE_TYPE", "CREATE_MASKING_POLICY", "UPDATE_MASKING_POLICY", "DELETE_MASKING_POLICY", "UPLOAD_MASKING_POLICY", "GENERATE_MASKING_POLICY_FOR_DOWNLOAD", "CREATE_MASKING_COLUMN", "UPDATE_MASKING_COLUMN", "PATCH_MASKING_COLUMNS", "GENERATE_MASKING_REPORT", "CREATE_LIBRARY_MASKING_FORMAT", "UPDATE_LIBRARY_MASKING_FORMAT", "ADD_COLUMNS_FROM_SDM", "MASKING_JOB", "CREATE_DIFFERENCE", "DELETE_DIFFERENCE", "UPDATE_DIFFERENCE", "PATCH_DIFFERENCE", "APPLY_DIFFERENCE", "MASK_POLICY_GENERATE_HEALTH_REPORT", "MASK_POLICY_DELETE_HEALTH_REPORT", "ABORT_MASKING", "CREATE_SECURITY_POLICY_REPORT", "REFRESH_SECURITY_POLICY_CACHE", "DELETE_SECURITY_POLICY_CACHE", "CREATE_SCHEDULE", "REMOVE_SCHEDULE_REPORT", "UPDATE_ALL_ALERT", "PATCH_TARGET_ALERT_POLICY_ASSOCIATION", "CREATE_ALERT_POLICY", "UPDATE_ALERT_POLICY", "DELETE_ALERT_POLICY", "CREATE_ALERT_POLICY_RULE", "UPDATE_ALERT_POLICY_RULE", "DELETE_ALERT_POLICY_RULE", "CHANGE_ALERT_POLICY_COMPARTMENT"] + allowed_values = ["ENABLE_DATA_SAFE_CONFIGURATION", "CREATE_PRIVATE_ENDPOINT", "UPDATE_PRIVATE_ENDPOINT", "DELETE_PRIVATE_ENDPOINT", "CHANGE_PRIVATE_ENDPOINT_COMPARTMENT", "CREATE_ONPREM_CONNECTOR", "UPDATE_ONPREM_CONNECTOR", "DELETE_ONPREM_CONNECTOR", "UPDATE_ONPREM_CONNECTOR_WALLET", "CHANGE_ONPREM_CONNECTOR_COMPARTMENT", "PROVISION_POLICY", "RETRIEVE_POLICY", "UPDATE_POLICY", "CHANGE_POLICY_COMPARTMENT", "CREATE_TARGET_DATABASE", "UPDATE_TARGET_DATABASE", "ACTIVATE_TARGET_DATABASE", "DEACTIVATE_TARGET_DATABASE", "DELETE_TARGET_DATABASE", "CHANGE_TARGET_DATABASE_COMPARTMENT", "CREATE_PEER_TARGET_DATABASE", "UPDATE_PEER_TARGET_DATABASE", "DELETE_PEER_TARGET_DATABASE", "REFRESH_TARGET_DATABASE", "CREATE_USER_ASSESSMENT", "ASSESS_USER_ASSESSMENT", "CREATE_SNAPSHOT_USER_ASSESSMENT", "CREATE_SCHEDULE_USER_ASSESSMENT", "COMPARE_WITH_BASELINE_USER_ASSESSMENT", "DELETE_USER_ASSESSMENT", "UPDATE_USER_ASSESSMENT", "CHANGE_USER_ASSESSMENT_COMPARTMENT", "SET_USER_ASSESSMENT_BASELINE", "UNSET_USER_ASSESSMENT_BASELINE", "GENERATE_USER_ASSESSMENT_REPORT", "CREATE_SECURITY_ASSESSMENT", "CREATE_SECURITY_ASSESSMENT_NOW", "ASSESS_SECURITY_ASSESSMENT", "CREATE_SNAPSHOT_SECURITY_ASSESSMENT", "CREATE_SCHEDULE_SECURITY_ASSESSMENT", "COMPARE_WITH_BASELINE_SECURITY_ASSESSMENT", "DELETE_SECURITY_ASSESSMENT", "UPDATE_SECURITY_ASSESSMENT", "UPDATE_FINDING_RISK", "CHANGE_SECURITY_ASSESSMENT_COMPARTMENT", "SET_SECURITY_ASSESSMENT_BASELINE", "UNSET_SECURITY_ASSESSMENT_BASELINE", "GENERATE_SECURITY_ASSESSMENT_REPORT", "DELETE_SQL_FIREWALL_ALLOWED_SQL", "BULK_CREATE_SQL_FIREWALL_ALLOWED_SQL", "BULK_DELETE_SQL_FIREWALL_ALLOWED_SQL", "CALCULATE_VOLUME", "CALCULATE_COLLECTED_VOLUME", "CREATE_DB_SECURITY_CONFIG", "REFRESH_DB_SECURITY_CONFIG", "UPDATE_DB_SECURITY_CONFIG", "CHANGE_DB_SECURITY_CONFIG_COMPARTMENT", "GENERATE_FIREWALL_POLICY", "UPDATE_FIREWALL_POLICY", "CHANGE_FIREWALL_POLICY_COMPARTMENT", "DELETE_FIREWALL_POLICY", "CREATE_SQL_COLLECTION", "UPDATE_SQL_COLLECTION", "START_SQL_COLLECTION", "STOP_SQL_COLLECTION", "DELETE_SQL_COLLECTION", "CHANGE_SQL_COLLECTION_COMPARTMENT", "REFRESH_SQL_COLLECTION_LOG_INSIGHTS", "PURGE_SQL_COLLECTION_LOGS", "REFRESH_VIOLATIONS", "CREATE_ARCHIVAL", "UPDATE_SECURITY_POLICY", "CHANGE_SECURITY_POLICY_COMPARTMENT", "UPDATE_SECURITY_POLICY_DEPLOYMENT", "CHANGE_SECURITY_POLICY_DEPLOYMENT_COMPARTMENT", "AUDIT_TRAIL", "DELETE_AUDIT_TRAIL", "DISCOVER_AUDIT_TRAILS", "UPDATE_AUDIT_TRAIL", "UPDATE_AUDIT_PROFILE", "AUDIT_CHANGE_COMPARTMENT", "CREATE_REPORT_DEFINITION", "UPDATE_REPORT_DEFINITION", "CHANGE_REPORT_DEFINITION_COMPARTMENT", "DELETE_REPORT_DEFINITION", "GENERATE_REPORT", "CHANGE_REPORT_COMPARTMENT", "DELETE_ARCHIVE_RETRIEVAL", "CREATE_ARCHIVE_RETRIEVAL", "UPDATE_ARCHIVE_RETRIEVAL", "CHANGE_ARCHIVE_RETRIEVAL_COMPARTMENT", "UPDATE_ALERT", "TARGET_ALERT_POLICY_ASSOCIATION", "CREATE_SENSITIVE_DATA_MODEL", "UPDATE_SENSITIVE_DATA_MODEL", "DELETE_SENSITIVE_DATA_MODEL", "UPLOAD_SENSITIVE_DATA_MODEL", "GENERATE_SENSITIVE_DATA_MODEL_FOR_DOWNLOAD", "CREATE_SENSITIVE_COLUMN", "UPDATE_SENSITIVE_COLUMN", "PATCH_SENSITIVE_COLUMNS", "CREATE_DISCOVERY_JOB", "DELETE_DISCOVERY_JOB", "PATCH_DISCOVERY_JOB_RESULT", "APPLY_DISCOVERY_JOB_RESULT", "GENERATE_DISCOVERY_REPORT", "CREATE_SENSITIVE_TYPE", "UPDATE_SENSITIVE_TYPE", "CREATE_MASKING_POLICY", "UPDATE_MASKING_POLICY", "DELETE_MASKING_POLICY", "UPLOAD_MASKING_POLICY", "GENERATE_MASKING_POLICY_FOR_DOWNLOAD", "CREATE_MASKING_COLUMN", "UPDATE_MASKING_COLUMN", "PATCH_MASKING_COLUMNS", "GENERATE_MASKING_REPORT", "CREATE_LIBRARY_MASKING_FORMAT", "UPDATE_LIBRARY_MASKING_FORMAT", "ADD_COLUMNS_FROM_SDM", "MASKING_JOB", "CREATE_DIFFERENCE", "DELETE_DIFFERENCE", "UPDATE_DIFFERENCE", "PATCH_DIFFERENCE", "APPLY_DIFFERENCE", "MASK_POLICY_GENERATE_HEALTH_REPORT", "MASK_POLICY_DELETE_HEALTH_REPORT", "CREATE_SENSITIVE_TYPES_EXPORT", "UPDATE_SENSITIVE_TYPES_EXPORT", "BULK_CREATE_SENSITIVE_TYPES", "ABORT_MASKING", "CREATE_SECURITY_POLICY_REPORT", "REFRESH_SECURITY_POLICY_CACHE", "DELETE_SECURITY_POLICY_CACHE", "CREATE_SCHEDULE", "REMOVE_SCHEDULE_REPORT", "UPDATE_ALL_ALERT", "PATCH_TARGET_ALERT_POLICY_ASSOCIATION", "CREATE_ALERT_POLICY", "UPDATE_ALERT_POLICY", "DELETE_ALERT_POLICY", "CREATE_ALERT_POLICY_RULE", "UPDATE_ALERT_POLICY_RULE", "DELETE_ALERT_POLICY_RULE", "CHANGE_ALERT_POLICY_COMPARTMENT"] if not value_allowed_none_or_none_sentinel(operation_type, allowed_values): operation_type = 'UNKNOWN_ENUM_VALUE' self._operation_type = operation_type diff --git a/src/oci/data_science/data_science_client.py b/src/oci/data_science/data_science_client.py index e908459ba0..abe23f68e6 100644 --- a/src/oci/data_science/data_science_client.py +++ b/src/oci/data_science/data_science_client.py @@ -436,6 +436,117 @@ def activate_notebook_session(self, notebook_session_id, **kwargs): api_reference_link=api_reference_link, required_arguments=required_arguments) + def activate_schedule(self, schedule_id, **kwargs): + """ + Activate schedule. + + + :param str schedule_id: (required) + unique Schedule identifier + + :param str opc_request_id: (optional) + Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. + + :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 is updated or deleted only if the `etag` you + provide matches the resource's current `etag` value. + + :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 activate_schedule API. + """ + # Required path and query arguments. These are in camelCase to replace values in service endpoints. + required_arguments = ['scheduleId'] + resource_path = "/schedules/{scheduleId}/actions/activate" + method = "POST" + operation_name = "activate_schedule" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-science/20190101/Schedule/ActivateSchedule" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id", + "if_match", + "opc_retry_token" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + f"activate_schedule got unknown kwargs: {extra_kwargs!r}") + + path_params = { + "scheduleId": schedule_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(f'Parameter {k} cannot be None, whitespace or empty string') + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing), + "if-match": kwargs.get("if_match", 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, + 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 cancel_job_run(self, job_run_id, **kwargs): """ Cancels an IN_PROGRESS job run. @@ -1908,6 +2019,122 @@ def change_project_compartment(self, project_id, change_project_compartment_deta api_reference_link=api_reference_link, required_arguments=required_arguments) + def change_schedule_compartment(self, schedule_id, change_schedule_compartment_details, **kwargs): + """ + Moves a Schedule resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource. + + + :param str schedule_id: (required) + unique Schedule identifier + + :param oci.data_science.models.ChangeScheduleCompartmentDetails change_schedule_compartment_details: (required) + The information to be updated. + + :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 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 is 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, then 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 change_schedule_compartment API. + """ + # Required path and query arguments. These are in camelCase to replace values in service endpoints. + required_arguments = ['scheduleId'] + resource_path = "/schedules/{scheduleId}/actions/changeCompartment" + method = "POST" + operation_name = "change_schedule_compartment" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-science/20190101/Schedule/ChangeScheduleCompartment" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_retry_token", + "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( + f"change_schedule_compartment got unknown kwargs: {extra_kwargs!r}") + + path_params = { + "scheduleId": schedule_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(f'Parameter {k} cannot be None, whitespace or empty string') + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "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} + + 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_schedule_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_schedule_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 create_data_science_private_endpoint(self, create_data_science_private_endpoint_details, **kwargs): """ Creates a Data Science private endpoint to be used by a Data Science resource. @@ -3286,44 +3513,24 @@ def create_project(self, create_project_details, **kwargs): api_reference_link=api_reference_link, required_arguments=required_arguments) - def create_step_artifact(self, pipeline_id, step_name, step_artifact, **kwargs): + def create_schedule(self, create_schedule_details, **kwargs): """ - Upload the artifact for a step in the pipeline. - - - :param str pipeline_id: (required) - The `OCID`__ of the pipeline. + Creates a new Schedule. - __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm - - :param str step_name: (required) - Unique Step identifier in a pipeline. - - :param stream step_artifact: (required) - The step artifact to upload. - - :param int content_length: (optional) - The content length of the body. - :param str opc_request_id: (optional) - Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. + :param oci.data_science.models.CreateScheduleDetails create_schedule_details: (required) + Details for the new Schedule. :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 content_disposition: (optional) - This header allows you to specify a filename during upload. This file name is used to dispose of the file contents - while downloading the file. If this optional field is not populated in the request, then the OCID of the model is used for the file - name when downloading. - Example: `{\"Content-Disposition\": \"attachment\" - \"filename\"=\"model.tar.gz\" - \"Content-Length\": \"2347\" - \"Content-Type\": \"application/gzip\"}` + :param str opc_request_id: (optional) + Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then 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 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`. @@ -3331,46 +3538,160 @@ def create_step_artifact(self, pipeline_id, step_name, step_artifact, **kwargs): :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 int buffer_limit: (optional) - A buffer limit for the stream to be buffered. buffer_limit is used to set the buffer size capacity. Streams will be read until the size of the buffer reaches the buffer_limit. - If the stream size is greater than the buffer_limit, a BufferError exception will be thrown. - - The buffer_limit parameter is used when the stream object does not have a `seek`, `tell`, or `fileno` property for the Python Request library to calculate out the content length. - If buffer_limit is not passed, then the buffer_limit will be defaulted to 100MB. - Large streams can cause the process to freeze, consider passing in content-length for large streams instead. - :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.data_science.models.Schedule` :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use create_step_artifact API. + Click `here `__ to see an example of how to use create_schedule API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['pipelineId', 'stepName'] - resource_path = "/pipelines/{pipelineId}/steps/{stepName}/artifact" + required_arguments = [] + resource_path = "/schedules" method = "POST" - operation_name = "create_step_artifact" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-science/20190101/Pipeline/CreateStepArtifact" + operation_name = "create_schedule" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-science/20190101/Schedule/CreateSchedule" # Don't accept unknown kwargs expected_kwargs = [ "allow_control_chars", "retry_strategy", - "buffer_limit", - "content_length", - "opc_request_id", "opc_retry_token", - "content_disposition" + "opc_request_id" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"create_step_artifact got unknown kwargs: {extra_kwargs!r}") + f"create_schedule got unknown kwargs: {extra_kwargs!r}") + + 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_schedule_details, + response_type="Schedule", + 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_schedule_details, + response_type="Schedule", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + + def create_step_artifact(self, pipeline_id, step_name, step_artifact, **kwargs): + """ + Upload the artifact for a step in the pipeline. - path_params = { - "pipelineId": pipeline_id, - "stepName": step_name - } + + :param str pipeline_id: (required) + The `OCID`__ of the pipeline. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + :param str step_name: (required) + Unique Step identifier in a pipeline. + + :param stream step_artifact: (required) + The step artifact to upload. + + :param int content_length: (optional) + The content length of the body. + + :param str opc_request_id: (optional) + Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then 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 str content_disposition: (optional) + This header allows you to specify a filename during upload. This file name is used to dispose of the file contents + while downloading the file. If this optional field is not populated in the request, then the OCID of the model is used for the file + name when downloading. + Example: `{\"Content-Disposition\": \"attachment\" + \"filename\"=\"model.tar.gz\" + \"Content-Length\": \"2347\" + \"Content-Type\": \"application/gzip\"}` + + :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 + :param int buffer_limit: (optional) + A buffer limit for the stream to be buffered. buffer_limit is used to set the buffer size capacity. Streams will be read until the size of the buffer reaches the buffer_limit. + If the stream size is greater than the buffer_limit, a BufferError exception will be thrown. + + The buffer_limit parameter is used when the stream object does not have a `seek`, `tell`, or `fileno` property for the Python Request library to calculate out the content length. + If buffer_limit is not passed, then the buffer_limit will be defaulted to 100MB. + Large streams can cause the process to freeze, consider passing in content-length for large streams instead. + + :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 create_step_artifact API. + """ + # Required path and query arguments. These are in camelCase to replace values in service endpoints. + required_arguments = ['pipelineId', 'stepName'] + resource_path = "/pipelines/{pipelineId}/steps/{stepName}/artifact" + method = "POST" + operation_name = "create_step_artifact" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-science/20190101/Pipeline/CreateStepArtifact" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "buffer_limit", + "content_length", + "opc_request_id", + "opc_retry_token", + "content_disposition" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + f"create_step_artifact got unknown kwargs: {extra_kwargs!r}") + + path_params = { + "pipelineId": pipeline_id, + "stepName": step_name + } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -3762,6 +4083,117 @@ def deactivate_notebook_session(self, notebook_session_id, **kwargs): api_reference_link=api_reference_link, required_arguments=required_arguments) + def deactivate_schedule(self, schedule_id, **kwargs): + """ + Deactivate schedule. + + + :param str schedule_id: (required) + unique Schedule identifier + + :param str opc_request_id: (optional) + Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. + + :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 is updated or deleted only if the `etag` you + provide matches the resource's current `etag` value. + + :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 deactivate_schedule API. + """ + # Required path and query arguments. These are in camelCase to replace values in service endpoints. + required_arguments = ['scheduleId'] + resource_path = "/schedules/{scheduleId}/actions/deactivate" + method = "POST" + operation_name = "deactivate_schedule" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-science/20190101/Schedule/DeactivateSchedule" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id", + "if_match", + "opc_retry_token" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + f"deactivate_schedule got unknown kwargs: {extra_kwargs!r}") + + path_params = { + "scheduleId": schedule_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(f'Parameter {k} cannot be None, whitespace or empty string') + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing), + "if-match": kwargs.get("if_match", 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, + 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_data_science_private_endpoint(self, data_science_private_endpoint_id, **kwargs): """ Deletes a private endpoint using `privateEndpointId`. @@ -4693,27 +5125,139 @@ def delete_pipeline_run(self, pipeline_run_id, **kwargs): Click `here `__ to see an example of how to use delete_pipeline_run API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['pipelineRunId'] - resource_path = "/pipelineRuns/{pipelineRunId}" + required_arguments = ['pipelineRunId'] + resource_path = "/pipelineRuns/{pipelineRunId}" + method = "DELETE" + operation_name = "delete_pipeline_run" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-science/20190101/PipelineRun/DeletePipelineRun" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "delete_related_job_runs", + "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( + f"delete_pipeline_run got unknown kwargs: {extra_kwargs!r}") + + path_params = { + "pipelineRunId": pipeline_run_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(f'Parameter {k} cannot be None, whitespace or empty string') + + query_params = { + "deleteRelatedJobRuns": kwargs.get("delete_related_job_runs", 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", + "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: + 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, + 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, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + + def delete_project(self, project_id, **kwargs): + """ + Deletes the specified project. This operation fails unless all associated resources (notebook sessions or models) are in a DELETED state. You must delete all associated resources before deleting a project. + + + :param str project_id: (required) + The `OCID`__ of the project. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + :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 is 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, then 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_project API. + """ + # Required path and query arguments. These are in camelCase to replace values in service endpoints. + required_arguments = ['projectId'] + resource_path = "/projects/{projectId}" method = "DELETE" - operation_name = "delete_pipeline_run" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-science/20190101/PipelineRun/DeletePipelineRun" + operation_name = "delete_project" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-science/20190101/Project/DeleteProject" # Don't accept unknown kwargs expected_kwargs = [ "allow_control_chars", "retry_strategy", - "delete_related_job_runs", "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( - f"delete_pipeline_run got unknown kwargs: {extra_kwargs!r}") + f"delete_project got unknown kwargs: {extra_kwargs!r}") path_params = { - "pipelineRunId": pipeline_run_id + "projectId": project_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -4722,11 +5266,6 @@ def delete_pipeline_run(self, pipeline_run_id, **kwargs): if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): raise ValueError(f'Parameter {k} cannot be None, whitespace or empty string') - query_params = { - "deleteRelatedJobRuns": kwargs.get("delete_related_job_runs", 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", @@ -4739,6 +5278,8 @@ def delete_pipeline_run(self, pipeline_run_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): @@ -4749,7 +5290,6 @@ def delete_pipeline_run(self, pipeline_run_id, **kwargs): resource_path=resource_path, method=method, path_params=path_params, - query_params=query_params, header_params=header_params, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, @@ -4760,22 +5300,19 @@ def delete_pipeline_run(self, pipeline_run_id, **kwargs): resource_path=resource_path, method=method, path_params=path_params, - query_params=query_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_project(self, project_id, **kwargs): + def delete_schedule(self, schedule_id, **kwargs): """ - Deletes the specified project. This operation fails unless all associated resources (notebook sessions or models) are in a DELETED state. You must delete all associated resources before deleting a project. + Deletes a Schedule resource by identifier - :param str project_id: (required) - The `OCID`__ of the project. - - __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + :param str schedule_id: (required) + unique Schedule identifier :param str if_match: (optional) For optimistic concurrency control. In the PUT or DELETE call @@ -4790,7 +5327,7 @@ def delete_project(self, project_id, **kwargs): :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. + 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`. @@ -4803,14 +5340,14 @@ def delete_project(self, project_id, **kwargs): :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use delete_project API. + Click `here `__ to see an example of how to use delete_schedule API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['projectId'] - resource_path = "/projects/{projectId}" + required_arguments = ['scheduleId'] + resource_path = "/schedules/{scheduleId}" method = "DELETE" - operation_name = "delete_project" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-science/20190101/Project/DeleteProject" + operation_name = "delete_schedule" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-science/20190101/Schedule/DeleteSchedule" # Don't accept unknown kwargs expected_kwargs = [ @@ -4822,10 +5359,10 @@ def delete_project(self, project_id, **kwargs): extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"delete_project got unknown kwargs: {extra_kwargs!r}") + f"delete_schedule got unknown kwargs: {extra_kwargs!r}") path_params = { - "projectId": project_id + "scheduleId": schedule_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -4846,8 +5383,6 @@ def delete_project(self, project_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): @@ -6306,6 +6841,104 @@ def get_project(self, project_id, **kwargs): api_reference_link=api_reference_link, required_arguments=required_arguments) + def get_schedule(self, schedule_id, **kwargs): + """ + Gets a Schedule by identifier + + + :param str schedule_id: (required) + unique Schedule identifier + + :param str opc_request_id: (optional) + Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then 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.data_science.models.Schedule` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_schedule API. + """ + # Required path and query arguments. These are in camelCase to replace values in service endpoints. + required_arguments = ['scheduleId'] + resource_path = "/schedules/{scheduleId}" + method = "GET" + operation_name = "get_schedule" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-science/20190101/Schedule/GetSchedule" + + # 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( + f"get_schedule got unknown kwargs: {extra_kwargs!r}") + + path_params = { + "scheduleId": schedule_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(f'Parameter {k} cannot be None, whitespace or empty string') + + 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, + path_params=path_params, + header_params=header_params, + response_type="Schedule", + 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, + response_type="Schedule", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + def get_step_artifact_content(self, pipeline_id, step_name, **kwargs): """ Download the artifact for a step in the pipeline. @@ -6922,7 +7555,181 @@ def import_model_artifact(self, model_id, import_model_artifact_details, **kwarg method=method, path_params=path_params, header_params=header_params, - body=import_model_artifact_details, + body=import_model_artifact_details, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + + def list_containers(self, **kwargs): + """ + List containers. + + + :param str opc_request_id: (optional) + Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. + + :param bool is_latest: (optional) + if true, this returns latest version of container. + + :param str display_name: (optional) + Filter results by its user-friendly name. + + :param str container_name: (optional) + Filter results by the container name. + + :param str lifecycle_state: (optional) + Filter results by the specified lifecycle state. Must be a valid + state for the resource type. + + Allowed values are: "ACTIVE", "INACTIVE" + + :param str target_workload: (optional) + Filter results by the target workload. + + Allowed values are: "MODEL_DEPLOYMENT", "JOB_RUN" + + :param str usage_query_param: (optional) + Filter results by the usage. + + Allowed values are: "INFERENCE", "FINE_TUNE", "EVALUATION", "BATCH_INFERENCE", "OTHER" + + :param str tag_query_param: (optional) + Filter results by the container version tag. + + :param int limit: (optional) + For list pagination. The maximum number of results per page, + or items to return in a paginated \"List\" call. + 1 is the minimum, 100 is the maximum. + See `List Pagination`__. + + Example: `50` + + __ https://docs.cloud.oracle.com/iaas/Content/General/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. + + See `List Pagination`__. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/usingapi.htm#nine + + :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 list of :class:`~oci.data_science.models.ContainerSummary` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_containers API. + """ + # Required path and query arguments. These are in camelCase to replace values in service endpoints. + required_arguments = [] + resource_path = "/containers" + method = "GET" + operation_name = "list_containers" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-science/20190101/ContainerSummary/ListContainers" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id", + "is_latest", + "display_name", + "container_name", + "lifecycle_state", + "target_workload", + "usage_query_param", + "tag_query_param", + "limit", + "page" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + f"list_containers got unknown kwargs: {extra_kwargs!r}") + + if 'lifecycle_state' in kwargs: + lifecycle_state_allowed_values = ["ACTIVE", "INACTIVE"] + if kwargs['lifecycle_state'] not in lifecycle_state_allowed_values: + raise ValueError( + f"Invalid value for `lifecycle_state`, must be one of { lifecycle_state_allowed_values }" + ) + + if 'target_workload' in kwargs: + target_workload_allowed_values = ["MODEL_DEPLOYMENT", "JOB_RUN"] + if kwargs['target_workload'] not in target_workload_allowed_values: + raise ValueError( + f"Invalid value for `target_workload`, must be one of { target_workload_allowed_values }" + ) + + if 'usage_query_param' in kwargs: + usage_query_param_allowed_values = ["INFERENCE", "FINE_TUNE", "EVALUATION", "BATCH_INFERENCE", "OTHER"] + if kwargs['usage_query_param'] not in usage_query_param_allowed_values: + raise ValueError( + f"Invalid value for `usage_query_param`, must be one of { usage_query_param_allowed_values }" + ) + + query_params = { + "isLatest": kwargs.get("is_latest", missing), + "displayName": kwargs.get("display_name", missing), + "containerName": kwargs.get("container_name", missing), + "lifecycleState": kwargs.get("lifecycle_state", missing), + "targetWorkload": kwargs.get("target_workload", missing), + "usageQueryParam": kwargs.get("usage_query_param", missing), + "tagQueryParam": kwargs.get("tag_query_param", missing), + "limit": kwargs.get("limit", missing), + "page": kwargs.get("page", 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="list[ContainerSummary]", + 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="list[ContainerSummary]", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -9280,6 +10087,182 @@ def list_projects(self, compartment_id, **kwargs): api_reference_link=api_reference_link, required_arguments=required_arguments) + def list_schedules(self, compartment_id, **kwargs): + """ + Returns a list of Schedules. + + + :param str compartment_id: (required) + Filter results by the `OCID`__ of the compartment. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + :param str project_id: (optional) + Filter results by the `OCID`__ of the project. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + :param str lifecycle_state: (optional) + A filter to return only resources their lifecycleState matches the given lifecycleState. + + Allowed values are: "CREATING", "ACTIVE", "INACTIVE", "UPDATING", "DELETING", "DELETED", "FAILED" + + :param str display_name: (optional) + Filter results by its user-friendly name. + + :param str id: (optional) + unique Schedule identifier + + :param int limit: (optional) + For list pagination. The maximum number of results per page, + or items to return in a paginated \"List\" call. + 1 is the minimum, 100 is the maximum. + See `List Pagination`__. + + Example: `50` + + __ https://docs.cloud.oracle.com/iaas/Content/General/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. + + See `List Pagination`__. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/usingapi.htm#nine + + :param str sort_order: (optional) + Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending). + + 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 is ascending. + + Allowed values are: "timeCreated", "displayName" + + :param str opc_request_id: (optional) + Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then 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 list of :class:`~oci.data_science.models.ScheduleSummary` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_schedules API. + """ + # Required path and query arguments. These are in camelCase to replace values in service endpoints. + required_arguments = ['compartmentId'] + resource_path = "/schedules" + method = "GET" + operation_name = "list_schedules" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-science/20190101/Schedule/ListSchedules" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "project_id", + "lifecycle_state", + "display_name", + "id", + "limit", + "page", + "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( + f"list_schedules got unknown kwargs: {extra_kwargs!r}") + + if 'lifecycle_state' in kwargs: + lifecycle_state_allowed_values = ["CREATING", "ACTIVE", "INACTIVE", "UPDATING", "DELETING", "DELETED", "FAILED"] + if kwargs['lifecycle_state'] not in lifecycle_state_allowed_values: + raise ValueError( + f"Invalid value for `lifecycle_state`, must be one of { 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( + f"Invalid value for `sort_order`, must be one of { sort_order_allowed_values }" + ) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["timeCreated", "displayName"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + f"Invalid value for `sort_by`, must be one of { sort_by_allowed_values }" + ) + + query_params = { + "compartmentId": compartment_id, + "projectId": kwargs.get("project_id", missing), + "lifecycleState": kwargs.get("lifecycle_state", missing), + "displayName": kwargs.get("display_name", missing), + "id": kwargs.get("id", missing), + "limit": kwargs.get("limit", missing), + "page": kwargs.get("page", 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="list[ScheduleSummary]", + 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="list[ScheduleSummary]", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + def list_work_request_errors(self, work_request_id, **kwargs): """ Lists work request errors for the specified work request. @@ -9554,7 +10537,7 @@ def list_work_requests(self, compartment_id, **kwargs): :param str operation_type: (optional) Filter results by the type of the operation associated with the work request. - Allowed values are: "NOTEBOOK_SESSION_CREATE", "NOTEBOOK_SESSION_DELETE", "NOTEBOOK_SESSION_ACTIVATE", "NOTEBOOK_SESSION_DEACTIVATE", "MODELVERSIONSET_DELETE", "EXPORT_MODEL_ARTIFACT", "IMPORT_MODEL_ARTIFACT", "MODEL_DEPLOYMENT_CREATE", "MODEL_DEPLOYMENT_DELETE", "MODEL_DEPLOYMENT_ACTIVATE", "MODEL_DEPLOYMENT_DEACTIVATE", "MODEL_DEPLOYMENT_UPDATE", "PROJECT_DELETE", "WORKREQUEST_CANCEL", "JOB_DELETE", "PIPELINE_CREATE", "PIPELINE_DELETE", "PIPELINE_RUN_CREATE", "PIPELINE_RUN_CANCEL", "PIPELINE_RUN_DELETE", "PRIVATE_ENDPOINT_CREATE", "PRIVATE_ENDPOINT_DELETE", "PRIVATE_ENDPOINT_MOVE", "PRIVATE_ENDPOINT_UPDATE", "RESTORE_ARCHIVED_MODEL" + Allowed values are: "NOTEBOOK_SESSION_CREATE", "NOTEBOOK_SESSION_DELETE", "NOTEBOOK_SESSION_ACTIVATE", "NOTEBOOK_SESSION_DEACTIVATE", "MODELVERSIONSET_DELETE", "EXPORT_MODEL_ARTIFACT", "IMPORT_MODEL_ARTIFACT", "MODEL_DEPLOYMENT_CREATE", "MODEL_DEPLOYMENT_DELETE", "MODEL_DEPLOYMENT_ACTIVATE", "MODEL_DEPLOYMENT_DEACTIVATE", "MODEL_DEPLOYMENT_UPDATE", "PROJECT_DELETE", "WORKREQUEST_CANCEL", "JOB_DELETE", "PIPELINE_CREATE", "PIPELINE_DELETE", "PIPELINE_RUN_CREATE", "PIPELINE_RUN_CANCEL", "PIPELINE_RUN_DELETE", "PRIVATE_ENDPOINT_CREATE", "PRIVATE_ENDPOINT_DELETE", "PRIVATE_ENDPOINT_MOVE", "PRIVATE_ENDPOINT_UPDATE", "SCHEDULE_CREATE", "SCHEDULE_UPDATE", "SCHEDULE_DELETE", "SCHEDULE_MOVE", "SCHEDULE_ACTIVATE", "SCHEDULE_DEACTIVATE", "RESTORE_ARCHIVED_MODEL" :param str status: (optional) Filter results by work request status. @@ -9636,7 +10619,7 @@ def list_work_requests(self, compartment_id, **kwargs): f"list_work_requests got unknown kwargs: {extra_kwargs!r}") if 'operation_type' in kwargs: - operation_type_allowed_values = ["NOTEBOOK_SESSION_CREATE", "NOTEBOOK_SESSION_DELETE", "NOTEBOOK_SESSION_ACTIVATE", "NOTEBOOK_SESSION_DEACTIVATE", "MODELVERSIONSET_DELETE", "EXPORT_MODEL_ARTIFACT", "IMPORT_MODEL_ARTIFACT", "MODEL_DEPLOYMENT_CREATE", "MODEL_DEPLOYMENT_DELETE", "MODEL_DEPLOYMENT_ACTIVATE", "MODEL_DEPLOYMENT_DEACTIVATE", "MODEL_DEPLOYMENT_UPDATE", "PROJECT_DELETE", "WORKREQUEST_CANCEL", "JOB_DELETE", "PIPELINE_CREATE", "PIPELINE_DELETE", "PIPELINE_RUN_CREATE", "PIPELINE_RUN_CANCEL", "PIPELINE_RUN_DELETE", "PRIVATE_ENDPOINT_CREATE", "PRIVATE_ENDPOINT_DELETE", "PRIVATE_ENDPOINT_MOVE", "PRIVATE_ENDPOINT_UPDATE", "RESTORE_ARCHIVED_MODEL"] + operation_type_allowed_values = ["NOTEBOOK_SESSION_CREATE", "NOTEBOOK_SESSION_DELETE", "NOTEBOOK_SESSION_ACTIVATE", "NOTEBOOK_SESSION_DEACTIVATE", "MODELVERSIONSET_DELETE", "EXPORT_MODEL_ARTIFACT", "IMPORT_MODEL_ARTIFACT", "MODEL_DEPLOYMENT_CREATE", "MODEL_DEPLOYMENT_DELETE", "MODEL_DEPLOYMENT_ACTIVATE", "MODEL_DEPLOYMENT_DEACTIVATE", "MODEL_DEPLOYMENT_UPDATE", "PROJECT_DELETE", "WORKREQUEST_CANCEL", "JOB_DELETE", "PIPELINE_CREATE", "PIPELINE_DELETE", "PIPELINE_RUN_CREATE", "PIPELINE_RUN_CANCEL", "PIPELINE_RUN_DELETE", "PRIVATE_ENDPOINT_CREATE", "PRIVATE_ENDPOINT_DELETE", "PRIVATE_ENDPOINT_MOVE", "PRIVATE_ENDPOINT_UPDATE", "SCHEDULE_CREATE", "SCHEDULE_UPDATE", "SCHEDULE_DELETE", "SCHEDULE_MOVE", "SCHEDULE_ACTIVATE", "SCHEDULE_DEACTIVATE", "RESTORE_ARCHIVED_MODEL"] if kwargs['operation_type'] not in operation_type_allowed_values: raise ValueError( f"Invalid value for `operation_type`, must be one of { operation_type_allowed_values }" @@ -11094,3 +12077,111 @@ def update_project(self, project_id, update_project_details, **kwargs): operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) + + def update_schedule(self, schedule_id, update_schedule_details, **kwargs): + """ + Updates the Schedule + + + :param str schedule_id: (required) + unique Schedule identifier + + :param oci.data_science.models.UpdateScheduleDetails update_schedule_details: (required) + The information 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 is 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, then 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 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 update_schedule API. + """ + # Required path and query arguments. These are in camelCase to replace values in service endpoints. + required_arguments = ['scheduleId'] + resource_path = "/schedules/{scheduleId}" + method = "PUT" + operation_name = "update_schedule" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-science/20190101/Schedule/UpdateSchedule" + + # 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( + f"update_schedule got unknown kwargs: {extra_kwargs!r}") + + path_params = { + "scheduleId": schedule_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(f'Parameter {k} cannot be None, whitespace or empty string') + + 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: + 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_schedule_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=update_schedule_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/data_science/data_science_client_composite_operations.py b/src/oci/data_science/data_science_client_composite_operations.py index 38177dcf0b..d5472be117 100644 --- a/src/oci/data_science/data_science_client_composite_operations.py +++ b/src/oci/data_science/data_science_client_composite_operations.py @@ -151,6 +151,45 @@ def activate_notebook_session_and_wait_for_state(self, notebook_session_id, wait except Exception as e: raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def activate_schedule_and_wait_for_state(self, schedule_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.data_science.DataScienceClient.activate_schedule` and waits for the :py:class:`~oci.data_science.models.WorkRequest` + to enter the given state(s). + + :param str schedule_id: (required) + unique Schedule identifier + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.data_science.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.data_science.DataScienceClient.activate_schedule` + + :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.activate_schedule(schedule_id, **operation_kwargs) + if not wait_for_states: + return operation_result + lowered_wait_for_states = [w.lower() for w in wait_for_states] + if 'opc-work-request-id' not in operation_result.headers: + return operation_result + wait_for_resource_id = operation_result.headers['opc-work-request-id'] + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_work_request(wait_for_resource_id), + evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_wait_for_states, + **waiter_kwargs + ) + result_to_return = waiter_result + + return result_to_return + except Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def change_data_science_private_endpoint_compartment_and_wait_for_state(self, data_science_private_endpoint_id, change_data_science_private_endpoint_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): """ Calls :py:func:`~oci.data_science.DataScienceClient.change_data_science_private_endpoint_compartment` and waits for the :py:class:`~oci.data_science.models.WorkRequest` @@ -237,6 +276,48 @@ def change_model_version_set_compartment_and_wait_for_state(self, model_version_ except Exception as e: raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def change_schedule_compartment_and_wait_for_state(self, schedule_id, change_schedule_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.data_science.DataScienceClient.change_schedule_compartment` and waits for the :py:class:`~oci.data_science.models.WorkRequest` + to enter the given state(s). + + :param str schedule_id: (required) + unique Schedule identifier + + :param oci.data_science.models.ChangeScheduleCompartmentDetails change_schedule_compartment_details: (required) + The information 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.data_science.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.data_science.DataScienceClient.change_schedule_compartment` + + :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.change_schedule_compartment(schedule_id, change_schedule_compartment_details, **operation_kwargs) + if not wait_for_states: + return operation_result + lowered_wait_for_states = [w.lower() for w in wait_for_states] + if 'opc-work-request-id' not in operation_result.headers: + return operation_result + wait_for_resource_id = operation_result.headers['opc-work-request-id'] + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_work_request(wait_for_resource_id), + evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_wait_for_states, + **waiter_kwargs + ) + result_to_return = waiter_result + + return result_to_return + except Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def create_data_science_private_endpoint_and_wait_for_state(self, create_data_science_private_endpoint_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): """ Calls :py:func:`~oci.data_science.DataScienceClient.create_data_science_private_endpoint` and waits for the :py:class:`~oci.data_science.models.WorkRequest` @@ -648,6 +729,45 @@ def create_project_and_wait_for_state(self, create_project_details, wait_for_sta except Exception as e: raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def create_schedule_and_wait_for_state(self, create_schedule_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.data_science.DataScienceClient.create_schedule` and waits for the :py:class:`~oci.data_science.models.WorkRequest` + to enter the given state(s). + + :param oci.data_science.models.CreateScheduleDetails create_schedule_details: (required) + Details for the new Schedule. + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.data_science.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.data_science.DataScienceClient.create_schedule` + + :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_schedule(create_schedule_details, **operation_kwargs) + if not wait_for_states: + return operation_result + lowered_wait_for_states = [w.lower() for w in wait_for_states] + if 'opc-work-request-id' not in operation_result.headers: + return operation_result + wait_for_resource_id = operation_result.headers['opc-work-request-id'] + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_work_request(wait_for_resource_id), + evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_wait_for_states, + **waiter_kwargs + ) + result_to_return = waiter_result + + return result_to_return + except Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def deactivate_model_and_wait_for_state(self, model_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): """ Calls :py:func:`~oci.data_science.DataScienceClient.deactivate_model` and waits for the :py:class:`~oci.data_science.models.Model` acted upon @@ -774,6 +894,45 @@ def deactivate_notebook_session_and_wait_for_state(self, notebook_session_id, wa except Exception as e: raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def deactivate_schedule_and_wait_for_state(self, schedule_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.data_science.DataScienceClient.deactivate_schedule` and waits for the :py:class:`~oci.data_science.models.WorkRequest` + to enter the given state(s). + + :param str schedule_id: (required) + unique Schedule identifier + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.data_science.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.data_science.DataScienceClient.deactivate_schedule` + + :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.deactivate_schedule(schedule_id, **operation_kwargs) + if not wait_for_states: + return operation_result + lowered_wait_for_states = [w.lower() for w in wait_for_states] + if 'opc-work-request-id' not in operation_result.headers: + return operation_result + wait_for_resource_id = operation_result.headers['opc-work-request-id'] + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_work_request(wait_for_resource_id), + evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_wait_for_states, + **waiter_kwargs + ) + result_to_return = waiter_result + + return result_to_return + except Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def delete_data_science_private_endpoint_and_wait_for_state(self, data_science_private_endpoint_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): """ Calls :py:func:`~oci.data_science.DataScienceClient.delete_data_science_private_endpoint` and waits for the :py:class:`~oci.data_science.models.WorkRequest` @@ -1298,6 +1457,53 @@ def delete_project_and_wait_for_state(self, project_id, wait_for_states=[], oper except Exception as e: raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def delete_schedule_and_wait_for_state(self, schedule_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.data_science.DataScienceClient.delete_schedule` and waits for the :py:class:`~oci.data_science.models.WorkRequest` + to enter the given state(s). + + :param str schedule_id: (required) + unique Schedule identifier + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.data_science.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.data_science.DataScienceClient.delete_schedule` + + :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 = None + try: + operation_result = self.client.delete_schedule(schedule_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] + if 'opc-work-request-id' not in operation_result.headers: + return operation_result + wait_for_resource_id = operation_result.headers['opc-work-request-id'] + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_work_request(wait_for_resource_id), + evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_wait_for_states, + **waiter_kwargs + ) + result_to_return = waiter_result + + return result_to_return + except Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def export_model_artifact_and_wait_for_state(self, model_id, export_model_artifact_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): """ Calls :py:func:`~oci.data_science.DataScienceClient.export_model_artifact` and waits for the :py:class:`~oci.data_science.models.WorkRequest` @@ -1892,3 +2098,45 @@ def update_project_and_wait_for_state(self, project_id, update_project_details, 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_schedule_and_wait_for_state(self, schedule_id, update_schedule_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.data_science.DataScienceClient.update_schedule` and waits for the :py:class:`~oci.data_science.models.WorkRequest` + to enter the given state(s). + + :param str schedule_id: (required) + unique Schedule identifier + + :param oci.data_science.models.UpdateScheduleDetails update_schedule_details: (required) + The information 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.data_science.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.data_science.DataScienceClient.update_schedule` + + :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_schedule(schedule_id, update_schedule_details, **operation_kwargs) + if not wait_for_states: + return operation_result + lowered_wait_for_states = [w.lower() for w in wait_for_states] + if 'opc-work-request-id' not in operation_result.headers: + return operation_result + wait_for_resource_id = operation_result.headers['opc-work-request-id'] + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_work_request(wait_for_resource_id), + evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_wait_for_states, + **waiter_kwargs + ) + result_to_return = waiter_result + + return result_to_return + except Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) diff --git a/src/oci/data_science/models/__init__.py b/src/oci/data_science/models/__init__.py index af3b953a52..bc0079209b 100644 --- a/src/oci/data_science/models/__init__.py +++ b/src/oci/data_science/models/__init__.py @@ -25,9 +25,12 @@ from .change_pipeline_compartment_details import ChangePipelineCompartmentDetails from .change_pipeline_run_compartment_details import ChangePipelineRunCompartmentDetails from .change_project_compartment_details import ChangeProjectCompartmentDetails +from .change_schedule_compartment_details import ChangeScheduleCompartmentDetails +from .container_summary import ContainerSummary from .create_data_science_private_endpoint_details import CreateDataSciencePrivateEndpointDetails from .create_job_details import CreateJobDetails from .create_job_run_details import CreateJobRunDetails +from .create_job_run_schedule_action_details import CreateJobRunScheduleActionDetails from .create_model_deployment_details import CreateModelDeploymentDetails from .create_model_details import CreateModelDetails from .create_model_provenance_details import CreateModelProvenanceDetails @@ -35,7 +38,9 @@ from .create_notebook_session_details import CreateNotebookSessionDetails from .create_pipeline_details import CreatePipelineDetails from .create_pipeline_run_details import CreatePipelineRunDetails +from .create_pipeline_run_schedule_action_details import CreatePipelineRunScheduleActionDetails from .create_project_details import CreateProjectDetails +from .create_schedule_details import CreateScheduleDetails from .custom_expression_query_scaling_configuration import CustomExpressionQueryScalingConfiguration from .custom_metric_expression_rule import CustomMetricExpressionRule from .data_science_private_endpoint import DataSciencePrivateEndpoint @@ -46,9 +51,11 @@ from .fast_launch_job_config_summary import FastLaunchJobConfigSummary from .file_storage_mount_configuration_details import FileStorageMountConfigurationDetails from .fixed_size_scaling_policy import FixedSizeScalingPolicy +from .generic_job_run_use_case_configuration_details import GenericJobRunUseCaseConfigurationDetails from .import_model_artifact_details import ImportModelArtifactDetails from .instance_configuration import InstanceConfiguration from .instance_pool_model_deployment_system_data import InstancePoolModelDeploymentSystemData +from .invoke_ml_application_provider_trigger_schedule_action_details import InvokeMlApplicationProviderTriggerScheduleActionDetails from .job import Job from .job_configuration_details import JobConfigurationDetails from .job_environment_configuration_details import JobEnvironmentConfigurationDetails @@ -57,6 +64,8 @@ from .job_run import JobRun from .job_run_log_details import JobRunLogDetails from .job_run_summary import JobRunSummary +from .job_run_use_case_configuration_details import JobRunUseCaseConfigurationDetails +from .job_run_workload_configuration_details import JobRunWorkloadConfigurationDetails from .job_shape_config_details import JobShapeConfigDetails from .job_shape_summary import JobShapeSummary from .job_summary import JobSummary @@ -66,6 +75,7 @@ from .metric_expression_rule import MetricExpressionRule from .model import Model from .model_configuration_details import ModelConfigurationDetails +from .model_deploy_workload_configuration_details import ModelDeployWorkloadConfigurationDetails from .model_deployment import ModelDeployment from .model_deployment_configuration_details import ModelDeploymentConfigurationDetails from .model_deployment_environment_configuration_details import ModelDeploymentEnvironmentConfigurationDetails @@ -123,10 +133,23 @@ from .retention_setting import RetentionSetting from .scaling_configuration import ScalingConfiguration from .scaling_policy import ScalingPolicy +from .schedule import Schedule +from .schedule_action import ScheduleAction +from .schedule_cron_trigger import ScheduleCronTrigger +from .schedule_http_action import ScheduleHttpAction +from .schedule_http_action_details import ScheduleHttpActionDetails +from .schedule_i_cal_trigger import ScheduleICalTrigger +from .schedule_interval_trigger import ScheduleIntervalTrigger +from .schedule_log_details import ScheduleLogDetails +from .schedule_summary import ScheduleSummary +from .schedule_trigger import ScheduleTrigger from .single_model_deployment_configuration_details import SingleModelDeploymentConfigurationDetails from .standalone_job_infrastructure_configuration_details import StandaloneJobInfrastructureConfigurationDetails from .storage_mount_configuration_details import StorageMountConfigurationDetails +from .tag_configuration import TagConfiguration from .threshold_based_auto_scaling_policy_details import ThresholdBasedAutoScalingPolicyDetails +from .trigger_ml_application_instance_view_flow_details import TriggerMlApplicationInstanceViewFlowDetails +from .trigger_parameter import TriggerParameter from .update_category_log_details import UpdateCategoryLogDetails from .update_data_science_private_endpoint_details import UpdateDataSciencePrivateEndpointDetails from .update_default_model_deployment_environment_configuration_details import UpdateDefaultModelDeploymentEnvironmentConfigurationDetails @@ -144,12 +167,14 @@ from .update_pipeline_details import UpdatePipelineDetails from .update_pipeline_run_details import UpdatePipelineRunDetails from .update_project_details import UpdateProjectDetails +from .update_schedule_details import UpdateScheduleDetails from .update_single_model_deployment_configuration_details import UpdateSingleModelDeploymentConfigurationDetails from .work_request import WorkRequest from .work_request_error import WorkRequestError from .work_request_log_entry import WorkRequestLogEntry from .work_request_resource import WorkRequestResource from .work_request_summary import WorkRequestSummary +from .workload_configuration_details import WorkloadConfigurationDetails # Maps type names to classes for data_science services. data_science_type_mapping = { @@ -172,9 +197,12 @@ "ChangePipelineCompartmentDetails": ChangePipelineCompartmentDetails, "ChangePipelineRunCompartmentDetails": ChangePipelineRunCompartmentDetails, "ChangeProjectCompartmentDetails": ChangeProjectCompartmentDetails, + "ChangeScheduleCompartmentDetails": ChangeScheduleCompartmentDetails, + "ContainerSummary": ContainerSummary, "CreateDataSciencePrivateEndpointDetails": CreateDataSciencePrivateEndpointDetails, "CreateJobDetails": CreateJobDetails, "CreateJobRunDetails": CreateJobRunDetails, + "CreateJobRunScheduleActionDetails": CreateJobRunScheduleActionDetails, "CreateModelDeploymentDetails": CreateModelDeploymentDetails, "CreateModelDetails": CreateModelDetails, "CreateModelProvenanceDetails": CreateModelProvenanceDetails, @@ -182,7 +210,9 @@ "CreateNotebookSessionDetails": CreateNotebookSessionDetails, "CreatePipelineDetails": CreatePipelineDetails, "CreatePipelineRunDetails": CreatePipelineRunDetails, + "CreatePipelineRunScheduleActionDetails": CreatePipelineRunScheduleActionDetails, "CreateProjectDetails": CreateProjectDetails, + "CreateScheduleDetails": CreateScheduleDetails, "CustomExpressionQueryScalingConfiguration": CustomExpressionQueryScalingConfiguration, "CustomMetricExpressionRule": CustomMetricExpressionRule, "DataSciencePrivateEndpoint": DataSciencePrivateEndpoint, @@ -193,9 +223,11 @@ "FastLaunchJobConfigSummary": FastLaunchJobConfigSummary, "FileStorageMountConfigurationDetails": FileStorageMountConfigurationDetails, "FixedSizeScalingPolicy": FixedSizeScalingPolicy, + "GenericJobRunUseCaseConfigurationDetails": GenericJobRunUseCaseConfigurationDetails, "ImportModelArtifactDetails": ImportModelArtifactDetails, "InstanceConfiguration": InstanceConfiguration, "InstancePoolModelDeploymentSystemData": InstancePoolModelDeploymentSystemData, + "InvokeMlApplicationProviderTriggerScheduleActionDetails": InvokeMlApplicationProviderTriggerScheduleActionDetails, "Job": Job, "JobConfigurationDetails": JobConfigurationDetails, "JobEnvironmentConfigurationDetails": JobEnvironmentConfigurationDetails, @@ -204,6 +236,8 @@ "JobRun": JobRun, "JobRunLogDetails": JobRunLogDetails, "JobRunSummary": JobRunSummary, + "JobRunUseCaseConfigurationDetails": JobRunUseCaseConfigurationDetails, + "JobRunWorkloadConfigurationDetails": JobRunWorkloadConfigurationDetails, "JobShapeConfigDetails": JobShapeConfigDetails, "JobShapeSummary": JobShapeSummary, "JobSummary": JobSummary, @@ -213,6 +247,7 @@ "MetricExpressionRule": MetricExpressionRule, "Model": Model, "ModelConfigurationDetails": ModelConfigurationDetails, + "ModelDeployWorkloadConfigurationDetails": ModelDeployWorkloadConfigurationDetails, "ModelDeployment": ModelDeployment, "ModelDeploymentConfigurationDetails": ModelDeploymentConfigurationDetails, "ModelDeploymentEnvironmentConfigurationDetails": ModelDeploymentEnvironmentConfigurationDetails, @@ -270,10 +305,23 @@ "RetentionSetting": RetentionSetting, "ScalingConfiguration": ScalingConfiguration, "ScalingPolicy": ScalingPolicy, + "Schedule": Schedule, + "ScheduleAction": ScheduleAction, + "ScheduleCronTrigger": ScheduleCronTrigger, + "ScheduleHttpAction": ScheduleHttpAction, + "ScheduleHttpActionDetails": ScheduleHttpActionDetails, + "ScheduleICalTrigger": ScheduleICalTrigger, + "ScheduleIntervalTrigger": ScheduleIntervalTrigger, + "ScheduleLogDetails": ScheduleLogDetails, + "ScheduleSummary": ScheduleSummary, + "ScheduleTrigger": ScheduleTrigger, "SingleModelDeploymentConfigurationDetails": SingleModelDeploymentConfigurationDetails, "StandaloneJobInfrastructureConfigurationDetails": StandaloneJobInfrastructureConfigurationDetails, "StorageMountConfigurationDetails": StorageMountConfigurationDetails, + "TagConfiguration": TagConfiguration, "ThresholdBasedAutoScalingPolicyDetails": ThresholdBasedAutoScalingPolicyDetails, + "TriggerMlApplicationInstanceViewFlowDetails": TriggerMlApplicationInstanceViewFlowDetails, + "TriggerParameter": TriggerParameter, "UpdateCategoryLogDetails": UpdateCategoryLogDetails, "UpdateDataSciencePrivateEndpointDetails": UpdateDataSciencePrivateEndpointDetails, "UpdateDefaultModelDeploymentEnvironmentConfigurationDetails": UpdateDefaultModelDeploymentEnvironmentConfigurationDetails, @@ -291,10 +339,12 @@ "UpdatePipelineDetails": UpdatePipelineDetails, "UpdatePipelineRunDetails": UpdatePipelineRunDetails, "UpdateProjectDetails": UpdateProjectDetails, + "UpdateScheduleDetails": UpdateScheduleDetails, "UpdateSingleModelDeploymentConfigurationDetails": UpdateSingleModelDeploymentConfigurationDetails, "WorkRequest": WorkRequest, "WorkRequestError": WorkRequestError, "WorkRequestLogEntry": WorkRequestLogEntry, "WorkRequestResource": WorkRequestResource, - "WorkRequestSummary": WorkRequestSummary + "WorkRequestSummary": WorkRequestSummary, + "WorkloadConfigurationDetails": WorkloadConfigurationDetails } diff --git a/src/oci/data_science/models/change_schedule_compartment_details.py b/src/oci/data_science/models/change_schedule_compartment_details.py new file mode 100644 index 0000000000..9bc3f739bf --- /dev/null +++ b/src/oci/data_science/models/change_schedule_compartment_details.py @@ -0,0 +1,78 @@ +# coding: utf-8 +# Copyright (c) 2016, 2025, 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: 20190101 + + +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 ChangeScheduleCompartmentDetails(object): + """ + The information to be updated. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ChangeScheduleCompartmentDetails 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 ChangeScheduleCompartmentDetails. + :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 ChangeScheduleCompartmentDetails. + 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 ChangeScheduleCompartmentDetails. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this ChangeScheduleCompartmentDetails. + 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 ChangeScheduleCompartmentDetails. + :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/data_science/models/container_summary.py b/src/oci/data_science/models/container_summary.py new file mode 100644 index 0000000000..ca1e6ba1db --- /dev/null +++ b/src/oci/data_science/models/container_summary.py @@ -0,0 +1,516 @@ +# coding: utf-8 +# Copyright (c) 2016, 2025, 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: 20190101 + + +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 ContainerSummary(object): + """ + Summary representation of a container + """ + + #: A constant which can be used with the target_workloads property of a ContainerSummary. + #: This constant has a value of "MODEL_DEPLOYMENT" + TARGET_WORKLOADS_MODEL_DEPLOYMENT = "MODEL_DEPLOYMENT" + + #: A constant which can be used with the target_workloads property of a ContainerSummary. + #: This constant has a value of "JOB_RUN" + TARGET_WORKLOADS_JOB_RUN = "JOB_RUN" + + #: A constant which can be used with the usages property of a ContainerSummary. + #: This constant has a value of "INFERENCE" + USAGES_INFERENCE = "INFERENCE" + + #: A constant which can be used with the usages property of a ContainerSummary. + #: This constant has a value of "FINE_TUNE" + USAGES_FINE_TUNE = "FINE_TUNE" + + #: A constant which can be used with the usages property of a ContainerSummary. + #: This constant has a value of "EVALUATION" + USAGES_EVALUATION = "EVALUATION" + + #: A constant which can be used with the usages property of a ContainerSummary. + #: This constant has a value of "BATCH_INFERENCE" + USAGES_BATCH_INFERENCE = "BATCH_INFERENCE" + + #: A constant which can be used with the usages property of a ContainerSummary. + #: This constant has a value of "OTHER" + USAGES_OTHER = "OTHER" + + #: A constant which can be used with the lifecycle_state property of a ContainerSummary. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a ContainerSummary. + #: This constant has a value of "INACTIVE" + LIFECYCLE_STATE_INACTIVE = "INACTIVE" + + def __init__(self, **kwargs): + """ + Initializes a new ContainerSummary object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param container_name: + The value to assign to the container_name property of this ContainerSummary. + :type container_name: str + + :param display_name: + The value to assign to the display_name property of this ContainerSummary. + :type display_name: str + + :param family_name: + The value to assign to the family_name property of this ContainerSummary. + :type family_name: str + + :param description: + The value to assign to the description property of this ContainerSummary. + :type description: str + + :param is_latest: + The value to assign to the is_latest property of this ContainerSummary. + :type is_latest: bool + + :param target_workloads: + The value to assign to the target_workloads property of this ContainerSummary. + Allowed values for items in this list are: "MODEL_DEPLOYMENT", "JOB_RUN", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type target_workloads: list[str] + + :param usages: + The value to assign to the usages property of this ContainerSummary. + Allowed values for items in this list are: "INFERENCE", "FINE_TUNE", "EVALUATION", "BATCH_INFERENCE", "OTHER", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type usages: list[str] + + :param tag: + The value to assign to the tag property of this ContainerSummary. + :type tag: str + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this ContainerSummary. + Allowed values for this property are: "ACTIVE", "INACTIVE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type lifecycle_state: str + + :param workload_configuration_details_list: + The value to assign to the workload_configuration_details_list property of this ContainerSummary. + :type workload_configuration_details_list: list[oci.data_science.models.WorkloadConfigurationDetails] + + :param tag_configuration_list: + The value to assign to the tag_configuration_list property of this ContainerSummary. + :type tag_configuration_list: list[oci.data_science.models.TagConfiguration] + + :param freeform_tags: + The value to assign to the freeform_tags property of this ContainerSummary. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this ContainerSummary. + :type defined_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'container_name': 'str', + 'display_name': 'str', + 'family_name': 'str', + 'description': 'str', + 'is_latest': 'bool', + 'target_workloads': 'list[str]', + 'usages': 'list[str]', + 'tag': 'str', + 'lifecycle_state': 'str', + 'workload_configuration_details_list': 'list[WorkloadConfigurationDetails]', + 'tag_configuration_list': 'list[TagConfiguration]', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))' + } + + self.attribute_map = { + 'container_name': 'containerName', + 'display_name': 'displayName', + 'family_name': 'familyName', + 'description': 'description', + 'is_latest': 'isLatest', + 'target_workloads': 'targetWorkloads', + 'usages': 'usages', + 'tag': 'tag', + 'lifecycle_state': 'lifecycleState', + 'workload_configuration_details_list': 'workloadConfigurationDetailsList', + 'tag_configuration_list': 'tagConfigurationList', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags' + } + + self._container_name = None + self._display_name = None + self._family_name = None + self._description = None + self._is_latest = None + self._target_workloads = None + self._usages = None + self._tag = None + self._lifecycle_state = None + self._workload_configuration_details_list = None + self._tag_configuration_list = None + self._freeform_tags = None + self._defined_tags = None + + @property + def container_name(self): + """ + **[Required]** Gets the container_name of this ContainerSummary. + The name of the container. This can be same for different tags + + + :return: The container_name of this ContainerSummary. + :rtype: str + """ + return self._container_name + + @container_name.setter + def container_name(self, container_name): + """ + Sets the container_name of this ContainerSummary. + The name of the container. This can be same for different tags + + + :param container_name: The container_name of this ContainerSummary. + :type: str + """ + self._container_name = container_name + + @property + def display_name(self): + """ + Gets the display_name of this ContainerSummary. + The display name of the container. + + + :return: The display_name of this ContainerSummary. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this ContainerSummary. + The display name of the container. + + + :param display_name: The display_name of this ContainerSummary. + :type: str + """ + self._display_name = display_name + + @property + def family_name(self): + """ + Gets the family_name of this ContainerSummary. + The family name of the container. + + + :return: The family_name of this ContainerSummary. + :rtype: str + """ + return self._family_name + + @family_name.setter + def family_name(self, family_name): + """ + Sets the family_name of this ContainerSummary. + The family name of the container. + + + :param family_name: The family_name of this ContainerSummary. + :type: str + """ + self._family_name = family_name + + @property + def description(self): + """ + Gets the description of this ContainerSummary. + Description of the container. + + + :return: The description of this ContainerSummary. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this ContainerSummary. + Description of the container. + + + :param description: The description of this ContainerSummary. + :type: str + """ + self._description = description + + @property + def is_latest(self): + """ + **[Required]** Gets the is_latest of this ContainerSummary. + The latest tag of the container. + + + :return: The is_latest of this ContainerSummary. + :rtype: bool + """ + return self._is_latest + + @is_latest.setter + def is_latest(self, is_latest): + """ + Sets the is_latest of this ContainerSummary. + The latest tag of the container. + + + :param is_latest: The is_latest of this ContainerSummary. + :type: bool + """ + self._is_latest = is_latest + + @property + def target_workloads(self): + """ + Gets the target_workloads of this ContainerSummary. + The list of target workload. This Container can be used with given data science resources. + + Allowed values for items in this list are: "MODEL_DEPLOYMENT", "JOB_RUN", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The target_workloads of this ContainerSummary. + :rtype: list[str] + """ + return self._target_workloads + + @target_workloads.setter + def target_workloads(self, target_workloads): + """ + Sets the target_workloads of this ContainerSummary. + The list of target workload. This Container can be used with given data science resources. + + + :param target_workloads: The target_workloads of this ContainerSummary. + :type: list[str] + """ + allowed_values = ["MODEL_DEPLOYMENT", "JOB_RUN"] + if target_workloads: + target_workloads[:] = ['UNKNOWN_ENUM_VALUE' if not value_allowed_none_or_none_sentinel(x, allowed_values) else x for x in target_workloads] + self._target_workloads = target_workloads + + @property + def usages(self): + """ + Gets the usages of this ContainerSummary. + The list of usages of this container. This Container can be used for given use-cases. + + Allowed values for items in this list are: "INFERENCE", "FINE_TUNE", "EVALUATION", "BATCH_INFERENCE", "OTHER", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The usages of this ContainerSummary. + :rtype: list[str] + """ + return self._usages + + @usages.setter + def usages(self, usages): + """ + Sets the usages of this ContainerSummary. + The list of usages of this container. This Container can be used for given use-cases. + + + :param usages: The usages of this ContainerSummary. + :type: list[str] + """ + allowed_values = ["INFERENCE", "FINE_TUNE", "EVALUATION", "BATCH_INFERENCE", "OTHER"] + if usages: + usages[:] = ['UNKNOWN_ENUM_VALUE' if not value_allowed_none_or_none_sentinel(x, allowed_values) else x for x in usages] + self._usages = usages + + @property + def tag(self): + """ + **[Required]** Gets the tag of this ContainerSummary. + Container Tag. + + + :return: The tag of this ContainerSummary. + :rtype: str + """ + return self._tag + + @tag.setter + def tag(self, tag): + """ + Sets the tag of this ContainerSummary. + Container Tag. + + + :param tag: The tag of this ContainerSummary. + :type: str + """ + self._tag = tag + + @property + def lifecycle_state(self): + """ + **[Required]** Gets the lifecycle_state of this ContainerSummary. + Container Version LifecycleState. + + Allowed values for this property are: "ACTIVE", "INACTIVE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The lifecycle_state of this ContainerSummary. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this ContainerSummary. + Container Version LifecycleState. + + + :param lifecycle_state: The lifecycle_state of this ContainerSummary. + :type: str + """ + allowed_values = ["ACTIVE", "INACTIVE"] + if not value_allowed_none_or_none_sentinel(lifecycle_state, allowed_values): + lifecycle_state = 'UNKNOWN_ENUM_VALUE' + self._lifecycle_state = lifecycle_state + + @property + def workload_configuration_details_list(self): + """ + Gets the workload_configuration_details_list of this ContainerSummary. + workload configuration of the container. + + + :return: The workload_configuration_details_list of this ContainerSummary. + :rtype: list[oci.data_science.models.WorkloadConfigurationDetails] + """ + return self._workload_configuration_details_list + + @workload_configuration_details_list.setter + def workload_configuration_details_list(self, workload_configuration_details_list): + """ + Sets the workload_configuration_details_list of this ContainerSummary. + workload configuration of the container. + + + :param workload_configuration_details_list: The workload_configuration_details_list of this ContainerSummary. + :type: list[oci.data_science.models.WorkloadConfigurationDetails] + """ + self._workload_configuration_details_list = workload_configuration_details_list + + @property + def tag_configuration_list(self): + """ + Gets the tag_configuration_list of this ContainerSummary. + An array of defined metadata details for the model. + + + :return: The tag_configuration_list of this ContainerSummary. + :rtype: list[oci.data_science.models.TagConfiguration] + """ + return self._tag_configuration_list + + @tag_configuration_list.setter + def tag_configuration_list(self, tag_configuration_list): + """ + Sets the tag_configuration_list of this ContainerSummary. + An array of defined metadata details for the model. + + + :param tag_configuration_list: The tag_configuration_list of this ContainerSummary. + :type: list[oci.data_science.models.TagConfiguration] + """ + self._tag_configuration_list = tag_configuration_list + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this ContainerSummary. + Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See `Resource Tags`__. + Example: `{\"Department\": \"Finance\"}` + + __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm + + + :return: The freeform_tags of this ContainerSummary. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this ContainerSummary. + Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See `Resource Tags`__. + Example: `{\"Department\": \"Finance\"}` + + __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm + + + :param freeform_tags: The freeform_tags of this ContainerSummary. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this ContainerSummary. + Defined tags for this resource. Each key is predefined and scoped to a namespace. See `Resource Tags`__. + Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` + + __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm + + + :return: The defined_tags of this ContainerSummary. + :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 ContainerSummary. + Defined tags for this resource. Each key is predefined and scoped to a namespace. See `Resource Tags`__. + Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` + + __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm + + + :param defined_tags: The defined_tags of this ContainerSummary. + :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/data_science/models/create_job_run_schedule_action_details.py b/src/oci/data_science/models/create_job_run_schedule_action_details.py new file mode 100644 index 0000000000..73124e137f --- /dev/null +++ b/src/oci/data_science/models/create_job_run_schedule_action_details.py @@ -0,0 +1,78 @@ +# coding: utf-8 +# Copyright (c) 2016, 2025, 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: 20190101 + +from .schedule_http_action_details import ScheduleHttpActionDetails +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 CreateJobRunScheduleActionDetails(ScheduleHttpActionDetails): + """ + create job run details + """ + + def __init__(self, **kwargs): + """ + Initializes a new CreateJobRunScheduleActionDetails object with values from keyword arguments. The default value of the :py:attr:`~oci.data_science.models.CreateJobRunScheduleActionDetails.http_action_type` attribute + of this class is ``CREATE_JOB_RUN`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param http_action_type: + The value to assign to the http_action_type property of this CreateJobRunScheduleActionDetails. + Allowed values for this property are: "CREATE_JOB_RUN", "CREATE_PIPELINE_RUN", "INVOKE_ML_APPLICATION_PROVIDER_TRIGGER" + :type http_action_type: str + + :param create_job_run_details: + The value to assign to the create_job_run_details property of this CreateJobRunScheduleActionDetails. + :type create_job_run_details: oci.data_science.models.CreateJobRunDetails + + """ + self.swagger_types = { + 'http_action_type': 'str', + 'create_job_run_details': 'CreateJobRunDetails' + } + + self.attribute_map = { + 'http_action_type': 'httpActionType', + 'create_job_run_details': 'createJobRunDetails' + } + + self._http_action_type = None + self._create_job_run_details = None + self._http_action_type = 'CREATE_JOB_RUN' + + @property + def create_job_run_details(self): + """ + **[Required]** Gets the create_job_run_details of this CreateJobRunScheduleActionDetails. + + :return: The create_job_run_details of this CreateJobRunScheduleActionDetails. + :rtype: oci.data_science.models.CreateJobRunDetails + """ + return self._create_job_run_details + + @create_job_run_details.setter + def create_job_run_details(self, create_job_run_details): + """ + Sets the create_job_run_details of this CreateJobRunScheduleActionDetails. + + :param create_job_run_details: The create_job_run_details of this CreateJobRunScheduleActionDetails. + :type: oci.data_science.models.CreateJobRunDetails + """ + self._create_job_run_details = create_job_run_details + + 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/data_science/models/create_pipeline_run_schedule_action_details.py b/src/oci/data_science/models/create_pipeline_run_schedule_action_details.py new file mode 100644 index 0000000000..dea718b7c0 --- /dev/null +++ b/src/oci/data_science/models/create_pipeline_run_schedule_action_details.py @@ -0,0 +1,78 @@ +# coding: utf-8 +# Copyright (c) 2016, 2025, 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: 20190101 + +from .schedule_http_action_details import ScheduleHttpActionDetails +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 CreatePipelineRunScheduleActionDetails(ScheduleHttpActionDetails): + """ + create pipeline run details + """ + + def __init__(self, **kwargs): + """ + Initializes a new CreatePipelineRunScheduleActionDetails object with values from keyword arguments. The default value of the :py:attr:`~oci.data_science.models.CreatePipelineRunScheduleActionDetails.http_action_type` attribute + of this class is ``CREATE_PIPELINE_RUN`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param http_action_type: + The value to assign to the http_action_type property of this CreatePipelineRunScheduleActionDetails. + Allowed values for this property are: "CREATE_JOB_RUN", "CREATE_PIPELINE_RUN", "INVOKE_ML_APPLICATION_PROVIDER_TRIGGER" + :type http_action_type: str + + :param create_pipeline_run_details: + The value to assign to the create_pipeline_run_details property of this CreatePipelineRunScheduleActionDetails. + :type create_pipeline_run_details: oci.data_science.models.CreatePipelineRunDetails + + """ + self.swagger_types = { + 'http_action_type': 'str', + 'create_pipeline_run_details': 'CreatePipelineRunDetails' + } + + self.attribute_map = { + 'http_action_type': 'httpActionType', + 'create_pipeline_run_details': 'createPipelineRunDetails' + } + + self._http_action_type = None + self._create_pipeline_run_details = None + self._http_action_type = 'CREATE_PIPELINE_RUN' + + @property + def create_pipeline_run_details(self): + """ + **[Required]** Gets the create_pipeline_run_details of this CreatePipelineRunScheduleActionDetails. + + :return: The create_pipeline_run_details of this CreatePipelineRunScheduleActionDetails. + :rtype: oci.data_science.models.CreatePipelineRunDetails + """ + return self._create_pipeline_run_details + + @create_pipeline_run_details.setter + def create_pipeline_run_details(self, create_pipeline_run_details): + """ + Sets the create_pipeline_run_details of this CreatePipelineRunScheduleActionDetails. + + :param create_pipeline_run_details: The create_pipeline_run_details of this CreatePipelineRunScheduleActionDetails. + :type: oci.data_science.models.CreatePipelineRunDetails + """ + self._create_pipeline_run_details = create_pipeline_run_details + + 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/data_science/models/create_schedule_details.py b/src/oci/data_science/models/create_schedule_details.py new file mode 100644 index 0000000000..41775879b2 --- /dev/null +++ b/src/oci/data_science/models/create_schedule_details.py @@ -0,0 +1,328 @@ +# coding: utf-8 +# Copyright (c) 2016, 2025, 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: 20190101 + + +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 CreateScheduleDetails(object): + """ + Creation details for a new schedule. + """ + + def __init__(self, **kwargs): + """ + Initializes a new CreateScheduleDetails object with values from keyword arguments. + 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 CreateScheduleDetails. + :type display_name: str + + :param description: + The value to assign to the description property of this CreateScheduleDetails. + :type description: str + + :param project_id: + The value to assign to the project_id property of this CreateScheduleDetails. + :type project_id: str + + :param compartment_id: + The value to assign to the compartment_id property of this CreateScheduleDetails. + :type compartment_id: str + + :param trigger: + The value to assign to the trigger property of this CreateScheduleDetails. + :type trigger: oci.data_science.models.ScheduleTrigger + + :param action: + The value to assign to the action property of this CreateScheduleDetails. + :type action: oci.data_science.models.ScheduleAction + + :param log_details: + The value to assign to the log_details property of this CreateScheduleDetails. + :type log_details: oci.data_science.models.ScheduleLogDetails + + :param freeform_tags: + The value to assign to the freeform_tags property of this CreateScheduleDetails. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this CreateScheduleDetails. + :type defined_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'display_name': 'str', + 'description': 'str', + 'project_id': 'str', + 'compartment_id': 'str', + 'trigger': 'ScheduleTrigger', + 'action': 'ScheduleAction', + 'log_details': 'ScheduleLogDetails', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))' + } + + self.attribute_map = { + 'display_name': 'displayName', + 'description': 'description', + 'project_id': 'projectId', + 'compartment_id': 'compartmentId', + 'trigger': 'trigger', + 'action': 'action', + 'log_details': 'logDetails', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags' + } + + self._display_name = None + self._description = None + self._project_id = None + self._compartment_id = None + self._trigger = None + self._action = None + self._log_details = None + self._freeform_tags = None + self._defined_tags = None + + @property + def display_name(self): + """ + **[Required]** Gets the display_name of this CreateScheduleDetails. + A user-friendly name. Avoid entering confidential information. + + + :return: The display_name of this CreateScheduleDetails. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this CreateScheduleDetails. + A user-friendly name. Avoid entering confidential information. + + + :param display_name: The display_name of this CreateScheduleDetails. + :type: str + """ + self._display_name = display_name + + @property + def description(self): + """ + Gets the description of this CreateScheduleDetails. + A short description of the schedule. + + + :return: The description of this CreateScheduleDetails. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this CreateScheduleDetails. + A short description of the schedule. + + + :param description: The description of this CreateScheduleDetails. + :type: str + """ + self._description = description + + @property + def project_id(self): + """ + **[Required]** Gets the project_id of this CreateScheduleDetails. + The `OCID`__ of the project to associate the schedule with. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :return: The project_id of this CreateScheduleDetails. + :rtype: str + """ + return self._project_id + + @project_id.setter + def project_id(self, project_id): + """ + Sets the project_id of this CreateScheduleDetails. + The `OCID`__ of the project to associate the schedule with. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :param project_id: The project_id of this CreateScheduleDetails. + :type: str + """ + self._project_id = project_id + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this CreateScheduleDetails. + The `OCID`__ of the compartment that contains the schedule. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :return: The compartment_id of this CreateScheduleDetails. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this CreateScheduleDetails. + The `OCID`__ of the compartment that contains the schedule. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :param compartment_id: The compartment_id of this CreateScheduleDetails. + :type: str + """ + self._compartment_id = compartment_id + + @property + def trigger(self): + """ + **[Required]** Gets the trigger of this CreateScheduleDetails. + + :return: The trigger of this CreateScheduleDetails. + :rtype: oci.data_science.models.ScheduleTrigger + """ + return self._trigger + + @trigger.setter + def trigger(self, trigger): + """ + Sets the trigger of this CreateScheduleDetails. + + :param trigger: The trigger of this CreateScheduleDetails. + :type: oci.data_science.models.ScheduleTrigger + """ + self._trigger = trigger + + @property + def action(self): + """ + **[Required]** Gets the action of this CreateScheduleDetails. + + :return: The action of this CreateScheduleDetails. + :rtype: oci.data_science.models.ScheduleAction + """ + return self._action + + @action.setter + def action(self, action): + """ + Sets the action of this CreateScheduleDetails. + + :param action: The action of this CreateScheduleDetails. + :type: oci.data_science.models.ScheduleAction + """ + self._action = action + + @property + def log_details(self): + """ + Gets the log_details of this CreateScheduleDetails. + + :return: The log_details of this CreateScheduleDetails. + :rtype: oci.data_science.models.ScheduleLogDetails + """ + return self._log_details + + @log_details.setter + def log_details(self, log_details): + """ + Sets the log_details of this CreateScheduleDetails. + + :param log_details: The log_details of this CreateScheduleDetails. + :type: oci.data_science.models.ScheduleLogDetails + """ + self._log_details = log_details + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this CreateScheduleDetails. + Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See `Resource Tags`__. + Example: `{\"Department\": \"Finance\"}` + + __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm + + + :return: The freeform_tags of this CreateScheduleDetails. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this CreateScheduleDetails. + Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See `Resource Tags`__. + Example: `{\"Department\": \"Finance\"}` + + __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm + + + :param freeform_tags: The freeform_tags of this CreateScheduleDetails. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this CreateScheduleDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. See `Resource Tags`__. + Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` + + __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm + + + :return: The defined_tags of this CreateScheduleDetails. + :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 CreateScheduleDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. See `Resource Tags`__. + Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` + + __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm + + + :param defined_tags: The defined_tags of this CreateScheduleDetails. + :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/data_science/models/generic_job_run_use_case_configuration_details.py b/src/oci/data_science/models/generic_job_run_use_case_configuration_details.py new file mode 100644 index 0000000000..bc02018ee2 --- /dev/null +++ b/src/oci/data_science/models/generic_job_run_use_case_configuration_details.py @@ -0,0 +1,82 @@ +# coding: utf-8 +# Copyright (c) 2016, 2025, 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: 20190101 + +from .job_run_use_case_configuration_details import JobRunUseCaseConfigurationDetails +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 GenericJobRunUseCaseConfigurationDetails(JobRunUseCaseConfigurationDetails): + """ + The evaluation use-case configuration. + """ + + def __init__(self, **kwargs): + """ + Initializes a new GenericJobRunUseCaseConfigurationDetails object with values from keyword arguments. The default value of the :py:attr:`~oci.data_science.models.GenericJobRunUseCaseConfigurationDetails.use_case_type` attribute + of this class is ``GENERIC`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param use_case_type: + The value to assign to the use_case_type property of this GenericJobRunUseCaseConfigurationDetails. + Allowed values for this property are: "GENERIC" + :type use_case_type: str + + :param additional_configurations: + The value to assign to the additional_configurations property of this GenericJobRunUseCaseConfigurationDetails. + :type additional_configurations: dict(str, str) + + """ + self.swagger_types = { + 'use_case_type': 'str', + 'additional_configurations': 'dict(str, str)' + } + + self.attribute_map = { + 'use_case_type': 'useCaseType', + 'additional_configurations': 'additionalConfigurations' + } + + self._use_case_type = None + self._additional_configurations = None + self._use_case_type = 'GENERIC' + + @property + def additional_configurations(self): + """ + Gets the additional_configurations of this GenericJobRunUseCaseConfigurationDetails. + The additional configurations + + + :return: The additional_configurations of this GenericJobRunUseCaseConfigurationDetails. + :rtype: dict(str, str) + """ + return self._additional_configurations + + @additional_configurations.setter + def additional_configurations(self, additional_configurations): + """ + Sets the additional_configurations of this GenericJobRunUseCaseConfigurationDetails. + The additional configurations + + + :param additional_configurations: The additional_configurations of this GenericJobRunUseCaseConfigurationDetails. + :type: dict(str, str) + """ + self._additional_configurations = additional_configurations + + 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/data_science/models/invoke_ml_application_provider_trigger_schedule_action_details.py b/src/oci/data_science/models/invoke_ml_application_provider_trigger_schedule_action_details.py new file mode 100644 index 0000000000..d8292d71ee --- /dev/null +++ b/src/oci/data_science/models/invoke_ml_application_provider_trigger_schedule_action_details.py @@ -0,0 +1,113 @@ +# coding: utf-8 +# Copyright (c) 2016, 2025, 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: 20190101 + +from .schedule_http_action_details import ScheduleHttpActionDetails +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 InvokeMlApplicationProviderTriggerScheduleActionDetails(ScheduleHttpActionDetails): + """ + invoke ml application trigger details + """ + + def __init__(self, **kwargs): + """ + Initializes a new InvokeMlApplicationProviderTriggerScheduleActionDetails object with values from keyword arguments. The default value of the :py:attr:`~oci.data_science.models.InvokeMlApplicationProviderTriggerScheduleActionDetails.http_action_type` attribute + of this class is ``INVOKE_ML_APPLICATION_PROVIDER_TRIGGER`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param http_action_type: + The value to assign to the http_action_type property of this InvokeMlApplicationProviderTriggerScheduleActionDetails. + Allowed values for this property are: "CREATE_JOB_RUN", "CREATE_PIPELINE_RUN", "INVOKE_ML_APPLICATION_PROVIDER_TRIGGER" + :type http_action_type: str + + :param ml_application_instance_view_id: + The value to assign to the ml_application_instance_view_id property of this InvokeMlApplicationProviderTriggerScheduleActionDetails. + :type ml_application_instance_view_id: str + + :param trigger_ml_application_instance_view_flow_details: + The value to assign to the trigger_ml_application_instance_view_flow_details property of this InvokeMlApplicationProviderTriggerScheduleActionDetails. + :type trigger_ml_application_instance_view_flow_details: oci.data_science.models.TriggerMlApplicationInstanceViewFlowDetails + + """ + self.swagger_types = { + 'http_action_type': 'str', + 'ml_application_instance_view_id': 'str', + 'trigger_ml_application_instance_view_flow_details': 'TriggerMlApplicationInstanceViewFlowDetails' + } + + self.attribute_map = { + 'http_action_type': 'httpActionType', + 'ml_application_instance_view_id': 'mlApplicationInstanceViewId', + 'trigger_ml_application_instance_view_flow_details': 'triggerMlApplicationInstanceViewFlowDetails' + } + + self._http_action_type = None + self._ml_application_instance_view_id = None + self._trigger_ml_application_instance_view_flow_details = None + self._http_action_type = 'INVOKE_ML_APPLICATION_PROVIDER_TRIGGER' + + @property + def ml_application_instance_view_id(self): + """ + **[Required]** Gets the ml_application_instance_view_id of this InvokeMlApplicationProviderTriggerScheduleActionDetails. + The `OCID`__ of the schedule. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :return: The ml_application_instance_view_id of this InvokeMlApplicationProviderTriggerScheduleActionDetails. + :rtype: str + """ + return self._ml_application_instance_view_id + + @ml_application_instance_view_id.setter + def ml_application_instance_view_id(self, ml_application_instance_view_id): + """ + Sets the ml_application_instance_view_id of this InvokeMlApplicationProviderTriggerScheduleActionDetails. + The `OCID`__ of the schedule. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :param ml_application_instance_view_id: The ml_application_instance_view_id of this InvokeMlApplicationProviderTriggerScheduleActionDetails. + :type: str + """ + self._ml_application_instance_view_id = ml_application_instance_view_id + + @property + def trigger_ml_application_instance_view_flow_details(self): + """ + **[Required]** Gets the trigger_ml_application_instance_view_flow_details of this InvokeMlApplicationProviderTriggerScheduleActionDetails. + + :return: The trigger_ml_application_instance_view_flow_details of this InvokeMlApplicationProviderTriggerScheduleActionDetails. + :rtype: oci.data_science.models.TriggerMlApplicationInstanceViewFlowDetails + """ + return self._trigger_ml_application_instance_view_flow_details + + @trigger_ml_application_instance_view_flow_details.setter + def trigger_ml_application_instance_view_flow_details(self, trigger_ml_application_instance_view_flow_details): + """ + Sets the trigger_ml_application_instance_view_flow_details of this InvokeMlApplicationProviderTriggerScheduleActionDetails. + + :param trigger_ml_application_instance_view_flow_details: The trigger_ml_application_instance_view_flow_details of this InvokeMlApplicationProviderTriggerScheduleActionDetails. + :type: oci.data_science.models.TriggerMlApplicationInstanceViewFlowDetails + """ + self._trigger_ml_application_instance_view_flow_details = trigger_ml_application_instance_view_flow_details + + 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/data_science/models/job_run_use_case_configuration_details.py b/src/oci/data_science/models/job_run_use_case_configuration_details.py new file mode 100644 index 0000000000..2151292392 --- /dev/null +++ b/src/oci/data_science/models/job_run_use_case_configuration_details.py @@ -0,0 +1,101 @@ +# coding: utf-8 +# Copyright (c) 2016, 2025, 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: 20190101 + + +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 JobRunUseCaseConfigurationDetails(object): + """ + The use-case configuration details + """ + + #: A constant which can be used with the use_case_type property of a JobRunUseCaseConfigurationDetails. + #: This constant has a value of "GENERIC" + USE_CASE_TYPE_GENERIC = "GENERIC" + + def __init__(self, **kwargs): + """ + Initializes a new JobRunUseCaseConfigurationDetails 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.data_science.models.GenericJobRunUseCaseConfigurationDetails` + + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param use_case_type: + The value to assign to the use_case_type property of this JobRunUseCaseConfigurationDetails. + Allowed values for this property are: "GENERIC", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type use_case_type: str + + """ + self.swagger_types = { + 'use_case_type': 'str' + } + + self.attribute_map = { + 'use_case_type': 'useCaseType' + } + + self._use_case_type = 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['useCaseType'] + + if type == 'GENERIC': + return 'GenericJobRunUseCaseConfigurationDetails' + else: + return 'JobRunUseCaseConfigurationDetails' + + @property + def use_case_type(self): + """ + **[Required]** Gets the use_case_type of this JobRunUseCaseConfigurationDetails. + The job-run use-case. + + Allowed values for this property are: "GENERIC", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The use_case_type of this JobRunUseCaseConfigurationDetails. + :rtype: str + """ + return self._use_case_type + + @use_case_type.setter + def use_case_type(self, use_case_type): + """ + Sets the use_case_type of this JobRunUseCaseConfigurationDetails. + The job-run use-case. + + + :param use_case_type: The use_case_type of this JobRunUseCaseConfigurationDetails. + :type: str + """ + allowed_values = ["GENERIC"] + if not value_allowed_none_or_none_sentinel(use_case_type, allowed_values): + use_case_type = 'UNKNOWN_ENUM_VALUE' + self._use_case_type = use_case_type + + 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/data_science/models/job_run_workload_configuration_details.py b/src/oci/data_science/models/job_run_workload_configuration_details.py new file mode 100644 index 0000000000..e9730be16a --- /dev/null +++ b/src/oci/data_science/models/job_run_workload_configuration_details.py @@ -0,0 +1,78 @@ +# coding: utf-8 +# Copyright (c) 2016, 2025, 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: 20190101 + +from .workload_configuration_details import WorkloadConfigurationDetails +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 JobRunWorkloadConfigurationDetails(WorkloadConfigurationDetails): + """ + The job run workload configuration. + """ + + def __init__(self, **kwargs): + """ + Initializes a new JobRunWorkloadConfigurationDetails object with values from keyword arguments. The default value of the :py:attr:`~oci.data_science.models.JobRunWorkloadConfigurationDetails.workload_type` attribute + of this class is ``JOB_RUN`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param workload_type: + The value to assign to the workload_type property of this JobRunWorkloadConfigurationDetails. + Allowed values for this property are: "MODEL_DEPLOYMENT", "JOB_RUN" + :type workload_type: str + + :param use_case_configuration: + The value to assign to the use_case_configuration property of this JobRunWorkloadConfigurationDetails. + :type use_case_configuration: oci.data_science.models.JobRunUseCaseConfigurationDetails + + """ + self.swagger_types = { + 'workload_type': 'str', + 'use_case_configuration': 'JobRunUseCaseConfigurationDetails' + } + + self.attribute_map = { + 'workload_type': 'workloadType', + 'use_case_configuration': 'useCaseConfiguration' + } + + self._workload_type = None + self._use_case_configuration = None + self._workload_type = 'JOB_RUN' + + @property + def use_case_configuration(self): + """ + Gets the use_case_configuration of this JobRunWorkloadConfigurationDetails. + + :return: The use_case_configuration of this JobRunWorkloadConfigurationDetails. + :rtype: oci.data_science.models.JobRunUseCaseConfigurationDetails + """ + return self._use_case_configuration + + @use_case_configuration.setter + def use_case_configuration(self, use_case_configuration): + """ + Sets the use_case_configuration of this JobRunWorkloadConfigurationDetails. + + :param use_case_configuration: The use_case_configuration of this JobRunWorkloadConfigurationDetails. + :type: oci.data_science.models.JobRunUseCaseConfigurationDetails + """ + self._use_case_configuration = use_case_configuration + + 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/data_science/models/model_deploy_workload_configuration_details.py b/src/oci/data_science/models/model_deploy_workload_configuration_details.py new file mode 100644 index 0000000000..ccde3ce676 --- /dev/null +++ b/src/oci/data_science/models/model_deploy_workload_configuration_details.py @@ -0,0 +1,191 @@ +# coding: utf-8 +# Copyright (c) 2016, 2025, 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: 20190101 + +from .workload_configuration_details import WorkloadConfigurationDetails +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 ModelDeployWorkloadConfigurationDetails(WorkloadConfigurationDetails): + """ + The model deployment workload configuration. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ModelDeployWorkloadConfigurationDetails object with values from keyword arguments. The default value of the :py:attr:`~oci.data_science.models.ModelDeployWorkloadConfigurationDetails.workload_type` attribute + of this class is ``MODEL_DEPLOYMENT`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param workload_type: + The value to assign to the workload_type property of this ModelDeployWorkloadConfigurationDetails. + Allowed values for this property are: "MODEL_DEPLOYMENT", "JOB_RUN" + :type workload_type: str + + :param cmd: + The value to assign to the cmd property of this ModelDeployWorkloadConfigurationDetails. + :type cmd: str + + :param server_port: + The value to assign to the server_port property of this ModelDeployWorkloadConfigurationDetails. + :type server_port: int + + :param health_check_port: + The value to assign to the health_check_port property of this ModelDeployWorkloadConfigurationDetails. + :type health_check_port: int + + :param additional_configurations: + The value to assign to the additional_configurations property of this ModelDeployWorkloadConfigurationDetails. + :type additional_configurations: dict(str, str) + + """ + self.swagger_types = { + 'workload_type': 'str', + 'cmd': 'str', + 'server_port': 'int', + 'health_check_port': 'int', + 'additional_configurations': 'dict(str, str)' + } + + self.attribute_map = { + 'workload_type': 'workloadType', + 'cmd': 'cmd', + 'server_port': 'serverPort', + 'health_check_port': 'healthCheckPort', + 'additional_configurations': 'additionalConfigurations' + } + + self._workload_type = None + self._cmd = None + self._server_port = None + self._health_check_port = None + self._additional_configurations = None + self._workload_type = 'MODEL_DEPLOYMENT' + + @property + def cmd(self): + """ + **[Required]** Gets the cmd of this ModelDeployWorkloadConfigurationDetails. + The container image run `CMD`__ as a list of strings. + Use `CMD` as arguments to the `ENTRYPOINT` or the only command to run in the absence of an `ENTRYPOINT`. + The combined size of `CMD` and `ENTRYPOINT` must be less than 2048 bytes. + + __ https://docs.docker.com/engine/reference/builder/#cmd + + + :return: The cmd of this ModelDeployWorkloadConfigurationDetails. + :rtype: str + """ + return self._cmd + + @cmd.setter + def cmd(self, cmd): + """ + Sets the cmd of this ModelDeployWorkloadConfigurationDetails. + The container image run `CMD`__ as a list of strings. + Use `CMD` as arguments to the `ENTRYPOINT` or the only command to run in the absence of an `ENTRYPOINT`. + The combined size of `CMD` and `ENTRYPOINT` must be less than 2048 bytes. + + __ https://docs.docker.com/engine/reference/builder/#cmd + + + :param cmd: The cmd of this ModelDeployWorkloadConfigurationDetails. + :type: str + """ + self._cmd = cmd + + @property + def server_port(self): + """ + **[Required]** Gets the server_port of this ModelDeployWorkloadConfigurationDetails. + The port on which the web server serving the inference is running. + The port can be anything between `1024` and `65535`. The following ports cannot be used `24224`, `8446`, `8447`. + + + :return: The server_port of this ModelDeployWorkloadConfigurationDetails. + :rtype: int + """ + return self._server_port + + @server_port.setter + def server_port(self, server_port): + """ + Sets the server_port of this ModelDeployWorkloadConfigurationDetails. + The port on which the web server serving the inference is running. + The port can be anything between `1024` and `65535`. The following ports cannot be used `24224`, `8446`, `8447`. + + + :param server_port: The server_port of this ModelDeployWorkloadConfigurationDetails. + :type: int + """ + self._server_port = server_port + + @property + def health_check_port(self): + """ + **[Required]** Gets the health_check_port of this ModelDeployWorkloadConfigurationDetails. + The port on which the container `HEALTHCHECK`__ would listen. + The port can be anything between `1024` and `65535`. The following ports cannot be used `24224`, `8446`, `8447`. + + __ https://docs.docker.com/engine/reference/builder/#healthcheck + + + :return: The health_check_port of this ModelDeployWorkloadConfigurationDetails. + :rtype: int + """ + return self._health_check_port + + @health_check_port.setter + def health_check_port(self, health_check_port): + """ + Sets the health_check_port of this ModelDeployWorkloadConfigurationDetails. + The port on which the container `HEALTHCHECK`__ would listen. + The port can be anything between `1024` and `65535`. The following ports cannot be used `24224`, `8446`, `8447`. + + __ https://docs.docker.com/engine/reference/builder/#healthcheck + + + :param health_check_port: The health_check_port of this ModelDeployWorkloadConfigurationDetails. + :type: int + """ + self._health_check_port = health_check_port + + @property + def additional_configurations(self): + """ + Gets the additional_configurations of this ModelDeployWorkloadConfigurationDetails. + The additional configurations + + + :return: The additional_configurations of this ModelDeployWorkloadConfigurationDetails. + :rtype: dict(str, str) + """ + return self._additional_configurations + + @additional_configurations.setter + def additional_configurations(self, additional_configurations): + """ + Sets the additional_configurations of this ModelDeployWorkloadConfigurationDetails. + The additional configurations + + + :param additional_configurations: The additional_configurations of this ModelDeployWorkloadConfigurationDetails. + :type: dict(str, str) + """ + self._additional_configurations = additional_configurations + + 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/data_science/models/schedule.py b/src/oci/data_science/models/schedule.py new file mode 100644 index 0000000000..4e9ac81711 --- /dev/null +++ b/src/oci/data_science/models/schedule.py @@ -0,0 +1,706 @@ +# coding: utf-8 +# Copyright (c) 2016, 2025, 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: 20190101 + + +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 Schedule(object): + """ + A repeating action. Examples: + * Invoke a ML Pipeline Run once an hour. + * Call ML Job Run every night at midnight. + """ + + #: A constant which can be used with the lifecycle_state property of a Schedule. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + #: A constant which can be used with the lifecycle_state property of a Schedule. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a Schedule. + #: This constant has a value of "INACTIVE" + LIFECYCLE_STATE_INACTIVE = "INACTIVE" + + #: A constant which can be used with the lifecycle_state property of a Schedule. + #: This constant has a value of "UPDATING" + LIFECYCLE_STATE_UPDATING = "UPDATING" + + #: A constant which can be used with the lifecycle_state property of a Schedule. + #: This constant has a value of "DELETING" + LIFECYCLE_STATE_DELETING = "DELETING" + + #: A constant which can be used with the lifecycle_state property of a Schedule. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" + + #: A constant which can be used with the lifecycle_state property of a Schedule. + #: This constant has a value of "FAILED" + LIFECYCLE_STATE_FAILED = "FAILED" + + def __init__(self, **kwargs): + """ + Initializes a new Schedule 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 Schedule. + :type id: str + + :param compartment_id: + The value to assign to the compartment_id property of this Schedule. + :type compartment_id: str + + :param project_id: + The value to assign to the project_id property of this Schedule. + :type project_id: str + + :param display_name: + The value to assign to the display_name property of this Schedule. + :type display_name: str + + :param description: + The value to assign to the description property of this Schedule. + :type description: str + + :param time_last_schedule_run: + The value to assign to the time_last_schedule_run property of this Schedule. + :type time_last_schedule_run: datetime + + :param time_next_scheduled_run: + The value to assign to the time_next_scheduled_run property of this Schedule. + :type time_next_scheduled_run: datetime + + :param time_created: + The value to assign to the time_created property of this Schedule. + :type time_created: datetime + + :param time_updated: + The value to assign to the time_updated property of this Schedule. + :type time_updated: datetime + + :param created_by: + The value to assign to the created_by property of this Schedule. + :type created_by: str + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this Schedule. + 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 + + :param lifecycle_details: + The value to assign to the lifecycle_details property of this Schedule. + :type lifecycle_details: str + + :param last_schedule_run_details: + The value to assign to the last_schedule_run_details property of this Schedule. + :type last_schedule_run_details: str + + :param trigger: + The value to assign to the trigger property of this Schedule. + :type trigger: oci.data_science.models.ScheduleTrigger + + :param action: + The value to assign to the action property of this Schedule. + :type action: oci.data_science.models.ScheduleAction + + :param log_details: + The value to assign to the log_details property of this Schedule. + :type log_details: oci.data_science.models.ScheduleLogDetails + + :param freeform_tags: + The value to assign to the freeform_tags property of this Schedule. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this Schedule. + :type defined_tags: dict(str, dict(str, object)) + + :param system_tags: + The value to assign to the system_tags property of this Schedule. + :type system_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'id': 'str', + 'compartment_id': 'str', + 'project_id': 'str', + 'display_name': 'str', + 'description': 'str', + 'time_last_schedule_run': 'datetime', + 'time_next_scheduled_run': 'datetime', + 'time_created': 'datetime', + 'time_updated': 'datetime', + 'created_by': 'str', + 'lifecycle_state': 'str', + 'lifecycle_details': 'str', + 'last_schedule_run_details': 'str', + 'trigger': 'ScheduleTrigger', + 'action': 'ScheduleAction', + 'log_details': 'ScheduleLogDetails', + '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', + 'project_id': 'projectId', + 'display_name': 'displayName', + 'description': 'description', + 'time_last_schedule_run': 'timeLastScheduleRun', + 'time_next_scheduled_run': 'timeNextScheduledRun', + 'time_created': 'timeCreated', + 'time_updated': 'timeUpdated', + 'created_by': 'createdBy', + 'lifecycle_state': 'lifecycleState', + 'lifecycle_details': 'lifecycleDetails', + 'last_schedule_run_details': 'lastScheduleRunDetails', + 'trigger': 'trigger', + 'action': 'action', + 'log_details': 'logDetails', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags', + 'system_tags': 'systemTags' + } + + self._id = None + self._compartment_id = None + self._project_id = None + self._display_name = None + self._description = None + self._time_last_schedule_run = None + self._time_next_scheduled_run = None + self._time_created = None + self._time_updated = None + self._created_by = None + self._lifecycle_state = None + self._lifecycle_details = None + self._last_schedule_run_details = None + self._trigger = None + self._action = None + self._log_details = None + self._freeform_tags = None + self._defined_tags = None + self._system_tags = None + + @property + def id(self): + """ + **[Required]** Gets the id of this Schedule. + The `OCID`__ of the schedule. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :return: The id of this Schedule. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this Schedule. + The `OCID`__ of the schedule. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :param id: The id of this Schedule. + :type: str + """ + self._id = id + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this Schedule. + The `OCID`__ of the compartment where you want to create the schedule. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :return: The compartment_id of this Schedule. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this Schedule. + The `OCID`__ of the compartment where you want to create the schedule. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :param compartment_id: The compartment_id of this Schedule. + :type: str + """ + self._compartment_id = compartment_id + + @property + def project_id(self): + """ + **[Required]** Gets the project_id of this Schedule. + The `OCID`__ of the project associated with the schedule. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :return: The project_id of this Schedule. + :rtype: str + """ + return self._project_id + + @project_id.setter + def project_id(self, project_id): + """ + Sets the project_id of this Schedule. + The `OCID`__ of the project associated with the schedule. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :param project_id: The project_id of this Schedule. + :type: str + """ + self._project_id = project_id + + @property + def display_name(self): + """ + **[Required]** Gets the display_name of this Schedule. + A user-friendly display name for the resource. Avoid entering confidential information. + + + :return: The display_name of this Schedule. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this Schedule. + A user-friendly display name for the resource. Avoid entering confidential information. + + + :param display_name: The display_name of this Schedule. + :type: str + """ + self._display_name = display_name + + @property + def description(self): + """ + Gets the description of this Schedule. + A short description of the schedule. + + + :return: The description of this Schedule. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this Schedule. + A short description of the schedule. + + + :param description: The description of this Schedule. + :type: str + """ + self._description = description + + @property + def time_last_schedule_run(self): + """ + Gets the time_last_schedule_run of this Schedule. + The last schedule execution time. + Format is defined by RFC3339. + Example: `2022-08-05T01:02:29.600Z` + + + :return: The time_last_schedule_run of this Schedule. + :rtype: datetime + """ + return self._time_last_schedule_run + + @time_last_schedule_run.setter + def time_last_schedule_run(self, time_last_schedule_run): + """ + Sets the time_last_schedule_run of this Schedule. + The last schedule execution time. + Format is defined by RFC3339. + Example: `2022-08-05T01:02:29.600Z` + + + :param time_last_schedule_run: The time_last_schedule_run of this Schedule. + :type: datetime + """ + self._time_last_schedule_run = time_last_schedule_run + + @property + def time_next_scheduled_run(self): + """ + Gets the time_next_scheduled_run of this Schedule. + The next scheduled execution time for the schedule. + Format is defined by RFC3339. + Example: `2022-08-05T01:02:29.600Z` + + + :return: The time_next_scheduled_run of this Schedule. + :rtype: datetime + """ + return self._time_next_scheduled_run + + @time_next_scheduled_run.setter + def time_next_scheduled_run(self, time_next_scheduled_run): + """ + Sets the time_next_scheduled_run of this Schedule. + The next scheduled execution time for the schedule. + Format is defined by RFC3339. + Example: `2022-08-05T01:02:29.600Z` + + + :param time_next_scheduled_run: The time_next_scheduled_run of this Schedule. + :type: datetime + """ + self._time_next_scheduled_run = time_next_scheduled_run + + @property + def time_created(self): + """ + **[Required]** Gets the time_created of this Schedule. + The date and time the schedule was created. + Format is defined by RFC3339. + Example: `2022-08-05T01:02:29.600Z` + + + :return: The time_created of this Schedule. + :rtype: datetime + """ + return self._time_created + + @time_created.setter + def time_created(self, time_created): + """ + Sets the time_created of this Schedule. + The date and time the schedule was created. + Format is defined by RFC3339. + Example: `2022-08-05T01:02:29.600Z` + + + :param time_created: The time_created of this Schedule. + :type: datetime + """ + self._time_created = time_created + + @property + def time_updated(self): + """ + Gets the time_updated of this Schedule. + The date and time the schedule was updated. + Format is defined by RFC3339. + Example: `2022-09-05T01:02:29.600Z` + + + :return: The time_updated of this Schedule. + :rtype: datetime + """ + return self._time_updated + + @time_updated.setter + def time_updated(self, time_updated): + """ + Sets the time_updated of this Schedule. + The date and time the schedule was updated. + Format is defined by RFC3339. + Example: `2022-09-05T01:02:29.600Z` + + + :param time_updated: The time_updated of this Schedule. + :type: datetime + """ + self._time_updated = time_updated + + @property + def created_by(self): + """ + **[Required]** Gets the created_by of this Schedule. + The `OCID`__ of the user who created the schedule. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :return: The created_by of this Schedule. + :rtype: str + """ + return self._created_by + + @created_by.setter + def created_by(self, created_by): + """ + Sets the created_by of this Schedule. + The `OCID`__ of the user who created the schedule. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :param created_by: The created_by of this Schedule. + :type: str + """ + self._created_by = created_by + + @property + def lifecycle_state(self): + """ + **[Required]** Gets the lifecycle_state of this Schedule. + The current state of the schedule. + Example: `ACTIVE` + + 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'. + + + :return: The lifecycle_state of this Schedule. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this Schedule. + The current state of the schedule. + Example: `ACTIVE` + + + :param lifecycle_state: The lifecycle_state of this Schedule. + :type: str + """ + 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 + + @property + def lifecycle_details(self): + """ + Gets the lifecycle_details of this Schedule. + A message describing the current state in more detail. + + + :return: The lifecycle_details of this Schedule. + :rtype: str + """ + return self._lifecycle_details + + @lifecycle_details.setter + def lifecycle_details(self, lifecycle_details): + """ + Sets the lifecycle_details of this Schedule. + A message describing the current state in more detail. + + + :param lifecycle_details: The lifecycle_details of this Schedule. + :type: str + """ + self._lifecycle_details = lifecycle_details + + @property + def last_schedule_run_details(self): + """ + Gets the last_schedule_run_details of this Schedule. + Details about the action performed by the last schedule execution. + Example: `Invoked ML Application trigger.` + + + :return: The last_schedule_run_details of this Schedule. + :rtype: str + """ + return self._last_schedule_run_details + + @last_schedule_run_details.setter + def last_schedule_run_details(self, last_schedule_run_details): + """ + Sets the last_schedule_run_details of this Schedule. + Details about the action performed by the last schedule execution. + Example: `Invoked ML Application trigger.` + + + :param last_schedule_run_details: The last_schedule_run_details of this Schedule. + :type: str + """ + self._last_schedule_run_details = last_schedule_run_details + + @property + def trigger(self): + """ + **[Required]** Gets the trigger of this Schedule. + + :return: The trigger of this Schedule. + :rtype: oci.data_science.models.ScheduleTrigger + """ + return self._trigger + + @trigger.setter + def trigger(self, trigger): + """ + Sets the trigger of this Schedule. + + :param trigger: The trigger of this Schedule. + :type: oci.data_science.models.ScheduleTrigger + """ + self._trigger = trigger + + @property + def action(self): + """ + **[Required]** Gets the action of this Schedule. + + :return: The action of this Schedule. + :rtype: oci.data_science.models.ScheduleAction + """ + return self._action + + @action.setter + def action(self, action): + """ + Sets the action of this Schedule. + + :param action: The action of this Schedule. + :type: oci.data_science.models.ScheduleAction + """ + self._action = action + + @property + def log_details(self): + """ + Gets the log_details of this Schedule. + + :return: The log_details of this Schedule. + :rtype: oci.data_science.models.ScheduleLogDetails + """ + return self._log_details + + @log_details.setter + def log_details(self, log_details): + """ + Sets the log_details of this Schedule. + + :param log_details: The log_details of this Schedule. + :type: oci.data_science.models.ScheduleLogDetails + """ + self._log_details = log_details + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this Schedule. + Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See `Resource Tags`__. + Example: `{\"Department\": \"Finance\"}` + + __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm + + + :return: The freeform_tags of this Schedule. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this Schedule. + Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See `Resource Tags`__. + Example: `{\"Department\": \"Finance\"}` + + __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm + + + :param freeform_tags: The freeform_tags of this Schedule. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this Schedule. + Defined tags for this resource. Each key is predefined and scoped to a namespace. See `Resource Tags`__. + Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` + + __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm + + + :return: The defined_tags of this Schedule. + :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 Schedule. + Defined tags for this resource. Each key is predefined and scoped to a namespace. See `Resource Tags`__. + Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` + + __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm + + + :param defined_tags: The defined_tags of this Schedule. + :type: dict(str, dict(str, object)) + """ + self._defined_tags = defined_tags + + @property + def system_tags(self): + """ + Gets the system_tags of this Schedule. + 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 Schedule. + :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 Schedule. + 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 Schedule. + :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/data_science/models/schedule_action.py b/src/oci/data_science/models/schedule_action.py new file mode 100644 index 0000000000..b8c55d4f31 --- /dev/null +++ b/src/oci/data_science/models/schedule_action.py @@ -0,0 +1,101 @@ +# coding: utf-8 +# Copyright (c) 2016, 2025, 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: 20190101 + + +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 ScheduleAction(object): + """ + The schedule action + """ + + #: A constant which can be used with the action_type property of a ScheduleAction. + #: This constant has a value of "HTTP" + ACTION_TYPE_HTTP = "HTTP" + + def __init__(self, **kwargs): + """ + Initializes a new ScheduleAction 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.data_science.models.ScheduleHttpAction` + + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param action_type: + The value to assign to the action_type property of this ScheduleAction. + Allowed values for this property are: "HTTP", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type action_type: str + + """ + self.swagger_types = { + 'action_type': 'str' + } + + self.attribute_map = { + 'action_type': 'actionType' + } + + self._action_type = 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['actionType'] + + if type == 'HTTP': + return 'ScheduleHttpAction' + else: + return 'ScheduleAction' + + @property + def action_type(self): + """ + **[Required]** Gets the action_type of this ScheduleAction. + The Schedule Action type + + Allowed values for this property are: "HTTP", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The action_type of this ScheduleAction. + :rtype: str + """ + return self._action_type + + @action_type.setter + def action_type(self, action_type): + """ + Sets the action_type of this ScheduleAction. + The Schedule Action type + + + :param action_type: The action_type of this ScheduleAction. + :type: str + """ + allowed_values = ["HTTP"] + if not value_allowed_none_or_none_sentinel(action_type, allowed_values): + action_type = 'UNKNOWN_ENUM_VALUE' + self._action_type = action_type + + 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/data_science/models/schedule_cron_trigger.py b/src/oci/data_science/models/schedule_cron_trigger.py new file mode 100644 index 0000000000..bdc65ddce2 --- /dev/null +++ b/src/oci/data_science/models/schedule_cron_trigger.py @@ -0,0 +1,96 @@ +# coding: utf-8 +# Copyright (c) 2016, 2025, 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: 20190101 + +from .schedule_trigger import ScheduleTrigger +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 ScheduleCronTrigger(ScheduleTrigger): + """ + The scheduled UNIX cron definition. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ScheduleCronTrigger object with values from keyword arguments. The default value of the :py:attr:`~oci.data_science.models.ScheduleCronTrigger.trigger_type` attribute + of this class is ``CRON`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param trigger_type: + The value to assign to the trigger_type property of this ScheduleCronTrigger. + Allowed values for this property are: "CRON", "INTERVAL", "ICAL" + :type trigger_type: str + + :param time_start: + The value to assign to the time_start property of this ScheduleCronTrigger. + :type time_start: datetime + + :param time_end: + The value to assign to the time_end property of this ScheduleCronTrigger. + :type time_end: datetime + + :param cron_expression: + The value to assign to the cron_expression property of this ScheduleCronTrigger. + :type cron_expression: str + + """ + self.swagger_types = { + 'trigger_type': 'str', + 'time_start': 'datetime', + 'time_end': 'datetime', + 'cron_expression': 'str' + } + + self.attribute_map = { + 'trigger_type': 'triggerType', + 'time_start': 'timeStart', + 'time_end': 'timeEnd', + 'cron_expression': 'cronExpression' + } + + self._trigger_type = None + self._time_start = None + self._time_end = None + self._cron_expression = None + self._trigger_type = 'CRON' + + @property + def cron_expression(self): + """ + **[Required]** Gets the cron_expression of this ScheduleCronTrigger. + Schedule cron expression + + + :return: The cron_expression of this ScheduleCronTrigger. + :rtype: str + """ + return self._cron_expression + + @cron_expression.setter + def cron_expression(self, cron_expression): + """ + Sets the cron_expression of this ScheduleCronTrigger. + Schedule cron expression + + + :param cron_expression: The cron_expression of this ScheduleCronTrigger. + :type: str + """ + self._cron_expression = cron_expression + + 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/data_science/models/schedule_http_action.py b/src/oci/data_science/models/schedule_http_action.py new file mode 100644 index 0000000000..9a94e99abe --- /dev/null +++ b/src/oci/data_science/models/schedule_http_action.py @@ -0,0 +1,78 @@ +# coding: utf-8 +# Copyright (c) 2016, 2025, 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: 20190101 + +from .schedule_action import ScheduleAction +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 ScheduleHttpAction(ScheduleAction): + """ + this is HTTP action + """ + + def __init__(self, **kwargs): + """ + Initializes a new ScheduleHttpAction object with values from keyword arguments. The default value of the :py:attr:`~oci.data_science.models.ScheduleHttpAction.action_type` attribute + of this class is ``HTTP`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param action_type: + The value to assign to the action_type property of this ScheduleHttpAction. + Allowed values for this property are: "HTTP" + :type action_type: str + + :param action_details: + The value to assign to the action_details property of this ScheduleHttpAction. + :type action_details: oci.data_science.models.ScheduleHttpActionDetails + + """ + self.swagger_types = { + 'action_type': 'str', + 'action_details': 'ScheduleHttpActionDetails' + } + + self.attribute_map = { + 'action_type': 'actionType', + 'action_details': 'actionDetails' + } + + self._action_type = None + self._action_details = None + self._action_type = 'HTTP' + + @property + def action_details(self): + """ + **[Required]** Gets the action_details of this ScheduleHttpAction. + + :return: The action_details of this ScheduleHttpAction. + :rtype: oci.data_science.models.ScheduleHttpActionDetails + """ + return self._action_details + + @action_details.setter + def action_details(self, action_details): + """ + Sets the action_details of this ScheduleHttpAction. + + :param action_details: The action_details of this ScheduleHttpAction. + :type: oci.data_science.models.ScheduleHttpActionDetails + """ + self._action_details = action_details + + 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/data_science/models/schedule_http_action_details.py b/src/oci/data_science/models/schedule_http_action_details.py new file mode 100644 index 0000000000..2d5a75d47d --- /dev/null +++ b/src/oci/data_science/models/schedule_http_action_details.py @@ -0,0 +1,117 @@ +# coding: utf-8 +# Copyright (c) 2016, 2025, 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: 20190101 + + +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 ScheduleHttpActionDetails(object): + """ + Schedule Http action details + """ + + #: A constant which can be used with the http_action_type property of a ScheduleHttpActionDetails. + #: This constant has a value of "CREATE_JOB_RUN" + HTTP_ACTION_TYPE_CREATE_JOB_RUN = "CREATE_JOB_RUN" + + #: A constant which can be used with the http_action_type property of a ScheduleHttpActionDetails. + #: This constant has a value of "CREATE_PIPELINE_RUN" + HTTP_ACTION_TYPE_CREATE_PIPELINE_RUN = "CREATE_PIPELINE_RUN" + + #: A constant which can be used with the http_action_type property of a ScheduleHttpActionDetails. + #: This constant has a value of "INVOKE_ML_APPLICATION_PROVIDER_TRIGGER" + HTTP_ACTION_TYPE_INVOKE_ML_APPLICATION_PROVIDER_TRIGGER = "INVOKE_ML_APPLICATION_PROVIDER_TRIGGER" + + def __init__(self, **kwargs): + """ + Initializes a new ScheduleHttpActionDetails 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.data_science.models.CreateJobRunScheduleActionDetails` + * :class:`~oci.data_science.models.InvokeMlApplicationProviderTriggerScheduleActionDetails` + * :class:`~oci.data_science.models.CreatePipelineRunScheduleActionDetails` + + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param http_action_type: + The value to assign to the http_action_type property of this ScheduleHttpActionDetails. + Allowed values for this property are: "CREATE_JOB_RUN", "CREATE_PIPELINE_RUN", "INVOKE_ML_APPLICATION_PROVIDER_TRIGGER", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type http_action_type: str + + """ + self.swagger_types = { + 'http_action_type': 'str' + } + + self.attribute_map = { + 'http_action_type': 'httpActionType' + } + + self._http_action_type = 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['httpActionType'] + + if type == 'CREATE_JOB_RUN': + return 'CreateJobRunScheduleActionDetails' + + if type == 'INVOKE_ML_APPLICATION_PROVIDER_TRIGGER': + return 'InvokeMlApplicationProviderTriggerScheduleActionDetails' + + if type == 'CREATE_PIPELINE_RUN': + return 'CreatePipelineRunScheduleActionDetails' + else: + return 'ScheduleHttpActionDetails' + + @property + def http_action_type(self): + """ + **[Required]** Gets the http_action_type of this ScheduleHttpActionDetails. + The type of http action to trigger. + + Allowed values for this property are: "CREATE_JOB_RUN", "CREATE_PIPELINE_RUN", "INVOKE_ML_APPLICATION_PROVIDER_TRIGGER", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The http_action_type of this ScheduleHttpActionDetails. + :rtype: str + """ + return self._http_action_type + + @http_action_type.setter + def http_action_type(self, http_action_type): + """ + Sets the http_action_type of this ScheduleHttpActionDetails. + The type of http action to trigger. + + + :param http_action_type: The http_action_type of this ScheduleHttpActionDetails. + :type: str + """ + allowed_values = ["CREATE_JOB_RUN", "CREATE_PIPELINE_RUN", "INVOKE_ML_APPLICATION_PROVIDER_TRIGGER"] + if not value_allowed_none_or_none_sentinel(http_action_type, allowed_values): + http_action_type = 'UNKNOWN_ENUM_VALUE' + self._http_action_type = http_action_type + + 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/data_science/models/schedule_i_cal_trigger.py b/src/oci/data_science/models/schedule_i_cal_trigger.py new file mode 100644 index 0000000000..d414ac06df --- /dev/null +++ b/src/oci/data_science/models/schedule_i_cal_trigger.py @@ -0,0 +1,96 @@ +# coding: utf-8 +# Copyright (c) 2016, 2025, 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: 20190101 + +from .schedule_trigger import ScheduleTrigger +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 ScheduleICalTrigger(ScheduleTrigger): + """ + The iCal schedule trigger. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ScheduleICalTrigger object with values from keyword arguments. The default value of the :py:attr:`~oci.data_science.models.ScheduleICalTrigger.trigger_type` attribute + of this class is ``ICAL`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param trigger_type: + The value to assign to the trigger_type property of this ScheduleICalTrigger. + Allowed values for this property are: "CRON", "INTERVAL", "ICAL" + :type trigger_type: str + + :param time_start: + The value to assign to the time_start property of this ScheduleICalTrigger. + :type time_start: datetime + + :param time_end: + The value to assign to the time_end property of this ScheduleICalTrigger. + :type time_end: datetime + + :param recurrence: + The value to assign to the recurrence property of this ScheduleICalTrigger. + :type recurrence: str + + """ + self.swagger_types = { + 'trigger_type': 'str', + 'time_start': 'datetime', + 'time_end': 'datetime', + 'recurrence': 'str' + } + + self.attribute_map = { + 'trigger_type': 'triggerType', + 'time_start': 'timeStart', + 'time_end': 'timeEnd', + 'recurrence': 'recurrence' + } + + self._trigger_type = None + self._time_start = None + self._time_end = None + self._recurrence = None + self._trigger_type = 'ICAL' + + @property + def recurrence(self): + """ + **[Required]** Gets the recurrence of this ScheduleICalTrigger. + This recurrence field conforms to RFC-5545 formatting + + + :return: The recurrence of this ScheduleICalTrigger. + :rtype: str + """ + return self._recurrence + + @recurrence.setter + def recurrence(self, recurrence): + """ + Sets the recurrence of this ScheduleICalTrigger. + This recurrence field conforms to RFC-5545 formatting + + + :param recurrence: The recurrence of this ScheduleICalTrigger. + :type: str + """ + self._recurrence = recurrence + + 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/data_science/models/schedule_interval_trigger.py b/src/oci/data_science/models/schedule_interval_trigger.py new file mode 100644 index 0000000000..02e8c649ed --- /dev/null +++ b/src/oci/data_science/models/schedule_interval_trigger.py @@ -0,0 +1,177 @@ +# coding: utf-8 +# Copyright (c) 2016, 2025, 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: 20190101 + +from .schedule_trigger import ScheduleTrigger +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 ScheduleIntervalTrigger(ScheduleTrigger): + """ + The interval schedule trigger. + """ + + #: A constant which can be used with the frequency property of a ScheduleIntervalTrigger. + #: This constant has a value of "HOURLY" + FREQUENCY_HOURLY = "HOURLY" + + #: A constant which can be used with the frequency property of a ScheduleIntervalTrigger. + #: This constant has a value of "DAILY" + FREQUENCY_DAILY = "DAILY" + + def __init__(self, **kwargs): + """ + Initializes a new ScheduleIntervalTrigger object with values from keyword arguments. The default value of the :py:attr:`~oci.data_science.models.ScheduleIntervalTrigger.trigger_type` attribute + of this class is ``INTERVAL`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param trigger_type: + The value to assign to the trigger_type property of this ScheduleIntervalTrigger. + Allowed values for this property are: "CRON", "INTERVAL", "ICAL", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type trigger_type: str + + :param time_start: + The value to assign to the time_start property of this ScheduleIntervalTrigger. + :type time_start: datetime + + :param time_end: + The value to assign to the time_end property of this ScheduleIntervalTrigger. + :type time_end: datetime + + :param frequency: + The value to assign to the frequency property of this ScheduleIntervalTrigger. + Allowed values for this property are: "HOURLY", "DAILY", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type frequency: str + + :param interval: + The value to assign to the interval property of this ScheduleIntervalTrigger. + :type interval: int + + :param is_random_start_time: + The value to assign to the is_random_start_time property of this ScheduleIntervalTrigger. + :type is_random_start_time: bool + + """ + self.swagger_types = { + 'trigger_type': 'str', + 'time_start': 'datetime', + 'time_end': 'datetime', + 'frequency': 'str', + 'interval': 'int', + 'is_random_start_time': 'bool' + } + + self.attribute_map = { + 'trigger_type': 'triggerType', + 'time_start': 'timeStart', + 'time_end': 'timeEnd', + 'frequency': 'frequency', + 'interval': 'interval', + 'is_random_start_time': 'isRandomStartTime' + } + + self._trigger_type = None + self._time_start = None + self._time_end = None + self._frequency = None + self._interval = None + self._is_random_start_time = None + self._trigger_type = 'INTERVAL' + + @property + def frequency(self): + """ + **[Required]** Gets the frequency of this ScheduleIntervalTrigger. + The type of frequency + + Allowed values for this property are: "HOURLY", "DAILY", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The frequency of this ScheduleIntervalTrigger. + :rtype: str + """ + return self._frequency + + @frequency.setter + def frequency(self, frequency): + """ + Sets the frequency of this ScheduleIntervalTrigger. + The type of frequency + + + :param frequency: The frequency of this ScheduleIntervalTrigger. + :type: str + """ + allowed_values = ["HOURLY", "DAILY"] + if not value_allowed_none_or_none_sentinel(frequency, allowed_values): + frequency = 'UNKNOWN_ENUM_VALUE' + self._frequency = frequency + + @property + def interval(self): + """ + **[Required]** Gets the interval of this ScheduleIntervalTrigger. + The interval of frequency. + + + :return: The interval of this ScheduleIntervalTrigger. + :rtype: int + """ + return self._interval + + @interval.setter + def interval(self, interval): + """ + Sets the interval of this ScheduleIntervalTrigger. + The interval of frequency. + + + :param interval: The interval of this ScheduleIntervalTrigger. + :type: int + """ + self._interval = interval + + @property + def is_random_start_time(self): + """ + Gets the is_random_start_time of this ScheduleIntervalTrigger. + when true and timeStart is null, system generate a random start time between now and now + interval; + isRandomStartTime can be true if timeStart is null. + + + :return: The is_random_start_time of this ScheduleIntervalTrigger. + :rtype: bool + """ + return self._is_random_start_time + + @is_random_start_time.setter + def is_random_start_time(self, is_random_start_time): + """ + Sets the is_random_start_time of this ScheduleIntervalTrigger. + when true and timeStart is null, system generate a random start time between now and now + interval; + isRandomStartTime can be true if timeStart is null. + + + :param is_random_start_time: The is_random_start_time of this ScheduleIntervalTrigger. + :type: bool + """ + self._is_random_start_time = is_random_start_time + + 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/data_science/models/schedule_log_details.py b/src/oci/data_science/models/schedule_log_details.py new file mode 100644 index 0000000000..965a74a4c8 --- /dev/null +++ b/src/oci/data_science/models/schedule_log_details.py @@ -0,0 +1,111 @@ +# coding: utf-8 +# Copyright (c) 2016, 2025, 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: 20190101 + + +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 ScheduleLogDetails(object): + """ + Custom logging details for schedule execution. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ScheduleLogDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param log_group_id: + The value to assign to the log_group_id property of this ScheduleLogDetails. + :type log_group_id: str + + :param log_id: + The value to assign to the log_id property of this ScheduleLogDetails. + :type log_id: str + + """ + self.swagger_types = { + 'log_group_id': 'str', + 'log_id': 'str' + } + + self.attribute_map = { + 'log_group_id': 'logGroupId', + 'log_id': 'logId' + } + + self._log_group_id = None + self._log_id = None + + @property + def log_group_id(self): + """ + **[Required]** Gets the log_group_id of this ScheduleLogDetails. + The `OCID`__ of the log group. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :return: The log_group_id of this ScheduleLogDetails. + :rtype: str + """ + return self._log_group_id + + @log_group_id.setter + def log_group_id(self, log_group_id): + """ + Sets the log_group_id of this ScheduleLogDetails. + The `OCID`__ of the log group. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :param log_group_id: The log_group_id of this ScheduleLogDetails. + :type: str + """ + self._log_group_id = log_group_id + + @property + def log_id(self): + """ + **[Required]** Gets the log_id of this ScheduleLogDetails. + The `OCID`__ of the custom log to be used for Schedule logging. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :return: The log_id of this ScheduleLogDetails. + :rtype: str + """ + return self._log_id + + @log_id.setter + def log_id(self, log_id): + """ + Sets the log_id of this ScheduleLogDetails. + The `OCID`__ of the custom log to be used for Schedule logging. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :param log_id: The log_id of this ScheduleLogDetails. + :type: str + """ + self._log_id = log_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/data_science/models/schedule_summary.py b/src/oci/data_science/models/schedule_summary.py new file mode 100644 index 0000000000..ac4a971be1 --- /dev/null +++ b/src/oci/data_science/models/schedule_summary.py @@ -0,0 +1,485 @@ +# coding: utf-8 +# Copyright (c) 2016, 2025, 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: 20190101 + + +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 ScheduleSummary(object): + """ + Summary representation of a schedule. + """ + + #: A constant which can be used with the lifecycle_state property of a ScheduleSummary. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + #: A constant which can be used with the lifecycle_state property of a ScheduleSummary. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a ScheduleSummary. + #: This constant has a value of "INACTIVE" + LIFECYCLE_STATE_INACTIVE = "INACTIVE" + + #: A constant which can be used with the lifecycle_state property of a ScheduleSummary. + #: This constant has a value of "UPDATING" + LIFECYCLE_STATE_UPDATING = "UPDATING" + + #: A constant which can be used with the lifecycle_state property of a ScheduleSummary. + #: This constant has a value of "DELETING" + LIFECYCLE_STATE_DELETING = "DELETING" + + #: A constant which can be used with the lifecycle_state property of a ScheduleSummary. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" + + #: A constant which can be used with the lifecycle_state property of a ScheduleSummary. + #: This constant has a value of "FAILED" + LIFECYCLE_STATE_FAILED = "FAILED" + + def __init__(self, **kwargs): + """ + Initializes a new ScheduleSummary 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 ScheduleSummary. + :type id: str + + :param display_name: + The value to assign to the display_name property of this ScheduleSummary. + :type display_name: str + + :param compartment_id: + The value to assign to the compartment_id property of this ScheduleSummary. + :type compartment_id: str + + :param project_id: + The value to assign to the project_id property of this ScheduleSummary. + :type project_id: str + + :param trigger: + The value to assign to the trigger property of this ScheduleSummary. + :type trigger: oci.data_science.models.ScheduleTrigger + + :param time_created: + The value to assign to the time_created property of this ScheduleSummary. + :type time_created: datetime + + :param time_updated: + The value to assign to the time_updated property of this ScheduleSummary. + :type time_updated: datetime + + :param created_by: + The value to assign to the created_by property of this ScheduleSummary. + :type created_by: str + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this ScheduleSummary. + 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 + + :param freeform_tags: + The value to assign to the freeform_tags property of this ScheduleSummary. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this ScheduleSummary. + :type defined_tags: dict(str, dict(str, object)) + + :param system_tags: + The value to assign to the system_tags property of this ScheduleSummary. + :type system_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'id': 'str', + 'display_name': 'str', + 'compartment_id': 'str', + 'project_id': 'str', + 'trigger': 'ScheduleTrigger', + 'time_created': 'datetime', + 'time_updated': 'datetime', + 'created_by': 'str', + 'lifecycle_state': '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', + 'display_name': 'displayName', + 'compartment_id': 'compartmentId', + 'project_id': 'projectId', + 'trigger': 'trigger', + 'time_created': 'timeCreated', + 'time_updated': 'timeUpdated', + 'created_by': 'createdBy', + 'lifecycle_state': 'lifecycleState', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags', + 'system_tags': 'systemTags' + } + + self._id = None + self._display_name = None + self._compartment_id = None + self._project_id = None + self._trigger = None + self._time_created = None + self._time_updated = None + self._created_by = None + self._lifecycle_state = None + self._freeform_tags = None + self._defined_tags = None + self._system_tags = None + + @property + def id(self): + """ + **[Required]** Gets the id of this ScheduleSummary. + The `OCID`__ of the schedule. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :return: The id of this ScheduleSummary. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this ScheduleSummary. + The `OCID`__ of the schedule. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :param id: The id of this ScheduleSummary. + :type: str + """ + self._id = id + + @property + def display_name(self): + """ + **[Required]** Gets the display_name of this ScheduleSummary. + The name of the schedule. + + + :return: The display_name of this ScheduleSummary. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this ScheduleSummary. + The name of the schedule. + + + :param display_name: The display_name of this ScheduleSummary. + :type: str + """ + self._display_name = display_name + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this ScheduleSummary. + The `OCID`__ of the compartment that contains the schedule. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :return: The compartment_id of this ScheduleSummary. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this ScheduleSummary. + The `OCID`__ of the compartment that contains the schedule. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :param compartment_id: The compartment_id of this ScheduleSummary. + :type: str + """ + self._compartment_id = compartment_id + + @property + def project_id(self): + """ + **[Required]** Gets the project_id of this ScheduleSummary. + The `OCID`__ of the project associated with the schedule. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :return: The project_id of this ScheduleSummary. + :rtype: str + """ + return self._project_id + + @project_id.setter + def project_id(self, project_id): + """ + Sets the project_id of this ScheduleSummary. + The `OCID`__ of the project associated with the schedule. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :param project_id: The project_id of this ScheduleSummary. + :type: str + """ + self._project_id = project_id + + @property + def trigger(self): + """ + **[Required]** Gets the trigger of this ScheduleSummary. + + :return: The trigger of this ScheduleSummary. + :rtype: oci.data_science.models.ScheduleTrigger + """ + return self._trigger + + @trigger.setter + def trigger(self, trigger): + """ + Sets the trigger of this ScheduleSummary. + + :param trigger: The trigger of this ScheduleSummary. + :type: oci.data_science.models.ScheduleTrigger + """ + self._trigger = trigger + + @property + def time_created(self): + """ + **[Required]** Gets the time_created of this ScheduleSummary. + The date and time the schedule was created. + Format is defined by RFC3339. + Example: `2022-08-05T01:02:29.600Z` + + + :return: The time_created of this ScheduleSummary. + :rtype: datetime + """ + return self._time_created + + @time_created.setter + def time_created(self, time_created): + """ + Sets the time_created of this ScheduleSummary. + The date and time the schedule was created. + Format is defined by RFC3339. + Example: `2022-08-05T01:02:29.600Z` + + + :param time_created: The time_created of this ScheduleSummary. + :type: datetime + """ + self._time_created = time_created + + @property + def time_updated(self): + """ + Gets the time_updated of this ScheduleSummary. + The date and time the schedule was updated. + Format is defined by RFC3339. + Example: `2022-08-05T01:02:29.600Z` + + + :return: The time_updated of this ScheduleSummary. + :rtype: datetime + """ + return self._time_updated + + @time_updated.setter + def time_updated(self, time_updated): + """ + Sets the time_updated of this ScheduleSummary. + The date and time the schedule was updated. + Format is defined by RFC3339. + Example: `2022-08-05T01:02:29.600Z` + + + :param time_updated: The time_updated of this ScheduleSummary. + :type: datetime + """ + self._time_updated = time_updated + + @property + def created_by(self): + """ + **[Required]** Gets the created_by of this ScheduleSummary. + The `OCID`__ of the user who created the schedule. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :return: The created_by of this ScheduleSummary. + :rtype: str + """ + return self._created_by + + @created_by.setter + def created_by(self, created_by): + """ + Sets the created_by of this ScheduleSummary. + The `OCID`__ of the user who created the schedule. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :param created_by: The created_by of this ScheduleSummary. + :type: str + """ + self._created_by = created_by + + @property + def lifecycle_state(self): + """ + **[Required]** Gets the lifecycle_state of this ScheduleSummary. + The current state of the schedule. + Example: `ACTIVE` + + 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'. + + + :return: The lifecycle_state of this ScheduleSummary. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this ScheduleSummary. + The current state of the schedule. + Example: `ACTIVE` + + + :param lifecycle_state: The lifecycle_state of this ScheduleSummary. + :type: str + """ + 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 + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this ScheduleSummary. + Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See `Resource Tags`__. + Example: `{\"Department\": \"Finance\"}` + + __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm + + + :return: The freeform_tags of this ScheduleSummary. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this ScheduleSummary. + Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See `Resource Tags`__. + Example: `{\"Department\": \"Finance\"}` + + __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm + + + :param freeform_tags: The freeform_tags of this ScheduleSummary. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this ScheduleSummary. + Defined tags for this resource. Each key is predefined and scoped to a namespace. See `Resource Tags`__. + Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` + + __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm + + + :return: The defined_tags of this ScheduleSummary. + :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 ScheduleSummary. + Defined tags for this resource. Each key is predefined and scoped to a namespace. See `Resource Tags`__. + Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` + + __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm + + + :param defined_tags: The defined_tags of this ScheduleSummary. + :type: dict(str, dict(str, object)) + """ + self._defined_tags = defined_tags + + @property + def system_tags(self): + """ + Gets the system_tags of this ScheduleSummary. + 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 ScheduleSummary. + :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 ScheduleSummary. + 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 ScheduleSummary. + :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/data_science/models/schedule_trigger.py b/src/oci/data_science/models/schedule_trigger.py new file mode 100644 index 0000000000..4e2b583f70 --- /dev/null +++ b/src/oci/data_science/models/schedule_trigger.py @@ -0,0 +1,191 @@ +# coding: utf-8 +# Copyright (c) 2016, 2025, 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: 20190101 + + +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 ScheduleTrigger(object): + """ + The trigger of the schedule can be UNIX cron or iCal expression or simple interval + """ + + #: A constant which can be used with the trigger_type property of a ScheduleTrigger. + #: This constant has a value of "CRON" + TRIGGER_TYPE_CRON = "CRON" + + #: A constant which can be used with the trigger_type property of a ScheduleTrigger. + #: This constant has a value of "INTERVAL" + TRIGGER_TYPE_INTERVAL = "INTERVAL" + + #: A constant which can be used with the trigger_type property of a ScheduleTrigger. + #: This constant has a value of "ICAL" + TRIGGER_TYPE_ICAL = "ICAL" + + def __init__(self, **kwargs): + """ + Initializes a new ScheduleTrigger 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.data_science.models.ScheduleICalTrigger` + * :class:`~oci.data_science.models.ScheduleIntervalTrigger` + * :class:`~oci.data_science.models.ScheduleCronTrigger` + + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param trigger_type: + The value to assign to the trigger_type property of this ScheduleTrigger. + Allowed values for this property are: "CRON", "INTERVAL", "ICAL", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type trigger_type: str + + :param time_start: + The value to assign to the time_start property of this ScheduleTrigger. + :type time_start: datetime + + :param time_end: + The value to assign to the time_end property of this ScheduleTrigger. + :type time_end: datetime + + """ + self.swagger_types = { + 'trigger_type': 'str', + 'time_start': 'datetime', + 'time_end': 'datetime' + } + + self.attribute_map = { + 'trigger_type': 'triggerType', + 'time_start': 'timeStart', + 'time_end': 'timeEnd' + } + + self._trigger_type = None + self._time_start = None + self._time_end = 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['triggerType'] + + if type == 'ICAL': + return 'ScheduleICalTrigger' + + if type == 'INTERVAL': + return 'ScheduleIntervalTrigger' + + if type == 'CRON': + return 'ScheduleCronTrigger' + else: + return 'ScheduleTrigger' + + @property + def trigger_type(self): + """ + **[Required]** Gets the trigger_type of this ScheduleTrigger. + The schedule trigger type + + Allowed values for this property are: "CRON", "INTERVAL", "ICAL", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The trigger_type of this ScheduleTrigger. + :rtype: str + """ + return self._trigger_type + + @trigger_type.setter + def trigger_type(self, trigger_type): + """ + Sets the trigger_type of this ScheduleTrigger. + The schedule trigger type + + + :param trigger_type: The trigger_type of this ScheduleTrigger. + :type: str + """ + allowed_values = ["CRON", "INTERVAL", "ICAL"] + if not value_allowed_none_or_none_sentinel(trigger_type, allowed_values): + trigger_type = 'UNKNOWN_ENUM_VALUE' + self._trigger_type = trigger_type + + @property + def time_start(self): + """ + Gets the time_start of this ScheduleTrigger. + The schedule starting date time, if null, System set the time when schedule is created. + Format is defined by `RFC3339`__. + + __ https://tools.ietf.org/html/rfc3339 + + + :return: The time_start of this ScheduleTrigger. + :rtype: datetime + """ + return self._time_start + + @time_start.setter + def time_start(self, time_start): + """ + Sets the time_start of this ScheduleTrigger. + The schedule starting date time, if null, System set the time when schedule is created. + Format is defined by `RFC3339`__. + + __ https://tools.ietf.org/html/rfc3339 + + + :param time_start: The time_start of this ScheduleTrigger. + :type: datetime + """ + self._time_start = time_start + + @property + def time_end(self): + """ + Gets the time_end of this ScheduleTrigger. + The schedule end date time, if null, the schedule will never expire. + Format is defined by `RFC3339`__. + + __ https://tools.ietf.org/html/rfc3339 + + + :return: The time_end of this ScheduleTrigger. + :rtype: datetime + """ + return self._time_end + + @time_end.setter + def time_end(self, time_end): + """ + Sets the time_end of this ScheduleTrigger. + The schedule end date time, if null, the schedule will never expire. + Format is defined by `RFC3339`__. + + __ https://tools.ietf.org/html/rfc3339 + + + :param time_end: The time_end of this ScheduleTrigger. + :type: datetime + """ + self._time_end = time_end + + 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/data_science/models/tag_configuration.py b/src/oci/data_science/models/tag_configuration.py new file mode 100644 index 0000000000..3e913ba709 --- /dev/null +++ b/src/oci/data_science/models/tag_configuration.py @@ -0,0 +1,103 @@ +# coding: utf-8 +# Copyright (c) 2016, 2025, 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: 20190101 + + +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 TagConfiguration(object): + """ + Defines properties of each container tag metadata. + """ + + def __init__(self, **kwargs): + """ + Initializes a new TagConfiguration object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param key: + The value to assign to the key property of this TagConfiguration. + :type key: str + + :param value: + The value to assign to the value property of this TagConfiguration. + :type value: str + + """ + self.swagger_types = { + 'key': 'str', + 'value': 'str' + } + + self.attribute_map = { + 'key': 'key', + 'value': 'value' + } + + self._key = None + self._value = None + + @property + def key(self): + """ + Gets the key of this TagConfiguration. + Key of the container tag Metadata + + + :return: The key of this TagConfiguration. + :rtype: str + """ + return self._key + + @key.setter + def key(self, key): + """ + Sets the key of this TagConfiguration. + Key of the container tag Metadata + + + :param key: The key of this TagConfiguration. + :type: str + """ + self._key = key + + @property + def value(self): + """ + Gets the value of this TagConfiguration. + Value of the container tag Metadata + + + :return: The value of this TagConfiguration. + :rtype: str + """ + return self._value + + @value.setter + def value(self, value): + """ + Sets the value of this TagConfiguration. + Value of the container tag Metadata + + + :param value: The value of this TagConfiguration. + :type: str + """ + self._value = value + + 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/data_science/models/trigger_ml_application_instance_view_flow_details.py b/src/oci/data_science/models/trigger_ml_application_instance_view_flow_details.py new file mode 100644 index 0000000000..df6128adbb --- /dev/null +++ b/src/oci/data_science/models/trigger_ml_application_instance_view_flow_details.py @@ -0,0 +1,103 @@ +# coding: utf-8 +# Copyright (c) 2016, 2025, 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: 20190101 + + +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 TriggerMlApplicationInstanceViewFlowDetails(object): + """ + Payload for trigger request endpoint + """ + + def __init__(self, **kwargs): + """ + Initializes a new TriggerMlApplicationInstanceViewFlowDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param trigger_name: + The value to assign to the trigger_name property of this TriggerMlApplicationInstanceViewFlowDetails. + :type trigger_name: str + + :param parameters: + The value to assign to the parameters property of this TriggerMlApplicationInstanceViewFlowDetails. + :type parameters: list[oci.data_science.models.TriggerParameter] + + """ + self.swagger_types = { + 'trigger_name': 'str', + 'parameters': 'list[TriggerParameter]' + } + + self.attribute_map = { + 'trigger_name': 'triggerName', + 'parameters': 'parameters' + } + + self._trigger_name = None + self._parameters = None + + @property + def trigger_name(self): + """ + **[Required]** Gets the trigger_name of this TriggerMlApplicationInstanceViewFlowDetails. + Name of trigger + + + :return: The trigger_name of this TriggerMlApplicationInstanceViewFlowDetails. + :rtype: str + """ + return self._trigger_name + + @trigger_name.setter + def trigger_name(self, trigger_name): + """ + Sets the trigger_name of this TriggerMlApplicationInstanceViewFlowDetails. + Name of trigger + + + :param trigger_name: The trigger_name of this TriggerMlApplicationInstanceViewFlowDetails. + :type: str + """ + self._trigger_name = trigger_name + + @property + def parameters(self): + """ + Gets the parameters of this TriggerMlApplicationInstanceViewFlowDetails. + Parameters provided for given trigger invocation (they must match predefined schema) + + + :return: The parameters of this TriggerMlApplicationInstanceViewFlowDetails. + :rtype: list[oci.data_science.models.TriggerParameter] + """ + return self._parameters + + @parameters.setter + def parameters(self, parameters): + """ + Sets the parameters of this TriggerMlApplicationInstanceViewFlowDetails. + Parameters provided for given trigger invocation (they must match predefined schema) + + + :param parameters: The parameters of this TriggerMlApplicationInstanceViewFlowDetails. + :type: list[oci.data_science.models.TriggerParameter] + """ + self._parameters = parameters + + 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/data_science/models/trigger_parameter.py b/src/oci/data_science/models/trigger_parameter.py new file mode 100644 index 0000000000..c6ba71df2d --- /dev/null +++ b/src/oci/data_science/models/trigger_parameter.py @@ -0,0 +1,103 @@ +# coding: utf-8 +# Copyright (c) 2016, 2025, 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: 20190101 + + +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 TriggerParameter(object): + """ + Trigger parameter + """ + + def __init__(self, **kwargs): + """ + Initializes a new TriggerParameter object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param name: + The value to assign to the name property of this TriggerParameter. + :type name: str + + :param value: + The value to assign to the value property of this TriggerParameter. + :type value: str + + """ + self.swagger_types = { + 'name': 'str', + 'value': 'str' + } + + self.attribute_map = { + 'name': 'name', + 'value': 'value' + } + + self._name = None + self._value = None + + @property + def name(self): + """ + **[Required]** Gets the name of this TriggerParameter. + Name of trigger parameter + + + :return: The name of this TriggerParameter. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this TriggerParameter. + Name of trigger parameter + + + :param name: The name of this TriggerParameter. + :type: str + """ + self._name = name + + @property + def value(self): + """ + **[Required]** Gets the value of this TriggerParameter. + Value of trigger parameter + + + :return: The value of this TriggerParameter. + :rtype: str + """ + return self._value + + @value.setter + def value(self, value): + """ + Sets the value of this TriggerParameter. + Value of trigger parameter + + + :param value: The value of this TriggerParameter. + :type: str + """ + self._value = value + + 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/data_science/models/update_schedule_details.py b/src/oci/data_science/models/update_schedule_details.py new file mode 100644 index 0000000000..148bdfb46a --- /dev/null +++ b/src/oci/data_science/models/update_schedule_details.py @@ -0,0 +1,258 @@ +# coding: utf-8 +# Copyright (c) 2016, 2025, 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: 20190101 + + +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 UpdateScheduleDetails(object): + """ + Update details for a schedule. + """ + + def __init__(self, **kwargs): + """ + Initializes a new UpdateScheduleDetails object with values from keyword arguments. + 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 UpdateScheduleDetails. + :type display_name: str + + :param description: + The value to assign to the description property of this UpdateScheduleDetails. + :type description: str + + :param trigger: + The value to assign to the trigger property of this UpdateScheduleDetails. + :type trigger: oci.data_science.models.ScheduleTrigger + + :param action: + The value to assign to the action property of this UpdateScheduleDetails. + :type action: oci.data_science.models.ScheduleAction + + :param log_details: + The value to assign to the log_details property of this UpdateScheduleDetails. + :type log_details: oci.data_science.models.ScheduleLogDetails + + :param freeform_tags: + The value to assign to the freeform_tags property of this UpdateScheduleDetails. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this UpdateScheduleDetails. + :type defined_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'display_name': 'str', + 'description': 'str', + 'trigger': 'ScheduleTrigger', + 'action': 'ScheduleAction', + 'log_details': 'ScheduleLogDetails', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))' + } + + self.attribute_map = { + 'display_name': 'displayName', + 'description': 'description', + 'trigger': 'trigger', + 'action': 'action', + 'log_details': 'logDetails', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags' + } + + self._display_name = None + self._description = None + self._trigger = None + self._action = None + self._log_details = None + self._freeform_tags = None + self._defined_tags = None + + @property + def display_name(self): + """ + Gets the display_name of this UpdateScheduleDetails. + A user-friendly name. Avoid entering confidential information. + + + :return: The display_name of this UpdateScheduleDetails. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this UpdateScheduleDetails. + A user-friendly name. Avoid entering confidential information. + + + :param display_name: The display_name of this UpdateScheduleDetails. + :type: str + """ + self._display_name = display_name + + @property + def description(self): + """ + Gets the description of this UpdateScheduleDetails. + A short description of the schedule. + + + :return: The description of this UpdateScheduleDetails. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this UpdateScheduleDetails. + A short description of the schedule. + + + :param description: The description of this UpdateScheduleDetails. + :type: str + """ + self._description = description + + @property + def trigger(self): + """ + Gets the trigger of this UpdateScheduleDetails. + + :return: The trigger of this UpdateScheduleDetails. + :rtype: oci.data_science.models.ScheduleTrigger + """ + return self._trigger + + @trigger.setter + def trigger(self, trigger): + """ + Sets the trigger of this UpdateScheduleDetails. + + :param trigger: The trigger of this UpdateScheduleDetails. + :type: oci.data_science.models.ScheduleTrigger + """ + self._trigger = trigger + + @property + def action(self): + """ + Gets the action of this UpdateScheduleDetails. + + :return: The action of this UpdateScheduleDetails. + :rtype: oci.data_science.models.ScheduleAction + """ + return self._action + + @action.setter + def action(self, action): + """ + Sets the action of this UpdateScheduleDetails. + + :param action: The action of this UpdateScheduleDetails. + :type: oci.data_science.models.ScheduleAction + """ + self._action = action + + @property + def log_details(self): + """ + Gets the log_details of this UpdateScheduleDetails. + + :return: The log_details of this UpdateScheduleDetails. + :rtype: oci.data_science.models.ScheduleLogDetails + """ + return self._log_details + + @log_details.setter + def log_details(self, log_details): + """ + Sets the log_details of this UpdateScheduleDetails. + + :param log_details: The log_details of this UpdateScheduleDetails. + :type: oci.data_science.models.ScheduleLogDetails + """ + self._log_details = log_details + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this UpdateScheduleDetails. + Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See `Resource Tags`__. + Example: `{\"Department\": \"Finance\"}` + + __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm + + + :return: The freeform_tags of this UpdateScheduleDetails. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this UpdateScheduleDetails. + Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See `Resource Tags`__. + Example: `{\"Department\": \"Finance\"}` + + __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm + + + :param freeform_tags: The freeform_tags of this UpdateScheduleDetails. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this UpdateScheduleDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. See `Resource Tags`__. + Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` + + __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm + + + :return: The defined_tags of this UpdateScheduleDetails. + :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 UpdateScheduleDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. See `Resource Tags`__. + Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` + + __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm + + + :param defined_tags: The defined_tags of this UpdateScheduleDetails. + :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/data_science/models/work_request.py b/src/oci/data_science/models/work_request.py index e61db779b0..4f506475ff 100644 --- a/src/oci/data_science/models/work_request.py +++ b/src/oci/data_science/models/work_request.py @@ -111,6 +111,30 @@ class WorkRequest(object): #: This constant has a value of "PRIVATE_ENDPOINT_UPDATE" OPERATION_TYPE_PRIVATE_ENDPOINT_UPDATE = "PRIVATE_ENDPOINT_UPDATE" + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "SCHEDULE_CREATE" + OPERATION_TYPE_SCHEDULE_CREATE = "SCHEDULE_CREATE" + + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "SCHEDULE_UPDATE" + OPERATION_TYPE_SCHEDULE_UPDATE = "SCHEDULE_UPDATE" + + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "SCHEDULE_DELETE" + OPERATION_TYPE_SCHEDULE_DELETE = "SCHEDULE_DELETE" + + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "SCHEDULE_MOVE" + OPERATION_TYPE_SCHEDULE_MOVE = "SCHEDULE_MOVE" + + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "SCHEDULE_ACTIVATE" + OPERATION_TYPE_SCHEDULE_ACTIVATE = "SCHEDULE_ACTIVATE" + + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "SCHEDULE_DEACTIVATE" + OPERATION_TYPE_SCHEDULE_DEACTIVATE = "SCHEDULE_DEACTIVATE" + #: A constant which can be used with the operation_type property of a WorkRequest. #: This constant has a value of "RESTORE_ARCHIVED_MODEL" OPERATION_TYPE_RESTORE_ARCHIVED_MODEL = "RESTORE_ARCHIVED_MODEL" @@ -150,7 +174,7 @@ def __init__(self, **kwargs): :param operation_type: The value to assign to the operation_type property of this WorkRequest. - Allowed values for this property are: "NOTEBOOK_SESSION_CREATE", "NOTEBOOK_SESSION_DELETE", "NOTEBOOK_SESSION_ACTIVATE", "NOTEBOOK_SESSION_DEACTIVATE", "MODELVERSIONSET_DELETE", "EXPORT_MODEL_ARTIFACT", "IMPORT_MODEL_ARTIFACT", "MODEL_DEPLOYMENT_CREATE", "MODEL_DEPLOYMENT_DELETE", "MODEL_DEPLOYMENT_ACTIVATE", "MODEL_DEPLOYMENT_DEACTIVATE", "MODEL_DEPLOYMENT_UPDATE", "PROJECT_DELETE", "WORKREQUEST_CANCEL", "JOB_DELETE", "PIPELINE_CREATE", "PIPELINE_DELETE", "PIPELINE_RUN_CREATE", "PIPELINE_RUN_CANCEL", "PIPELINE_RUN_DELETE", "PRIVATE_ENDPOINT_CREATE", "PRIVATE_ENDPOINT_DELETE", "PRIVATE_ENDPOINT_MOVE", "PRIVATE_ENDPOINT_UPDATE", "RESTORE_ARCHIVED_MODEL", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "NOTEBOOK_SESSION_CREATE", "NOTEBOOK_SESSION_DELETE", "NOTEBOOK_SESSION_ACTIVATE", "NOTEBOOK_SESSION_DEACTIVATE", "MODELVERSIONSET_DELETE", "EXPORT_MODEL_ARTIFACT", "IMPORT_MODEL_ARTIFACT", "MODEL_DEPLOYMENT_CREATE", "MODEL_DEPLOYMENT_DELETE", "MODEL_DEPLOYMENT_ACTIVATE", "MODEL_DEPLOYMENT_DEACTIVATE", "MODEL_DEPLOYMENT_UPDATE", "PROJECT_DELETE", "WORKREQUEST_CANCEL", "JOB_DELETE", "PIPELINE_CREATE", "PIPELINE_DELETE", "PIPELINE_RUN_CREATE", "PIPELINE_RUN_CANCEL", "PIPELINE_RUN_DELETE", "PRIVATE_ENDPOINT_CREATE", "PRIVATE_ENDPOINT_DELETE", "PRIVATE_ENDPOINT_MOVE", "PRIVATE_ENDPOINT_UPDATE", "SCHEDULE_CREATE", "SCHEDULE_UPDATE", "SCHEDULE_DELETE", "SCHEDULE_MOVE", "SCHEDULE_ACTIVATE", "SCHEDULE_DEACTIVATE", "RESTORE_ARCHIVED_MODEL", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type operation_type: str @@ -253,7 +277,7 @@ def operation_type(self): **[Required]** Gets the operation_type of this WorkRequest. The type of work the work request is doing. - Allowed values for this property are: "NOTEBOOK_SESSION_CREATE", "NOTEBOOK_SESSION_DELETE", "NOTEBOOK_SESSION_ACTIVATE", "NOTEBOOK_SESSION_DEACTIVATE", "MODELVERSIONSET_DELETE", "EXPORT_MODEL_ARTIFACT", "IMPORT_MODEL_ARTIFACT", "MODEL_DEPLOYMENT_CREATE", "MODEL_DEPLOYMENT_DELETE", "MODEL_DEPLOYMENT_ACTIVATE", "MODEL_DEPLOYMENT_DEACTIVATE", "MODEL_DEPLOYMENT_UPDATE", "PROJECT_DELETE", "WORKREQUEST_CANCEL", "JOB_DELETE", "PIPELINE_CREATE", "PIPELINE_DELETE", "PIPELINE_RUN_CREATE", "PIPELINE_RUN_CANCEL", "PIPELINE_RUN_DELETE", "PRIVATE_ENDPOINT_CREATE", "PRIVATE_ENDPOINT_DELETE", "PRIVATE_ENDPOINT_MOVE", "PRIVATE_ENDPOINT_UPDATE", "RESTORE_ARCHIVED_MODEL", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "NOTEBOOK_SESSION_CREATE", "NOTEBOOK_SESSION_DELETE", "NOTEBOOK_SESSION_ACTIVATE", "NOTEBOOK_SESSION_DEACTIVATE", "MODELVERSIONSET_DELETE", "EXPORT_MODEL_ARTIFACT", "IMPORT_MODEL_ARTIFACT", "MODEL_DEPLOYMENT_CREATE", "MODEL_DEPLOYMENT_DELETE", "MODEL_DEPLOYMENT_ACTIVATE", "MODEL_DEPLOYMENT_DEACTIVATE", "MODEL_DEPLOYMENT_UPDATE", "PROJECT_DELETE", "WORKREQUEST_CANCEL", "JOB_DELETE", "PIPELINE_CREATE", "PIPELINE_DELETE", "PIPELINE_RUN_CREATE", "PIPELINE_RUN_CANCEL", "PIPELINE_RUN_DELETE", "PRIVATE_ENDPOINT_CREATE", "PRIVATE_ENDPOINT_DELETE", "PRIVATE_ENDPOINT_MOVE", "PRIVATE_ENDPOINT_UPDATE", "SCHEDULE_CREATE", "SCHEDULE_UPDATE", "SCHEDULE_DELETE", "SCHEDULE_MOVE", "SCHEDULE_ACTIVATE", "SCHEDULE_DEACTIVATE", "RESTORE_ARCHIVED_MODEL", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -272,7 +296,7 @@ def operation_type(self, operation_type): :param operation_type: The operation_type of this WorkRequest. :type: str """ - allowed_values = ["NOTEBOOK_SESSION_CREATE", "NOTEBOOK_SESSION_DELETE", "NOTEBOOK_SESSION_ACTIVATE", "NOTEBOOK_SESSION_DEACTIVATE", "MODELVERSIONSET_DELETE", "EXPORT_MODEL_ARTIFACT", "IMPORT_MODEL_ARTIFACT", "MODEL_DEPLOYMENT_CREATE", "MODEL_DEPLOYMENT_DELETE", "MODEL_DEPLOYMENT_ACTIVATE", "MODEL_DEPLOYMENT_DEACTIVATE", "MODEL_DEPLOYMENT_UPDATE", "PROJECT_DELETE", "WORKREQUEST_CANCEL", "JOB_DELETE", "PIPELINE_CREATE", "PIPELINE_DELETE", "PIPELINE_RUN_CREATE", "PIPELINE_RUN_CANCEL", "PIPELINE_RUN_DELETE", "PRIVATE_ENDPOINT_CREATE", "PRIVATE_ENDPOINT_DELETE", "PRIVATE_ENDPOINT_MOVE", "PRIVATE_ENDPOINT_UPDATE", "RESTORE_ARCHIVED_MODEL"] + allowed_values = ["NOTEBOOK_SESSION_CREATE", "NOTEBOOK_SESSION_DELETE", "NOTEBOOK_SESSION_ACTIVATE", "NOTEBOOK_SESSION_DEACTIVATE", "MODELVERSIONSET_DELETE", "EXPORT_MODEL_ARTIFACT", "IMPORT_MODEL_ARTIFACT", "MODEL_DEPLOYMENT_CREATE", "MODEL_DEPLOYMENT_DELETE", "MODEL_DEPLOYMENT_ACTIVATE", "MODEL_DEPLOYMENT_DEACTIVATE", "MODEL_DEPLOYMENT_UPDATE", "PROJECT_DELETE", "WORKREQUEST_CANCEL", "JOB_DELETE", "PIPELINE_CREATE", "PIPELINE_DELETE", "PIPELINE_RUN_CREATE", "PIPELINE_RUN_CANCEL", "PIPELINE_RUN_DELETE", "PRIVATE_ENDPOINT_CREATE", "PRIVATE_ENDPOINT_DELETE", "PRIVATE_ENDPOINT_MOVE", "PRIVATE_ENDPOINT_UPDATE", "SCHEDULE_CREATE", "SCHEDULE_UPDATE", "SCHEDULE_DELETE", "SCHEDULE_MOVE", "SCHEDULE_ACTIVATE", "SCHEDULE_DEACTIVATE", "RESTORE_ARCHIVED_MODEL"] if not value_allowed_none_or_none_sentinel(operation_type, allowed_values): operation_type = 'UNKNOWN_ENUM_VALUE' self._operation_type = operation_type diff --git a/src/oci/data_science/models/work_request_summary.py b/src/oci/data_science/models/work_request_summary.py index 4108497396..89f799fb9d 100644 --- a/src/oci/data_science/models/work_request_summary.py +++ b/src/oci/data_science/models/work_request_summary.py @@ -111,6 +111,30 @@ class WorkRequestSummary(object): #: This constant has a value of "PRIVATE_ENDPOINT_UPDATE" OPERATION_TYPE_PRIVATE_ENDPOINT_UPDATE = "PRIVATE_ENDPOINT_UPDATE" + #: A constant which can be used with the operation_type property of a WorkRequestSummary. + #: This constant has a value of "SCHEDULE_CREATE" + OPERATION_TYPE_SCHEDULE_CREATE = "SCHEDULE_CREATE" + + #: A constant which can be used with the operation_type property of a WorkRequestSummary. + #: This constant has a value of "SCHEDULE_UPDATE" + OPERATION_TYPE_SCHEDULE_UPDATE = "SCHEDULE_UPDATE" + + #: A constant which can be used with the operation_type property of a WorkRequestSummary. + #: This constant has a value of "SCHEDULE_DELETE" + OPERATION_TYPE_SCHEDULE_DELETE = "SCHEDULE_DELETE" + + #: A constant which can be used with the operation_type property of a WorkRequestSummary. + #: This constant has a value of "SCHEDULE_MOVE" + OPERATION_TYPE_SCHEDULE_MOVE = "SCHEDULE_MOVE" + + #: A constant which can be used with the operation_type property of a WorkRequestSummary. + #: This constant has a value of "SCHEDULE_ACTIVATE" + OPERATION_TYPE_SCHEDULE_ACTIVATE = "SCHEDULE_ACTIVATE" + + #: A constant which can be used with the operation_type property of a WorkRequestSummary. + #: This constant has a value of "SCHEDULE_DEACTIVATE" + OPERATION_TYPE_SCHEDULE_DEACTIVATE = "SCHEDULE_DEACTIVATE" + #: A constant which can be used with the operation_type property of a WorkRequestSummary. #: This constant has a value of "RESTORE_ARCHIVED_MODEL" OPERATION_TYPE_RESTORE_ARCHIVED_MODEL = "RESTORE_ARCHIVED_MODEL" @@ -150,7 +174,7 @@ def __init__(self, **kwargs): :param operation_type: The value to assign to the operation_type property of this WorkRequestSummary. - Allowed values for this property are: "NOTEBOOK_SESSION_CREATE", "NOTEBOOK_SESSION_DELETE", "NOTEBOOK_SESSION_ACTIVATE", "NOTEBOOK_SESSION_DEACTIVATE", "MODELVERSIONSET_DELETE", "EXPORT_MODEL_ARTIFACT", "IMPORT_MODEL_ARTIFACT", "MODEL_DEPLOYMENT_CREATE", "MODEL_DEPLOYMENT_DELETE", "MODEL_DEPLOYMENT_ACTIVATE", "MODEL_DEPLOYMENT_DEACTIVATE", "MODEL_DEPLOYMENT_UPDATE", "PROJECT_DELETE", "WORKREQUEST_CANCEL", "JOB_DELETE", "PIPELINE_CREATE", "PIPELINE_DELETE", "PIPELINE_RUN_CREATE", "PIPELINE_RUN_CANCEL", "PIPELINE_RUN_DELETE", "PRIVATE_ENDPOINT_CREATE", "PRIVATE_ENDPOINT_DELETE", "PRIVATE_ENDPOINT_MOVE", "PRIVATE_ENDPOINT_UPDATE", "RESTORE_ARCHIVED_MODEL", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "NOTEBOOK_SESSION_CREATE", "NOTEBOOK_SESSION_DELETE", "NOTEBOOK_SESSION_ACTIVATE", "NOTEBOOK_SESSION_DEACTIVATE", "MODELVERSIONSET_DELETE", "EXPORT_MODEL_ARTIFACT", "IMPORT_MODEL_ARTIFACT", "MODEL_DEPLOYMENT_CREATE", "MODEL_DEPLOYMENT_DELETE", "MODEL_DEPLOYMENT_ACTIVATE", "MODEL_DEPLOYMENT_DEACTIVATE", "MODEL_DEPLOYMENT_UPDATE", "PROJECT_DELETE", "WORKREQUEST_CANCEL", "JOB_DELETE", "PIPELINE_CREATE", "PIPELINE_DELETE", "PIPELINE_RUN_CREATE", "PIPELINE_RUN_CANCEL", "PIPELINE_RUN_DELETE", "PRIVATE_ENDPOINT_CREATE", "PRIVATE_ENDPOINT_DELETE", "PRIVATE_ENDPOINT_MOVE", "PRIVATE_ENDPOINT_UPDATE", "SCHEDULE_CREATE", "SCHEDULE_UPDATE", "SCHEDULE_DELETE", "SCHEDULE_MOVE", "SCHEDULE_ACTIVATE", "SCHEDULE_DEACTIVATE", "RESTORE_ARCHIVED_MODEL", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type operation_type: str @@ -253,7 +277,7 @@ def operation_type(self): **[Required]** Gets the operation_type of this WorkRequestSummary. The type of work the work request is doing. - Allowed values for this property are: "NOTEBOOK_SESSION_CREATE", "NOTEBOOK_SESSION_DELETE", "NOTEBOOK_SESSION_ACTIVATE", "NOTEBOOK_SESSION_DEACTIVATE", "MODELVERSIONSET_DELETE", "EXPORT_MODEL_ARTIFACT", "IMPORT_MODEL_ARTIFACT", "MODEL_DEPLOYMENT_CREATE", "MODEL_DEPLOYMENT_DELETE", "MODEL_DEPLOYMENT_ACTIVATE", "MODEL_DEPLOYMENT_DEACTIVATE", "MODEL_DEPLOYMENT_UPDATE", "PROJECT_DELETE", "WORKREQUEST_CANCEL", "JOB_DELETE", "PIPELINE_CREATE", "PIPELINE_DELETE", "PIPELINE_RUN_CREATE", "PIPELINE_RUN_CANCEL", "PIPELINE_RUN_DELETE", "PRIVATE_ENDPOINT_CREATE", "PRIVATE_ENDPOINT_DELETE", "PRIVATE_ENDPOINT_MOVE", "PRIVATE_ENDPOINT_UPDATE", "RESTORE_ARCHIVED_MODEL", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "NOTEBOOK_SESSION_CREATE", "NOTEBOOK_SESSION_DELETE", "NOTEBOOK_SESSION_ACTIVATE", "NOTEBOOK_SESSION_DEACTIVATE", "MODELVERSIONSET_DELETE", "EXPORT_MODEL_ARTIFACT", "IMPORT_MODEL_ARTIFACT", "MODEL_DEPLOYMENT_CREATE", "MODEL_DEPLOYMENT_DELETE", "MODEL_DEPLOYMENT_ACTIVATE", "MODEL_DEPLOYMENT_DEACTIVATE", "MODEL_DEPLOYMENT_UPDATE", "PROJECT_DELETE", "WORKREQUEST_CANCEL", "JOB_DELETE", "PIPELINE_CREATE", "PIPELINE_DELETE", "PIPELINE_RUN_CREATE", "PIPELINE_RUN_CANCEL", "PIPELINE_RUN_DELETE", "PRIVATE_ENDPOINT_CREATE", "PRIVATE_ENDPOINT_DELETE", "PRIVATE_ENDPOINT_MOVE", "PRIVATE_ENDPOINT_UPDATE", "SCHEDULE_CREATE", "SCHEDULE_UPDATE", "SCHEDULE_DELETE", "SCHEDULE_MOVE", "SCHEDULE_ACTIVATE", "SCHEDULE_DEACTIVATE", "RESTORE_ARCHIVED_MODEL", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -272,7 +296,7 @@ def operation_type(self, operation_type): :param operation_type: The operation_type of this WorkRequestSummary. :type: str """ - allowed_values = ["NOTEBOOK_SESSION_CREATE", "NOTEBOOK_SESSION_DELETE", "NOTEBOOK_SESSION_ACTIVATE", "NOTEBOOK_SESSION_DEACTIVATE", "MODELVERSIONSET_DELETE", "EXPORT_MODEL_ARTIFACT", "IMPORT_MODEL_ARTIFACT", "MODEL_DEPLOYMENT_CREATE", "MODEL_DEPLOYMENT_DELETE", "MODEL_DEPLOYMENT_ACTIVATE", "MODEL_DEPLOYMENT_DEACTIVATE", "MODEL_DEPLOYMENT_UPDATE", "PROJECT_DELETE", "WORKREQUEST_CANCEL", "JOB_DELETE", "PIPELINE_CREATE", "PIPELINE_DELETE", "PIPELINE_RUN_CREATE", "PIPELINE_RUN_CANCEL", "PIPELINE_RUN_DELETE", "PRIVATE_ENDPOINT_CREATE", "PRIVATE_ENDPOINT_DELETE", "PRIVATE_ENDPOINT_MOVE", "PRIVATE_ENDPOINT_UPDATE", "RESTORE_ARCHIVED_MODEL"] + allowed_values = ["NOTEBOOK_SESSION_CREATE", "NOTEBOOK_SESSION_DELETE", "NOTEBOOK_SESSION_ACTIVATE", "NOTEBOOK_SESSION_DEACTIVATE", "MODELVERSIONSET_DELETE", "EXPORT_MODEL_ARTIFACT", "IMPORT_MODEL_ARTIFACT", "MODEL_DEPLOYMENT_CREATE", "MODEL_DEPLOYMENT_DELETE", "MODEL_DEPLOYMENT_ACTIVATE", "MODEL_DEPLOYMENT_DEACTIVATE", "MODEL_DEPLOYMENT_UPDATE", "PROJECT_DELETE", "WORKREQUEST_CANCEL", "JOB_DELETE", "PIPELINE_CREATE", "PIPELINE_DELETE", "PIPELINE_RUN_CREATE", "PIPELINE_RUN_CANCEL", "PIPELINE_RUN_DELETE", "PRIVATE_ENDPOINT_CREATE", "PRIVATE_ENDPOINT_DELETE", "PRIVATE_ENDPOINT_MOVE", "PRIVATE_ENDPOINT_UPDATE", "SCHEDULE_CREATE", "SCHEDULE_UPDATE", "SCHEDULE_DELETE", "SCHEDULE_MOVE", "SCHEDULE_ACTIVATE", "SCHEDULE_DEACTIVATE", "RESTORE_ARCHIVED_MODEL"] if not value_allowed_none_or_none_sentinel(operation_type, allowed_values): operation_type = 'UNKNOWN_ENUM_VALUE' self._operation_type = operation_type diff --git a/src/oci/data_science/models/workload_configuration_details.py b/src/oci/data_science/models/workload_configuration_details.py new file mode 100644 index 0000000000..8de121e17f --- /dev/null +++ b/src/oci/data_science/models/workload_configuration_details.py @@ -0,0 +1,109 @@ +# coding: utf-8 +# Copyright (c) 2016, 2025, 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: 20190101 + + +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 WorkloadConfigurationDetails(object): + """ + The workload configuration details + """ + + #: A constant which can be used with the workload_type property of a WorkloadConfigurationDetails. + #: This constant has a value of "MODEL_DEPLOYMENT" + WORKLOAD_TYPE_MODEL_DEPLOYMENT = "MODEL_DEPLOYMENT" + + #: A constant which can be used with the workload_type property of a WorkloadConfigurationDetails. + #: This constant has a value of "JOB_RUN" + WORKLOAD_TYPE_JOB_RUN = "JOB_RUN" + + def __init__(self, **kwargs): + """ + Initializes a new WorkloadConfigurationDetails 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.data_science.models.ModelDeployWorkloadConfigurationDetails` + * :class:`~oci.data_science.models.JobRunWorkloadConfigurationDetails` + + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param workload_type: + The value to assign to the workload_type property of this WorkloadConfigurationDetails. + Allowed values for this property are: "MODEL_DEPLOYMENT", "JOB_RUN", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type workload_type: str + + """ + self.swagger_types = { + 'workload_type': 'str' + } + + self.attribute_map = { + 'workload_type': 'workloadType' + } + + self._workload_type = 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['workloadType'] + + if type == 'MODEL_DEPLOYMENT': + return 'ModelDeployWorkloadConfigurationDetails' + + if type == 'JOB_RUN': + return 'JobRunWorkloadConfigurationDetails' + else: + return 'WorkloadConfigurationDetails' + + @property + def workload_type(self): + """ + **[Required]** Gets the workload_type of this WorkloadConfigurationDetails. + The workload use case. + + Allowed values for this property are: "MODEL_DEPLOYMENT", "JOB_RUN", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The workload_type of this WorkloadConfigurationDetails. + :rtype: str + """ + return self._workload_type + + @workload_type.setter + def workload_type(self, workload_type): + """ + Sets the workload_type of this WorkloadConfigurationDetails. + The workload use case. + + + :param workload_type: The workload_type of this WorkloadConfigurationDetails. + :type: str + """ + allowed_values = ["MODEL_DEPLOYMENT", "JOB_RUN"] + if not value_allowed_none_or_none_sentinel(workload_type, allowed_values): + workload_type = 'UNKNOWN_ENUM_VALUE' + self._workload_type = workload_type + + 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/generative_ai_inference/generative_ai_inference_client.py b/src/oci/generative_ai_inference/generative_ai_inference_client.py index 1dd5438904..0d68eb6db8 100644 --- a/src/oci/generative_ai_inference/generative_ai_inference_client.py +++ b/src/oci/generative_ai_inference/generative_ai_inference_client.py @@ -415,6 +415,105 @@ def generate_text(self, generate_text_details, **kwargs): api_reference_link=api_reference_link, required_arguments=required_arguments) + def rerank_text(self, rerank_text_details, **kwargs): + """ + Reranks the text responses based on the input documents and a prompt. + + Rerank assigns an index and a relevance score to each document, indicating which document is most related to the prompt. + + + :param oci.generative_ai_inference.models.RerankTextDetails rerank_text_details: (required) + Details required for the rerank request. + + :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 that, in case of conflicting operations. For example, if a resource is deleted and purged from the system, then a retry of the original creation request + is rejected. + + :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 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.generative_ai_inference.models.RerankTextResult` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use rerank_text API. + """ + # Required path and query arguments. These are in camelCase to replace values in service endpoints. + required_arguments = [] + resource_path = "/actions/rerankText" + method = "POST" + operation_name = "rerank_text" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/generative-ai-inference/20231130/RerankTextResult/RerankText" + + # 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( + f"rerank_text got unknown kwargs: {extra_kwargs!r}") + + 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=rerank_text_details, + response_type="RerankTextResult", + 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=rerank_text_details, + response_type="RerankTextResult", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + def summarize_text(self, summarize_text_details, **kwargs): """ Summarizes the input text. diff --git a/src/oci/generative_ai_inference/models/__init__.py b/src/oci/generative_ai_inference/models/__init__.py index 437aa608ce..66f71260f1 100644 --- a/src/oci/generative_ai_inference/models/__init__.py +++ b/src/oci/generative_ai_inference/models/__init__.py @@ -32,8 +32,12 @@ from .cohere_tool_result import CohereToolResult from .cohere_user_message import CohereUserMessage from .dedicated_serving_mode import DedicatedServingMode +from .document import Document +from .document_rank import DocumentRank from .embed_text_details import EmbedTextDetails from .embed_text_result import EmbedTextResult +from .function_call import FunctionCall +from .function_definition import FunctionDefinition from .generate_text_details import GenerateTextDetails from .generate_text_result import GenerateTextResult from .generated_text import GeneratedText @@ -48,6 +52,8 @@ from .logprobs import Logprobs from .message import Message from .on_demand_serving_mode import OnDemandServingMode +from .rerank_text_details import RerankTextDetails +from .rerank_text_result import RerankTextResult from .search_query import SearchQuery from .serving_mode import ServingMode from .summarize_text_details import SummarizeTextDetails @@ -55,6 +61,14 @@ from .system_message import SystemMessage from .text_content import TextContent from .token_likelihood import TokenLikelihood +from .tool_call import ToolCall +from .tool_choice import ToolChoice +from .tool_choice_auto import ToolChoiceAuto +from .tool_choice_function import ToolChoiceFunction +from .tool_choice_none import ToolChoiceNone +from .tool_choice_required import ToolChoiceRequired +from .tool_definition import ToolDefinition +from .tool_message import ToolMessage from .user_message import UserMessage # Maps type names to classes for generative_ai_inference services. @@ -85,8 +99,12 @@ "CohereToolResult": CohereToolResult, "CohereUserMessage": CohereUserMessage, "DedicatedServingMode": DedicatedServingMode, + "Document": Document, + "DocumentRank": DocumentRank, "EmbedTextDetails": EmbedTextDetails, "EmbedTextResult": EmbedTextResult, + "FunctionCall": FunctionCall, + "FunctionDefinition": FunctionDefinition, "GenerateTextDetails": GenerateTextDetails, "GenerateTextResult": GenerateTextResult, "GeneratedText": GeneratedText, @@ -101,6 +119,8 @@ "Logprobs": Logprobs, "Message": Message, "OnDemandServingMode": OnDemandServingMode, + "RerankTextDetails": RerankTextDetails, + "RerankTextResult": RerankTextResult, "SearchQuery": SearchQuery, "ServingMode": ServingMode, "SummarizeTextDetails": SummarizeTextDetails, @@ -108,5 +128,13 @@ "SystemMessage": SystemMessage, "TextContent": TextContent, "TokenLikelihood": TokenLikelihood, + "ToolCall": ToolCall, + "ToolChoice": ToolChoice, + "ToolChoiceAuto": ToolChoiceAuto, + "ToolChoiceFunction": ToolChoiceFunction, + "ToolChoiceNone": ToolChoiceNone, + "ToolChoiceRequired": ToolChoiceRequired, + "ToolDefinition": ToolDefinition, + "ToolMessage": ToolMessage, "UserMessage": UserMessage } diff --git a/src/oci/generative_ai_inference/models/assistant_message.py b/src/oci/generative_ai_inference/models/assistant_message.py index ccda9830ab..5139474aaf 100644 --- a/src/oci/generative_ai_inference/models/assistant_message.py +++ b/src/oci/generative_ai_inference/models/assistant_message.py @@ -23,7 +23,7 @@ def __init__(self, **kwargs): :param role: The value to assign to the role property of this AssistantMessage. - Allowed values for this property are: "SYSTEM", "USER", "ASSISTANT" + Allowed values for this property are: "SYSTEM", "USER", "ASSISTANT", "TOOL" :type role: str :param content: @@ -34,22 +34,29 @@ def __init__(self, **kwargs): The value to assign to the name property of this AssistantMessage. :type name: str + :param tool_calls: + The value to assign to the tool_calls property of this AssistantMessage. + :type tool_calls: list[oci.generative_ai_inference.models.ToolCall] + """ self.swagger_types = { 'role': 'str', 'content': 'list[ChatContent]', - 'name': 'str' + 'name': 'str', + 'tool_calls': 'list[ToolCall]' } self.attribute_map = { 'role': 'role', 'content': 'content', - 'name': 'name' + 'name': 'name', + 'tool_calls': 'toolCalls' } self._role = None self._content = None self._name = None + self._tool_calls = None self._role = 'ASSISTANT' @property @@ -76,6 +83,30 @@ def name(self, name): """ self._name = name + @property + def tool_calls(self): + """ + Gets the tool_calls of this AssistantMessage. + The tool calls generated by the model, such as function calls. + + + :return: The tool_calls of this AssistantMessage. + :rtype: list[oci.generative_ai_inference.models.ToolCall] + """ + return self._tool_calls + + @tool_calls.setter + def tool_calls(self, tool_calls): + """ + Sets the tool_calls of this AssistantMessage. + The tool calls generated by the model, such as function calls. + + + :param tool_calls: The tool_calls of this AssistantMessage. + :type: list[oci.generative_ai_inference.models.ToolCall] + """ + self._tool_calls = tool_calls + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/generative_ai_inference/models/cohere_chat_request.py b/src/oci/generative_ai_inference/models/cohere_chat_request.py index c37f65ffa2..982471ff5f 100644 --- a/src/oci/generative_ai_inference/models/cohere_chat_request.py +++ b/src/oci/generative_ai_inference/models/cohere_chat_request.py @@ -616,7 +616,7 @@ def presence_penalty(self, presence_penalty): def seed(self): """ Gets the seed of this CohereChatRequest. - If specified, the backend will make a best effort to sample tokens deterministically, such that repeated requests with the same seed and parameters should return the same result. However, determinism cannot be totally guaranteed. + If specified, the backend will make a best effort to sample tokens deterministically, so that repeated requests with the same seed and parameters yield the same result. However, determinism cannot be fully guaranteed. :return: The seed of this CohereChatRequest. @@ -628,7 +628,7 @@ def seed(self): def seed(self, seed): """ Sets the seed of this CohereChatRequest. - If specified, the backend will make a best effort to sample tokens deterministically, such that repeated requests with the same seed and parameters should return the same result. However, determinism cannot be totally guaranteed. + If specified, the backend will make a best effort to sample tokens deterministically, so that repeated requests with the same seed and parameters yield the same result. However, determinism cannot be fully guaranteed. :param seed: The seed of this CohereChatRequest. diff --git a/src/oci/generative_ai_inference/models/document.py b/src/oci/generative_ai_inference/models/document.py new file mode 100644 index 0000000000..a0bac52a22 --- /dev/null +++ b/src/oci/generative_ai_inference/models/document.py @@ -0,0 +1,72 @@ +# coding: utf-8 +# Copyright (c) 2016, 2025, 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: 20231130 + + +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 Document(object): + """ + The input of the document to rerank. + """ + + def __init__(self, **kwargs): + """ + Initializes a new Document object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param text: + The value to assign to the text property of this Document. + :type text: str + + """ + self.swagger_types = { + 'text': 'str' + } + + self.attribute_map = { + 'text': 'text' + } + + self._text = None + + @property + def text(self): + """ + **[Required]** Gets the text of this Document. + The text of the document to rerank. + + + :return: The text of this Document. + :rtype: str + """ + return self._text + + @text.setter + def text(self, text): + """ + Sets the text of this Document. + The text of the document to rerank. + + + :param text: The text of this Document. + :type: str + """ + self._text = text + + 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/generative_ai_inference/models/document_rank.py b/src/oci/generative_ai_inference/models/document_rank.py new file mode 100644 index 0000000000..13cdf824d1 --- /dev/null +++ b/src/oci/generative_ai_inference/models/document_rank.py @@ -0,0 +1,130 @@ +# coding: utf-8 +# Copyright (c) 2016, 2025, 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: 20231130 + + +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 DocumentRank(object): + """ + An object that contains a relevance score, an index and the text for a document. + """ + + def __init__(self, **kwargs): + """ + Initializes a new DocumentRank object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param index: + The value to assign to the index property of this DocumentRank. + :type index: int + + :param relevance_score: + The value to assign to the relevance_score property of this DocumentRank. + :type relevance_score: float + + :param document: + The value to assign to the document property of this DocumentRank. + :type document: oci.generative_ai_inference.models.Document + + """ + self.swagger_types = { + 'index': 'int', + 'relevance_score': 'float', + 'document': 'Document' + } + + self.attribute_map = { + 'index': 'index', + 'relevance_score': 'relevanceScore', + 'document': 'document' + } + + self._index = None + self._relevance_score = None + self._document = None + + @property + def index(self): + """ + Gets the index of this DocumentRank. + Index of the document in documents array. + + + :return: The index of this DocumentRank. + :rtype: int + """ + return self._index + + @index.setter + def index(self, index): + """ + Sets the index of this DocumentRank. + Index of the document in documents array. + + + :param index: The index of this DocumentRank. + :type: int + """ + self._index = index + + @property + def relevance_score(self): + """ + Gets the relevance_score of this DocumentRank. + The relevance score for the document at that index. + + + :return: The relevance_score of this DocumentRank. + :rtype: float + """ + return self._relevance_score + + @relevance_score.setter + def relevance_score(self, relevance_score): + """ + Sets the relevance_score of this DocumentRank. + The relevance score for the document at that index. + + + :param relevance_score: The relevance_score of this DocumentRank. + :type: float + """ + self._relevance_score = relevance_score + + @property + def document(self): + """ + Gets the document of this DocumentRank. + + :return: The document of this DocumentRank. + :rtype: oci.generative_ai_inference.models.Document + """ + return self._document + + @document.setter + def document(self, document): + """ + Sets the document of this DocumentRank. + + :param document: The document of this DocumentRank. + :type: oci.generative_ai_inference.models.Document + """ + self._document = document + + 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/generative_ai_inference/models/embed_text_details.py b/src/oci/generative_ai_inference/models/embed_text_details.py index 7220344ccc..b9c6f1fa60 100644 --- a/src/oci/generative_ai_inference/models/embed_text_details.py +++ b/src/oci/generative_ai_inference/models/embed_text_details.py @@ -43,6 +43,10 @@ class EmbedTextDetails(object): #: This constant has a value of "CLUSTERING" INPUT_TYPE_CLUSTERING = "CLUSTERING" + #: A constant which can be used with the input_type property of a EmbedTextDetails. + #: This constant has a value of "IMAGE" + INPUT_TYPE_IMAGE = "IMAGE" + def __init__(self, **kwargs): """ Initializes a new EmbedTextDetails object with values from keyword arguments. @@ -71,7 +75,7 @@ def __init__(self, **kwargs): :param input_type: The value to assign to the input_type property of this EmbedTextDetails. - Allowed values for this property are: "SEARCH_DOCUMENT", "SEARCH_QUERY", "CLASSIFICATION", "CLUSTERING" + Allowed values for this property are: "SEARCH_DOCUMENT", "SEARCH_QUERY", "CLASSIFICATION", "CLUSTERING", "IMAGE" :type input_type: str """ @@ -104,7 +108,7 @@ def __init__(self, **kwargs): def inputs(self): """ **[Required]** Gets the inputs of this EmbedTextDetails. - Provide a list of strings. Each string can be words, a phrase, or a paragraph. The maximum length of each string entry in the list is 512 tokens. + Provide a list of strings or one base64 encoded image with `input_type` setting to `IMAGE`. If text embedding, each string can be words, a phrase, or a paragraph. The maximum length of each string entry in the list is 512 tokens. :return: The inputs of this EmbedTextDetails. @@ -116,7 +120,7 @@ def inputs(self): def inputs(self, inputs): """ Sets the inputs of this EmbedTextDetails. - Provide a list of strings. Each string can be words, a phrase, or a paragraph. The maximum length of each string entry in the list is 512 tokens. + Provide a list of strings or one base64 encoded image with `input_type` setting to `IMAGE`. If text embedding, each string can be words, a phrase, or a paragraph. The maximum length of each string entry in the list is 512 tokens. :param inputs: The inputs of this EmbedTextDetails. @@ -229,7 +233,7 @@ def input_type(self): Gets the input_type of this EmbedTextDetails. Specifies the input type. - Allowed values for this property are: "SEARCH_DOCUMENT", "SEARCH_QUERY", "CLASSIFICATION", "CLUSTERING" + Allowed values for this property are: "SEARCH_DOCUMENT", "SEARCH_QUERY", "CLASSIFICATION", "CLUSTERING", "IMAGE" :return: The input_type of this EmbedTextDetails. @@ -247,7 +251,7 @@ def input_type(self, input_type): :param input_type: The input_type of this EmbedTextDetails. :type: str """ - allowed_values = ["SEARCH_DOCUMENT", "SEARCH_QUERY", "CLASSIFICATION", "CLUSTERING"] + allowed_values = ["SEARCH_DOCUMENT", "SEARCH_QUERY", "CLASSIFICATION", "CLUSTERING", "IMAGE"] if not value_allowed_none_or_none_sentinel(input_type, allowed_values): raise ValueError( f"Invalid value for `input_type`, must be None or one of {allowed_values}" diff --git a/src/oci/generative_ai_inference/models/function_call.py b/src/oci/generative_ai_inference/models/function_call.py new file mode 100644 index 0000000000..6302434205 --- /dev/null +++ b/src/oci/generative_ai_inference/models/function_call.py @@ -0,0 +1,120 @@ +# coding: utf-8 +# Copyright (c) 2016, 2025, 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: 20231130 + +from .tool_call import ToolCall +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 FunctionCall(ToolCall): + """ + The function call generated by the model. + """ + + def __init__(self, **kwargs): + """ + Initializes a new FunctionCall object with values from keyword arguments. The default value of the :py:attr:`~oci.generative_ai_inference.models.FunctionCall.type` attribute + of this class is ``FUNCTION`` 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 FunctionCall. + :type id: str + + :param type: + The value to assign to the type property of this FunctionCall. + Allowed values for this property are: "FUNCTION" + :type type: str + + :param name: + The value to assign to the name property of this FunctionCall. + :type name: str + + :param arguments: + The value to assign to the arguments property of this FunctionCall. + :type arguments: str + + """ + self.swagger_types = { + 'id': 'str', + 'type': 'str', + 'name': 'str', + 'arguments': 'str' + } + + self.attribute_map = { + 'id': 'id', + 'type': 'type', + 'name': 'name', + 'arguments': 'arguments' + } + + self._id = None + self._type = None + self._name = None + self._arguments = None + self._type = 'FUNCTION' + + @property + def name(self): + """ + Gets the name of this FunctionCall. + The name of the function to call. + + + :return: The name of this FunctionCall. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this FunctionCall. + The name of the function to call. + + + :param name: The name of this FunctionCall. + :type: str + """ + self._name = name + + @property + def arguments(self): + """ + Gets the arguments of this FunctionCall. + The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function. + + + :return: The arguments of this FunctionCall. + :rtype: str + """ + return self._arguments + + @arguments.setter + def arguments(self, arguments): + """ + Sets the arguments of this FunctionCall. + The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function. + + + :param arguments: The arguments of this FunctionCall. + :type: str + """ + self._arguments = arguments + + 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/generative_ai_inference/models/function_definition.py b/src/oci/generative_ai_inference/models/function_definition.py new file mode 100644 index 0000000000..09df7cd4fe --- /dev/null +++ b/src/oci/generative_ai_inference/models/function_definition.py @@ -0,0 +1,144 @@ +# coding: utf-8 +# Copyright (c) 2016, 2025, 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: 20231130 + +from .tool_definition import ToolDefinition +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 FunctionDefinition(ToolDefinition): + """ + A function the model may call. + """ + + def __init__(self, **kwargs): + """ + Initializes a new FunctionDefinition object with values from keyword arguments. The default value of the :py:attr:`~oci.generative_ai_inference.models.FunctionDefinition.type` attribute + of this class is ``FUNCTION`` and it should not be changed. + 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 FunctionDefinition. + Allowed values for this property are: "FUNCTION" + :type type: str + + :param name: + The value to assign to the name property of this FunctionDefinition. + :type name: str + + :param description: + The value to assign to the description property of this FunctionDefinition. + :type description: str + + :param parameters: + The value to assign to the parameters property of this FunctionDefinition. + :type parameters: object + + """ + self.swagger_types = { + 'type': 'str', + 'name': 'str', + 'description': 'str', + 'parameters': 'object' + } + + self.attribute_map = { + 'type': 'type', + 'name': 'name', + 'description': 'description', + 'parameters': 'parameters' + } + + self._type = None + self._name = None + self._description = None + self._parameters = None + self._type = 'FUNCTION' + + @property + def name(self): + """ + Gets the name of this FunctionDefinition. + The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. + + + :return: The name of this FunctionDefinition. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this FunctionDefinition. + The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. + + + :param name: The name of this FunctionDefinition. + :type: str + """ + self._name = name + + @property + def description(self): + """ + Gets the description of this FunctionDefinition. + A description of what the function does, used by the model to choose when and how to call the function. + + + :return: The description of this FunctionDefinition. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this FunctionDefinition. + A description of what the function does, used by the model to choose when and how to call the function. + + + :param description: The description of this FunctionDefinition. + :type: str + """ + self._description = description + + @property + def parameters(self): + """ + Gets the parameters of this FunctionDefinition. + The parameters the functions accepts, described as a JSON Schema object. Omitting parameters defines a function with an empty parameter list. + + + :return: The parameters of this FunctionDefinition. + :rtype: object + """ + return self._parameters + + @parameters.setter + def parameters(self, parameters): + """ + Sets the parameters of this FunctionDefinition. + The parameters the functions accepts, described as a JSON Schema object. Omitting parameters defines a function with an empty parameter list. + + + :param parameters: The parameters of this FunctionDefinition. + :type: object + """ + self._parameters = parameters + + 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/generative_ai_inference/models/generic_chat_request.py b/src/oci/generative_ai_inference/models/generic_chat_request.py index e5d3062d75..234607abdb 100644 --- a/src/oci/generative_ai_inference/models/generic_chat_request.py +++ b/src/oci/generative_ai_inference/models/generic_chat_request.py @@ -38,6 +38,10 @@ def __init__(self, **kwargs): The value to assign to the num_generations property of this GenericChatRequest. :type num_generations: int + :param seed: + The value to assign to the seed property of this GenericChatRequest. + :type seed: int + :param is_echo: The value to assign to the is_echo property of this GenericChatRequest. :type is_echo: bool @@ -78,12 +82,21 @@ def __init__(self, **kwargs): The value to assign to the logit_bias property of this GenericChatRequest. :type logit_bias: object + :param tool_choice: + The value to assign to the tool_choice property of this GenericChatRequest. + :type tool_choice: oci.generative_ai_inference.models.ToolChoice + + :param tools: + The value to assign to the tools property of this GenericChatRequest. + :type tools: list[oci.generative_ai_inference.models.ToolDefinition] + """ self.swagger_types = { 'api_format': 'str', 'messages': 'list[Message]', 'is_stream': 'bool', 'num_generations': 'int', + 'seed': 'int', 'is_echo': 'bool', 'top_k': 'int', 'top_p': 'float', @@ -93,7 +106,9 @@ def __init__(self, **kwargs): 'stop': 'list[str]', 'log_probs': 'int', 'max_tokens': 'int', - 'logit_bias': 'object' + 'logit_bias': 'object', + 'tool_choice': 'ToolChoice', + 'tools': 'list[ToolDefinition]' } self.attribute_map = { @@ -101,6 +116,7 @@ def __init__(self, **kwargs): 'messages': 'messages', 'is_stream': 'isStream', 'num_generations': 'numGenerations', + 'seed': 'seed', 'is_echo': 'isEcho', 'top_k': 'topK', 'top_p': 'topP', @@ -110,13 +126,16 @@ def __init__(self, **kwargs): 'stop': 'stop', 'log_probs': 'logProbs', 'max_tokens': 'maxTokens', - 'logit_bias': 'logitBias' + 'logit_bias': 'logitBias', + 'tool_choice': 'toolChoice', + 'tools': 'tools' } self._api_format = None self._messages = None self._is_stream = None self._num_generations = None + self._seed = None self._is_echo = None self._top_k = None self._top_p = None @@ -127,6 +146,8 @@ def __init__(self, **kwargs): self._log_probs = None self._max_tokens = None self._logit_bias = None + self._tool_choice = None + self._tools = None self._api_format = 'GENERIC' @property @@ -201,6 +222,30 @@ def num_generations(self, num_generations): """ self._num_generations = num_generations + @property + def seed(self): + """ + Gets the seed of this GenericChatRequest. + If specified, the backend will make a best effort to sample tokens deterministically, so that repeated requests with the same seed and parameters yield the same result. However, determinism cannot be fully guaranteed. + + + :return: The seed of this GenericChatRequest. + :rtype: int + """ + return self._seed + + @seed.setter + def seed(self, seed): + """ + Sets the seed of this GenericChatRequest. + If specified, the backend will make a best effort to sample tokens deterministically, so that repeated requests with the same seed and parameters yield the same result. However, determinism cannot be fully guaranteed. + + + :param seed: The seed of this GenericChatRequest. + :type: int + """ + self._seed = seed + @property def is_echo(self): """ @@ -467,6 +512,50 @@ def logit_bias(self, logit_bias): """ self._logit_bias = logit_bias + @property + def tool_choice(self): + """ + Gets the tool_choice of this GenericChatRequest. + + :return: The tool_choice of this GenericChatRequest. + :rtype: oci.generative_ai_inference.models.ToolChoice + """ + return self._tool_choice + + @tool_choice.setter + def tool_choice(self, tool_choice): + """ + Sets the tool_choice of this GenericChatRequest. + + :param tool_choice: The tool_choice of this GenericChatRequest. + :type: oci.generative_ai_inference.models.ToolChoice + """ + self._tool_choice = tool_choice + + @property + def tools(self): + """ + Gets the tools of this GenericChatRequest. + A list of tools the model may call. Use this to provide a list of functions the model may generate JSON inputs for. A max of 128 functions are supported. + + + :return: The tools of this GenericChatRequest. + :rtype: list[oci.generative_ai_inference.models.ToolDefinition] + """ + return self._tools + + @tools.setter + def tools(self, tools): + """ + Sets the tools of this GenericChatRequest. + A list of tools the model may call. Use this to provide a list of functions the model may generate JSON inputs for. A max of 128 functions are supported. + + + :param tools: The tools of this GenericChatRequest. + :type: list[oci.generative_ai_inference.models.ToolDefinition] + """ + self._tools = tools + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/generative_ai_inference/models/image_url.py b/src/oci/generative_ai_inference/models/image_url.py index 8908f84498..dc157f1034 100644 --- a/src/oci/generative_ai_inference/models/image_url.py +++ b/src/oci/generative_ai_inference/models/image_url.py @@ -12,7 +12,7 @@ @init_model_state_from_kwargs class ImageUrl(object): """ - Represents a single instance of chat image url. + Provide a base64 encoded image. """ #: A constant which can be used with the detail property of a ImageUrl. @@ -60,7 +60,15 @@ def __init__(self, **kwargs): def url(self): """ **[Required]** Gets the url of this ImageUrl. - The URL of the image. + The base64 encoded image data. + + Example for a png image: + `{ + \"type\": \"IMAGE\", + \"imageUrl\": { + \"url\": \"data:image/png;base64,\" + } + }` :return: The url of this ImageUrl. @@ -72,7 +80,15 @@ def url(self): def url(self, url): """ Sets the url of this ImageUrl. - The URL of the image. + The base64 encoded image data. + + Example for a png image: + `{ + \"type\": \"IMAGE\", + \"imageUrl\": { + \"url\": \"data:image/png;base64,\" + } + }` :param url: The url of this ImageUrl. @@ -84,7 +100,7 @@ def url(self, url): def detail(self): """ Gets the detail of this ImageUrl. - The level of the detail. + The default value is AUTO and only AUTO is supported. This option controls how to convert the base64 encoded image to tokens. Allowed values for this property are: "AUTO", "HIGH", "LOW", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -99,7 +115,7 @@ def detail(self): def detail(self, detail): """ Sets the detail of this ImageUrl. - The level of the detail. + The default value is AUTO and only AUTO is supported. This option controls how to convert the base64 encoded image to tokens. :param detail: The detail of this ImageUrl. diff --git a/src/oci/generative_ai_inference/models/message.py b/src/oci/generative_ai_inference/models/message.py index 5aab6067f9..4207178870 100644 --- a/src/oci/generative_ai_inference/models/message.py +++ b/src/oci/generative_ai_inference/models/message.py @@ -27,6 +27,10 @@ class Message(object): #: This constant has a value of "ASSISTANT" ROLE_ASSISTANT = "ASSISTANT" + #: A constant which can be used with the role property of a Message. + #: This constant has a value of "TOOL" + ROLE_TOOL = "TOOL" + def __init__(self, **kwargs): """ Initializes a new Message object with values from keyword arguments. This class has the following subclasses and if you are using this class as input @@ -35,12 +39,13 @@ def __init__(self, **kwargs): * :class:`~oci.generative_ai_inference.models.SystemMessage` * :class:`~oci.generative_ai_inference.models.AssistantMessage` * :class:`~oci.generative_ai_inference.models.UserMessage` + * :class:`~oci.generative_ai_inference.models.ToolMessage` The following keyword arguments are supported (corresponding to the getters/setters of this class): :param role: The value to assign to the role property of this Message. - Allowed values for this property are: "SYSTEM", "USER", "ASSISTANT", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "SYSTEM", "USER", "ASSISTANT", "TOOL", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type role: str @@ -78,6 +83,9 @@ def get_subtype(object_dictionary): if type == 'USER': return 'UserMessage' + + if type == 'TOOL': + return 'ToolMessage' else: return 'Message' @@ -87,7 +95,7 @@ def role(self): **[Required]** Gets the role of this Message. Indicates who is writing the current chat message. - Allowed values for this property are: "SYSTEM", "USER", "ASSISTANT", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "SYSTEM", "USER", "ASSISTANT", "TOOL", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -106,7 +114,7 @@ def role(self, role): :param role: The role of this Message. :type: str """ - allowed_values = ["SYSTEM", "USER", "ASSISTANT"] + allowed_values = ["SYSTEM", "USER", "ASSISTANT", "TOOL"] if not value_allowed_none_or_none_sentinel(role, allowed_values): role = 'UNKNOWN_ENUM_VALUE' self._role = role diff --git a/src/oci/generative_ai_inference/models/rerank_text_details.py b/src/oci/generative_ai_inference/models/rerank_text_details.py new file mode 100644 index 0000000000..ac56b183e8 --- /dev/null +++ b/src/oci/generative_ai_inference/models/rerank_text_details.py @@ -0,0 +1,254 @@ +# coding: utf-8 +# Copyright (c) 2016, 2025, 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: 20231130 + + +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 RerankTextDetails(object): + """ + Details required for a rerank request. + """ + + def __init__(self, **kwargs): + """ + Initializes a new RerankTextDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param input: + The value to assign to the input property of this RerankTextDetails. + :type input: str + + :param compartment_id: + The value to assign to the compartment_id property of this RerankTextDetails. + :type compartment_id: str + + :param serving_mode: + The value to assign to the serving_mode property of this RerankTextDetails. + :type serving_mode: oci.generative_ai_inference.models.ServingMode + + :param documents: + The value to assign to the documents property of this RerankTextDetails. + :type documents: list[str] + + :param top_n: + The value to assign to the top_n property of this RerankTextDetails. + :type top_n: int + + :param is_echo: + The value to assign to the is_echo property of this RerankTextDetails. + :type is_echo: bool + + :param max_chunks_per_document: + The value to assign to the max_chunks_per_document property of this RerankTextDetails. + :type max_chunks_per_document: int + + """ + self.swagger_types = { + 'input': 'str', + 'compartment_id': 'str', + 'serving_mode': 'ServingMode', + 'documents': 'list[str]', + 'top_n': 'int', + 'is_echo': 'bool', + 'max_chunks_per_document': 'int' + } + + self.attribute_map = { + 'input': 'input', + 'compartment_id': 'compartmentId', + 'serving_mode': 'servingMode', + 'documents': 'documents', + 'top_n': 'topN', + 'is_echo': 'isEcho', + 'max_chunks_per_document': 'maxChunksPerDocument' + } + + self._input = None + self._compartment_id = None + self._serving_mode = None + self._documents = None + self._top_n = None + self._is_echo = None + self._max_chunks_per_document = None + + @property + def input(self): + """ + **[Required]** Gets the input of this RerankTextDetails. + Input query for search in the documents. + + + :return: The input of this RerankTextDetails. + :rtype: str + """ + return self._input + + @input.setter + def input(self, input): + """ + Sets the input of this RerankTextDetails. + Input query for search in the documents. + + + :param input: The input of this RerankTextDetails. + :type: str + """ + self._input = input + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this RerankTextDetails. + The OCID of the compartment to call into the Generative AI service LLMs. + + + :return: The compartment_id of this RerankTextDetails. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this RerankTextDetails. + The OCID of the compartment to call into the Generative AI service LLMs. + + + :param compartment_id: The compartment_id of this RerankTextDetails. + :type: str + """ + self._compartment_id = compartment_id + + @property + def serving_mode(self): + """ + **[Required]** Gets the serving_mode of this RerankTextDetails. + + :return: The serving_mode of this RerankTextDetails. + :rtype: oci.generative_ai_inference.models.ServingMode + """ + return self._serving_mode + + @serving_mode.setter + def serving_mode(self, serving_mode): + """ + Sets the serving_mode of this RerankTextDetails. + + :param serving_mode: The serving_mode of this RerankTextDetails. + :type: oci.generative_ai_inference.models.ServingMode + """ + self._serving_mode = serving_mode + + @property + def documents(self): + """ + **[Required]** Gets the documents of this RerankTextDetails. + A list of document strings to rerank based on the query asked. + + + :return: The documents of this RerankTextDetails. + :rtype: list[str] + """ + return self._documents + + @documents.setter + def documents(self, documents): + """ + Sets the documents of this RerankTextDetails. + A list of document strings to rerank based on the query asked. + + + :param documents: The documents of this RerankTextDetails. + :type: list[str] + """ + self._documents = documents + + @property + def top_n(self): + """ + Gets the top_n of this RerankTextDetails. + The number of most relevant documents or indices to return. Defaults to the length of the documents. + + + :return: The top_n of this RerankTextDetails. + :rtype: int + """ + return self._top_n + + @top_n.setter + def top_n(self, top_n): + """ + Sets the top_n of this RerankTextDetails. + The number of most relevant documents or indices to return. Defaults to the length of the documents. + + + :param top_n: The top_n of this RerankTextDetails. + :type: int + """ + self._top_n = top_n + + @property + def is_echo(self): + """ + Gets the is_echo of this RerankTextDetails. + Whether or not to return the documents in the response. + + + :return: The is_echo of this RerankTextDetails. + :rtype: bool + """ + return self._is_echo + + @is_echo.setter + def is_echo(self, is_echo): + """ + Sets the is_echo of this RerankTextDetails. + Whether or not to return the documents in the response. + + + :param is_echo: The is_echo of this RerankTextDetails. + :type: bool + """ + self._is_echo = is_echo + + @property + def max_chunks_per_document(self): + """ + Gets the max_chunks_per_document of this RerankTextDetails. + The maximum number of chunks to produce internally from a document. + + + :return: The max_chunks_per_document of this RerankTextDetails. + :rtype: int + """ + return self._max_chunks_per_document + + @max_chunks_per_document.setter + def max_chunks_per_document(self, max_chunks_per_document): + """ + Sets the max_chunks_per_document of this RerankTextDetails. + The maximum number of chunks to produce internally from a document. + + + :param max_chunks_per_document: The max_chunks_per_document of this RerankTextDetails. + :type: int + """ + self._max_chunks_per_document = max_chunks_per_document + + 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/generative_ai_inference/models/rerank_text_result.py b/src/oci/generative_ai_inference/models/rerank_text_result.py new file mode 100644 index 0000000000..e6e111facf --- /dev/null +++ b/src/oci/generative_ai_inference/models/rerank_text_result.py @@ -0,0 +1,165 @@ +# coding: utf-8 +# Copyright (c) 2016, 2025, 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: 20231130 + + +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 RerankTextResult(object): + """ + The rerank response to return to the caller. + """ + + def __init__(self, **kwargs): + """ + Initializes a new RerankTextResult 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 RerankTextResult. + :type id: str + + :param model_id: + The value to assign to the model_id property of this RerankTextResult. + :type model_id: str + + :param model_version: + The value to assign to the model_version property of this RerankTextResult. + :type model_version: str + + :param document_ranks: + The value to assign to the document_ranks property of this RerankTextResult. + :type document_ranks: list[oci.generative_ai_inference.models.DocumentRank] + + """ + self.swagger_types = { + 'id': 'str', + 'model_id': 'str', + 'model_version': 'str', + 'document_ranks': 'list[DocumentRank]' + } + + self.attribute_map = { + 'id': 'id', + 'model_id': 'modelId', + 'model_version': 'modelVersion', + 'document_ranks': 'documentRanks' + } + + self._id = None + self._model_id = None + self._model_version = None + self._document_ranks = None + + @property + def id(self): + """ + **[Required]** Gets the id of this RerankTextResult. + A unique identifier for this `RerankResult`. + + + :return: The id of this RerankTextResult. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this RerankTextResult. + A unique identifier for this `RerankResult`. + + + :param id: The id of this RerankTextResult. + :type: str + """ + self._id = id + + @property + def model_id(self): + """ + Gets the model_id of this RerankTextResult. + The OCID of the model used in the rerank request. + + + :return: The model_id of this RerankTextResult. + :rtype: str + """ + return self._model_id + + @model_id.setter + def model_id(self, model_id): + """ + Sets the model_id of this RerankTextResult. + The OCID of the model used in the rerank request. + + + :param model_id: The model_id of this RerankTextResult. + :type: str + """ + self._model_id = model_id + + @property + def model_version(self): + """ + Gets the model_version of this RerankTextResult. + The version of the model. + + + :return: The model_version of this RerankTextResult. + :rtype: str + """ + return self._model_version + + @model_version.setter + def model_version(self, model_version): + """ + Sets the model_version of this RerankTextResult. + The version of the model. + + + :param model_version: The model_version of this RerankTextResult. + :type: str + """ + self._model_version = model_version + + @property + def document_ranks(self): + """ + **[Required]** Gets the document_ranks of this RerankTextResult. + Top n documents with their index and relevance score. + + + :return: The document_ranks of this RerankTextResult. + :rtype: list[oci.generative_ai_inference.models.DocumentRank] + """ + return self._document_ranks + + @document_ranks.setter + def document_ranks(self, document_ranks): + """ + Sets the document_ranks of this RerankTextResult. + Top n documents with their index and relevance score. + + + :param document_ranks: The document_ranks of this RerankTextResult. + :type: list[oci.generative_ai_inference.models.DocumentRank] + """ + self._document_ranks = document_ranks + + 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/generative_ai_inference/models/system_message.py b/src/oci/generative_ai_inference/models/system_message.py index 98311a1fcf..d31481b56f 100644 --- a/src/oci/generative_ai_inference/models/system_message.py +++ b/src/oci/generative_ai_inference/models/system_message.py @@ -23,7 +23,7 @@ def __init__(self, **kwargs): :param role: The value to assign to the role property of this SystemMessage. - Allowed values for this property are: "SYSTEM", "USER", "ASSISTANT" + Allowed values for this property are: "SYSTEM", "USER", "ASSISTANT", "TOOL" :type role: str :param content: diff --git a/src/oci/generative_ai_inference/models/tool_call.py b/src/oci/generative_ai_inference/models/tool_call.py new file mode 100644 index 0000000000..99d3a43cae --- /dev/null +++ b/src/oci/generative_ai_inference/models/tool_call.py @@ -0,0 +1,132 @@ +# coding: utf-8 +# Copyright (c) 2016, 2025, 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: 20231130 + + +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 ToolCall(object): + """ + The tool call generated by the model, such as function call. + """ + + #: A constant which can be used with the type property of a ToolCall. + #: This constant has a value of "FUNCTION" + TYPE_FUNCTION = "FUNCTION" + + def __init__(self, **kwargs): + """ + Initializes a new ToolCall 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.generative_ai_inference.models.FunctionCall` + + 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 ToolCall. + :type id: str + + :param type: + The value to assign to the type property of this ToolCall. + Allowed values for this property are: "FUNCTION", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type type: str + + """ + self.swagger_types = { + 'id': 'str', + 'type': 'str' + } + + self.attribute_map = { + 'id': 'id', + 'type': 'type' + } + + self._id = None + self._type = 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['type'] + + if type == 'FUNCTION': + return 'FunctionCall' + else: + return 'ToolCall' + + @property + def id(self): + """ + **[Required]** Gets the id of this ToolCall. + The ID of the tool call. + + + :return: The id of this ToolCall. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this ToolCall. + The ID of the tool call. + + + :param id: The id of this ToolCall. + :type: str + """ + self._id = id + + @property + def type(self): + """ + **[Required]** Gets the type of this ToolCall. + The type of the tool. + + Allowed values for this property are: "FUNCTION", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The type of this ToolCall. + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """ + Sets the type of this ToolCall. + The type of the tool. + + + :param type: The type of this ToolCall. + :type: str + """ + allowed_values = ["FUNCTION"] + if not value_allowed_none_or_none_sentinel(type, allowed_values): + type = 'UNKNOWN_ENUM_VALUE' + self._type = type + + 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/generative_ai_inference/models/tool_choice.py b/src/oci/generative_ai_inference/models/tool_choice.py new file mode 100644 index 0000000000..a51e5a73b0 --- /dev/null +++ b/src/oci/generative_ai_inference/models/tool_choice.py @@ -0,0 +1,125 @@ +# coding: utf-8 +# Copyright (c) 2016, 2025, 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: 20231130 + + +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 ToolChoice(object): + """ + The tool choice for a tool. + """ + + #: A constant which can be used with the type property of a ToolChoice. + #: This constant has a value of "NONE" + TYPE_NONE = "NONE" + + #: A constant which can be used with the type property of a ToolChoice. + #: This constant has a value of "AUTO" + TYPE_AUTO = "AUTO" + + #: A constant which can be used with the type property of a ToolChoice. + #: This constant has a value of "REQUIRED" + TYPE_REQUIRED = "REQUIRED" + + #: A constant which can be used with the type property of a ToolChoice. + #: This constant has a value of "FUNCTION" + TYPE_FUNCTION = "FUNCTION" + + def __init__(self, **kwargs): + """ + Initializes a new ToolChoice 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.generative_ai_inference.models.ToolChoiceFunction` + * :class:`~oci.generative_ai_inference.models.ToolChoiceNone` + * :class:`~oci.generative_ai_inference.models.ToolChoiceAuto` + * :class:`~oci.generative_ai_inference.models.ToolChoiceRequired` + + 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 ToolChoice. + Allowed values for this property are: "NONE", "AUTO", "REQUIRED", "FUNCTION" + :type type: str + + """ + self.swagger_types = { + 'type': 'str' + } + + self.attribute_map = { + 'type': 'type' + } + + self._type = 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['type'] + + if type == 'FUNCTION': + return 'ToolChoiceFunction' + + if type == 'NONE': + return 'ToolChoiceNone' + + if type == 'AUTO': + return 'ToolChoiceAuto' + + if type == 'REQUIRED': + return 'ToolChoiceRequired' + else: + return 'ToolChoice' + + @property + def type(self): + """ + **[Required]** Gets the type of this ToolChoice. + The tool choice. + + Allowed values for this property are: "NONE", "AUTO", "REQUIRED", "FUNCTION" + + + :return: The type of this ToolChoice. + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """ + Sets the type of this ToolChoice. + The tool choice. + + + :param type: The type of this ToolChoice. + :type: str + """ + allowed_values = ["NONE", "AUTO", "REQUIRED", "FUNCTION"] + if not value_allowed_none_or_none_sentinel(type, allowed_values): + raise ValueError( + f"Invalid value for `type`, must be None or one of {allowed_values}" + ) + self._type = type + + 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/generative_ai_inference/models/tool_choice_auto.py b/src/oci/generative_ai_inference/models/tool_choice_auto.py new file mode 100644 index 0000000000..19960fcdf3 --- /dev/null +++ b/src/oci/generative_ai_inference/models/tool_choice_auto.py @@ -0,0 +1,51 @@ +# coding: utf-8 +# Copyright (c) 2016, 2025, 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: 20231130 + +from .tool_choice import ToolChoice +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 ToolChoiceAuto(ToolChoice): + """ + The model can pick between generating a message or calling one or more tools. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ToolChoiceAuto object with values from keyword arguments. The default value of the :py:attr:`~oci.generative_ai_inference.models.ToolChoiceAuto.type` attribute + of this class is ``AUTO`` and it should not be changed. + 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 ToolChoiceAuto. + Allowed values for this property are: "NONE", "AUTO", "REQUIRED", "FUNCTION" + :type type: str + + """ + self.swagger_types = { + 'type': 'str' + } + + self.attribute_map = { + 'type': 'type' + } + + self._type = None + self._type = 'AUTO' + + 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/generative_ai_inference/models/tool_choice_function.py b/src/oci/generative_ai_inference/models/tool_choice_function.py new file mode 100644 index 0000000000..f86282310f --- /dev/null +++ b/src/oci/generative_ai_inference/models/tool_choice_function.py @@ -0,0 +1,82 @@ +# coding: utf-8 +# Copyright (c) 2016, 2025, 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: 20231130 + +from .tool_choice import ToolChoice +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 ToolChoiceFunction(ToolChoice): + """ + The tool choice for a function. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ToolChoiceFunction object with values from keyword arguments. The default value of the :py:attr:`~oci.generative_ai_inference.models.ToolChoiceFunction.type` attribute + of this class is ``FUNCTION`` and it should not be changed. + 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 ToolChoiceFunction. + Allowed values for this property are: "NONE", "AUTO", "REQUIRED", "FUNCTION" + :type type: str + + :param name: + The value to assign to the name property of this ToolChoiceFunction. + :type name: str + + """ + self.swagger_types = { + 'type': 'str', + 'name': 'str' + } + + self.attribute_map = { + 'type': 'type', + 'name': 'name' + } + + self._type = None + self._name = None + self._type = 'FUNCTION' + + @property + def name(self): + """ + Gets the name of this ToolChoiceFunction. + The function name. + + + :return: The name of this ToolChoiceFunction. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this ToolChoiceFunction. + The function name. + + + :param name: The name of this ToolChoiceFunction. + :type: str + """ + self._name = 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/generative_ai_inference/models/tool_choice_none.py b/src/oci/generative_ai_inference/models/tool_choice_none.py new file mode 100644 index 0000000000..07f9a423f4 --- /dev/null +++ b/src/oci/generative_ai_inference/models/tool_choice_none.py @@ -0,0 +1,51 @@ +# coding: utf-8 +# Copyright (c) 2016, 2025, 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: 20231130 + +from .tool_choice import ToolChoice +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 ToolChoiceNone(ToolChoice): + """ + The model will not call any tool and instead generates a message. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ToolChoiceNone object with values from keyword arguments. The default value of the :py:attr:`~oci.generative_ai_inference.models.ToolChoiceNone.type` attribute + of this class is ``NONE`` and it should not be changed. + 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 ToolChoiceNone. + Allowed values for this property are: "NONE", "AUTO", "REQUIRED", "FUNCTION" + :type type: str + + """ + self.swagger_types = { + 'type': 'str' + } + + self.attribute_map = { + 'type': 'type' + } + + self._type = None + self._type = 'NONE' + + 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/generative_ai_inference/models/tool_choice_required.py b/src/oci/generative_ai_inference/models/tool_choice_required.py new file mode 100644 index 0000000000..f2a87a487f --- /dev/null +++ b/src/oci/generative_ai_inference/models/tool_choice_required.py @@ -0,0 +1,51 @@ +# coding: utf-8 +# Copyright (c) 2016, 2025, 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: 20231130 + +from .tool_choice import ToolChoice +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 ToolChoiceRequired(ToolChoice): + """ + The model must call one or more tools. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ToolChoiceRequired object with values from keyword arguments. The default value of the :py:attr:`~oci.generative_ai_inference.models.ToolChoiceRequired.type` attribute + of this class is ``REQUIRED`` and it should not be changed. + 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 ToolChoiceRequired. + Allowed values for this property are: "NONE", "AUTO", "REQUIRED", "FUNCTION" + :type type: str + + """ + self.swagger_types = { + 'type': 'str' + } + + self.attribute_map = { + 'type': 'type' + } + + self._type = None + self._type = 'REQUIRED' + + 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/generative_ai_inference/models/tool_definition.py b/src/oci/generative_ai_inference/models/tool_definition.py new file mode 100644 index 0000000000..1d3ff6df9b --- /dev/null +++ b/src/oci/generative_ai_inference/models/tool_definition.py @@ -0,0 +1,101 @@ +# coding: utf-8 +# Copyright (c) 2016, 2025, 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: 20231130 + + +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 ToolDefinition(object): + """ + A tool the model may call. + """ + + #: A constant which can be used with the type property of a ToolDefinition. + #: This constant has a value of "FUNCTION" + TYPE_FUNCTION = "FUNCTION" + + def __init__(self, **kwargs): + """ + Initializes a new ToolDefinition 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.generative_ai_inference.models.FunctionDefinition` + + 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 ToolDefinition. + Allowed values for this property are: "FUNCTION" + :type type: str + + """ + self.swagger_types = { + 'type': 'str' + } + + self.attribute_map = { + 'type': 'type' + } + + self._type = 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['type'] + + if type == 'FUNCTION': + return 'FunctionDefinition' + else: + return 'ToolDefinition' + + @property + def type(self): + """ + **[Required]** Gets the type of this ToolDefinition. + The type of the tool. + + Allowed values for this property are: "FUNCTION" + + + :return: The type of this ToolDefinition. + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """ + Sets the type of this ToolDefinition. + The type of the tool. + + + :param type: The type of this ToolDefinition. + :type: str + """ + allowed_values = ["FUNCTION"] + if not value_allowed_none_or_none_sentinel(type, allowed_values): + raise ValueError( + f"Invalid value for `type`, must be None or one of {allowed_values}" + ) + self._type = type + + 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/generative_ai_inference/models/tool_message.py b/src/oci/generative_ai_inference/models/tool_message.py new file mode 100644 index 0000000000..fc0eecdfe9 --- /dev/null +++ b/src/oci/generative_ai_inference/models/tool_message.py @@ -0,0 +1,89 @@ +# coding: utf-8 +# Copyright (c) 2016, 2025, 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: 20231130 + +from .message import Message +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 ToolMessage(Message): + """ + Represents a single instance of tool message. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ToolMessage object with values from keyword arguments. The default value of the :py:attr:`~oci.generative_ai_inference.models.ToolMessage.role` attribute + of this class is ``TOOL`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param role: + The value to assign to the role property of this ToolMessage. + Allowed values for this property are: "SYSTEM", "USER", "ASSISTANT", "TOOL" + :type role: str + + :param content: + The value to assign to the content property of this ToolMessage. + :type content: list[oci.generative_ai_inference.models.ChatContent] + + :param tool_call_id: + The value to assign to the tool_call_id property of this ToolMessage. + :type tool_call_id: str + + """ + self.swagger_types = { + 'role': 'str', + 'content': 'list[ChatContent]', + 'tool_call_id': 'str' + } + + self.attribute_map = { + 'role': 'role', + 'content': 'content', + 'tool_call_id': 'toolCallId' + } + + self._role = None + self._content = None + self._tool_call_id = None + self._role = 'TOOL' + + @property + def tool_call_id(self): + """ + Gets the tool_call_id of this ToolMessage. + Tool call that this message is responding to. + + + :return: The tool_call_id of this ToolMessage. + :rtype: str + """ + return self._tool_call_id + + @tool_call_id.setter + def tool_call_id(self, tool_call_id): + """ + Sets the tool_call_id of this ToolMessage. + Tool call that this message is responding to. + + + :param tool_call_id: The tool_call_id of this ToolMessage. + :type: str + """ + self._tool_call_id = tool_call_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/generative_ai_inference/models/user_message.py b/src/oci/generative_ai_inference/models/user_message.py index 08e0f665c0..682e3a2bcc 100644 --- a/src/oci/generative_ai_inference/models/user_message.py +++ b/src/oci/generative_ai_inference/models/user_message.py @@ -23,7 +23,7 @@ def __init__(self, **kwargs): :param role: The value to assign to the role property of this UserMessage. - Allowed values for this property are: "SYSTEM", "USER", "ASSISTANT" + Allowed values for this property are: "SYSTEM", "USER", "ASSISTANT", "TOOL" :type role: str :param content: diff --git a/src/oci/mysql/models/__init__.py b/src/oci/mysql/models/__init__.py index 4c529aba60..60cb948950 100644 --- a/src/oci/mysql/models/__init__.py +++ b/src/oci/mysql/models/__init__.py @@ -42,6 +42,7 @@ from .create_db_system_source_import_from_url_details import CreateDbSystemSourceImportFromUrlDetails from .create_deletion_policy_details import CreateDeletionPolicyDetails from .create_maintenance_details import CreateMaintenanceDetails +from .create_read_endpoint_details import CreateReadEndpointDetails from .create_replica_details import CreateReplicaDetails from .customer_contact import CustomerContact from .data_storage import DataStorage @@ -70,6 +71,7 @@ from .pem_ca_certificate import PemCaCertificate from .pitr_policy import PitrPolicy from .point_in_time_recovery_details import PointInTimeRecoveryDetails +from .read_endpoint_details import ReadEndpointDetails from .replica import Replica from .replica_overrides import ReplicaOverrides from .replica_summary import ReplicaSummary @@ -89,6 +91,7 @@ from .update_deletion_policy_details import UpdateDeletionPolicyDetails from .update_heat_wave_cluster_details import UpdateHeatWaveClusterDetails from .update_maintenance_details import UpdateMaintenanceDetails +from .update_read_endpoint_details import UpdateReadEndpointDetails from .update_replica_details import UpdateReplicaDetails from .version import Version from .version_summary import VersionSummary @@ -136,6 +139,7 @@ "CreateDbSystemSourceImportFromUrlDetails": CreateDbSystemSourceImportFromUrlDetails, "CreateDeletionPolicyDetails": CreateDeletionPolicyDetails, "CreateMaintenanceDetails": CreateMaintenanceDetails, + "CreateReadEndpointDetails": CreateReadEndpointDetails, "CreateReplicaDetails": CreateReplicaDetails, "CustomerContact": CustomerContact, "DataStorage": DataStorage, @@ -164,6 +168,7 @@ "PemCaCertificate": PemCaCertificate, "PitrPolicy": PitrPolicy, "PointInTimeRecoveryDetails": PointInTimeRecoveryDetails, + "ReadEndpointDetails": ReadEndpointDetails, "Replica": Replica, "ReplicaOverrides": ReplicaOverrides, "ReplicaSummary": ReplicaSummary, @@ -183,6 +188,7 @@ "UpdateDeletionPolicyDetails": UpdateDeletionPolicyDetails, "UpdateHeatWaveClusterDetails": UpdateHeatWaveClusterDetails, "UpdateMaintenanceDetails": UpdateMaintenanceDetails, + "UpdateReadEndpointDetails": UpdateReadEndpointDetails, "UpdateReplicaDetails": UpdateReplicaDetails, "Version": Version, "VersionSummary": VersionSummary, diff --git a/src/oci/mysql/models/create_db_system_details.py b/src/oci/mysql/models/create_db_system_details.py index 83807dedeb..004ddc11d0 100644 --- a/src/oci/mysql/models/create_db_system_details.py +++ b/src/oci/mysql/models/create_db_system_details.py @@ -146,10 +146,22 @@ def __init__(self, **kwargs): The value to assign to the secure_connections property of this CreateDbSystemDetails. :type secure_connections: oci.mysql.models.SecureConnectionDetails + :param database_mode: + The value to assign to the database_mode property of this CreateDbSystemDetails. + :type database_mode: str + + :param access_mode: + The value to assign to the access_mode property of this CreateDbSystemDetails. + :type access_mode: str + :param customer_contacts: The value to assign to the customer_contacts property of this CreateDbSystemDetails. :type customer_contacts: list[oci.mysql.models.CustomerContact] + :param read_endpoint: + The value to assign to the read_endpoint property of this CreateDbSystemDetails. + :type read_endpoint: oci.mysql.models.CreateReadEndpointDetails + """ self.swagger_types = { 'display_name': 'str', @@ -179,7 +191,10 @@ def __init__(self, **kwargs): 'crash_recovery': 'str', 'database_management': 'str', 'secure_connections': 'SecureConnectionDetails', - 'customer_contacts': 'list[CustomerContact]' + 'database_mode': 'str', + 'access_mode': 'str', + 'customer_contacts': 'list[CustomerContact]', + 'read_endpoint': 'CreateReadEndpointDetails' } self.attribute_map = { @@ -210,7 +225,10 @@ def __init__(self, **kwargs): 'crash_recovery': 'crashRecovery', 'database_management': 'databaseManagement', 'secure_connections': 'secureConnections', - 'customer_contacts': 'customerContacts' + 'database_mode': 'databaseMode', + 'access_mode': 'accessMode', + 'customer_contacts': 'customerContacts', + 'read_endpoint': 'readEndpoint' } self._display_name = None @@ -240,7 +258,10 @@ def __init__(self, **kwargs): self._crash_recovery = None self._database_management = None self._secure_connections = None + self._database_mode = None + self._access_mode = None self._customer_contacts = None + self._read_endpoint = None @property def display_name(self): @@ -956,6 +977,74 @@ def secure_connections(self, secure_connections): """ self._secure_connections = secure_connections + @property + def database_mode(self): + """ + Gets the database_mode of this CreateDbSystemDetails. + The database mode indicating the types of statements that will be allowed to run in the DB system. + This mode will apply only to statements run by user connections. Replicated write statements will continue + to be allowed regardless of the DatabaseMode. + - READ_WRITE (default): allow running read and write statements on the DB system; + - READ_ONLY: only allow running read statements on the DB system. + + + :return: The database_mode of this CreateDbSystemDetails. + :rtype: str + """ + return self._database_mode + + @database_mode.setter + def database_mode(self, database_mode): + """ + Sets the database_mode of this CreateDbSystemDetails. + The database mode indicating the types of statements that will be allowed to run in the DB system. + This mode will apply only to statements run by user connections. Replicated write statements will continue + to be allowed regardless of the DatabaseMode. + - READ_WRITE (default): allow running read and write statements on the DB system; + - READ_ONLY: only allow running read statements on the DB system. + + + :param database_mode: The database_mode of this CreateDbSystemDetails. + :type: str + """ + self._database_mode = database_mode + + @property + def access_mode(self): + """ + Gets the access_mode of this CreateDbSystemDetails. + The access mode indicating if the database access will be restricted only to administrators or not: + - UNRESTRICTED (default): the access to the database is not restricted; + - RESTRICTED: the access will be allowed only to users with specific privileges; + RESTRICTED will correspond to setting the MySQL system variable + `offline_mode`__ to ON. + + __ https://dev.mysql.com/doc/en/server-system-variables.html#sysvar_offline_mode + + + :return: The access_mode of this CreateDbSystemDetails. + :rtype: str + """ + return self._access_mode + + @access_mode.setter + def access_mode(self, access_mode): + """ + Sets the access_mode of this CreateDbSystemDetails. + The access mode indicating if the database access will be restricted only to administrators or not: + - UNRESTRICTED (default): the access to the database is not restricted; + - RESTRICTED: the access will be allowed only to users with specific privileges; + RESTRICTED will correspond to setting the MySQL system variable + `offline_mode`__ to ON. + + __ https://dev.mysql.com/doc/en/server-system-variables.html#sysvar_offline_mode + + + :param access_mode: The access_mode of this CreateDbSystemDetails. + :type: str + """ + self._access_mode = access_mode + @property def customer_contacts(self): """ @@ -984,6 +1073,26 @@ def customer_contacts(self, customer_contacts): """ self._customer_contacts = customer_contacts + @property + def read_endpoint(self): + """ + Gets the read_endpoint of this CreateDbSystemDetails. + + :return: The read_endpoint of this CreateDbSystemDetails. + :rtype: oci.mysql.models.CreateReadEndpointDetails + """ + return self._read_endpoint + + @read_endpoint.setter + def read_endpoint(self, read_endpoint): + """ + Sets the read_endpoint of this CreateDbSystemDetails. + + :param read_endpoint: The read_endpoint of this CreateDbSystemDetails. + :type: oci.mysql.models.CreateReadEndpointDetails + """ + self._read_endpoint = read_endpoint + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/mysql/models/create_read_endpoint_details.py b/src/oci/mysql/models/create_read_endpoint_details.py new file mode 100644 index 0000000000..b97ae31bfb --- /dev/null +++ b/src/oci/mysql/models/create_read_endpoint_details.py @@ -0,0 +1,183 @@ +# coding: utf-8 +# Copyright (c) 2016, 2025, 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: 20190415 + + +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 CreateReadEndpointDetails(object): + """ + Details required to create a Read Endpoint. + """ + + def __init__(self, **kwargs): + """ + Initializes a new CreateReadEndpointDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param is_enabled: + The value to assign to the is_enabled property of this CreateReadEndpointDetails. + :type is_enabled: bool + + :param read_endpoint_ip_address: + The value to assign to the read_endpoint_ip_address property of this CreateReadEndpointDetails. + :type read_endpoint_ip_address: str + + :param read_endpoint_hostname_label: + The value to assign to the read_endpoint_hostname_label property of this CreateReadEndpointDetails. + :type read_endpoint_hostname_label: str + + :param exclude_ips: + The value to assign to the exclude_ips property of this CreateReadEndpointDetails. + :type exclude_ips: list[str] + + """ + self.swagger_types = { + 'is_enabled': 'bool', + 'read_endpoint_ip_address': 'str', + 'read_endpoint_hostname_label': 'str', + 'exclude_ips': 'list[str]' + } + + self.attribute_map = { + 'is_enabled': 'isEnabled', + 'read_endpoint_ip_address': 'readEndpointIpAddress', + 'read_endpoint_hostname_label': 'readEndpointHostnameLabel', + 'exclude_ips': 'excludeIps' + } + + self._is_enabled = None + self._read_endpoint_ip_address = None + self._read_endpoint_hostname_label = None + self._exclude_ips = None + + @property + def is_enabled(self): + """ + Gets the is_enabled of this CreateReadEndpointDetails. + Specifies if the DB System read endpoint is enabled or not. + + + :return: The is_enabled of this CreateReadEndpointDetails. + :rtype: bool + """ + return self._is_enabled + + @is_enabled.setter + def is_enabled(self, is_enabled): + """ + Sets the is_enabled of this CreateReadEndpointDetails. + Specifies if the DB System read endpoint is enabled or not. + + + :param is_enabled: The is_enabled of this CreateReadEndpointDetails. + :type: bool + """ + self._is_enabled = is_enabled + + @property + def read_endpoint_ip_address(self): + """ + Gets the read_endpoint_ip_address of this CreateReadEndpointDetails. + The IP address the DB System read endpoint is configured to listen on. + A private IP address of your choice to assign to the read endpoint of the DB System. + Must be an available IP address within the subnet's CIDR. If you don't specify a value, + Oracle automatically assigns a private IP address from the subnet. This should be a + \"dotted-quad\" style IPv4 address. + + + :return: The read_endpoint_ip_address of this CreateReadEndpointDetails. + :rtype: str + """ + return self._read_endpoint_ip_address + + @read_endpoint_ip_address.setter + def read_endpoint_ip_address(self, read_endpoint_ip_address): + """ + Sets the read_endpoint_ip_address of this CreateReadEndpointDetails. + The IP address the DB System read endpoint is configured to listen on. + A private IP address of your choice to assign to the read endpoint of the DB System. + Must be an available IP address within the subnet's CIDR. If you don't specify a value, + Oracle automatically assigns a private IP address from the subnet. This should be a + \"dotted-quad\" style IPv4 address. + + + :param read_endpoint_ip_address: The read_endpoint_ip_address of this CreateReadEndpointDetails. + :type: str + """ + self._read_endpoint_ip_address = read_endpoint_ip_address + + @property + def read_endpoint_hostname_label(self): + """ + Gets the read_endpoint_hostname_label of this CreateReadEndpointDetails. + The hostname for the read endpoint of the DB System. Used for DNS. + + The value is the hostname portion of the primary private IP's fully qualified domain name (FQDN) + (for example, \"dbsystem-1\" in FQDN \"dbsystem-1.subnet123.vcn1.oraclevcn.com\"). + + Must be unique across all VNICs in the subnet and comply with RFC 952 and RFC 1123. + + + :return: The read_endpoint_hostname_label of this CreateReadEndpointDetails. + :rtype: str + """ + return self._read_endpoint_hostname_label + + @read_endpoint_hostname_label.setter + def read_endpoint_hostname_label(self, read_endpoint_hostname_label): + """ + Sets the read_endpoint_hostname_label of this CreateReadEndpointDetails. + The hostname for the read endpoint of the DB System. Used for DNS. + + The value is the hostname portion of the primary private IP's fully qualified domain name (FQDN) + (for example, \"dbsystem-1\" in FQDN \"dbsystem-1.subnet123.vcn1.oraclevcn.com\"). + + Must be unique across all VNICs in the subnet and comply with RFC 952 and RFC 1123. + + + :param read_endpoint_hostname_label: The read_endpoint_hostname_label of this CreateReadEndpointDetails. + :type: str + """ + self._read_endpoint_hostname_label = read_endpoint_hostname_label + + @property + def exclude_ips(self): + """ + Gets the exclude_ips of this CreateReadEndpointDetails. + A list of IP addresses of read replicas that are excluded from serving read requests. + + + :return: The exclude_ips of this CreateReadEndpointDetails. + :rtype: list[str] + """ + return self._exclude_ips + + @exclude_ips.setter + def exclude_ips(self, exclude_ips): + """ + Sets the exclude_ips of this CreateReadEndpointDetails. + A list of IP addresses of read replicas that are excluded from serving read requests. + + + :param exclude_ips: The exclude_ips of this CreateReadEndpointDetails. + :type: list[str] + """ + self._exclude_ips = exclude_ips + + 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/mysql/models/db_system.py b/src/oci/mysql/models/db_system.py index 093a606f22..3bf4401521 100644 --- a/src/oci/mysql/models/db_system.py +++ b/src/oci/mysql/models/db_system.py @@ -59,6 +59,22 @@ class DbSystem(object): #: This constant has a value of "DISABLED" DATABASE_MANAGEMENT_DISABLED = "DISABLED" + #: A constant which can be used with the database_mode property of a DbSystem. + #: This constant has a value of "READ_WRITE" + DATABASE_MODE_READ_WRITE = "READ_WRITE" + + #: A constant which can be used with the database_mode property of a DbSystem. + #: This constant has a value of "READ_ONLY" + DATABASE_MODE_READ_ONLY = "READ_ONLY" + + #: A constant which can be used with the access_mode property of a DbSystem. + #: This constant has a value of "UNRESTRICTED" + ACCESS_MODE_UNRESTRICTED = "UNRESTRICTED" + + #: A constant which can be used with the access_mode property of a DbSystem. + #: This constant has a value of "RESTRICTED" + ACCESS_MODE_RESTRICTED = "RESTRICTED" + def __init__(self, **kwargs): """ Initializes a new DbSystem object with values from keyword arguments. @@ -214,10 +230,26 @@ def __init__(self, **kwargs): The value to assign to the secure_connections property of this DbSystem. :type secure_connections: oci.mysql.models.SecureConnectionDetails + :param database_mode: + The value to assign to the database_mode property of this DbSystem. + Allowed values for this property are: "READ_WRITE", "READ_ONLY", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type database_mode: str + + :param access_mode: + The value to assign to the access_mode property of this DbSystem. + Allowed values for this property are: "UNRESTRICTED", "RESTRICTED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type access_mode: str + :param customer_contacts: The value to assign to the customer_contacts property of this DbSystem. :type customer_contacts: list[oci.mysql.models.CustomerContact] + :param read_endpoint: + The value to assign to the read_endpoint property of this DbSystem. + :type read_endpoint: oci.mysql.models.ReadEndpointDetails + """ self.swagger_types = { 'id': 'str', @@ -256,7 +288,10 @@ def __init__(self, **kwargs): 'point_in_time_recovery_details': 'PointInTimeRecoveryDetails', 'database_management': 'str', 'secure_connections': 'SecureConnectionDetails', - 'customer_contacts': 'list[CustomerContact]' + 'database_mode': 'str', + 'access_mode': 'str', + 'customer_contacts': 'list[CustomerContact]', + 'read_endpoint': 'ReadEndpointDetails' } self.attribute_map = { @@ -296,7 +331,10 @@ def __init__(self, **kwargs): 'point_in_time_recovery_details': 'pointInTimeRecoveryDetails', 'database_management': 'databaseManagement', 'secure_connections': 'secureConnections', - 'customer_contacts': 'customerContacts' + 'database_mode': 'databaseMode', + 'access_mode': 'accessMode', + 'customer_contacts': 'customerContacts', + 'read_endpoint': 'readEndpoint' } self._id = None @@ -335,7 +373,10 @@ def __init__(self, **kwargs): self._point_in_time_recovery_details = None self._database_management = None self._secure_connections = None + self._database_mode = None + self._access_mode = None self._customer_contacts = None + self._read_endpoint = None @property def id(self): @@ -1235,6 +1276,88 @@ def secure_connections(self, secure_connections): """ self._secure_connections = secure_connections + @property + def database_mode(self): + """ + **[Required]** Gets the database_mode of this DbSystem. + The database mode indicating the types of statements that are allowed to run in the the DB system. + This mode applies only to statements run by user connections. Replicated write statements continue + to be allowed regardless of the DatabaseMode. + - READ_WRITE: allow running read and write statements on the DB system; + - READ_ONLY: only allow running read statements on the DB system. + + Allowed values for this property are: "READ_WRITE", "READ_ONLY", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The database_mode of this DbSystem. + :rtype: str + """ + return self._database_mode + + @database_mode.setter + def database_mode(self, database_mode): + """ + Sets the database_mode of this DbSystem. + The database mode indicating the types of statements that are allowed to run in the the DB system. + This mode applies only to statements run by user connections. Replicated write statements continue + to be allowed regardless of the DatabaseMode. + - READ_WRITE: allow running read and write statements on the DB system; + - READ_ONLY: only allow running read statements on the DB system. + + + :param database_mode: The database_mode of this DbSystem. + :type: str + """ + allowed_values = ["READ_WRITE", "READ_ONLY"] + if not value_allowed_none_or_none_sentinel(database_mode, allowed_values): + database_mode = 'UNKNOWN_ENUM_VALUE' + self._database_mode = database_mode + + @property + def access_mode(self): + """ + **[Required]** Gets the access_mode of this DbSystem. + The access mode indicating if the database access is unrestricted (to all MySQL user accounts), + or restricted (to only certain users with specific privileges): + - UNRESTRICTED: the access to the database is not restricted; + - RESTRICTED: access allowed only to users with specific privileges; + RESTRICTED will correspond to setting the MySQL system variable + `offline_mode`__ to ON. + + __ https://dev.mysql.com/doc/en/server-system-variables.html#sysvar_offline_mode + + Allowed values for this property are: "UNRESTRICTED", "RESTRICTED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The access_mode of this DbSystem. + :rtype: str + """ + return self._access_mode + + @access_mode.setter + def access_mode(self, access_mode): + """ + Sets the access_mode of this DbSystem. + The access mode indicating if the database access is unrestricted (to all MySQL user accounts), + or restricted (to only certain users with specific privileges): + - UNRESTRICTED: the access to the database is not restricted; + - RESTRICTED: access allowed only to users with specific privileges; + RESTRICTED will correspond to setting the MySQL system variable + `offline_mode`__ to ON. + + __ https://dev.mysql.com/doc/en/server-system-variables.html#sysvar_offline_mode + + + :param access_mode: The access_mode of this DbSystem. + :type: str + """ + allowed_values = ["UNRESTRICTED", "RESTRICTED"] + if not value_allowed_none_or_none_sentinel(access_mode, allowed_values): + access_mode = 'UNKNOWN_ENUM_VALUE' + self._access_mode = access_mode + @property def customer_contacts(self): """ @@ -1263,6 +1386,26 @@ def customer_contacts(self, customer_contacts): """ self._customer_contacts = customer_contacts + @property + def read_endpoint(self): + """ + Gets the read_endpoint of this DbSystem. + + :return: The read_endpoint of this DbSystem. + :rtype: oci.mysql.models.ReadEndpointDetails + """ + return self._read_endpoint + + @read_endpoint.setter + def read_endpoint(self, read_endpoint): + """ + Sets the read_endpoint of this DbSystem. + + :param read_endpoint: The read_endpoint of this DbSystem. + :type: oci.mysql.models.ReadEndpointDetails + """ + self._read_endpoint = read_endpoint + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/mysql/models/db_system_endpoint.py b/src/oci/mysql/models/db_system_endpoint.py index c290ac1fe0..0d8cd17160 100644 --- a/src/oci/mysql/models/db_system_endpoint.py +++ b/src/oci/mysql/models/db_system_endpoint.py @@ -47,6 +47,10 @@ class DbSystemEndpoint(object): #: This constant has a value of "LOAD_BALANCER" RESOURCE_TYPE_LOAD_BALANCER = "LOAD_BALANCER" + #: A constant which can be used with the resource_type property of a DbSystemEndpoint. + #: This constant has a value of "READ_ENDPOINT" + RESOURCE_TYPE_READ_ENDPOINT = "READ_ENDPOINT" + def __init__(self, **kwargs): """ Initializes a new DbSystemEndpoint object with values from keyword arguments. @@ -86,7 +90,7 @@ def __init__(self, **kwargs): :param resource_type: The value to assign to the resource_type property of this DbSystemEndpoint. - Allowed values for this property are: "DBSYSTEM", "READ_REPLICA", "LOAD_BALANCER", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "DBSYSTEM", "READ_REPLICA", "LOAD_BALANCER", "READ_ENDPOINT", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type resource_type: str @@ -317,7 +321,7 @@ def resource_type(self): Gets the resource_type of this DbSystemEndpoint. The type of endpoint that clients and connectors can connect to. - Allowed values for this property are: "DBSYSTEM", "READ_REPLICA", "LOAD_BALANCER", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "DBSYSTEM", "READ_REPLICA", "LOAD_BALANCER", "READ_ENDPOINT", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -336,7 +340,7 @@ def resource_type(self, resource_type): :param resource_type: The resource_type of this DbSystemEndpoint. :type: str """ - allowed_values = ["DBSYSTEM", "READ_REPLICA", "LOAD_BALANCER"] + allowed_values = ["DBSYSTEM", "READ_REPLICA", "LOAD_BALANCER", "READ_ENDPOINT"] if not value_allowed_none_or_none_sentinel(resource_type, allowed_values): resource_type = 'UNKNOWN_ENUM_VALUE' self._resource_type = resource_type diff --git a/src/oci/mysql/models/db_system_snapshot.py b/src/oci/mysql/models/db_system_snapshot.py index 694d02a019..d8c5592bd0 100644 --- a/src/oci/mysql/models/db_system_snapshot.py +++ b/src/oci/mysql/models/db_system_snapshot.py @@ -152,6 +152,10 @@ def __init__(self, **kwargs): The value to assign to the region property of this DbSystemSnapshot. :type region: str + :param read_endpoint: + The value to assign to the read_endpoint property of this DbSystemSnapshot. + :type read_endpoint: oci.mysql.models.ReadEndpointDetails + """ self.swagger_types = { 'id': 'str', @@ -181,7 +185,8 @@ def __init__(self, **kwargs): 'crash_recovery': 'str', 'database_management': 'str', 'secure_connections': 'SecureConnectionDetails', - 'region': 'str' + 'region': 'str', + 'read_endpoint': 'ReadEndpointDetails' } self.attribute_map = { @@ -212,7 +217,8 @@ def __init__(self, **kwargs): 'crash_recovery': 'crashRecovery', 'database_management': 'databaseManagement', 'secure_connections': 'secureConnections', - 'region': 'region' + 'region': 'region', + 'read_endpoint': 'readEndpoint' } self._id = None @@ -243,6 +249,7 @@ def __init__(self, **kwargs): self._database_management = None self._secure_connections = None self._region = None + self._read_endpoint = None @property def id(self): @@ -942,6 +949,26 @@ def region(self, region): """ self._region = region + @property + def read_endpoint(self): + """ + Gets the read_endpoint of this DbSystemSnapshot. + + :return: The read_endpoint of this DbSystemSnapshot. + :rtype: oci.mysql.models.ReadEndpointDetails + """ + return self._read_endpoint + + @read_endpoint.setter + def read_endpoint(self, read_endpoint): + """ + Sets the read_endpoint of this DbSystemSnapshot. + + :param read_endpoint: The read_endpoint of this DbSystemSnapshot. + :type: oci.mysql.models.ReadEndpointDetails + """ + self._read_endpoint = read_endpoint + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/mysql/models/db_system_summary.py b/src/oci/mysql/models/db_system_summary.py index 4fdb6ef109..2bdacc646d 100644 --- a/src/oci/mysql/models/db_system_summary.py +++ b/src/oci/mysql/models/db_system_summary.py @@ -128,6 +128,18 @@ def __init__(self, **kwargs): Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type database_management: str + :param database_mode: + The value to assign to the database_mode property of this DbSystemSummary. + :type database_mode: str + + :param access_mode: + The value to assign to the access_mode property of this DbSystemSummary. + :type access_mode: str + + :param read_endpoint: + The value to assign to the read_endpoint property of this DbSystemSummary. + :type read_endpoint: oci.mysql.models.ReadEndpointDetails + """ self.swagger_types = { 'id': 'str', @@ -151,7 +163,10 @@ def __init__(self, **kwargs): 'backup_policy': 'BackupPolicy', 'shape_name': 'str', 'crash_recovery': 'str', - 'database_management': 'str' + 'database_management': 'str', + 'database_mode': 'str', + 'access_mode': 'str', + 'read_endpoint': 'ReadEndpointDetails' } self.attribute_map = { @@ -176,7 +191,10 @@ def __init__(self, **kwargs): 'backup_policy': 'backupPolicy', 'shape_name': 'shapeName', 'crash_recovery': 'crashRecovery', - 'database_management': 'databaseManagement' + 'database_management': 'databaseManagement', + 'database_mode': 'databaseMode', + 'access_mode': 'accessMode', + 'read_endpoint': 'readEndpoint' } self._id = None @@ -201,6 +219,9 @@ def __init__(self, **kwargs): self._shape_name = None self._crash_recovery = None self._database_management = None + self._database_mode = None + self._access_mode = None + self._read_endpoint = None @property def id(self): @@ -764,6 +785,96 @@ def database_management(self, database_management): database_management = 'UNKNOWN_ENUM_VALUE' self._database_management = database_management + @property + def database_mode(self): + """ + **[Required]** Gets the database_mode of this DbSystemSummary. + The database mode indicating the types of statements that are allowed to run in the DB system. + This mode applies only to statements run by user connections. Replicated write statements continue + to be allowed regardless of the DatabaseMode. + - READ_WRITE: allow running read and write statements on the DB system; + - READ_ONLY: only allow running read statements on the DB system. + + + :return: The database_mode of this DbSystemSummary. + :rtype: str + """ + return self._database_mode + + @database_mode.setter + def database_mode(self, database_mode): + """ + Sets the database_mode of this DbSystemSummary. + The database mode indicating the types of statements that are allowed to run in the DB system. + This mode applies only to statements run by user connections. Replicated write statements continue + to be allowed regardless of the DatabaseMode. + - READ_WRITE: allow running read and write statements on the DB system; + - READ_ONLY: only allow running read statements on the DB system. + + + :param database_mode: The database_mode of this DbSystemSummary. + :type: str + """ + self._database_mode = database_mode + + @property + def access_mode(self): + """ + **[Required]** Gets the access_mode of this DbSystemSummary. + The access mode indicating if the database access is unrestricted (to all MySQL user accounts), + or restricted (to only certain users with specific privileges): + - UNRESTRICTED: the access to the database is not restricted; + - RESTRICTED: the access is allowed only to users with specific privileges; + RESTRICTED will correspond to setting the MySQL system variable + `offline_mode`__ to ON. + + __ https://dev.mysql.com/doc/en/server-system-variables.html#sysvar_offline_mode + + + :return: The access_mode of this DbSystemSummary. + :rtype: str + """ + return self._access_mode + + @access_mode.setter + def access_mode(self, access_mode): + """ + Sets the access_mode of this DbSystemSummary. + The access mode indicating if the database access is unrestricted (to all MySQL user accounts), + or restricted (to only certain users with specific privileges): + - UNRESTRICTED: the access to the database is not restricted; + - RESTRICTED: the access is allowed only to users with specific privileges; + RESTRICTED will correspond to setting the MySQL system variable + `offline_mode`__ to ON. + + __ https://dev.mysql.com/doc/en/server-system-variables.html#sysvar_offline_mode + + + :param access_mode: The access_mode of this DbSystemSummary. + :type: str + """ + self._access_mode = access_mode + + @property + def read_endpoint(self): + """ + Gets the read_endpoint of this DbSystemSummary. + + :return: The read_endpoint of this DbSystemSummary. + :rtype: oci.mysql.models.ReadEndpointDetails + """ + return self._read_endpoint + + @read_endpoint.setter + def read_endpoint(self, read_endpoint): + """ + Sets the read_endpoint of this DbSystemSummary. + + :param read_endpoint: The read_endpoint of this DbSystemSummary. + :type: oci.mysql.models.ReadEndpointDetails + """ + self._read_endpoint = read_endpoint + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/mysql/models/read_endpoint_details.py b/src/oci/mysql/models/read_endpoint_details.py new file mode 100644 index 0000000000..06e242fc5b --- /dev/null +++ b/src/oci/mysql/models/read_endpoint_details.py @@ -0,0 +1,183 @@ +# coding: utf-8 +# Copyright (c) 2016, 2025, 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: 20190415 + + +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 ReadEndpointDetails(object): + """ + The read endpoint of a DB System. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ReadEndpointDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param is_enabled: + The value to assign to the is_enabled property of this ReadEndpointDetails. + :type is_enabled: bool + + :param read_endpoint_ip_address: + The value to assign to the read_endpoint_ip_address property of this ReadEndpointDetails. + :type read_endpoint_ip_address: str + + :param read_endpoint_hostname_label: + The value to assign to the read_endpoint_hostname_label property of this ReadEndpointDetails. + :type read_endpoint_hostname_label: str + + :param exclude_ips: + The value to assign to the exclude_ips property of this ReadEndpointDetails. + :type exclude_ips: list[str] + + """ + self.swagger_types = { + 'is_enabled': 'bool', + 'read_endpoint_ip_address': 'str', + 'read_endpoint_hostname_label': 'str', + 'exclude_ips': 'list[str]' + } + + self.attribute_map = { + 'is_enabled': 'isEnabled', + 'read_endpoint_ip_address': 'readEndpointIpAddress', + 'read_endpoint_hostname_label': 'readEndpointHostnameLabel', + 'exclude_ips': 'excludeIps' + } + + self._is_enabled = None + self._read_endpoint_ip_address = None + self._read_endpoint_hostname_label = None + self._exclude_ips = None + + @property + def is_enabled(self): + """ + Gets the is_enabled of this ReadEndpointDetails. + Specifies if the DB System read endpoint is enabled or not. + + + :return: The is_enabled of this ReadEndpointDetails. + :rtype: bool + """ + return self._is_enabled + + @is_enabled.setter + def is_enabled(self, is_enabled): + """ + Sets the is_enabled of this ReadEndpointDetails. + Specifies if the DB System read endpoint is enabled or not. + + + :param is_enabled: The is_enabled of this ReadEndpointDetails. + :type: bool + """ + self._is_enabled = is_enabled + + @property + def read_endpoint_ip_address(self): + """ + Gets the read_endpoint_ip_address of this ReadEndpointDetails. + The IP address the DB System read endpoint is configured to listen on. + A private IP address of your choice to assign to the read endpoint of the DB System. + Must be an available IP address within the subnet's CIDR. If you don't specify a value, + Oracle automatically assigns a private IP address from the subnet. This should be a + \"dotted-quad\" style IPv4 address. + + + :return: The read_endpoint_ip_address of this ReadEndpointDetails. + :rtype: str + """ + return self._read_endpoint_ip_address + + @read_endpoint_ip_address.setter + def read_endpoint_ip_address(self, read_endpoint_ip_address): + """ + Sets the read_endpoint_ip_address of this ReadEndpointDetails. + The IP address the DB System read endpoint is configured to listen on. + A private IP address of your choice to assign to the read endpoint of the DB System. + Must be an available IP address within the subnet's CIDR. If you don't specify a value, + Oracle automatically assigns a private IP address from the subnet. This should be a + \"dotted-quad\" style IPv4 address. + + + :param read_endpoint_ip_address: The read_endpoint_ip_address of this ReadEndpointDetails. + :type: str + """ + self._read_endpoint_ip_address = read_endpoint_ip_address + + @property + def read_endpoint_hostname_label(self): + """ + Gets the read_endpoint_hostname_label of this ReadEndpointDetails. + The hostname for the read endpoint of the DB System. Used for DNS. + + The value is the hostname portion of the primary private IP's fully qualified domain name (FQDN) + (for example, \"dbsystem-1\" in FQDN \"dbsystem-1.subnet123.vcn1.oraclevcn.com\"). + + Must be unique across all VNICs in the subnet and comply with RFC 952 and RFC 1123. + + + :return: The read_endpoint_hostname_label of this ReadEndpointDetails. + :rtype: str + """ + return self._read_endpoint_hostname_label + + @read_endpoint_hostname_label.setter + def read_endpoint_hostname_label(self, read_endpoint_hostname_label): + """ + Sets the read_endpoint_hostname_label of this ReadEndpointDetails. + The hostname for the read endpoint of the DB System. Used for DNS. + + The value is the hostname portion of the primary private IP's fully qualified domain name (FQDN) + (for example, \"dbsystem-1\" in FQDN \"dbsystem-1.subnet123.vcn1.oraclevcn.com\"). + + Must be unique across all VNICs in the subnet and comply with RFC 952 and RFC 1123. + + + :param read_endpoint_hostname_label: The read_endpoint_hostname_label of this ReadEndpointDetails. + :type: str + """ + self._read_endpoint_hostname_label = read_endpoint_hostname_label + + @property + def exclude_ips(self): + """ + Gets the exclude_ips of this ReadEndpointDetails. + A list of IP addresses of read replicas that are excluded from serving read requests. + + + :return: The exclude_ips of this ReadEndpointDetails. + :rtype: list[str] + """ + return self._exclude_ips + + @exclude_ips.setter + def exclude_ips(self, exclude_ips): + """ + Sets the exclude_ips of this ReadEndpointDetails. + A list of IP addresses of read replicas that are excluded from serving read requests. + + + :param exclude_ips: The exclude_ips of this ReadEndpointDetails. + :type: list[str] + """ + self._exclude_ips = exclude_ips + + 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/mysql/models/update_db_system_details.py b/src/oci/mysql/models/update_db_system_details.py index 1b1edaa2bd..0d29c128b7 100644 --- a/src/oci/mysql/models/update_db_system_details.py +++ b/src/oci/mysql/models/update_db_system_details.py @@ -48,6 +48,14 @@ def __init__(self, **kwargs): The value to assign to the subnet_id property of this UpdateDbSystemDetails. :type subnet_id: str + :param database_mode: + The value to assign to the database_mode property of this UpdateDbSystemDetails. + :type database_mode: str + + :param access_mode: + The value to assign to the access_mode property of this UpdateDbSystemDetails. + :type access_mode: str + :param is_highly_available: The value to assign to the is_highly_available property of this UpdateDbSystemDetails. :type is_highly_available: bool @@ -142,11 +150,17 @@ def __init__(self, **kwargs): The value to assign to the customer_contacts property of this UpdateDbSystemDetails. :type customer_contacts: list[oci.mysql.models.CustomerContact] + :param read_endpoint: + The value to assign to the read_endpoint property of this UpdateDbSystemDetails. + :type read_endpoint: oci.mysql.models.UpdateReadEndpointDetails + """ self.swagger_types = { 'display_name': 'str', 'description': 'str', 'subnet_id': 'str', + 'database_mode': 'str', + 'access_mode': 'str', 'is_highly_available': 'bool', 'availability_domain': 'str', 'fault_domain': 'str', @@ -169,13 +183,16 @@ def __init__(self, **kwargs): 'crash_recovery': 'str', 'database_management': 'str', 'secure_connections': 'SecureConnectionDetails', - 'customer_contacts': 'list[CustomerContact]' + 'customer_contacts': 'list[CustomerContact]', + 'read_endpoint': 'UpdateReadEndpointDetails' } self.attribute_map = { 'display_name': 'displayName', 'description': 'description', 'subnet_id': 'subnetId', + 'database_mode': 'databaseMode', + 'access_mode': 'accessMode', 'is_highly_available': 'isHighlyAvailable', 'availability_domain': 'availabilityDomain', 'fault_domain': 'faultDomain', @@ -198,12 +215,15 @@ def __init__(self, **kwargs): 'crash_recovery': 'crashRecovery', 'database_management': 'databaseManagement', 'secure_connections': 'secureConnections', - 'customer_contacts': 'customerContacts' + 'customer_contacts': 'customerContacts', + 'read_endpoint': 'readEndpoint' } self._display_name = None self._description = None self._subnet_id = None + self._database_mode = None + self._access_mode = None self._is_highly_available = None self._availability_domain = None self._fault_domain = None @@ -227,6 +247,7 @@ def __init__(self, **kwargs): self._database_management = None self._secure_connections = None self._customer_contacts = None + self._read_endpoint = None @property def display_name(self): @@ -300,6 +321,74 @@ def subnet_id(self, subnet_id): """ self._subnet_id = subnet_id + @property + def database_mode(self): + """ + Gets the database_mode of this UpdateDbSystemDetails. + The database mode indicating the types of statements that will be allowed to run in the DB system. + This mode will apply only to statements run by user connections. Replicated write statements will continue + to be allowed regardless of the DatabaseMode. + - READ_WRITE: allow running read and write statements on the DB system; + - READ_ONLY: only allow running read statements on the DB system. + + + :return: The database_mode of this UpdateDbSystemDetails. + :rtype: str + """ + return self._database_mode + + @database_mode.setter + def database_mode(self, database_mode): + """ + Sets the database_mode of this UpdateDbSystemDetails. + The database mode indicating the types of statements that will be allowed to run in the DB system. + This mode will apply only to statements run by user connections. Replicated write statements will continue + to be allowed regardless of the DatabaseMode. + - READ_WRITE: allow running read and write statements on the DB system; + - READ_ONLY: only allow running read statements on the DB system. + + + :param database_mode: The database_mode of this UpdateDbSystemDetails. + :type: str + """ + self._database_mode = database_mode + + @property + def access_mode(self): + """ + Gets the access_mode of this UpdateDbSystemDetails. + The access mode indicating if the database access will be restricted only to administrators or not: + - UNRESTRICTED: the access to the database is not restricted; + - RESTRICTED: the access will be allowed only to users with specific privileges; + RESTRICTED will correspond to setting the MySQL system variable + `offline_mode`__ to ON. + + __ https://dev.mysql.com/doc/en/server-system-variables.html#sysvar_offline_mode + + + :return: The access_mode of this UpdateDbSystemDetails. + :rtype: str + """ + return self._access_mode + + @access_mode.setter + def access_mode(self, access_mode): + """ + Sets the access_mode of this UpdateDbSystemDetails. + The access mode indicating if the database access will be restricted only to administrators or not: + - UNRESTRICTED: the access to the database is not restricted; + - RESTRICTED: the access will be allowed only to users with specific privileges; + RESTRICTED will correspond to setting the MySQL system variable + `offline_mode`__ to ON. + + __ https://dev.mysql.com/doc/en/server-system-variables.html#sysvar_offline_mode + + + :param access_mode: The access_mode of this UpdateDbSystemDetails. + :type: str + """ + self._access_mode = access_mode + @property def is_highly_available(self): """ @@ -940,6 +1029,26 @@ def customer_contacts(self, customer_contacts): """ self._customer_contacts = customer_contacts + @property + def read_endpoint(self): + """ + Gets the read_endpoint of this UpdateDbSystemDetails. + + :return: The read_endpoint of this UpdateDbSystemDetails. + :rtype: oci.mysql.models.UpdateReadEndpointDetails + """ + return self._read_endpoint + + @read_endpoint.setter + def read_endpoint(self, read_endpoint): + """ + Sets the read_endpoint of this UpdateDbSystemDetails. + + :param read_endpoint: The read_endpoint of this UpdateDbSystemDetails. + :type: oci.mysql.models.UpdateReadEndpointDetails + """ + self._read_endpoint = read_endpoint + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/mysql/models/update_read_endpoint_details.py b/src/oci/mysql/models/update_read_endpoint_details.py new file mode 100644 index 0000000000..7e4cac9ce6 --- /dev/null +++ b/src/oci/mysql/models/update_read_endpoint_details.py @@ -0,0 +1,183 @@ +# coding: utf-8 +# Copyright (c) 2016, 2025, 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: 20190415 + + +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 UpdateReadEndpointDetails(object): + """ + Read Endpoint details. + """ + + def __init__(self, **kwargs): + """ + Initializes a new UpdateReadEndpointDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param is_enabled: + The value to assign to the is_enabled property of this UpdateReadEndpointDetails. + :type is_enabled: bool + + :param read_endpoint_ip_address: + The value to assign to the read_endpoint_ip_address property of this UpdateReadEndpointDetails. + :type read_endpoint_ip_address: str + + :param read_endpoint_hostname_label: + The value to assign to the read_endpoint_hostname_label property of this UpdateReadEndpointDetails. + :type read_endpoint_hostname_label: str + + :param exclude_ips: + The value to assign to the exclude_ips property of this UpdateReadEndpointDetails. + :type exclude_ips: list[str] + + """ + self.swagger_types = { + 'is_enabled': 'bool', + 'read_endpoint_ip_address': 'str', + 'read_endpoint_hostname_label': 'str', + 'exclude_ips': 'list[str]' + } + + self.attribute_map = { + 'is_enabled': 'isEnabled', + 'read_endpoint_ip_address': 'readEndpointIpAddress', + 'read_endpoint_hostname_label': 'readEndpointHostnameLabel', + 'exclude_ips': 'excludeIps' + } + + self._is_enabled = None + self._read_endpoint_ip_address = None + self._read_endpoint_hostname_label = None + self._exclude_ips = None + + @property + def is_enabled(self): + """ + Gets the is_enabled of this UpdateReadEndpointDetails. + Specifies if the DB System read endpoint is enabled or not. + + + :return: The is_enabled of this UpdateReadEndpointDetails. + :rtype: bool + """ + return self._is_enabled + + @is_enabled.setter + def is_enabled(self, is_enabled): + """ + Sets the is_enabled of this UpdateReadEndpointDetails. + Specifies if the DB System read endpoint is enabled or not. + + + :param is_enabled: The is_enabled of this UpdateReadEndpointDetails. + :type: bool + """ + self._is_enabled = is_enabled + + @property + def read_endpoint_ip_address(self): + """ + Gets the read_endpoint_ip_address of this UpdateReadEndpointDetails. + The IP address the DB System read endpoint is configured to listen on. + A private IP address of your choice to assign to the read endpoint of the DB System. + Must be an available IP address within the subnet's CIDR. If you don't specify a value, + Oracle automatically assigns a private IP address from the subnet. This should be a + \"dotted-quad\" style IPv4 address. + + + :return: The read_endpoint_ip_address of this UpdateReadEndpointDetails. + :rtype: str + """ + return self._read_endpoint_ip_address + + @read_endpoint_ip_address.setter + def read_endpoint_ip_address(self, read_endpoint_ip_address): + """ + Sets the read_endpoint_ip_address of this UpdateReadEndpointDetails. + The IP address the DB System read endpoint is configured to listen on. + A private IP address of your choice to assign to the read endpoint of the DB System. + Must be an available IP address within the subnet's CIDR. If you don't specify a value, + Oracle automatically assigns a private IP address from the subnet. This should be a + \"dotted-quad\" style IPv4 address. + + + :param read_endpoint_ip_address: The read_endpoint_ip_address of this UpdateReadEndpointDetails. + :type: str + """ + self._read_endpoint_ip_address = read_endpoint_ip_address + + @property + def read_endpoint_hostname_label(self): + """ + Gets the read_endpoint_hostname_label of this UpdateReadEndpointDetails. + The hostname for the read endpoint of the DB System. Used for DNS. + + The value is the hostname portion of the primary private IP's fully qualified domain name (FQDN) + (for example, \"dbsystem-1\" in FQDN \"dbsystem-1.subnet123.vcn1.oraclevcn.com\"). + + Must be unique across all VNICs in the subnet and comply with RFC 952 and RFC 1123. + + + :return: The read_endpoint_hostname_label of this UpdateReadEndpointDetails. + :rtype: str + """ + return self._read_endpoint_hostname_label + + @read_endpoint_hostname_label.setter + def read_endpoint_hostname_label(self, read_endpoint_hostname_label): + """ + Sets the read_endpoint_hostname_label of this UpdateReadEndpointDetails. + The hostname for the read endpoint of the DB System. Used for DNS. + + The value is the hostname portion of the primary private IP's fully qualified domain name (FQDN) + (for example, \"dbsystem-1\" in FQDN \"dbsystem-1.subnet123.vcn1.oraclevcn.com\"). + + Must be unique across all VNICs in the subnet and comply with RFC 952 and RFC 1123. + + + :param read_endpoint_hostname_label: The read_endpoint_hostname_label of this UpdateReadEndpointDetails. + :type: str + """ + self._read_endpoint_hostname_label = read_endpoint_hostname_label + + @property + def exclude_ips(self): + """ + Gets the exclude_ips of this UpdateReadEndpointDetails. + A list of IP addresses of read replicas that are excluded from serving read requests. + + + :return: The exclude_ips of this UpdateReadEndpointDetails. + :rtype: list[str] + """ + return self._exclude_ips + + @exclude_ips.setter + def exclude_ips(self, exclude_ips): + """ + Sets the exclude_ips of this UpdateReadEndpointDetails. + A list of IP addresses of read replicas that are excluded from serving read requests. + + + :param exclude_ips: The exclude_ips of this UpdateReadEndpointDetails. + :type: list[str] + """ + self._exclude_ips = exclude_ips + + 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/discovery_details.py b/src/oci/stack_monitoring/models/discovery_details.py index 125eba9785..b089c496e9 100644 --- a/src/oci/stack_monitoring/models/discovery_details.py +++ b/src/oci/stack_monitoring/models/discovery_details.py @@ -79,6 +79,22 @@ class DiscoveryDetails(object): #: This constant has a value of "MICROSOFT_IIS" RESOURCE_TYPE_MICROSOFT_IIS = "MICROSOFT_IIS" + #: A constant which can be used with the resource_type property of a DiscoveryDetails. + #: This constant has a value of "NGINX" + RESOURCE_TYPE_NGINX = "NGINX" + + #: A constant which can be used with the resource_type property of a DiscoveryDetails. + #: This constant has a value of "JBOSS_SERVER" + RESOURCE_TYPE_JBOSS_SERVER = "JBOSS_SERVER" + + #: A constant which can be used with the resource_type property of a DiscoveryDetails. + #: This constant has a value of "JBOSS_DOMAIN" + RESOURCE_TYPE_JBOSS_DOMAIN = "JBOSS_DOMAIN" + + #: A constant which can be used with the resource_type property of a DiscoveryDetails. + #: This constant has a value of "ORACLE_JVM" + RESOURCE_TYPE_ORACLE_JVM = "ORACLE_JVM" + #: A constant which can be used with the license property of a DiscoveryDetails. #: This constant has a value of "STANDARD_EDITION" LICENSE_STANDARD_EDITION = "STANDARD_EDITION" @@ -98,7 +114,7 @@ def __init__(self, **kwargs): :param resource_type: The value to assign to the resource_type property of this DiscoveryDetails. - Allowed values for this property are: "WEBLOGIC_DOMAIN", "EBS_INSTANCE", "SQL_SERVER", "APACHE_TOMCAT", "ORACLE_DATABASE", "OCI_ORACLE_DB", "OCI_ORACLE_CDB", "OCI_ORACLE_PDB", "HOST", "ORACLE_PSFT", "ORACLE_MFT", "APACHE_HTTP_SERVER", "ORACLE_GOLDENGATE", "CUSTOM_RESOURCE", "ORACLE_HTTP_SERVER", "MICROSOFT_IIS", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "WEBLOGIC_DOMAIN", "EBS_INSTANCE", "SQL_SERVER", "APACHE_TOMCAT", "ORACLE_DATABASE", "OCI_ORACLE_DB", "OCI_ORACLE_CDB", "OCI_ORACLE_PDB", "HOST", "ORACLE_PSFT", "ORACLE_MFT", "APACHE_HTTP_SERVER", "ORACLE_GOLDENGATE", "CUSTOM_RESOURCE", "ORACLE_HTTP_SERVER", "MICROSOFT_IIS", "NGINX", "JBOSS_SERVER", "JBOSS_DOMAIN", "ORACLE_JVM", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type resource_type: str @@ -183,7 +199,7 @@ def resource_type(self): **[Required]** Gets the resource_type of this DiscoveryDetails. Resource Type. - Allowed values for this property are: "WEBLOGIC_DOMAIN", "EBS_INSTANCE", "SQL_SERVER", "APACHE_TOMCAT", "ORACLE_DATABASE", "OCI_ORACLE_DB", "OCI_ORACLE_CDB", "OCI_ORACLE_PDB", "HOST", "ORACLE_PSFT", "ORACLE_MFT", "APACHE_HTTP_SERVER", "ORACLE_GOLDENGATE", "CUSTOM_RESOURCE", "ORACLE_HTTP_SERVER", "MICROSOFT_IIS", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "WEBLOGIC_DOMAIN", "EBS_INSTANCE", "SQL_SERVER", "APACHE_TOMCAT", "ORACLE_DATABASE", "OCI_ORACLE_DB", "OCI_ORACLE_CDB", "OCI_ORACLE_PDB", "HOST", "ORACLE_PSFT", "ORACLE_MFT", "APACHE_HTTP_SERVER", "ORACLE_GOLDENGATE", "CUSTOM_RESOURCE", "ORACLE_HTTP_SERVER", "MICROSOFT_IIS", "NGINX", "JBOSS_SERVER", "JBOSS_DOMAIN", "ORACLE_JVM", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -202,7 +218,7 @@ def resource_type(self, resource_type): :param resource_type: The resource_type of this DiscoveryDetails. :type: str """ - allowed_values = ["WEBLOGIC_DOMAIN", "EBS_INSTANCE", "SQL_SERVER", "APACHE_TOMCAT", "ORACLE_DATABASE", "OCI_ORACLE_DB", "OCI_ORACLE_CDB", "OCI_ORACLE_PDB", "HOST", "ORACLE_PSFT", "ORACLE_MFT", "APACHE_HTTP_SERVER", "ORACLE_GOLDENGATE", "CUSTOM_RESOURCE", "ORACLE_HTTP_SERVER", "MICROSOFT_IIS"] + allowed_values = ["WEBLOGIC_DOMAIN", "EBS_INSTANCE", "SQL_SERVER", "APACHE_TOMCAT", "ORACLE_DATABASE", "OCI_ORACLE_DB", "OCI_ORACLE_CDB", "OCI_ORACLE_PDB", "HOST", "ORACLE_PSFT", "ORACLE_MFT", "APACHE_HTTP_SERVER", "ORACLE_GOLDENGATE", "CUSTOM_RESOURCE", "ORACLE_HTTP_SERVER", "MICROSOFT_IIS", "NGINX", "JBOSS_SERVER", "JBOSS_DOMAIN", "ORACLE_JVM"] if not value_allowed_none_or_none_sentinel(resource_type, allowed_values): resource_type = 'UNKNOWN_ENUM_VALUE' self._resource_type = resource_type diff --git a/src/oci/stack_monitoring/models/discovery_job_summary.py b/src/oci/stack_monitoring/models/discovery_job_summary.py index e021e2f906..b8659541f1 100644 --- a/src/oci/stack_monitoring/models/discovery_job_summary.py +++ b/src/oci/stack_monitoring/models/discovery_job_summary.py @@ -79,6 +79,22 @@ class DiscoveryJobSummary(object): #: This constant has a value of "MICROSOFT_IIS" RESOURCE_TYPE_MICROSOFT_IIS = "MICROSOFT_IIS" + #: A constant which can be used with the resource_type property of a DiscoveryJobSummary. + #: This constant has a value of "NGINX" + RESOURCE_TYPE_NGINX = "NGINX" + + #: A constant which can be used with the resource_type property of a DiscoveryJobSummary. + #: This constant has a value of "JBOSS_SERVER" + RESOURCE_TYPE_JBOSS_SERVER = "JBOSS_SERVER" + + #: A constant which can be used with the resource_type property of a DiscoveryJobSummary. + #: This constant has a value of "JBOSS_DOMAIN" + RESOURCE_TYPE_JBOSS_DOMAIN = "JBOSS_DOMAIN" + + #: A constant which can be used with the resource_type property of a DiscoveryJobSummary. + #: This constant has a value of "ORACLE_JVM" + RESOURCE_TYPE_ORACLE_JVM = "ORACLE_JVM" + #: A constant which can be used with the license property of a DiscoveryJobSummary. #: This constant has a value of "STANDARD_EDITION" LICENSE_STANDARD_EDITION = "STANDARD_EDITION" @@ -158,7 +174,7 @@ def __init__(self, **kwargs): :param resource_type: The value to assign to the resource_type property of this DiscoveryJobSummary. - Allowed values for this property are: "WEBLOGIC_DOMAIN", "EBS_INSTANCE", "SQL_SERVER", "APACHE_TOMCAT", "ORACLE_DATABASE", "OCI_ORACLE_DB", "OCI_ORACLE_CDB", "OCI_ORACLE_PDB", "HOST", "ORACLE_PSFT", "ORACLE_MFT", "APACHE_HTTP_SERVER", "ORACLE_GOLDENGATE", "CUSTOM_RESOURCE", "ORACLE_HTTP_SERVER", "MICROSOFT_IIS", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "WEBLOGIC_DOMAIN", "EBS_INSTANCE", "SQL_SERVER", "APACHE_TOMCAT", "ORACLE_DATABASE", "OCI_ORACLE_DB", "OCI_ORACLE_CDB", "OCI_ORACLE_PDB", "HOST", "ORACLE_PSFT", "ORACLE_MFT", "APACHE_HTTP_SERVER", "ORACLE_GOLDENGATE", "CUSTOM_RESOURCE", "ORACLE_HTTP_SERVER", "MICROSOFT_IIS", "NGINX", "JBOSS_SERVER", "JBOSS_DOMAIN", "ORACLE_JVM", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type resource_type: str @@ -305,7 +321,7 @@ def resource_type(self): Gets the resource_type of this DiscoveryJobSummary. Resource Type - Allowed values for this property are: "WEBLOGIC_DOMAIN", "EBS_INSTANCE", "SQL_SERVER", "APACHE_TOMCAT", "ORACLE_DATABASE", "OCI_ORACLE_DB", "OCI_ORACLE_CDB", "OCI_ORACLE_PDB", "HOST", "ORACLE_PSFT", "ORACLE_MFT", "APACHE_HTTP_SERVER", "ORACLE_GOLDENGATE", "CUSTOM_RESOURCE", "ORACLE_HTTP_SERVER", "MICROSOFT_IIS", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "WEBLOGIC_DOMAIN", "EBS_INSTANCE", "SQL_SERVER", "APACHE_TOMCAT", "ORACLE_DATABASE", "OCI_ORACLE_DB", "OCI_ORACLE_CDB", "OCI_ORACLE_PDB", "HOST", "ORACLE_PSFT", "ORACLE_MFT", "APACHE_HTTP_SERVER", "ORACLE_GOLDENGATE", "CUSTOM_RESOURCE", "ORACLE_HTTP_SERVER", "MICROSOFT_IIS", "NGINX", "JBOSS_SERVER", "JBOSS_DOMAIN", "ORACLE_JVM", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -324,7 +340,7 @@ def resource_type(self, resource_type): :param resource_type: The resource_type of this DiscoveryJobSummary. :type: str """ - allowed_values = ["WEBLOGIC_DOMAIN", "EBS_INSTANCE", "SQL_SERVER", "APACHE_TOMCAT", "ORACLE_DATABASE", "OCI_ORACLE_DB", "OCI_ORACLE_CDB", "OCI_ORACLE_PDB", "HOST", "ORACLE_PSFT", "ORACLE_MFT", "APACHE_HTTP_SERVER", "ORACLE_GOLDENGATE", "CUSTOM_RESOURCE", "ORACLE_HTTP_SERVER", "MICROSOFT_IIS"] + allowed_values = ["WEBLOGIC_DOMAIN", "EBS_INSTANCE", "SQL_SERVER", "APACHE_TOMCAT", "ORACLE_DATABASE", "OCI_ORACLE_DB", "OCI_ORACLE_CDB", "OCI_ORACLE_PDB", "HOST", "ORACLE_PSFT", "ORACLE_MFT", "APACHE_HTTP_SERVER", "ORACLE_GOLDENGATE", "CUSTOM_RESOURCE", "ORACLE_HTTP_SERVER", "MICROSOFT_IIS", "NGINX", "JBOSS_SERVER", "JBOSS_DOMAIN", "ORACLE_JVM"] if not value_allowed_none_or_none_sentinel(resource_type, allowed_values): resource_type = 'UNKNOWN_ENUM_VALUE' self._resource_type = resource_type diff --git a/src/oci/version.py b/src/oci/version.py index e2e97c0857..7d83e381ec 100644 --- a/src/oci/version.py +++ b/src/oci/version.py @@ -2,4 +2,4 @@ # Copyright (c) 2016, 2025, 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.143.1" +__version__ = "2.144.0"