diff --git a/CHANGELOG.rst b/CHANGELOG.rst index f40c1e46e3..0556eb5388 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -3,6 +3,27 @@ Change Log All notable changes to this project will be documented in this file. The format is based on `Keep a Changelog `_. +==================== +2.75.1 - 2022-07-19 +==================== + +Added +----- +* Support for calling Oracle Cloud Infrastructure services in the mx-queretaro-1 region +* Support for the Process Automation service +* Support for the Managed Access service +* Support for extending maintenance reboot due dates on virtual machines in the Compute service +* Support for ingress routing tables on NAT gateways and internet gateways in the Networking service +* Support for container database and pluggable database discovery in the Stack Monitoring service +* Support for displaying rack serial numbers for Exadata infrastructure resources in the Database service +* Support for grace periods for wallet rotation on autonomous databases in the Database service +* Support for hosting models on flexible compute shapes with customizable OCPUs and memory in the Data Science service + +Changed +------- +* The upper bound for `pyOpenSSL` dependency has changed from `19.1.0` to `22.0.0` +* The upper bound for `cryptography` dependency has changed from `3.4.7` to `37.0.2` + ==================== 2.75.0 - 2022-07-12 ==================== diff --git a/docs/api/core.rst b/docs/api/core.rst index 67aebed50f..0b0a148d03 100644 --- a/docs/api/core.rst +++ b/docs/api/core.rst @@ -317,6 +317,7 @@ Core Services oci.core.models.InstanceConfigurationVolumeSourceFromVolumeDetails oci.core.models.InstanceConsoleConnection oci.core.models.InstanceCredentials + oci.core.models.InstanceMaintenanceReboot oci.core.models.InstanceOptions oci.core.models.InstancePool oci.core.models.InstancePoolInstance diff --git a/docs/api/core/models/oci.core.models.InstanceMaintenanceReboot.rst b/docs/api/core/models/oci.core.models.InstanceMaintenanceReboot.rst new file mode 100644 index 0000000000..030edb1d43 --- /dev/null +++ b/docs/api/core/models/oci.core.models.InstanceMaintenanceReboot.rst @@ -0,0 +1,11 @@ +InstanceMaintenanceReboot +========================= + +.. currentmodule:: oci.core.models + +.. autoclass:: InstanceMaintenanceReboot + :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 e8373e31d2..fe9c109d1f 100644 --- a/docs/api/data_science.rst +++ b/docs/api/data_science.rst @@ -52,6 +52,7 @@ Data Science oci.data_science.models.ModelConfigurationDetails oci.data_science.models.ModelDeployment oci.data_science.models.ModelDeploymentConfigurationDetails + oci.data_science.models.ModelDeploymentInstanceShapeConfigDetails oci.data_science.models.ModelDeploymentShapeSummary oci.data_science.models.ModelDeploymentSummary oci.data_science.models.ModelProvenance diff --git a/docs/api/data_science/models/oci.data_science.models.ModelDeploymentInstanceShapeConfigDetails.rst b/docs/api/data_science/models/oci.data_science.models.ModelDeploymentInstanceShapeConfigDetails.rst new file mode 100644 index 0000000000..bfe21e355e --- /dev/null +++ b/docs/api/data_science/models/oci.data_science.models.ModelDeploymentInstanceShapeConfigDetails.rst @@ -0,0 +1,11 @@ +ModelDeploymentInstanceShapeConfigDetails +========================================= + +.. currentmodule:: oci.data_science.models + +.. autoclass:: ModelDeploymentInstanceShapeConfigDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/fusion_apps.rst b/docs/api/fusion_apps.rst new file mode 100644 index 0000000000..0c6783ca21 --- /dev/null +++ b/docs/api/fusion_apps.rst @@ -0,0 +1,102 @@ +Fusion Apps +=========== + +.. autosummary:: + :toctree: fusion_apps/client + :nosignatures: + :template: autosummary/service_client.rst + + oci.fusion_apps.DataMaskingActivityClient + oci.fusion_apps.FusionEnvironmentClient + oci.fusion_apps.FusionEnvironmentFamilyClient + oci.fusion_apps.RefreshActivityClient + oci.fusion_apps.ScheduledActivityClient + oci.fusion_apps.ServiceAttachmentClient + oci.fusion_apps.DataMaskingActivityClientCompositeOperations + oci.fusion_apps.FusionEnvironmentClientCompositeOperations + oci.fusion_apps.FusionEnvironmentFamilyClientCompositeOperations + oci.fusion_apps.RefreshActivityClientCompositeOperations + oci.fusion_apps.ScheduledActivityClientCompositeOperations + oci.fusion_apps.ServiceAttachmentClientCompositeOperations + +-------- + Models +-------- + +.. autosummary:: + :toctree: fusion_apps/models + :nosignatures: + :template: autosummary/model_class.rst + + oci.fusion_apps.models.Action + oci.fusion_apps.models.AdminUserCollection + oci.fusion_apps.models.AdminUserSummary + oci.fusion_apps.models.AllowRule + oci.fusion_apps.models.AttachExistingInstanceDetails + oci.fusion_apps.models.Capabilities + oci.fusion_apps.models.ChangeFusionEnvironmentCompartmentDetails + oci.fusion_apps.models.ChangeFusionEnvironmentFamilyCompartmentDetails + oci.fusion_apps.models.CreateDataMaskingActivityDetails + oci.fusion_apps.models.CreateFusionEnvironmentAdminUserDetails + oci.fusion_apps.models.CreateFusionEnvironmentDetails + oci.fusion_apps.models.CreateFusionEnvironmentFamilyDetails + oci.fusion_apps.models.CreateNewInstanceDetails + oci.fusion_apps.models.CreateOaxServiceInstanceDetails + oci.fusion_apps.models.CreateOicServiceInstanceDetails + oci.fusion_apps.models.CreateRefreshActivityDetails + oci.fusion_apps.models.CreateServiceAttachmentDetails + oci.fusion_apps.models.CreateServiceInstanceDetails + oci.fusion_apps.models.DataMaskingActivity + oci.fusion_apps.models.DataMaskingActivityCollection + oci.fusion_apps.models.DataMaskingActivitySummary + oci.fusion_apps.models.FamilyMaintenancePolicy + oci.fusion_apps.models.FawAdminInfoDetails + oci.fusion_apps.models.FusionEnvironment + oci.fusion_apps.models.FusionEnvironmentCollection + oci.fusion_apps.models.FusionEnvironmentFamily + oci.fusion_apps.models.FusionEnvironmentFamilyCollection + oci.fusion_apps.models.FusionEnvironmentFamilyLimitsAndUsage + oci.fusion_apps.models.FusionEnvironmentFamilySummary + oci.fusion_apps.models.FusionEnvironmentStatus + oci.fusion_apps.models.FusionEnvironmentSummary + oci.fusion_apps.models.GetMaintenancePolicyDetails + oci.fusion_apps.models.KmsKeyInfo + oci.fusion_apps.models.LimitAndUsage + oci.fusion_apps.models.MaintenancePolicy + oci.fusion_apps.models.PatchAction + oci.fusion_apps.models.QuarterlyUpgradeBeginTimes + oci.fusion_apps.models.RefreshActivity + oci.fusion_apps.models.RefreshActivityCollection + oci.fusion_apps.models.RefreshActivitySummary + oci.fusion_apps.models.RefreshDetails + oci.fusion_apps.models.ResetFusionEnvironmentPasswordDetails + oci.fusion_apps.models.Rule + oci.fusion_apps.models.RuleCondition + oci.fusion_apps.models.ScheduledActivity + oci.fusion_apps.models.ScheduledActivityCollection + oci.fusion_apps.models.ScheduledActivitySummary + oci.fusion_apps.models.ServiceAttachment + oci.fusion_apps.models.ServiceAttachmentCollection + oci.fusion_apps.models.ServiceAttachmentSummary + oci.fusion_apps.models.SourceIpAddressCondition + oci.fusion_apps.models.SourceVcnIdCondition + oci.fusion_apps.models.SourceVcnIpAddressCondition + oci.fusion_apps.models.Subscription + oci.fusion_apps.models.SubscriptionDetail + oci.fusion_apps.models.SubscriptionSku + oci.fusion_apps.models.TimeAvailableForRefresh + oci.fusion_apps.models.TimeAvailableForRefreshCollection + oci.fusion_apps.models.TimeAvailableForRefreshSummary + oci.fusion_apps.models.UpdateFamilyMaintenancePolicyDetails + oci.fusion_apps.models.UpdateFusionEnvironmentDetails + oci.fusion_apps.models.UpdateFusionEnvironmentFamilyDetails + oci.fusion_apps.models.UpgradeAction + oci.fusion_apps.models.VertexAction + oci.fusion_apps.models.WorkRequest + oci.fusion_apps.models.WorkRequestError + oci.fusion_apps.models.WorkRequestErrorCollection + oci.fusion_apps.models.WorkRequestLogEntry + oci.fusion_apps.models.WorkRequestLogEntryCollection + oci.fusion_apps.models.WorkRequestResource + oci.fusion_apps.models.WorkRequestSummary + oci.fusion_apps.models.WorkRequestSummaryCollection diff --git a/docs/api/fusion_apps/client/oci.fusion_apps.DataMaskingActivityClient.rst b/docs/api/fusion_apps/client/oci.fusion_apps.DataMaskingActivityClient.rst new file mode 100644 index 0000000000..258aeab3ee --- /dev/null +++ b/docs/api/fusion_apps/client/oci.fusion_apps.DataMaskingActivityClient.rst @@ -0,0 +1,8 @@ +DataMaskingActivityClient +========================= + +.. currentmodule:: oci.fusion_apps + +.. autoclass:: DataMaskingActivityClient + :special-members: __init__ + :members: \ No newline at end of file diff --git a/docs/api/fusion_apps/client/oci.fusion_apps.DataMaskingActivityClientCompositeOperations.rst b/docs/api/fusion_apps/client/oci.fusion_apps.DataMaskingActivityClientCompositeOperations.rst new file mode 100644 index 0000000000..4211521ee8 --- /dev/null +++ b/docs/api/fusion_apps/client/oci.fusion_apps.DataMaskingActivityClientCompositeOperations.rst @@ -0,0 +1,8 @@ +DataMaskingActivityClientCompositeOperations +============================================ + +.. currentmodule:: oci.fusion_apps + +.. autoclass:: DataMaskingActivityClientCompositeOperations + :special-members: __init__ + :members: \ No newline at end of file diff --git a/docs/api/fusion_apps/client/oci.fusion_apps.FusionEnvironmentClient.rst b/docs/api/fusion_apps/client/oci.fusion_apps.FusionEnvironmentClient.rst new file mode 100644 index 0000000000..50f7683569 --- /dev/null +++ b/docs/api/fusion_apps/client/oci.fusion_apps.FusionEnvironmentClient.rst @@ -0,0 +1,8 @@ +FusionEnvironmentClient +======================= + +.. currentmodule:: oci.fusion_apps + +.. autoclass:: FusionEnvironmentClient + :special-members: __init__ + :members: \ No newline at end of file diff --git a/docs/api/fusion_apps/client/oci.fusion_apps.FusionEnvironmentClientCompositeOperations.rst b/docs/api/fusion_apps/client/oci.fusion_apps.FusionEnvironmentClientCompositeOperations.rst new file mode 100644 index 0000000000..266ff6223b --- /dev/null +++ b/docs/api/fusion_apps/client/oci.fusion_apps.FusionEnvironmentClientCompositeOperations.rst @@ -0,0 +1,8 @@ +FusionEnvironmentClientCompositeOperations +========================================== + +.. currentmodule:: oci.fusion_apps + +.. autoclass:: FusionEnvironmentClientCompositeOperations + :special-members: __init__ + :members: \ No newline at end of file diff --git a/docs/api/fusion_apps/client/oci.fusion_apps.FusionEnvironmentFamilyClient.rst b/docs/api/fusion_apps/client/oci.fusion_apps.FusionEnvironmentFamilyClient.rst new file mode 100644 index 0000000000..fe2b51ce50 --- /dev/null +++ b/docs/api/fusion_apps/client/oci.fusion_apps.FusionEnvironmentFamilyClient.rst @@ -0,0 +1,8 @@ +FusionEnvironmentFamilyClient +============================= + +.. currentmodule:: oci.fusion_apps + +.. autoclass:: FusionEnvironmentFamilyClient + :special-members: __init__ + :members: \ No newline at end of file diff --git a/docs/api/fusion_apps/client/oci.fusion_apps.FusionEnvironmentFamilyClientCompositeOperations.rst b/docs/api/fusion_apps/client/oci.fusion_apps.FusionEnvironmentFamilyClientCompositeOperations.rst new file mode 100644 index 0000000000..18816c720f --- /dev/null +++ b/docs/api/fusion_apps/client/oci.fusion_apps.FusionEnvironmentFamilyClientCompositeOperations.rst @@ -0,0 +1,8 @@ +FusionEnvironmentFamilyClientCompositeOperations +================================================ + +.. currentmodule:: oci.fusion_apps + +.. autoclass:: FusionEnvironmentFamilyClientCompositeOperations + :special-members: __init__ + :members: \ No newline at end of file diff --git a/docs/api/fusion_apps/client/oci.fusion_apps.RefreshActivityClient.rst b/docs/api/fusion_apps/client/oci.fusion_apps.RefreshActivityClient.rst new file mode 100644 index 0000000000..38bccb5af7 --- /dev/null +++ b/docs/api/fusion_apps/client/oci.fusion_apps.RefreshActivityClient.rst @@ -0,0 +1,8 @@ +RefreshActivityClient +===================== + +.. currentmodule:: oci.fusion_apps + +.. autoclass:: RefreshActivityClient + :special-members: __init__ + :members: \ No newline at end of file diff --git a/docs/api/fusion_apps/client/oci.fusion_apps.RefreshActivityClientCompositeOperations.rst b/docs/api/fusion_apps/client/oci.fusion_apps.RefreshActivityClientCompositeOperations.rst new file mode 100644 index 0000000000..2add7b3fa1 --- /dev/null +++ b/docs/api/fusion_apps/client/oci.fusion_apps.RefreshActivityClientCompositeOperations.rst @@ -0,0 +1,8 @@ +RefreshActivityClientCompositeOperations +======================================== + +.. currentmodule:: oci.fusion_apps + +.. autoclass:: RefreshActivityClientCompositeOperations + :special-members: __init__ + :members: \ No newline at end of file diff --git a/docs/api/fusion_apps/client/oci.fusion_apps.ScheduledActivityClient.rst b/docs/api/fusion_apps/client/oci.fusion_apps.ScheduledActivityClient.rst new file mode 100644 index 0000000000..0bc09e10ba --- /dev/null +++ b/docs/api/fusion_apps/client/oci.fusion_apps.ScheduledActivityClient.rst @@ -0,0 +1,8 @@ +ScheduledActivityClient +======================= + +.. currentmodule:: oci.fusion_apps + +.. autoclass:: ScheduledActivityClient + :special-members: __init__ + :members: \ No newline at end of file diff --git a/docs/api/fusion_apps/client/oci.fusion_apps.ScheduledActivityClientCompositeOperations.rst b/docs/api/fusion_apps/client/oci.fusion_apps.ScheduledActivityClientCompositeOperations.rst new file mode 100644 index 0000000000..1df6535bf9 --- /dev/null +++ b/docs/api/fusion_apps/client/oci.fusion_apps.ScheduledActivityClientCompositeOperations.rst @@ -0,0 +1,8 @@ +ScheduledActivityClientCompositeOperations +========================================== + +.. currentmodule:: oci.fusion_apps + +.. autoclass:: ScheduledActivityClientCompositeOperations + :special-members: __init__ + :members: \ No newline at end of file diff --git a/docs/api/fusion_apps/client/oci.fusion_apps.ServiceAttachmentClient.rst b/docs/api/fusion_apps/client/oci.fusion_apps.ServiceAttachmentClient.rst new file mode 100644 index 0000000000..f85bba41db --- /dev/null +++ b/docs/api/fusion_apps/client/oci.fusion_apps.ServiceAttachmentClient.rst @@ -0,0 +1,8 @@ +ServiceAttachmentClient +======================= + +.. currentmodule:: oci.fusion_apps + +.. autoclass:: ServiceAttachmentClient + :special-members: __init__ + :members: \ No newline at end of file diff --git a/docs/api/fusion_apps/client/oci.fusion_apps.ServiceAttachmentClientCompositeOperations.rst b/docs/api/fusion_apps/client/oci.fusion_apps.ServiceAttachmentClientCompositeOperations.rst new file mode 100644 index 0000000000..067e843db3 --- /dev/null +++ b/docs/api/fusion_apps/client/oci.fusion_apps.ServiceAttachmentClientCompositeOperations.rst @@ -0,0 +1,8 @@ +ServiceAttachmentClientCompositeOperations +========================================== + +.. currentmodule:: oci.fusion_apps + +.. autoclass:: ServiceAttachmentClientCompositeOperations + :special-members: __init__ + :members: \ No newline at end of file diff --git a/docs/api/fusion_apps/models/oci.fusion_apps.models.Action.rst b/docs/api/fusion_apps/models/oci.fusion_apps.models.Action.rst new file mode 100644 index 0000000000..411941130d --- /dev/null +++ b/docs/api/fusion_apps/models/oci.fusion_apps.models.Action.rst @@ -0,0 +1,11 @@ +Action +====== + +.. currentmodule:: oci.fusion_apps.models + +.. autoclass:: Action + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/fusion_apps/models/oci.fusion_apps.models.AdminUserCollection.rst b/docs/api/fusion_apps/models/oci.fusion_apps.models.AdminUserCollection.rst new file mode 100644 index 0000000000..4c26b66804 --- /dev/null +++ b/docs/api/fusion_apps/models/oci.fusion_apps.models.AdminUserCollection.rst @@ -0,0 +1,11 @@ +AdminUserCollection +=================== + +.. currentmodule:: oci.fusion_apps.models + +.. autoclass:: AdminUserCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/fusion_apps/models/oci.fusion_apps.models.AdminUserSummary.rst b/docs/api/fusion_apps/models/oci.fusion_apps.models.AdminUserSummary.rst new file mode 100644 index 0000000000..ac80f92094 --- /dev/null +++ b/docs/api/fusion_apps/models/oci.fusion_apps.models.AdminUserSummary.rst @@ -0,0 +1,11 @@ +AdminUserSummary +================ + +.. currentmodule:: oci.fusion_apps.models + +.. autoclass:: AdminUserSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/fusion_apps/models/oci.fusion_apps.models.AllowRule.rst b/docs/api/fusion_apps/models/oci.fusion_apps.models.AllowRule.rst new file mode 100644 index 0000000000..7887337f15 --- /dev/null +++ b/docs/api/fusion_apps/models/oci.fusion_apps.models.AllowRule.rst @@ -0,0 +1,11 @@ +AllowRule +========= + +.. currentmodule:: oci.fusion_apps.models + +.. autoclass:: AllowRule + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/fusion_apps/models/oci.fusion_apps.models.AttachExistingInstanceDetails.rst b/docs/api/fusion_apps/models/oci.fusion_apps.models.AttachExistingInstanceDetails.rst new file mode 100644 index 0000000000..3184fe8617 --- /dev/null +++ b/docs/api/fusion_apps/models/oci.fusion_apps.models.AttachExistingInstanceDetails.rst @@ -0,0 +1,11 @@ +AttachExistingInstanceDetails +============================= + +.. currentmodule:: oci.fusion_apps.models + +.. autoclass:: AttachExistingInstanceDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/fusion_apps/models/oci.fusion_apps.models.Capabilities.rst b/docs/api/fusion_apps/models/oci.fusion_apps.models.Capabilities.rst new file mode 100644 index 0000000000..72f94499a4 --- /dev/null +++ b/docs/api/fusion_apps/models/oci.fusion_apps.models.Capabilities.rst @@ -0,0 +1,11 @@ +Capabilities +============ + +.. currentmodule:: oci.fusion_apps.models + +.. autoclass:: Capabilities + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/fusion_apps/models/oci.fusion_apps.models.ChangeFusionEnvironmentCompartmentDetails.rst b/docs/api/fusion_apps/models/oci.fusion_apps.models.ChangeFusionEnvironmentCompartmentDetails.rst new file mode 100644 index 0000000000..658e816c1c --- /dev/null +++ b/docs/api/fusion_apps/models/oci.fusion_apps.models.ChangeFusionEnvironmentCompartmentDetails.rst @@ -0,0 +1,11 @@ +ChangeFusionEnvironmentCompartmentDetails +========================================= + +.. currentmodule:: oci.fusion_apps.models + +.. autoclass:: ChangeFusionEnvironmentCompartmentDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/fusion_apps/models/oci.fusion_apps.models.ChangeFusionEnvironmentFamilyCompartmentDetails.rst b/docs/api/fusion_apps/models/oci.fusion_apps.models.ChangeFusionEnvironmentFamilyCompartmentDetails.rst new file mode 100644 index 0000000000..da1d113ecb --- /dev/null +++ b/docs/api/fusion_apps/models/oci.fusion_apps.models.ChangeFusionEnvironmentFamilyCompartmentDetails.rst @@ -0,0 +1,11 @@ +ChangeFusionEnvironmentFamilyCompartmentDetails +=============================================== + +.. currentmodule:: oci.fusion_apps.models + +.. autoclass:: ChangeFusionEnvironmentFamilyCompartmentDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/fusion_apps/models/oci.fusion_apps.models.CreateDataMaskingActivityDetails.rst b/docs/api/fusion_apps/models/oci.fusion_apps.models.CreateDataMaskingActivityDetails.rst new file mode 100644 index 0000000000..66a932cecd --- /dev/null +++ b/docs/api/fusion_apps/models/oci.fusion_apps.models.CreateDataMaskingActivityDetails.rst @@ -0,0 +1,11 @@ +CreateDataMaskingActivityDetails +================================ + +.. currentmodule:: oci.fusion_apps.models + +.. autoclass:: CreateDataMaskingActivityDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/fusion_apps/models/oci.fusion_apps.models.CreateFusionEnvironmentAdminUserDetails.rst b/docs/api/fusion_apps/models/oci.fusion_apps.models.CreateFusionEnvironmentAdminUserDetails.rst new file mode 100644 index 0000000000..635e697976 --- /dev/null +++ b/docs/api/fusion_apps/models/oci.fusion_apps.models.CreateFusionEnvironmentAdminUserDetails.rst @@ -0,0 +1,11 @@ +CreateFusionEnvironmentAdminUserDetails +======================================= + +.. currentmodule:: oci.fusion_apps.models + +.. autoclass:: CreateFusionEnvironmentAdminUserDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/fusion_apps/models/oci.fusion_apps.models.CreateFusionEnvironmentDetails.rst b/docs/api/fusion_apps/models/oci.fusion_apps.models.CreateFusionEnvironmentDetails.rst new file mode 100644 index 0000000000..e368e3713c --- /dev/null +++ b/docs/api/fusion_apps/models/oci.fusion_apps.models.CreateFusionEnvironmentDetails.rst @@ -0,0 +1,11 @@ +CreateFusionEnvironmentDetails +============================== + +.. currentmodule:: oci.fusion_apps.models + +.. autoclass:: CreateFusionEnvironmentDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/fusion_apps/models/oci.fusion_apps.models.CreateFusionEnvironmentFamilyDetails.rst b/docs/api/fusion_apps/models/oci.fusion_apps.models.CreateFusionEnvironmentFamilyDetails.rst new file mode 100644 index 0000000000..6fbc9b437d --- /dev/null +++ b/docs/api/fusion_apps/models/oci.fusion_apps.models.CreateFusionEnvironmentFamilyDetails.rst @@ -0,0 +1,11 @@ +CreateFusionEnvironmentFamilyDetails +==================================== + +.. currentmodule:: oci.fusion_apps.models + +.. autoclass:: CreateFusionEnvironmentFamilyDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/fusion_apps/models/oci.fusion_apps.models.CreateNewInstanceDetails.rst b/docs/api/fusion_apps/models/oci.fusion_apps.models.CreateNewInstanceDetails.rst new file mode 100644 index 0000000000..2f039e5c10 --- /dev/null +++ b/docs/api/fusion_apps/models/oci.fusion_apps.models.CreateNewInstanceDetails.rst @@ -0,0 +1,11 @@ +CreateNewInstanceDetails +======================== + +.. currentmodule:: oci.fusion_apps.models + +.. autoclass:: CreateNewInstanceDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/fusion_apps/models/oci.fusion_apps.models.CreateOaxServiceInstanceDetails.rst b/docs/api/fusion_apps/models/oci.fusion_apps.models.CreateOaxServiceInstanceDetails.rst new file mode 100644 index 0000000000..1e482c7fb7 --- /dev/null +++ b/docs/api/fusion_apps/models/oci.fusion_apps.models.CreateOaxServiceInstanceDetails.rst @@ -0,0 +1,11 @@ +CreateOaxServiceInstanceDetails +=============================== + +.. currentmodule:: oci.fusion_apps.models + +.. autoclass:: CreateOaxServiceInstanceDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/fusion_apps/models/oci.fusion_apps.models.CreateOicServiceInstanceDetails.rst b/docs/api/fusion_apps/models/oci.fusion_apps.models.CreateOicServiceInstanceDetails.rst new file mode 100644 index 0000000000..4dc19bd299 --- /dev/null +++ b/docs/api/fusion_apps/models/oci.fusion_apps.models.CreateOicServiceInstanceDetails.rst @@ -0,0 +1,11 @@ +CreateOicServiceInstanceDetails +=============================== + +.. currentmodule:: oci.fusion_apps.models + +.. autoclass:: CreateOicServiceInstanceDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/fusion_apps/models/oci.fusion_apps.models.CreateRefreshActivityDetails.rst b/docs/api/fusion_apps/models/oci.fusion_apps.models.CreateRefreshActivityDetails.rst new file mode 100644 index 0000000000..37eb445459 --- /dev/null +++ b/docs/api/fusion_apps/models/oci.fusion_apps.models.CreateRefreshActivityDetails.rst @@ -0,0 +1,11 @@ +CreateRefreshActivityDetails +============================ + +.. currentmodule:: oci.fusion_apps.models + +.. autoclass:: CreateRefreshActivityDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/fusion_apps/models/oci.fusion_apps.models.CreateServiceAttachmentDetails.rst b/docs/api/fusion_apps/models/oci.fusion_apps.models.CreateServiceAttachmentDetails.rst new file mode 100644 index 0000000000..92bef37348 --- /dev/null +++ b/docs/api/fusion_apps/models/oci.fusion_apps.models.CreateServiceAttachmentDetails.rst @@ -0,0 +1,11 @@ +CreateServiceAttachmentDetails +============================== + +.. currentmodule:: oci.fusion_apps.models + +.. autoclass:: CreateServiceAttachmentDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/fusion_apps/models/oci.fusion_apps.models.CreateServiceInstanceDetails.rst b/docs/api/fusion_apps/models/oci.fusion_apps.models.CreateServiceInstanceDetails.rst new file mode 100644 index 0000000000..1cd25f89fc --- /dev/null +++ b/docs/api/fusion_apps/models/oci.fusion_apps.models.CreateServiceInstanceDetails.rst @@ -0,0 +1,11 @@ +CreateServiceInstanceDetails +============================ + +.. currentmodule:: oci.fusion_apps.models + +.. autoclass:: CreateServiceInstanceDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/fusion_apps/models/oci.fusion_apps.models.DataMaskingActivity.rst b/docs/api/fusion_apps/models/oci.fusion_apps.models.DataMaskingActivity.rst new file mode 100644 index 0000000000..33f9b8f7ee --- /dev/null +++ b/docs/api/fusion_apps/models/oci.fusion_apps.models.DataMaskingActivity.rst @@ -0,0 +1,11 @@ +DataMaskingActivity +=================== + +.. currentmodule:: oci.fusion_apps.models + +.. autoclass:: DataMaskingActivity + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/fusion_apps/models/oci.fusion_apps.models.DataMaskingActivityCollection.rst b/docs/api/fusion_apps/models/oci.fusion_apps.models.DataMaskingActivityCollection.rst new file mode 100644 index 0000000000..5dd240c27a --- /dev/null +++ b/docs/api/fusion_apps/models/oci.fusion_apps.models.DataMaskingActivityCollection.rst @@ -0,0 +1,11 @@ +DataMaskingActivityCollection +============================= + +.. currentmodule:: oci.fusion_apps.models + +.. autoclass:: DataMaskingActivityCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/fusion_apps/models/oci.fusion_apps.models.DataMaskingActivitySummary.rst b/docs/api/fusion_apps/models/oci.fusion_apps.models.DataMaskingActivitySummary.rst new file mode 100644 index 0000000000..1140a7ca37 --- /dev/null +++ b/docs/api/fusion_apps/models/oci.fusion_apps.models.DataMaskingActivitySummary.rst @@ -0,0 +1,11 @@ +DataMaskingActivitySummary +========================== + +.. currentmodule:: oci.fusion_apps.models + +.. autoclass:: DataMaskingActivitySummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/fusion_apps/models/oci.fusion_apps.models.FamilyMaintenancePolicy.rst b/docs/api/fusion_apps/models/oci.fusion_apps.models.FamilyMaintenancePolicy.rst new file mode 100644 index 0000000000..401a582d69 --- /dev/null +++ b/docs/api/fusion_apps/models/oci.fusion_apps.models.FamilyMaintenancePolicy.rst @@ -0,0 +1,11 @@ +FamilyMaintenancePolicy +======================= + +.. currentmodule:: oci.fusion_apps.models + +.. autoclass:: FamilyMaintenancePolicy + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/fusion_apps/models/oci.fusion_apps.models.FawAdminInfoDetails.rst b/docs/api/fusion_apps/models/oci.fusion_apps.models.FawAdminInfoDetails.rst new file mode 100644 index 0000000000..1ea75117a7 --- /dev/null +++ b/docs/api/fusion_apps/models/oci.fusion_apps.models.FawAdminInfoDetails.rst @@ -0,0 +1,11 @@ +FawAdminInfoDetails +=================== + +.. currentmodule:: oci.fusion_apps.models + +.. autoclass:: FawAdminInfoDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/fusion_apps/models/oci.fusion_apps.models.FusionEnvironment.rst b/docs/api/fusion_apps/models/oci.fusion_apps.models.FusionEnvironment.rst new file mode 100644 index 0000000000..a792763239 --- /dev/null +++ b/docs/api/fusion_apps/models/oci.fusion_apps.models.FusionEnvironment.rst @@ -0,0 +1,11 @@ +FusionEnvironment +================= + +.. currentmodule:: oci.fusion_apps.models + +.. autoclass:: FusionEnvironment + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/fusion_apps/models/oci.fusion_apps.models.FusionEnvironmentCollection.rst b/docs/api/fusion_apps/models/oci.fusion_apps.models.FusionEnvironmentCollection.rst new file mode 100644 index 0000000000..1e7fb71b0e --- /dev/null +++ b/docs/api/fusion_apps/models/oci.fusion_apps.models.FusionEnvironmentCollection.rst @@ -0,0 +1,11 @@ +FusionEnvironmentCollection +=========================== + +.. currentmodule:: oci.fusion_apps.models + +.. autoclass:: FusionEnvironmentCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/fusion_apps/models/oci.fusion_apps.models.FusionEnvironmentFamily.rst b/docs/api/fusion_apps/models/oci.fusion_apps.models.FusionEnvironmentFamily.rst new file mode 100644 index 0000000000..bb94b84bac --- /dev/null +++ b/docs/api/fusion_apps/models/oci.fusion_apps.models.FusionEnvironmentFamily.rst @@ -0,0 +1,11 @@ +FusionEnvironmentFamily +======================= + +.. currentmodule:: oci.fusion_apps.models + +.. autoclass:: FusionEnvironmentFamily + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/fusion_apps/models/oci.fusion_apps.models.FusionEnvironmentFamilyCollection.rst b/docs/api/fusion_apps/models/oci.fusion_apps.models.FusionEnvironmentFamilyCollection.rst new file mode 100644 index 0000000000..58a306a535 --- /dev/null +++ b/docs/api/fusion_apps/models/oci.fusion_apps.models.FusionEnvironmentFamilyCollection.rst @@ -0,0 +1,11 @@ +FusionEnvironmentFamilyCollection +================================= + +.. currentmodule:: oci.fusion_apps.models + +.. autoclass:: FusionEnvironmentFamilyCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/fusion_apps/models/oci.fusion_apps.models.FusionEnvironmentFamilyLimitsAndUsage.rst b/docs/api/fusion_apps/models/oci.fusion_apps.models.FusionEnvironmentFamilyLimitsAndUsage.rst new file mode 100644 index 0000000000..36c0f4dc5d --- /dev/null +++ b/docs/api/fusion_apps/models/oci.fusion_apps.models.FusionEnvironmentFamilyLimitsAndUsage.rst @@ -0,0 +1,11 @@ +FusionEnvironmentFamilyLimitsAndUsage +===================================== + +.. currentmodule:: oci.fusion_apps.models + +.. autoclass:: FusionEnvironmentFamilyLimitsAndUsage + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/fusion_apps/models/oci.fusion_apps.models.FusionEnvironmentFamilySummary.rst b/docs/api/fusion_apps/models/oci.fusion_apps.models.FusionEnvironmentFamilySummary.rst new file mode 100644 index 0000000000..af31545799 --- /dev/null +++ b/docs/api/fusion_apps/models/oci.fusion_apps.models.FusionEnvironmentFamilySummary.rst @@ -0,0 +1,11 @@ +FusionEnvironmentFamilySummary +============================== + +.. currentmodule:: oci.fusion_apps.models + +.. autoclass:: FusionEnvironmentFamilySummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/fusion_apps/models/oci.fusion_apps.models.FusionEnvironmentStatus.rst b/docs/api/fusion_apps/models/oci.fusion_apps.models.FusionEnvironmentStatus.rst new file mode 100644 index 0000000000..12a4e792a2 --- /dev/null +++ b/docs/api/fusion_apps/models/oci.fusion_apps.models.FusionEnvironmentStatus.rst @@ -0,0 +1,11 @@ +FusionEnvironmentStatus +======================= + +.. currentmodule:: oci.fusion_apps.models + +.. autoclass:: FusionEnvironmentStatus + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/fusion_apps/models/oci.fusion_apps.models.FusionEnvironmentSummary.rst b/docs/api/fusion_apps/models/oci.fusion_apps.models.FusionEnvironmentSummary.rst new file mode 100644 index 0000000000..198bef88ff --- /dev/null +++ b/docs/api/fusion_apps/models/oci.fusion_apps.models.FusionEnvironmentSummary.rst @@ -0,0 +1,11 @@ +FusionEnvironmentSummary +======================== + +.. currentmodule:: oci.fusion_apps.models + +.. autoclass:: FusionEnvironmentSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/fusion_apps/models/oci.fusion_apps.models.GetMaintenancePolicyDetails.rst b/docs/api/fusion_apps/models/oci.fusion_apps.models.GetMaintenancePolicyDetails.rst new file mode 100644 index 0000000000..0eb7256fc4 --- /dev/null +++ b/docs/api/fusion_apps/models/oci.fusion_apps.models.GetMaintenancePolicyDetails.rst @@ -0,0 +1,11 @@ +GetMaintenancePolicyDetails +=========================== + +.. currentmodule:: oci.fusion_apps.models + +.. autoclass:: GetMaintenancePolicyDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/fusion_apps/models/oci.fusion_apps.models.KmsKeyInfo.rst b/docs/api/fusion_apps/models/oci.fusion_apps.models.KmsKeyInfo.rst new file mode 100644 index 0000000000..228cce280f --- /dev/null +++ b/docs/api/fusion_apps/models/oci.fusion_apps.models.KmsKeyInfo.rst @@ -0,0 +1,11 @@ +KmsKeyInfo +========== + +.. currentmodule:: oci.fusion_apps.models + +.. autoclass:: KmsKeyInfo + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/fusion_apps/models/oci.fusion_apps.models.LimitAndUsage.rst b/docs/api/fusion_apps/models/oci.fusion_apps.models.LimitAndUsage.rst new file mode 100644 index 0000000000..a125805e9d --- /dev/null +++ b/docs/api/fusion_apps/models/oci.fusion_apps.models.LimitAndUsage.rst @@ -0,0 +1,11 @@ +LimitAndUsage +============= + +.. currentmodule:: oci.fusion_apps.models + +.. autoclass:: LimitAndUsage + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/fusion_apps/models/oci.fusion_apps.models.MaintenancePolicy.rst b/docs/api/fusion_apps/models/oci.fusion_apps.models.MaintenancePolicy.rst new file mode 100644 index 0000000000..fb20d3f3f4 --- /dev/null +++ b/docs/api/fusion_apps/models/oci.fusion_apps.models.MaintenancePolicy.rst @@ -0,0 +1,11 @@ +MaintenancePolicy +================= + +.. currentmodule:: oci.fusion_apps.models + +.. autoclass:: MaintenancePolicy + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/fusion_apps/models/oci.fusion_apps.models.PatchAction.rst b/docs/api/fusion_apps/models/oci.fusion_apps.models.PatchAction.rst new file mode 100644 index 0000000000..cee409226b --- /dev/null +++ b/docs/api/fusion_apps/models/oci.fusion_apps.models.PatchAction.rst @@ -0,0 +1,11 @@ +PatchAction +=========== + +.. currentmodule:: oci.fusion_apps.models + +.. autoclass:: PatchAction + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/fusion_apps/models/oci.fusion_apps.models.QuarterlyUpgradeBeginTimes.rst b/docs/api/fusion_apps/models/oci.fusion_apps.models.QuarterlyUpgradeBeginTimes.rst new file mode 100644 index 0000000000..5549a3a5f0 --- /dev/null +++ b/docs/api/fusion_apps/models/oci.fusion_apps.models.QuarterlyUpgradeBeginTimes.rst @@ -0,0 +1,11 @@ +QuarterlyUpgradeBeginTimes +========================== + +.. currentmodule:: oci.fusion_apps.models + +.. autoclass:: QuarterlyUpgradeBeginTimes + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/fusion_apps/models/oci.fusion_apps.models.RefreshActivity.rst b/docs/api/fusion_apps/models/oci.fusion_apps.models.RefreshActivity.rst new file mode 100644 index 0000000000..bff5895142 --- /dev/null +++ b/docs/api/fusion_apps/models/oci.fusion_apps.models.RefreshActivity.rst @@ -0,0 +1,11 @@ +RefreshActivity +=============== + +.. currentmodule:: oci.fusion_apps.models + +.. autoclass:: RefreshActivity + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/fusion_apps/models/oci.fusion_apps.models.RefreshActivityCollection.rst b/docs/api/fusion_apps/models/oci.fusion_apps.models.RefreshActivityCollection.rst new file mode 100644 index 0000000000..dc0156f904 --- /dev/null +++ b/docs/api/fusion_apps/models/oci.fusion_apps.models.RefreshActivityCollection.rst @@ -0,0 +1,11 @@ +RefreshActivityCollection +========================= + +.. currentmodule:: oci.fusion_apps.models + +.. autoclass:: RefreshActivityCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/fusion_apps/models/oci.fusion_apps.models.RefreshActivitySummary.rst b/docs/api/fusion_apps/models/oci.fusion_apps.models.RefreshActivitySummary.rst new file mode 100644 index 0000000000..41f28a6195 --- /dev/null +++ b/docs/api/fusion_apps/models/oci.fusion_apps.models.RefreshActivitySummary.rst @@ -0,0 +1,11 @@ +RefreshActivitySummary +====================== + +.. currentmodule:: oci.fusion_apps.models + +.. autoclass:: RefreshActivitySummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/fusion_apps/models/oci.fusion_apps.models.RefreshDetails.rst b/docs/api/fusion_apps/models/oci.fusion_apps.models.RefreshDetails.rst new file mode 100644 index 0000000000..304cb7fe62 --- /dev/null +++ b/docs/api/fusion_apps/models/oci.fusion_apps.models.RefreshDetails.rst @@ -0,0 +1,11 @@ +RefreshDetails +============== + +.. currentmodule:: oci.fusion_apps.models + +.. autoclass:: RefreshDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/fusion_apps/models/oci.fusion_apps.models.ResetFusionEnvironmentPasswordDetails.rst b/docs/api/fusion_apps/models/oci.fusion_apps.models.ResetFusionEnvironmentPasswordDetails.rst new file mode 100644 index 0000000000..53743874ba --- /dev/null +++ b/docs/api/fusion_apps/models/oci.fusion_apps.models.ResetFusionEnvironmentPasswordDetails.rst @@ -0,0 +1,11 @@ +ResetFusionEnvironmentPasswordDetails +===================================== + +.. currentmodule:: oci.fusion_apps.models + +.. autoclass:: ResetFusionEnvironmentPasswordDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/fusion_apps/models/oci.fusion_apps.models.Rule.rst b/docs/api/fusion_apps/models/oci.fusion_apps.models.Rule.rst new file mode 100644 index 0000000000..3917ff5e65 --- /dev/null +++ b/docs/api/fusion_apps/models/oci.fusion_apps.models.Rule.rst @@ -0,0 +1,11 @@ +Rule +==== + +.. currentmodule:: oci.fusion_apps.models + +.. autoclass:: Rule + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/fusion_apps/models/oci.fusion_apps.models.RuleCondition.rst b/docs/api/fusion_apps/models/oci.fusion_apps.models.RuleCondition.rst new file mode 100644 index 0000000000..fe0f391164 --- /dev/null +++ b/docs/api/fusion_apps/models/oci.fusion_apps.models.RuleCondition.rst @@ -0,0 +1,11 @@ +RuleCondition +============= + +.. currentmodule:: oci.fusion_apps.models + +.. autoclass:: RuleCondition + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/fusion_apps/models/oci.fusion_apps.models.ScheduledActivity.rst b/docs/api/fusion_apps/models/oci.fusion_apps.models.ScheduledActivity.rst new file mode 100644 index 0000000000..c4aaa541e7 --- /dev/null +++ b/docs/api/fusion_apps/models/oci.fusion_apps.models.ScheduledActivity.rst @@ -0,0 +1,11 @@ +ScheduledActivity +================= + +.. currentmodule:: oci.fusion_apps.models + +.. autoclass:: ScheduledActivity + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/fusion_apps/models/oci.fusion_apps.models.ScheduledActivityCollection.rst b/docs/api/fusion_apps/models/oci.fusion_apps.models.ScheduledActivityCollection.rst new file mode 100644 index 0000000000..d334430311 --- /dev/null +++ b/docs/api/fusion_apps/models/oci.fusion_apps.models.ScheduledActivityCollection.rst @@ -0,0 +1,11 @@ +ScheduledActivityCollection +=========================== + +.. currentmodule:: oci.fusion_apps.models + +.. autoclass:: ScheduledActivityCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/fusion_apps/models/oci.fusion_apps.models.ScheduledActivitySummary.rst b/docs/api/fusion_apps/models/oci.fusion_apps.models.ScheduledActivitySummary.rst new file mode 100644 index 0000000000..d5a4898379 --- /dev/null +++ b/docs/api/fusion_apps/models/oci.fusion_apps.models.ScheduledActivitySummary.rst @@ -0,0 +1,11 @@ +ScheduledActivitySummary +======================== + +.. currentmodule:: oci.fusion_apps.models + +.. autoclass:: ScheduledActivitySummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/fusion_apps/models/oci.fusion_apps.models.ServiceAttachment.rst b/docs/api/fusion_apps/models/oci.fusion_apps.models.ServiceAttachment.rst new file mode 100644 index 0000000000..82cba4701b --- /dev/null +++ b/docs/api/fusion_apps/models/oci.fusion_apps.models.ServiceAttachment.rst @@ -0,0 +1,11 @@ +ServiceAttachment +================= + +.. currentmodule:: oci.fusion_apps.models + +.. autoclass:: ServiceAttachment + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/fusion_apps/models/oci.fusion_apps.models.ServiceAttachmentCollection.rst b/docs/api/fusion_apps/models/oci.fusion_apps.models.ServiceAttachmentCollection.rst new file mode 100644 index 0000000000..cf76fe4e8e --- /dev/null +++ b/docs/api/fusion_apps/models/oci.fusion_apps.models.ServiceAttachmentCollection.rst @@ -0,0 +1,11 @@ +ServiceAttachmentCollection +=========================== + +.. currentmodule:: oci.fusion_apps.models + +.. autoclass:: ServiceAttachmentCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/fusion_apps/models/oci.fusion_apps.models.ServiceAttachmentSummary.rst b/docs/api/fusion_apps/models/oci.fusion_apps.models.ServiceAttachmentSummary.rst new file mode 100644 index 0000000000..6d63c745a5 --- /dev/null +++ b/docs/api/fusion_apps/models/oci.fusion_apps.models.ServiceAttachmentSummary.rst @@ -0,0 +1,11 @@ +ServiceAttachmentSummary +======================== + +.. currentmodule:: oci.fusion_apps.models + +.. autoclass:: ServiceAttachmentSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/fusion_apps/models/oci.fusion_apps.models.SourceIpAddressCondition.rst b/docs/api/fusion_apps/models/oci.fusion_apps.models.SourceIpAddressCondition.rst new file mode 100644 index 0000000000..1b5ceed5dc --- /dev/null +++ b/docs/api/fusion_apps/models/oci.fusion_apps.models.SourceIpAddressCondition.rst @@ -0,0 +1,11 @@ +SourceIpAddressCondition +======================== + +.. currentmodule:: oci.fusion_apps.models + +.. autoclass:: SourceIpAddressCondition + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/fusion_apps/models/oci.fusion_apps.models.SourceVcnIdCondition.rst b/docs/api/fusion_apps/models/oci.fusion_apps.models.SourceVcnIdCondition.rst new file mode 100644 index 0000000000..8e0ea9b99f --- /dev/null +++ b/docs/api/fusion_apps/models/oci.fusion_apps.models.SourceVcnIdCondition.rst @@ -0,0 +1,11 @@ +SourceVcnIdCondition +==================== + +.. currentmodule:: oci.fusion_apps.models + +.. autoclass:: SourceVcnIdCondition + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/fusion_apps/models/oci.fusion_apps.models.SourceVcnIpAddressCondition.rst b/docs/api/fusion_apps/models/oci.fusion_apps.models.SourceVcnIpAddressCondition.rst new file mode 100644 index 0000000000..bcb39de278 --- /dev/null +++ b/docs/api/fusion_apps/models/oci.fusion_apps.models.SourceVcnIpAddressCondition.rst @@ -0,0 +1,11 @@ +SourceVcnIpAddressCondition +=========================== + +.. currentmodule:: oci.fusion_apps.models + +.. autoclass:: SourceVcnIpAddressCondition + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/fusion_apps/models/oci.fusion_apps.models.Subscription.rst b/docs/api/fusion_apps/models/oci.fusion_apps.models.Subscription.rst new file mode 100644 index 0000000000..beca9adcce --- /dev/null +++ b/docs/api/fusion_apps/models/oci.fusion_apps.models.Subscription.rst @@ -0,0 +1,11 @@ +Subscription +============ + +.. currentmodule:: oci.fusion_apps.models + +.. autoclass:: Subscription + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/fusion_apps/models/oci.fusion_apps.models.SubscriptionDetail.rst b/docs/api/fusion_apps/models/oci.fusion_apps.models.SubscriptionDetail.rst new file mode 100644 index 0000000000..47ab7621fe --- /dev/null +++ b/docs/api/fusion_apps/models/oci.fusion_apps.models.SubscriptionDetail.rst @@ -0,0 +1,11 @@ +SubscriptionDetail +================== + +.. currentmodule:: oci.fusion_apps.models + +.. autoclass:: SubscriptionDetail + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/fusion_apps/models/oci.fusion_apps.models.SubscriptionSku.rst b/docs/api/fusion_apps/models/oci.fusion_apps.models.SubscriptionSku.rst new file mode 100644 index 0000000000..c93c150744 --- /dev/null +++ b/docs/api/fusion_apps/models/oci.fusion_apps.models.SubscriptionSku.rst @@ -0,0 +1,11 @@ +SubscriptionSku +=============== + +.. currentmodule:: oci.fusion_apps.models + +.. autoclass:: SubscriptionSku + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/fusion_apps/models/oci.fusion_apps.models.TimeAvailableForRefresh.rst b/docs/api/fusion_apps/models/oci.fusion_apps.models.TimeAvailableForRefresh.rst new file mode 100644 index 0000000000..fbdbcba877 --- /dev/null +++ b/docs/api/fusion_apps/models/oci.fusion_apps.models.TimeAvailableForRefresh.rst @@ -0,0 +1,11 @@ +TimeAvailableForRefresh +======================= + +.. currentmodule:: oci.fusion_apps.models + +.. autoclass:: TimeAvailableForRefresh + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/fusion_apps/models/oci.fusion_apps.models.TimeAvailableForRefreshCollection.rst b/docs/api/fusion_apps/models/oci.fusion_apps.models.TimeAvailableForRefreshCollection.rst new file mode 100644 index 0000000000..8e67adc47e --- /dev/null +++ b/docs/api/fusion_apps/models/oci.fusion_apps.models.TimeAvailableForRefreshCollection.rst @@ -0,0 +1,11 @@ +TimeAvailableForRefreshCollection +================================= + +.. currentmodule:: oci.fusion_apps.models + +.. autoclass:: TimeAvailableForRefreshCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/fusion_apps/models/oci.fusion_apps.models.TimeAvailableForRefreshSummary.rst b/docs/api/fusion_apps/models/oci.fusion_apps.models.TimeAvailableForRefreshSummary.rst new file mode 100644 index 0000000000..3deea0c34d --- /dev/null +++ b/docs/api/fusion_apps/models/oci.fusion_apps.models.TimeAvailableForRefreshSummary.rst @@ -0,0 +1,11 @@ +TimeAvailableForRefreshSummary +============================== + +.. currentmodule:: oci.fusion_apps.models + +.. autoclass:: TimeAvailableForRefreshSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/fusion_apps/models/oci.fusion_apps.models.UpdateFamilyMaintenancePolicyDetails.rst b/docs/api/fusion_apps/models/oci.fusion_apps.models.UpdateFamilyMaintenancePolicyDetails.rst new file mode 100644 index 0000000000..64ba46ed8a --- /dev/null +++ b/docs/api/fusion_apps/models/oci.fusion_apps.models.UpdateFamilyMaintenancePolicyDetails.rst @@ -0,0 +1,11 @@ +UpdateFamilyMaintenancePolicyDetails +==================================== + +.. currentmodule:: oci.fusion_apps.models + +.. autoclass:: UpdateFamilyMaintenancePolicyDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/fusion_apps/models/oci.fusion_apps.models.UpdateFusionEnvironmentDetails.rst b/docs/api/fusion_apps/models/oci.fusion_apps.models.UpdateFusionEnvironmentDetails.rst new file mode 100644 index 0000000000..53a2193ddf --- /dev/null +++ b/docs/api/fusion_apps/models/oci.fusion_apps.models.UpdateFusionEnvironmentDetails.rst @@ -0,0 +1,11 @@ +UpdateFusionEnvironmentDetails +============================== + +.. currentmodule:: oci.fusion_apps.models + +.. autoclass:: UpdateFusionEnvironmentDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/fusion_apps/models/oci.fusion_apps.models.UpdateFusionEnvironmentFamilyDetails.rst b/docs/api/fusion_apps/models/oci.fusion_apps.models.UpdateFusionEnvironmentFamilyDetails.rst new file mode 100644 index 0000000000..fd1f511853 --- /dev/null +++ b/docs/api/fusion_apps/models/oci.fusion_apps.models.UpdateFusionEnvironmentFamilyDetails.rst @@ -0,0 +1,11 @@ +UpdateFusionEnvironmentFamilyDetails +==================================== + +.. currentmodule:: oci.fusion_apps.models + +.. autoclass:: UpdateFusionEnvironmentFamilyDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/fusion_apps/models/oci.fusion_apps.models.UpgradeAction.rst b/docs/api/fusion_apps/models/oci.fusion_apps.models.UpgradeAction.rst new file mode 100644 index 0000000000..c1dc0eda65 --- /dev/null +++ b/docs/api/fusion_apps/models/oci.fusion_apps.models.UpgradeAction.rst @@ -0,0 +1,11 @@ +UpgradeAction +============= + +.. currentmodule:: oci.fusion_apps.models + +.. autoclass:: UpgradeAction + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/fusion_apps/models/oci.fusion_apps.models.VertexAction.rst b/docs/api/fusion_apps/models/oci.fusion_apps.models.VertexAction.rst new file mode 100644 index 0000000000..2549bd318a --- /dev/null +++ b/docs/api/fusion_apps/models/oci.fusion_apps.models.VertexAction.rst @@ -0,0 +1,11 @@ +VertexAction +============ + +.. currentmodule:: oci.fusion_apps.models + +.. autoclass:: VertexAction + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/fusion_apps/models/oci.fusion_apps.models.WorkRequest.rst b/docs/api/fusion_apps/models/oci.fusion_apps.models.WorkRequest.rst new file mode 100644 index 0000000000..2e90c15a62 --- /dev/null +++ b/docs/api/fusion_apps/models/oci.fusion_apps.models.WorkRequest.rst @@ -0,0 +1,11 @@ +WorkRequest +=========== + +.. currentmodule:: oci.fusion_apps.models + +.. autoclass:: WorkRequest + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/fusion_apps/models/oci.fusion_apps.models.WorkRequestError.rst b/docs/api/fusion_apps/models/oci.fusion_apps.models.WorkRequestError.rst new file mode 100644 index 0000000000..625a1f9547 --- /dev/null +++ b/docs/api/fusion_apps/models/oci.fusion_apps.models.WorkRequestError.rst @@ -0,0 +1,11 @@ +WorkRequestError +================ + +.. currentmodule:: oci.fusion_apps.models + +.. autoclass:: WorkRequestError + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/fusion_apps/models/oci.fusion_apps.models.WorkRequestErrorCollection.rst b/docs/api/fusion_apps/models/oci.fusion_apps.models.WorkRequestErrorCollection.rst new file mode 100644 index 0000000000..12a557d71d --- /dev/null +++ b/docs/api/fusion_apps/models/oci.fusion_apps.models.WorkRequestErrorCollection.rst @@ -0,0 +1,11 @@ +WorkRequestErrorCollection +========================== + +.. currentmodule:: oci.fusion_apps.models + +.. autoclass:: WorkRequestErrorCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/fusion_apps/models/oci.fusion_apps.models.WorkRequestLogEntry.rst b/docs/api/fusion_apps/models/oci.fusion_apps.models.WorkRequestLogEntry.rst new file mode 100644 index 0000000000..c61ce8232f --- /dev/null +++ b/docs/api/fusion_apps/models/oci.fusion_apps.models.WorkRequestLogEntry.rst @@ -0,0 +1,11 @@ +WorkRequestLogEntry +=================== + +.. currentmodule:: oci.fusion_apps.models + +.. autoclass:: WorkRequestLogEntry + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/fusion_apps/models/oci.fusion_apps.models.WorkRequestLogEntryCollection.rst b/docs/api/fusion_apps/models/oci.fusion_apps.models.WorkRequestLogEntryCollection.rst new file mode 100644 index 0000000000..766cba0188 --- /dev/null +++ b/docs/api/fusion_apps/models/oci.fusion_apps.models.WorkRequestLogEntryCollection.rst @@ -0,0 +1,11 @@ +WorkRequestLogEntryCollection +============================= + +.. currentmodule:: oci.fusion_apps.models + +.. autoclass:: WorkRequestLogEntryCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/fusion_apps/models/oci.fusion_apps.models.WorkRequestResource.rst b/docs/api/fusion_apps/models/oci.fusion_apps.models.WorkRequestResource.rst new file mode 100644 index 0000000000..9013c3f625 --- /dev/null +++ b/docs/api/fusion_apps/models/oci.fusion_apps.models.WorkRequestResource.rst @@ -0,0 +1,11 @@ +WorkRequestResource +=================== + +.. currentmodule:: oci.fusion_apps.models + +.. autoclass:: WorkRequestResource + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/fusion_apps/models/oci.fusion_apps.models.WorkRequestSummary.rst b/docs/api/fusion_apps/models/oci.fusion_apps.models.WorkRequestSummary.rst new file mode 100644 index 0000000000..7b210b1c87 --- /dev/null +++ b/docs/api/fusion_apps/models/oci.fusion_apps.models.WorkRequestSummary.rst @@ -0,0 +1,11 @@ +WorkRequestSummary +================== + +.. currentmodule:: oci.fusion_apps.models + +.. autoclass:: WorkRequestSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/fusion_apps/models/oci.fusion_apps.models.WorkRequestSummaryCollection.rst b/docs/api/fusion_apps/models/oci.fusion_apps.models.WorkRequestSummaryCollection.rst new file mode 100644 index 0000000000..2b5e292568 --- /dev/null +++ b/docs/api/fusion_apps/models/oci.fusion_apps.models.WorkRequestSummaryCollection.rst @@ -0,0 +1,11 @@ +WorkRequestSummaryCollection +============================ + +.. currentmodule:: oci.fusion_apps.models + +.. autoclass:: WorkRequestSummaryCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/landing.rst b/docs/api/landing.rst index b48448cf72..8f54a23398 100644 --- a/docs/api/landing.rst +++ b/docs/api/landing.rst @@ -77,6 +77,12 @@ API Reference * :doc:`File Storage ` * :doc:`Functions Invoke ` * :doc:`Functions Management ` +* :doc:`Data Masking Activity ` +* :doc:`Fusion Environment ` +* :doc:`Fusion Environment Family ` +* :doc:`Refresh Activity ` +* :doc:`Scheduled Activity ` +* :doc:`Service Attachment ` * :doc:`Generic Artifacts Content ` * :doc:`Golden Gate ` * :doc:`Governance Rule ` @@ -93,6 +99,7 @@ API Reference * :doc:`Limits ` * :doc:`Quotas ` * :doc:`Load Balancer ` +* :doc:`Lockbox ` * :doc:`Log Analytics ` * :doc:`Logging Management ` * :doc:`Logging ` @@ -101,6 +108,7 @@ API Reference * :doc:`Dashx Apis ` * :doc:`Account ` * :doc:`Marketplace ` +* :doc:`Media Services ` * :doc:`Monitoring ` * :doc:`Channels ` * :doc:`Db Backups ` @@ -128,6 +136,7 @@ API Reference * :doc:`Subscription ` * :doc:`Notification Control Plane ` * :doc:`Notification Data Plane ` +* :doc:`Opa Instance ` * :doc:`Access Requests ` * :doc:`Operator Actions ` * :doc:`Operator Control Assignment ` @@ -248,6 +257,7 @@ API Reference events file_storage functions + fusion_apps generic_artifacts_content golden_gate governance_rules_control_plane @@ -260,6 +270,7 @@ API Reference license_manager limits load_balancer + lockbox log_analytics logging loggingingestion @@ -267,6 +278,7 @@ API Reference management_agent management_dashboard marketplace + media_services monitoring mysql network_firewall @@ -278,6 +290,7 @@ API Reference oda onesubscription ons + opa operator_access_control opsi optimizer diff --git a/docs/api/lockbox.rst b/docs/api/lockbox.rst new file mode 100644 index 0000000000..b475c31296 --- /dev/null +++ b/docs/api/lockbox.rst @@ -0,0 +1,51 @@ +Lockbox +======= + +.. autosummary:: + :toctree: lockbox/client + :nosignatures: + :template: autosummary/service_client.rst + + oci.lockbox.LockboxClient + oci.lockbox.LockboxClientCompositeOperations + +-------- + Models +-------- + +.. autosummary:: + :toctree: lockbox/models + :nosignatures: + :template: autosummary/model_class.rst + + oci.lockbox.models.AccessContextAttribute + oci.lockbox.models.AccessContextAttributeCollection + oci.lockbox.models.AccessMaterials + oci.lockbox.models.AccessRequest + oci.lockbox.models.AccessRequestCollection + oci.lockbox.models.AccessRequestSummary + oci.lockbox.models.ActivityLog + oci.lockbox.models.ApprovalTemplate + oci.lockbox.models.ApprovalTemplateCollection + oci.lockbox.models.ApprovalTemplateSummary + oci.lockbox.models.ApproverInfo + oci.lockbox.models.ApproverLevels + oci.lockbox.models.ChangeApprovalTemplateCompartmentDetails + oci.lockbox.models.ChangeLockboxCompartmentDetails + oci.lockbox.models.CreateAccessRequestDetails + oci.lockbox.models.CreateApprovalTemplateDetails + oci.lockbox.models.CreateLockboxDetails + oci.lockbox.models.HandleAccessRequestDetails + oci.lockbox.models.Lockbox + oci.lockbox.models.LockboxCollection + oci.lockbox.models.LockboxSummary + oci.lockbox.models.UpdateApprovalTemplateDetails + oci.lockbox.models.UpdateLockboxDetails + oci.lockbox.models.WorkRequest + oci.lockbox.models.WorkRequestError + oci.lockbox.models.WorkRequestErrorCollection + oci.lockbox.models.WorkRequestLogEntry + oci.lockbox.models.WorkRequestLogEntryCollection + oci.lockbox.models.WorkRequestResource + oci.lockbox.models.WorkRequestSummary + oci.lockbox.models.WorkRequestSummaryCollection diff --git a/docs/api/lockbox/client/oci.lockbox.LockboxClient.rst b/docs/api/lockbox/client/oci.lockbox.LockboxClient.rst new file mode 100644 index 0000000000..046e3ee13d --- /dev/null +++ b/docs/api/lockbox/client/oci.lockbox.LockboxClient.rst @@ -0,0 +1,8 @@ +LockboxClient +============= + +.. currentmodule:: oci.lockbox + +.. autoclass:: LockboxClient + :special-members: __init__ + :members: \ No newline at end of file diff --git a/docs/api/lockbox/client/oci.lockbox.LockboxClientCompositeOperations.rst b/docs/api/lockbox/client/oci.lockbox.LockboxClientCompositeOperations.rst new file mode 100644 index 0000000000..c9e247475c --- /dev/null +++ b/docs/api/lockbox/client/oci.lockbox.LockboxClientCompositeOperations.rst @@ -0,0 +1,8 @@ +LockboxClientCompositeOperations +================================ + +.. currentmodule:: oci.lockbox + +.. autoclass:: LockboxClientCompositeOperations + :special-members: __init__ + :members: \ No newline at end of file diff --git a/docs/api/lockbox/models/oci.lockbox.models.AccessContextAttribute.rst b/docs/api/lockbox/models/oci.lockbox.models.AccessContextAttribute.rst new file mode 100644 index 0000000000..8166c6795a --- /dev/null +++ b/docs/api/lockbox/models/oci.lockbox.models.AccessContextAttribute.rst @@ -0,0 +1,11 @@ +AccessContextAttribute +====================== + +.. currentmodule:: oci.lockbox.models + +.. autoclass:: AccessContextAttribute + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/lockbox/models/oci.lockbox.models.AccessContextAttributeCollection.rst b/docs/api/lockbox/models/oci.lockbox.models.AccessContextAttributeCollection.rst new file mode 100644 index 0000000000..a72399e7be --- /dev/null +++ b/docs/api/lockbox/models/oci.lockbox.models.AccessContextAttributeCollection.rst @@ -0,0 +1,11 @@ +AccessContextAttributeCollection +================================ + +.. currentmodule:: oci.lockbox.models + +.. autoclass:: AccessContextAttributeCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/lockbox/models/oci.lockbox.models.AccessMaterials.rst b/docs/api/lockbox/models/oci.lockbox.models.AccessMaterials.rst new file mode 100644 index 0000000000..6fbc7cabdf --- /dev/null +++ b/docs/api/lockbox/models/oci.lockbox.models.AccessMaterials.rst @@ -0,0 +1,11 @@ +AccessMaterials +=============== + +.. currentmodule:: oci.lockbox.models + +.. autoclass:: AccessMaterials + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/lockbox/models/oci.lockbox.models.AccessRequest.rst b/docs/api/lockbox/models/oci.lockbox.models.AccessRequest.rst new file mode 100644 index 0000000000..67fa7ca76d --- /dev/null +++ b/docs/api/lockbox/models/oci.lockbox.models.AccessRequest.rst @@ -0,0 +1,11 @@ +AccessRequest +============= + +.. currentmodule:: oci.lockbox.models + +.. autoclass:: AccessRequest + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/lockbox/models/oci.lockbox.models.AccessRequestCollection.rst b/docs/api/lockbox/models/oci.lockbox.models.AccessRequestCollection.rst new file mode 100644 index 0000000000..f0de5e1fcc --- /dev/null +++ b/docs/api/lockbox/models/oci.lockbox.models.AccessRequestCollection.rst @@ -0,0 +1,11 @@ +AccessRequestCollection +======================= + +.. currentmodule:: oci.lockbox.models + +.. autoclass:: AccessRequestCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/lockbox/models/oci.lockbox.models.AccessRequestSummary.rst b/docs/api/lockbox/models/oci.lockbox.models.AccessRequestSummary.rst new file mode 100644 index 0000000000..80d7d8daac --- /dev/null +++ b/docs/api/lockbox/models/oci.lockbox.models.AccessRequestSummary.rst @@ -0,0 +1,11 @@ +AccessRequestSummary +==================== + +.. currentmodule:: oci.lockbox.models + +.. autoclass:: AccessRequestSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/lockbox/models/oci.lockbox.models.ActivityLog.rst b/docs/api/lockbox/models/oci.lockbox.models.ActivityLog.rst new file mode 100644 index 0000000000..0f8a20a4e9 --- /dev/null +++ b/docs/api/lockbox/models/oci.lockbox.models.ActivityLog.rst @@ -0,0 +1,11 @@ +ActivityLog +=========== + +.. currentmodule:: oci.lockbox.models + +.. autoclass:: ActivityLog + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/lockbox/models/oci.lockbox.models.ApprovalTemplate.rst b/docs/api/lockbox/models/oci.lockbox.models.ApprovalTemplate.rst new file mode 100644 index 0000000000..a29227adb2 --- /dev/null +++ b/docs/api/lockbox/models/oci.lockbox.models.ApprovalTemplate.rst @@ -0,0 +1,11 @@ +ApprovalTemplate +================ + +.. currentmodule:: oci.lockbox.models + +.. autoclass:: ApprovalTemplate + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/lockbox/models/oci.lockbox.models.ApprovalTemplateCollection.rst b/docs/api/lockbox/models/oci.lockbox.models.ApprovalTemplateCollection.rst new file mode 100644 index 0000000000..b1a2caada3 --- /dev/null +++ b/docs/api/lockbox/models/oci.lockbox.models.ApprovalTemplateCollection.rst @@ -0,0 +1,11 @@ +ApprovalTemplateCollection +========================== + +.. currentmodule:: oci.lockbox.models + +.. autoclass:: ApprovalTemplateCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/lockbox/models/oci.lockbox.models.ApprovalTemplateSummary.rst b/docs/api/lockbox/models/oci.lockbox.models.ApprovalTemplateSummary.rst new file mode 100644 index 0000000000..043bdff100 --- /dev/null +++ b/docs/api/lockbox/models/oci.lockbox.models.ApprovalTemplateSummary.rst @@ -0,0 +1,11 @@ +ApprovalTemplateSummary +======================= + +.. currentmodule:: oci.lockbox.models + +.. autoclass:: ApprovalTemplateSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/lockbox/models/oci.lockbox.models.ApproverInfo.rst b/docs/api/lockbox/models/oci.lockbox.models.ApproverInfo.rst new file mode 100644 index 0000000000..8030c89bda --- /dev/null +++ b/docs/api/lockbox/models/oci.lockbox.models.ApproverInfo.rst @@ -0,0 +1,11 @@ +ApproverInfo +============ + +.. currentmodule:: oci.lockbox.models + +.. autoclass:: ApproverInfo + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/lockbox/models/oci.lockbox.models.ApproverLevels.rst b/docs/api/lockbox/models/oci.lockbox.models.ApproverLevels.rst new file mode 100644 index 0000000000..9518c1265a --- /dev/null +++ b/docs/api/lockbox/models/oci.lockbox.models.ApproverLevels.rst @@ -0,0 +1,11 @@ +ApproverLevels +============== + +.. currentmodule:: oci.lockbox.models + +.. autoclass:: ApproverLevels + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/lockbox/models/oci.lockbox.models.ChangeApprovalTemplateCompartmentDetails.rst b/docs/api/lockbox/models/oci.lockbox.models.ChangeApprovalTemplateCompartmentDetails.rst new file mode 100644 index 0000000000..29a64b5bdc --- /dev/null +++ b/docs/api/lockbox/models/oci.lockbox.models.ChangeApprovalTemplateCompartmentDetails.rst @@ -0,0 +1,11 @@ +ChangeApprovalTemplateCompartmentDetails +======================================== + +.. currentmodule:: oci.lockbox.models + +.. autoclass:: ChangeApprovalTemplateCompartmentDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/lockbox/models/oci.lockbox.models.ChangeLockboxCompartmentDetails.rst b/docs/api/lockbox/models/oci.lockbox.models.ChangeLockboxCompartmentDetails.rst new file mode 100644 index 0000000000..4b30b924db --- /dev/null +++ b/docs/api/lockbox/models/oci.lockbox.models.ChangeLockboxCompartmentDetails.rst @@ -0,0 +1,11 @@ +ChangeLockboxCompartmentDetails +=============================== + +.. currentmodule:: oci.lockbox.models + +.. autoclass:: ChangeLockboxCompartmentDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/lockbox/models/oci.lockbox.models.CreateAccessRequestDetails.rst b/docs/api/lockbox/models/oci.lockbox.models.CreateAccessRequestDetails.rst new file mode 100644 index 0000000000..a8e493b03a --- /dev/null +++ b/docs/api/lockbox/models/oci.lockbox.models.CreateAccessRequestDetails.rst @@ -0,0 +1,11 @@ +CreateAccessRequestDetails +========================== + +.. currentmodule:: oci.lockbox.models + +.. autoclass:: CreateAccessRequestDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/lockbox/models/oci.lockbox.models.CreateApprovalTemplateDetails.rst b/docs/api/lockbox/models/oci.lockbox.models.CreateApprovalTemplateDetails.rst new file mode 100644 index 0000000000..929deed218 --- /dev/null +++ b/docs/api/lockbox/models/oci.lockbox.models.CreateApprovalTemplateDetails.rst @@ -0,0 +1,11 @@ +CreateApprovalTemplateDetails +============================= + +.. currentmodule:: oci.lockbox.models + +.. autoclass:: CreateApprovalTemplateDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/lockbox/models/oci.lockbox.models.CreateLockboxDetails.rst b/docs/api/lockbox/models/oci.lockbox.models.CreateLockboxDetails.rst new file mode 100644 index 0000000000..8f6c127aff --- /dev/null +++ b/docs/api/lockbox/models/oci.lockbox.models.CreateLockboxDetails.rst @@ -0,0 +1,11 @@ +CreateLockboxDetails +==================== + +.. currentmodule:: oci.lockbox.models + +.. autoclass:: CreateLockboxDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/lockbox/models/oci.lockbox.models.HandleAccessRequestDetails.rst b/docs/api/lockbox/models/oci.lockbox.models.HandleAccessRequestDetails.rst new file mode 100644 index 0000000000..c154412531 --- /dev/null +++ b/docs/api/lockbox/models/oci.lockbox.models.HandleAccessRequestDetails.rst @@ -0,0 +1,11 @@ +HandleAccessRequestDetails +========================== + +.. currentmodule:: oci.lockbox.models + +.. autoclass:: HandleAccessRequestDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/lockbox/models/oci.lockbox.models.Lockbox.rst b/docs/api/lockbox/models/oci.lockbox.models.Lockbox.rst new file mode 100644 index 0000000000..2d7198bcd0 --- /dev/null +++ b/docs/api/lockbox/models/oci.lockbox.models.Lockbox.rst @@ -0,0 +1,11 @@ +Lockbox +======= + +.. currentmodule:: oci.lockbox.models + +.. autoclass:: Lockbox + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/lockbox/models/oci.lockbox.models.LockboxCollection.rst b/docs/api/lockbox/models/oci.lockbox.models.LockboxCollection.rst new file mode 100644 index 0000000000..bd0f15c3b8 --- /dev/null +++ b/docs/api/lockbox/models/oci.lockbox.models.LockboxCollection.rst @@ -0,0 +1,11 @@ +LockboxCollection +================= + +.. currentmodule:: oci.lockbox.models + +.. autoclass:: LockboxCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/lockbox/models/oci.lockbox.models.LockboxSummary.rst b/docs/api/lockbox/models/oci.lockbox.models.LockboxSummary.rst new file mode 100644 index 0000000000..4ffba857ab --- /dev/null +++ b/docs/api/lockbox/models/oci.lockbox.models.LockboxSummary.rst @@ -0,0 +1,11 @@ +LockboxSummary +============== + +.. currentmodule:: oci.lockbox.models + +.. autoclass:: LockboxSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/lockbox/models/oci.lockbox.models.UpdateApprovalTemplateDetails.rst b/docs/api/lockbox/models/oci.lockbox.models.UpdateApprovalTemplateDetails.rst new file mode 100644 index 0000000000..8bd2427bdc --- /dev/null +++ b/docs/api/lockbox/models/oci.lockbox.models.UpdateApprovalTemplateDetails.rst @@ -0,0 +1,11 @@ +UpdateApprovalTemplateDetails +============================= + +.. currentmodule:: oci.lockbox.models + +.. autoclass:: UpdateApprovalTemplateDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/lockbox/models/oci.lockbox.models.UpdateLockboxDetails.rst b/docs/api/lockbox/models/oci.lockbox.models.UpdateLockboxDetails.rst new file mode 100644 index 0000000000..a00226f616 --- /dev/null +++ b/docs/api/lockbox/models/oci.lockbox.models.UpdateLockboxDetails.rst @@ -0,0 +1,11 @@ +UpdateLockboxDetails +==================== + +.. currentmodule:: oci.lockbox.models + +.. autoclass:: UpdateLockboxDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/lockbox/models/oci.lockbox.models.WorkRequest.rst b/docs/api/lockbox/models/oci.lockbox.models.WorkRequest.rst new file mode 100644 index 0000000000..4a71c0036b --- /dev/null +++ b/docs/api/lockbox/models/oci.lockbox.models.WorkRequest.rst @@ -0,0 +1,11 @@ +WorkRequest +=========== + +.. currentmodule:: oci.lockbox.models + +.. autoclass:: WorkRequest + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/lockbox/models/oci.lockbox.models.WorkRequestError.rst b/docs/api/lockbox/models/oci.lockbox.models.WorkRequestError.rst new file mode 100644 index 0000000000..339248c50d --- /dev/null +++ b/docs/api/lockbox/models/oci.lockbox.models.WorkRequestError.rst @@ -0,0 +1,11 @@ +WorkRequestError +================ + +.. currentmodule:: oci.lockbox.models + +.. autoclass:: WorkRequestError + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/lockbox/models/oci.lockbox.models.WorkRequestErrorCollection.rst b/docs/api/lockbox/models/oci.lockbox.models.WorkRequestErrorCollection.rst new file mode 100644 index 0000000000..5376b330fc --- /dev/null +++ b/docs/api/lockbox/models/oci.lockbox.models.WorkRequestErrorCollection.rst @@ -0,0 +1,11 @@ +WorkRequestErrorCollection +========================== + +.. currentmodule:: oci.lockbox.models + +.. autoclass:: WorkRequestErrorCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/lockbox/models/oci.lockbox.models.WorkRequestLogEntry.rst b/docs/api/lockbox/models/oci.lockbox.models.WorkRequestLogEntry.rst new file mode 100644 index 0000000000..5e6625a86f --- /dev/null +++ b/docs/api/lockbox/models/oci.lockbox.models.WorkRequestLogEntry.rst @@ -0,0 +1,11 @@ +WorkRequestLogEntry +=================== + +.. currentmodule:: oci.lockbox.models + +.. autoclass:: WorkRequestLogEntry + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/lockbox/models/oci.lockbox.models.WorkRequestLogEntryCollection.rst b/docs/api/lockbox/models/oci.lockbox.models.WorkRequestLogEntryCollection.rst new file mode 100644 index 0000000000..04a5bb8ca6 --- /dev/null +++ b/docs/api/lockbox/models/oci.lockbox.models.WorkRequestLogEntryCollection.rst @@ -0,0 +1,11 @@ +WorkRequestLogEntryCollection +============================= + +.. currentmodule:: oci.lockbox.models + +.. autoclass:: WorkRequestLogEntryCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/lockbox/models/oci.lockbox.models.WorkRequestResource.rst b/docs/api/lockbox/models/oci.lockbox.models.WorkRequestResource.rst new file mode 100644 index 0000000000..c627019139 --- /dev/null +++ b/docs/api/lockbox/models/oci.lockbox.models.WorkRequestResource.rst @@ -0,0 +1,11 @@ +WorkRequestResource +=================== + +.. currentmodule:: oci.lockbox.models + +.. autoclass:: WorkRequestResource + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/lockbox/models/oci.lockbox.models.WorkRequestSummary.rst b/docs/api/lockbox/models/oci.lockbox.models.WorkRequestSummary.rst new file mode 100644 index 0000000000..b77444347e --- /dev/null +++ b/docs/api/lockbox/models/oci.lockbox.models.WorkRequestSummary.rst @@ -0,0 +1,11 @@ +WorkRequestSummary +================== + +.. currentmodule:: oci.lockbox.models + +.. autoclass:: WorkRequestSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/lockbox/models/oci.lockbox.models.WorkRequestSummaryCollection.rst b/docs/api/lockbox/models/oci.lockbox.models.WorkRequestSummaryCollection.rst new file mode 100644 index 0000000000..e448f95b91 --- /dev/null +++ b/docs/api/lockbox/models/oci.lockbox.models.WorkRequestSummaryCollection.rst @@ -0,0 +1,11 @@ +WorkRequestSummaryCollection +============================ + +.. currentmodule:: oci.lockbox.models + +.. autoclass:: WorkRequestSummaryCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/media_services.rst b/docs/api/media_services.rst new file mode 100644 index 0000000000..c080f5eede --- /dev/null +++ b/docs/api/media_services.rst @@ -0,0 +1,88 @@ +Media Services +============== + +.. autosummary:: + :toctree: media_services/client + :nosignatures: + :template: autosummary/service_client.rst + + oci.media_services.MediaServicesClient + oci.media_services.MediaServicesClientCompositeOperations + +-------- + Models +-------- + +.. autosummary:: + :toctree: media_services/models + :nosignatures: + :template: autosummary/model_class.rst + + oci.media_services.models.AkamaiManualStreamCdnConfig + oci.media_services.models.AssetMetadataEntryDetails + oci.media_services.models.ChangeMediaAssetCompartmentDetails + oci.media_services.models.ChangeMediaWorkflowCompartmentDetails + oci.media_services.models.ChangeMediaWorkflowConfigurationCompartmentDetails + oci.media_services.models.ChangeMediaWorkflowJobCompartmentDetails + oci.media_services.models.ChangeStreamDistributionChannelCompartmentDetails + oci.media_services.models.CreateMediaAssetDetails + oci.media_services.models.CreateMediaWorkflowConfigurationDetails + oci.media_services.models.CreateMediaWorkflowDetails + oci.media_services.models.CreateMediaWorkflowJobByIdDetails + oci.media_services.models.CreateMediaWorkflowJobByNameDetails + oci.media_services.models.CreateMediaWorkflowJobDetails + oci.media_services.models.CreateStreamCdnConfigDetails + oci.media_services.models.CreateStreamDistributionChannelDetails + oci.media_services.models.CreateStreamPackagingConfigDetails + oci.media_services.models.DashStreamPackagingConfig + oci.media_services.models.EdgeStreamCdnConfig + oci.media_services.models.HlsStreamPackagingConfig + oci.media_services.models.IngestStreamDistributionChannelDetails + oci.media_services.models.IngestStreamDistributionChannelResult + oci.media_services.models.JobOutput + oci.media_services.models.MediaAsset + oci.media_services.models.MediaAssetCollection + oci.media_services.models.MediaAssetDistributionChannelAttachment + oci.media_services.models.MediaAssetDistributionChannelAttachmentCollection + oci.media_services.models.MediaAssetDistributionChannelAttachmentSummary + oci.media_services.models.MediaAssetSummary + oci.media_services.models.MediaAssetTag + oci.media_services.models.MediaWorkflow + oci.media_services.models.MediaWorkflowCollection + oci.media_services.models.MediaWorkflowConfiguration + oci.media_services.models.MediaWorkflowConfigurationCollection + oci.media_services.models.MediaWorkflowConfigurationSummary + oci.media_services.models.MediaWorkflowJob + oci.media_services.models.MediaWorkflowJobCollection + oci.media_services.models.MediaWorkflowJobFact + oci.media_services.models.MediaWorkflowJobFactCollection + oci.media_services.models.MediaWorkflowJobFactSummary + oci.media_services.models.MediaWorkflowJobSummary + oci.media_services.models.MediaWorkflowSummary + oci.media_services.models.MediaWorkflowTask + oci.media_services.models.MediaWorkflowTaskDeclaration + oci.media_services.models.MediaWorkflowTaskDeclarationCollection + oci.media_services.models.MediaWorkflowTaskState + oci.media_services.models.Metadata + oci.media_services.models.StreamCdnConfig + oci.media_services.models.StreamCdnConfigCollection + oci.media_services.models.StreamCdnConfigSection + oci.media_services.models.StreamCdnConfigSummary + oci.media_services.models.StreamDistributionChannel + oci.media_services.models.StreamDistributionChannelCollection + oci.media_services.models.StreamDistributionChannelSummary + oci.media_services.models.StreamPackagingConfig + oci.media_services.models.StreamPackagingConfigCollection + oci.media_services.models.StreamPackagingConfigEncryption + oci.media_services.models.StreamPackagingConfigEncryptionAes128 + oci.media_services.models.StreamPackagingConfigEncryptionNone + oci.media_services.models.StreamPackagingConfigSummary + oci.media_services.models.SystemMediaWorkflow + oci.media_services.models.SystemMediaWorkflowCollection + oci.media_services.models.UpdateMediaAssetDetails + oci.media_services.models.UpdateMediaWorkflowConfigurationDetails + oci.media_services.models.UpdateMediaWorkflowDetails + oci.media_services.models.UpdateMediaWorkflowJobDetails + oci.media_services.models.UpdateStreamCdnConfigDetails + oci.media_services.models.UpdateStreamDistributionChannelDetails + oci.media_services.models.UpdateStreamPackagingConfigDetails diff --git a/docs/api/media_services/client/oci.media_services.MediaServicesClient.rst b/docs/api/media_services/client/oci.media_services.MediaServicesClient.rst new file mode 100644 index 0000000000..b90b11e2f0 --- /dev/null +++ b/docs/api/media_services/client/oci.media_services.MediaServicesClient.rst @@ -0,0 +1,8 @@ +MediaServicesClient +=================== + +.. currentmodule:: oci.media_services + +.. autoclass:: MediaServicesClient + :special-members: __init__ + :members: \ No newline at end of file diff --git a/docs/api/media_services/client/oci.media_services.MediaServicesClientCompositeOperations.rst b/docs/api/media_services/client/oci.media_services.MediaServicesClientCompositeOperations.rst new file mode 100644 index 0000000000..c23f41ce7d --- /dev/null +++ b/docs/api/media_services/client/oci.media_services.MediaServicesClientCompositeOperations.rst @@ -0,0 +1,8 @@ +MediaServicesClientCompositeOperations +====================================== + +.. currentmodule:: oci.media_services + +.. autoclass:: MediaServicesClientCompositeOperations + :special-members: __init__ + :members: \ No newline at end of file diff --git a/docs/api/media_services/models/oci.media_services.models.AkamaiManualStreamCdnConfig.rst b/docs/api/media_services/models/oci.media_services.models.AkamaiManualStreamCdnConfig.rst new file mode 100644 index 0000000000..261a12650c --- /dev/null +++ b/docs/api/media_services/models/oci.media_services.models.AkamaiManualStreamCdnConfig.rst @@ -0,0 +1,11 @@ +AkamaiManualStreamCdnConfig +=========================== + +.. currentmodule:: oci.media_services.models + +.. autoclass:: AkamaiManualStreamCdnConfig + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/media_services/models/oci.media_services.models.AssetMetadataEntryDetails.rst b/docs/api/media_services/models/oci.media_services.models.AssetMetadataEntryDetails.rst new file mode 100644 index 0000000000..bdee58483f --- /dev/null +++ b/docs/api/media_services/models/oci.media_services.models.AssetMetadataEntryDetails.rst @@ -0,0 +1,11 @@ +AssetMetadataEntryDetails +========================= + +.. currentmodule:: oci.media_services.models + +.. autoclass:: AssetMetadataEntryDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/media_services/models/oci.media_services.models.ChangeMediaAssetCompartmentDetails.rst b/docs/api/media_services/models/oci.media_services.models.ChangeMediaAssetCompartmentDetails.rst new file mode 100644 index 0000000000..2607b86644 --- /dev/null +++ b/docs/api/media_services/models/oci.media_services.models.ChangeMediaAssetCompartmentDetails.rst @@ -0,0 +1,11 @@ +ChangeMediaAssetCompartmentDetails +================================== + +.. currentmodule:: oci.media_services.models + +.. autoclass:: ChangeMediaAssetCompartmentDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/media_services/models/oci.media_services.models.ChangeMediaWorkflowCompartmentDetails.rst b/docs/api/media_services/models/oci.media_services.models.ChangeMediaWorkflowCompartmentDetails.rst new file mode 100644 index 0000000000..4bed0ffd31 --- /dev/null +++ b/docs/api/media_services/models/oci.media_services.models.ChangeMediaWorkflowCompartmentDetails.rst @@ -0,0 +1,11 @@ +ChangeMediaWorkflowCompartmentDetails +===================================== + +.. currentmodule:: oci.media_services.models + +.. autoclass:: ChangeMediaWorkflowCompartmentDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/media_services/models/oci.media_services.models.ChangeMediaWorkflowConfigurationCompartmentDetails.rst b/docs/api/media_services/models/oci.media_services.models.ChangeMediaWorkflowConfigurationCompartmentDetails.rst new file mode 100644 index 0000000000..f8d9a897ea --- /dev/null +++ b/docs/api/media_services/models/oci.media_services.models.ChangeMediaWorkflowConfigurationCompartmentDetails.rst @@ -0,0 +1,11 @@ +ChangeMediaWorkflowConfigurationCompartmentDetails +================================================== + +.. currentmodule:: oci.media_services.models + +.. autoclass:: ChangeMediaWorkflowConfigurationCompartmentDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/media_services/models/oci.media_services.models.ChangeMediaWorkflowJobCompartmentDetails.rst b/docs/api/media_services/models/oci.media_services.models.ChangeMediaWorkflowJobCompartmentDetails.rst new file mode 100644 index 0000000000..8fa806fd4a --- /dev/null +++ b/docs/api/media_services/models/oci.media_services.models.ChangeMediaWorkflowJobCompartmentDetails.rst @@ -0,0 +1,11 @@ +ChangeMediaWorkflowJobCompartmentDetails +======================================== + +.. currentmodule:: oci.media_services.models + +.. autoclass:: ChangeMediaWorkflowJobCompartmentDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/media_services/models/oci.media_services.models.ChangeStreamDistributionChannelCompartmentDetails.rst b/docs/api/media_services/models/oci.media_services.models.ChangeStreamDistributionChannelCompartmentDetails.rst new file mode 100644 index 0000000000..a6c6c35c2c --- /dev/null +++ b/docs/api/media_services/models/oci.media_services.models.ChangeStreamDistributionChannelCompartmentDetails.rst @@ -0,0 +1,11 @@ +ChangeStreamDistributionChannelCompartmentDetails +================================================= + +.. currentmodule:: oci.media_services.models + +.. autoclass:: ChangeStreamDistributionChannelCompartmentDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/media_services/models/oci.media_services.models.CreateMediaAssetDetails.rst b/docs/api/media_services/models/oci.media_services.models.CreateMediaAssetDetails.rst new file mode 100644 index 0000000000..2a2f29d44a --- /dev/null +++ b/docs/api/media_services/models/oci.media_services.models.CreateMediaAssetDetails.rst @@ -0,0 +1,11 @@ +CreateMediaAssetDetails +======================= + +.. currentmodule:: oci.media_services.models + +.. autoclass:: CreateMediaAssetDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/media_services/models/oci.media_services.models.CreateMediaWorkflowConfigurationDetails.rst b/docs/api/media_services/models/oci.media_services.models.CreateMediaWorkflowConfigurationDetails.rst new file mode 100644 index 0000000000..61c413e3ac --- /dev/null +++ b/docs/api/media_services/models/oci.media_services.models.CreateMediaWorkflowConfigurationDetails.rst @@ -0,0 +1,11 @@ +CreateMediaWorkflowConfigurationDetails +======================================= + +.. currentmodule:: oci.media_services.models + +.. autoclass:: CreateMediaWorkflowConfigurationDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/media_services/models/oci.media_services.models.CreateMediaWorkflowDetails.rst b/docs/api/media_services/models/oci.media_services.models.CreateMediaWorkflowDetails.rst new file mode 100644 index 0000000000..a59b0e35ac --- /dev/null +++ b/docs/api/media_services/models/oci.media_services.models.CreateMediaWorkflowDetails.rst @@ -0,0 +1,11 @@ +CreateMediaWorkflowDetails +========================== + +.. currentmodule:: oci.media_services.models + +.. autoclass:: CreateMediaWorkflowDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/media_services/models/oci.media_services.models.CreateMediaWorkflowJobByIdDetails.rst b/docs/api/media_services/models/oci.media_services.models.CreateMediaWorkflowJobByIdDetails.rst new file mode 100644 index 0000000000..0bbdc2beb8 --- /dev/null +++ b/docs/api/media_services/models/oci.media_services.models.CreateMediaWorkflowJobByIdDetails.rst @@ -0,0 +1,11 @@ +CreateMediaWorkflowJobByIdDetails +================================= + +.. currentmodule:: oci.media_services.models + +.. autoclass:: CreateMediaWorkflowJobByIdDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/media_services/models/oci.media_services.models.CreateMediaWorkflowJobByNameDetails.rst b/docs/api/media_services/models/oci.media_services.models.CreateMediaWorkflowJobByNameDetails.rst new file mode 100644 index 0000000000..3f3829832d --- /dev/null +++ b/docs/api/media_services/models/oci.media_services.models.CreateMediaWorkflowJobByNameDetails.rst @@ -0,0 +1,11 @@ +CreateMediaWorkflowJobByNameDetails +=================================== + +.. currentmodule:: oci.media_services.models + +.. autoclass:: CreateMediaWorkflowJobByNameDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/media_services/models/oci.media_services.models.CreateMediaWorkflowJobDetails.rst b/docs/api/media_services/models/oci.media_services.models.CreateMediaWorkflowJobDetails.rst new file mode 100644 index 0000000000..ec39b5a891 --- /dev/null +++ b/docs/api/media_services/models/oci.media_services.models.CreateMediaWorkflowJobDetails.rst @@ -0,0 +1,11 @@ +CreateMediaWorkflowJobDetails +============================= + +.. currentmodule:: oci.media_services.models + +.. autoclass:: CreateMediaWorkflowJobDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/media_services/models/oci.media_services.models.CreateStreamCdnConfigDetails.rst b/docs/api/media_services/models/oci.media_services.models.CreateStreamCdnConfigDetails.rst new file mode 100644 index 0000000000..deb5b74228 --- /dev/null +++ b/docs/api/media_services/models/oci.media_services.models.CreateStreamCdnConfigDetails.rst @@ -0,0 +1,11 @@ +CreateStreamCdnConfigDetails +============================ + +.. currentmodule:: oci.media_services.models + +.. autoclass:: CreateStreamCdnConfigDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/media_services/models/oci.media_services.models.CreateStreamDistributionChannelDetails.rst b/docs/api/media_services/models/oci.media_services.models.CreateStreamDistributionChannelDetails.rst new file mode 100644 index 0000000000..9d2a50547e --- /dev/null +++ b/docs/api/media_services/models/oci.media_services.models.CreateStreamDistributionChannelDetails.rst @@ -0,0 +1,11 @@ +CreateStreamDistributionChannelDetails +====================================== + +.. currentmodule:: oci.media_services.models + +.. autoclass:: CreateStreamDistributionChannelDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/media_services/models/oci.media_services.models.CreateStreamPackagingConfigDetails.rst b/docs/api/media_services/models/oci.media_services.models.CreateStreamPackagingConfigDetails.rst new file mode 100644 index 0000000000..d0a83860ed --- /dev/null +++ b/docs/api/media_services/models/oci.media_services.models.CreateStreamPackagingConfigDetails.rst @@ -0,0 +1,11 @@ +CreateStreamPackagingConfigDetails +================================== + +.. currentmodule:: oci.media_services.models + +.. autoclass:: CreateStreamPackagingConfigDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/media_services/models/oci.media_services.models.DashStreamPackagingConfig.rst b/docs/api/media_services/models/oci.media_services.models.DashStreamPackagingConfig.rst new file mode 100644 index 0000000000..bcdbaca429 --- /dev/null +++ b/docs/api/media_services/models/oci.media_services.models.DashStreamPackagingConfig.rst @@ -0,0 +1,11 @@ +DashStreamPackagingConfig +========================= + +.. currentmodule:: oci.media_services.models + +.. autoclass:: DashStreamPackagingConfig + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/media_services/models/oci.media_services.models.EdgeStreamCdnConfig.rst b/docs/api/media_services/models/oci.media_services.models.EdgeStreamCdnConfig.rst new file mode 100644 index 0000000000..1abf19b40f --- /dev/null +++ b/docs/api/media_services/models/oci.media_services.models.EdgeStreamCdnConfig.rst @@ -0,0 +1,11 @@ +EdgeStreamCdnConfig +=================== + +.. currentmodule:: oci.media_services.models + +.. autoclass:: EdgeStreamCdnConfig + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/media_services/models/oci.media_services.models.HlsStreamPackagingConfig.rst b/docs/api/media_services/models/oci.media_services.models.HlsStreamPackagingConfig.rst new file mode 100644 index 0000000000..b5ece9ad1e --- /dev/null +++ b/docs/api/media_services/models/oci.media_services.models.HlsStreamPackagingConfig.rst @@ -0,0 +1,11 @@ +HlsStreamPackagingConfig +======================== + +.. currentmodule:: oci.media_services.models + +.. autoclass:: HlsStreamPackagingConfig + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/media_services/models/oci.media_services.models.IngestStreamDistributionChannelDetails.rst b/docs/api/media_services/models/oci.media_services.models.IngestStreamDistributionChannelDetails.rst new file mode 100644 index 0000000000..570c884f77 --- /dev/null +++ b/docs/api/media_services/models/oci.media_services.models.IngestStreamDistributionChannelDetails.rst @@ -0,0 +1,11 @@ +IngestStreamDistributionChannelDetails +====================================== + +.. currentmodule:: oci.media_services.models + +.. autoclass:: IngestStreamDistributionChannelDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/media_services/models/oci.media_services.models.IngestStreamDistributionChannelResult.rst b/docs/api/media_services/models/oci.media_services.models.IngestStreamDistributionChannelResult.rst new file mode 100644 index 0000000000..5aa4fe5682 --- /dev/null +++ b/docs/api/media_services/models/oci.media_services.models.IngestStreamDistributionChannelResult.rst @@ -0,0 +1,11 @@ +IngestStreamDistributionChannelResult +===================================== + +.. currentmodule:: oci.media_services.models + +.. autoclass:: IngestStreamDistributionChannelResult + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/media_services/models/oci.media_services.models.JobOutput.rst b/docs/api/media_services/models/oci.media_services.models.JobOutput.rst new file mode 100644 index 0000000000..6e911b9660 --- /dev/null +++ b/docs/api/media_services/models/oci.media_services.models.JobOutput.rst @@ -0,0 +1,11 @@ +JobOutput +========= + +.. currentmodule:: oci.media_services.models + +.. autoclass:: JobOutput + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/media_services/models/oci.media_services.models.MediaAsset.rst b/docs/api/media_services/models/oci.media_services.models.MediaAsset.rst new file mode 100644 index 0000000000..06aee4c715 --- /dev/null +++ b/docs/api/media_services/models/oci.media_services.models.MediaAsset.rst @@ -0,0 +1,11 @@ +MediaAsset +========== + +.. currentmodule:: oci.media_services.models + +.. autoclass:: MediaAsset + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/media_services/models/oci.media_services.models.MediaAssetCollection.rst b/docs/api/media_services/models/oci.media_services.models.MediaAssetCollection.rst new file mode 100644 index 0000000000..a04849fd7d --- /dev/null +++ b/docs/api/media_services/models/oci.media_services.models.MediaAssetCollection.rst @@ -0,0 +1,11 @@ +MediaAssetCollection +==================== + +.. currentmodule:: oci.media_services.models + +.. autoclass:: MediaAssetCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/media_services/models/oci.media_services.models.MediaAssetDistributionChannelAttachment.rst b/docs/api/media_services/models/oci.media_services.models.MediaAssetDistributionChannelAttachment.rst new file mode 100644 index 0000000000..6028b6b574 --- /dev/null +++ b/docs/api/media_services/models/oci.media_services.models.MediaAssetDistributionChannelAttachment.rst @@ -0,0 +1,11 @@ +MediaAssetDistributionChannelAttachment +======================================= + +.. currentmodule:: oci.media_services.models + +.. autoclass:: MediaAssetDistributionChannelAttachment + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/media_services/models/oci.media_services.models.MediaAssetDistributionChannelAttachmentCollection.rst b/docs/api/media_services/models/oci.media_services.models.MediaAssetDistributionChannelAttachmentCollection.rst new file mode 100644 index 0000000000..41ac7f3bd8 --- /dev/null +++ b/docs/api/media_services/models/oci.media_services.models.MediaAssetDistributionChannelAttachmentCollection.rst @@ -0,0 +1,11 @@ +MediaAssetDistributionChannelAttachmentCollection +================================================= + +.. currentmodule:: oci.media_services.models + +.. autoclass:: MediaAssetDistributionChannelAttachmentCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/media_services/models/oci.media_services.models.MediaAssetDistributionChannelAttachmentSummary.rst b/docs/api/media_services/models/oci.media_services.models.MediaAssetDistributionChannelAttachmentSummary.rst new file mode 100644 index 0000000000..e84d50e145 --- /dev/null +++ b/docs/api/media_services/models/oci.media_services.models.MediaAssetDistributionChannelAttachmentSummary.rst @@ -0,0 +1,11 @@ +MediaAssetDistributionChannelAttachmentSummary +============================================== + +.. currentmodule:: oci.media_services.models + +.. autoclass:: MediaAssetDistributionChannelAttachmentSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/media_services/models/oci.media_services.models.MediaAssetSummary.rst b/docs/api/media_services/models/oci.media_services.models.MediaAssetSummary.rst new file mode 100644 index 0000000000..77c68c66a8 --- /dev/null +++ b/docs/api/media_services/models/oci.media_services.models.MediaAssetSummary.rst @@ -0,0 +1,11 @@ +MediaAssetSummary +================= + +.. currentmodule:: oci.media_services.models + +.. autoclass:: MediaAssetSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/media_services/models/oci.media_services.models.MediaAssetTag.rst b/docs/api/media_services/models/oci.media_services.models.MediaAssetTag.rst new file mode 100644 index 0000000000..1c310dccc8 --- /dev/null +++ b/docs/api/media_services/models/oci.media_services.models.MediaAssetTag.rst @@ -0,0 +1,11 @@ +MediaAssetTag +============= + +.. currentmodule:: oci.media_services.models + +.. autoclass:: MediaAssetTag + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/media_services/models/oci.media_services.models.MediaWorkflow.rst b/docs/api/media_services/models/oci.media_services.models.MediaWorkflow.rst new file mode 100644 index 0000000000..44d368453c --- /dev/null +++ b/docs/api/media_services/models/oci.media_services.models.MediaWorkflow.rst @@ -0,0 +1,11 @@ +MediaWorkflow +============= + +.. currentmodule:: oci.media_services.models + +.. autoclass:: MediaWorkflow + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/media_services/models/oci.media_services.models.MediaWorkflowCollection.rst b/docs/api/media_services/models/oci.media_services.models.MediaWorkflowCollection.rst new file mode 100644 index 0000000000..749193e541 --- /dev/null +++ b/docs/api/media_services/models/oci.media_services.models.MediaWorkflowCollection.rst @@ -0,0 +1,11 @@ +MediaWorkflowCollection +======================= + +.. currentmodule:: oci.media_services.models + +.. autoclass:: MediaWorkflowCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/media_services/models/oci.media_services.models.MediaWorkflowConfiguration.rst b/docs/api/media_services/models/oci.media_services.models.MediaWorkflowConfiguration.rst new file mode 100644 index 0000000000..1f96d5870b --- /dev/null +++ b/docs/api/media_services/models/oci.media_services.models.MediaWorkflowConfiguration.rst @@ -0,0 +1,11 @@ +MediaWorkflowConfiguration +========================== + +.. currentmodule:: oci.media_services.models + +.. autoclass:: MediaWorkflowConfiguration + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/media_services/models/oci.media_services.models.MediaWorkflowConfigurationCollection.rst b/docs/api/media_services/models/oci.media_services.models.MediaWorkflowConfigurationCollection.rst new file mode 100644 index 0000000000..fb8102f23f --- /dev/null +++ b/docs/api/media_services/models/oci.media_services.models.MediaWorkflowConfigurationCollection.rst @@ -0,0 +1,11 @@ +MediaWorkflowConfigurationCollection +==================================== + +.. currentmodule:: oci.media_services.models + +.. autoclass:: MediaWorkflowConfigurationCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/media_services/models/oci.media_services.models.MediaWorkflowConfigurationSummary.rst b/docs/api/media_services/models/oci.media_services.models.MediaWorkflowConfigurationSummary.rst new file mode 100644 index 0000000000..6b78e5ba61 --- /dev/null +++ b/docs/api/media_services/models/oci.media_services.models.MediaWorkflowConfigurationSummary.rst @@ -0,0 +1,11 @@ +MediaWorkflowConfigurationSummary +================================= + +.. currentmodule:: oci.media_services.models + +.. autoclass:: MediaWorkflowConfigurationSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/media_services/models/oci.media_services.models.MediaWorkflowJob.rst b/docs/api/media_services/models/oci.media_services.models.MediaWorkflowJob.rst new file mode 100644 index 0000000000..5afc7c8d88 --- /dev/null +++ b/docs/api/media_services/models/oci.media_services.models.MediaWorkflowJob.rst @@ -0,0 +1,11 @@ +MediaWorkflowJob +================ + +.. currentmodule:: oci.media_services.models + +.. autoclass:: MediaWorkflowJob + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/media_services/models/oci.media_services.models.MediaWorkflowJobCollection.rst b/docs/api/media_services/models/oci.media_services.models.MediaWorkflowJobCollection.rst new file mode 100644 index 0000000000..7928ca2811 --- /dev/null +++ b/docs/api/media_services/models/oci.media_services.models.MediaWorkflowJobCollection.rst @@ -0,0 +1,11 @@ +MediaWorkflowJobCollection +========================== + +.. currentmodule:: oci.media_services.models + +.. autoclass:: MediaWorkflowJobCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/media_services/models/oci.media_services.models.MediaWorkflowJobFact.rst b/docs/api/media_services/models/oci.media_services.models.MediaWorkflowJobFact.rst new file mode 100644 index 0000000000..2d523be542 --- /dev/null +++ b/docs/api/media_services/models/oci.media_services.models.MediaWorkflowJobFact.rst @@ -0,0 +1,11 @@ +MediaWorkflowJobFact +==================== + +.. currentmodule:: oci.media_services.models + +.. autoclass:: MediaWorkflowJobFact + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/media_services/models/oci.media_services.models.MediaWorkflowJobFactCollection.rst b/docs/api/media_services/models/oci.media_services.models.MediaWorkflowJobFactCollection.rst new file mode 100644 index 0000000000..978adee5c1 --- /dev/null +++ b/docs/api/media_services/models/oci.media_services.models.MediaWorkflowJobFactCollection.rst @@ -0,0 +1,11 @@ +MediaWorkflowJobFactCollection +============================== + +.. currentmodule:: oci.media_services.models + +.. autoclass:: MediaWorkflowJobFactCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/media_services/models/oci.media_services.models.MediaWorkflowJobFactSummary.rst b/docs/api/media_services/models/oci.media_services.models.MediaWorkflowJobFactSummary.rst new file mode 100644 index 0000000000..2c4599e401 --- /dev/null +++ b/docs/api/media_services/models/oci.media_services.models.MediaWorkflowJobFactSummary.rst @@ -0,0 +1,11 @@ +MediaWorkflowJobFactSummary +=========================== + +.. currentmodule:: oci.media_services.models + +.. autoclass:: MediaWorkflowJobFactSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/media_services/models/oci.media_services.models.MediaWorkflowJobSummary.rst b/docs/api/media_services/models/oci.media_services.models.MediaWorkflowJobSummary.rst new file mode 100644 index 0000000000..9e520c346b --- /dev/null +++ b/docs/api/media_services/models/oci.media_services.models.MediaWorkflowJobSummary.rst @@ -0,0 +1,11 @@ +MediaWorkflowJobSummary +======================= + +.. currentmodule:: oci.media_services.models + +.. autoclass:: MediaWorkflowJobSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/media_services/models/oci.media_services.models.MediaWorkflowSummary.rst b/docs/api/media_services/models/oci.media_services.models.MediaWorkflowSummary.rst new file mode 100644 index 0000000000..4965834492 --- /dev/null +++ b/docs/api/media_services/models/oci.media_services.models.MediaWorkflowSummary.rst @@ -0,0 +1,11 @@ +MediaWorkflowSummary +==================== + +.. currentmodule:: oci.media_services.models + +.. autoclass:: MediaWorkflowSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/media_services/models/oci.media_services.models.MediaWorkflowTask.rst b/docs/api/media_services/models/oci.media_services.models.MediaWorkflowTask.rst new file mode 100644 index 0000000000..878bca17aa --- /dev/null +++ b/docs/api/media_services/models/oci.media_services.models.MediaWorkflowTask.rst @@ -0,0 +1,11 @@ +MediaWorkflowTask +================= + +.. currentmodule:: oci.media_services.models + +.. autoclass:: MediaWorkflowTask + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/media_services/models/oci.media_services.models.MediaWorkflowTaskDeclaration.rst b/docs/api/media_services/models/oci.media_services.models.MediaWorkflowTaskDeclaration.rst new file mode 100644 index 0000000000..51c003e476 --- /dev/null +++ b/docs/api/media_services/models/oci.media_services.models.MediaWorkflowTaskDeclaration.rst @@ -0,0 +1,11 @@ +MediaWorkflowTaskDeclaration +============================ + +.. currentmodule:: oci.media_services.models + +.. autoclass:: MediaWorkflowTaskDeclaration + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/media_services/models/oci.media_services.models.MediaWorkflowTaskDeclarationCollection.rst b/docs/api/media_services/models/oci.media_services.models.MediaWorkflowTaskDeclarationCollection.rst new file mode 100644 index 0000000000..7957563bd5 --- /dev/null +++ b/docs/api/media_services/models/oci.media_services.models.MediaWorkflowTaskDeclarationCollection.rst @@ -0,0 +1,11 @@ +MediaWorkflowTaskDeclarationCollection +====================================== + +.. currentmodule:: oci.media_services.models + +.. autoclass:: MediaWorkflowTaskDeclarationCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/media_services/models/oci.media_services.models.MediaWorkflowTaskState.rst b/docs/api/media_services/models/oci.media_services.models.MediaWorkflowTaskState.rst new file mode 100644 index 0000000000..e8d17a3102 --- /dev/null +++ b/docs/api/media_services/models/oci.media_services.models.MediaWorkflowTaskState.rst @@ -0,0 +1,11 @@ +MediaWorkflowTaskState +====================== + +.. currentmodule:: oci.media_services.models + +.. autoclass:: MediaWorkflowTaskState + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/media_services/models/oci.media_services.models.Metadata.rst b/docs/api/media_services/models/oci.media_services.models.Metadata.rst new file mode 100644 index 0000000000..322dc55b8a --- /dev/null +++ b/docs/api/media_services/models/oci.media_services.models.Metadata.rst @@ -0,0 +1,11 @@ +Metadata +======== + +.. currentmodule:: oci.media_services.models + +.. autoclass:: Metadata + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/media_services/models/oci.media_services.models.StreamCdnConfig.rst b/docs/api/media_services/models/oci.media_services.models.StreamCdnConfig.rst new file mode 100644 index 0000000000..8c6c644ae3 --- /dev/null +++ b/docs/api/media_services/models/oci.media_services.models.StreamCdnConfig.rst @@ -0,0 +1,11 @@ +StreamCdnConfig +=============== + +.. currentmodule:: oci.media_services.models + +.. autoclass:: StreamCdnConfig + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/media_services/models/oci.media_services.models.StreamCdnConfigCollection.rst b/docs/api/media_services/models/oci.media_services.models.StreamCdnConfigCollection.rst new file mode 100644 index 0000000000..cdd7094c53 --- /dev/null +++ b/docs/api/media_services/models/oci.media_services.models.StreamCdnConfigCollection.rst @@ -0,0 +1,11 @@ +StreamCdnConfigCollection +========================= + +.. currentmodule:: oci.media_services.models + +.. autoclass:: StreamCdnConfigCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/media_services/models/oci.media_services.models.StreamCdnConfigSection.rst b/docs/api/media_services/models/oci.media_services.models.StreamCdnConfigSection.rst new file mode 100644 index 0000000000..e76e34e75d --- /dev/null +++ b/docs/api/media_services/models/oci.media_services.models.StreamCdnConfigSection.rst @@ -0,0 +1,11 @@ +StreamCdnConfigSection +====================== + +.. currentmodule:: oci.media_services.models + +.. autoclass:: StreamCdnConfigSection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/media_services/models/oci.media_services.models.StreamCdnConfigSummary.rst b/docs/api/media_services/models/oci.media_services.models.StreamCdnConfigSummary.rst new file mode 100644 index 0000000000..218a655a4f --- /dev/null +++ b/docs/api/media_services/models/oci.media_services.models.StreamCdnConfigSummary.rst @@ -0,0 +1,11 @@ +StreamCdnConfigSummary +====================== + +.. currentmodule:: oci.media_services.models + +.. autoclass:: StreamCdnConfigSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/media_services/models/oci.media_services.models.StreamDistributionChannel.rst b/docs/api/media_services/models/oci.media_services.models.StreamDistributionChannel.rst new file mode 100644 index 0000000000..160500d256 --- /dev/null +++ b/docs/api/media_services/models/oci.media_services.models.StreamDistributionChannel.rst @@ -0,0 +1,11 @@ +StreamDistributionChannel +========================= + +.. currentmodule:: oci.media_services.models + +.. autoclass:: StreamDistributionChannel + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/media_services/models/oci.media_services.models.StreamDistributionChannelCollection.rst b/docs/api/media_services/models/oci.media_services.models.StreamDistributionChannelCollection.rst new file mode 100644 index 0000000000..1be6d122d6 --- /dev/null +++ b/docs/api/media_services/models/oci.media_services.models.StreamDistributionChannelCollection.rst @@ -0,0 +1,11 @@ +StreamDistributionChannelCollection +=================================== + +.. currentmodule:: oci.media_services.models + +.. autoclass:: StreamDistributionChannelCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/media_services/models/oci.media_services.models.StreamDistributionChannelSummary.rst b/docs/api/media_services/models/oci.media_services.models.StreamDistributionChannelSummary.rst new file mode 100644 index 0000000000..28655f8625 --- /dev/null +++ b/docs/api/media_services/models/oci.media_services.models.StreamDistributionChannelSummary.rst @@ -0,0 +1,11 @@ +StreamDistributionChannelSummary +================================ + +.. currentmodule:: oci.media_services.models + +.. autoclass:: StreamDistributionChannelSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/media_services/models/oci.media_services.models.StreamPackagingConfig.rst b/docs/api/media_services/models/oci.media_services.models.StreamPackagingConfig.rst new file mode 100644 index 0000000000..d8b592ae73 --- /dev/null +++ b/docs/api/media_services/models/oci.media_services.models.StreamPackagingConfig.rst @@ -0,0 +1,11 @@ +StreamPackagingConfig +===================== + +.. currentmodule:: oci.media_services.models + +.. autoclass:: StreamPackagingConfig + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/media_services/models/oci.media_services.models.StreamPackagingConfigCollection.rst b/docs/api/media_services/models/oci.media_services.models.StreamPackagingConfigCollection.rst new file mode 100644 index 0000000000..6d9ebafc5b --- /dev/null +++ b/docs/api/media_services/models/oci.media_services.models.StreamPackagingConfigCollection.rst @@ -0,0 +1,11 @@ +StreamPackagingConfigCollection +=============================== + +.. currentmodule:: oci.media_services.models + +.. autoclass:: StreamPackagingConfigCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/media_services/models/oci.media_services.models.StreamPackagingConfigEncryption.rst b/docs/api/media_services/models/oci.media_services.models.StreamPackagingConfigEncryption.rst new file mode 100644 index 0000000000..7dad8adc2d --- /dev/null +++ b/docs/api/media_services/models/oci.media_services.models.StreamPackagingConfigEncryption.rst @@ -0,0 +1,11 @@ +StreamPackagingConfigEncryption +=============================== + +.. currentmodule:: oci.media_services.models + +.. autoclass:: StreamPackagingConfigEncryption + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/media_services/models/oci.media_services.models.StreamPackagingConfigEncryptionAes128.rst b/docs/api/media_services/models/oci.media_services.models.StreamPackagingConfigEncryptionAes128.rst new file mode 100644 index 0000000000..8b04a5b59d --- /dev/null +++ b/docs/api/media_services/models/oci.media_services.models.StreamPackagingConfigEncryptionAes128.rst @@ -0,0 +1,11 @@ +StreamPackagingConfigEncryptionAes128 +===================================== + +.. currentmodule:: oci.media_services.models + +.. autoclass:: StreamPackagingConfigEncryptionAes128 + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/media_services/models/oci.media_services.models.StreamPackagingConfigEncryptionNone.rst b/docs/api/media_services/models/oci.media_services.models.StreamPackagingConfigEncryptionNone.rst new file mode 100644 index 0000000000..fee617bf52 --- /dev/null +++ b/docs/api/media_services/models/oci.media_services.models.StreamPackagingConfigEncryptionNone.rst @@ -0,0 +1,11 @@ +StreamPackagingConfigEncryptionNone +=================================== + +.. currentmodule:: oci.media_services.models + +.. autoclass:: StreamPackagingConfigEncryptionNone + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/media_services/models/oci.media_services.models.StreamPackagingConfigSummary.rst b/docs/api/media_services/models/oci.media_services.models.StreamPackagingConfigSummary.rst new file mode 100644 index 0000000000..8b1fdda415 --- /dev/null +++ b/docs/api/media_services/models/oci.media_services.models.StreamPackagingConfigSummary.rst @@ -0,0 +1,11 @@ +StreamPackagingConfigSummary +============================ + +.. currentmodule:: oci.media_services.models + +.. autoclass:: StreamPackagingConfigSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/media_services/models/oci.media_services.models.SystemMediaWorkflow.rst b/docs/api/media_services/models/oci.media_services.models.SystemMediaWorkflow.rst new file mode 100644 index 0000000000..20f3d189ed --- /dev/null +++ b/docs/api/media_services/models/oci.media_services.models.SystemMediaWorkflow.rst @@ -0,0 +1,11 @@ +SystemMediaWorkflow +=================== + +.. currentmodule:: oci.media_services.models + +.. autoclass:: SystemMediaWorkflow + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/media_services/models/oci.media_services.models.SystemMediaWorkflowCollection.rst b/docs/api/media_services/models/oci.media_services.models.SystemMediaWorkflowCollection.rst new file mode 100644 index 0000000000..1ddd2e57c2 --- /dev/null +++ b/docs/api/media_services/models/oci.media_services.models.SystemMediaWorkflowCollection.rst @@ -0,0 +1,11 @@ +SystemMediaWorkflowCollection +============================= + +.. currentmodule:: oci.media_services.models + +.. autoclass:: SystemMediaWorkflowCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/media_services/models/oci.media_services.models.UpdateMediaAssetDetails.rst b/docs/api/media_services/models/oci.media_services.models.UpdateMediaAssetDetails.rst new file mode 100644 index 0000000000..464f2ef456 --- /dev/null +++ b/docs/api/media_services/models/oci.media_services.models.UpdateMediaAssetDetails.rst @@ -0,0 +1,11 @@ +UpdateMediaAssetDetails +======================= + +.. currentmodule:: oci.media_services.models + +.. autoclass:: UpdateMediaAssetDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/media_services/models/oci.media_services.models.UpdateMediaWorkflowConfigurationDetails.rst b/docs/api/media_services/models/oci.media_services.models.UpdateMediaWorkflowConfigurationDetails.rst new file mode 100644 index 0000000000..92b7d76278 --- /dev/null +++ b/docs/api/media_services/models/oci.media_services.models.UpdateMediaWorkflowConfigurationDetails.rst @@ -0,0 +1,11 @@ +UpdateMediaWorkflowConfigurationDetails +======================================= + +.. currentmodule:: oci.media_services.models + +.. autoclass:: UpdateMediaWorkflowConfigurationDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/media_services/models/oci.media_services.models.UpdateMediaWorkflowDetails.rst b/docs/api/media_services/models/oci.media_services.models.UpdateMediaWorkflowDetails.rst new file mode 100644 index 0000000000..c49aab8799 --- /dev/null +++ b/docs/api/media_services/models/oci.media_services.models.UpdateMediaWorkflowDetails.rst @@ -0,0 +1,11 @@ +UpdateMediaWorkflowDetails +========================== + +.. currentmodule:: oci.media_services.models + +.. autoclass:: UpdateMediaWorkflowDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/media_services/models/oci.media_services.models.UpdateMediaWorkflowJobDetails.rst b/docs/api/media_services/models/oci.media_services.models.UpdateMediaWorkflowJobDetails.rst new file mode 100644 index 0000000000..ab642cbc9a --- /dev/null +++ b/docs/api/media_services/models/oci.media_services.models.UpdateMediaWorkflowJobDetails.rst @@ -0,0 +1,11 @@ +UpdateMediaWorkflowJobDetails +============================= + +.. currentmodule:: oci.media_services.models + +.. autoclass:: UpdateMediaWorkflowJobDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/media_services/models/oci.media_services.models.UpdateStreamCdnConfigDetails.rst b/docs/api/media_services/models/oci.media_services.models.UpdateStreamCdnConfigDetails.rst new file mode 100644 index 0000000000..634505184d --- /dev/null +++ b/docs/api/media_services/models/oci.media_services.models.UpdateStreamCdnConfigDetails.rst @@ -0,0 +1,11 @@ +UpdateStreamCdnConfigDetails +============================ + +.. currentmodule:: oci.media_services.models + +.. autoclass:: UpdateStreamCdnConfigDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/media_services/models/oci.media_services.models.UpdateStreamDistributionChannelDetails.rst b/docs/api/media_services/models/oci.media_services.models.UpdateStreamDistributionChannelDetails.rst new file mode 100644 index 0000000000..c4d689eff4 --- /dev/null +++ b/docs/api/media_services/models/oci.media_services.models.UpdateStreamDistributionChannelDetails.rst @@ -0,0 +1,11 @@ +UpdateStreamDistributionChannelDetails +====================================== + +.. currentmodule:: oci.media_services.models + +.. autoclass:: UpdateStreamDistributionChannelDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/media_services/models/oci.media_services.models.UpdateStreamPackagingConfigDetails.rst b/docs/api/media_services/models/oci.media_services.models.UpdateStreamPackagingConfigDetails.rst new file mode 100644 index 0000000000..83b48b239e --- /dev/null +++ b/docs/api/media_services/models/oci.media_services.models.UpdateStreamPackagingConfigDetails.rst @@ -0,0 +1,11 @@ +UpdateStreamPackagingConfigDetails +================================== + +.. currentmodule:: oci.media_services.models + +.. autoclass:: UpdateStreamPackagingConfigDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/opa.rst b/docs/api/opa.rst new file mode 100644 index 0000000000..a8c47613e2 --- /dev/null +++ b/docs/api/opa.rst @@ -0,0 +1,34 @@ +Opa +=== + +.. autosummary:: + :toctree: opa/client + :nosignatures: + :template: autosummary/service_client.rst + + oci.opa.OpaInstanceClient + oci.opa.OpaInstanceClientCompositeOperations + +-------- + Models +-------- + +.. autosummary:: + :toctree: opa/models + :nosignatures: + :template: autosummary/model_class.rst + + oci.opa.models.ChangeOpaInstanceCompartmentDetails + oci.opa.models.CreateOpaInstanceDetails + oci.opa.models.OpaInstance + oci.opa.models.OpaInstanceCollection + oci.opa.models.OpaInstanceSummary + oci.opa.models.UpdateOpaInstanceDetails + oci.opa.models.WorkRequest + oci.opa.models.WorkRequestError + oci.opa.models.WorkRequestErrorCollection + oci.opa.models.WorkRequestLogEntry + oci.opa.models.WorkRequestLogEntryCollection + oci.opa.models.WorkRequestResource + oci.opa.models.WorkRequestSummary + oci.opa.models.WorkRequestSummaryCollection diff --git a/docs/api/opa/client/oci.opa.OpaInstanceClient.rst b/docs/api/opa/client/oci.opa.OpaInstanceClient.rst new file mode 100644 index 0000000000..e99792c76d --- /dev/null +++ b/docs/api/opa/client/oci.opa.OpaInstanceClient.rst @@ -0,0 +1,8 @@ +OpaInstanceClient +================= + +.. currentmodule:: oci.opa + +.. autoclass:: OpaInstanceClient + :special-members: __init__ + :members: \ No newline at end of file diff --git a/docs/api/opa/client/oci.opa.OpaInstanceClientCompositeOperations.rst b/docs/api/opa/client/oci.opa.OpaInstanceClientCompositeOperations.rst new file mode 100644 index 0000000000..92c87c97fd --- /dev/null +++ b/docs/api/opa/client/oci.opa.OpaInstanceClientCompositeOperations.rst @@ -0,0 +1,8 @@ +OpaInstanceClientCompositeOperations +==================================== + +.. currentmodule:: oci.opa + +.. autoclass:: OpaInstanceClientCompositeOperations + :special-members: __init__ + :members: \ No newline at end of file diff --git a/docs/api/opa/models/oci.opa.models.ChangeOpaInstanceCompartmentDetails.rst b/docs/api/opa/models/oci.opa.models.ChangeOpaInstanceCompartmentDetails.rst new file mode 100644 index 0000000000..4b287c3d4d --- /dev/null +++ b/docs/api/opa/models/oci.opa.models.ChangeOpaInstanceCompartmentDetails.rst @@ -0,0 +1,11 @@ +ChangeOpaInstanceCompartmentDetails +=================================== + +.. currentmodule:: oci.opa.models + +.. autoclass:: ChangeOpaInstanceCompartmentDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/opa/models/oci.opa.models.CreateOpaInstanceDetails.rst b/docs/api/opa/models/oci.opa.models.CreateOpaInstanceDetails.rst new file mode 100644 index 0000000000..82357120d4 --- /dev/null +++ b/docs/api/opa/models/oci.opa.models.CreateOpaInstanceDetails.rst @@ -0,0 +1,11 @@ +CreateOpaInstanceDetails +======================== + +.. currentmodule:: oci.opa.models + +.. autoclass:: CreateOpaInstanceDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/opa/models/oci.opa.models.OpaInstance.rst b/docs/api/opa/models/oci.opa.models.OpaInstance.rst new file mode 100644 index 0000000000..b116500d7a --- /dev/null +++ b/docs/api/opa/models/oci.opa.models.OpaInstance.rst @@ -0,0 +1,11 @@ +OpaInstance +=========== + +.. currentmodule:: oci.opa.models + +.. autoclass:: OpaInstance + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/opa/models/oci.opa.models.OpaInstanceCollection.rst b/docs/api/opa/models/oci.opa.models.OpaInstanceCollection.rst new file mode 100644 index 0000000000..0ff4a759fe --- /dev/null +++ b/docs/api/opa/models/oci.opa.models.OpaInstanceCollection.rst @@ -0,0 +1,11 @@ +OpaInstanceCollection +===================== + +.. currentmodule:: oci.opa.models + +.. autoclass:: OpaInstanceCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/opa/models/oci.opa.models.OpaInstanceSummary.rst b/docs/api/opa/models/oci.opa.models.OpaInstanceSummary.rst new file mode 100644 index 0000000000..c0b444bbf6 --- /dev/null +++ b/docs/api/opa/models/oci.opa.models.OpaInstanceSummary.rst @@ -0,0 +1,11 @@ +OpaInstanceSummary +================== + +.. currentmodule:: oci.opa.models + +.. autoclass:: OpaInstanceSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/opa/models/oci.opa.models.UpdateOpaInstanceDetails.rst b/docs/api/opa/models/oci.opa.models.UpdateOpaInstanceDetails.rst new file mode 100644 index 0000000000..67004be79d --- /dev/null +++ b/docs/api/opa/models/oci.opa.models.UpdateOpaInstanceDetails.rst @@ -0,0 +1,11 @@ +UpdateOpaInstanceDetails +======================== + +.. currentmodule:: oci.opa.models + +.. autoclass:: UpdateOpaInstanceDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/opa/models/oci.opa.models.WorkRequest.rst b/docs/api/opa/models/oci.opa.models.WorkRequest.rst new file mode 100644 index 0000000000..a3d8e9bb74 --- /dev/null +++ b/docs/api/opa/models/oci.opa.models.WorkRequest.rst @@ -0,0 +1,11 @@ +WorkRequest +=========== + +.. currentmodule:: oci.opa.models + +.. autoclass:: WorkRequest + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/opa/models/oci.opa.models.WorkRequestError.rst b/docs/api/opa/models/oci.opa.models.WorkRequestError.rst new file mode 100644 index 0000000000..01ad7d6267 --- /dev/null +++ b/docs/api/opa/models/oci.opa.models.WorkRequestError.rst @@ -0,0 +1,11 @@ +WorkRequestError +================ + +.. currentmodule:: oci.opa.models + +.. autoclass:: WorkRequestError + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/opa/models/oci.opa.models.WorkRequestErrorCollection.rst b/docs/api/opa/models/oci.opa.models.WorkRequestErrorCollection.rst new file mode 100644 index 0000000000..361caab161 --- /dev/null +++ b/docs/api/opa/models/oci.opa.models.WorkRequestErrorCollection.rst @@ -0,0 +1,11 @@ +WorkRequestErrorCollection +========================== + +.. currentmodule:: oci.opa.models + +.. autoclass:: WorkRequestErrorCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/opa/models/oci.opa.models.WorkRequestLogEntry.rst b/docs/api/opa/models/oci.opa.models.WorkRequestLogEntry.rst new file mode 100644 index 0000000000..baedc862ea --- /dev/null +++ b/docs/api/opa/models/oci.opa.models.WorkRequestLogEntry.rst @@ -0,0 +1,11 @@ +WorkRequestLogEntry +=================== + +.. currentmodule:: oci.opa.models + +.. autoclass:: WorkRequestLogEntry + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/opa/models/oci.opa.models.WorkRequestLogEntryCollection.rst b/docs/api/opa/models/oci.opa.models.WorkRequestLogEntryCollection.rst new file mode 100644 index 0000000000..fc4224ceec --- /dev/null +++ b/docs/api/opa/models/oci.opa.models.WorkRequestLogEntryCollection.rst @@ -0,0 +1,11 @@ +WorkRequestLogEntryCollection +============================= + +.. currentmodule:: oci.opa.models + +.. autoclass:: WorkRequestLogEntryCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/opa/models/oci.opa.models.WorkRequestResource.rst b/docs/api/opa/models/oci.opa.models.WorkRequestResource.rst new file mode 100644 index 0000000000..663180a722 --- /dev/null +++ b/docs/api/opa/models/oci.opa.models.WorkRequestResource.rst @@ -0,0 +1,11 @@ +WorkRequestResource +=================== + +.. currentmodule:: oci.opa.models + +.. autoclass:: WorkRequestResource + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/opa/models/oci.opa.models.WorkRequestSummary.rst b/docs/api/opa/models/oci.opa.models.WorkRequestSummary.rst new file mode 100644 index 0000000000..9d86eb7df2 --- /dev/null +++ b/docs/api/opa/models/oci.opa.models.WorkRequestSummary.rst @@ -0,0 +1,11 @@ +WorkRequestSummary +================== + +.. currentmodule:: oci.opa.models + +.. autoclass:: WorkRequestSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/opa/models/oci.opa.models.WorkRequestSummaryCollection.rst b/docs/api/opa/models/oci.opa.models.WorkRequestSummaryCollection.rst new file mode 100644 index 0000000000..cad8c00acd --- /dev/null +++ b/docs/api/opa/models/oci.opa.models.WorkRequestSummaryCollection.rst @@ -0,0 +1,11 @@ +WorkRequestSummaryCollection +============================ + +.. currentmodule:: oci.opa.models + +.. autoclass:: WorkRequestSummaryCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/requirements.txt b/requirements.txt index dd358cfc9f..8d11053267 100644 --- a/requirements.txt +++ b/requirements.txt @@ -2,10 +2,10 @@ autodocsumm==0.1.11 certifi configparser==4.0.2; python_version < '3' coverage==4.5.2 -cryptography>=3.2.1,<=3.4.7 +cryptography>=3.2.1,<=37.0.2 flake8>=3.6.0 mock==2.0.0 -pyOpenSSL==19.1.0 +pyOpenSSL>=17.5.0,<=22.0.0 pytest==4.1.0 pytest-cov==2.6.1 attrs==19.1.0 diff --git a/setup.py b/setup.py index d056fa7bb3..ca11184d6d 100644 --- a/setup.py +++ b/setup.py @@ -32,8 +32,8 @@ def open_relative(*path): requires = [ "certifi", "configparser==4.0.2 ; python_version < '3'", - "cryptography>=3.2.1,<=3.4.7", - "pyOpenSSL>=17.5.0,<=19.1.0", + "cryptography>=3.2.1,<=37.0.2", + "pyOpenSSL>=17.5.0,<=22.0.0", "python-dateutil>=2.5.3,<3.0.0", "pytz>=2016.10", "circuitbreaker>=1.3.1,< 2.0.0" diff --git a/src/oci/__init__.py b/src/oci/__init__.py index d009cfd8a8..9297d03a76 100644 --- a/src/oci/__init__.py +++ b/src/oci/__init__.py @@ -16,9 +16,9 @@ if os.getenv("OCI_PYTHON_SDK_NO_SERVICE_IMPORTS", "").lower() in ["true", "1"]: pass else: - from . import adm, ai_anomaly_detection, ai_language, ai_speech, ai_vision, analytics, announcements_service, apigateway, apm_config, apm_control_plane, apm_synthetics, apm_traces, application_migration, appmgmt_control, artifacts, audit, autoscaling, bastion, bds, blockchain, budget, certificates, certificates_management, cims, cloud_guard, compute_instance_agent, container_engine, core, dashboard_service, data_catalog, data_connectivity, data_flow, data_integration, data_labeling_service, data_labeling_service_dataplane, data_safe, data_science, database, database_management, database_migration, database_tools, devops, dns, dts, em_warehouse, email, events, file_storage, functions, generic_artifacts_content, golden_gate, governance_rules_control_plane, healthchecks, identity, identity_data_plane, integration, jms, key_management, license_manager, limits, load_balancer, log_analytics, logging, loggingingestion, loggingsearch, management_agent, management_dashboard, marketplace, monitoring, mysql, network_firewall, network_load_balancer, nosql, object_storage, oce, ocvp, oda, onesubscription, ons, operator_access_control, opsi, optimizer, os_management, osp_gateway, osub_billing_schedule, osub_organization_subscription, osub_subscription, osub_usage, resource_manager, resource_search, rover, sch, secrets, service_catalog, service_manager_proxy, service_mesh, stack_monitoring, streaming, tenant_manager_control_plane, threat_intelligence, usage, usage_api, vault, visual_builder, vn_monitoring, vulnerability_scanning, waa, waas, waf, work_requests + from . import adm, ai_anomaly_detection, ai_language, ai_speech, ai_vision, analytics, announcements_service, apigateway, apm_config, apm_control_plane, apm_synthetics, apm_traces, application_migration, appmgmt_control, artifacts, audit, autoscaling, bastion, bds, blockchain, budget, certificates, certificates_management, cims, cloud_guard, compute_instance_agent, container_engine, core, dashboard_service, data_catalog, data_connectivity, data_flow, data_integration, data_labeling_service, data_labeling_service_dataplane, data_safe, data_science, database, database_management, database_migration, database_tools, devops, dns, dts, em_warehouse, email, events, file_storage, functions, fusion_apps, generic_artifacts_content, golden_gate, governance_rules_control_plane, healthchecks, identity, identity_data_plane, integration, jms, key_management, license_manager, limits, load_balancer, lockbox, log_analytics, logging, loggingingestion, loggingsearch, management_agent, management_dashboard, marketplace, media_services, monitoring, mysql, network_firewall, network_load_balancer, nosql, object_storage, oce, ocvp, oda, onesubscription, ons, opa, operator_access_control, opsi, optimizer, os_management, osp_gateway, osub_billing_schedule, osub_organization_subscription, osub_subscription, osub_usage, resource_manager, resource_search, rover, sch, secrets, service_catalog, service_manager_proxy, service_mesh, stack_monitoring, streaming, tenant_manager_control_plane, threat_intelligence, usage, usage_api, vault, visual_builder, vn_monitoring, vulnerability_scanning, waa, waas, waf, work_requests __all__ = [ "BaseClient", "Error", "Request", "Response", "Signer", "config", "constants", "decorators", "exceptions", "regions", "wait_until", "pagination", "auth", "retry", "fips", "circuit_breaker", - "adm", "ai_anomaly_detection", "ai_language", "ai_speech", "ai_vision", "analytics", "announcements_service", "apigateway", "apm_config", "apm_control_plane", "apm_synthetics", "apm_traces", "application_migration", "appmgmt_control", "artifacts", "audit", "autoscaling", "bastion", "bds", "blockchain", "budget", "certificates", "certificates_management", "cims", "cloud_guard", "compute_instance_agent", "container_engine", "core", "dashboard_service", "data_catalog", "data_connectivity", "data_flow", "data_integration", "data_labeling_service", "data_labeling_service_dataplane", "data_safe", "data_science", "database", "database_management", "database_migration", "database_tools", "devops", "dns", "dts", "em_warehouse", "email", "events", "file_storage", "functions", "generic_artifacts_content", "golden_gate", "governance_rules_control_plane", "healthchecks", "identity", "identity_data_plane", "integration", "jms", "key_management", "license_manager", "limits", "load_balancer", "log_analytics", "logging", "loggingingestion", "loggingsearch", "management_agent", "management_dashboard", "marketplace", "monitoring", "mysql", "network_firewall", "network_load_balancer", "nosql", "object_storage", "oce", "ocvp", "oda", "onesubscription", "ons", "operator_access_control", "opsi", "optimizer", "os_management", "osp_gateway", "osub_billing_schedule", "osub_organization_subscription", "osub_subscription", "osub_usage", "resource_manager", "resource_search", "rover", "sch", "secrets", "service_catalog", "service_manager_proxy", "service_mesh", "stack_monitoring", "streaming", "tenant_manager_control_plane", "threat_intelligence", "usage", "usage_api", "vault", "visual_builder", "vn_monitoring", "vulnerability_scanning", "waa", "waas", "waf", "work_requests" + "adm", "ai_anomaly_detection", "ai_language", "ai_speech", "ai_vision", "analytics", "announcements_service", "apigateway", "apm_config", "apm_control_plane", "apm_synthetics", "apm_traces", "application_migration", "appmgmt_control", "artifacts", "audit", "autoscaling", "bastion", "bds", "blockchain", "budget", "certificates", "certificates_management", "cims", "cloud_guard", "compute_instance_agent", "container_engine", "core", "dashboard_service", "data_catalog", "data_connectivity", "data_flow", "data_integration", "data_labeling_service", "data_labeling_service_dataplane", "data_safe", "data_science", "database", "database_management", "database_migration", "database_tools", "devops", "dns", "dts", "em_warehouse", "email", "events", "file_storage", "functions", "fusion_apps", "generic_artifacts_content", "golden_gate", "governance_rules_control_plane", "healthchecks", "identity", "identity_data_plane", "integration", "jms", "key_management", "license_manager", "limits", "load_balancer", "lockbox", "log_analytics", "logging", "loggingingestion", "loggingsearch", "management_agent", "management_dashboard", "marketplace", "media_services", "monitoring", "mysql", "network_firewall", "network_load_balancer", "nosql", "object_storage", "oce", "ocvp", "oda", "onesubscription", "ons", "opa", "operator_access_control", "opsi", "optimizer", "os_management", "osp_gateway", "osub_billing_schedule", "osub_organization_subscription", "osub_subscription", "osub_usage", "resource_manager", "resource_search", "rover", "sch", "secrets", "service_catalog", "service_manager_proxy", "service_mesh", "stack_monitoring", "streaming", "tenant_manager_control_plane", "threat_intelligence", "usage", "usage_api", "vault", "visual_builder", "vn_monitoring", "vulnerability_scanning", "waa", "waas", "waf", "work_requests" ] diff --git a/src/oci/core/compute_client.py b/src/oci/core/compute_client.py index b124d035d5..42019ed630 100644 --- a/src/oci/core/compute_client.py +++ b/src/oci/core/compute_client.py @@ -4245,6 +4245,101 @@ def get_instance_console_connection(self, instance_console_connection_id, **kwar operation_name=operation_name, api_reference_link=api_reference_link) + def get_instance_maintenance_reboot(self, instance_id, **kwargs): + """ + Gets the maximum possible date that a maintenance reboot can be extended. + + + :param str instance_id: (required) + The `OCID`__ of the instance. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + :param str opc_request_id: (optional) + Unique identifier for the request. + If you need to contact Oracle about a particular request, please provide the request ID. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.InstanceMaintenanceReboot` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_instance_maintenance_reboot API. + """ + resource_path = "/instances/{instanceId}/maintenanceReboot" + method = "GET" + operation_name = "get_instance_maintenance_reboot" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/iaas/20160918/InstanceMaintenanceReboot/GetInstanceMaintenanceReboot" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "get_instance_maintenance_reboot got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "instanceId": instance_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="InstanceMaintenanceReboot", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="InstanceMaintenanceReboot", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + def get_measured_boot_report(self, instance_id, **kwargs): """ Gets the measured boot report for this shielded instance. diff --git a/src/oci/core/models/__init__.py b/src/oci/core/models/__init__.py index 7eabb48e31..43fae7c9a7 100644 --- a/src/oci/core/models/__init__.py +++ b/src/oci/core/models/__init__.py @@ -297,6 +297,7 @@ from .instance_configuration_volume_source_from_volume_details import InstanceConfigurationVolumeSourceFromVolumeDetails from .instance_console_connection import InstanceConsoleConnection from .instance_credentials import InstanceCredentials +from .instance_maintenance_reboot import InstanceMaintenanceReboot from .instance_options import InstanceOptions from .instance_pool import InstancePool from .instance_pool_instance import InstancePoolInstance @@ -813,6 +814,7 @@ "InstanceConfigurationVolumeSourceFromVolumeDetails": InstanceConfigurationVolumeSourceFromVolumeDetails, "InstanceConsoleConnection": InstanceConsoleConnection, "InstanceCredentials": InstanceCredentials, + "InstanceMaintenanceReboot": InstanceMaintenanceReboot, "InstanceOptions": InstanceOptions, "InstancePool": InstancePool, "InstancePoolInstance": InstancePoolInstance, diff --git a/src/oci/core/models/create_internet_gateway_details.py b/src/oci/core/models/create_internet_gateway_details.py index d124a91dff..a0a914bfdb 100644 --- a/src/oci/core/models/create_internet_gateway_details.py +++ b/src/oci/core/models/create_internet_gateway_details.py @@ -42,6 +42,10 @@ def __init__(self, **kwargs): The value to assign to the vcn_id property of this CreateInternetGatewayDetails. :type vcn_id: str + :param route_table_id: + The value to assign to the route_table_id property of this CreateInternetGatewayDetails. + :type route_table_id: str + """ self.swagger_types = { 'compartment_id': 'str', @@ -49,7 +53,8 @@ def __init__(self, **kwargs): 'display_name': 'str', 'freeform_tags': 'dict(str, str)', 'is_enabled': 'bool', - 'vcn_id': 'str' + 'vcn_id': 'str', + 'route_table_id': 'str' } self.attribute_map = { @@ -58,7 +63,8 @@ def __init__(self, **kwargs): 'display_name': 'displayName', 'freeform_tags': 'freeformTags', 'is_enabled': 'isEnabled', - 'vcn_id': 'vcnId' + 'vcn_id': 'vcnId', + 'route_table_id': 'routeTableId' } self._compartment_id = None @@ -67,6 +73,7 @@ def __init__(self, **kwargs): self._freeform_tags = None self._is_enabled = None self._vcn_id = None + self._route_table_id = None @property def compartment_id(self): @@ -242,6 +249,34 @@ def vcn_id(self, vcn_id): """ self._vcn_id = vcn_id + @property + def route_table_id(self): + """ + Gets the route_table_id of this CreateInternetGatewayDetails. + The `OCID`__ of the route table the Internet Gateway is using. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :return: The route_table_id of this CreateInternetGatewayDetails. + :rtype: str + """ + return self._route_table_id + + @route_table_id.setter + def route_table_id(self, route_table_id): + """ + Sets the route_table_id of this CreateInternetGatewayDetails. + The `OCID`__ of the route table the Internet Gateway is using. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :param route_table_id: The route_table_id of this CreateInternetGatewayDetails. + :type: str + """ + self._route_table_id = route_table_id + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/core/models/create_nat_gateway_details.py b/src/oci/core/models/create_nat_gateway_details.py index e60177e5bc..c7876fac56 100644 --- a/src/oci/core/models/create_nat_gateway_details.py +++ b/src/oci/core/models/create_nat_gateway_details.py @@ -46,6 +46,10 @@ def __init__(self, **kwargs): The value to assign to the public_ip_id property of this CreateNatGatewayDetails. :type public_ip_id: str + :param route_table_id: + The value to assign to the route_table_id property of this CreateNatGatewayDetails. + :type route_table_id: str + """ self.swagger_types = { 'compartment_id': 'str', @@ -54,7 +58,8 @@ def __init__(self, **kwargs): 'freeform_tags': 'dict(str, str)', 'block_traffic': 'bool', 'vcn_id': 'str', - 'public_ip_id': 'str' + 'public_ip_id': 'str', + 'route_table_id': 'str' } self.attribute_map = { @@ -64,7 +69,8 @@ def __init__(self, **kwargs): 'freeform_tags': 'freeformTags', 'block_traffic': 'blockTraffic', 'vcn_id': 'vcnId', - 'public_ip_id': 'publicIpId' + 'public_ip_id': 'publicIpId', + 'route_table_id': 'routeTableId' } self._compartment_id = None @@ -74,6 +80,7 @@ def __init__(self, **kwargs): self._block_traffic = None self._vcn_id = None self._public_ip_id = None + self._route_table_id = None @property def compartment_id(self): @@ -283,6 +290,42 @@ def public_ip_id(self, public_ip_id): """ self._public_ip_id = public_ip_id + @property + def route_table_id(self): + """ + Gets the route_table_id of this CreateNatGatewayDetails. + The `OCID`__ of the route table used by the NAT gateway. + + If you don't specify a route table here, the NAT gateway is created without an associated route + table. The Networking service does NOT automatically associate the attached VCN's default route table + with the NAT gateway. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :return: The route_table_id of this CreateNatGatewayDetails. + :rtype: str + """ + return self._route_table_id + + @route_table_id.setter + def route_table_id(self, route_table_id): + """ + Sets the route_table_id of this CreateNatGatewayDetails. + The `OCID`__ of the route table used by the NAT gateway. + + If you don't specify a route table here, the NAT gateway is created without an associated route + table. The Networking service does NOT automatically associate the attached VCN's default route table + with the NAT gateway. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :param route_table_id: The route_table_id of this CreateNatGatewayDetails. + :type: str + """ + self._route_table_id = route_table_id + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/core/models/instance_maintenance_reboot.py b/src/oci/core/models/instance_maintenance_reboot.py new file mode 100644 index 0000000000..badb12131f --- /dev/null +++ b/src/oci/core/models/instance_maintenance_reboot.py @@ -0,0 +1,80 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 InstanceMaintenanceReboot(object): + """ + The maximum possible date and time that a maintenance reboot can be extended. + """ + + def __init__(self, **kwargs): + """ + Initializes a new InstanceMaintenanceReboot object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param time_maintenance_reboot_due_max: + The value to assign to the time_maintenance_reboot_due_max property of this InstanceMaintenanceReboot. + :type time_maintenance_reboot_due_max: datetime + + """ + self.swagger_types = { + 'time_maintenance_reboot_due_max': 'datetime' + } + + self.attribute_map = { + 'time_maintenance_reboot_due_max': 'timeMaintenanceRebootDueMax' + } + + self._time_maintenance_reboot_due_max = None + + @property + def time_maintenance_reboot_due_max(self): + """ + **[Required]** Gets the time_maintenance_reboot_due_max of this InstanceMaintenanceReboot. + The maximum extension date and time for the maintenance reboot, in the format defined by + `RFC3339`__. + The range for the maintenance extension is between 1 and 14 days from the initial scheduled maintenance date. + Example: `2018-05-25T21:10:29.600Z` + + __ https://tools.ietf.org/html/rfc3339 + + + :return: The time_maintenance_reboot_due_max of this InstanceMaintenanceReboot. + :rtype: datetime + """ + return self._time_maintenance_reboot_due_max + + @time_maintenance_reboot_due_max.setter + def time_maintenance_reboot_due_max(self, time_maintenance_reboot_due_max): + """ + Sets the time_maintenance_reboot_due_max of this InstanceMaintenanceReboot. + The maximum extension date and time for the maintenance reboot, in the format defined by + `RFC3339`__. + The range for the maintenance extension is between 1 and 14 days from the initial scheduled maintenance date. + Example: `2018-05-25T21:10:29.600Z` + + __ https://tools.ietf.org/html/rfc3339 + + + :param time_maintenance_reboot_due_max: The time_maintenance_reboot_due_max of this InstanceMaintenanceReboot. + :type: datetime + """ + self._time_maintenance_reboot_due_max = time_maintenance_reboot_due_max + + 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/core/models/internet_gateway.py b/src/oci/core/models/internet_gateway.py index e9e8febe0d..700789df71 100644 --- a/src/oci/core/models/internet_gateway.py +++ b/src/oci/core/models/internet_gateway.py @@ -81,6 +81,10 @@ def __init__(self, **kwargs): The value to assign to the vcn_id property of this InternetGateway. :type vcn_id: str + :param route_table_id: + The value to assign to the route_table_id property of this InternetGateway. + :type route_table_id: str + """ self.swagger_types = { 'compartment_id': 'str', @@ -91,7 +95,8 @@ def __init__(self, **kwargs): 'is_enabled': 'bool', 'lifecycle_state': 'str', 'time_created': 'datetime', - 'vcn_id': 'str' + 'vcn_id': 'str', + 'route_table_id': 'str' } self.attribute_map = { @@ -103,7 +108,8 @@ def __init__(self, **kwargs): 'is_enabled': 'isEnabled', 'lifecycle_state': 'lifecycleState', 'time_created': 'timeCreated', - 'vcn_id': 'vcnId' + 'vcn_id': 'vcnId', + 'route_table_id': 'routeTableId' } self._compartment_id = None @@ -115,6 +121,7 @@ def __init__(self, **kwargs): self._lifecycle_state = None self._time_created = None self._vcn_id = None + self._route_table_id = None @property def compartment_id(self): @@ -382,6 +389,34 @@ def vcn_id(self, vcn_id): """ self._vcn_id = vcn_id + @property + def route_table_id(self): + """ + Gets the route_table_id of this InternetGateway. + The `OCID`__ of the route table the Internet Gateway is using. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :return: The route_table_id of this InternetGateway. + :rtype: str + """ + return self._route_table_id + + @route_table_id.setter + def route_table_id(self, route_table_id): + """ + Sets the route_table_id of this InternetGateway. + The `OCID`__ of the route table the Internet Gateway is using. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :param route_table_id: The route_table_id of this InternetGateway. + :type: str + """ + self._route_table_id = route_table_id + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/core/models/nat_gateway.py b/src/oci/core/models/nat_gateway.py index 6a7a22e0f0..556c92a0b3 100644 --- a/src/oci/core/models/nat_gateway.py +++ b/src/oci/core/models/nat_gateway.py @@ -92,6 +92,10 @@ def __init__(self, **kwargs): The value to assign to the public_ip_id property of this NatGateway. :type public_ip_id: str + :param route_table_id: + The value to assign to the route_table_id property of this NatGateway. + :type route_table_id: str + """ self.swagger_types = { 'compartment_id': 'str', @@ -104,7 +108,8 @@ def __init__(self, **kwargs): 'nat_ip': 'str', 'time_created': 'datetime', 'vcn_id': 'str', - 'public_ip_id': 'str' + 'public_ip_id': 'str', + 'route_table_id': 'str' } self.attribute_map = { @@ -118,7 +123,8 @@ def __init__(self, **kwargs): 'nat_ip': 'natIp', 'time_created': 'timeCreated', 'vcn_id': 'vcnId', - 'public_ip_id': 'publicIpId' + 'public_ip_id': 'publicIpId', + 'route_table_id': 'routeTableId' } self._compartment_id = None @@ -132,6 +138,7 @@ def __init__(self, **kwargs): self._time_created = None self._vcn_id = None self._public_ip_id = None + self._route_table_id = None @property def compartment_id(self): @@ -459,6 +466,42 @@ def public_ip_id(self, public_ip_id): """ self._public_ip_id = public_ip_id + @property + def route_table_id(self): + """ + Gets the route_table_id of this NatGateway. + The `OCID`__ of the route table used by the NAT gateway. + + If you don't specify a route table here, the NAT gateway is created without an associated route + table. The Networking service does NOT automatically associate the attached VCN's default route table + with the NAT gateway. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :return: The route_table_id of this NatGateway. + :rtype: str + """ + return self._route_table_id + + @route_table_id.setter + def route_table_id(self, route_table_id): + """ + Sets the route_table_id of this NatGateway. + The `OCID`__ of the route table used by the NAT gateway. + + If you don't specify a route table here, the NAT gateway is created without an associated route + table. The Networking service does NOT automatically associate the attached VCN's default route table + with the NAT gateway. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :param route_table_id: The route_table_id of this NatGateway. + :type: str + """ + self._route_table_id = route_table_id + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/core/models/route_rule.py b/src/oci/core/models/route_rule.py index 8810e07cfc..e3c0734f31 100644 --- a/src/oci/core/models/route_rule.py +++ b/src/oci/core/models/route_rule.py @@ -22,6 +22,14 @@ class RouteRule(object): #: This constant has a value of "SERVICE_CIDR_BLOCK" DESTINATION_TYPE_SERVICE_CIDR_BLOCK = "SERVICE_CIDR_BLOCK" + #: A constant which can be used with the route_type property of a RouteRule. + #: This constant has a value of "STATIC" + ROUTE_TYPE_STATIC = "STATIC" + + #: A constant which can be used with the route_type property of a RouteRule. + #: This constant has a value of "LOCAL" + ROUTE_TYPE_LOCAL = "LOCAL" + def __init__(self, **kwargs): """ Initializes a new RouteRule object with values from keyword arguments. @@ -49,13 +57,20 @@ def __init__(self, **kwargs): The value to assign to the description property of this RouteRule. :type description: str + :param route_type: + The value to assign to the route_type property of this RouteRule. + Allowed values for this property are: "STATIC", "LOCAL", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type route_type: str + """ self.swagger_types = { 'cidr_block': 'str', 'destination': 'str', 'destination_type': 'str', 'network_entity_id': 'str', - 'description': 'str' + 'description': 'str', + 'route_type': 'str' } self.attribute_map = { @@ -63,7 +78,8 @@ def __init__(self, **kwargs): 'destination': 'destination', 'destination_type': 'destinationType', 'network_entity_id': 'networkEntityId', - 'description': 'description' + 'description': 'description', + 'route_type': 'routeType' } self._cidr_block = None @@ -71,6 +87,7 @@ def __init__(self, **kwargs): self._destination_type = None self._network_entity_id = None self._description = None + self._route_type = None @property def cidr_block(self): @@ -266,6 +283,36 @@ def description(self, description): """ self._description = description + @property + def route_type(self): + """ + Gets the route_type of this RouteRule. + A route rule can be STATIC if manually added to the route table, LOCAL if added by OCI to the route table. + + Allowed values for this property are: "STATIC", "LOCAL", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The route_type of this RouteRule. + :rtype: str + """ + return self._route_type + + @route_type.setter + def route_type(self, route_type): + """ + Sets the route_type of this RouteRule. + A route rule can be STATIC if manually added to the route table, LOCAL if added by OCI to the route table. + + + :param route_type: The route_type of this RouteRule. + :type: str + """ + allowed_values = ["STATIC", "LOCAL"] + if not value_allowed_none_or_none_sentinel(route_type, allowed_values): + route_type = 'UNKNOWN_ENUM_VALUE' + self._route_type = route_type + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/core/models/update_instance_details.py b/src/oci/core/models/update_instance_details.py index ebc205bb94..290b0419f9 100644 --- a/src/oci/core/models/update_instance_details.py +++ b/src/oci/core/models/update_instance_details.py @@ -70,6 +70,10 @@ def __init__(self, **kwargs): The value to assign to the availability_config property of this UpdateInstanceDetails. :type availability_config: oci.core.models.UpdateInstanceAvailabilityConfigDetails + :param time_maintenance_reboot_due: + The value to assign to the time_maintenance_reboot_due property of this UpdateInstanceDetails. + :type time_maintenance_reboot_due: datetime + """ self.swagger_types = { 'capacity_reservation_id': 'str', @@ -84,7 +88,8 @@ def __init__(self, **kwargs): 'instance_options': 'InstanceOptions', 'fault_domain': 'str', 'launch_options': 'UpdateLaunchOptions', - 'availability_config': 'UpdateInstanceAvailabilityConfigDetails' + 'availability_config': 'UpdateInstanceAvailabilityConfigDetails', + 'time_maintenance_reboot_due': 'datetime' } self.attribute_map = { @@ -100,7 +105,8 @@ def __init__(self, **kwargs): 'instance_options': 'instanceOptions', 'fault_domain': 'faultDomain', 'launch_options': 'launchOptions', - 'availability_config': 'availabilityConfig' + 'availability_config': 'availabilityConfig', + 'time_maintenance_reboot_due': 'timeMaintenanceRebootDue' } self._capacity_reservation_id = None @@ -116,6 +122,7 @@ def __init__(self, **kwargs): self._fault_domain = None self._launch_options = None self._availability_config = None + self._time_maintenance_reboot_due = None @property def capacity_reservation_id(self): @@ -537,6 +544,48 @@ def availability_config(self, availability_config): """ self._availability_config = availability_config + @property + def time_maintenance_reboot_due(self): + """ + Gets the time_maintenance_reboot_due of this UpdateInstanceDetails. + The date and time the instance is expected to be stopped and restarted, in the format defined by + `RFC3339`__. + If the instance hasn't been rebooted after this date, Oracle reboots the instance within 24 hours of the time + and date that maintenance is due. + Regardless of how the instance is stopped, this flag is reset to empty as soon as the instance reaches + Stopped state. + + Example: `2018-05-25T21:10:29.600Z` + + __ https://tools.ietf.org/html/rfc3339 + + + :return: The time_maintenance_reboot_due of this UpdateInstanceDetails. + :rtype: datetime + """ + return self._time_maintenance_reboot_due + + @time_maintenance_reboot_due.setter + def time_maintenance_reboot_due(self, time_maintenance_reboot_due): + """ + Sets the time_maintenance_reboot_due of this UpdateInstanceDetails. + The date and time the instance is expected to be stopped and restarted, in the format defined by + `RFC3339`__. + If the instance hasn't been rebooted after this date, Oracle reboots the instance within 24 hours of the time + and date that maintenance is due. + Regardless of how the instance is stopped, this flag is reset to empty as soon as the instance reaches + Stopped state. + + Example: `2018-05-25T21:10:29.600Z` + + __ https://tools.ietf.org/html/rfc3339 + + + :param time_maintenance_reboot_due: The time_maintenance_reboot_due of this UpdateInstanceDetails. + :type: datetime + """ + self._time_maintenance_reboot_due = time_maintenance_reboot_due + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/core/models/update_internet_gateway_details.py b/src/oci/core/models/update_internet_gateway_details.py index fb599d3a90..a2c7a8082f 100644 --- a/src/oci/core/models/update_internet_gateway_details.py +++ b/src/oci/core/models/update_internet_gateway_details.py @@ -34,25 +34,32 @@ def __init__(self, **kwargs): The value to assign to the is_enabled property of this UpdateInternetGatewayDetails. :type is_enabled: bool + :param route_table_id: + The value to assign to the route_table_id property of this UpdateInternetGatewayDetails. + :type route_table_id: str + """ self.swagger_types = { 'defined_tags': 'dict(str, dict(str, object))', 'display_name': 'str', 'freeform_tags': 'dict(str, str)', - 'is_enabled': 'bool' + 'is_enabled': 'bool', + 'route_table_id': 'str' } self.attribute_map = { 'defined_tags': 'definedTags', 'display_name': 'displayName', 'freeform_tags': 'freeformTags', - 'is_enabled': 'isEnabled' + 'is_enabled': 'isEnabled', + 'route_table_id': 'routeTableId' } self._defined_tags = None self._display_name = None self._freeform_tags = None self._is_enabled = None + self._route_table_id = None @property def defined_tags(self): @@ -172,6 +179,34 @@ def is_enabled(self, is_enabled): """ self._is_enabled = is_enabled + @property + def route_table_id(self): + """ + Gets the route_table_id of this UpdateInternetGatewayDetails. + The `OCID`__ of the route table the Internet Gateway is using. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :return: The route_table_id of this UpdateInternetGatewayDetails. + :rtype: str + """ + return self._route_table_id + + @route_table_id.setter + def route_table_id(self, route_table_id): + """ + Sets the route_table_id of this UpdateInternetGatewayDetails. + The `OCID`__ of the route table the Internet Gateway is using. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :param route_table_id: The route_table_id of this UpdateInternetGatewayDetails. + :type: str + """ + self._route_table_id = route_table_id + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/core/models/update_nat_gateway_details.py b/src/oci/core/models/update_nat_gateway_details.py index 57e5b7e600..5325a44334 100644 --- a/src/oci/core/models/update_nat_gateway_details.py +++ b/src/oci/core/models/update_nat_gateway_details.py @@ -34,25 +34,32 @@ def __init__(self, **kwargs): The value to assign to the block_traffic property of this UpdateNatGatewayDetails. :type block_traffic: bool + :param route_table_id: + The value to assign to the route_table_id property of this UpdateNatGatewayDetails. + :type route_table_id: str + """ self.swagger_types = { 'defined_tags': 'dict(str, dict(str, object))', 'display_name': 'str', 'freeform_tags': 'dict(str, str)', - 'block_traffic': 'bool' + 'block_traffic': 'bool', + 'route_table_id': 'str' } self.attribute_map = { 'defined_tags': 'definedTags', 'display_name': 'displayName', 'freeform_tags': 'freeformTags', - 'block_traffic': 'blockTraffic' + 'block_traffic': 'blockTraffic', + 'route_table_id': 'routeTableId' } self._defined_tags = None self._display_name = None self._freeform_tags = None self._block_traffic = None + self._route_table_id = None @property def defined_tags(self): @@ -176,6 +183,42 @@ def block_traffic(self, block_traffic): """ self._block_traffic = block_traffic + @property + def route_table_id(self): + """ + Gets the route_table_id of this UpdateNatGatewayDetails. + The `OCID`__ of the route table used by the NAT gateway. + + If you don't specify a route table here, the NAT gateway is created without an associated route + table. The Networking service does NOT automatically associate the attached VCN's default route + table with the NAT gateway. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :return: The route_table_id of this UpdateNatGatewayDetails. + :rtype: str + """ + return self._route_table_id + + @route_table_id.setter + def route_table_id(self, route_table_id): + """ + Sets the route_table_id of this UpdateNatGatewayDetails. + The `OCID`__ of the route table used by the NAT gateway. + + If you don't specify a route table here, the NAT gateway is created without an associated route + table. The Networking service does NOT automatically associate the attached VCN's default route + table with the NAT gateway. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :param route_table_id: The route_table_id of this UpdateNatGatewayDetails. + :type: str + """ + self._route_table_id = route_table_id + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/data_science/models/__init__.py b/src/oci/data_science/models/__init__.py index 575cb8445a..4c22f041bd 100644 --- a/src/oci/data_science/models/__init__.py +++ b/src/oci/data_science/models/__init__.py @@ -38,6 +38,7 @@ from .model_configuration_details import ModelConfigurationDetails from .model_deployment import ModelDeployment from .model_deployment_configuration_details import ModelDeploymentConfigurationDetails +from .model_deployment_instance_shape_config_details import ModelDeploymentInstanceShapeConfigDetails from .model_deployment_shape_summary import ModelDeploymentShapeSummary from .model_deployment_summary import ModelDeploymentSummary from .model_provenance import ModelProvenance @@ -106,6 +107,7 @@ "ModelConfigurationDetails": ModelConfigurationDetails, "ModelDeployment": ModelDeployment, "ModelDeploymentConfigurationDetails": ModelDeploymentConfigurationDetails, + "ModelDeploymentInstanceShapeConfigDetails": ModelDeploymentInstanceShapeConfigDetails, "ModelDeploymentShapeSummary": ModelDeploymentShapeSummary, "ModelDeploymentSummary": ModelDeploymentSummary, "ModelProvenance": ModelProvenance, diff --git a/src/oci/data_science/models/instance_configuration.py b/src/oci/data_science/models/instance_configuration.py index ee6e474548..35980316a6 100644 --- a/src/oci/data_science/models/instance_configuration.py +++ b/src/oci/data_science/models/instance_configuration.py @@ -22,16 +22,23 @@ def __init__(self, **kwargs): The value to assign to the instance_shape_name property of this InstanceConfiguration. :type instance_shape_name: str + :param model_deployment_instance_shape_config_details: + The value to assign to the model_deployment_instance_shape_config_details property of this InstanceConfiguration. + :type model_deployment_instance_shape_config_details: oci.data_science.models.ModelDeploymentInstanceShapeConfigDetails + """ self.swagger_types = { - 'instance_shape_name': 'str' + 'instance_shape_name': 'str', + 'model_deployment_instance_shape_config_details': 'ModelDeploymentInstanceShapeConfigDetails' } self.attribute_map = { - 'instance_shape_name': 'instanceShapeName' + 'instance_shape_name': 'instanceShapeName', + 'model_deployment_instance_shape_config_details': 'modelDeploymentInstanceShapeConfigDetails' } self._instance_shape_name = None + self._model_deployment_instance_shape_config_details = None @property def instance_shape_name(self): @@ -57,6 +64,26 @@ def instance_shape_name(self, instance_shape_name): """ self._instance_shape_name = instance_shape_name + @property + def model_deployment_instance_shape_config_details(self): + """ + Gets the model_deployment_instance_shape_config_details of this InstanceConfiguration. + + :return: The model_deployment_instance_shape_config_details of this InstanceConfiguration. + :rtype: oci.data_science.models.ModelDeploymentInstanceShapeConfigDetails + """ + return self._model_deployment_instance_shape_config_details + + @model_deployment_instance_shape_config_details.setter + def model_deployment_instance_shape_config_details(self, model_deployment_instance_shape_config_details): + """ + Sets the model_deployment_instance_shape_config_details of this InstanceConfiguration. + + :param model_deployment_instance_shape_config_details: The model_deployment_instance_shape_config_details of this InstanceConfiguration. + :type: oci.data_science.models.ModelDeploymentInstanceShapeConfigDetails + """ + self._model_deployment_instance_shape_config_details = model_deployment_instance_shape_config_details + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/data_science/models/model_deployment_instance_shape_config_details.py b/src/oci/data_science/models/model_deployment_instance_shape_config_details.py new file mode 100644 index 0000000000..a90553bb02 --- /dev/null +++ b/src/oci/data_science/models/model_deployment_instance_shape_config_details.py @@ -0,0 +1,101 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 ModelDeploymentInstanceShapeConfigDetails(object): + """ + Details for the model-deployment instance shape configuration. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ModelDeploymentInstanceShapeConfigDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param ocpus: + The value to assign to the ocpus property of this ModelDeploymentInstanceShapeConfigDetails. + :type ocpus: float + + :param memory_in_gbs: + The value to assign to the memory_in_gbs property of this ModelDeploymentInstanceShapeConfigDetails. + :type memory_in_gbs: float + + """ + self.swagger_types = { + 'ocpus': 'float', + 'memory_in_gbs': 'float' + } + + self.attribute_map = { + 'ocpus': 'ocpus', + 'memory_in_gbs': 'memoryInGBs' + } + + self._ocpus = None + self._memory_in_gbs = None + + @property + def ocpus(self): + """ + Gets the ocpus of this ModelDeploymentInstanceShapeConfigDetails. + A model-deployment instance of type VM.Standard.E3.Flex or VM.Standard.E4.Flex allows the ocpu count to be specified. + + + :return: The ocpus of this ModelDeploymentInstanceShapeConfigDetails. + :rtype: float + """ + return self._ocpus + + @ocpus.setter + def ocpus(self, ocpus): + """ + Sets the ocpus of this ModelDeploymentInstanceShapeConfigDetails. + A model-deployment instance of type VM.Standard.E3.Flex or VM.Standard.E4.Flex allows the ocpu count to be specified. + + + :param ocpus: The ocpus of this ModelDeploymentInstanceShapeConfigDetails. + :type: float + """ + self._ocpus = ocpus + + @property + def memory_in_gbs(self): + """ + Gets the memory_in_gbs of this ModelDeploymentInstanceShapeConfigDetails. + A model-deployment instance of type VM.Standard.E3.Flex or VM.Standard.E4.Flex allows memory to be specified. This specifies the size of the memory in GBs. + + + :return: The memory_in_gbs of this ModelDeploymentInstanceShapeConfigDetails. + :rtype: float + """ + return self._memory_in_gbs + + @memory_in_gbs.setter + def memory_in_gbs(self, memory_in_gbs): + """ + Sets the memory_in_gbs of this ModelDeploymentInstanceShapeConfigDetails. + A model-deployment instance of type VM.Standard.E3.Flex or VM.Standard.E4.Flex allows memory to be specified. This specifies the size of the memory in GBs. + + + :param memory_in_gbs: The memory_in_gbs of this ModelDeploymentInstanceShapeConfigDetails. + :type: float + """ + self._memory_in_gbs = memory_in_gbs + + 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_deployment_shape_summary.py b/src/oci/data_science/models/model_deployment_shape_summary.py index 73ef157983..10ade76efe 100644 --- a/src/oci/data_science/models/model_deployment_shape_summary.py +++ b/src/oci/data_science/models/model_deployment_shape_summary.py @@ -13,6 +13,14 @@ class ModelDeploymentShapeSummary(object): The compute shape used to launch a model deployment compute instance. """ + #: A constant which can be used with the shape_series property of a ModelDeploymentShapeSummary. + #: This constant has a value of "AMD_ROME" + SHAPE_SERIES_AMD_ROME = "AMD_ROME" + + #: A constant which can be used with the shape_series property of a ModelDeploymentShapeSummary. + #: This constant has a value of "INTEL_SKYLAKE" + SHAPE_SERIES_INTEL_SKYLAKE = "INTEL_SKYLAKE" + def __init__(self, **kwargs): """ Initializes a new ModelDeploymentShapeSummary object with values from keyword arguments. @@ -30,22 +38,31 @@ def __init__(self, **kwargs): The value to assign to the memory_in_gbs property of this ModelDeploymentShapeSummary. :type memory_in_gbs: int + :param shape_series: + The value to assign to the shape_series property of this ModelDeploymentShapeSummary. + Allowed values for this property are: "AMD_ROME", "INTEL_SKYLAKE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type shape_series: str + """ self.swagger_types = { 'name': 'str', 'core_count': 'int', - 'memory_in_gbs': 'int' + 'memory_in_gbs': 'int', + 'shape_series': 'str' } self.attribute_map = { 'name': 'name', 'core_count': 'coreCount', - 'memory_in_gbs': 'memoryInGBs' + 'memory_in_gbs': 'memoryInGBs', + 'shape_series': 'shapeSeries' } self._name = None self._core_count = None self._memory_in_gbs = None + self._shape_series = None @property def name(self): @@ -119,6 +136,36 @@ def memory_in_gbs(self, memory_in_gbs): """ self._memory_in_gbs = memory_in_gbs + @property + def shape_series(self): + """ + **[Required]** Gets the shape_series of this ModelDeploymentShapeSummary. + The family that the compute shape belongs to. + + Allowed values for this property are: "AMD_ROME", "INTEL_SKYLAKE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The shape_series of this ModelDeploymentShapeSummary. + :rtype: str + """ + return self._shape_series + + @shape_series.setter + def shape_series(self, shape_series): + """ + Sets the shape_series of this ModelDeploymentShapeSummary. + The family that the compute shape belongs to. + + + :param shape_series: The shape_series of this ModelDeploymentShapeSummary. + :type: str + """ + allowed_values = ["AMD_ROME", "INTEL_SKYLAKE"] + if not value_allowed_none_or_none_sentinel(shape_series, allowed_values): + shape_series = 'UNKNOWN_ENUM_VALUE' + self._shape_series = shape_series + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/database/models/create_autonomous_database_base.py b/src/oci/database/models/create_autonomous_database_base.py index 0b53a378a5..115f4a1a79 100644 --- a/src/oci/database/models/create_autonomous_database_base.py +++ b/src/oci/database/models/create_autonomous_database_base.py @@ -471,12 +471,10 @@ def character_set(self, character_set): def ncharacter_set(self): """ Gets the ncharacter_set of this CreateAutonomousDatabaseBase. - The character set for the Autonomous Database. The default is AL32UTF8. Use `List Autonomous Database Character Sets`__ to list the allowed values for an Autonomous Database on shared Exadata infrastructure. + The character set for the Autonomous Database. The default is AL32UTF8. Use :func:`list_autonomous_database_character_sets` to list the allowed values for an Autonomous Database on shared Exadata infrastructure. For an Autonomous Database on dedicated Exadata infrastructure, the allowed values are: AL16UTF16 or UTF8. - __ https://docs.cloud.oracle.com/autonomousDatabaseCharacterSets - :return: The ncharacter_set of this CreateAutonomousDatabaseBase. :rtype: str @@ -487,12 +485,10 @@ def ncharacter_set(self): def ncharacter_set(self, ncharacter_set): """ Sets the ncharacter_set of this CreateAutonomousDatabaseBase. - The character set for the Autonomous Database. The default is AL32UTF8. Use `List Autonomous Database Character Sets`__ to list the allowed values for an Autonomous Database on shared Exadata infrastructure. + The character set for the Autonomous Database. The default is AL32UTF8. Use :func:`list_autonomous_database_character_sets` to list the allowed values for an Autonomous Database on shared Exadata infrastructure. For an Autonomous Database on dedicated Exadata infrastructure, the allowed values are: AL16UTF16 or UTF8. - __ https://docs.cloud.oracle.com/autonomousDatabaseCharacterSets - :param ncharacter_set: The ncharacter_set of this CreateAutonomousDatabaseBase. :type: str diff --git a/src/oci/database/models/exadata_infrastructure.py b/src/oci/database/models/exadata_infrastructure.py index 4f009db12a..edf7db3749 100644 --- a/src/oci/database/models/exadata_infrastructure.py +++ b/src/oci/database/models/exadata_infrastructure.py @@ -128,6 +128,10 @@ def __init__(self, **kwargs): The value to assign to the max_data_storage_in_t_bs property of this ExadataInfrastructure. :type max_data_storage_in_t_bs: float + :param rack_serial_number: + The value to assign to the rack_serial_number property of this ExadataInfrastructure. + :type rack_serial_number: str + :param storage_count: The value to assign to the storage_count property of this ExadataInfrastructure. :type storage_count: int @@ -250,6 +254,7 @@ def __init__(self, **kwargs): 'max_db_node_storage_in_g_bs': 'int', 'data_storage_size_in_tbs': 'float', 'max_data_storage_in_t_bs': 'float', + 'rack_serial_number': 'str', 'storage_count': 'int', 'additional_storage_count': 'int', 'activated_storage_count': 'int', @@ -293,6 +298,7 @@ def __init__(self, **kwargs): 'max_db_node_storage_in_g_bs': 'maxDbNodeStorageInGBs', 'data_storage_size_in_tbs': 'dataStorageSizeInTBs', 'max_data_storage_in_t_bs': 'maxDataStorageInTBs', + 'rack_serial_number': 'rackSerialNumber', 'storage_count': 'storageCount', 'additional_storage_count': 'additionalStorageCount', 'activated_storage_count': 'activatedStorageCount', @@ -335,6 +341,7 @@ def __init__(self, **kwargs): self._max_db_node_storage_in_g_bs = None self._data_storage_size_in_tbs = None self._max_data_storage_in_t_bs = None + self._rack_serial_number = None self._storage_count = None self._additional_storage_count = None self._activated_storage_count = None @@ -716,6 +723,30 @@ def max_data_storage_in_t_bs(self, max_data_storage_in_t_bs): """ self._max_data_storage_in_t_bs = max_data_storage_in_t_bs + @property + def rack_serial_number(self): + """ + Gets the rack_serial_number of this ExadataInfrastructure. + The serial number for the Exadata infrastructure. + + + :return: The rack_serial_number of this ExadataInfrastructure. + :rtype: str + """ + return self._rack_serial_number + + @rack_serial_number.setter + def rack_serial_number(self, rack_serial_number): + """ + Sets the rack_serial_number of this ExadataInfrastructure. + The serial number for the Exadata infrastructure. + + + :param rack_serial_number: The rack_serial_number of this ExadataInfrastructure. + :type: str + """ + self._rack_serial_number = rack_serial_number + @property def storage_count(self): """ diff --git a/src/oci/database/models/exadata_infrastructure_summary.py b/src/oci/database/models/exadata_infrastructure_summary.py index 9e256aa8b2..79f3022bc0 100644 --- a/src/oci/database/models/exadata_infrastructure_summary.py +++ b/src/oci/database/models/exadata_infrastructure_summary.py @@ -129,6 +129,10 @@ def __init__(self, **kwargs): The value to assign to the max_data_storage_in_t_bs property of this ExadataInfrastructureSummary. :type max_data_storage_in_t_bs: float + :param rack_serial_number: + The value to assign to the rack_serial_number property of this ExadataInfrastructureSummary. + :type rack_serial_number: str + :param storage_count: The value to assign to the storage_count property of this ExadataInfrastructureSummary. :type storage_count: int @@ -251,6 +255,7 @@ def __init__(self, **kwargs): 'max_db_node_storage_in_g_bs': 'int', 'data_storage_size_in_tbs': 'float', 'max_data_storage_in_t_bs': 'float', + 'rack_serial_number': 'str', 'storage_count': 'int', 'additional_storage_count': 'int', 'activated_storage_count': 'int', @@ -294,6 +299,7 @@ def __init__(self, **kwargs): 'max_db_node_storage_in_g_bs': 'maxDbNodeStorageInGBs', 'data_storage_size_in_tbs': 'dataStorageSizeInTBs', 'max_data_storage_in_t_bs': 'maxDataStorageInTBs', + 'rack_serial_number': 'rackSerialNumber', 'storage_count': 'storageCount', 'additional_storage_count': 'additionalStorageCount', 'activated_storage_count': 'activatedStorageCount', @@ -336,6 +342,7 @@ def __init__(self, **kwargs): self._max_db_node_storage_in_g_bs = None self._data_storage_size_in_tbs = None self._max_data_storage_in_t_bs = None + self._rack_serial_number = None self._storage_count = None self._additional_storage_count = None self._activated_storage_count = None @@ -717,6 +724,30 @@ def max_data_storage_in_t_bs(self, max_data_storage_in_t_bs): """ self._max_data_storage_in_t_bs = max_data_storage_in_t_bs + @property + def rack_serial_number(self): + """ + Gets the rack_serial_number of this ExadataInfrastructureSummary. + The serial number for the Exadata infrastructure. + + + :return: The rack_serial_number of this ExadataInfrastructureSummary. + :rtype: str + """ + return self._rack_serial_number + + @rack_serial_number.setter + def rack_serial_number(self, rack_serial_number): + """ + Sets the rack_serial_number of this ExadataInfrastructureSummary. + The serial number for the Exadata infrastructure. + + + :param rack_serial_number: The rack_serial_number of this ExadataInfrastructureSummary. + :type: str + """ + self._rack_serial_number = rack_serial_number + @property def storage_count(self): """ diff --git a/src/oci/database/models/update_autonomous_database_wallet_details.py b/src/oci/database/models/update_autonomous_database_wallet_details.py index 3b6f5f62e6..32ebd69c4d 100644 --- a/src/oci/database/models/update_autonomous_database_wallet_details.py +++ b/src/oci/database/models/update_autonomous_database_wallet_details.py @@ -22,16 +22,23 @@ def __init__(self, **kwargs): The value to assign to the should_rotate property of this UpdateAutonomousDatabaseWalletDetails. :type should_rotate: bool + :param grace_period: + The value to assign to the grace_period property of this UpdateAutonomousDatabaseWalletDetails. + :type grace_period: int + """ self.swagger_types = { - 'should_rotate': 'bool' + 'should_rotate': 'bool', + 'grace_period': 'int' } self.attribute_map = { - 'should_rotate': 'shouldRotate' + 'should_rotate': 'shouldRotate', + 'grace_period': 'gracePeriod' } self._should_rotate = None + self._grace_period = None @property def should_rotate(self): @@ -57,6 +64,30 @@ def should_rotate(self, should_rotate): """ self._should_rotate = should_rotate + @property + def grace_period(self): + """ + Gets the grace_period of this UpdateAutonomousDatabaseWalletDetails. + Grace period in hours to keep the existing wallet valid after rotation. + + + :return: The grace_period of this UpdateAutonomousDatabaseWalletDetails. + :rtype: int + """ + return self._grace_period + + @grace_period.setter + def grace_period(self, grace_period): + """ + Sets the grace_period of this UpdateAutonomousDatabaseWalletDetails. + Grace period in hours to keep the existing wallet valid after rotation. + + + :param grace_period: The grace_period of this UpdateAutonomousDatabaseWalletDetails. + :type: int + """ + self._grace_period = grace_period + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/fusion_apps/__init__.py b/src/oci/fusion_apps/__init__.py new file mode 100644 index 0000000000..e7820a1a20 --- /dev/null +++ b/src/oci/fusion_apps/__init__.py @@ -0,0 +1,22 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from __future__ import absolute_import + + +from .data_masking_activity_client import DataMaskingActivityClient +from .data_masking_activity_client_composite_operations import DataMaskingActivityClientCompositeOperations +from .fusion_environment_client import FusionEnvironmentClient +from .fusion_environment_client_composite_operations import FusionEnvironmentClientCompositeOperations +from .fusion_environment_family_client import FusionEnvironmentFamilyClient +from .fusion_environment_family_client_composite_operations import FusionEnvironmentFamilyClientCompositeOperations +from .refresh_activity_client import RefreshActivityClient +from .refresh_activity_client_composite_operations import RefreshActivityClientCompositeOperations +from .scheduled_activity_client import ScheduledActivityClient +from .scheduled_activity_client_composite_operations import ScheduledActivityClientCompositeOperations +from .service_attachment_client import ServiceAttachmentClient +from .service_attachment_client_composite_operations import ServiceAttachmentClientCompositeOperations +from . import models + +__all__ = ["DataMaskingActivityClient", "DataMaskingActivityClientCompositeOperations", "FusionEnvironmentClient", "FusionEnvironmentClientCompositeOperations", "FusionEnvironmentFamilyClient", "FusionEnvironmentFamilyClientCompositeOperations", "RefreshActivityClient", "RefreshActivityClientCompositeOperations", "ScheduledActivityClient", "ScheduledActivityClientCompositeOperations", "ServiceAttachmentClient", "ServiceAttachmentClientCompositeOperations", "models"] diff --git a/src/oci/fusion_apps/data_masking_activity_client.py b/src/oci/fusion_apps/data_masking_activity_client.py new file mode 100644 index 0000000000..73e88f13c7 --- /dev/null +++ b/src/oci/fusion_apps/data_masking_activity_client.py @@ -0,0 +1,456 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from __future__ import absolute_import + +from oci._vendor import requests # noqa: F401 +from oci._vendor import six + +from oci import retry, circuit_breaker # noqa: F401 +from oci.base_client import BaseClient +from oci.config import get_config_value_or_default, validate_config +from oci.signer import Signer +from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from .models import fusion_apps_type_mapping +missing = Sentinel("Missing") + + +class DataMaskingActivityClient(object): + """ + Use the Fusion Applications Environment Management API to manage the environments where your Fusion Applications run. For more information, see the [Fusion Applications Environment Management documentation](/iaas/Content/Identity/fusion-applications/home.htm). + """ + + def __init__(self, config, **kwargs): + """ + Creates a new service client + + :param dict config: + Configuration keys and values as per `SDK and Tool Configuration `__. + The :py:meth:`~oci.config.from_file` method can be used to load configuration from a file. Alternatively, a ``dict`` can be passed. You can validate_config + the dict using :py:meth:`~oci.config.validate_config` + + :param str service_endpoint: (optional) + The endpoint of the service to call using this client. For example ``https://iaas.us-ashburn-1.oraclecloud.com``. If this keyword argument is + not provided then it will be derived using the region in the config parameter. You should only provide this keyword argument if you have an explicit + need to specify a service endpoint. + + :param timeout: (optional) + The connection and read timeouts for the client. The default values are connection timeout 10 seconds and read timeout 60 seconds. This keyword argument can be provided + as a single float, in which case the value provided is used for both the read and connection timeouts, or as a tuple of two floats. If + a tuple is provided then the first value is used as the connection timeout and the second value as the read timeout. + :type timeout: float or tuple(float, float) + + :param signer: (optional) + The signer to use when signing requests made by the service client. The default is to use a :py:class:`~oci.signer.Signer` based on the values + provided in the config parameter. + + One use case for this parameter is for `Instance Principals authentication `__ + by passing an instance of :py:class:`~oci.auth.signers.InstancePrincipalsSecurityTokenSigner` as the value for this keyword argument + :type signer: :py:class:`~oci.signer.AbstractBaseSigner` + + :param obj retry_strategy: (optional) + A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. + Retry strategies can also be applied at the operation level by passing a ``retry_strategy`` keyword argument as part of calling the operation. + Any value provided at the operation level will override whatever is specified at the client level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` + is also available. The specifics of the default retry strategy are described `here `__. + + :param obj circuit_breaker_strategy: (optional) + A circuit breaker strategy to apply to all calls made by this service client (i.e. at the client level). + This client uses :py:data:`~oci.circuit_breaker.DEFAULT_CIRCUIT_BREAKER_STRATEGY` as default if no circuit breaker strategy is provided. + The specifics of circuit breaker strategy are described `here `__. + + :param function circuit_breaker_callback: (optional) + Callback function to receive any exceptions triggerred by the circuit breaker. + + :param allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not + allow control characters to be in the response object. + """ + validate_config(config, signer=kwargs.get('signer')) + if 'signer' in kwargs: + signer = kwargs['signer'] + + elif AUTHENTICATION_TYPE_FIELD_NAME in config: + signer = get_signer_from_authentication_type(config) + + else: + signer = Signer( + tenancy=config["tenancy"], + user=config["user"], + fingerprint=config["fingerprint"], + private_key_file_location=config.get("key_file"), + pass_phrase=get_config_value_or_default(config, "pass_phrase"), + private_key_content=config.get("key_content") + ) + + base_client_init_kwargs = { + 'regional_client': True, + 'service_endpoint': kwargs.get('service_endpoint'), + 'base_path': '/20211201', + 'service_endpoint_template': 'https://fusionapps.{region}.oci.{secondLevelDomain}', + 'skip_deserialization': kwargs.get('skip_deserialization', False), + 'circuit_breaker_strategy': kwargs.get('circuit_breaker_strategy', circuit_breaker.GLOBAL_CIRCUIT_BREAKER_STRATEGY) + } + if 'timeout' in kwargs: + base_client_init_kwargs['timeout'] = kwargs.get('timeout') + if base_client_init_kwargs.get('circuit_breaker_strategy') is None: + base_client_init_kwargs['circuit_breaker_strategy'] = circuit_breaker.DEFAULT_CIRCUIT_BREAKER_STRATEGY + if 'allow_control_chars' in kwargs: + base_client_init_kwargs['allow_control_chars'] = kwargs.get('allow_control_chars') + self.base_client = BaseClient("data_masking_activity", config, signer, fusion_apps_type_mapping, **base_client_init_kwargs) + self.retry_strategy = kwargs.get('retry_strategy') + self.circuit_breaker_callback = kwargs.get('circuit_breaker_callback') + + def create_data_masking_activity(self, fusion_environment_id, create_data_masking_activity_details, **kwargs): + """ + Creates a new DataMaskingActivity. + + + :param str fusion_environment_id: (required) + unique FusionEnvironment identifier + + :param oci.fusion_apps.models.CreateDataMaskingActivityDetails create_data_masking_activity_details: (required) + Details for the new DataMaskingActivity. + + :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) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use create_data_masking_activity API. + """ + resource_path = "/fusionEnvironments/{fusionEnvironmentId}/dataMaskingActivities" + method = "POST" + operation_name = "create_data_masking_activity" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_retry_token", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "create_data_masking_activity got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "fusionEnvironmentId": fusion_environment_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-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: + 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=create_data_masking_activity_details, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=create_data_masking_activity_details, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def get_data_masking_activity(self, fusion_environment_id, data_masking_activity_id, **kwargs): + """ + Gets a DataMaskingActivity by identifier + + + :param str fusion_environment_id: (required) + unique FusionEnvironment identifier + + :param str data_masking_activity_id: (required) + Unique DataMasking run identifier. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.fusion_apps.models.DataMaskingActivity` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_data_masking_activity API. + """ + resource_path = "/fusionEnvironments/{fusionEnvironmentId}/dataMaskingActivities/{dataMaskingActivityId}" + method = "GET" + operation_name = "get_data_masking_activity" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "get_data_masking_activity got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "fusionEnvironmentId": fusion_environment_id, + "dataMaskingActivityId": data_masking_activity_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="DataMaskingActivity", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="DataMaskingActivity", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def list_data_masking_activities(self, fusion_environment_id, **kwargs): + """ + Returns a list of DataMaskingActivities. + + + :param str fusion_environment_id: (required) + unique FusionEnvironment identifier + + :param str lifecycle_state: (optional) + A filter that returns all resources that match the specified status + + Allowed values are: "ACCEPTED", "IN_PROGRESS", "FAILED", "SUCCEEDED", "CANCELED" + + :param int limit: (optional) + The maximum number of items to return. + + :param str page: (optional) + The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. + + :param str sort_order: (optional) + The sort order to use, either 'asc' or 'desc'. + + Allowed values are: "ASC", "DESC" + + :param str sort_by: (optional) + The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. + + Allowed values are: "TIME_CREATED", "DISPLAY_NAME" + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.fusion_apps.models.DataMaskingActivityCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_data_masking_activities API. + """ + resource_path = "/fusionEnvironments/{fusionEnvironmentId}/dataMaskingActivities" + method = "GET" + operation_name = "list_data_masking_activities" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "lifecycle_state", + "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( + "list_data_masking_activities got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "fusionEnvironmentId": fusion_environment_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + if 'lifecycle_state' in kwargs: + lifecycle_state_allowed_values = ["ACCEPTED", "IN_PROGRESS", "FAILED", "SUCCEEDED", "CANCELED"] + if kwargs['lifecycle_state'] not in lifecycle_state_allowed_values: + raise ValueError( + "Invalid value for `lifecycle_state`, must be one of {0}".format(lifecycle_state_allowed_values) + ) + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + "Invalid value for `sort_order`, must be one of {0}".format(sort_order_allowed_values) + ) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["TIME_CREATED", "DISPLAY_NAME"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) + ) + + query_params = { + "lifecycleState": kwargs.get("lifecycle_state", 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: + 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="DataMaskingActivityCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + 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="DataMaskingActivityCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) diff --git a/src/oci/fusion_apps/data_masking_activity_client_composite_operations.py b/src/oci/fusion_apps/data_masking_activity_client_composite_operations.py new file mode 100644 index 0000000000..b34a16ce59 --- /dev/null +++ b/src/oci/fusion_apps/data_masking_activity_client_composite_operations.py @@ -0,0 +1,65 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, 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. + +import oci # noqa: F401 +from oci.util import WAIT_RESOURCE_NOT_FOUND # noqa: F401 + + +class DataMaskingActivityClientCompositeOperations(object): + """ + This class provides a wrapper around :py:class:`~oci.fusion_apps.DataMaskingActivityClient` and offers convenience methods + for operations that would otherwise need to be chained together. For example, instead of performing an action + on a resource (e.g. launching an instance, creating a load balancer) and then using a waiter to wait for the resource + to enter a given state, you can call a single method in this class to accomplish the same functionality + """ + + def __init__(self, client, **kwargs): + """ + Creates a new DataMaskingActivityClientCompositeOperations object + + :param DataMaskingActivityClient client: + The service client which will be wrapped by this object + """ + self.client = client + + def create_data_masking_activity_and_wait_for_state(self, fusion_environment_id, create_data_masking_activity_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.fusion_apps.DataMaskingActivityClient.create_data_masking_activity` and waits for the :py:class:`~oci.fusion_apps.models.WorkRequest` + to enter the given state(s). + + :param str fusion_environment_id: (required) + unique FusionEnvironment identifier + + :param oci.fusion_apps.models.CreateDataMaskingActivityDetails create_data_masking_activity_details: (required) + Details for the new DataMaskingActivity. + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.fusion_apps.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.fusion_apps.DataMaskingActivityClient.create_data_masking_activity` + + :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_data_masking_activity(fusion_environment_id, create_data_masking_activity_details, **operation_kwargs) + if not wait_for_states: + return operation_result + + lowered_wait_for_states = [w.lower() for w in wait_for_states] + 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/fusion_apps/fusion_environment_client.py b/src/oci/fusion_apps/fusion_environment_client.py new file mode 100644 index 0000000000..290af6bd85 --- /dev/null +++ b/src/oci/fusion_apps/fusion_environment_client.py @@ -0,0 +1,1772 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from __future__ import absolute_import + +from oci._vendor import requests # noqa: F401 +from oci._vendor import six + +from oci import retry, circuit_breaker # noqa: F401 +from oci.base_client import BaseClient +from oci.config import get_config_value_or_default, validate_config +from oci.signer import Signer +from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from .models import fusion_apps_type_mapping +missing = Sentinel("Missing") + + +class FusionEnvironmentClient(object): + """ + Use the Fusion Applications Environment Management API to manage the environments where your Fusion Applications run. For more information, see the [Fusion Applications Environment Management documentation](/iaas/Content/Identity/fusion-applications/home.htm). + """ + + def __init__(self, config, **kwargs): + """ + Creates a new service client + + :param dict config: + Configuration keys and values as per `SDK and Tool Configuration `__. + The :py:meth:`~oci.config.from_file` method can be used to load configuration from a file. Alternatively, a ``dict`` can be passed. You can validate_config + the dict using :py:meth:`~oci.config.validate_config` + + :param str service_endpoint: (optional) + The endpoint of the service to call using this client. For example ``https://iaas.us-ashburn-1.oraclecloud.com``. If this keyword argument is + not provided then it will be derived using the region in the config parameter. You should only provide this keyword argument if you have an explicit + need to specify a service endpoint. + + :param timeout: (optional) + The connection and read timeouts for the client. The default values are connection timeout 10 seconds and read timeout 60 seconds. This keyword argument can be provided + as a single float, in which case the value provided is used for both the read and connection timeouts, or as a tuple of two floats. If + a tuple is provided then the first value is used as the connection timeout and the second value as the read timeout. + :type timeout: float or tuple(float, float) + + :param signer: (optional) + The signer to use when signing requests made by the service client. The default is to use a :py:class:`~oci.signer.Signer` based on the values + provided in the config parameter. + + One use case for this parameter is for `Instance Principals authentication `__ + by passing an instance of :py:class:`~oci.auth.signers.InstancePrincipalsSecurityTokenSigner` as the value for this keyword argument + :type signer: :py:class:`~oci.signer.AbstractBaseSigner` + + :param obj retry_strategy: (optional) + A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. + Retry strategies can also be applied at the operation level by passing a ``retry_strategy`` keyword argument as part of calling the operation. + Any value provided at the operation level will override whatever is specified at the client level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` + is also available. The specifics of the default retry strategy are described `here `__. + + :param obj circuit_breaker_strategy: (optional) + A circuit breaker strategy to apply to all calls made by this service client (i.e. at the client level). + This client uses :py:data:`~oci.circuit_breaker.DEFAULT_CIRCUIT_BREAKER_STRATEGY` as default if no circuit breaker strategy is provided. + The specifics of circuit breaker strategy are described `here `__. + + :param function circuit_breaker_callback: (optional) + Callback function to receive any exceptions triggerred by the circuit breaker. + + :param allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not + allow control characters to be in the response object. + """ + validate_config(config, signer=kwargs.get('signer')) + if 'signer' in kwargs: + signer = kwargs['signer'] + + elif AUTHENTICATION_TYPE_FIELD_NAME in config: + signer = get_signer_from_authentication_type(config) + + else: + signer = Signer( + tenancy=config["tenancy"], + user=config["user"], + fingerprint=config["fingerprint"], + private_key_file_location=config.get("key_file"), + pass_phrase=get_config_value_or_default(config, "pass_phrase"), + private_key_content=config.get("key_content") + ) + + base_client_init_kwargs = { + 'regional_client': True, + 'service_endpoint': kwargs.get('service_endpoint'), + 'base_path': '/20211201', + 'service_endpoint_template': 'https://fusionapps.{region}.oci.{secondLevelDomain}', + 'skip_deserialization': kwargs.get('skip_deserialization', False), + 'circuit_breaker_strategy': kwargs.get('circuit_breaker_strategy', circuit_breaker.GLOBAL_CIRCUIT_BREAKER_STRATEGY) + } + if 'timeout' in kwargs: + base_client_init_kwargs['timeout'] = kwargs.get('timeout') + if base_client_init_kwargs.get('circuit_breaker_strategy') is None: + base_client_init_kwargs['circuit_breaker_strategy'] = circuit_breaker.DEFAULT_CIRCUIT_BREAKER_STRATEGY + if 'allow_control_chars' in kwargs: + base_client_init_kwargs['allow_control_chars'] = kwargs.get('allow_control_chars') + self.base_client = BaseClient("fusion_environment", config, signer, fusion_apps_type_mapping, **base_client_init_kwargs) + self.retry_strategy = kwargs.get('retry_strategy') + self.circuit_breaker_callback = kwargs.get('circuit_breaker_callback') + + def change_fusion_environment_compartment(self, fusion_environment_id, change_fusion_environment_compartment_details, **kwargs): + """ + Moves a FusionEnvironment into a different compartment. When provided, If-Match is checked against ETag + values of the resource. + + + :param str fusion_environment_id: (required) + unique FusionEnvironment identifier + + :param oci.fusion_apps.models.ChangeFusionEnvironmentCompartmentDetails change_fusion_environment_compartment_details: (required) + The details of change compartment 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 str opc_request_id: (optional) + The client request ID for tracing. + + :param str opc_retry_token: (optional) + A token that uniquely identifies a request so it can be retried in case of a timeout or + server error without risk of executing that same action again. Retry tokens expire after 24 + hours, but can be invalidated before then due to conflicting operations. For example, if a resource + has been deleted and purged from the system, then a retry of the original creation request + might be rejected. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + 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_fusion_environment_compartment API. + """ + resource_path = "/fusionEnvironments/{fusionEnvironmentId}/actions/changeCompartment" + method = "POST" + operation_name = "change_fusion_environment_compartment" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "if_match", + "opc_request_id", + "opc_retry_token" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "change_fusion_environment_compartment got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "fusionEnvironmentId": fusion_environment_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "if-match": kwargs.get("if_match", missing), + "opc-request-id": kwargs.get("opc_request_id", missing), + "opc-retry-token": kwargs.get("opc_retry_token", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + 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_fusion_environment_compartment_details, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=change_fusion_environment_compartment_details, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def create_fusion_environment(self, create_fusion_environment_details, **kwargs): + """ + Creates a new FusionEnvironment. + + + :param oci.fusion_apps.models.CreateFusionEnvironmentDetails create_fusion_environment_details: (required) + Details for the new FusionEnvironment. + + :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) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use create_fusion_environment API. + """ + resource_path = "/fusionEnvironments" + method = "POST" + operation_name = "create_fusion_environment" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_retry_token", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "create_fusion_environment got unknown kwargs: {!r}".format(extra_kwargs)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-retry-token": kwargs.get("opc_retry_token", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + 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_fusion_environment_details, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + header_params=header_params, + body=create_fusion_environment_details, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def create_fusion_environment_admin_user(self, create_fusion_environment_admin_user_details, fusion_environment_id, **kwargs): + """ + Create a FusionEnvironment admin user + + + :param oci.fusion_apps.models.CreateFusionEnvironmentAdminUserDetails create_fusion_environment_admin_user_details: (required) + The admin user to be created. + + :param str fusion_environment_id: (required) + unique FusionEnvironment 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 str opc_request_id: (optional) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use create_fusion_environment_admin_user API. + """ + resource_path = "/fusionEnvironments/{fusionEnvironmentId}/adminUsers" + method = "POST" + operation_name = "create_fusion_environment_admin_user" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_retry_token", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "create_fusion_environment_admin_user got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "fusionEnvironmentId": fusion_environment_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-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: + 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=create_fusion_environment_admin_user_details, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=create_fusion_environment_admin_user_details, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def delete_fusion_environment(self, fusion_environment_id, **kwargs): + """ + Deletes the Fusion environment identified by it's OCID. + + + :param str fusion_environment_id: (required) + unique FusionEnvironment identifier + + :param str if_match: (optional) + For optimistic concurrency control. In the PUT or DELETE call + for a resource, set the `if-match` parameter to the value of the + etag from a previous GET or POST response for that resource. + The resource will be updated or deleted only if the etag you + provide matches the resource's current etag value. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use delete_fusion_environment API. + """ + resource_path = "/fusionEnvironments/{fusionEnvironmentId}" + method = "DELETE" + operation_name = "delete_fusion_environment" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "if_match", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "delete_fusion_environment got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "fusionEnvironmentId": fusion_environment_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "if-match": kwargs.get("if_match", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + 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) + 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) + + def delete_fusion_environment_admin_user(self, admin_username, fusion_environment_id, **kwargs): + """ + Deletes the FusionEnvironment administrator user identified by the username. + + + :param str admin_username: (required) + The admin user name for the fusion environment. + + :param str fusion_environment_id: (required) + unique FusionEnvironment identifier + + :param str if_match: (optional) + For optimistic concurrency control. In the PUT or DELETE call + for a resource, set the `if-match` parameter to the value of the + etag from a previous GET or POST response for that resource. + The resource will be updated or deleted only if the etag you + provide matches the resource's current etag value. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use delete_fusion_environment_admin_user API. + """ + resource_path = "/fusionEnvironments/{fusionEnvironmentId}/adminUsers/{adminUsername}" + method = "DELETE" + operation_name = "delete_fusion_environment_admin_user" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "if_match", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "delete_fusion_environment_admin_user got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "adminUsername": admin_username, + "fusionEnvironmentId": fusion_environment_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "if-match": kwargs.get("if_match", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + 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) + 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) + + def get_fusion_environment(self, fusion_environment_id, **kwargs): + """ + Gets a FusionEnvironment by identifier + + + :param str fusion_environment_id: (required) + unique FusionEnvironment identifier + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.fusion_apps.models.FusionEnvironment` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_fusion_environment API. + """ + resource_path = "/fusionEnvironments/{fusionEnvironmentId}" + method = "GET" + operation_name = "get_fusion_environment" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "get_fusion_environment got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "fusionEnvironmentId": fusion_environment_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="FusionEnvironment", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="FusionEnvironment", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def get_fusion_environment_status(self, fusion_environment_id, **kwargs): + """ + Gets the status of a Fusion environment identified by its OCID. + + + :param str fusion_environment_id: (required) + unique FusionEnvironment identifier + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.fusion_apps.models.FusionEnvironmentStatus` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_fusion_environment_status API. + """ + resource_path = "/fusionEnvironments/{fusionEnvironmentId}/status" + method = "GET" + operation_name = "get_fusion_environment_status" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "get_fusion_environment_status got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "fusionEnvironmentId": fusion_environment_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="FusionEnvironmentStatus", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="FusionEnvironmentStatus", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def get_work_request(self, work_request_id, **kwargs): + """ + Gets the status of the work request with the given ID. + + + :param str work_request_id: (required) + The ID of the asynchronous request. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.fusion_apps.models.WorkRequest` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_work_request API. + """ + resource_path = "/workRequests/{workRequestId}" + method = "GET" + operation_name = "get_work_request" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "get_work_request got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "workRequestId": work_request_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="WorkRequest", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="WorkRequest", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def list_admin_users(self, fusion_environment_id, **kwargs): + """ + List all FusionEnvironment admin users + + + :param str fusion_environment_id: (required) + unique FusionEnvironment identifier + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.fusion_apps.models.AdminUserCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_admin_users API. + """ + resource_path = "/fusionEnvironments/{fusionEnvironmentId}/adminUsers" + method = "GET" + operation_name = "list_admin_users" + api_reference_link = "" + + # 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( + "list_admin_users got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "fusionEnvironmentId": fusion_environment_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="AdminUserCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="AdminUserCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def list_fusion_environments(self, compartment_id, **kwargs): + """ + Returns a list of FusionEnvironments. + + + :param str compartment_id: (required) + The ID of the compartment in which to list resources. + + :param str fusion_environment_family_id: (optional) + The ID of the fusion environment family in which to list resources. + + :param str display_name: (optional) + A filter to return only resources that match the entire display name given. + + :param str lifecycle_state: (optional) + A filter that returns all resources that match the specified lifecycle state. + + Allowed values are: "CREATING", "UPDATING", "ACTIVE", "INACTIVE", "DELETING", "DELETED", "FAILED" + + :param int limit: (optional) + The maximum number of items to return. + + :param str page: (optional) + The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. + + :param str sort_order: (optional) + The sort order to use, either 'asc' or 'desc'. + + Allowed values are: "ASC", "DESC" + + :param str sort_by: (optional) + The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. + + Allowed values are: "TIME_CREATED", "DISPLAY_NAME" + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.fusion_apps.models.FusionEnvironmentCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_fusion_environments API. + """ + resource_path = "/fusionEnvironments" + method = "GET" + operation_name = "list_fusion_environments" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "fusion_environment_family_id", + "display_name", + "lifecycle_state", + "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( + "list_fusion_environments got unknown kwargs: {!r}".format(extra_kwargs)) + + if 'lifecycle_state' in kwargs: + lifecycle_state_allowed_values = ["CREATING", "UPDATING", "ACTIVE", "INACTIVE", "DELETING", "DELETED", "FAILED"] + if kwargs['lifecycle_state'] not in lifecycle_state_allowed_values: + raise ValueError( + "Invalid value for `lifecycle_state`, must be one of {0}".format(lifecycle_state_allowed_values) + ) + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + "Invalid value for `sort_order`, must be one of {0}".format(sort_order_allowed_values) + ) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["TIME_CREATED", "DISPLAY_NAME"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) + ) + + query_params = { + "compartmentId": compartment_id, + "fusionEnvironmentFamilyId": kwargs.get("fusion_environment_family_id", missing), + "displayName": kwargs.get("display_name", missing), + "lifecycleState": kwargs.get("lifecycle_state", 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: + 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="FusionEnvironmentCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + query_params=query_params, + header_params=header_params, + response_type="FusionEnvironmentCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def list_work_request_errors(self, work_request_id, **kwargs): + """ + Return a (paginated) list of errors for a given work request. + + + :param str work_request_id: (required) + The ID of the asynchronous request. + + :param str sort_by: (optional) + The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending. + + Allowed values are: "timeAccepted" + + :param str sort_order: (optional) + The sort order to use, either 'asc' or 'desc'. + + Allowed values are: "ASC", "DESC" + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param str page: (optional) + The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. + + :param int limit: (optional) + The maximum number of items to return. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.fusion_apps.models.WorkRequestErrorCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_work_request_errors API. + """ + resource_path = "/workRequests/{workRequestId}/errors" + method = "GET" + operation_name = "list_work_request_errors" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "sort_by", + "sort_order", + "opc_request_id", + "page", + "limit" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_work_request_errors got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "workRequestId": work_request_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["timeAccepted"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) + ) + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + "Invalid value for `sort_order`, must be one of {0}".format(sort_order_allowed_values) + ) + + query_params = { + "sortBy": kwargs.get("sort_by", missing), + "sortOrder": kwargs.get("sort_order", missing), + "page": kwargs.get("page", missing), + "limit": kwargs.get("limit", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + query_params=query_params, + header_params=header_params, + response_type="WorkRequestErrorCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + 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="WorkRequestErrorCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def list_work_request_logs(self, work_request_id, **kwargs): + """ + Return a (paginated) list of logs for a given work request. + + + :param str work_request_id: (required) + The ID of the asynchronous request. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param str page: (optional) + The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. + + :param int limit: (optional) + The maximum number of items to return. + + :param str sort_by: (optional) + The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending. + + Allowed values are: "timeAccepted" + + :param str sort_order: (optional) + The sort order to use, either 'asc' or 'desc'. + + Allowed values are: "ASC", "DESC" + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.fusion_apps.models.WorkRequestLogEntryCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_work_request_logs API. + """ + resource_path = "/workRequests/{workRequestId}/logs" + method = "GET" + operation_name = "list_work_request_logs" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id", + "page", + "limit", + "sort_by", + "sort_order" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_work_request_logs got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "workRequestId": work_request_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["timeAccepted"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) + ) + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + "Invalid value for `sort_order`, must be one of {0}".format(sort_order_allowed_values) + ) + + query_params = { + "page": kwargs.get("page", missing), + "limit": kwargs.get("limit", missing), + "sortBy": kwargs.get("sort_by", missing), + "sortOrder": kwargs.get("sort_order", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + query_params=query_params, + header_params=header_params, + response_type="WorkRequestLogEntryCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + 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="WorkRequestLogEntryCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def list_work_requests(self, compartment_id, **kwargs): + """ + Lists the work requests in a compartment. + + + :param str compartment_id: (required) + The ID of the compartment in which to list resources. + + :param str status: (optional) + A filter to return only resources their lifecycleState matches the given OperationStatus. + + Allowed values are: "ACCEPTED", "IN_PROGRESS", "FAILED", "SUCCEEDED", "CANCELING", "CANCELED" + + :param str sort_by: (optional) + The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending. + + Allowed values are: "timeAccepted" + + :param str sort_order: (optional) + The sort order to use, either 'asc' or 'desc'. + + Allowed values are: "ASC", "DESC" + + :param str resource_id: (optional) + The ID of the a resource in which to list associated resources. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param str page: (optional) + The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. + + :param int limit: (optional) + The maximum number of items to return. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.fusion_apps.models.WorkRequestSummaryCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_work_requests API. + """ + resource_path = "/workRequests" + method = "GET" + operation_name = "list_work_requests" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "status", + "sort_by", + "sort_order", + "resource_id", + "opc_request_id", + "page", + "limit" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_work_requests got unknown kwargs: {!r}".format(extra_kwargs)) + + if 'status' in kwargs: + status_allowed_values = ["ACCEPTED", "IN_PROGRESS", "FAILED", "SUCCEEDED", "CANCELING", "CANCELED"] + if kwargs['status'] not in status_allowed_values: + raise ValueError( + "Invalid value for `status`, must be one of {0}".format(status_allowed_values) + ) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["timeAccepted"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) + ) + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + "Invalid value for `sort_order`, must be one of {0}".format(sort_order_allowed_values) + ) + + query_params = { + "compartmentId": compartment_id, + "status": kwargs.get("status", missing), + "sortBy": kwargs.get("sort_by", missing), + "sortOrder": kwargs.get("sort_order", missing), + "resourceId": kwargs.get("resource_id", missing), + "page": kwargs.get("page", missing), + "limit": kwargs.get("limit", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + query_params=query_params, + header_params=header_params, + response_type="WorkRequestSummaryCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + query_params=query_params, + header_params=header_params, + response_type="WorkRequestSummaryCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def reset_fusion_environment_password(self, reset_fusion_environment_password_details, fusion_environment_id, admin_username, **kwargs): + """ + Resets the password of the Fusion Environment Administrator. + + + :param oci.fusion_apps.models.ResetFusionEnvironmentPasswordDetails reset_fusion_environment_password_details: (required) + The information to be updated. + + :param str fusion_environment_id: (required) + unique FusionEnvironment identifier + + :param str admin_username: (required) + The admin user name for the fusion environment. + + :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) + The client request ID for tracing. + + :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 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 reset_fusion_environment_password API. + """ + resource_path = "/fusionEnvironments/{fusionEnvironmentId}/adminUsers/{adminUsername}/actions/resetPassword" + method = "POST" + operation_name = "reset_fusion_environment_password" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "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( + "reset_fusion_environment_password got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "fusionEnvironmentId": fusion_environment_id, + "adminUsername": admin_username + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-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} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_retry_token_if_needed(header_params) + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=reset_fusion_environment_password_details, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=reset_fusion_environment_password_details, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def update_fusion_environment(self, fusion_environment_id, update_fusion_environment_details, **kwargs): + """ + Updates the FusionEnvironment + + + :param str fusion_environment_id: (required) + unique FusionEnvironment identifier + + :param oci.fusion_apps.models.UpdateFusionEnvironmentDetails update_fusion_environment_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 will be updated or deleted only if the etag you + provide matches the resource's current etag value. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use update_fusion_environment API. + """ + resource_path = "/fusionEnvironments/{fusionEnvironmentId}" + method = "PUT" + operation_name = "update_fusion_environment" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "if_match", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "update_fusion_environment got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "fusionEnvironmentId": fusion_environment_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "if-match": kwargs.get("if_match", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + 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_fusion_environment_details, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=update_fusion_environment_details, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) diff --git a/src/oci/fusion_apps/fusion_environment_client_composite_operations.py b/src/oci/fusion_apps/fusion_environment_client_composite_operations.py new file mode 100644 index 0000000000..d9dfcbabbb --- /dev/null +++ b/src/oci/fusion_apps/fusion_environment_client_composite_operations.py @@ -0,0 +1,324 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, 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. + +import oci # noqa: F401 +from oci.util import WAIT_RESOURCE_NOT_FOUND # noqa: F401 + + +class FusionEnvironmentClientCompositeOperations(object): + """ + This class provides a wrapper around :py:class:`~oci.fusion_apps.FusionEnvironmentClient` and offers convenience methods + for operations that would otherwise need to be chained together. For example, instead of performing an action + on a resource (e.g. launching an instance, creating a load balancer) and then using a waiter to wait for the resource + to enter a given state, you can call a single method in this class to accomplish the same functionality + """ + + def __init__(self, client, **kwargs): + """ + Creates a new FusionEnvironmentClientCompositeOperations object + + :param FusionEnvironmentClient client: + The service client which will be wrapped by this object + """ + self.client = client + + def change_fusion_environment_compartment_and_wait_for_state(self, fusion_environment_id, change_fusion_environment_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.fusion_apps.FusionEnvironmentClient.change_fusion_environment_compartment` and waits for the :py:class:`~oci.fusion_apps.models.WorkRequest` + to enter the given state(s). + + :param str fusion_environment_id: (required) + unique FusionEnvironment identifier + + :param oci.fusion_apps.models.ChangeFusionEnvironmentCompartmentDetails change_fusion_environment_compartment_details: (required) + The details of change compartment request. + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.fusion_apps.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.fusion_apps.FusionEnvironmentClient.change_fusion_environment_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_fusion_environment_compartment(fusion_environment_id, change_fusion_environment_compartment_details, **operation_kwargs) + if not wait_for_states: + return operation_result + + lowered_wait_for_states = [w.lower() for w in wait_for_states] + 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_fusion_environment_and_wait_for_state(self, create_fusion_environment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.fusion_apps.FusionEnvironmentClient.create_fusion_environment` and waits for the :py:class:`~oci.fusion_apps.models.WorkRequest` + to enter the given state(s). + + :param oci.fusion_apps.models.CreateFusionEnvironmentDetails create_fusion_environment_details: (required) + Details for the new FusionEnvironment. + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.fusion_apps.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.fusion_apps.FusionEnvironmentClient.create_fusion_environment` + + :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_fusion_environment(create_fusion_environment_details, **operation_kwargs) + if not wait_for_states: + return operation_result + + lowered_wait_for_states = [w.lower() for w in wait_for_states] + 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_fusion_environment_admin_user_and_wait_for_state(self, create_fusion_environment_admin_user_details, fusion_environment_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.fusion_apps.FusionEnvironmentClient.create_fusion_environment_admin_user` and waits for the :py:class:`~oci.fusion_apps.models.WorkRequest` + to enter the given state(s). + + :param oci.fusion_apps.models.CreateFusionEnvironmentAdminUserDetails create_fusion_environment_admin_user_details: (required) + The admin user to be created. + + :param str fusion_environment_id: (required) + unique FusionEnvironment identifier + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.fusion_apps.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.fusion_apps.FusionEnvironmentClient.create_fusion_environment_admin_user` + + :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_fusion_environment_admin_user(create_fusion_environment_admin_user_details, fusion_environment_id, **operation_kwargs) + if not wait_for_states: + return operation_result + + lowered_wait_for_states = [w.lower() for w in wait_for_states] + 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_fusion_environment_and_wait_for_state(self, fusion_environment_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.fusion_apps.FusionEnvironmentClient.delete_fusion_environment` and waits for the :py:class:`~oci.fusion_apps.models.WorkRequest` + to enter the given state(s). + + :param str fusion_environment_id: (required) + unique FusionEnvironment identifier + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.fusion_apps.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.fusion_apps.FusionEnvironmentClient.delete_fusion_environment` + + :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_fusion_environment(fusion_environment_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] + 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_fusion_environment_admin_user_and_wait_for_state(self, admin_username, fusion_environment_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.fusion_apps.FusionEnvironmentClient.delete_fusion_environment_admin_user` and waits for the :py:class:`~oci.fusion_apps.models.WorkRequest` + to enter the given state(s). + + :param str admin_username: (required) + The admin user name for the fusion environment. + + :param str fusion_environment_id: (required) + unique FusionEnvironment identifier + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.fusion_apps.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.fusion_apps.FusionEnvironmentClient.delete_fusion_environment_admin_user` + + :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_fusion_environment_admin_user(admin_username, fusion_environment_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] + 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 reset_fusion_environment_password_and_wait_for_state(self, reset_fusion_environment_password_details, fusion_environment_id, admin_username, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.fusion_apps.FusionEnvironmentClient.reset_fusion_environment_password` and waits for the :py:class:`~oci.fusion_apps.models.WorkRequest` + to enter the given state(s). + + :param oci.fusion_apps.models.ResetFusionEnvironmentPasswordDetails reset_fusion_environment_password_details: (required) + The information to be updated. + + :param str fusion_environment_id: (required) + unique FusionEnvironment identifier + + :param str admin_username: (required) + The admin user name for the fusion environment. + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.fusion_apps.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.fusion_apps.FusionEnvironmentClient.reset_fusion_environment_password` + + :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.reset_fusion_environment_password(reset_fusion_environment_password_details, fusion_environment_id, admin_username, **operation_kwargs) + if not wait_for_states: + return operation_result + + lowered_wait_for_states = [w.lower() for w in wait_for_states] + 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_fusion_environment_and_wait_for_state(self, fusion_environment_id, update_fusion_environment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.fusion_apps.FusionEnvironmentClient.update_fusion_environment` and waits for the :py:class:`~oci.fusion_apps.models.WorkRequest` + to enter the given state(s). + + :param str fusion_environment_id: (required) + unique FusionEnvironment identifier + + :param oci.fusion_apps.models.UpdateFusionEnvironmentDetails update_fusion_environment_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.fusion_apps.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.fusion_apps.FusionEnvironmentClient.update_fusion_environment` + + :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_fusion_environment(fusion_environment_id, update_fusion_environment_details, **operation_kwargs) + if not wait_for_states: + return operation_result + + lowered_wait_for_states = [w.lower() for w in wait_for_states] + 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/fusion_apps/fusion_environment_family_client.py b/src/oci/fusion_apps/fusion_environment_family_client.py new file mode 100644 index 0000000000..31fa4364ef --- /dev/null +++ b/src/oci/fusion_apps/fusion_environment_family_client.py @@ -0,0 +1,943 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from __future__ import absolute_import + +from oci._vendor import requests # noqa: F401 +from oci._vendor import six + +from oci import retry, circuit_breaker # noqa: F401 +from oci.base_client import BaseClient +from oci.config import get_config_value_or_default, validate_config +from oci.signer import Signer +from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from .models import fusion_apps_type_mapping +missing = Sentinel("Missing") + + +class FusionEnvironmentFamilyClient(object): + """ + Use the Fusion Applications Environment Management API to manage the environments where your Fusion Applications run. For more information, see the [Fusion Applications Environment Management documentation](/iaas/Content/Identity/fusion-applications/home.htm). + """ + + def __init__(self, config, **kwargs): + """ + Creates a new service client + + :param dict config: + Configuration keys and values as per `SDK and Tool Configuration `__. + The :py:meth:`~oci.config.from_file` method can be used to load configuration from a file. Alternatively, a ``dict`` can be passed. You can validate_config + the dict using :py:meth:`~oci.config.validate_config` + + :param str service_endpoint: (optional) + The endpoint of the service to call using this client. For example ``https://iaas.us-ashburn-1.oraclecloud.com``. If this keyword argument is + not provided then it will be derived using the region in the config parameter. You should only provide this keyword argument if you have an explicit + need to specify a service endpoint. + + :param timeout: (optional) + The connection and read timeouts for the client. The default values are connection timeout 10 seconds and read timeout 60 seconds. This keyword argument can be provided + as a single float, in which case the value provided is used for both the read and connection timeouts, or as a tuple of two floats. If + a tuple is provided then the first value is used as the connection timeout and the second value as the read timeout. + :type timeout: float or tuple(float, float) + + :param signer: (optional) + The signer to use when signing requests made by the service client. The default is to use a :py:class:`~oci.signer.Signer` based on the values + provided in the config parameter. + + One use case for this parameter is for `Instance Principals authentication `__ + by passing an instance of :py:class:`~oci.auth.signers.InstancePrincipalsSecurityTokenSigner` as the value for this keyword argument + :type signer: :py:class:`~oci.signer.AbstractBaseSigner` + + :param obj retry_strategy: (optional) + A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. + Retry strategies can also be applied at the operation level by passing a ``retry_strategy`` keyword argument as part of calling the operation. + Any value provided at the operation level will override whatever is specified at the client level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` + is also available. The specifics of the default retry strategy are described `here `__. + + :param obj circuit_breaker_strategy: (optional) + A circuit breaker strategy to apply to all calls made by this service client (i.e. at the client level). + This client uses :py:data:`~oci.circuit_breaker.DEFAULT_CIRCUIT_BREAKER_STRATEGY` as default if no circuit breaker strategy is provided. + The specifics of circuit breaker strategy are described `here `__. + + :param function circuit_breaker_callback: (optional) + Callback function to receive any exceptions triggerred by the circuit breaker. + + :param allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not + allow control characters to be in the response object. + """ + validate_config(config, signer=kwargs.get('signer')) + if 'signer' in kwargs: + signer = kwargs['signer'] + + elif AUTHENTICATION_TYPE_FIELD_NAME in config: + signer = get_signer_from_authentication_type(config) + + else: + signer = Signer( + tenancy=config["tenancy"], + user=config["user"], + fingerprint=config["fingerprint"], + private_key_file_location=config.get("key_file"), + pass_phrase=get_config_value_or_default(config, "pass_phrase"), + private_key_content=config.get("key_content") + ) + + base_client_init_kwargs = { + 'regional_client': True, + 'service_endpoint': kwargs.get('service_endpoint'), + 'base_path': '/20211201', + 'service_endpoint_template': 'https://fusionapps.{region}.oci.{secondLevelDomain}', + 'skip_deserialization': kwargs.get('skip_deserialization', False), + 'circuit_breaker_strategy': kwargs.get('circuit_breaker_strategy', circuit_breaker.GLOBAL_CIRCUIT_BREAKER_STRATEGY) + } + if 'timeout' in kwargs: + base_client_init_kwargs['timeout'] = kwargs.get('timeout') + if base_client_init_kwargs.get('circuit_breaker_strategy') is None: + base_client_init_kwargs['circuit_breaker_strategy'] = circuit_breaker.DEFAULT_CIRCUIT_BREAKER_STRATEGY + if 'allow_control_chars' in kwargs: + base_client_init_kwargs['allow_control_chars'] = kwargs.get('allow_control_chars') + self.base_client = BaseClient("fusion_environment_family", config, signer, fusion_apps_type_mapping, **base_client_init_kwargs) + self.retry_strategy = kwargs.get('retry_strategy') + self.circuit_breaker_callback = kwargs.get('circuit_breaker_callback') + + def change_fusion_environment_family_compartment(self, fusion_environment_family_id, change_fusion_environment_family_compartment_details, **kwargs): + """ + Moves a FusionEnvironmentFamily into a different compartment. When provided, If-Match is checked against ETag + values of the resource. + + + :param str fusion_environment_family_id: (required) + The unique identifier (OCID) of the FusionEnvironmentFamily. + + :param oci.fusion_apps.models.ChangeFusionEnvironmentFamilyCompartmentDetails change_fusion_environment_family_compartment_details: (required) + Details for the compartment move. + + :param str if_match: (optional) + For optimistic concurrency control. In the PUT or DELETE call + for a resource, set the `if-match` parameter to the value of the + etag from a previous GET or POST response for that resource. + The resource will be updated or deleted only if the etag you + provide matches the resource's current etag value. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param str opc_retry_token: (optional) + A token that uniquely identifies a request so it can be retried in case of a timeout or + server error without risk of executing that same action again. Retry tokens expire after 24 + hours, but can be invalidated before then due to conflicting operations. For example, if a resource + has been deleted and purged from the system, then a retry of the original creation request + might be rejected. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + 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_fusion_environment_family_compartment API. + """ + resource_path = "/fusionEnvironmentFamilies/{fusionEnvironmentFamilyId}/actions/changeCompartment" + method = "POST" + operation_name = "change_fusion_environment_family_compartment" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "if_match", + "opc_request_id", + "opc_retry_token" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "change_fusion_environment_family_compartment got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "fusionEnvironmentFamilyId": fusion_environment_family_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "if-match": kwargs.get("if_match", missing), + "opc-request-id": kwargs.get("opc_request_id", missing), + "opc-retry-token": kwargs.get("opc_retry_token", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + 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_fusion_environment_family_compartment_details, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=change_fusion_environment_family_compartment_details, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def create_fusion_environment_family(self, create_fusion_environment_family_details, **kwargs): + """ + Creates a new FusionEnvironmentFamily. + + + :param oci.fusion_apps.models.CreateFusionEnvironmentFamilyDetails create_fusion_environment_family_details: (required) + Details for the new FusionEnvironmentFamily. + + :param str opc_provision_option: (optional) + For Oracle internal use only. + + :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) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use create_fusion_environment_family API. + """ + resource_path = "/fusionEnvironmentFamilies" + method = "POST" + operation_name = "create_fusion_environment_family" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_provision_option", + "opc_retry_token", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "create_fusion_environment_family got unknown kwargs: {!r}".format(extra_kwargs)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-provision-option": kwargs.get("opc_provision_option", 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: + 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_fusion_environment_family_details, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + header_params=header_params, + body=create_fusion_environment_family_details, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def delete_fusion_environment_family(self, fusion_environment_family_id, **kwargs): + """ + Deletes a FusionEnvironmentFamily resource by identifier + + + :param str fusion_environment_family_id: (required) + The unique identifier (OCID) of the FusionEnvironmentFamily. + + :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) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use delete_fusion_environment_family API. + """ + resource_path = "/fusionEnvironmentFamilies/{fusionEnvironmentFamilyId}" + method = "DELETE" + operation_name = "delete_fusion_environment_family" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "if_match", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "delete_fusion_environment_family got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "fusionEnvironmentFamilyId": fusion_environment_family_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "if-match": kwargs.get("if_match", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + 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) + 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) + + def get_fusion_environment_family(self, fusion_environment_family_id, **kwargs): + """ + Retrieves a fusion environment family identified by its OCID. + + + :param str fusion_environment_family_id: (required) + The unique identifier (OCID) of the FusionEnvironmentFamily. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.fusion_apps.models.FusionEnvironmentFamily` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_fusion_environment_family API. + """ + resource_path = "/fusionEnvironmentFamilies/{fusionEnvironmentFamilyId}" + method = "GET" + operation_name = "get_fusion_environment_family" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "get_fusion_environment_family got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "fusionEnvironmentFamilyId": fusion_environment_family_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="FusionEnvironmentFamily", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="FusionEnvironmentFamily", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def get_fusion_environment_family_limits_and_usage(self, fusion_environment_family_id, **kwargs): + """ + Gets the number of environments (usage) of each type in the fusion environment family, as well as the limit that's allowed to be created based on the group's associated subscriptions. + + + :param str fusion_environment_family_id: (required) + The unique identifier (OCID) of the FusionEnvironmentFamily. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.fusion_apps.models.FusionEnvironmentFamilyLimitsAndUsage` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_fusion_environment_family_limits_and_usage API. + """ + resource_path = "/fusionEnvironmentFamilies/{fusionEnvironmentFamilyId}/limitsAndUsage" + method = "GET" + operation_name = "get_fusion_environment_family_limits_and_usage" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "get_fusion_environment_family_limits_and_usage got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "fusionEnvironmentFamilyId": fusion_environment_family_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="FusionEnvironmentFamilyLimitsAndUsage", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="FusionEnvironmentFamilyLimitsAndUsage", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def get_fusion_environment_family_subscription_detail(self, fusion_environment_family_id, **kwargs): + """ + Gets the subscription details of an fusion environment family. + + + :param str fusion_environment_family_id: (required) + The unique identifier (OCID) of the FusionEnvironmentFamily. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.fusion_apps.models.SubscriptionDetail` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_fusion_environment_family_subscription_detail API. + """ + resource_path = "/fusionEnvironmentFamilies/{fusionEnvironmentFamilyId}/subscriptionDetails" + method = "GET" + operation_name = "get_fusion_environment_family_subscription_detail" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "get_fusion_environment_family_subscription_detail got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "fusionEnvironmentFamilyId": fusion_environment_family_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="SubscriptionDetail", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="SubscriptionDetail", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def list_fusion_environment_families(self, compartment_id, **kwargs): + """ + Returns a list of FusionEnvironmentFamilies. + + + :param str compartment_id: (required) + The ID of the compartment in which to list resources. + + :param str fusion_environment_family_id: (optional) + The ID of the fusion environment family in which to list resources. + + :param str display_name: (optional) + A filter to return only resources that match the entire display name given. + + :param str lifecycle_state: (optional) + A filter that returns all resources that match the specified lifecycle state. + + Allowed values are: "CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED" + + :param int limit: (optional) + The maximum number of items to return. + + :param str page: (optional) + The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. + + :param str sort_order: (optional) + The sort order to use, either 'asc' or 'desc'. + + Allowed values are: "ASC", "DESC" + + :param str sort_by: (optional) + The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. + + Allowed values are: "TIME_CREATED", "DISPLAY_NAME" + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.fusion_apps.models.FusionEnvironmentFamilyCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_fusion_environment_families API. + """ + resource_path = "/fusionEnvironmentFamilies" + method = "GET" + operation_name = "list_fusion_environment_families" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "fusion_environment_family_id", + "display_name", + "lifecycle_state", + "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( + "list_fusion_environment_families got unknown kwargs: {!r}".format(extra_kwargs)) + + if 'lifecycle_state' in kwargs: + lifecycle_state_allowed_values = ["CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED"] + if kwargs['lifecycle_state'] not in lifecycle_state_allowed_values: + raise ValueError( + "Invalid value for `lifecycle_state`, must be one of {0}".format(lifecycle_state_allowed_values) + ) + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + "Invalid value for `sort_order`, must be one of {0}".format(sort_order_allowed_values) + ) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["TIME_CREATED", "DISPLAY_NAME"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) + ) + + query_params = { + "fusionEnvironmentFamilyId": kwargs.get("fusion_environment_family_id", missing), + "compartmentId": compartment_id, + "displayName": kwargs.get("display_name", missing), + "lifecycleState": kwargs.get("lifecycle_state", 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: + 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="FusionEnvironmentFamilyCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + query_params=query_params, + header_params=header_params, + response_type="FusionEnvironmentFamilyCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def update_fusion_environment_family(self, fusion_environment_family_id, update_fusion_environment_family_details, **kwargs): + """ + Updates the FusionEnvironmentFamily + + + :param str fusion_environment_family_id: (required) + The unique identifier (OCID) of the FusionEnvironmentFamily. + + :param oci.fusion_apps.models.UpdateFusionEnvironmentFamilyDetails update_fusion_environment_family_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 will be updated or deleted only if the etag you + provide matches the resource's current etag value. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use update_fusion_environment_family API. + """ + resource_path = "/fusionEnvironmentFamilies/{fusionEnvironmentFamilyId}" + method = "PUT" + operation_name = "update_fusion_environment_family" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "if_match", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "update_fusion_environment_family got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "fusionEnvironmentFamilyId": fusion_environment_family_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "if-match": kwargs.get("if_match", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + 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_fusion_environment_family_details, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=update_fusion_environment_family_details, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) diff --git a/src/oci/fusion_apps/fusion_environment_family_client_composite_operations.py b/src/oci/fusion_apps/fusion_environment_family_client_composite_operations.py new file mode 100644 index 0000000000..5e880a0736 --- /dev/null +++ b/src/oci/fusion_apps/fusion_environment_family_client_composite_operations.py @@ -0,0 +1,190 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, 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. + +import oci # noqa: F401 +from oci.util import WAIT_RESOURCE_NOT_FOUND # noqa: F401 + + +class FusionEnvironmentFamilyClientCompositeOperations(object): + """ + This class provides a wrapper around :py:class:`~oci.fusion_apps.FusionEnvironmentFamilyClient` and offers convenience methods + for operations that would otherwise need to be chained together. For example, instead of performing an action + on a resource (e.g. launching an instance, creating a load balancer) and then using a waiter to wait for the resource + to enter a given state, you can call a single method in this class to accomplish the same functionality + """ + + def __init__(self, client, **kwargs): + """ + Creates a new FusionEnvironmentFamilyClientCompositeOperations object + + :param FusionEnvironmentFamilyClient client: + The service client which will be wrapped by this object + """ + self.client = client + + def change_fusion_environment_family_compartment_and_wait_for_state(self, fusion_environment_family_id, change_fusion_environment_family_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.fusion_apps.FusionEnvironmentFamilyClient.change_fusion_environment_family_compartment` and waits for the :py:class:`~oci.fusion_apps.models.WorkRequest` + to enter the given state(s). + + :param str fusion_environment_family_id: (required) + The unique identifier (OCID) of the FusionEnvironmentFamily. + + :param oci.fusion_apps.models.ChangeFusionEnvironmentFamilyCompartmentDetails change_fusion_environment_family_compartment_details: (required) + Details for the compartment move. + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.fusion_apps.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.fusion_apps.FusionEnvironmentFamilyClient.change_fusion_environment_family_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_fusion_environment_family_compartment(fusion_environment_family_id, change_fusion_environment_family_compartment_details, **operation_kwargs) + if not wait_for_states: + return operation_result + + lowered_wait_for_states = [w.lower() for w in wait_for_states] + 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_fusion_environment_family_and_wait_for_state(self, create_fusion_environment_family_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.fusion_apps.FusionEnvironmentFamilyClient.create_fusion_environment_family` and waits for the :py:class:`~oci.fusion_apps.models.WorkRequest` + to enter the given state(s). + + :param oci.fusion_apps.models.CreateFusionEnvironmentFamilyDetails create_fusion_environment_family_details: (required) + Details for the new FusionEnvironmentFamily. + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.fusion_apps.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.fusion_apps.FusionEnvironmentFamilyClient.create_fusion_environment_family` + + :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_fusion_environment_family(create_fusion_environment_family_details, **operation_kwargs) + if not wait_for_states: + return operation_result + + lowered_wait_for_states = [w.lower() for w in wait_for_states] + 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_fusion_environment_family_and_wait_for_state(self, fusion_environment_family_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.fusion_apps.FusionEnvironmentFamilyClient.delete_fusion_environment_family` and waits for the :py:class:`~oci.fusion_apps.models.WorkRequest` + to enter the given state(s). + + :param str fusion_environment_family_id: (required) + The unique identifier (OCID) of the FusionEnvironmentFamily. + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.fusion_apps.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.fusion_apps.FusionEnvironmentFamilyClient.delete_fusion_environment_family` + + :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_fusion_environment_family(fusion_environment_family_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] + 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_fusion_environment_family_and_wait_for_state(self, fusion_environment_family_id, update_fusion_environment_family_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.fusion_apps.FusionEnvironmentFamilyClient.update_fusion_environment_family` and waits for the :py:class:`~oci.fusion_apps.models.WorkRequest` + to enter the given state(s). + + :param str fusion_environment_family_id: (required) + The unique identifier (OCID) of the FusionEnvironmentFamily. + + :param oci.fusion_apps.models.UpdateFusionEnvironmentFamilyDetails update_fusion_environment_family_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.fusion_apps.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.fusion_apps.FusionEnvironmentFamilyClient.update_fusion_environment_family` + + :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_fusion_environment_family(fusion_environment_family_id, update_fusion_environment_family_details, **operation_kwargs) + if not wait_for_states: + return operation_result + + lowered_wait_for_states = [w.lower() for w in wait_for_states] + 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/fusion_apps/models/__init__.py b/src/oci/fusion_apps/models/__init__.py new file mode 100644 index 0000000000..b8cc0b2948 --- /dev/null +++ b/src/oci/fusion_apps/models/__init__.py @@ -0,0 +1,154 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from __future__ import absolute_import + +from .action import Action +from .admin_user_collection import AdminUserCollection +from .admin_user_summary import AdminUserSummary +from .allow_rule import AllowRule +from .attach_existing_instance_details import AttachExistingInstanceDetails +from .capabilities import Capabilities +from .change_fusion_environment_compartment_details import ChangeFusionEnvironmentCompartmentDetails +from .change_fusion_environment_family_compartment_details import ChangeFusionEnvironmentFamilyCompartmentDetails +from .create_data_masking_activity_details import CreateDataMaskingActivityDetails +from .create_fusion_environment_admin_user_details import CreateFusionEnvironmentAdminUserDetails +from .create_fusion_environment_details import CreateFusionEnvironmentDetails +from .create_fusion_environment_family_details import CreateFusionEnvironmentFamilyDetails +from .create_new_instance_details import CreateNewInstanceDetails +from .create_oax_service_instance_details import CreateOaxServiceInstanceDetails +from .create_oic_service_instance_details import CreateOicServiceInstanceDetails +from .create_refresh_activity_details import CreateRefreshActivityDetails +from .create_service_attachment_details import CreateServiceAttachmentDetails +from .create_service_instance_details import CreateServiceInstanceDetails +from .data_masking_activity import DataMaskingActivity +from .data_masking_activity_collection import DataMaskingActivityCollection +from .data_masking_activity_summary import DataMaskingActivitySummary +from .family_maintenance_policy import FamilyMaintenancePolicy +from .faw_admin_info_details import FawAdminInfoDetails +from .fusion_environment import FusionEnvironment +from .fusion_environment_collection import FusionEnvironmentCollection +from .fusion_environment_family import FusionEnvironmentFamily +from .fusion_environment_family_collection import FusionEnvironmentFamilyCollection +from .fusion_environment_family_limits_and_usage import FusionEnvironmentFamilyLimitsAndUsage +from .fusion_environment_family_summary import FusionEnvironmentFamilySummary +from .fusion_environment_status import FusionEnvironmentStatus +from .fusion_environment_summary import FusionEnvironmentSummary +from .get_maintenance_policy_details import GetMaintenancePolicyDetails +from .kms_key_info import KmsKeyInfo +from .limit_and_usage import LimitAndUsage +from .maintenance_policy import MaintenancePolicy +from .patch_action import PatchAction +from .quarterly_upgrade_begin_times import QuarterlyUpgradeBeginTimes +from .refresh_activity import RefreshActivity +from .refresh_activity_collection import RefreshActivityCollection +from .refresh_activity_summary import RefreshActivitySummary +from .refresh_details import RefreshDetails +from .reset_fusion_environment_password_details import ResetFusionEnvironmentPasswordDetails +from .rule import Rule +from .rule_condition import RuleCondition +from .scheduled_activity import ScheduledActivity +from .scheduled_activity_collection import ScheduledActivityCollection +from .scheduled_activity_summary import ScheduledActivitySummary +from .service_attachment import ServiceAttachment +from .service_attachment_collection import ServiceAttachmentCollection +from .service_attachment_summary import ServiceAttachmentSummary +from .source_ip_address_condition import SourceIpAddressCondition +from .source_vcn_id_condition import SourceVcnIdCondition +from .source_vcn_ip_address_condition import SourceVcnIpAddressCondition +from .subscription import Subscription +from .subscription_detail import SubscriptionDetail +from .subscription_sku import SubscriptionSku +from .time_available_for_refresh import TimeAvailableForRefresh +from .time_available_for_refresh_collection import TimeAvailableForRefreshCollection +from .time_available_for_refresh_summary import TimeAvailableForRefreshSummary +from .update_family_maintenance_policy_details import UpdateFamilyMaintenancePolicyDetails +from .update_fusion_environment_details import UpdateFusionEnvironmentDetails +from .update_fusion_environment_family_details import UpdateFusionEnvironmentFamilyDetails +from .upgrade_action import UpgradeAction +from .vertex_action import VertexAction +from .work_request import WorkRequest +from .work_request_error import WorkRequestError +from .work_request_error_collection import WorkRequestErrorCollection +from .work_request_log_entry import WorkRequestLogEntry +from .work_request_log_entry_collection import WorkRequestLogEntryCollection +from .work_request_resource import WorkRequestResource +from .work_request_summary import WorkRequestSummary +from .work_request_summary_collection import WorkRequestSummaryCollection + +# Maps type names to classes for fusion_apps services. +fusion_apps_type_mapping = { + "Action": Action, + "AdminUserCollection": AdminUserCollection, + "AdminUserSummary": AdminUserSummary, + "AllowRule": AllowRule, + "AttachExistingInstanceDetails": AttachExistingInstanceDetails, + "Capabilities": Capabilities, + "ChangeFusionEnvironmentCompartmentDetails": ChangeFusionEnvironmentCompartmentDetails, + "ChangeFusionEnvironmentFamilyCompartmentDetails": ChangeFusionEnvironmentFamilyCompartmentDetails, + "CreateDataMaskingActivityDetails": CreateDataMaskingActivityDetails, + "CreateFusionEnvironmentAdminUserDetails": CreateFusionEnvironmentAdminUserDetails, + "CreateFusionEnvironmentDetails": CreateFusionEnvironmentDetails, + "CreateFusionEnvironmentFamilyDetails": CreateFusionEnvironmentFamilyDetails, + "CreateNewInstanceDetails": CreateNewInstanceDetails, + "CreateOaxServiceInstanceDetails": CreateOaxServiceInstanceDetails, + "CreateOicServiceInstanceDetails": CreateOicServiceInstanceDetails, + "CreateRefreshActivityDetails": CreateRefreshActivityDetails, + "CreateServiceAttachmentDetails": CreateServiceAttachmentDetails, + "CreateServiceInstanceDetails": CreateServiceInstanceDetails, + "DataMaskingActivity": DataMaskingActivity, + "DataMaskingActivityCollection": DataMaskingActivityCollection, + "DataMaskingActivitySummary": DataMaskingActivitySummary, + "FamilyMaintenancePolicy": FamilyMaintenancePolicy, + "FawAdminInfoDetails": FawAdminInfoDetails, + "FusionEnvironment": FusionEnvironment, + "FusionEnvironmentCollection": FusionEnvironmentCollection, + "FusionEnvironmentFamily": FusionEnvironmentFamily, + "FusionEnvironmentFamilyCollection": FusionEnvironmentFamilyCollection, + "FusionEnvironmentFamilyLimitsAndUsage": FusionEnvironmentFamilyLimitsAndUsage, + "FusionEnvironmentFamilySummary": FusionEnvironmentFamilySummary, + "FusionEnvironmentStatus": FusionEnvironmentStatus, + "FusionEnvironmentSummary": FusionEnvironmentSummary, + "GetMaintenancePolicyDetails": GetMaintenancePolicyDetails, + "KmsKeyInfo": KmsKeyInfo, + "LimitAndUsage": LimitAndUsage, + "MaintenancePolicy": MaintenancePolicy, + "PatchAction": PatchAction, + "QuarterlyUpgradeBeginTimes": QuarterlyUpgradeBeginTimes, + "RefreshActivity": RefreshActivity, + "RefreshActivityCollection": RefreshActivityCollection, + "RefreshActivitySummary": RefreshActivitySummary, + "RefreshDetails": RefreshDetails, + "ResetFusionEnvironmentPasswordDetails": ResetFusionEnvironmentPasswordDetails, + "Rule": Rule, + "RuleCondition": RuleCondition, + "ScheduledActivity": ScheduledActivity, + "ScheduledActivityCollection": ScheduledActivityCollection, + "ScheduledActivitySummary": ScheduledActivitySummary, + "ServiceAttachment": ServiceAttachment, + "ServiceAttachmentCollection": ServiceAttachmentCollection, + "ServiceAttachmentSummary": ServiceAttachmentSummary, + "SourceIpAddressCondition": SourceIpAddressCondition, + "SourceVcnIdCondition": SourceVcnIdCondition, + "SourceVcnIpAddressCondition": SourceVcnIpAddressCondition, + "Subscription": Subscription, + "SubscriptionDetail": SubscriptionDetail, + "SubscriptionSku": SubscriptionSku, + "TimeAvailableForRefresh": TimeAvailableForRefresh, + "TimeAvailableForRefreshCollection": TimeAvailableForRefreshCollection, + "TimeAvailableForRefreshSummary": TimeAvailableForRefreshSummary, + "UpdateFamilyMaintenancePolicyDetails": UpdateFamilyMaintenancePolicyDetails, + "UpdateFusionEnvironmentDetails": UpdateFusionEnvironmentDetails, + "UpdateFusionEnvironmentFamilyDetails": UpdateFusionEnvironmentFamilyDetails, + "UpgradeAction": UpgradeAction, + "VertexAction": VertexAction, + "WorkRequest": WorkRequest, + "WorkRequestError": WorkRequestError, + "WorkRequestErrorCollection": WorkRequestErrorCollection, + "WorkRequestLogEntry": WorkRequestLogEntry, + "WorkRequestLogEntryCollection": WorkRequestLogEntryCollection, + "WorkRequestResource": WorkRequestResource, + "WorkRequestSummary": WorkRequestSummary, + "WorkRequestSummaryCollection": WorkRequestSummaryCollection +} diff --git a/src/oci/fusion_apps/models/action.py b/src/oci/fusion_apps/models/action.py new file mode 100644 index 0000000000..1045667f57 --- /dev/null +++ b/src/oci/fusion_apps/models/action.py @@ -0,0 +1,236 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 Action(object): + """ + Action details + """ + + #: A constant which can be used with the action_type property of a Action. + #: This constant has a value of "QUARTERLY_UPGRADE" + ACTION_TYPE_QUARTERLY_UPGRADE = "QUARTERLY_UPGRADE" + + #: A constant which can be used with the action_type property of a Action. + #: This constant has a value of "PATCH" + ACTION_TYPE_PATCH = "PATCH" + + #: A constant which can be used with the action_type property of a Action. + #: This constant has a value of "VERTEX" + ACTION_TYPE_VERTEX = "VERTEX" + + #: A constant which can be used with the state property of a Action. + #: This constant has a value of "ACCEPTED" + STATE_ACCEPTED = "ACCEPTED" + + #: A constant which can be used with the state property of a Action. + #: This constant has a value of "IN_PROGRESS" + STATE_IN_PROGRESS = "IN_PROGRESS" + + #: A constant which can be used with the state property of a Action. + #: This constant has a value of "SUCCEEDED" + STATE_SUCCEEDED = "SUCCEEDED" + + #: A constant which can be used with the state property of a Action. + #: This constant has a value of "FAILED" + STATE_FAILED = "FAILED" + + #: A constant which can be used with the state property of a Action. + #: This constant has a value of "CANCELED" + STATE_CANCELED = "CANCELED" + + def __init__(self, **kwargs): + """ + Initializes a new Action 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.fusion_apps.models.PatchAction` + * :class:`~oci.fusion_apps.models.UpgradeAction` + * :class:`~oci.fusion_apps.models.VertexAction` + + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param reference_key: + The value to assign to the reference_key property of this Action. + :type reference_key: str + + :param action_type: + The value to assign to the action_type property of this Action. + Allowed values for this property are: "QUARTERLY_UPGRADE", "PATCH", "VERTEX", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type action_type: str + + :param state: + The value to assign to the state property of this Action. + Allowed values for this property are: "ACCEPTED", "IN_PROGRESS", "SUCCEEDED", "FAILED", "CANCELED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type state: str + + :param description: + The value to assign to the description property of this Action. + :type description: str + + """ + self.swagger_types = { + 'reference_key': 'str', + 'action_type': 'str', + 'state': 'str', + 'description': 'str' + } + + self.attribute_map = { + 'reference_key': 'referenceKey', + 'action_type': 'actionType', + 'state': 'state', + 'description': 'description' + } + + self._reference_key = None + self._action_type = None + self._state = None + self._description = 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 == 'PATCH': + return 'PatchAction' + + if type == 'QUARTERLY_UPGRADE': + return 'UpgradeAction' + + if type == 'VERTEX': + return 'VertexAction' + else: + return 'Action' + + @property + def reference_key(self): + """ + Gets the reference_key of this Action. + Unique identifier of the object that represents the action + + + :return: The reference_key of this Action. + :rtype: str + """ + return self._reference_key + + @reference_key.setter + def reference_key(self, reference_key): + """ + Sets the reference_key of this Action. + Unique identifier of the object that represents the action + + + :param reference_key: The reference_key of this Action. + :type: str + """ + self._reference_key = reference_key + + @property + def action_type(self): + """ + **[Required]** Gets the action_type of this Action. + Type of action + + Allowed values for this property are: "QUARTERLY_UPGRADE", "PATCH", "VERTEX", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The action_type of this Action. + :rtype: str + """ + return self._action_type + + @action_type.setter + def action_type(self, action_type): + """ + Sets the action_type of this Action. + Type of action + + + :param action_type: The action_type of this Action. + :type: str + """ + allowed_values = ["QUARTERLY_UPGRADE", "PATCH", "VERTEX"] + if not value_allowed_none_or_none_sentinel(action_type, allowed_values): + action_type = 'UNKNOWN_ENUM_VALUE' + self._action_type = action_type + + @property + def state(self): + """ + Gets the state of this Action. + A string that describes whether the change is applied hot or cold + + Allowed values for this property are: "ACCEPTED", "IN_PROGRESS", "SUCCEEDED", "FAILED", "CANCELED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The state of this Action. + :rtype: str + """ + return self._state + + @state.setter + def state(self, state): + """ + Sets the state of this Action. + A string that describes whether the change is applied hot or cold + + + :param state: The state of this Action. + :type: str + """ + allowed_values = ["ACCEPTED", "IN_PROGRESS", "SUCCEEDED", "FAILED", "CANCELED"] + if not value_allowed_none_or_none_sentinel(state, allowed_values): + state = 'UNKNOWN_ENUM_VALUE' + self._state = state + + @property + def description(self): + """ + **[Required]** Gets the description of this Action. + A string that describes the details of the action. It does not have to be unique, and you can change it. Avoid entering confidential information. + + + :return: The description of this Action. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this Action. + A string that describes the details of the action. It does not have to be unique, and you can change it. Avoid entering confidential information. + + + :param description: The description of this Action. + :type: str + """ + self._description = description + + 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/fusion_apps/models/admin_user_collection.py b/src/oci/fusion_apps/models/admin_user_collection.py new file mode 100644 index 0000000000..a0a92c835a --- /dev/null +++ b/src/oci/fusion_apps/models/admin_user_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 AdminUserCollection(object): + """ + IDM admin credentials without password + """ + + def __init__(self, **kwargs): + """ + Initializes a new AdminUserCollection 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 AdminUserCollection. + :type items: list[oci.fusion_apps.models.AdminUserSummary] + + """ + self.swagger_types = { + 'items': 'list[AdminUserSummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this AdminUserCollection. + A page of AdminUserSummary objects. + + + :return: The items of this AdminUserCollection. + :rtype: list[oci.fusion_apps.models.AdminUserSummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this AdminUserCollection. + A page of AdminUserSummary objects. + + + :param items: The items of this AdminUserCollection. + :type: list[oci.fusion_apps.models.AdminUserSummary] + """ + 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/fusion_apps/models/admin_user_summary.py b/src/oci/fusion_apps/models/admin_user_summary.py new file mode 100644 index 0000000000..8caf63e739 --- /dev/null +++ b/src/oci/fusion_apps/models/admin_user_summary.py @@ -0,0 +1,163 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 AdminUserSummary(object): + """ + IDM admin credentials without password + """ + + def __init__(self, **kwargs): + """ + Initializes a new AdminUserSummary object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param username: + The value to assign to the username property of this AdminUserSummary. + :type username: str + + :param email_address: + The value to assign to the email_address property of this AdminUserSummary. + :type email_address: str + + :param first_name: + The value to assign to the first_name property of this AdminUserSummary. + :type first_name: str + + :param last_name: + The value to assign to the last_name property of this AdminUserSummary. + :type last_name: str + + """ + self.swagger_types = { + 'username': 'str', + 'email_address': 'str', + 'first_name': 'str', + 'last_name': 'str' + } + + self.attribute_map = { + 'username': 'username', + 'email_address': 'emailAddress', + 'first_name': 'firstName', + 'last_name': 'lastName' + } + + self._username = None + self._email_address = None + self._first_name = None + self._last_name = None + + @property + def username(self): + """ + **[Required]** Gets the username of this AdminUserSummary. + Admin username + + + :return: The username of this AdminUserSummary. + :rtype: str + """ + return self._username + + @username.setter + def username(self, username): + """ + Sets the username of this AdminUserSummary. + Admin username + + + :param username: The username of this AdminUserSummary. + :type: str + """ + self._username = username + + @property + def email_address(self): + """ + **[Required]** Gets the email_address of this AdminUserSummary. + Admin users email address + + + :return: The email_address of this AdminUserSummary. + :rtype: str + """ + return self._email_address + + @email_address.setter + def email_address(self, email_address): + """ + Sets the email_address of this AdminUserSummary. + Admin users email address + + + :param email_address: The email_address of this AdminUserSummary. + :type: str + """ + self._email_address = email_address + + @property + def first_name(self): + """ + **[Required]** Gets the first_name of this AdminUserSummary. + Admin users first name + + + :return: The first_name of this AdminUserSummary. + :rtype: str + """ + return self._first_name + + @first_name.setter + def first_name(self, first_name): + """ + Sets the first_name of this AdminUserSummary. + Admin users first name + + + :param first_name: The first_name of this AdminUserSummary. + :type: str + """ + self._first_name = first_name + + @property + def last_name(self): + """ + **[Required]** Gets the last_name of this AdminUserSummary. + Admin users last name + + + :return: The last_name of this AdminUserSummary. + :rtype: str + """ + return self._last_name + + @last_name.setter + def last_name(self, last_name): + """ + Sets the last_name of this AdminUserSummary. + Admin users last name + + + :param last_name: The last_name of this AdminUserSummary. + :type: str + """ + self._last_name = last_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/fusion_apps/models/allow_rule.py b/src/oci/fusion_apps/models/allow_rule.py new file mode 100644 index 0000000000..07158b9d16 --- /dev/null +++ b/src/oci/fusion_apps/models/allow_rule.py @@ -0,0 +1,118 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .rule import Rule +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 AllowRule(Rule): + """ + An object that represents the action of configuring an access control rule. Access control rules permit access + to application resources based on user-specified match conditions. This rule applies only to HTTP listeners. + **NOTES:** + * If you do not specify any access control rules, the default rule is to allow all traffic. + * If you add access control rules, the load balancer denies any traffic that does not match the rules. + * Maximum of two match conditions can be specified in a rule. + * You can specify this rule only with the following `RuleCondition` combinations: + * `SOURCE_IP_ADDRESS` + * `SOURCE_VCN_ID` + * `SOURCE_VCN_ID\", \"SOURCE_VCN_IP_ADDRESS` + """ + + def __init__(self, **kwargs): + """ + Initializes a new AllowRule object with values from keyword arguments. The default value of the :py:attr:`~oci.fusion_apps.models.AllowRule.action` attribute + of this class is ``ALLOW`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param action: + The value to assign to the action property of this AllowRule. + Allowed values for this property are: "ALLOW" + :type action: str + + :param conditions: + The value to assign to the conditions property of this AllowRule. + :type conditions: list[oci.fusion_apps.models.RuleCondition] + + :param description: + The value to assign to the description property of this AllowRule. + :type description: str + + """ + self.swagger_types = { + 'action': 'str', + 'conditions': 'list[RuleCondition]', + 'description': 'str' + } + + self.attribute_map = { + 'action': 'action', + 'conditions': 'conditions', + 'description': 'description' + } + + self._action = None + self._conditions = None + self._description = None + self._action = 'ALLOW' + + @property + def conditions(self): + """ + **[Required]** Gets the conditions of this AllowRule. + + :return: The conditions of this AllowRule. + :rtype: list[oci.fusion_apps.models.RuleCondition] + """ + return self._conditions + + @conditions.setter + def conditions(self, conditions): + """ + Sets the conditions of this AllowRule. + + :param conditions: The conditions of this AllowRule. + :type: list[oci.fusion_apps.models.RuleCondition] + """ + self._conditions = conditions + + @property + def description(self): + """ + Gets the description of this AllowRule. + A brief description of the access control rule. Avoid entering confidential information. + example: `192.168.0.0/16 and 2001:db8::/32 are trusted clients. Whitelist them.` + + + :return: The description of this AllowRule. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this AllowRule. + A brief description of the access control rule. Avoid entering confidential information. + example: `192.168.0.0/16 and 2001:db8::/32 are trusted clients. Whitelist them.` + + + :param description: The description of this AllowRule. + :type: str + """ + self._description = description + + 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/fusion_apps/models/attach_existing_instance_details.py b/src/oci/fusion_apps/models/attach_existing_instance_details.py new file mode 100644 index 0000000000..a1e039eff2 --- /dev/null +++ b/src/oci/fusion_apps/models/attach_existing_instance_details.py @@ -0,0 +1,194 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .create_service_attachment_details import CreateServiceAttachmentDetails +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 AttachExistingInstanceDetails(CreateServiceAttachmentDetails): + """ + Information about the service attachment. + """ + + #: A constant which can be used with the service_instance_type property of a AttachExistingInstanceDetails. + #: This constant has a value of "INTEGRATION_CLOUD" + SERVICE_INSTANCE_TYPE_INTEGRATION_CLOUD = "INTEGRATION_CLOUD" + + #: A constant which can be used with the service_instance_type property of a AttachExistingInstanceDetails. + #: This constant has a value of "ANALYTICS_WAREHOUSE" + SERVICE_INSTANCE_TYPE_ANALYTICS_WAREHOUSE = "ANALYTICS_WAREHOUSE" + + def __init__(self, **kwargs): + """ + Initializes a new AttachExistingInstanceDetails object with values from keyword arguments. The default value of the :py:attr:`~oci.fusion_apps.models.AttachExistingInstanceDetails.action` attribute + of this class is ``ATTACH_EXISTING_INSTANCE`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param action: + The value to assign to the action property of this AttachExistingInstanceDetails. + Allowed values for this property are: "CREATE_NEW_INSTANCE", "ATTACH_EXISTING_INSTANCE" + :type action: str + + :param service_instance_type: + The value to assign to the service_instance_type property of this AttachExistingInstanceDetails. + Allowed values for this property are: "INTEGRATION_CLOUD", "ANALYTICS_WAREHOUSE" + :type service_instance_type: str + + :param instance_id: + The value to assign to the instance_id property of this AttachExistingInstanceDetails. + :type instance_id: str + + :param freeform_tags: + The value to assign to the freeform_tags property of this AttachExistingInstanceDetails. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this AttachExistingInstanceDetails. + :type defined_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'action': 'str', + 'service_instance_type': 'str', + 'instance_id': 'str', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))' + } + + self.attribute_map = { + 'action': 'action', + 'service_instance_type': 'serviceInstanceType', + 'instance_id': 'instanceId', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags' + } + + self._action = None + self._service_instance_type = None + self._instance_id = None + self._freeform_tags = None + self._defined_tags = None + self._action = 'ATTACH_EXISTING_INSTANCE' + + @property + def service_instance_type(self): + """ + Gets the service_instance_type of this AttachExistingInstanceDetails. + Type of the ServiceInstance being attached. + + Allowed values for this property are: "INTEGRATION_CLOUD", "ANALYTICS_WAREHOUSE" + + + :return: The service_instance_type of this AttachExistingInstanceDetails. + :rtype: str + """ + return self._service_instance_type + + @service_instance_type.setter + def service_instance_type(self, service_instance_type): + """ + Sets the service_instance_type of this AttachExistingInstanceDetails. + Type of the ServiceInstance being attached. + + + :param service_instance_type: The service_instance_type of this AttachExistingInstanceDetails. + :type: str + """ + allowed_values = ["INTEGRATION_CLOUD", "ANALYTICS_WAREHOUSE"] + if not value_allowed_none_or_none_sentinel(service_instance_type, allowed_values): + raise ValueError( + "Invalid value for `service_instance_type`, must be None or one of {0}" + .format(allowed_values) + ) + self._service_instance_type = service_instance_type + + @property + def instance_id(self): + """ + Gets the instance_id of this AttachExistingInstanceDetails. + The service instance OCID of the instance being attached + + + :return: The instance_id of this AttachExistingInstanceDetails. + :rtype: str + """ + return self._instance_id + + @instance_id.setter + def instance_id(self, instance_id): + """ + Sets the instance_id of this AttachExistingInstanceDetails. + The service instance OCID of the instance being attached + + + :param instance_id: The instance_id of this AttachExistingInstanceDetails. + :type: str + """ + self._instance_id = instance_id + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this AttachExistingInstanceDetails. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :return: The freeform_tags of this AttachExistingInstanceDetails. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this AttachExistingInstanceDetails. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :param freeform_tags: The freeform_tags of this AttachExistingInstanceDetails. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this AttachExistingInstanceDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this AttachExistingInstanceDetails. + :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 AttachExistingInstanceDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this AttachExistingInstanceDetails. + :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/fusion_apps/models/capabilities.py b/src/oci/fusion_apps/models/capabilities.py new file mode 100644 index 0000000000..8ee9b5bc74 --- /dev/null +++ b/src/oci/fusion_apps/models/capabilities.py @@ -0,0 +1,132 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 Capabilities(object): + """ + Status of capabilities that can be enabled for an environment family. + """ + + def __init__(self, **kwargs): + """ + Initializes a new Capabilities object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param is_data_masking_enabled: + The value to assign to the is_data_masking_enabled property of this Capabilities. + :type is_data_masking_enabled: bool + + :param is_break_glass_enabled: + The value to assign to the is_break_glass_enabled property of this Capabilities. + :type is_break_glass_enabled: bool + + :param is_byok_enabled: + The value to assign to the is_byok_enabled property of this Capabilities. + :type is_byok_enabled: bool + + """ + self.swagger_types = { + 'is_data_masking_enabled': 'bool', + 'is_break_glass_enabled': 'bool', + 'is_byok_enabled': 'bool' + } + + self.attribute_map = { + 'is_data_masking_enabled': 'isDataMaskingEnabled', + 'is_break_glass_enabled': 'isBreakGlassEnabled', + 'is_byok_enabled': 'isByokEnabled' + } + + self._is_data_masking_enabled = None + self._is_break_glass_enabled = None + self._is_byok_enabled = None + + @property + def is_data_masking_enabled(self): + """ + Gets the is_data_masking_enabled of this Capabilities. + Indicates whether data masking is enabled for the environment family. When enabled, data masking activities are supported. + + + :return: The is_data_masking_enabled of this Capabilities. + :rtype: bool + """ + return self._is_data_masking_enabled + + @is_data_masking_enabled.setter + def is_data_masking_enabled(self, is_data_masking_enabled): + """ + Sets the is_data_masking_enabled of this Capabilities. + Indicates whether data masking is enabled for the environment family. When enabled, data masking activities are supported. + + + :param is_data_masking_enabled: The is_data_masking_enabled of this Capabilities. + :type: bool + """ + self._is_data_masking_enabled = is_data_masking_enabled + + @property + def is_break_glass_enabled(self): + """ + Gets the is_break_glass_enabled of this Capabilities. + Indicates whether Break Glass is enabled for the environment family. + + + :return: The is_break_glass_enabled of this Capabilities. + :rtype: bool + """ + return self._is_break_glass_enabled + + @is_break_glass_enabled.setter + def is_break_glass_enabled(self, is_break_glass_enabled): + """ + Sets the is_break_glass_enabled of this Capabilities. + Indicates whether Break Glass is enabled for the environment family. + + + :param is_break_glass_enabled: The is_break_glass_enabled of this Capabilities. + :type: bool + """ + self._is_break_glass_enabled = is_break_glass_enabled + + @property + def is_byok_enabled(self): + """ + Gets the is_byok_enabled of this Capabilities. + Indicates whether customers can use their own encryption keys. + + + :return: The is_byok_enabled of this Capabilities. + :rtype: bool + """ + return self._is_byok_enabled + + @is_byok_enabled.setter + def is_byok_enabled(self, is_byok_enabled): + """ + Sets the is_byok_enabled of this Capabilities. + Indicates whether customers can use their own encryption keys. + + + :param is_byok_enabled: The is_byok_enabled of this Capabilities. + :type: bool + """ + self._is_byok_enabled = is_byok_enabled + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/fusion_apps/models/change_fusion_environment_compartment_details.py b/src/oci/fusion_apps/models/change_fusion_environment_compartment_details.py new file mode 100644 index 0000000000..984c10926d --- /dev/null +++ b/src/oci/fusion_apps/models/change_fusion_environment_compartment_details.py @@ -0,0 +1,74 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 ChangeFusionEnvironmentCompartmentDetails(object): + """ + Details about the compartment the Fusion environment should move to. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ChangeFusionEnvironmentCompartmentDetails 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 ChangeFusionEnvironmentCompartmentDetails. + :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 ChangeFusionEnvironmentCompartmentDetails. + 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 ChangeFusionEnvironmentCompartmentDetails. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this ChangeFusionEnvironmentCompartmentDetails. + 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 ChangeFusionEnvironmentCompartmentDetails. + :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/fusion_apps/models/change_fusion_environment_family_compartment_details.py b/src/oci/fusion_apps/models/change_fusion_environment_family_compartment_details.py new file mode 100644 index 0000000000..6132c9386d --- /dev/null +++ b/src/oci/fusion_apps/models/change_fusion_environment_family_compartment_details.py @@ -0,0 +1,74 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 ChangeFusionEnvironmentFamilyCompartmentDetails(object): + """ + Details about the compartment the environment family should be moved to. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ChangeFusionEnvironmentFamilyCompartmentDetails 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 ChangeFusionEnvironmentFamilyCompartmentDetails. + :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 ChangeFusionEnvironmentFamilyCompartmentDetails. + 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 ChangeFusionEnvironmentFamilyCompartmentDetails. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this ChangeFusionEnvironmentFamilyCompartmentDetails. + 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 ChangeFusionEnvironmentFamilyCompartmentDetails. + :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/fusion_apps/models/create_data_masking_activity_details.py b/src/oci/fusion_apps/models/create_data_masking_activity_details.py new file mode 100644 index 0000000000..41e69e758f --- /dev/null +++ b/src/oci/fusion_apps/models/create_data_masking_activity_details.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 CreateDataMaskingActivityDetails(object): + """ + The information about current data masking request. + """ + + def __init__(self, **kwargs): + """ + Initializes a new CreateDataMaskingActivityDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param is_resume_data_masking: + The value to assign to the is_resume_data_masking property of this CreateDataMaskingActivityDetails. + :type is_resume_data_masking: bool + + """ + self.swagger_types = { + 'is_resume_data_masking': 'bool' + } + + self.attribute_map = { + 'is_resume_data_masking': 'isResumeDataMasking' + } + + self._is_resume_data_masking = None + + @property + def is_resume_data_masking(self): + """ + Gets the is_resume_data_masking of this CreateDataMaskingActivityDetails. + This allows the Data Safe service to resume the previously failed data masking activity. + + + :return: The is_resume_data_masking of this CreateDataMaskingActivityDetails. + :rtype: bool + """ + return self._is_resume_data_masking + + @is_resume_data_masking.setter + def is_resume_data_masking(self, is_resume_data_masking): + """ + Sets the is_resume_data_masking of this CreateDataMaskingActivityDetails. + This allows the Data Safe service to resume the previously failed data masking activity. + + + :param is_resume_data_masking: The is_resume_data_masking of this CreateDataMaskingActivityDetails. + :type: bool + """ + self._is_resume_data_masking = is_resume_data_masking + + 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/fusion_apps/models/create_fusion_environment_admin_user_details.py b/src/oci/fusion_apps/models/create_fusion_environment_admin_user_details.py new file mode 100644 index 0000000000..4fddfca43a --- /dev/null +++ b/src/oci/fusion_apps/models/create_fusion_environment_admin_user_details.py @@ -0,0 +1,194 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 CreateFusionEnvironmentAdminUserDetails(object): + """ + The credentials for the Fusion Applications service administrator. + """ + + def __init__(self, **kwargs): + """ + Initializes a new CreateFusionEnvironmentAdminUserDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param username: + The value to assign to the username property of this CreateFusionEnvironmentAdminUserDetails. + :type username: str + + :param password: + The value to assign to the password property of this CreateFusionEnvironmentAdminUserDetails. + :type password: str + + :param email_address: + The value to assign to the email_address property of this CreateFusionEnvironmentAdminUserDetails. + :type email_address: str + + :param first_name: + The value to assign to the first_name property of this CreateFusionEnvironmentAdminUserDetails. + :type first_name: str + + :param last_name: + The value to assign to the last_name property of this CreateFusionEnvironmentAdminUserDetails. + :type last_name: str + + """ + self.swagger_types = { + 'username': 'str', + 'password': 'str', + 'email_address': 'str', + 'first_name': 'str', + 'last_name': 'str' + } + + self.attribute_map = { + 'username': 'username', + 'password': 'password', + 'email_address': 'emailAddress', + 'first_name': 'firstName', + 'last_name': 'lastName' + } + + self._username = None + self._password = None + self._email_address = None + self._first_name = None + self._last_name = None + + @property + def username(self): + """ + **[Required]** Gets the username of this CreateFusionEnvironmentAdminUserDetails. + The username for the administrator. + + + :return: The username of this CreateFusionEnvironmentAdminUserDetails. + :rtype: str + """ + return self._username + + @username.setter + def username(self, username): + """ + Sets the username of this CreateFusionEnvironmentAdminUserDetails. + The username for the administrator. + + + :param username: The username of this CreateFusionEnvironmentAdminUserDetails. + :type: str + """ + self._username = username + + @property + def password(self): + """ + **[Required]** Gets the password of this CreateFusionEnvironmentAdminUserDetails. + The password for the administrator. + + + :return: The password of this CreateFusionEnvironmentAdminUserDetails. + :rtype: str + """ + return self._password + + @password.setter + def password(self, password): + """ + Sets the password of this CreateFusionEnvironmentAdminUserDetails. + The password for the administrator. + + + :param password: The password of this CreateFusionEnvironmentAdminUserDetails. + :type: str + """ + self._password = password + + @property + def email_address(self): + """ + **[Required]** Gets the email_address of this CreateFusionEnvironmentAdminUserDetails. + The email address for the administrator. + + + :return: The email_address of this CreateFusionEnvironmentAdminUserDetails. + :rtype: str + """ + return self._email_address + + @email_address.setter + def email_address(self, email_address): + """ + Sets the email_address of this CreateFusionEnvironmentAdminUserDetails. + The email address for the administrator. + + + :param email_address: The email_address of this CreateFusionEnvironmentAdminUserDetails. + :type: str + """ + self._email_address = email_address + + @property + def first_name(self): + """ + **[Required]** Gets the first_name of this CreateFusionEnvironmentAdminUserDetails. + The administrator's first name. + + + :return: The first_name of this CreateFusionEnvironmentAdminUserDetails. + :rtype: str + """ + return self._first_name + + @first_name.setter + def first_name(self, first_name): + """ + Sets the first_name of this CreateFusionEnvironmentAdminUserDetails. + The administrator's first name. + + + :param first_name: The first_name of this CreateFusionEnvironmentAdminUserDetails. + :type: str + """ + self._first_name = first_name + + @property + def last_name(self): + """ + **[Required]** Gets the last_name of this CreateFusionEnvironmentAdminUserDetails. + The administrator's last name. + + + :return: The last_name of this CreateFusionEnvironmentAdminUserDetails. + :rtype: str + """ + return self._last_name + + @last_name.setter + def last_name(self, last_name): + """ + Sets the last_name of this CreateFusionEnvironmentAdminUserDetails. + The administrator's last name. + + + :param last_name: The last_name of this CreateFusionEnvironmentAdminUserDetails. + :type: str + """ + self._last_name = last_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/fusion_apps/models/create_fusion_environment_details.py b/src/oci/fusion_apps/models/create_fusion_environment_details.py new file mode 100644 index 0000000000..073f2f2953 --- /dev/null +++ b/src/oci/fusion_apps/models/create_fusion_environment_details.py @@ -0,0 +1,409 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 CreateFusionEnvironmentDetails(object): + """ + The configuration details of the FusionEnvironment. For more information about these fields, see `Managing Environments`__. + + __ https://docs.cloud.oracle.com/iaas/Content/fusion-applications/manage-environment.htm + """ + + def __init__(self, **kwargs): + """ + Initializes a new CreateFusionEnvironmentDetails 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 CreateFusionEnvironmentDetails. + :type display_name: str + + :param maintenance_policy: + The value to assign to the maintenance_policy property of this CreateFusionEnvironmentDetails. + :type maintenance_policy: oci.fusion_apps.models.MaintenancePolicy + + :param compartment_id: + The value to assign to the compartment_id property of this CreateFusionEnvironmentDetails. + :type compartment_id: str + + :param fusion_environment_family_id: + The value to assign to the fusion_environment_family_id property of this CreateFusionEnvironmentDetails. + :type fusion_environment_family_id: str + + :param fusion_environment_type: + The value to assign to the fusion_environment_type property of this CreateFusionEnvironmentDetails. + :type fusion_environment_type: str + + :param kms_key_id: + The value to assign to the kms_key_id property of this CreateFusionEnvironmentDetails. + :type kms_key_id: str + + :param dns_prefix: + The value to assign to the dns_prefix property of this CreateFusionEnvironmentDetails. + :type dns_prefix: str + + :param additional_language_packs: + The value to assign to the additional_language_packs property of this CreateFusionEnvironmentDetails. + :type additional_language_packs: list[str] + + :param rules: + The value to assign to the rules property of this CreateFusionEnvironmentDetails. + :type rules: list[oci.fusion_apps.models.Rule] + + :param create_fusion_environment_admin_user_details: + The value to assign to the create_fusion_environment_admin_user_details property of this CreateFusionEnvironmentDetails. + :type create_fusion_environment_admin_user_details: oci.fusion_apps.models.CreateFusionEnvironmentAdminUserDetails + + :param freeform_tags: + The value to assign to the freeform_tags property of this CreateFusionEnvironmentDetails. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this CreateFusionEnvironmentDetails. + :type defined_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'display_name': 'str', + 'maintenance_policy': 'MaintenancePolicy', + 'compartment_id': 'str', + 'fusion_environment_family_id': 'str', + 'fusion_environment_type': 'str', + 'kms_key_id': 'str', + 'dns_prefix': 'str', + 'additional_language_packs': 'list[str]', + 'rules': 'list[Rule]', + 'create_fusion_environment_admin_user_details': 'CreateFusionEnvironmentAdminUserDetails', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))' + } + + self.attribute_map = { + 'display_name': 'displayName', + 'maintenance_policy': 'maintenancePolicy', + 'compartment_id': 'compartmentId', + 'fusion_environment_family_id': 'fusionEnvironmentFamilyId', + 'fusion_environment_type': 'fusionEnvironmentType', + 'kms_key_id': 'kmsKeyId', + 'dns_prefix': 'dnsPrefix', + 'additional_language_packs': 'additionalLanguagePacks', + 'rules': 'rules', + 'create_fusion_environment_admin_user_details': 'createFusionEnvironmentAdminUserDetails', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags' + } + + self._display_name = None + self._maintenance_policy = None + self._compartment_id = None + self._fusion_environment_family_id = None + self._fusion_environment_type = None + self._kms_key_id = None + self._dns_prefix = None + self._additional_language_packs = None + self._rules = None + self._create_fusion_environment_admin_user_details = None + self._freeform_tags = None + self._defined_tags = None + + @property + def display_name(self): + """ + **[Required]** Gets the display_name of this CreateFusionEnvironmentDetails. + FusionEnvironment Identifier can be renamed. + + + :return: The display_name of this CreateFusionEnvironmentDetails. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this CreateFusionEnvironmentDetails. + FusionEnvironment Identifier can be renamed. + + + :param display_name: The display_name of this CreateFusionEnvironmentDetails. + :type: str + """ + self._display_name = display_name + + @property + def maintenance_policy(self): + """ + Gets the maintenance_policy of this CreateFusionEnvironmentDetails. + + :return: The maintenance_policy of this CreateFusionEnvironmentDetails. + :rtype: oci.fusion_apps.models.MaintenancePolicy + """ + return self._maintenance_policy + + @maintenance_policy.setter + def maintenance_policy(self, maintenance_policy): + """ + Sets the maintenance_policy of this CreateFusionEnvironmentDetails. + + :param maintenance_policy: The maintenance_policy of this CreateFusionEnvironmentDetails. + :type: oci.fusion_apps.models.MaintenancePolicy + """ + self._maintenance_policy = maintenance_policy + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this CreateFusionEnvironmentDetails. + The unique identifier (OCID) of the compartment where the Fusion Environment is located. + + + :return: The compartment_id of this CreateFusionEnvironmentDetails. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this CreateFusionEnvironmentDetails. + The unique identifier (OCID) of the compartment where the Fusion Environment is located. + + + :param compartment_id: The compartment_id of this CreateFusionEnvironmentDetails. + :type: str + """ + self._compartment_id = compartment_id + + @property + def fusion_environment_family_id(self): + """ + **[Required]** Gets the fusion_environment_family_id of this CreateFusionEnvironmentDetails. + The unique identifier (OCID) of the Fusion Environment Family that the Fusion Environment belongs to. + + + :return: The fusion_environment_family_id of this CreateFusionEnvironmentDetails. + :rtype: str + """ + return self._fusion_environment_family_id + + @fusion_environment_family_id.setter + def fusion_environment_family_id(self, fusion_environment_family_id): + """ + Sets the fusion_environment_family_id of this CreateFusionEnvironmentDetails. + The unique identifier (OCID) of the Fusion Environment Family that the Fusion Environment belongs to. + + + :param fusion_environment_family_id: The fusion_environment_family_id of this CreateFusionEnvironmentDetails. + :type: str + """ + self._fusion_environment_family_id = fusion_environment_family_id + + @property + def fusion_environment_type(self): + """ + **[Required]** Gets the fusion_environment_type of this CreateFusionEnvironmentDetails. + The type of environment. Valid values are Production, Test, or Development. + + + :return: The fusion_environment_type of this CreateFusionEnvironmentDetails. + :rtype: str + """ + return self._fusion_environment_type + + @fusion_environment_type.setter + def fusion_environment_type(self, fusion_environment_type): + """ + Sets the fusion_environment_type of this CreateFusionEnvironmentDetails. + The type of environment. Valid values are Production, Test, or Development. + + + :param fusion_environment_type: The fusion_environment_type of this CreateFusionEnvironmentDetails. + :type: str + """ + self._fusion_environment_type = fusion_environment_type + + @property + def kms_key_id(self): + """ + Gets the kms_key_id of this CreateFusionEnvironmentDetails. + byok kms keyId + + + :return: The kms_key_id of this CreateFusionEnvironmentDetails. + :rtype: str + """ + return self._kms_key_id + + @kms_key_id.setter + def kms_key_id(self, kms_key_id): + """ + Sets the kms_key_id of this CreateFusionEnvironmentDetails. + byok kms keyId + + + :param kms_key_id: The kms_key_id of this CreateFusionEnvironmentDetails. + :type: str + """ + self._kms_key_id = kms_key_id + + @property + def dns_prefix(self): + """ + Gets the dns_prefix of this CreateFusionEnvironmentDetails. + DNS prefix. + + + :return: The dns_prefix of this CreateFusionEnvironmentDetails. + :rtype: str + """ + return self._dns_prefix + + @dns_prefix.setter + def dns_prefix(self, dns_prefix): + """ + Sets the dns_prefix of this CreateFusionEnvironmentDetails. + DNS prefix. + + + :param dns_prefix: The dns_prefix of this CreateFusionEnvironmentDetails. + :type: str + """ + self._dns_prefix = dns_prefix + + @property + def additional_language_packs(self): + """ + Gets the additional_language_packs of this CreateFusionEnvironmentDetails. + Language packs. + + + :return: The additional_language_packs of this CreateFusionEnvironmentDetails. + :rtype: list[str] + """ + return self._additional_language_packs + + @additional_language_packs.setter + def additional_language_packs(self, additional_language_packs): + """ + Sets the additional_language_packs of this CreateFusionEnvironmentDetails. + Language packs. + + + :param additional_language_packs: The additional_language_packs of this CreateFusionEnvironmentDetails. + :type: list[str] + """ + self._additional_language_packs = additional_language_packs + + @property + def rules(self): + """ + Gets the rules of this CreateFusionEnvironmentDetails. + Rules. + + + :return: The rules of this CreateFusionEnvironmentDetails. + :rtype: list[oci.fusion_apps.models.Rule] + """ + return self._rules + + @rules.setter + def rules(self, rules): + """ + Sets the rules of this CreateFusionEnvironmentDetails. + Rules. + + + :param rules: The rules of this CreateFusionEnvironmentDetails. + :type: list[oci.fusion_apps.models.Rule] + """ + self._rules = rules + + @property + def create_fusion_environment_admin_user_details(self): + """ + **[Required]** Gets the create_fusion_environment_admin_user_details of this CreateFusionEnvironmentDetails. + + :return: The create_fusion_environment_admin_user_details of this CreateFusionEnvironmentDetails. + :rtype: oci.fusion_apps.models.CreateFusionEnvironmentAdminUserDetails + """ + return self._create_fusion_environment_admin_user_details + + @create_fusion_environment_admin_user_details.setter + def create_fusion_environment_admin_user_details(self, create_fusion_environment_admin_user_details): + """ + Sets the create_fusion_environment_admin_user_details of this CreateFusionEnvironmentDetails. + + :param create_fusion_environment_admin_user_details: The create_fusion_environment_admin_user_details of this CreateFusionEnvironmentDetails. + :type: oci.fusion_apps.models.CreateFusionEnvironmentAdminUserDetails + """ + self._create_fusion_environment_admin_user_details = create_fusion_environment_admin_user_details + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this CreateFusionEnvironmentDetails. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :return: The freeform_tags of this CreateFusionEnvironmentDetails. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this CreateFusionEnvironmentDetails. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :param freeform_tags: The freeform_tags of this CreateFusionEnvironmentDetails. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this CreateFusionEnvironmentDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this CreateFusionEnvironmentDetails. + :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 CreateFusionEnvironmentDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this CreateFusionEnvironmentDetails. + :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/fusion_apps/models/create_fusion_environment_family_details.py b/src/oci/fusion_apps/models/create_fusion_environment_family_details.py new file mode 100644 index 0000000000..c0b1110a9e --- /dev/null +++ b/src/oci/fusion_apps/models/create_fusion_environment_family_details.py @@ -0,0 +1,225 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 CreateFusionEnvironmentFamilyDetails(object): + """ + The information about new FusionEnvironmentFamily. + """ + + def __init__(self, **kwargs): + """ + Initializes a new CreateFusionEnvironmentFamilyDetails 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 CreateFusionEnvironmentFamilyDetails. + :type display_name: str + + :param family_maintenance_policy: + The value to assign to the family_maintenance_policy property of this CreateFusionEnvironmentFamilyDetails. + :type family_maintenance_policy: oci.fusion_apps.models.FamilyMaintenancePolicy + + :param compartment_id: + The value to assign to the compartment_id property of this CreateFusionEnvironmentFamilyDetails. + :type compartment_id: str + + :param subscription_ids: + The value to assign to the subscription_ids property of this CreateFusionEnvironmentFamilyDetails. + :type subscription_ids: list[str] + + :param freeform_tags: + The value to assign to the freeform_tags property of this CreateFusionEnvironmentFamilyDetails. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this CreateFusionEnvironmentFamilyDetails. + :type defined_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'display_name': 'str', + 'family_maintenance_policy': 'FamilyMaintenancePolicy', + 'compartment_id': 'str', + 'subscription_ids': 'list[str]', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))' + } + + self.attribute_map = { + 'display_name': 'displayName', + 'family_maintenance_policy': 'familyMaintenancePolicy', + 'compartment_id': 'compartmentId', + 'subscription_ids': 'subscriptionIds', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags' + } + + self._display_name = None + self._family_maintenance_policy = None + self._compartment_id = None + self._subscription_ids = None + self._freeform_tags = None + self._defined_tags = None + + @property + def display_name(self): + """ + **[Required]** Gets the display_name of this CreateFusionEnvironmentFamilyDetails. + A friendly name for the environment family. The name must contain only letters, numbers, dashes, and underscores. Can be changed later. + + + :return: The display_name of this CreateFusionEnvironmentFamilyDetails. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this CreateFusionEnvironmentFamilyDetails. + A friendly name for the environment family. The name must contain only letters, numbers, dashes, and underscores. Can be changed later. + + + :param display_name: The display_name of this CreateFusionEnvironmentFamilyDetails. + :type: str + """ + self._display_name = display_name + + @property + def family_maintenance_policy(self): + """ + Gets the family_maintenance_policy of this CreateFusionEnvironmentFamilyDetails. + + :return: The family_maintenance_policy of this CreateFusionEnvironmentFamilyDetails. + :rtype: oci.fusion_apps.models.FamilyMaintenancePolicy + """ + return self._family_maintenance_policy + + @family_maintenance_policy.setter + def family_maintenance_policy(self, family_maintenance_policy): + """ + Sets the family_maintenance_policy of this CreateFusionEnvironmentFamilyDetails. + + :param family_maintenance_policy: The family_maintenance_policy of this CreateFusionEnvironmentFamilyDetails. + :type: oci.fusion_apps.models.FamilyMaintenancePolicy + """ + self._family_maintenance_policy = family_maintenance_policy + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this CreateFusionEnvironmentFamilyDetails. + The OCID of the compartment where the environment family is located. + + + :return: The compartment_id of this CreateFusionEnvironmentFamilyDetails. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this CreateFusionEnvironmentFamilyDetails. + The OCID of the compartment where the environment family is located. + + + :param compartment_id: The compartment_id of this CreateFusionEnvironmentFamilyDetails. + :type: str + """ + self._compartment_id = compartment_id + + @property + def subscription_ids(self): + """ + **[Required]** Gets the subscription_ids of this CreateFusionEnvironmentFamilyDetails. + The list of the IDs of the applications subscriptions that are associated with the environment family. + + + :return: The subscription_ids of this CreateFusionEnvironmentFamilyDetails. + :rtype: list[str] + """ + return self._subscription_ids + + @subscription_ids.setter + def subscription_ids(self, subscription_ids): + """ + Sets the subscription_ids of this CreateFusionEnvironmentFamilyDetails. + The list of the IDs of the applications subscriptions that are associated with the environment family. + + + :param subscription_ids: The subscription_ids of this CreateFusionEnvironmentFamilyDetails. + :type: list[str] + """ + self._subscription_ids = subscription_ids + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this CreateFusionEnvironmentFamilyDetails. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :return: The freeform_tags of this CreateFusionEnvironmentFamilyDetails. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this CreateFusionEnvironmentFamilyDetails. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :param freeform_tags: The freeform_tags of this CreateFusionEnvironmentFamilyDetails. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this CreateFusionEnvironmentFamilyDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this CreateFusionEnvironmentFamilyDetails. + :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 CreateFusionEnvironmentFamilyDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this CreateFusionEnvironmentFamilyDetails. + :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/fusion_apps/models/create_new_instance_details.py b/src/oci/fusion_apps/models/create_new_instance_details.py new file mode 100644 index 0000000000..79b561cd4e --- /dev/null +++ b/src/oci/fusion_apps/models/create_new_instance_details.py @@ -0,0 +1,142 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .create_service_attachment_details import CreateServiceAttachmentDetails +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 CreateNewInstanceDetails(CreateServiceAttachmentDetails): + """ + Information about the service attachment. + """ + + def __init__(self, **kwargs): + """ + Initializes a new CreateNewInstanceDetails object with values from keyword arguments. The default value of the :py:attr:`~oci.fusion_apps.models.CreateNewInstanceDetails.action` attribute + of this class is ``CREATE_NEW_INSTANCE`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param action: + The value to assign to the action property of this CreateNewInstanceDetails. + Allowed values for this property are: "CREATE_NEW_INSTANCE", "ATTACH_EXISTING_INSTANCE" + :type action: str + + :param details: + The value to assign to the details property of this CreateNewInstanceDetails. + :type details: oci.fusion_apps.models.CreateServiceInstanceDetails + + :param freeform_tags: + The value to assign to the freeform_tags property of this CreateNewInstanceDetails. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this CreateNewInstanceDetails. + :type defined_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'action': 'str', + 'details': 'CreateServiceInstanceDetails', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))' + } + + self.attribute_map = { + 'action': 'action', + 'details': 'details', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags' + } + + self._action = None + self._details = None + self._freeform_tags = None + self._defined_tags = None + self._action = 'CREATE_NEW_INSTANCE' + + @property + def details(self): + """ + Gets the details of this CreateNewInstanceDetails. + + :return: The details of this CreateNewInstanceDetails. + :rtype: oci.fusion_apps.models.CreateServiceInstanceDetails + """ + return self._details + + @details.setter + def details(self, details): + """ + Sets the details of this CreateNewInstanceDetails. + + :param details: The details of this CreateNewInstanceDetails. + :type: oci.fusion_apps.models.CreateServiceInstanceDetails + """ + self._details = details + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this CreateNewInstanceDetails. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :return: The freeform_tags of this CreateNewInstanceDetails. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this CreateNewInstanceDetails. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :param freeform_tags: The freeform_tags of this CreateNewInstanceDetails. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this CreateNewInstanceDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this CreateNewInstanceDetails. + :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 CreateNewInstanceDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this CreateNewInstanceDetails. + :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/fusion_apps/models/create_oax_service_instance_details.py b/src/oci/fusion_apps/models/create_oax_service_instance_details.py new file mode 100644 index 0000000000..3224ea145c --- /dev/null +++ b/src/oci/fusion_apps/models/create_oax_service_instance_details.py @@ -0,0 +1,156 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .create_service_instance_details import CreateServiceInstanceDetails +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 CreateOaxServiceInstanceDetails(CreateServiceInstanceDetails): + """ + The information about new Analytics Warehouse instance being provisioned. + """ + + def __init__(self, **kwargs): + """ + Initializes a new CreateOaxServiceInstanceDetails object with values from keyword arguments. The default value of the :py:attr:`~oci.fusion_apps.models.CreateOaxServiceInstanceDetails.service_instance_type` attribute + of this class is ``ANALYTICS_WAREHOUSE`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param display_name: + The value to assign to the display_name property of this CreateOaxServiceInstanceDetails. + :type display_name: str + + :param compartment_id: + The value to assign to the compartment_id property of this CreateOaxServiceInstanceDetails. + :type compartment_id: str + + :param service_instance_type: + The value to assign to the service_instance_type property of this CreateOaxServiceInstanceDetails. + Allowed values for this property are: "INTEGRATION_CLOUD", "ANALYTICS_WAREHOUSE" + :type service_instance_type: str + + :param name: + The value to assign to the name property of this CreateOaxServiceInstanceDetails. + :type name: str + + :param description: + The value to assign to the description property of this CreateOaxServiceInstanceDetails. + :type description: str + + :param faw_admin_info: + The value to assign to the faw_admin_info property of this CreateOaxServiceInstanceDetails. + :type faw_admin_info: oci.fusion_apps.models.FawAdminInfoDetails + + """ + self.swagger_types = { + 'display_name': 'str', + 'compartment_id': 'str', + 'service_instance_type': 'str', + 'name': 'str', + 'description': 'str', + 'faw_admin_info': 'FawAdminInfoDetails' + } + + self.attribute_map = { + 'display_name': 'displayName', + 'compartment_id': 'compartmentId', + 'service_instance_type': 'serviceInstanceType', + 'name': 'name', + 'description': 'description', + 'faw_admin_info': 'FawAdminInfo' + } + + self._display_name = None + self._compartment_id = None + self._service_instance_type = None + self._name = None + self._description = None + self._faw_admin_info = None + self._service_instance_type = 'ANALYTICS_WAREHOUSE' + + @property + def name(self): + """ + Gets the name of this CreateOaxServiceInstanceDetails. + A unique Name for Analytics Warehouse. + + + :return: The name of this CreateOaxServiceInstanceDetails. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this CreateOaxServiceInstanceDetails. + A unique Name for Analytics Warehouse. + + + :param name: The name of this CreateOaxServiceInstanceDetails. + :type: str + """ + self._name = name + + @property + def description(self): + """ + Gets the description of this CreateOaxServiceInstanceDetails. + This is the description for Analytics Warehouse Service. + + + :return: The description of this CreateOaxServiceInstanceDetails. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this CreateOaxServiceInstanceDetails. + This is the description for Analytics Warehouse Service. + + + :param description: The description of this CreateOaxServiceInstanceDetails. + :type: str + """ + self._description = description + + @property + def faw_admin_info(self): + """ + Gets the faw_admin_info of this CreateOaxServiceInstanceDetails. + Admin information to provision Analytics Warehouse Servcie + + + :return: The faw_admin_info of this CreateOaxServiceInstanceDetails. + :rtype: oci.fusion_apps.models.FawAdminInfoDetails + """ + return self._faw_admin_info + + @faw_admin_info.setter + def faw_admin_info(self, faw_admin_info): + """ + Sets the faw_admin_info of this CreateOaxServiceInstanceDetails. + Admin information to provision Analytics Warehouse Servcie + + + :param faw_admin_info: The faw_admin_info of this CreateOaxServiceInstanceDetails. + :type: oci.fusion_apps.models.FawAdminInfoDetails + """ + self._faw_admin_info = faw_admin_info + + 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/fusion_apps/models/create_oic_service_instance_details.py b/src/oci/fusion_apps/models/create_oic_service_instance_details.py new file mode 100644 index 0000000000..ee62506d11 --- /dev/null +++ b/src/oci/fusion_apps/models/create_oic_service_instance_details.py @@ -0,0 +1,142 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .create_service_instance_details import CreateServiceInstanceDetails +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 CreateOicServiceInstanceDetails(CreateServiceInstanceDetails): + """ + The information about new Integration Cloud instance being provisioned. + """ + + #: A constant which can be used with the edition property of a CreateOicServiceInstanceDetails. + #: This constant has a value of "STANDARD" + EDITION_STANDARD = "STANDARD" + + #: A constant which can be used with the edition property of a CreateOicServiceInstanceDetails. + #: This constant has a value of "ENTERPRISE" + EDITION_ENTERPRISE = "ENTERPRISE" + + def __init__(self, **kwargs): + """ + Initializes a new CreateOicServiceInstanceDetails object with values from keyword arguments. The default value of the :py:attr:`~oci.fusion_apps.models.CreateOicServiceInstanceDetails.service_instance_type` attribute + of this class is ``INTEGRATION_CLOUD`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param display_name: + The value to assign to the display_name property of this CreateOicServiceInstanceDetails. + :type display_name: str + + :param compartment_id: + The value to assign to the compartment_id property of this CreateOicServiceInstanceDetails. + :type compartment_id: str + + :param service_instance_type: + The value to assign to the service_instance_type property of this CreateOicServiceInstanceDetails. + Allowed values for this property are: "INTEGRATION_CLOUD", "ANALYTICS_WAREHOUSE" + :type service_instance_type: str + + :param message_packs: + The value to assign to the message_packs property of this CreateOicServiceInstanceDetails. + :type message_packs: int + + :param edition: + The value to assign to the edition property of this CreateOicServiceInstanceDetails. + Allowed values for this property are: "STANDARD", "ENTERPRISE" + :type edition: str + + """ + self.swagger_types = { + 'display_name': 'str', + 'compartment_id': 'str', + 'service_instance_type': 'str', + 'message_packs': 'int', + 'edition': 'str' + } + + self.attribute_map = { + 'display_name': 'displayName', + 'compartment_id': 'compartmentId', + 'service_instance_type': 'serviceInstanceType', + 'message_packs': 'messagePacks', + 'edition': 'edition' + } + + self._display_name = None + self._compartment_id = None + self._service_instance_type = None + self._message_packs = None + self._edition = None + self._service_instance_type = 'INTEGRATION_CLOUD' + + @property + def message_packs(self): + """ + Gets the message_packs of this CreateOicServiceInstanceDetails. + Number of 5K message packs per hour + + + :return: The message_packs of this CreateOicServiceInstanceDetails. + :rtype: int + """ + return self._message_packs + + @message_packs.setter + def message_packs(self, message_packs): + """ + Sets the message_packs of this CreateOicServiceInstanceDetails. + Number of 5K message packs per hour + + + :param message_packs: The message_packs of this CreateOicServiceInstanceDetails. + :type: int + """ + self._message_packs = message_packs + + @property + def edition(self): + """ + Gets the edition of this CreateOicServiceInstanceDetails. + The Oracle Integration edition + + Allowed values for this property are: "STANDARD", "ENTERPRISE" + + + :return: The edition of this CreateOicServiceInstanceDetails. + :rtype: str + """ + return self._edition + + @edition.setter + def edition(self, edition): + """ + Sets the edition of this CreateOicServiceInstanceDetails. + The Oracle Integration edition + + + :param edition: The edition of this CreateOicServiceInstanceDetails. + :type: str + """ + allowed_values = ["STANDARD", "ENTERPRISE"] + if not value_allowed_none_or_none_sentinel(edition, allowed_values): + raise ValueError( + "Invalid value for `edition`, must be None or one of {0}" + .format(allowed_values) + ) + self._edition = edition + + 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/fusion_apps/models/create_refresh_activity_details.py b/src/oci/fusion_apps/models/create_refresh_activity_details.py new file mode 100644 index 0000000000..4ebc847585 --- /dev/null +++ b/src/oci/fusion_apps/models/create_refresh_activity_details.py @@ -0,0 +1,74 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 CreateRefreshActivityDetails(object): + """ + The information about current refresh. + """ + + def __init__(self, **kwargs): + """ + Initializes a new CreateRefreshActivityDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param source_fusion_environment_id: + The value to assign to the source_fusion_environment_id property of this CreateRefreshActivityDetails. + :type source_fusion_environment_id: str + + """ + self.swagger_types = { + 'source_fusion_environment_id': 'str' + } + + self.attribute_map = { + 'source_fusion_environment_id': 'sourceFusionEnvironmentId' + } + + self._source_fusion_environment_id = None + + @property + def source_fusion_environment_id(self): + """ + **[Required]** Gets the source_fusion_environment_id of this CreateRefreshActivityDetails. + The `OCID`__ of the source environment + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :return: The source_fusion_environment_id of this CreateRefreshActivityDetails. + :rtype: str + """ + return self._source_fusion_environment_id + + @source_fusion_environment_id.setter + def source_fusion_environment_id(self, source_fusion_environment_id): + """ + Sets the source_fusion_environment_id of this CreateRefreshActivityDetails. + The `OCID`__ of the source environment + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :param source_fusion_environment_id: The source_fusion_environment_id of this CreateRefreshActivityDetails. + :type: str + """ + self._source_fusion_environment_id = source_fusion_environment_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/fusion_apps/models/create_service_attachment_details.py b/src/oci/fusion_apps/models/create_service_attachment_details.py new file mode 100644 index 0000000000..f243da8835 --- /dev/null +++ b/src/oci/fusion_apps/models/create_service_attachment_details.py @@ -0,0 +1,108 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 CreateServiceAttachmentDetails(object): + """ + Information about the service attachment. + """ + + #: A constant which can be used with the action property of a CreateServiceAttachmentDetails. + #: This constant has a value of "CREATE_NEW_INSTANCE" + ACTION_CREATE_NEW_INSTANCE = "CREATE_NEW_INSTANCE" + + #: A constant which can be used with the action property of a CreateServiceAttachmentDetails. + #: This constant has a value of "ATTACH_EXISTING_INSTANCE" + ACTION_ATTACH_EXISTING_INSTANCE = "ATTACH_EXISTING_INSTANCE" + + def __init__(self, **kwargs): + """ + Initializes a new CreateServiceAttachmentDetails 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.fusion_apps.models.AttachExistingInstanceDetails` + * :class:`~oci.fusion_apps.models.CreateNewInstanceDetails` + + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param action: + The value to assign to the action property of this CreateServiceAttachmentDetails. + Allowed values for this property are: "CREATE_NEW_INSTANCE", "ATTACH_EXISTING_INSTANCE" + :type action: str + + """ + self.swagger_types = { + 'action': 'str' + } + + self.attribute_map = { + 'action': 'action' + } + + self._action = 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['action'] + + if type == 'ATTACH_EXISTING_INSTANCE': + return 'AttachExistingInstanceDetails' + + if type == 'CREATE_NEW_INSTANCE': + return 'CreateNewInstanceDetails' + else: + return 'CreateServiceAttachmentDetails' + + @property + def action(self): + """ + **[Required]** Gets the action of this CreateServiceAttachmentDetails. + The operation type - the customer can ask FAaaS to create a new instance or use an existing instance + + Allowed values for this property are: "CREATE_NEW_INSTANCE", "ATTACH_EXISTING_INSTANCE" + + + :return: The action of this CreateServiceAttachmentDetails. + :rtype: str + """ + return self._action + + @action.setter + def action(self, action): + """ + Sets the action of this CreateServiceAttachmentDetails. + The operation type - the customer can ask FAaaS to create a new instance or use an existing instance + + + :param action: The action of this CreateServiceAttachmentDetails. + :type: str + """ + allowed_values = ["CREATE_NEW_INSTANCE", "ATTACH_EXISTING_INSTANCE"] + if not value_allowed_none_or_none_sentinel(action, allowed_values): + raise ValueError( + "Invalid value for `action`, must be None or one of {0}" + .format(allowed_values) + ) + self._action = action + + 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/fusion_apps/models/create_service_instance_details.py b/src/oci/fusion_apps/models/create_service_instance_details.py new file mode 100644 index 0000000000..0d50f6041f --- /dev/null +++ b/src/oci/fusion_apps/models/create_service_instance_details.py @@ -0,0 +1,170 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 CreateServiceInstanceDetails(object): + """ + The information about new ServiceInstance. + """ + + #: A constant which can be used with the service_instance_type property of a CreateServiceInstanceDetails. + #: This constant has a value of "INTEGRATION_CLOUD" + SERVICE_INSTANCE_TYPE_INTEGRATION_CLOUD = "INTEGRATION_CLOUD" + + #: A constant which can be used with the service_instance_type property of a CreateServiceInstanceDetails. + #: This constant has a value of "ANALYTICS_WAREHOUSE" + SERVICE_INSTANCE_TYPE_ANALYTICS_WAREHOUSE = "ANALYTICS_WAREHOUSE" + + def __init__(self, **kwargs): + """ + Initializes a new CreateServiceInstanceDetails 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.fusion_apps.models.CreateOaxServiceInstanceDetails` + * :class:`~oci.fusion_apps.models.CreateOicServiceInstanceDetails` + + 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 CreateServiceInstanceDetails. + :type display_name: str + + :param compartment_id: + The value to assign to the compartment_id property of this CreateServiceInstanceDetails. + :type compartment_id: str + + :param service_instance_type: + The value to assign to the service_instance_type property of this CreateServiceInstanceDetails. + Allowed values for this property are: "INTEGRATION_CLOUD", "ANALYTICS_WAREHOUSE" + :type service_instance_type: str + + """ + self.swagger_types = { + 'display_name': 'str', + 'compartment_id': 'str', + 'service_instance_type': 'str' + } + + self.attribute_map = { + 'display_name': 'displayName', + 'compartment_id': 'compartmentId', + 'service_instance_type': 'serviceInstanceType' + } + + self._display_name = None + self._compartment_id = None + self._service_instance_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['serviceInstanceType'] + + if type == 'ANALYTICS_WAREHOUSE': + return 'CreateOaxServiceInstanceDetails' + + if type == 'INTEGRATION_CLOUD': + return 'CreateOicServiceInstanceDetails' + else: + return 'CreateServiceInstanceDetails' + + @property + def display_name(self): + """ + **[Required]** Gets the display_name of this CreateServiceInstanceDetails. + The service instance type being provisioned + + + :return: The display_name of this CreateServiceInstanceDetails. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this CreateServiceInstanceDetails. + The service instance type being provisioned + + + :param display_name: The display_name of this CreateServiceInstanceDetails. + :type: str + """ + self._display_name = display_name + + @property + def compartment_id(self): + """ + Gets the compartment_id of this CreateServiceInstanceDetails. + Comparment where the instance is to be created + + + :return: The compartment_id of this CreateServiceInstanceDetails. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this CreateServiceInstanceDetails. + Comparment where the instance is to be created + + + :param compartment_id: The compartment_id of this CreateServiceInstanceDetails. + :type: str + """ + self._compartment_id = compartment_id + + @property + def service_instance_type(self): + """ + **[Required]** Gets the service_instance_type of this CreateServiceInstanceDetails. + Type of the ServiceInstance. + + Allowed values for this property are: "INTEGRATION_CLOUD", "ANALYTICS_WAREHOUSE" + + + :return: The service_instance_type of this CreateServiceInstanceDetails. + :rtype: str + """ + return self._service_instance_type + + @service_instance_type.setter + def service_instance_type(self, service_instance_type): + """ + Sets the service_instance_type of this CreateServiceInstanceDetails. + Type of the ServiceInstance. + + + :param service_instance_type: The service_instance_type of this CreateServiceInstanceDetails. + :type: str + """ + allowed_values = ["INTEGRATION_CLOUD", "ANALYTICS_WAREHOUSE"] + if not value_allowed_none_or_none_sentinel(service_instance_type, allowed_values): + raise ValueError( + "Invalid value for `service_instance_type`, must be None or one of {0}" + .format(allowed_values) + ) + self._service_instance_type = service_instance_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/fusion_apps/models/data_masking_activity.py b/src/oci/fusion_apps/models/data_masking_activity.py new file mode 100644 index 0000000000..2a699da524 --- /dev/null +++ b/src/oci/fusion_apps/models/data_masking_activity.py @@ -0,0 +1,222 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 DataMaskingActivity(object): + """ + Details of data masking activity. + """ + + #: A constant which can be used with the lifecycle_state property of a DataMaskingActivity. + #: This constant has a value of "ACCEPTED" + LIFECYCLE_STATE_ACCEPTED = "ACCEPTED" + + #: A constant which can be used with the lifecycle_state property of a DataMaskingActivity. + #: This constant has a value of "IN_PROGRESS" + LIFECYCLE_STATE_IN_PROGRESS = "IN_PROGRESS" + + #: A constant which can be used with the lifecycle_state property of a DataMaskingActivity. + #: This constant has a value of "FAILED" + LIFECYCLE_STATE_FAILED = "FAILED" + + #: A constant which can be used with the lifecycle_state property of a DataMaskingActivity. + #: This constant has a value of "SUCCEEDED" + LIFECYCLE_STATE_SUCCEEDED = "SUCCEEDED" + + #: A constant which can be used with the lifecycle_state property of a DataMaskingActivity. + #: This constant has a value of "CANCELED" + LIFECYCLE_STATE_CANCELED = "CANCELED" + + def __init__(self, **kwargs): + """ + Initializes a new DataMaskingActivity 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 DataMaskingActivity. + :type id: str + + :param fusion_environment_id: + The value to assign to the fusion_environment_id property of this DataMaskingActivity. + :type fusion_environment_id: str + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this DataMaskingActivity. + Allowed values for this property are: "ACCEPTED", "IN_PROGRESS", "FAILED", "SUCCEEDED", "CANCELED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type lifecycle_state: str + + :param time_masking_start: + The value to assign to the time_masking_start property of this DataMaskingActivity. + :type time_masking_start: datetime + + :param time_masking_finish: + The value to assign to the time_masking_finish property of this DataMaskingActivity. + :type time_masking_finish: datetime + + """ + self.swagger_types = { + 'id': 'str', + 'fusion_environment_id': 'str', + 'lifecycle_state': 'str', + 'time_masking_start': 'datetime', + 'time_masking_finish': 'datetime' + } + + self.attribute_map = { + 'id': 'id', + 'fusion_environment_id': 'fusionEnvironmentId', + 'lifecycle_state': 'lifecycleState', + 'time_masking_start': 'timeMaskingStart', + 'time_masking_finish': 'timeMaskingFinish' + } + + self._id = None + self._fusion_environment_id = None + self._lifecycle_state = None + self._time_masking_start = None + self._time_masking_finish = None + + @property + def id(self): + """ + **[Required]** Gets the id of this DataMaskingActivity. + Unique identifier that is immutable on creation. + + + :return: The id of this DataMaskingActivity. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this DataMaskingActivity. + Unique identifier that is immutable on creation. + + + :param id: The id of this DataMaskingActivity. + :type: str + """ + self._id = id + + @property + def fusion_environment_id(self): + """ + **[Required]** Gets the fusion_environment_id of this DataMaskingActivity. + Fusion Environment Identifier. + + + :return: The fusion_environment_id of this DataMaskingActivity. + :rtype: str + """ + return self._fusion_environment_id + + @fusion_environment_id.setter + def fusion_environment_id(self, fusion_environment_id): + """ + Sets the fusion_environment_id of this DataMaskingActivity. + Fusion Environment Identifier. + + + :param fusion_environment_id: The fusion_environment_id of this DataMaskingActivity. + :type: str + """ + self._fusion_environment_id = fusion_environment_id + + @property + def lifecycle_state(self): + """ + **[Required]** Gets the lifecycle_state of this DataMaskingActivity. + The current state of the DataMaskingActivity. + + Allowed values for this property are: "ACCEPTED", "IN_PROGRESS", "FAILED", "SUCCEEDED", "CANCELED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The lifecycle_state of this DataMaskingActivity. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this DataMaskingActivity. + The current state of the DataMaskingActivity. + + + :param lifecycle_state: The lifecycle_state of this DataMaskingActivity. + :type: str + """ + allowed_values = ["ACCEPTED", "IN_PROGRESS", "FAILED", "SUCCEEDED", "CANCELED"] + 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_masking_start(self): + """ + **[Required]** Gets the time_masking_start of this DataMaskingActivity. + The time the data masking activity started. An RFC3339 formatted datetime string. + + + :return: The time_masking_start of this DataMaskingActivity. + :rtype: datetime + """ + return self._time_masking_start + + @time_masking_start.setter + def time_masking_start(self, time_masking_start): + """ + Sets the time_masking_start of this DataMaskingActivity. + The time the data masking activity started. An RFC3339 formatted datetime string. + + + :param time_masking_start: The time_masking_start of this DataMaskingActivity. + :type: datetime + """ + self._time_masking_start = time_masking_start + + @property + def time_masking_finish(self): + """ + **[Required]** Gets the time_masking_finish of this DataMaskingActivity. + The time the data masking activity ended. An RFC3339 formatted datetime string. + + + :return: The time_masking_finish of this DataMaskingActivity. + :rtype: datetime + """ + return self._time_masking_finish + + @time_masking_finish.setter + def time_masking_finish(self, time_masking_finish): + """ + Sets the time_masking_finish of this DataMaskingActivity. + The time the data masking activity ended. An RFC3339 formatted datetime string. + + + :param time_masking_finish: The time_masking_finish of this DataMaskingActivity. + :type: datetime + """ + self._time_masking_finish = time_masking_finish + + 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/fusion_apps/models/data_masking_activity_collection.py b/src/oci/fusion_apps/models/data_masking_activity_collection.py new file mode 100644 index 0000000000..28bbd56da4 --- /dev/null +++ b/src/oci/fusion_apps/models/data_masking_activity_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 DataMaskingActivityCollection(object): + """ + Results of data masking activities on a given Fusion Environment. + """ + + def __init__(self, **kwargs): + """ + Initializes a new DataMaskingActivityCollection 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 DataMaskingActivityCollection. + :type items: list[oci.fusion_apps.models.DataMaskingActivitySummary] + + """ + self.swagger_types = { + 'items': 'list[DataMaskingActivitySummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this DataMaskingActivityCollection. + A page of data masking activity objects. + + + :return: The items of this DataMaskingActivityCollection. + :rtype: list[oci.fusion_apps.models.DataMaskingActivitySummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this DataMaskingActivityCollection. + A page of data masking activity objects. + + + :param items: The items of this DataMaskingActivityCollection. + :type: list[oci.fusion_apps.models.DataMaskingActivitySummary] + """ + 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/fusion_apps/models/data_masking_activity_summary.py b/src/oci/fusion_apps/models/data_masking_activity_summary.py new file mode 100644 index 0000000000..f831761f2e --- /dev/null +++ b/src/oci/fusion_apps/models/data_masking_activity_summary.py @@ -0,0 +1,163 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 DataMaskingActivitySummary(object): + """ + Summary of the data masking activity. + """ + + def __init__(self, **kwargs): + """ + Initializes a new DataMaskingActivitySummary 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 DataMaskingActivitySummary. + :type id: str + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this DataMaskingActivitySummary. + :type lifecycle_state: str + + :param time_masking_start: + The value to assign to the time_masking_start property of this DataMaskingActivitySummary. + :type time_masking_start: datetime + + :param time_masking_finish: + The value to assign to the time_masking_finish property of this DataMaskingActivitySummary. + :type time_masking_finish: datetime + + """ + self.swagger_types = { + 'id': 'str', + 'lifecycle_state': 'str', + 'time_masking_start': 'datetime', + 'time_masking_finish': 'datetime' + } + + self.attribute_map = { + 'id': 'id', + 'lifecycle_state': 'lifecycleState', + 'time_masking_start': 'timeMaskingStart', + 'time_masking_finish': 'timeMaskingFinish' + } + + self._id = None + self._lifecycle_state = None + self._time_masking_start = None + self._time_masking_finish = None + + @property + def id(self): + """ + **[Required]** Gets the id of this DataMaskingActivitySummary. + Unique identifier that is immutable on creation. + + + :return: The id of this DataMaskingActivitySummary. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this DataMaskingActivitySummary. + Unique identifier that is immutable on creation. + + + :param id: The id of this DataMaskingActivitySummary. + :type: str + """ + self._id = id + + @property + def lifecycle_state(self): + """ + **[Required]** Gets the lifecycle_state of this DataMaskingActivitySummary. + The current state of the data masking activity Scheduled, In progress , Failed, Completed + + + :return: The lifecycle_state of this DataMaskingActivitySummary. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this DataMaskingActivitySummary. + The current state of the data masking activity Scheduled, In progress , Failed, Completed + + + :param lifecycle_state: The lifecycle_state of this DataMaskingActivitySummary. + :type: str + """ + self._lifecycle_state = lifecycle_state + + @property + def time_masking_start(self): + """ + **[Required]** Gets the time_masking_start of this DataMaskingActivitySummary. + The time the data masking activity started. An RFC3339 formatted datetime string. + + + :return: The time_masking_start of this DataMaskingActivitySummary. + :rtype: datetime + """ + return self._time_masking_start + + @time_masking_start.setter + def time_masking_start(self, time_masking_start): + """ + Sets the time_masking_start of this DataMaskingActivitySummary. + The time the data masking activity started. An RFC3339 formatted datetime string. + + + :param time_masking_start: The time_masking_start of this DataMaskingActivitySummary. + :type: datetime + """ + self._time_masking_start = time_masking_start + + @property + def time_masking_finish(self): + """ + **[Required]** Gets the time_masking_finish of this DataMaskingActivitySummary. + The time the data masking activity actually completed / cancelled / failed. An RFC3339 formatted datetime string. + + + :return: The time_masking_finish of this DataMaskingActivitySummary. + :rtype: datetime + """ + return self._time_masking_finish + + @time_masking_finish.setter + def time_masking_finish(self, time_masking_finish): + """ + Sets the time_masking_finish of this DataMaskingActivitySummary. + The time the data masking activity actually completed / cancelled / failed. An RFC3339 formatted datetime string. + + + :param time_masking_finish: The time_masking_finish of this DataMaskingActivitySummary. + :type: datetime + """ + self._time_masking_finish = time_masking_finish + + 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/fusion_apps/models/family_maintenance_policy.py b/src/oci/fusion_apps/models/family_maintenance_policy.py new file mode 100644 index 0000000000..a65be77678 --- /dev/null +++ b/src/oci/fusion_apps/models/family_maintenance_policy.py @@ -0,0 +1,154 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 FamilyMaintenancePolicy(object): + """ + The policy that specifies the maintenance and upgrade preferences for an environment. For more information about the options, see `Understanding Environment Maintenance`__. + + __ https://docs.cloud.oracle.com/iaas/Content/fusion-applications/plan-environment-family.htm#about-env-maintenance + """ + + #: A constant which can be used with the concurrent_maintenance property of a FamilyMaintenancePolicy. + #: This constant has a value of "PROD" + CONCURRENT_MAINTENANCE_PROD = "PROD" + + #: A constant which can be used with the concurrent_maintenance property of a FamilyMaintenancePolicy. + #: This constant has a value of "NON_PROD" + CONCURRENT_MAINTENANCE_NON_PROD = "NON_PROD" + + #: A constant which can be used with the concurrent_maintenance property of a FamilyMaintenancePolicy. + #: This constant has a value of "DISABLED" + CONCURRENT_MAINTENANCE_DISABLED = "DISABLED" + + def __init__(self, **kwargs): + """ + Initializes a new FamilyMaintenancePolicy object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param quarterly_upgrade_begin_times: + The value to assign to the quarterly_upgrade_begin_times property of this FamilyMaintenancePolicy. + :type quarterly_upgrade_begin_times: str + + :param is_monthly_patching_enabled: + The value to assign to the is_monthly_patching_enabled property of this FamilyMaintenancePolicy. + :type is_monthly_patching_enabled: bool + + :param concurrent_maintenance: + The value to assign to the concurrent_maintenance property of this FamilyMaintenancePolicy. + Allowed values for this property are: "PROD", "NON_PROD", "DISABLED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type concurrent_maintenance: str + + """ + self.swagger_types = { + 'quarterly_upgrade_begin_times': 'str', + 'is_monthly_patching_enabled': 'bool', + 'concurrent_maintenance': 'str' + } + + self.attribute_map = { + 'quarterly_upgrade_begin_times': 'quarterlyUpgradeBeginTimes', + 'is_monthly_patching_enabled': 'isMonthlyPatchingEnabled', + 'concurrent_maintenance': 'concurrentMaintenance' + } + + self._quarterly_upgrade_begin_times = None + self._is_monthly_patching_enabled = None + self._concurrent_maintenance = None + + @property + def quarterly_upgrade_begin_times(self): + """ + Gets the quarterly_upgrade_begin_times of this FamilyMaintenancePolicy. + The quarterly maintenance month group schedule of the Fusion environment family. + + + :return: The quarterly_upgrade_begin_times of this FamilyMaintenancePolicy. + :rtype: str + """ + return self._quarterly_upgrade_begin_times + + @quarterly_upgrade_begin_times.setter + def quarterly_upgrade_begin_times(self, quarterly_upgrade_begin_times): + """ + Sets the quarterly_upgrade_begin_times of this FamilyMaintenancePolicy. + The quarterly maintenance month group schedule of the Fusion environment family. + + + :param quarterly_upgrade_begin_times: The quarterly_upgrade_begin_times of this FamilyMaintenancePolicy. + :type: str + """ + self._quarterly_upgrade_begin_times = quarterly_upgrade_begin_times + + @property + def is_monthly_patching_enabled(self): + """ + Gets the is_monthly_patching_enabled of this FamilyMaintenancePolicy. + When True, monthly patching is enabled for the environment family. + + + :return: The is_monthly_patching_enabled of this FamilyMaintenancePolicy. + :rtype: bool + """ + return self._is_monthly_patching_enabled + + @is_monthly_patching_enabled.setter + def is_monthly_patching_enabled(self, is_monthly_patching_enabled): + """ + Sets the is_monthly_patching_enabled of this FamilyMaintenancePolicy. + When True, monthly patching is enabled for the environment family. + + + :param is_monthly_patching_enabled: The is_monthly_patching_enabled of this FamilyMaintenancePolicy. + :type: bool + """ + self._is_monthly_patching_enabled = is_monthly_patching_enabled + + @property + def concurrent_maintenance(self): + """ + Gets the concurrent_maintenance of this FamilyMaintenancePolicy. + Option to upgrade both production and non-production environments at the same time. When set to PROD both types of environnments are upgraded on the production schedule. When set to NON_PROD both types of environments are upgraded on the non-production schedule. + + Allowed values for this property are: "PROD", "NON_PROD", "DISABLED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The concurrent_maintenance of this FamilyMaintenancePolicy. + :rtype: str + """ + return self._concurrent_maintenance + + @concurrent_maintenance.setter + def concurrent_maintenance(self, concurrent_maintenance): + """ + Sets the concurrent_maintenance of this FamilyMaintenancePolicy. + Option to upgrade both production and non-production environments at the same time. When set to PROD both types of environnments are upgraded on the production schedule. When set to NON_PROD both types of environments are upgraded on the non-production schedule. + + + :param concurrent_maintenance: The concurrent_maintenance of this FamilyMaintenancePolicy. + :type: str + """ + allowed_values = ["PROD", "NON_PROD", "DISABLED"] + if not value_allowed_none_or_none_sentinel(concurrent_maintenance, allowed_values): + concurrent_maintenance = 'UNKNOWN_ENUM_VALUE' + self._concurrent_maintenance = concurrent_maintenance + + 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/fusion_apps/models/faw_admin_info_details.py b/src/oci/fusion_apps/models/faw_admin_info_details.py new file mode 100644 index 0000000000..3d0e5a29e0 --- /dev/null +++ b/src/oci/fusion_apps/models/faw_admin_info_details.py @@ -0,0 +1,132 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 FawAdminInfoDetails(object): + """ + Admin information to provision Analytics Warehouse Servcie. + """ + + def __init__(self, **kwargs): + """ + Initializes a new FawAdminInfoDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param adw_admin_pass: + The value to assign to the adw_admin_pass property of this FawAdminInfoDetails. + :type adw_admin_pass: str + + :param faw_service_pass: + The value to assign to the faw_service_pass property of this FawAdminInfoDetails. + :type faw_service_pass: str + + :param notification_email: + The value to assign to the notification_email property of this FawAdminInfoDetails. + :type notification_email: str + + """ + self.swagger_types = { + 'adw_admin_pass': 'str', + 'faw_service_pass': 'str', + 'notification_email': 'str' + } + + self.attribute_map = { + 'adw_admin_pass': 'adwAdminPass', + 'faw_service_pass': 'fawServicePass', + 'notification_email': 'notificationEmail' + } + + self._adw_admin_pass = None + self._faw_service_pass = None + self._notification_email = None + + @property + def adw_admin_pass(self): + """ + Gets the adw_admin_pass of this FawAdminInfoDetails. + Password for the ADW to be created in User Tenancy + + + :return: The adw_admin_pass of this FawAdminInfoDetails. + :rtype: str + """ + return self._adw_admin_pass + + @adw_admin_pass.setter + def adw_admin_pass(self, adw_admin_pass): + """ + Sets the adw_admin_pass of this FawAdminInfoDetails. + Password for the ADW to be created in User Tenancy + + + :param adw_admin_pass: The adw_admin_pass of this FawAdminInfoDetails. + :type: str + """ + self._adw_admin_pass = adw_admin_pass + + @property + def faw_service_pass(self): + """ + Gets the faw_service_pass of this FawAdminInfoDetails. + Password for the auto-created FAWService user + + + :return: The faw_service_pass of this FawAdminInfoDetails. + :rtype: str + """ + return self._faw_service_pass + + @faw_service_pass.setter + def faw_service_pass(self, faw_service_pass): + """ + Sets the faw_service_pass of this FawAdminInfoDetails. + Password for the auto-created FAWService user + + + :param faw_service_pass: The faw_service_pass of this FawAdminInfoDetails. + :type: str + """ + self._faw_service_pass = faw_service_pass + + @property + def notification_email(self): + """ + Gets the notification_email of this FawAdminInfoDetails. + Email ID to send notification for Analytics Warehouse updates. + + + :return: The notification_email of this FawAdminInfoDetails. + :rtype: str + """ + return self._notification_email + + @notification_email.setter + def notification_email(self, notification_email): + """ + Sets the notification_email of this FawAdminInfoDetails. + Email ID to send notification for Analytics Warehouse updates. + + + :param notification_email: The notification_email of this FawAdminInfoDetails. + :type: str + """ + self._notification_email = notification_email + + 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/fusion_apps/models/fusion_environment.py b/src/oci/fusion_apps/models/fusion_environment.py new file mode 100644 index 0000000000..80de816010 --- /dev/null +++ b/src/oci/fusion_apps/models/fusion_environment.py @@ -0,0 +1,897 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 FusionEnvironment(object): + """ + Description of FusionEnvironment. + """ + + #: A constant which can be used with the fusion_environment_type property of a FusionEnvironment. + #: This constant has a value of "PRODUCTION" + FUSION_ENVIRONMENT_TYPE_PRODUCTION = "PRODUCTION" + + #: A constant which can be used with the fusion_environment_type property of a FusionEnvironment. + #: This constant has a value of "TEST" + FUSION_ENVIRONMENT_TYPE_TEST = "TEST" + + #: A constant which can be used with the fusion_environment_type property of a FusionEnvironment. + #: This constant has a value of "DEVELOPMENT" + FUSION_ENVIRONMENT_TYPE_DEVELOPMENT = "DEVELOPMENT" + + #: A constant which can be used with the lifecycle_state property of a FusionEnvironment. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + #: A constant which can be used with the lifecycle_state property of a FusionEnvironment. + #: This constant has a value of "UPDATING" + LIFECYCLE_STATE_UPDATING = "UPDATING" + + #: A constant which can be used with the lifecycle_state property of a FusionEnvironment. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a FusionEnvironment. + #: This constant has a value of "INACTIVE" + LIFECYCLE_STATE_INACTIVE = "INACTIVE" + + #: A constant which can be used with the lifecycle_state property of a FusionEnvironment. + #: This constant has a value of "DELETING" + LIFECYCLE_STATE_DELETING = "DELETING" + + #: A constant which can be used with the lifecycle_state property of a FusionEnvironment. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" + + #: A constant which can be used with the lifecycle_state property of a FusionEnvironment. + #: This constant has a value of "FAILED" + LIFECYCLE_STATE_FAILED = "FAILED" + + def __init__(self, **kwargs): + """ + Initializes a new FusionEnvironment 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 FusionEnvironment. + :type id: str + + :param display_name: + The value to assign to the display_name property of this FusionEnvironment. + :type display_name: str + + :param maintenance_policy: + The value to assign to the maintenance_policy property of this FusionEnvironment. + :type maintenance_policy: oci.fusion_apps.models.GetMaintenancePolicyDetails + + :param time_upcoming_maintenance: + The value to assign to the time_upcoming_maintenance property of this FusionEnvironment. + :type time_upcoming_maintenance: datetime + + :param compartment_id: + The value to assign to the compartment_id property of this FusionEnvironment. + :type compartment_id: str + + :param fusion_environment_family_id: + The value to assign to the fusion_environment_family_id property of this FusionEnvironment. + :type fusion_environment_family_id: str + + :param subscription_ids: + The value to assign to the subscription_ids property of this FusionEnvironment. + :type subscription_ids: list[str] + + :param fusion_environment_type: + The value to assign to the fusion_environment_type property of this FusionEnvironment. + Allowed values for this property are: "PRODUCTION", "TEST", "DEVELOPMENT", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type fusion_environment_type: str + + :param kms_key_id: + The value to assign to the kms_key_id property of this FusionEnvironment. + :type kms_key_id: str + + :param kms_key_info: + The value to assign to the kms_key_info property of this FusionEnvironment. + :type kms_key_info: object + + :param domain_id: + The value to assign to the domain_id property of this FusionEnvironment. + :type domain_id: str + + :param idcs_domain_url: + The value to assign to the idcs_domain_url property of this FusionEnvironment. + :type idcs_domain_url: str + + :param applied_patch_bundles: + The value to assign to the applied_patch_bundles property of this FusionEnvironment. + :type applied_patch_bundles: list[str] + + :param version: + The value to assign to the version property of this FusionEnvironment. + :type version: str + + :param public_url: + The value to assign to the public_url property of this FusionEnvironment. + :type public_url: str + + :param dns_prefix: + The value to assign to the dns_prefix property of this FusionEnvironment. + :type dns_prefix: str + + :param additional_language_packs: + The value to assign to the additional_language_packs property of this FusionEnvironment. + :type additional_language_packs: list[str] + + :param refresh: + The value to assign to the refresh property of this FusionEnvironment. + :type refresh: oci.fusion_apps.models.RefreshDetails + + :param rules: + The value to assign to the rules property of this FusionEnvironment. + :type rules: list[oci.fusion_apps.models.Rule] + + :param time_created: + The value to assign to the time_created property of this FusionEnvironment. + :type time_created: datetime + + :param time_updated: + The value to assign to the time_updated property of this FusionEnvironment. + :type time_updated: datetime + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this FusionEnvironment. + Allowed values for this property are: "CREATING", "UPDATING", "ACTIVE", "INACTIVE", "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 FusionEnvironment. + :type lifecycle_details: str + + :param system_name: + The value to assign to the system_name property of this FusionEnvironment. + :type system_name: str + + :param freeform_tags: + The value to assign to the freeform_tags property of this FusionEnvironment. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this FusionEnvironment. + :type defined_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'id': 'str', + 'display_name': 'str', + 'maintenance_policy': 'GetMaintenancePolicyDetails', + 'time_upcoming_maintenance': 'datetime', + 'compartment_id': 'str', + 'fusion_environment_family_id': 'str', + 'subscription_ids': 'list[str]', + 'fusion_environment_type': 'str', + 'kms_key_id': 'str', + 'kms_key_info': 'object', + 'domain_id': 'str', + 'idcs_domain_url': 'str', + 'applied_patch_bundles': 'list[str]', + 'version': 'str', + 'public_url': 'str', + 'dns_prefix': 'str', + 'additional_language_packs': 'list[str]', + 'refresh': 'RefreshDetails', + 'rules': 'list[Rule]', + 'time_created': 'datetime', + 'time_updated': 'datetime', + 'lifecycle_state': 'str', + 'lifecycle_details': 'str', + 'system_name': 'str', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))' + } + + self.attribute_map = { + 'id': 'id', + 'display_name': 'displayName', + 'maintenance_policy': 'maintenancePolicy', + 'time_upcoming_maintenance': 'timeUpcomingMaintenance', + 'compartment_id': 'compartmentId', + 'fusion_environment_family_id': 'fusionEnvironmentFamilyId', + 'subscription_ids': 'subscriptionIds', + 'fusion_environment_type': 'fusionEnvironmentType', + 'kms_key_id': 'kmsKeyId', + 'kms_key_info': 'kmsKeyInfo', + 'domain_id': 'domainId', + 'idcs_domain_url': 'idcsDomainUrl', + 'applied_patch_bundles': 'appliedPatchBundles', + 'version': 'version', + 'public_url': 'publicUrl', + 'dns_prefix': 'dnsPrefix', + 'additional_language_packs': 'additionalLanguagePacks', + 'refresh': 'refresh', + 'rules': 'rules', + 'time_created': 'timeCreated', + 'time_updated': 'timeUpdated', + 'lifecycle_state': 'lifecycleState', + 'lifecycle_details': 'lifecycleDetails', + 'system_name': 'systemName', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags' + } + + self._id = None + self._display_name = None + self._maintenance_policy = None + self._time_upcoming_maintenance = None + self._compartment_id = None + self._fusion_environment_family_id = None + self._subscription_ids = None + self._fusion_environment_type = None + self._kms_key_id = None + self._kms_key_info = None + self._domain_id = None + self._idcs_domain_url = None + self._applied_patch_bundles = None + self._version = None + self._public_url = None + self._dns_prefix = None + self._additional_language_packs = None + self._refresh = None + self._rules = None + self._time_created = None + self._time_updated = None + self._lifecycle_state = None + self._lifecycle_details = None + self._system_name = None + self._freeform_tags = None + self._defined_tags = None + + @property + def id(self): + """ + **[Required]** Gets the id of this FusionEnvironment. + Unique identifier that is immutable on creation + + + :return: The id of this FusionEnvironment. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this FusionEnvironment. + Unique identifier that is immutable on creation + + + :param id: The id of this FusionEnvironment. + :type: str + """ + self._id = id + + @property + def display_name(self): + """ + **[Required]** Gets the display_name of this FusionEnvironment. + FusionEnvironment Identifier, can be renamed + + + :return: The display_name of this FusionEnvironment. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this FusionEnvironment. + FusionEnvironment Identifier, can be renamed + + + :param display_name: The display_name of this FusionEnvironment. + :type: str + """ + self._display_name = display_name + + @property + def maintenance_policy(self): + """ + Gets the maintenance_policy of this FusionEnvironment. + + :return: The maintenance_policy of this FusionEnvironment. + :rtype: oci.fusion_apps.models.GetMaintenancePolicyDetails + """ + return self._maintenance_policy + + @maintenance_policy.setter + def maintenance_policy(self, maintenance_policy): + """ + Sets the maintenance_policy of this FusionEnvironment. + + :param maintenance_policy: The maintenance_policy of this FusionEnvironment. + :type: oci.fusion_apps.models.GetMaintenancePolicyDetails + """ + self._maintenance_policy = maintenance_policy + + @property + def time_upcoming_maintenance(self): + """ + Gets the time_upcoming_maintenance of this FusionEnvironment. + The next maintenance for this environment + + + :return: The time_upcoming_maintenance of this FusionEnvironment. + :rtype: datetime + """ + return self._time_upcoming_maintenance + + @time_upcoming_maintenance.setter + def time_upcoming_maintenance(self, time_upcoming_maintenance): + """ + Sets the time_upcoming_maintenance of this FusionEnvironment. + The next maintenance for this environment + + + :param time_upcoming_maintenance: The time_upcoming_maintenance of this FusionEnvironment. + :type: datetime + """ + self._time_upcoming_maintenance = time_upcoming_maintenance + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this FusionEnvironment. + Compartment Identifier + + + :return: The compartment_id of this FusionEnvironment. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this FusionEnvironment. + Compartment Identifier + + + :param compartment_id: The compartment_id of this FusionEnvironment. + :type: str + """ + self._compartment_id = compartment_id + + @property + def fusion_environment_family_id(self): + """ + Gets the fusion_environment_family_id of this FusionEnvironment. + FusionEnvironmentFamily Identifier + + + :return: The fusion_environment_family_id of this FusionEnvironment. + :rtype: str + """ + return self._fusion_environment_family_id + + @fusion_environment_family_id.setter + def fusion_environment_family_id(self, fusion_environment_family_id): + """ + Sets the fusion_environment_family_id of this FusionEnvironment. + FusionEnvironmentFamily Identifier + + + :param fusion_environment_family_id: The fusion_environment_family_id of this FusionEnvironment. + :type: str + """ + self._fusion_environment_family_id = fusion_environment_family_id + + @property + def subscription_ids(self): + """ + Gets the subscription_ids of this FusionEnvironment. + List of subscription IDs. + + + :return: The subscription_ids of this FusionEnvironment. + :rtype: list[str] + """ + return self._subscription_ids + + @subscription_ids.setter + def subscription_ids(self, subscription_ids): + """ + Sets the subscription_ids of this FusionEnvironment. + List of subscription IDs. + + + :param subscription_ids: The subscription_ids of this FusionEnvironment. + :type: list[str] + """ + self._subscription_ids = subscription_ids + + @property + def fusion_environment_type(self): + """ + **[Required]** Gets the fusion_environment_type of this FusionEnvironment. + Type of the FusionEnvironment. + + Allowed values for this property are: "PRODUCTION", "TEST", "DEVELOPMENT", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The fusion_environment_type of this FusionEnvironment. + :rtype: str + """ + return self._fusion_environment_type + + @fusion_environment_type.setter + def fusion_environment_type(self, fusion_environment_type): + """ + Sets the fusion_environment_type of this FusionEnvironment. + Type of the FusionEnvironment. + + + :param fusion_environment_type: The fusion_environment_type of this FusionEnvironment. + :type: str + """ + allowed_values = ["PRODUCTION", "TEST", "DEVELOPMENT"] + if not value_allowed_none_or_none_sentinel(fusion_environment_type, allowed_values): + fusion_environment_type = 'UNKNOWN_ENUM_VALUE' + self._fusion_environment_type = fusion_environment_type + + @property + def kms_key_id(self): + """ + Gets the kms_key_id of this FusionEnvironment. + BYOK key id + + + :return: The kms_key_id of this FusionEnvironment. + :rtype: str + """ + return self._kms_key_id + + @kms_key_id.setter + def kms_key_id(self, kms_key_id): + """ + Sets the kms_key_id of this FusionEnvironment. + BYOK key id + + + :param kms_key_id: The kms_key_id of this FusionEnvironment. + :type: str + """ + self._kms_key_id = kms_key_id + + @property + def kms_key_info(self): + """ + Gets the kms_key_info of this FusionEnvironment. + BYOK key info + + + :return: The kms_key_info of this FusionEnvironment. + :rtype: object + """ + return self._kms_key_info + + @kms_key_info.setter + def kms_key_info(self, kms_key_info): + """ + Sets the kms_key_info of this FusionEnvironment. + BYOK key info + + + :param kms_key_info: The kms_key_info of this FusionEnvironment. + :type: object + """ + self._kms_key_info = kms_key_info + + @property + def domain_id(self): + """ + Gets the domain_id of this FusionEnvironment. + The IDCS domain created for the fusion instance + + + :return: The domain_id of this FusionEnvironment. + :rtype: str + """ + return self._domain_id + + @domain_id.setter + def domain_id(self, domain_id): + """ + Sets the domain_id of this FusionEnvironment. + The IDCS domain created for the fusion instance + + + :param domain_id: The domain_id of this FusionEnvironment. + :type: str + """ + self._domain_id = domain_id + + @property + def idcs_domain_url(self): + """ + Gets the idcs_domain_url of this FusionEnvironment. + The IDCS Domain URL + + + :return: The idcs_domain_url of this FusionEnvironment. + :rtype: str + """ + return self._idcs_domain_url + + @idcs_domain_url.setter + def idcs_domain_url(self, idcs_domain_url): + """ + Sets the idcs_domain_url of this FusionEnvironment. + The IDCS Domain URL + + + :param idcs_domain_url: The idcs_domain_url of this FusionEnvironment. + :type: str + """ + self._idcs_domain_url = idcs_domain_url + + @property + def applied_patch_bundles(self): + """ + Gets the applied_patch_bundles of this FusionEnvironment. + Patch bundle names + + + :return: The applied_patch_bundles of this FusionEnvironment. + :rtype: list[str] + """ + return self._applied_patch_bundles + + @applied_patch_bundles.setter + def applied_patch_bundles(self, applied_patch_bundles): + """ + Sets the applied_patch_bundles of this FusionEnvironment. + Patch bundle names + + + :param applied_patch_bundles: The applied_patch_bundles of this FusionEnvironment. + :type: list[str] + """ + self._applied_patch_bundles = applied_patch_bundles + + @property + def version(self): + """ + Gets the version of this FusionEnvironment. + Version of Fusion Apps used by this environment + + + :return: The version of this FusionEnvironment. + :rtype: str + """ + return self._version + + @version.setter + def version(self, version): + """ + Sets the version of this FusionEnvironment. + Version of Fusion Apps used by this environment + + + :param version: The version of this FusionEnvironment. + :type: str + """ + self._version = version + + @property + def public_url(self): + """ + Gets the public_url of this FusionEnvironment. + Public URL + + + :return: The public_url of this FusionEnvironment. + :rtype: str + """ + return self._public_url + + @public_url.setter + def public_url(self, public_url): + """ + Sets the public_url of this FusionEnvironment. + Public URL + + + :param public_url: The public_url of this FusionEnvironment. + :type: str + """ + self._public_url = public_url + + @property + def dns_prefix(self): + """ + Gets the dns_prefix of this FusionEnvironment. + DNS prefix + + + :return: The dns_prefix of this FusionEnvironment. + :rtype: str + """ + return self._dns_prefix + + @dns_prefix.setter + def dns_prefix(self, dns_prefix): + """ + Sets the dns_prefix of this FusionEnvironment. + DNS prefix + + + :param dns_prefix: The dns_prefix of this FusionEnvironment. + :type: str + """ + self._dns_prefix = dns_prefix + + @property + def additional_language_packs(self): + """ + Gets the additional_language_packs of this FusionEnvironment. + Language packs + + + :return: The additional_language_packs of this FusionEnvironment. + :rtype: list[str] + """ + return self._additional_language_packs + + @additional_language_packs.setter + def additional_language_packs(self, additional_language_packs): + """ + Sets the additional_language_packs of this FusionEnvironment. + Language packs + + + :param additional_language_packs: The additional_language_packs of this FusionEnvironment. + :type: list[str] + """ + self._additional_language_packs = additional_language_packs + + @property + def refresh(self): + """ + Gets the refresh of this FusionEnvironment. + + :return: The refresh of this FusionEnvironment. + :rtype: oci.fusion_apps.models.RefreshDetails + """ + return self._refresh + + @refresh.setter + def refresh(self, refresh): + """ + Sets the refresh of this FusionEnvironment. + + :param refresh: The refresh of this FusionEnvironment. + :type: oci.fusion_apps.models.RefreshDetails + """ + self._refresh = refresh + + @property + def rules(self): + """ + Gets the rules of this FusionEnvironment. + Network Access Control Rules + + + :return: The rules of this FusionEnvironment. + :rtype: list[oci.fusion_apps.models.Rule] + """ + return self._rules + + @rules.setter + def rules(self, rules): + """ + Sets the rules of this FusionEnvironment. + Network Access Control Rules + + + :param rules: The rules of this FusionEnvironment. + :type: list[oci.fusion_apps.models.Rule] + """ + self._rules = rules + + @property + def time_created(self): + """ + Gets the time_created of this FusionEnvironment. + The time the the FusionEnvironment was created. An RFC3339 formatted datetime string + + + :return: The time_created of this FusionEnvironment. + :rtype: datetime + """ + return self._time_created + + @time_created.setter + def time_created(self, time_created): + """ + Sets the time_created of this FusionEnvironment. + The time the the FusionEnvironment was created. An RFC3339 formatted datetime string + + + :param time_created: The time_created of this FusionEnvironment. + :type: datetime + """ + self._time_created = time_created + + @property + def time_updated(self): + """ + Gets the time_updated of this FusionEnvironment. + The time the FusionEnvironment was updated. An RFC3339 formatted datetime string + + + :return: The time_updated of this FusionEnvironment. + :rtype: datetime + """ + return self._time_updated + + @time_updated.setter + def time_updated(self, time_updated): + """ + Sets the time_updated of this FusionEnvironment. + The time the FusionEnvironment was updated. An RFC3339 formatted datetime string + + + :param time_updated: The time_updated of this FusionEnvironment. + :type: datetime + """ + self._time_updated = time_updated + + @property + def lifecycle_state(self): + """ + **[Required]** Gets the lifecycle_state of this FusionEnvironment. + The current state of the ServiceInstance. + + Allowed values for this property are: "CREATING", "UPDATING", "ACTIVE", "INACTIVE", "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 FusionEnvironment. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this FusionEnvironment. + The current state of the ServiceInstance. + + + :param lifecycle_state: The lifecycle_state of this FusionEnvironment. + :type: str + """ + allowed_values = ["CREATING", "UPDATING", "ACTIVE", "INACTIVE", "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 FusionEnvironment. + A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. + + + :return: The lifecycle_details of this FusionEnvironment. + :rtype: str + """ + return self._lifecycle_details + + @lifecycle_details.setter + def lifecycle_details(self, lifecycle_details): + """ + Sets the lifecycle_details of this FusionEnvironment. + A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. + + + :param lifecycle_details: The lifecycle_details of this FusionEnvironment. + :type: str + """ + self._lifecycle_details = lifecycle_details + + @property + def system_name(self): + """ + Gets the system_name of this FusionEnvironment. + Environment Specific Guid/ System Name + + + :return: The system_name of this FusionEnvironment. + :rtype: str + """ + return self._system_name + + @system_name.setter + def system_name(self, system_name): + """ + Sets the system_name of this FusionEnvironment. + Environment Specific Guid/ System Name + + + :param system_name: The system_name of this FusionEnvironment. + :type: str + """ + self._system_name = system_name + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this FusionEnvironment. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :return: The freeform_tags of this FusionEnvironment. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this FusionEnvironment. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :param freeform_tags: The freeform_tags of this FusionEnvironment. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this FusionEnvironment. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this FusionEnvironment. + :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 FusionEnvironment. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this FusionEnvironment. + :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/fusion_apps/models/fusion_environment_collection.py b/src/oci/fusion_apps/models/fusion_environment_collection.py new file mode 100644 index 0000000000..6a35c35290 --- /dev/null +++ b/src/oci/fusion_apps/models/fusion_environment_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 FusionEnvironmentCollection(object): + """ + Results of a fusion environment search. + """ + + def __init__(self, **kwargs): + """ + Initializes a new FusionEnvironmentCollection 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 FusionEnvironmentCollection. + :type items: list[oci.fusion_apps.models.FusionEnvironmentSummary] + + """ + self.swagger_types = { + 'items': 'list[FusionEnvironmentSummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this FusionEnvironmentCollection. + A page of FusionEnvironmentSummary objects. + + + :return: The items of this FusionEnvironmentCollection. + :rtype: list[oci.fusion_apps.models.FusionEnvironmentSummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this FusionEnvironmentCollection. + A page of FusionEnvironmentSummary objects. + + + :param items: The items of this FusionEnvironmentCollection. + :type: list[oci.fusion_apps.models.FusionEnvironmentSummary] + """ + 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/fusion_apps/models/fusion_environment_family.py b/src/oci/fusion_apps/models/fusion_environment_family.py new file mode 100644 index 0000000000..2d75247232 --- /dev/null +++ b/src/oci/fusion_apps/models/fusion_environment_family.py @@ -0,0 +1,445 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 FusionEnvironmentFamily(object): + """ + Details of a Fusion environment family. An environment family is a logical grouping of environments. The environment family defines a set of characteristics that are shared across the environments to allow consistent management and maintenance across your production, test, and development environments. For more information, see `Planning an Environment Family`__. + + __ https://docs.cloud.oracle.com/iaas/Content/fusion-applications/plan-environment-family.htm + """ + + #: A constant which can be used with the lifecycle_state property of a FusionEnvironmentFamily. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + #: A constant which can be used with the lifecycle_state property of a FusionEnvironmentFamily. + #: This constant has a value of "UPDATING" + LIFECYCLE_STATE_UPDATING = "UPDATING" + + #: A constant which can be used with the lifecycle_state property of a FusionEnvironmentFamily. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a FusionEnvironmentFamily. + #: This constant has a value of "DELETING" + LIFECYCLE_STATE_DELETING = "DELETING" + + #: A constant which can be used with the lifecycle_state property of a FusionEnvironmentFamily. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" + + #: A constant which can be used with the lifecycle_state property of a FusionEnvironmentFamily. + #: This constant has a value of "FAILED" + LIFECYCLE_STATE_FAILED = "FAILED" + + def __init__(self, **kwargs): + """ + Initializes a new FusionEnvironmentFamily 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 FusionEnvironmentFamily. + :type id: str + + :param display_name: + The value to assign to the display_name property of this FusionEnvironmentFamily. + :type display_name: str + + :param family_maintenance_policy: + The value to assign to the family_maintenance_policy property of this FusionEnvironmentFamily. + :type family_maintenance_policy: oci.fusion_apps.models.FamilyMaintenancePolicy + + :param compartment_id: + The value to assign to the compartment_id property of this FusionEnvironmentFamily. + :type compartment_id: str + + :param subscription_ids: + The value to assign to the subscription_ids property of this FusionEnvironmentFamily. + :type subscription_ids: list[str] + + :param is_subscription_update_needed: + The value to assign to the is_subscription_update_needed property of this FusionEnvironmentFamily. + :type is_subscription_update_needed: bool + + :param time_created: + The value to assign to the time_created property of this FusionEnvironmentFamily. + :type time_created: datetime + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this FusionEnvironmentFamily. + Allowed values for this property are: "CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type lifecycle_state: str + + :param lifecycle_details: + The value to assign to the lifecycle_details property of this FusionEnvironmentFamily. + :type lifecycle_details: str + + :param system_name: + The value to assign to the system_name property of this FusionEnvironmentFamily. + :type system_name: str + + :param freeform_tags: + The value to assign to the freeform_tags property of this FusionEnvironmentFamily. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this FusionEnvironmentFamily. + :type defined_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'id': 'str', + 'display_name': 'str', + 'family_maintenance_policy': 'FamilyMaintenancePolicy', + 'compartment_id': 'str', + 'subscription_ids': 'list[str]', + 'is_subscription_update_needed': 'bool', + 'time_created': 'datetime', + 'lifecycle_state': 'str', + 'lifecycle_details': 'str', + 'system_name': 'str', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))' + } + + self.attribute_map = { + 'id': 'id', + 'display_name': 'displayName', + 'family_maintenance_policy': 'familyMaintenancePolicy', + 'compartment_id': 'compartmentId', + 'subscription_ids': 'subscriptionIds', + 'is_subscription_update_needed': 'isSubscriptionUpdateNeeded', + 'time_created': 'timeCreated', + 'lifecycle_state': 'lifecycleState', + 'lifecycle_details': 'lifecycleDetails', + 'system_name': 'systemName', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags' + } + + self._id = None + self._display_name = None + self._family_maintenance_policy = None + self._compartment_id = None + self._subscription_ids = None + self._is_subscription_update_needed = None + self._time_created = None + self._lifecycle_state = None + self._lifecycle_details = None + self._system_name = None + self._freeform_tags = None + self._defined_tags = None + + @property + def id(self): + """ + **[Required]** Gets the id of this FusionEnvironmentFamily. + The unique identifier (OCID) of the environment family. Can't be changed after creation. + + + :return: The id of this FusionEnvironmentFamily. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this FusionEnvironmentFamily. + The unique identifier (OCID) of the environment family. Can't be changed after creation. + + + :param id: The id of this FusionEnvironmentFamily. + :type: str + """ + self._id = id + + @property + def display_name(self): + """ + **[Required]** Gets the display_name of this FusionEnvironmentFamily. + A friendly name for the environment family. The name must contain only letters, numbers, dashes, and underscores. Can be changed later. + + + :return: The display_name of this FusionEnvironmentFamily. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this FusionEnvironmentFamily. + A friendly name for the environment family. The name must contain only letters, numbers, dashes, and underscores. Can be changed later. + + + :param display_name: The display_name of this FusionEnvironmentFamily. + :type: str + """ + self._display_name = display_name + + @property + def family_maintenance_policy(self): + """ + Gets the family_maintenance_policy of this FusionEnvironmentFamily. + + :return: The family_maintenance_policy of this FusionEnvironmentFamily. + :rtype: oci.fusion_apps.models.FamilyMaintenancePolicy + """ + return self._family_maintenance_policy + + @family_maintenance_policy.setter + def family_maintenance_policy(self, family_maintenance_policy): + """ + Sets the family_maintenance_policy of this FusionEnvironmentFamily. + + :param family_maintenance_policy: The family_maintenance_policy of this FusionEnvironmentFamily. + :type: oci.fusion_apps.models.FamilyMaintenancePolicy + """ + self._family_maintenance_policy = family_maintenance_policy + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this FusionEnvironmentFamily. + The OCID of the compartment where the environment family is located. + + + :return: The compartment_id of this FusionEnvironmentFamily. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this FusionEnvironmentFamily. + The OCID of the compartment where the environment family is located. + + + :param compartment_id: The compartment_id of this FusionEnvironmentFamily. + :type: str + """ + self._compartment_id = compartment_id + + @property + def subscription_ids(self): + """ + **[Required]** Gets the subscription_ids of this FusionEnvironmentFamily. + The list of the IDs of the applications subscriptions that are associated with the environment family. + + + :return: The subscription_ids of this FusionEnvironmentFamily. + :rtype: list[str] + """ + return self._subscription_ids + + @subscription_ids.setter + def subscription_ids(self, subscription_ids): + """ + Sets the subscription_ids of this FusionEnvironmentFamily. + The list of the IDs of the applications subscriptions that are associated with the environment family. + + + :param subscription_ids: The subscription_ids of this FusionEnvironmentFamily. + :type: list[str] + """ + self._subscription_ids = subscription_ids + + @property + def is_subscription_update_needed(self): + """ + Gets the is_subscription_update_needed of this FusionEnvironmentFamily. + When set to True, a subscription update is required for the environment family. + + + :return: The is_subscription_update_needed of this FusionEnvironmentFamily. + :rtype: bool + """ + return self._is_subscription_update_needed + + @is_subscription_update_needed.setter + def is_subscription_update_needed(self, is_subscription_update_needed): + """ + Sets the is_subscription_update_needed of this FusionEnvironmentFamily. + When set to True, a subscription update is required for the environment family. + + + :param is_subscription_update_needed: The is_subscription_update_needed of this FusionEnvironmentFamily. + :type: bool + """ + self._is_subscription_update_needed = is_subscription_update_needed + + @property + def time_created(self): + """ + Gets the time_created of this FusionEnvironmentFamily. + The time the the FusionEnvironmentFamily was created. An RFC3339 formatted datetime string. + + + :return: The time_created of this FusionEnvironmentFamily. + :rtype: datetime + """ + return self._time_created + + @time_created.setter + def time_created(self, time_created): + """ + Sets the time_created of this FusionEnvironmentFamily. + The time the the FusionEnvironmentFamily was created. An RFC3339 formatted datetime string. + + + :param time_created: The time_created of this FusionEnvironmentFamily. + :type: datetime + """ + self._time_created = time_created + + @property + def lifecycle_state(self): + """ + **[Required]** Gets the lifecycle_state of this FusionEnvironmentFamily. + The current state of the FusionEnvironmentFamily. + + Allowed values for this property are: "CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The lifecycle_state of this FusionEnvironmentFamily. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this FusionEnvironmentFamily. + The current state of the FusionEnvironmentFamily. + + + :param lifecycle_state: The lifecycle_state of this FusionEnvironmentFamily. + :type: str + """ + allowed_values = ["CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED"] + if not value_allowed_none_or_none_sentinel(lifecycle_state, allowed_values): + lifecycle_state = 'UNKNOWN_ENUM_VALUE' + self._lifecycle_state = lifecycle_state + + @property + def lifecycle_details(self): + """ + Gets the lifecycle_details of this FusionEnvironmentFamily. + A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. + + + :return: The lifecycle_details of this FusionEnvironmentFamily. + :rtype: str + """ + return self._lifecycle_details + + @lifecycle_details.setter + def lifecycle_details(self, lifecycle_details): + """ + Sets the lifecycle_details of this FusionEnvironmentFamily. + A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. + + + :param lifecycle_details: The lifecycle_details of this FusionEnvironmentFamily. + :type: str + """ + self._lifecycle_details = lifecycle_details + + @property + def system_name(self): + """ + Gets the system_name of this FusionEnvironmentFamily. + Environment Specific Guid/ System Name + + + :return: The system_name of this FusionEnvironmentFamily. + :rtype: str + """ + return self._system_name + + @system_name.setter + def system_name(self, system_name): + """ + Sets the system_name of this FusionEnvironmentFamily. + Environment Specific Guid/ System Name + + + :param system_name: The system_name of this FusionEnvironmentFamily. + :type: str + """ + self._system_name = system_name + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this FusionEnvironmentFamily. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :return: The freeform_tags of this FusionEnvironmentFamily. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this FusionEnvironmentFamily. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :param freeform_tags: The freeform_tags of this FusionEnvironmentFamily. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this FusionEnvironmentFamily. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this FusionEnvironmentFamily. + :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 FusionEnvironmentFamily. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this FusionEnvironmentFamily. + :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/fusion_apps/models/fusion_environment_family_collection.py b/src/oci/fusion_apps/models/fusion_environment_family_collection.py new file mode 100644 index 0000000000..13af14d6f9 --- /dev/null +++ b/src/oci/fusion_apps/models/fusion_environment_family_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 FusionEnvironmentFamilyCollection(object): + """ + Results of a Fusion environment family search. + """ + + def __init__(self, **kwargs): + """ + Initializes a new FusionEnvironmentFamilyCollection 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 FusionEnvironmentFamilyCollection. + :type items: list[oci.fusion_apps.models.FusionEnvironmentFamilySummary] + + """ + self.swagger_types = { + 'items': 'list[FusionEnvironmentFamilySummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this FusionEnvironmentFamilyCollection. + A page of FusionEnvironmentFamilySummary objects. + + + :return: The items of this FusionEnvironmentFamilyCollection. + :rtype: list[oci.fusion_apps.models.FusionEnvironmentFamilySummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this FusionEnvironmentFamilyCollection. + A page of FusionEnvironmentFamilySummary objects. + + + :param items: The items of this FusionEnvironmentFamilyCollection. + :type: list[oci.fusion_apps.models.FusionEnvironmentFamilySummary] + """ + 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/fusion_apps/models/fusion_environment_family_limits_and_usage.py b/src/oci/fusion_apps/models/fusion_environment_family_limits_and_usage.py new file mode 100644 index 0000000000..cb8d48250f --- /dev/null +++ b/src/oci/fusion_apps/models/fusion_environment_family_limits_and_usage.py @@ -0,0 +1,120 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 FusionEnvironmentFamilyLimitsAndUsage(object): + """ + Details of EnvironmentLimits. + """ + + def __init__(self, **kwargs): + """ + Initializes a new FusionEnvironmentFamilyLimitsAndUsage object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param production_limit_and_usage: + The value to assign to the production_limit_and_usage property of this FusionEnvironmentFamilyLimitsAndUsage. + :type production_limit_and_usage: oci.fusion_apps.models.LimitAndUsage + + :param test_limit_and_usage: + The value to assign to the test_limit_and_usage property of this FusionEnvironmentFamilyLimitsAndUsage. + :type test_limit_and_usage: oci.fusion_apps.models.LimitAndUsage + + :param development_limit_and_usage: + The value to assign to the development_limit_and_usage property of this FusionEnvironmentFamilyLimitsAndUsage. + :type development_limit_and_usage: oci.fusion_apps.models.LimitAndUsage + + """ + self.swagger_types = { + 'production_limit_and_usage': 'LimitAndUsage', + 'test_limit_and_usage': 'LimitAndUsage', + 'development_limit_and_usage': 'LimitAndUsage' + } + + self.attribute_map = { + 'production_limit_and_usage': 'productionLimitAndUsage', + 'test_limit_and_usage': 'testLimitAndUsage', + 'development_limit_and_usage': 'developmentLimitAndUsage' + } + + self._production_limit_and_usage = None + self._test_limit_and_usage = None + self._development_limit_and_usage = None + + @property + def production_limit_and_usage(self): + """ + **[Required]** Gets the production_limit_and_usage of this FusionEnvironmentFamilyLimitsAndUsage. + + :return: The production_limit_and_usage of this FusionEnvironmentFamilyLimitsAndUsage. + :rtype: oci.fusion_apps.models.LimitAndUsage + """ + return self._production_limit_and_usage + + @production_limit_and_usage.setter + def production_limit_and_usage(self, production_limit_and_usage): + """ + Sets the production_limit_and_usage of this FusionEnvironmentFamilyLimitsAndUsage. + + :param production_limit_and_usage: The production_limit_and_usage of this FusionEnvironmentFamilyLimitsAndUsage. + :type: oci.fusion_apps.models.LimitAndUsage + """ + self._production_limit_and_usage = production_limit_and_usage + + @property + def test_limit_and_usage(self): + """ + **[Required]** Gets the test_limit_and_usage of this FusionEnvironmentFamilyLimitsAndUsage. + + :return: The test_limit_and_usage of this FusionEnvironmentFamilyLimitsAndUsage. + :rtype: oci.fusion_apps.models.LimitAndUsage + """ + return self._test_limit_and_usage + + @test_limit_and_usage.setter + def test_limit_and_usage(self, test_limit_and_usage): + """ + Sets the test_limit_and_usage of this FusionEnvironmentFamilyLimitsAndUsage. + + :param test_limit_and_usage: The test_limit_and_usage of this FusionEnvironmentFamilyLimitsAndUsage. + :type: oci.fusion_apps.models.LimitAndUsage + """ + self._test_limit_and_usage = test_limit_and_usage + + @property + def development_limit_and_usage(self): + """ + **[Required]** Gets the development_limit_and_usage of this FusionEnvironmentFamilyLimitsAndUsage. + + :return: The development_limit_and_usage of this FusionEnvironmentFamilyLimitsAndUsage. + :rtype: oci.fusion_apps.models.LimitAndUsage + """ + return self._development_limit_and_usage + + @development_limit_and_usage.setter + def development_limit_and_usage(self, development_limit_and_usage): + """ + Sets the development_limit_and_usage of this FusionEnvironmentFamilyLimitsAndUsage. + + :param development_limit_and_usage: The development_limit_and_usage of this FusionEnvironmentFamilyLimitsAndUsage. + :type: oci.fusion_apps.models.LimitAndUsage + """ + self._development_limit_and_usage = development_limit_and_usage + + 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/fusion_apps/models/fusion_environment_family_summary.py b/src/oci/fusion_apps/models/fusion_environment_family_summary.py new file mode 100644 index 0000000000..9e2bc88b4f --- /dev/null +++ b/src/oci/fusion_apps/models/fusion_environment_family_summary.py @@ -0,0 +1,411 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 FusionEnvironmentFamilySummary(object): + """ + Summary information for a Fusion environment family. + """ + + def __init__(self, **kwargs): + """ + Initializes a new FusionEnvironmentFamilySummary 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 FusionEnvironmentFamilySummary. + :type id: str + + :param display_name: + The value to assign to the display_name property of this FusionEnvironmentFamilySummary. + :type display_name: str + + :param family_maintenance_policy: + The value to assign to the family_maintenance_policy property of this FusionEnvironmentFamilySummary. + :type family_maintenance_policy: oci.fusion_apps.models.FamilyMaintenancePolicy + + :param compartment_id: + The value to assign to the compartment_id property of this FusionEnvironmentFamilySummary. + :type compartment_id: str + + :param subscription_ids: + The value to assign to the subscription_ids property of this FusionEnvironmentFamilySummary. + :type subscription_ids: list[str] + + :param is_subscription_update_needed: + The value to assign to the is_subscription_update_needed property of this FusionEnvironmentFamilySummary. + :type is_subscription_update_needed: bool + + :param time_created: + The value to assign to the time_created property of this FusionEnvironmentFamilySummary. + :type time_created: datetime + + :param time_updated: + The value to assign to the time_updated property of this FusionEnvironmentFamilySummary. + :type time_updated: datetime + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this FusionEnvironmentFamilySummary. + :type lifecycle_state: str + + :param lifecycle_details: + The value to assign to the lifecycle_details property of this FusionEnvironmentFamilySummary. + :type lifecycle_details: str + + :param freeform_tags: + The value to assign to the freeform_tags property of this FusionEnvironmentFamilySummary. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this FusionEnvironmentFamilySummary. + :type defined_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'id': 'str', + 'display_name': 'str', + 'family_maintenance_policy': 'FamilyMaintenancePolicy', + 'compartment_id': 'str', + 'subscription_ids': 'list[str]', + 'is_subscription_update_needed': 'bool', + 'time_created': 'datetime', + 'time_updated': 'datetime', + 'lifecycle_state': 'str', + 'lifecycle_details': 'str', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))' + } + + self.attribute_map = { + 'id': 'id', + 'display_name': 'displayName', + 'family_maintenance_policy': 'familyMaintenancePolicy', + 'compartment_id': 'compartmentId', + 'subscription_ids': 'subscriptionIds', + 'is_subscription_update_needed': 'isSubscriptionUpdateNeeded', + 'time_created': 'timeCreated', + 'time_updated': 'timeUpdated', + 'lifecycle_state': 'lifecycleState', + 'lifecycle_details': 'lifecycleDetails', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags' + } + + self._id = None + self._display_name = None + self._family_maintenance_policy = None + self._compartment_id = None + self._subscription_ids = None + self._is_subscription_update_needed = None + self._time_created = None + self._time_updated = None + self._lifecycle_state = None + self._lifecycle_details = None + self._freeform_tags = None + self._defined_tags = None + + @property + def id(self): + """ + **[Required]** Gets the id of this FusionEnvironmentFamilySummary. + The unique identifier (OCID) of the environment family. Can't be changed after creation. + + + :return: The id of this FusionEnvironmentFamilySummary. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this FusionEnvironmentFamilySummary. + The unique identifier (OCID) of the environment family. Can't be changed after creation. + + + :param id: The id of this FusionEnvironmentFamilySummary. + :type: str + """ + self._id = id + + @property + def display_name(self): + """ + **[Required]** Gets the display_name of this FusionEnvironmentFamilySummary. + A friendly name for the environment family. The name must contain only letters, numbers, dashes, and underscores. Can be changed later. + + + :return: The display_name of this FusionEnvironmentFamilySummary. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this FusionEnvironmentFamilySummary. + A friendly name for the environment family. The name must contain only letters, numbers, dashes, and underscores. Can be changed later. + + + :param display_name: The display_name of this FusionEnvironmentFamilySummary. + :type: str + """ + self._display_name = display_name + + @property + def family_maintenance_policy(self): + """ + Gets the family_maintenance_policy of this FusionEnvironmentFamilySummary. + + :return: The family_maintenance_policy of this FusionEnvironmentFamilySummary. + :rtype: oci.fusion_apps.models.FamilyMaintenancePolicy + """ + return self._family_maintenance_policy + + @family_maintenance_policy.setter + def family_maintenance_policy(self, family_maintenance_policy): + """ + Sets the family_maintenance_policy of this FusionEnvironmentFamilySummary. + + :param family_maintenance_policy: The family_maintenance_policy of this FusionEnvironmentFamilySummary. + :type: oci.fusion_apps.models.FamilyMaintenancePolicy + """ + self._family_maintenance_policy = family_maintenance_policy + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this FusionEnvironmentFamilySummary. + The OCID of the compartment where the environment family is located. + + + :return: The compartment_id of this FusionEnvironmentFamilySummary. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this FusionEnvironmentFamilySummary. + The OCID of the compartment where the environment family is located. + + + :param compartment_id: The compartment_id of this FusionEnvironmentFamilySummary. + :type: str + """ + self._compartment_id = compartment_id + + @property + def subscription_ids(self): + """ + **[Required]** Gets the subscription_ids of this FusionEnvironmentFamilySummary. + The list of the IDs of the applications subscriptions that are associated with the environment family. + + + :return: The subscription_ids of this FusionEnvironmentFamilySummary. + :rtype: list[str] + """ + return self._subscription_ids + + @subscription_ids.setter + def subscription_ids(self, subscription_ids): + """ + Sets the subscription_ids of this FusionEnvironmentFamilySummary. + The list of the IDs of the applications subscriptions that are associated with the environment family. + + + :param subscription_ids: The subscription_ids of this FusionEnvironmentFamilySummary. + :type: list[str] + """ + self._subscription_ids = subscription_ids + + @property + def is_subscription_update_needed(self): + """ + Gets the is_subscription_update_needed of this FusionEnvironmentFamilySummary. + When set to True, a subscription update is required for the environment family. + + + :return: The is_subscription_update_needed of this FusionEnvironmentFamilySummary. + :rtype: bool + """ + return self._is_subscription_update_needed + + @is_subscription_update_needed.setter + def is_subscription_update_needed(self, is_subscription_update_needed): + """ + Sets the is_subscription_update_needed of this FusionEnvironmentFamilySummary. + When set to True, a subscription update is required for the environment family. + + + :param is_subscription_update_needed: The is_subscription_update_needed of this FusionEnvironmentFamilySummary. + :type: bool + """ + self._is_subscription_update_needed = is_subscription_update_needed + + @property + def time_created(self): + """ + Gets the time_created of this FusionEnvironmentFamilySummary. + The time the the FusionEnvironmentFamily was created. An RFC3339 formatted datetime string. + + + :return: The time_created of this FusionEnvironmentFamilySummary. + :rtype: datetime + """ + return self._time_created + + @time_created.setter + def time_created(self, time_created): + """ + Sets the time_created of this FusionEnvironmentFamilySummary. + The time the the FusionEnvironmentFamily was created. An RFC3339 formatted datetime string. + + + :param time_created: The time_created of this FusionEnvironmentFamilySummary. + :type: datetime + """ + self._time_created = time_created + + @property + def time_updated(self): + """ + Gets the time_updated of this FusionEnvironmentFamilySummary. + The time the FusionEnvironmentFamily was updated. An RFC3339 formatted datetime string. + + + :return: The time_updated of this FusionEnvironmentFamilySummary. + :rtype: datetime + """ + return self._time_updated + + @time_updated.setter + def time_updated(self, time_updated): + """ + Sets the time_updated of this FusionEnvironmentFamilySummary. + The time the FusionEnvironmentFamily was updated. An RFC3339 formatted datetime string. + + + :param time_updated: The time_updated of this FusionEnvironmentFamilySummary. + :type: datetime + """ + self._time_updated = time_updated + + @property + def lifecycle_state(self): + """ + **[Required]** Gets the lifecycle_state of this FusionEnvironmentFamilySummary. + The current state of the FusionEnvironmentFamily. + + + :return: The lifecycle_state of this FusionEnvironmentFamilySummary. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this FusionEnvironmentFamilySummary. + The current state of the FusionEnvironmentFamily. + + + :param lifecycle_state: The lifecycle_state of this FusionEnvironmentFamilySummary. + :type: str + """ + self._lifecycle_state = lifecycle_state + + @property + def lifecycle_details(self): + """ + Gets the lifecycle_details of this FusionEnvironmentFamilySummary. + A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. + + + :return: The lifecycle_details of this FusionEnvironmentFamilySummary. + :rtype: str + """ + return self._lifecycle_details + + @lifecycle_details.setter + def lifecycle_details(self, lifecycle_details): + """ + Sets the lifecycle_details of this FusionEnvironmentFamilySummary. + A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. + + + :param lifecycle_details: The lifecycle_details of this FusionEnvironmentFamilySummary. + :type: str + """ + self._lifecycle_details = lifecycle_details + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this FusionEnvironmentFamilySummary. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :return: The freeform_tags of this FusionEnvironmentFamilySummary. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this FusionEnvironmentFamilySummary. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :param freeform_tags: The freeform_tags of this FusionEnvironmentFamilySummary. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this FusionEnvironmentFamilySummary. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this FusionEnvironmentFamilySummary. + :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 FusionEnvironmentFamilySummary. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this FusionEnvironmentFamilySummary. + :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/fusion_apps/models/fusion_environment_status.py b/src/oci/fusion_apps/models/fusion_environment_status.py new file mode 100644 index 0000000000..439a2daa88 --- /dev/null +++ b/src/oci/fusion_apps/models/fusion_environment_status.py @@ -0,0 +1,104 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 FusionEnvironmentStatus(object): + """ + The health status of the Fusion Applications environment. For more information, see `Environment Status`__. + + __ https://docs.cloud.oracle.com/iaas/Content/fusion-applications/manage-environment.htm#environment-status + """ + + #: A constant which can be used with the status property of a FusionEnvironmentStatus. + #: This constant has a value of "AVAILABLE" + STATUS_AVAILABLE = "AVAILABLE" + + #: A constant which can be used with the status property of a FusionEnvironmentStatus. + #: This constant has a value of "UNAVAILABLE" + STATUS_UNAVAILABLE = "UNAVAILABLE" + + #: A constant which can be used with the status property of a FusionEnvironmentStatus. + #: This constant has a value of "NOT_APPLICABLE" + STATUS_NOT_APPLICABLE = "NOT_APPLICABLE" + + #: A constant which can be used with the status property of a FusionEnvironmentStatus. + #: This constant has a value of "MAINTENANCE_IN_PROGRESS" + STATUS_MAINTENANCE_IN_PROGRESS = "MAINTENANCE_IN_PROGRESS" + + #: A constant which can be used with the status property of a FusionEnvironmentStatus. + #: This constant has a value of "REFRESH_IN_PROGRESS" + STATUS_REFRESH_IN_PROGRESS = "REFRESH_IN_PROGRESS" + + #: A constant which can be used with the status property of a FusionEnvironmentStatus. + #: This constant has a value of "UNKNOWN" + STATUS_UNKNOWN = "UNKNOWN" + + def __init__(self, **kwargs): + """ + Initializes a new FusionEnvironmentStatus object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param status: + The value to assign to the status property of this FusionEnvironmentStatus. + Allowed values for this property are: "AVAILABLE", "UNAVAILABLE", "NOT_APPLICABLE", "MAINTENANCE_IN_PROGRESS", "REFRESH_IN_PROGRESS", "UNKNOWN", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type status: str + + """ + self.swagger_types = { + 'status': 'str' + } + + self.attribute_map = { + 'status': 'status' + } + + self._status = None + + @property + def status(self): + """ + **[Required]** Gets the status of this FusionEnvironmentStatus. + The data plane status of FusionEnvironment. + + Allowed values for this property are: "AVAILABLE", "UNAVAILABLE", "NOT_APPLICABLE", "MAINTENANCE_IN_PROGRESS", "REFRESH_IN_PROGRESS", "UNKNOWN", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The status of this FusionEnvironmentStatus. + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """ + Sets the status of this FusionEnvironmentStatus. + The data plane status of FusionEnvironment. + + + :param status: The status of this FusionEnvironmentStatus. + :type: str + """ + allowed_values = ["AVAILABLE", "UNAVAILABLE", "NOT_APPLICABLE", "MAINTENANCE_IN_PROGRESS", "REFRESH_IN_PROGRESS", "UNKNOWN"] + if not value_allowed_none_or_none_sentinel(status, allowed_values): + status = 'UNKNOWN_ENUM_VALUE' + self._status = status + + 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/fusion_apps/models/fusion_environment_summary.py b/src/oci/fusion_apps/models/fusion_environment_summary.py new file mode 100644 index 0000000000..1be801eeab --- /dev/null +++ b/src/oci/fusion_apps/models/fusion_environment_summary.py @@ -0,0 +1,628 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 FusionEnvironmentSummary(object): + """ + Summary of the internal FA Environment. + """ + + def __init__(self, **kwargs): + """ + Initializes a new FusionEnvironmentSummary 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 FusionEnvironmentSummary. + :type id: str + + :param display_name: + The value to assign to the display_name property of this FusionEnvironmentSummary. + :type display_name: str + + :param time_upcoming_maintenance: + The value to assign to the time_upcoming_maintenance property of this FusionEnvironmentSummary. + :type time_upcoming_maintenance: datetime + + :param maintenance_policy: + The value to assign to the maintenance_policy property of this FusionEnvironmentSummary. + :type maintenance_policy: oci.fusion_apps.models.GetMaintenancePolicyDetails + + :param compartment_id: + The value to assign to the compartment_id property of this FusionEnvironmentSummary. + :type compartment_id: str + + :param fusion_environment_family_id: + The value to assign to the fusion_environment_family_id property of this FusionEnvironmentSummary. + :type fusion_environment_family_id: str + + :param subscription_ids: + The value to assign to the subscription_ids property of this FusionEnvironmentSummary. + :type subscription_ids: list[str] + + :param applied_patch_bundles: + The value to assign to the applied_patch_bundles property of this FusionEnvironmentSummary. + :type applied_patch_bundles: list[str] + + :param fusion_environment_type: + The value to assign to the fusion_environment_type property of this FusionEnvironmentSummary. + :type fusion_environment_type: str + + :param version: + The value to assign to the version property of this FusionEnvironmentSummary. + :type version: str + + :param public_url: + The value to assign to the public_url property of this FusionEnvironmentSummary. + :type public_url: str + + :param dns_prefix: + The value to assign to the dns_prefix property of this FusionEnvironmentSummary. + :type dns_prefix: str + + :param additional_language_packs: + The value to assign to the additional_language_packs property of this FusionEnvironmentSummary. + :type additional_language_packs: list[str] + + :param time_created: + The value to assign to the time_created property of this FusionEnvironmentSummary. + :type time_created: datetime + + :param time_updated: + The value to assign to the time_updated property of this FusionEnvironmentSummary. + :type time_updated: datetime + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this FusionEnvironmentSummary. + :type lifecycle_state: str + + :param lifecycle_details: + The value to assign to the lifecycle_details property of this FusionEnvironmentSummary. + :type lifecycle_details: str + + :param freeform_tags: + The value to assign to the freeform_tags property of this FusionEnvironmentSummary. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this FusionEnvironmentSummary. + :type defined_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'id': 'str', + 'display_name': 'str', + 'time_upcoming_maintenance': 'datetime', + 'maintenance_policy': 'GetMaintenancePolicyDetails', + 'compartment_id': 'str', + 'fusion_environment_family_id': 'str', + 'subscription_ids': 'list[str]', + 'applied_patch_bundles': 'list[str]', + 'fusion_environment_type': 'str', + 'version': 'str', + 'public_url': 'str', + 'dns_prefix': 'str', + 'additional_language_packs': 'list[str]', + 'time_created': 'datetime', + 'time_updated': 'datetime', + 'lifecycle_state': 'str', + 'lifecycle_details': 'str', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))' + } + + self.attribute_map = { + 'id': 'id', + 'display_name': 'displayName', + 'time_upcoming_maintenance': 'timeUpcomingMaintenance', + 'maintenance_policy': 'maintenancePolicy', + 'compartment_id': 'compartmentId', + 'fusion_environment_family_id': 'fusionEnvironmentFamilyId', + 'subscription_ids': 'subscriptionIds', + 'applied_patch_bundles': 'appliedPatchBundles', + 'fusion_environment_type': 'fusionEnvironmentType', + 'version': 'version', + 'public_url': 'publicUrl', + 'dns_prefix': 'dnsPrefix', + 'additional_language_packs': 'additionalLanguagePacks', + 'time_created': 'timeCreated', + 'time_updated': 'timeUpdated', + 'lifecycle_state': 'lifecycleState', + 'lifecycle_details': 'lifecycleDetails', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags' + } + + self._id = None + self._display_name = None + self._time_upcoming_maintenance = None + self._maintenance_policy = None + self._compartment_id = None + self._fusion_environment_family_id = None + self._subscription_ids = None + self._applied_patch_bundles = None + self._fusion_environment_type = None + self._version = None + self._public_url = None + self._dns_prefix = None + self._additional_language_packs = None + self._time_created = None + self._time_updated = None + self._lifecycle_state = None + self._lifecycle_details = None + self._freeform_tags = None + self._defined_tags = None + + @property + def id(self): + """ + **[Required]** Gets the id of this FusionEnvironmentSummary. + Unique identifier that is immutable on creation + + + :return: The id of this FusionEnvironmentSummary. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this FusionEnvironmentSummary. + Unique identifier that is immutable on creation + + + :param id: The id of this FusionEnvironmentSummary. + :type: str + """ + self._id = id + + @property + def display_name(self): + """ + **[Required]** Gets the display_name of this FusionEnvironmentSummary. + FusionEnvironment Identifier, can be renamed + + + :return: The display_name of this FusionEnvironmentSummary. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this FusionEnvironmentSummary. + FusionEnvironment Identifier, can be renamed + + + :param display_name: The display_name of this FusionEnvironmentSummary. + :type: str + """ + self._display_name = display_name + + @property + def time_upcoming_maintenance(self): + """ + Gets the time_upcoming_maintenance of this FusionEnvironmentSummary. + The next maintenance for this environment + + + :return: The time_upcoming_maintenance of this FusionEnvironmentSummary. + :rtype: datetime + """ + return self._time_upcoming_maintenance + + @time_upcoming_maintenance.setter + def time_upcoming_maintenance(self, time_upcoming_maintenance): + """ + Sets the time_upcoming_maintenance of this FusionEnvironmentSummary. + The next maintenance for this environment + + + :param time_upcoming_maintenance: The time_upcoming_maintenance of this FusionEnvironmentSummary. + :type: datetime + """ + self._time_upcoming_maintenance = time_upcoming_maintenance + + @property + def maintenance_policy(self): + """ + Gets the maintenance_policy of this FusionEnvironmentSummary. + + :return: The maintenance_policy of this FusionEnvironmentSummary. + :rtype: oci.fusion_apps.models.GetMaintenancePolicyDetails + """ + return self._maintenance_policy + + @maintenance_policy.setter + def maintenance_policy(self, maintenance_policy): + """ + Sets the maintenance_policy of this FusionEnvironmentSummary. + + :param maintenance_policy: The maintenance_policy of this FusionEnvironmentSummary. + :type: oci.fusion_apps.models.GetMaintenancePolicyDetails + """ + self._maintenance_policy = maintenance_policy + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this FusionEnvironmentSummary. + Compartment Identifier + + + :return: The compartment_id of this FusionEnvironmentSummary. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this FusionEnvironmentSummary. + Compartment Identifier + + + :param compartment_id: The compartment_id of this FusionEnvironmentSummary. + :type: str + """ + self._compartment_id = compartment_id + + @property + def fusion_environment_family_id(self): + """ + Gets the fusion_environment_family_id of this FusionEnvironmentSummary. + FusionEnvironmentFamily Identifier + + + :return: The fusion_environment_family_id of this FusionEnvironmentSummary. + :rtype: str + """ + return self._fusion_environment_family_id + + @fusion_environment_family_id.setter + def fusion_environment_family_id(self, fusion_environment_family_id): + """ + Sets the fusion_environment_family_id of this FusionEnvironmentSummary. + FusionEnvironmentFamily Identifier + + + :param fusion_environment_family_id: The fusion_environment_family_id of this FusionEnvironmentSummary. + :type: str + """ + self._fusion_environment_family_id = fusion_environment_family_id + + @property + def subscription_ids(self): + """ + Gets the subscription_ids of this FusionEnvironmentSummary. + List of subscription IDs. + + + :return: The subscription_ids of this FusionEnvironmentSummary. + :rtype: list[str] + """ + return self._subscription_ids + + @subscription_ids.setter + def subscription_ids(self, subscription_ids): + """ + Sets the subscription_ids of this FusionEnvironmentSummary. + List of subscription IDs. + + + :param subscription_ids: The subscription_ids of this FusionEnvironmentSummary. + :type: list[str] + """ + self._subscription_ids = subscription_ids + + @property + def applied_patch_bundles(self): + """ + Gets the applied_patch_bundles of this FusionEnvironmentSummary. + Patch bundle names + + + :return: The applied_patch_bundles of this FusionEnvironmentSummary. + :rtype: list[str] + """ + return self._applied_patch_bundles + + @applied_patch_bundles.setter + def applied_patch_bundles(self, applied_patch_bundles): + """ + Sets the applied_patch_bundles of this FusionEnvironmentSummary. + Patch bundle names + + + :param applied_patch_bundles: The applied_patch_bundles of this FusionEnvironmentSummary. + :type: list[str] + """ + self._applied_patch_bundles = applied_patch_bundles + + @property + def fusion_environment_type(self): + """ + **[Required]** Gets the fusion_environment_type of this FusionEnvironmentSummary. + Type of the FusionEnvironment. + + + :return: The fusion_environment_type of this FusionEnvironmentSummary. + :rtype: str + """ + return self._fusion_environment_type + + @fusion_environment_type.setter + def fusion_environment_type(self, fusion_environment_type): + """ + Sets the fusion_environment_type of this FusionEnvironmentSummary. + Type of the FusionEnvironment. + + + :param fusion_environment_type: The fusion_environment_type of this FusionEnvironmentSummary. + :type: str + """ + self._fusion_environment_type = fusion_environment_type + + @property + def version(self): + """ + Gets the version of this FusionEnvironmentSummary. + Version of Fusion Apps used by this environment + + + :return: The version of this FusionEnvironmentSummary. + :rtype: str + """ + return self._version + + @version.setter + def version(self, version): + """ + Sets the version of this FusionEnvironmentSummary. + Version of Fusion Apps used by this environment + + + :param version: The version of this FusionEnvironmentSummary. + :type: str + """ + self._version = version + + @property + def public_url(self): + """ + Gets the public_url of this FusionEnvironmentSummary. + Public URL + + + :return: The public_url of this FusionEnvironmentSummary. + :rtype: str + """ + return self._public_url + + @public_url.setter + def public_url(self, public_url): + """ + Sets the public_url of this FusionEnvironmentSummary. + Public URL + + + :param public_url: The public_url of this FusionEnvironmentSummary. + :type: str + """ + self._public_url = public_url + + @property + def dns_prefix(self): + """ + Gets the dns_prefix of this FusionEnvironmentSummary. + DNS prefix + + + :return: The dns_prefix of this FusionEnvironmentSummary. + :rtype: str + """ + return self._dns_prefix + + @dns_prefix.setter + def dns_prefix(self, dns_prefix): + """ + Sets the dns_prefix of this FusionEnvironmentSummary. + DNS prefix + + + :param dns_prefix: The dns_prefix of this FusionEnvironmentSummary. + :type: str + """ + self._dns_prefix = dns_prefix + + @property + def additional_language_packs(self): + """ + Gets the additional_language_packs of this FusionEnvironmentSummary. + Language packs + + + :return: The additional_language_packs of this FusionEnvironmentSummary. + :rtype: list[str] + """ + return self._additional_language_packs + + @additional_language_packs.setter + def additional_language_packs(self, additional_language_packs): + """ + Sets the additional_language_packs of this FusionEnvironmentSummary. + Language packs + + + :param additional_language_packs: The additional_language_packs of this FusionEnvironmentSummary. + :type: list[str] + """ + self._additional_language_packs = additional_language_packs + + @property + def time_created(self): + """ + Gets the time_created of this FusionEnvironmentSummary. + The time the the FusionEnvironment was created. An RFC3339 formatted datetime string + + + :return: The time_created of this FusionEnvironmentSummary. + :rtype: datetime + """ + return self._time_created + + @time_created.setter + def time_created(self, time_created): + """ + Sets the time_created of this FusionEnvironmentSummary. + The time the the FusionEnvironment was created. An RFC3339 formatted datetime string + + + :param time_created: The time_created of this FusionEnvironmentSummary. + :type: datetime + """ + self._time_created = time_created + + @property + def time_updated(self): + """ + Gets the time_updated of this FusionEnvironmentSummary. + The time the FusionEnvironment was updated. An RFC3339 formatted datetime string + + + :return: The time_updated of this FusionEnvironmentSummary. + :rtype: datetime + """ + return self._time_updated + + @time_updated.setter + def time_updated(self, time_updated): + """ + Sets the time_updated of this FusionEnvironmentSummary. + The time the FusionEnvironment was updated. An RFC3339 formatted datetime string + + + :param time_updated: The time_updated of this FusionEnvironmentSummary. + :type: datetime + """ + self._time_updated = time_updated + + @property + def lifecycle_state(self): + """ + **[Required]** Gets the lifecycle_state of this FusionEnvironmentSummary. + The current state of the FusionEnvironment. + + + :return: The lifecycle_state of this FusionEnvironmentSummary. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this FusionEnvironmentSummary. + The current state of the FusionEnvironment. + + + :param lifecycle_state: The lifecycle_state of this FusionEnvironmentSummary. + :type: str + """ + self._lifecycle_state = lifecycle_state + + @property + def lifecycle_details(self): + """ + Gets the lifecycle_details of this FusionEnvironmentSummary. + A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. + + + :return: The lifecycle_details of this FusionEnvironmentSummary. + :rtype: str + """ + return self._lifecycle_details + + @lifecycle_details.setter + def lifecycle_details(self, lifecycle_details): + """ + Sets the lifecycle_details of this FusionEnvironmentSummary. + A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. + + + :param lifecycle_details: The lifecycle_details of this FusionEnvironmentSummary. + :type: str + """ + self._lifecycle_details = lifecycle_details + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this FusionEnvironmentSummary. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :return: The freeform_tags of this FusionEnvironmentSummary. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this FusionEnvironmentSummary. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :param freeform_tags: The freeform_tags of this FusionEnvironmentSummary. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this FusionEnvironmentSummary. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this FusionEnvironmentSummary. + :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 FusionEnvironmentSummary. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this FusionEnvironmentSummary. + :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/fusion_apps/models/get_maintenance_policy_details.py b/src/oci/fusion_apps/models/get_maintenance_policy_details.py new file mode 100644 index 0000000000..01ebd34eb7 --- /dev/null +++ b/src/oci/fusion_apps/models/get_maintenance_policy_details.py @@ -0,0 +1,130 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 GetMaintenancePolicyDetails(object): + """ + The policy that specifies the maintenance and upgrade preferences for an environment. For more information about the options, see `Understanding Environment Maintenance`__. + + __ https://docs.cloud.oracle.com/iaas/Content/fusion-applications/plan-environment-family.htm#about-env-maintenance + """ + + def __init__(self, **kwargs): + """ + Initializes a new GetMaintenancePolicyDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param quarterly_upgrade_begin_times: + The value to assign to the quarterly_upgrade_begin_times property of this GetMaintenancePolicyDetails. + :type quarterly_upgrade_begin_times: oci.fusion_apps.models.QuarterlyUpgradeBeginTimes + + :param monthly_patching_override: + The value to assign to the monthly_patching_override property of this GetMaintenancePolicyDetails. + :type monthly_patching_override: str + + :param environment_maintenance_override: + The value to assign to the environment_maintenance_override property of this GetMaintenancePolicyDetails. + :type environment_maintenance_override: str + + """ + self.swagger_types = { + 'quarterly_upgrade_begin_times': 'QuarterlyUpgradeBeginTimes', + 'monthly_patching_override': 'str', + 'environment_maintenance_override': 'str' + } + + self.attribute_map = { + 'quarterly_upgrade_begin_times': 'quarterlyUpgradeBeginTimes', + 'monthly_patching_override': 'monthlyPatchingOverride', + 'environment_maintenance_override': 'environmentMaintenanceOverride' + } + + self._quarterly_upgrade_begin_times = None + self._monthly_patching_override = None + self._environment_maintenance_override = None + + @property + def quarterly_upgrade_begin_times(self): + """ + Gets the quarterly_upgrade_begin_times of this GetMaintenancePolicyDetails. + + :return: The quarterly_upgrade_begin_times of this GetMaintenancePolicyDetails. + :rtype: oci.fusion_apps.models.QuarterlyUpgradeBeginTimes + """ + return self._quarterly_upgrade_begin_times + + @quarterly_upgrade_begin_times.setter + def quarterly_upgrade_begin_times(self, quarterly_upgrade_begin_times): + """ + Sets the quarterly_upgrade_begin_times of this GetMaintenancePolicyDetails. + + :param quarterly_upgrade_begin_times: The quarterly_upgrade_begin_times of this GetMaintenancePolicyDetails. + :type: oci.fusion_apps.models.QuarterlyUpgradeBeginTimes + """ + self._quarterly_upgrade_begin_times = quarterly_upgrade_begin_times + + @property + def monthly_patching_override(self): + """ + Gets the monthly_patching_override of this GetMaintenancePolicyDetails. + Whether the Fusion environment will be updated monthly or updated on the quarterly cycle. This setting overrides the monthly patching setting of its Fusion environment family. + + + :return: The monthly_patching_override of this GetMaintenancePolicyDetails. + :rtype: str + """ + return self._monthly_patching_override + + @monthly_patching_override.setter + def monthly_patching_override(self, monthly_patching_override): + """ + Sets the monthly_patching_override of this GetMaintenancePolicyDetails. + Whether the Fusion environment will be updated monthly or updated on the quarterly cycle. This setting overrides the monthly patching setting of its Fusion environment family. + + + :param monthly_patching_override: The monthly_patching_override of this GetMaintenancePolicyDetails. + :type: str + """ + self._monthly_patching_override = monthly_patching_override + + @property + def environment_maintenance_override(self): + """ + Gets the environment_maintenance_override of this GetMaintenancePolicyDetails. + User choice to upgrade both production and non-production environments at the same time. Overrides the Fusion environment family setting. + + + :return: The environment_maintenance_override of this GetMaintenancePolicyDetails. + :rtype: str + """ + return self._environment_maintenance_override + + @environment_maintenance_override.setter + def environment_maintenance_override(self, environment_maintenance_override): + """ + Sets the environment_maintenance_override of this GetMaintenancePolicyDetails. + User choice to upgrade both production and non-production environments at the same time. Overrides the Fusion environment family setting. + + + :param environment_maintenance_override: The environment_maintenance_override of this GetMaintenancePolicyDetails. + :type: str + """ + self._environment_maintenance_override = environment_maintenance_override + + 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/fusion_apps/models/kms_key_info.py b/src/oci/fusion_apps/models/kms_key_info.py new file mode 100644 index 0000000000..66301ab48e --- /dev/null +++ b/src/oci/fusion_apps/models/kms_key_info.py @@ -0,0 +1,281 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 KmsKeyInfo(object): + """ + kmsKeyInfo + """ + + #: A constant which can be used with the scheduled_key_status property of a KmsKeyInfo. + #: This constant has a value of "SCHEDULING" + SCHEDULED_KEY_STATUS_SCHEDULING = "SCHEDULING" + + #: A constant which can be used with the scheduled_key_status property of a KmsKeyInfo. + #: This constant has a value of "UPDATING" + SCHEDULED_KEY_STATUS_UPDATING = "UPDATING" + + #: A constant which can be used with the scheduled_key_status property of a KmsKeyInfo. + #: This constant has a value of "FAILED" + SCHEDULED_KEY_STATUS_FAILED = "FAILED" + + #: A constant which can be used with the scheduled_key_status property of a KmsKeyInfo. + #: This constant has a value of "NONE" + SCHEDULED_KEY_STATUS_NONE = "NONE" + + def __init__(self, **kwargs): + """ + Initializes a new KmsKeyInfo object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param active_key_id: + The value to assign to the active_key_id property of this KmsKeyInfo. + :type active_key_id: str + + :param active_key_version: + The value to assign to the active_key_version property of this KmsKeyInfo. + :type active_key_version: str + + :param scheduled_key_id: + The value to assign to the scheduled_key_id property of this KmsKeyInfo. + :type scheduled_key_id: str + + :param scheduled_key_version: + The value to assign to the scheduled_key_version property of this KmsKeyInfo. + :type scheduled_key_version: str + + :param current_key_lifecycle_state: + The value to assign to the current_key_lifecycle_state property of this KmsKeyInfo. + :type current_key_lifecycle_state: str + + :param scheduled_lifecycle_state: + The value to assign to the scheduled_lifecycle_state property of this KmsKeyInfo. + :type scheduled_lifecycle_state: str + + :param scheduled_key_status: + The value to assign to the scheduled_key_status property of this KmsKeyInfo. + Allowed values for this property are: "SCHEDULING", "UPDATING", "FAILED", "NONE" + :type scheduled_key_status: str + + """ + self.swagger_types = { + 'active_key_id': 'str', + 'active_key_version': 'str', + 'scheduled_key_id': 'str', + 'scheduled_key_version': 'str', + 'current_key_lifecycle_state': 'str', + 'scheduled_lifecycle_state': 'str', + 'scheduled_key_status': 'str' + } + + self.attribute_map = { + 'active_key_id': 'activeKeyId', + 'active_key_version': 'activeKeyVersion', + 'scheduled_key_id': 'scheduledKeyId', + 'scheduled_key_version': 'scheduledKeyVersion', + 'current_key_lifecycle_state': 'currentKeyLifecycleState', + 'scheduled_lifecycle_state': 'scheduledLifecycleState', + 'scheduled_key_status': 'scheduledKeyStatus' + } + + self._active_key_id = None + self._active_key_version = None + self._scheduled_key_id = None + self._scheduled_key_version = None + self._current_key_lifecycle_state = None + self._scheduled_lifecycle_state = None + self._scheduled_key_status = None + + @property + def active_key_id(self): + """ + Gets the active_key_id of this KmsKeyInfo. + current BYOK keyId facp is using + + + :return: The active_key_id of this KmsKeyInfo. + :rtype: str + """ + return self._active_key_id + + @active_key_id.setter + def active_key_id(self, active_key_id): + """ + Sets the active_key_id of this KmsKeyInfo. + current BYOK keyId facp is using + + + :param active_key_id: The active_key_id of this KmsKeyInfo. + :type: str + """ + self._active_key_id = active_key_id + + @property + def active_key_version(self): + """ + Gets the active_key_version of this KmsKeyInfo. + current key version facp is using + + + :return: The active_key_version of this KmsKeyInfo. + :rtype: str + """ + return self._active_key_version + + @active_key_version.setter + def active_key_version(self, active_key_version): + """ + Sets the active_key_version of this KmsKeyInfo. + current key version facp is using + + + :param active_key_version: The active_key_version of this KmsKeyInfo. + :type: str + """ + self._active_key_version = active_key_version + + @property + def scheduled_key_id(self): + """ + Gets the scheduled_key_id of this KmsKeyInfo. + scheduled keyId to be updated + + + :return: The scheduled_key_id of this KmsKeyInfo. + :rtype: str + """ + return self._scheduled_key_id + + @scheduled_key_id.setter + def scheduled_key_id(self, scheduled_key_id): + """ + Sets the scheduled_key_id of this KmsKeyInfo. + scheduled keyId to be updated + + + :param scheduled_key_id: The scheduled_key_id of this KmsKeyInfo. + :type: str + """ + self._scheduled_key_id = scheduled_key_id + + @property + def scheduled_key_version(self): + """ + Gets the scheduled_key_version of this KmsKeyInfo. + scheduled key version to be updated. + + + :return: The scheduled_key_version of this KmsKeyInfo. + :rtype: str + """ + return self._scheduled_key_version + + @scheduled_key_version.setter + def scheduled_key_version(self, scheduled_key_version): + """ + Sets the scheduled_key_version of this KmsKeyInfo. + scheduled key version to be updated. + + + :param scheduled_key_version: The scheduled_key_version of this KmsKeyInfo. + :type: str + """ + self._scheduled_key_version = scheduled_key_version + + @property + def current_key_lifecycle_state(self): + """ + Gets the current_key_lifecycle_state of this KmsKeyInfo. + current key lifeCycleState + + + :return: The current_key_lifecycle_state of this KmsKeyInfo. + :rtype: str + """ + return self._current_key_lifecycle_state + + @current_key_lifecycle_state.setter + def current_key_lifecycle_state(self, current_key_lifecycle_state): + """ + Sets the current_key_lifecycle_state of this KmsKeyInfo. + current key lifeCycleState + + + :param current_key_lifecycle_state: The current_key_lifecycle_state of this KmsKeyInfo. + :type: str + """ + self._current_key_lifecycle_state = current_key_lifecycle_state + + @property + def scheduled_lifecycle_state(self): + """ + Gets the scheduled_lifecycle_state of this KmsKeyInfo. + scheduled key lifeCycle state to be updated. + + + :return: The scheduled_lifecycle_state of this KmsKeyInfo. + :rtype: str + """ + return self._scheduled_lifecycle_state + + @scheduled_lifecycle_state.setter + def scheduled_lifecycle_state(self, scheduled_lifecycle_state): + """ + Sets the scheduled_lifecycle_state of this KmsKeyInfo. + scheduled key lifeCycle state to be updated. + + + :param scheduled_lifecycle_state: The scheduled_lifecycle_state of this KmsKeyInfo. + :type: str + """ + self._scheduled_lifecycle_state = scheduled_lifecycle_state + + @property + def scheduled_key_status(self): + """ + Gets the scheduled_key_status of this KmsKeyInfo. + the scheduled key status + + Allowed values for this property are: "SCHEDULING", "UPDATING", "FAILED", "NONE" + + + :return: The scheduled_key_status of this KmsKeyInfo. + :rtype: str + """ + return self._scheduled_key_status + + @scheduled_key_status.setter + def scheduled_key_status(self, scheduled_key_status): + """ + Sets the scheduled_key_status of this KmsKeyInfo. + the scheduled key status + + + :param scheduled_key_status: The scheduled_key_status of this KmsKeyInfo. + :type: str + """ + allowed_values = ["SCHEDULING", "UPDATING", "FAILED", "NONE"] + if not value_allowed_none_or_none_sentinel(scheduled_key_status, allowed_values): + raise ValueError( + "Invalid value for `scheduled_key_status`, must be None or one of {0}" + .format(allowed_values) + ) + self._scheduled_key_status = scheduled_key_status + + 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/fusion_apps/models/limit_and_usage.py b/src/oci/fusion_apps/models/limit_and_usage.py new file mode 100644 index 0000000000..38535047cf --- /dev/null +++ b/src/oci/fusion_apps/models/limit_and_usage.py @@ -0,0 +1,101 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 LimitAndUsage(object): + """ + The limit and usage for a specific environment type, for example, production, development, or test. + """ + + def __init__(self, **kwargs): + """ + Initializes a new LimitAndUsage object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param limit: + The value to assign to the limit property of this LimitAndUsage. + :type limit: int + + :param usage: + The value to assign to the usage property of this LimitAndUsage. + :type usage: int + + """ + self.swagger_types = { + 'limit': 'int', + 'usage': 'int' + } + + self.attribute_map = { + 'limit': 'limit', + 'usage': 'usage' + } + + self._limit = None + self._usage = None + + @property + def limit(self): + """ + **[Required]** Gets the limit of this LimitAndUsage. + The limit of current environment. + + + :return: The limit of this LimitAndUsage. + :rtype: int + """ + return self._limit + + @limit.setter + def limit(self, limit): + """ + Sets the limit of this LimitAndUsage. + The limit of current environment. + + + :param limit: The limit of this LimitAndUsage. + :type: int + """ + self._limit = limit + + @property + def usage(self): + """ + **[Required]** Gets the usage of this LimitAndUsage. + The usage of current environment. + + + :return: The usage of this LimitAndUsage. + :rtype: int + """ + return self._usage + + @usage.setter + def usage(self, usage): + """ + Sets the usage of this LimitAndUsage. + The usage of current environment. + + + :param usage: The usage of this LimitAndUsage. + :type: int + """ + self._usage = usage + + 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/fusion_apps/models/maintenance_policy.py b/src/oci/fusion_apps/models/maintenance_policy.py new file mode 100644 index 0000000000..a242a3f1d6 --- /dev/null +++ b/src/oci/fusion_apps/models/maintenance_policy.py @@ -0,0 +1,145 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 MaintenancePolicy(object): + """ + The policy that specifies the maintenance and upgrade preferences for an environment. For more information about the options, see `Understanding Environment Maintenance`__. + + __ https://docs.cloud.oracle.com/iaas/Content/fusion-applications/plan-environment-family.htm#about-env-maintenance + """ + + #: A constant which can be used with the monthly_patching_override property of a MaintenancePolicy. + #: This constant has a value of "ENABLED" + MONTHLY_PATCHING_OVERRIDE_ENABLED = "ENABLED" + + #: A constant which can be used with the monthly_patching_override property of a MaintenancePolicy. + #: This constant has a value of "DISABLED" + MONTHLY_PATCHING_OVERRIDE_DISABLED = "DISABLED" + + #: A constant which can be used with the monthly_patching_override property of a MaintenancePolicy. + #: This constant has a value of "NONE" + MONTHLY_PATCHING_OVERRIDE_NONE = "NONE" + + #: A constant which can be used with the environment_maintenance_override property of a MaintenancePolicy. + #: This constant has a value of "PROD" + ENVIRONMENT_MAINTENANCE_OVERRIDE_PROD = "PROD" + + #: A constant which can be used with the environment_maintenance_override property of a MaintenancePolicy. + #: This constant has a value of "NON_PROD" + ENVIRONMENT_MAINTENANCE_OVERRIDE_NON_PROD = "NON_PROD" + + #: A constant which can be used with the environment_maintenance_override property of a MaintenancePolicy. + #: This constant has a value of "NONE" + ENVIRONMENT_MAINTENANCE_OVERRIDE_NONE = "NONE" + + def __init__(self, **kwargs): + """ + Initializes a new MaintenancePolicy object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param monthly_patching_override: + The value to assign to the monthly_patching_override property of this MaintenancePolicy. + Allowed values for this property are: "ENABLED", "DISABLED", "NONE" + :type monthly_patching_override: str + + :param environment_maintenance_override: + The value to assign to the environment_maintenance_override property of this MaintenancePolicy. + Allowed values for this property are: "PROD", "NON_PROD", "NONE" + :type environment_maintenance_override: str + + """ + self.swagger_types = { + 'monthly_patching_override': 'str', + 'environment_maintenance_override': 'str' + } + + self.attribute_map = { + 'monthly_patching_override': 'monthlyPatchingOverride', + 'environment_maintenance_override': 'environmentMaintenanceOverride' + } + + self._monthly_patching_override = None + self._environment_maintenance_override = None + + @property + def monthly_patching_override(self): + """ + Gets the monthly_patching_override of this MaintenancePolicy. + When \"ENABLED\", the Fusion environment is patched monthly. When \"DISABLED\", the Fusion environment is not patched monthly. This setting overrides the environment family setting. When not set, the environment follows the environment family policy. + + Allowed values for this property are: "ENABLED", "DISABLED", "NONE" + + + :return: The monthly_patching_override of this MaintenancePolicy. + :rtype: str + """ + return self._monthly_patching_override + + @monthly_patching_override.setter + def monthly_patching_override(self, monthly_patching_override): + """ + Sets the monthly_patching_override of this MaintenancePolicy. + When \"ENABLED\", the Fusion environment is patched monthly. When \"DISABLED\", the Fusion environment is not patched monthly. This setting overrides the environment family setting. When not set, the environment follows the environment family policy. + + + :param monthly_patching_override: The monthly_patching_override of this MaintenancePolicy. + :type: str + """ + allowed_values = ["ENABLED", "DISABLED", "NONE"] + if not value_allowed_none_or_none_sentinel(monthly_patching_override, allowed_values): + raise ValueError( + "Invalid value for `monthly_patching_override`, must be None or one of {0}" + .format(allowed_values) + ) + self._monthly_patching_override = monthly_patching_override + + @property + def environment_maintenance_override(self): + """ + Gets the environment_maintenance_override of this MaintenancePolicy. + User choice to upgrade both test and prod pods at the same time. Overrides fusion environment families'. + + Allowed values for this property are: "PROD", "NON_PROD", "NONE" + + + :return: The environment_maintenance_override of this MaintenancePolicy. + :rtype: str + """ + return self._environment_maintenance_override + + @environment_maintenance_override.setter + def environment_maintenance_override(self, environment_maintenance_override): + """ + Sets the environment_maintenance_override of this MaintenancePolicy. + User choice to upgrade both test and prod pods at the same time. Overrides fusion environment families'. + + + :param environment_maintenance_override: The environment_maintenance_override of this MaintenancePolicy. + :type: str + """ + allowed_values = ["PROD", "NON_PROD", "NONE"] + if not value_allowed_none_or_none_sentinel(environment_maintenance_override, allowed_values): + raise ValueError( + "Invalid value for `environment_maintenance_override`, must be None or one of {0}" + .format(allowed_values) + ) + self._environment_maintenance_override = environment_maintenance_override + + 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/fusion_apps/models/patch_action.py b/src/oci/fusion_apps/models/patch_action.py new file mode 100644 index 0000000000..2a325f3317 --- /dev/null +++ b/src/oci/fusion_apps/models/patch_action.py @@ -0,0 +1,202 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .action import Action +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 PatchAction(Action): + """ + Monthly patch details. + """ + + #: A constant which can be used with the mode property of a PatchAction. + #: This constant has a value of "HOT" + MODE_HOT = "HOT" + + #: A constant which can be used with the mode property of a PatchAction. + #: This constant has a value of "COLD" + MODE_COLD = "COLD" + + #: A constant which can be used with the category property of a PatchAction. + #: This constant has a value of "MONTHLY" + CATEGORY_MONTHLY = "MONTHLY" + + #: A constant which can be used with the category property of a PatchAction. + #: This constant has a value of "WEEKLY" + CATEGORY_WEEKLY = "WEEKLY" + + #: A constant which can be used with the category property of a PatchAction. + #: This constant has a value of "ONEOFF" + CATEGORY_ONEOFF = "ONEOFF" + + def __init__(self, **kwargs): + """ + Initializes a new PatchAction object with values from keyword arguments. The default value of the :py:attr:`~oci.fusion_apps.models.PatchAction.action_type` attribute + of this class is ``PATCH`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param reference_key: + The value to assign to the reference_key property of this PatchAction. + :type reference_key: str + + :param action_type: + The value to assign to the action_type property of this PatchAction. + Allowed values for this property are: "QUARTERLY_UPGRADE", "PATCH", "VERTEX", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type action_type: str + + :param state: + The value to assign to the state property of this PatchAction. + Allowed values for this property are: "ACCEPTED", "IN_PROGRESS", "SUCCEEDED", "FAILED", "CANCELED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type state: str + + :param description: + The value to assign to the description property of this PatchAction. + :type description: str + + :param mode: + The value to assign to the mode property of this PatchAction. + Allowed values for this property are: "HOT", "COLD", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type mode: str + + :param category: + The value to assign to the category property of this PatchAction. + Allowed values for this property are: "MONTHLY", "WEEKLY", "ONEOFF", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type category: str + + :param artifact: + The value to assign to the artifact property of this PatchAction. + :type artifact: str + + """ + self.swagger_types = { + 'reference_key': 'str', + 'action_type': 'str', + 'state': 'str', + 'description': 'str', + 'mode': 'str', + 'category': 'str', + 'artifact': 'str' + } + + self.attribute_map = { + 'reference_key': 'referenceKey', + 'action_type': 'actionType', + 'state': 'state', + 'description': 'description', + 'mode': 'mode', + 'category': 'category', + 'artifact': 'artifact' + } + + self._reference_key = None + self._action_type = None + self._state = None + self._description = None + self._mode = None + self._category = None + self._artifact = None + self._action_type = 'PATCH' + + @property + def mode(self): + """ + Gets the mode of this PatchAction. + A string that describeds whether the change is applied hot or cold + + Allowed values for this property are: "HOT", "COLD", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The mode of this PatchAction. + :rtype: str + """ + return self._mode + + @mode.setter + def mode(self, mode): + """ + Sets the mode of this PatchAction. + A string that describeds whether the change is applied hot or cold + + + :param mode: The mode of this PatchAction. + :type: str + """ + allowed_values = ["HOT", "COLD"] + if not value_allowed_none_or_none_sentinel(mode, allowed_values): + mode = 'UNKNOWN_ENUM_VALUE' + self._mode = mode + + @property + def category(self): + """ + Gets the category of this PatchAction. + patch artifact category + + Allowed values for this property are: "MONTHLY", "WEEKLY", "ONEOFF", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The category of this PatchAction. + :rtype: str + """ + return self._category + + @category.setter + def category(self, category): + """ + Sets the category of this PatchAction. + patch artifact category + + + :param category: The category of this PatchAction. + :type: str + """ + allowed_values = ["MONTHLY", "WEEKLY", "ONEOFF"] + if not value_allowed_none_or_none_sentinel(category, allowed_values): + category = 'UNKNOWN_ENUM_VALUE' + self._category = category + + @property + def artifact(self): + """ + Gets the artifact of this PatchAction. + patch bundle name + + + :return: The artifact of this PatchAction. + :rtype: str + """ + return self._artifact + + @artifact.setter + def artifact(self, artifact): + """ + Sets the artifact of this PatchAction. + patch bundle name + + + :param artifact: The artifact of this PatchAction. + :type: str + """ + self._artifact = artifact + + 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/fusion_apps/models/quarterly_upgrade_begin_times.py b/src/oci/fusion_apps/models/quarterly_upgrade_begin_times.py new file mode 100644 index 0000000000..f293b3c2f7 --- /dev/null +++ b/src/oci/fusion_apps/models/quarterly_upgrade_begin_times.py @@ -0,0 +1,117 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 QuarterlyUpgradeBeginTimes(object): + """ + Determines the quarterly upgrade begin times (monthly maintenance group schedule ) of the Fusion environment. + """ + + #: A constant which can be used with the override_type property of a QuarterlyUpgradeBeginTimes. + #: This constant has a value of "OVERRIDDEN" + OVERRIDE_TYPE_OVERRIDDEN = "OVERRIDDEN" + + #: A constant which can be used with the override_type property of a QuarterlyUpgradeBeginTimes. + #: This constant has a value of "INHERITED" + OVERRIDE_TYPE_INHERITED = "INHERITED" + + def __init__(self, **kwargs): + """ + Initializes a new QuarterlyUpgradeBeginTimes object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param override_type: + The value to assign to the override_type property of this QuarterlyUpgradeBeginTimes. + Allowed values for this property are: "OVERRIDDEN", "INHERITED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type override_type: str + + :param begin_times_value: + The value to assign to the begin_times_value property of this QuarterlyUpgradeBeginTimes. + :type begin_times_value: str + + """ + self.swagger_types = { + 'override_type': 'str', + 'begin_times_value': 'str' + } + + self.attribute_map = { + 'override_type': 'overrideType', + 'begin_times_value': 'beginTimesValue' + } + + self._override_type = None + self._begin_times_value = None + + @property + def override_type(self): + """ + Gets the override_type of this QuarterlyUpgradeBeginTimes. + Determines if the maintenance schedule of the Fusion environment is inherited from the Fusion environment family. + + Allowed values for this property are: "OVERRIDDEN", "INHERITED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The override_type of this QuarterlyUpgradeBeginTimes. + :rtype: str + """ + return self._override_type + + @override_type.setter + def override_type(self, override_type): + """ + Sets the override_type of this QuarterlyUpgradeBeginTimes. + Determines if the maintenance schedule of the Fusion environment is inherited from the Fusion environment family. + + + :param override_type: The override_type of this QuarterlyUpgradeBeginTimes. + :type: str + """ + allowed_values = ["OVERRIDDEN", "INHERITED"] + if not value_allowed_none_or_none_sentinel(override_type, allowed_values): + override_type = 'UNKNOWN_ENUM_VALUE' + self._override_type = override_type + + @property + def begin_times_value(self): + """ + Gets the begin_times_value of this QuarterlyUpgradeBeginTimes. + The frequency and month when maintenance occurs for the Fusion environment. + + + :return: The begin_times_value of this QuarterlyUpgradeBeginTimes. + :rtype: str + """ + return self._begin_times_value + + @begin_times_value.setter + def begin_times_value(self, begin_times_value): + """ + Sets the begin_times_value of this QuarterlyUpgradeBeginTimes. + The frequency and month when maintenance occurs for the Fusion environment. + + + :param begin_times_value: The begin_times_value of this QuarterlyUpgradeBeginTimes. + :type: str + """ + self._begin_times_value = begin_times_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/fusion_apps/models/refresh_activity.py b/src/oci/fusion_apps/models/refresh_activity.py new file mode 100644 index 0000000000..0dfb8fcda5 --- /dev/null +++ b/src/oci/fusion_apps/models/refresh_activity.py @@ -0,0 +1,485 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 RefreshActivity(object): + """ + An environment refresh copies data from a source environment to a target environment, making a copy of the source environment onto the target environment. For more information, see `Refreshing an Environment`__. + + __ https://docs.cloud.oracle.com/iaas/Content/fusion-applications/refresh-environment.htm + """ + + #: A constant which can be used with the lifecycle_state property of a RefreshActivity. + #: This constant has a value of "ACCEPTED" + LIFECYCLE_STATE_ACCEPTED = "ACCEPTED" + + #: A constant which can be used with the lifecycle_state property of a RefreshActivity. + #: This constant has a value of "IN_PROGRESS" + LIFECYCLE_STATE_IN_PROGRESS = "IN_PROGRESS" + + #: A constant which can be used with the lifecycle_state property of a RefreshActivity. + #: This constant has a value of "FAILED" + LIFECYCLE_STATE_FAILED = "FAILED" + + #: A constant which can be used with the lifecycle_state property of a RefreshActivity. + #: This constant has a value of "SUCCEEDED" + LIFECYCLE_STATE_SUCCEEDED = "SUCCEEDED" + + #: A constant which can be used with the lifecycle_state property of a RefreshActivity. + #: This constant has a value of "CANCELED" + LIFECYCLE_STATE_CANCELED = "CANCELED" + + #: A constant which can be used with the service_availability property of a RefreshActivity. + #: This constant has a value of "AVAILABLE" + SERVICE_AVAILABILITY_AVAILABLE = "AVAILABLE" + + #: A constant which can be used with the service_availability property of a RefreshActivity. + #: This constant has a value of "UNAVAILABLE" + SERVICE_AVAILABILITY_UNAVAILABLE = "UNAVAILABLE" + + #: A constant which can be used with the lifecycle_details property of a RefreshActivity. + #: This constant has a value of "NONE" + LIFECYCLE_DETAILS_NONE = "NONE" + + #: A constant which can be used with the lifecycle_details property of a RefreshActivity. + #: This constant has a value of "ROLLBACKACCEPTED" + LIFECYCLE_DETAILS_ROLLBACKACCEPTED = "ROLLBACKACCEPTED" + + #: A constant which can be used with the lifecycle_details property of a RefreshActivity. + #: This constant has a value of "ROLLBACKINPROGRESS" + LIFECYCLE_DETAILS_ROLLBACKINPROGRESS = "ROLLBACKINPROGRESS" + + #: A constant which can be used with the lifecycle_details property of a RefreshActivity. + #: This constant has a value of "ROLLBACKSUCCEEDED" + LIFECYCLE_DETAILS_ROLLBACKSUCCEEDED = "ROLLBACKSUCCEEDED" + + #: A constant which can be used with the lifecycle_details property of a RefreshActivity. + #: This constant has a value of "ROLLBACKFAILED" + LIFECYCLE_DETAILS_ROLLBACKFAILED = "ROLLBACKFAILED" + + def __init__(self, **kwargs): + """ + Initializes a new RefreshActivity 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 RefreshActivity. + :type id: str + + :param display_name: + The value to assign to the display_name property of this RefreshActivity. + :type display_name: str + + :param source_fusion_environment_id: + The value to assign to the source_fusion_environment_id property of this RefreshActivity. + :type source_fusion_environment_id: str + + :param time_of_restoration_point: + The value to assign to the time_of_restoration_point property of this RefreshActivity. + :type time_of_restoration_point: datetime + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this RefreshActivity. + Allowed values for this property are: "ACCEPTED", "IN_PROGRESS", "FAILED", "SUCCEEDED", "CANCELED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type lifecycle_state: str + + :param service_availability: + The value to assign to the service_availability property of this RefreshActivity. + Allowed values for this property are: "AVAILABLE", "UNAVAILABLE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type service_availability: str + + :param time_scheduled_start: + The value to assign to the time_scheduled_start property of this RefreshActivity. + :type time_scheduled_start: datetime + + :param time_expected_finish: + The value to assign to the time_expected_finish property of this RefreshActivity. + :type time_expected_finish: datetime + + :param time_finished: + The value to assign to the time_finished property of this RefreshActivity. + :type time_finished: datetime + + :param time_accepted: + The value to assign to the time_accepted property of this RefreshActivity. + :type time_accepted: datetime + + :param time_updated: + The value to assign to the time_updated property of this RefreshActivity. + :type time_updated: datetime + + :param lifecycle_details: + The value to assign to the lifecycle_details property of this RefreshActivity. + Allowed values for this property are: "NONE", "ROLLBACKACCEPTED", "ROLLBACKINPROGRESS", "ROLLBACKSUCCEEDED", "ROLLBACKFAILED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type lifecycle_details: str + + """ + self.swagger_types = { + 'id': 'str', + 'display_name': 'str', + 'source_fusion_environment_id': 'str', + 'time_of_restoration_point': 'datetime', + 'lifecycle_state': 'str', + 'service_availability': 'str', + 'time_scheduled_start': 'datetime', + 'time_expected_finish': 'datetime', + 'time_finished': 'datetime', + 'time_accepted': 'datetime', + 'time_updated': 'datetime', + 'lifecycle_details': 'str' + } + + self.attribute_map = { + 'id': 'id', + 'display_name': 'displayName', + 'source_fusion_environment_id': 'sourceFusionEnvironmentId', + 'time_of_restoration_point': 'timeOfRestorationPoint', + 'lifecycle_state': 'lifecycleState', + 'service_availability': 'serviceAvailability', + 'time_scheduled_start': 'timeScheduledStart', + 'time_expected_finish': 'timeExpectedFinish', + 'time_finished': 'timeFinished', + 'time_accepted': 'timeAccepted', + 'time_updated': 'timeUpdated', + 'lifecycle_details': 'lifecycleDetails' + } + + self._id = None + self._display_name = None + self._source_fusion_environment_id = None + self._time_of_restoration_point = None + self._lifecycle_state = None + self._service_availability = None + self._time_scheduled_start = None + self._time_expected_finish = None + self._time_finished = None + self._time_accepted = None + self._time_updated = None + self._lifecycle_details = None + + @property + def id(self): + """ + **[Required]** Gets the id of this RefreshActivity. + The unique identifier (OCID) of the refresh activity. Can't be changed after creation. + + + :return: The id of this RefreshActivity. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this RefreshActivity. + The unique identifier (OCID) of the refresh activity. Can't be changed after creation. + + + :param id: The id of this RefreshActivity. + :type: str + """ + self._id = id + + @property + def display_name(self): + """ + **[Required]** Gets the display_name of this RefreshActivity. + A friendly name for the refresh activity. Can be changed later. + + + :return: The display_name of this RefreshActivity. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this RefreshActivity. + A friendly name for the refresh activity. Can be changed later. + + + :param display_name: The display_name of this RefreshActivity. + :type: str + """ + self._display_name = display_name + + @property + def source_fusion_environment_id(self): + """ + **[Required]** Gets the source_fusion_environment_id of this RefreshActivity. + The OCID of the Fusion environment that is the source environment for the refresh. + + + :return: The source_fusion_environment_id of this RefreshActivity. + :rtype: str + """ + return self._source_fusion_environment_id + + @source_fusion_environment_id.setter + def source_fusion_environment_id(self, source_fusion_environment_id): + """ + Sets the source_fusion_environment_id of this RefreshActivity. + The OCID of the Fusion environment that is the source environment for the refresh. + + + :param source_fusion_environment_id: The source_fusion_environment_id of this RefreshActivity. + :type: str + """ + self._source_fusion_environment_id = source_fusion_environment_id + + @property + def time_of_restoration_point(self): + """ + Gets the time_of_restoration_point of this RefreshActivity. + The date and time of the most recent source environment backup used for the environment refresh. + + + :return: The time_of_restoration_point of this RefreshActivity. + :rtype: datetime + """ + return self._time_of_restoration_point + + @time_of_restoration_point.setter + def time_of_restoration_point(self, time_of_restoration_point): + """ + Sets the time_of_restoration_point of this RefreshActivity. + The date and time of the most recent source environment backup used for the environment refresh. + + + :param time_of_restoration_point: The time_of_restoration_point of this RefreshActivity. + :type: datetime + """ + self._time_of_restoration_point = time_of_restoration_point + + @property + def lifecycle_state(self): + """ + **[Required]** Gets the lifecycle_state of this RefreshActivity. + The current state of the refreshActivity. + + Allowed values for this property are: "ACCEPTED", "IN_PROGRESS", "FAILED", "SUCCEEDED", "CANCELED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The lifecycle_state of this RefreshActivity. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this RefreshActivity. + The current state of the refreshActivity. + + + :param lifecycle_state: The lifecycle_state of this RefreshActivity. + :type: str + """ + allowed_values = ["ACCEPTED", "IN_PROGRESS", "FAILED", "SUCCEEDED", "CANCELED"] + if not value_allowed_none_or_none_sentinel(lifecycle_state, allowed_values): + lifecycle_state = 'UNKNOWN_ENUM_VALUE' + self._lifecycle_state = lifecycle_state + + @property + def service_availability(self): + """ + **[Required]** Gets the service_availability of this RefreshActivity. + Service availability / impact during refresh activity execution up down + + Allowed values for this property are: "AVAILABLE", "UNAVAILABLE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The service_availability of this RefreshActivity. + :rtype: str + """ + return self._service_availability + + @service_availability.setter + def service_availability(self, service_availability): + """ + Sets the service_availability of this RefreshActivity. + Service availability / impact during refresh activity execution up down + + + :param service_availability: The service_availability of this RefreshActivity. + :type: str + """ + allowed_values = ["AVAILABLE", "UNAVAILABLE"] + if not value_allowed_none_or_none_sentinel(service_availability, allowed_values): + service_availability = 'UNKNOWN_ENUM_VALUE' + self._service_availability = service_availability + + @property + def time_scheduled_start(self): + """ + **[Required]** Gets the time_scheduled_start of this RefreshActivity. + The time the refresh activity is scheduled to start. An RFC3339 formatted datetime string. + + + :return: The time_scheduled_start of this RefreshActivity. + :rtype: datetime + """ + return self._time_scheduled_start + + @time_scheduled_start.setter + def time_scheduled_start(self, time_scheduled_start): + """ + Sets the time_scheduled_start of this RefreshActivity. + The time the refresh activity is scheduled to start. An RFC3339 formatted datetime string. + + + :param time_scheduled_start: The time_scheduled_start of this RefreshActivity. + :type: datetime + """ + self._time_scheduled_start = time_scheduled_start + + @property + def time_expected_finish(self): + """ + **[Required]** Gets the time_expected_finish of this RefreshActivity. + The time the refresh activity is scheduled to end. An RFC3339 formatted datetime string. + + + :return: The time_expected_finish of this RefreshActivity. + :rtype: datetime + """ + return self._time_expected_finish + + @time_expected_finish.setter + def time_expected_finish(self, time_expected_finish): + """ + Sets the time_expected_finish of this RefreshActivity. + The time the refresh activity is scheduled to end. An RFC3339 formatted datetime string. + + + :param time_expected_finish: The time_expected_finish of this RefreshActivity. + :type: datetime + """ + self._time_expected_finish = time_expected_finish + + @property + def time_finished(self): + """ + Gets the time_finished of this RefreshActivity. + The time the refresh activity actually completed / cancelled / failed. An RFC3339 formatted datetime string. + + + :return: The time_finished of this RefreshActivity. + :rtype: datetime + """ + return self._time_finished + + @time_finished.setter + def time_finished(self, time_finished): + """ + Sets the time_finished of this RefreshActivity. + The time the refresh activity actually completed / cancelled / failed. An RFC3339 formatted datetime string. + + + :param time_finished: The time_finished of this RefreshActivity. + :type: datetime + """ + self._time_finished = time_finished + + @property + def time_accepted(self): + """ + Gets the time_accepted of this RefreshActivity. + The time the refresh activity record was created. An RFC3339 formatted datetime string. + + + :return: The time_accepted of this RefreshActivity. + :rtype: datetime + """ + return self._time_accepted + + @time_accepted.setter + def time_accepted(self, time_accepted): + """ + Sets the time_accepted of this RefreshActivity. + The time the refresh activity record was created. An RFC3339 formatted datetime string. + + + :param time_accepted: The time_accepted of this RefreshActivity. + :type: datetime + """ + self._time_accepted = time_accepted + + @property + def time_updated(self): + """ + Gets the time_updated of this RefreshActivity. + The time the refresh activity record was updated. An RFC3339 formatted datetime string. + + + :return: The time_updated of this RefreshActivity. + :rtype: datetime + """ + return self._time_updated + + @time_updated.setter + def time_updated(self, time_updated): + """ + Sets the time_updated of this RefreshActivity. + The time the refresh activity record was updated. An RFC3339 formatted datetime string. + + + :param time_updated: The time_updated of this RefreshActivity. + :type: datetime + """ + self._time_updated = time_updated + + @property + def lifecycle_details(self): + """ + Gets the lifecycle_details of this RefreshActivity. + A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. + + Allowed values for this property are: "NONE", "ROLLBACKACCEPTED", "ROLLBACKINPROGRESS", "ROLLBACKSUCCEEDED", "ROLLBACKFAILED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The lifecycle_details of this RefreshActivity. + :rtype: str + """ + return self._lifecycle_details + + @lifecycle_details.setter + def lifecycle_details(self, lifecycle_details): + """ + Sets the lifecycle_details of this RefreshActivity. + A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. + + + :param lifecycle_details: The lifecycle_details of this RefreshActivity. + :type: str + """ + allowed_values = ["NONE", "ROLLBACKACCEPTED", "ROLLBACKINPROGRESS", "ROLLBACKSUCCEEDED", "ROLLBACKFAILED"] + if not value_allowed_none_or_none_sentinel(lifecycle_details, allowed_values): + lifecycle_details = 'UNKNOWN_ENUM_VALUE' + self._lifecycle_details = lifecycle_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/fusion_apps/models/refresh_activity_collection.py b/src/oci/fusion_apps/models/refresh_activity_collection.py new file mode 100644 index 0000000000..2c921eaca6 --- /dev/null +++ b/src/oci/fusion_apps/models/refresh_activity_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 RefreshActivityCollection(object): + """ + Results of a refresh activity search. + """ + + def __init__(self, **kwargs): + """ + Initializes a new RefreshActivityCollection 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 RefreshActivityCollection. + :type items: list[oci.fusion_apps.models.RefreshActivitySummary] + + """ + self.swagger_types = { + 'items': 'list[RefreshActivitySummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this RefreshActivityCollection. + A page of refresh activity objects. + + + :return: The items of this RefreshActivityCollection. + :rtype: list[oci.fusion_apps.models.RefreshActivitySummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this RefreshActivityCollection. + A page of refresh activity objects. + + + :param items: The items of this RefreshActivityCollection. + :type: list[oci.fusion_apps.models.RefreshActivitySummary] + """ + 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/fusion_apps/models/refresh_activity_summary.py b/src/oci/fusion_apps/models/refresh_activity_summary.py new file mode 100644 index 0000000000..7a024bdd91 --- /dev/null +++ b/src/oci/fusion_apps/models/refresh_activity_summary.py @@ -0,0 +1,411 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 RefreshActivitySummary(object): + """ + Summary of the refresh activity. + """ + + def __init__(self, **kwargs): + """ + Initializes a new RefreshActivitySummary 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 RefreshActivitySummary. + :type id: str + + :param display_name: + The value to assign to the display_name property of this RefreshActivitySummary. + :type display_name: str + + :param source_fusion_environment_id: + The value to assign to the source_fusion_environment_id property of this RefreshActivitySummary. + :type source_fusion_environment_id: str + + :param time_of_restoration_point: + The value to assign to the time_of_restoration_point property of this RefreshActivitySummary. + :type time_of_restoration_point: datetime + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this RefreshActivitySummary. + :type lifecycle_state: str + + :param time_scheduled_start: + The value to assign to the time_scheduled_start property of this RefreshActivitySummary. + :type time_scheduled_start: datetime + + :param time_expected_finish: + The value to assign to the time_expected_finish property of this RefreshActivitySummary. + :type time_expected_finish: datetime + + :param time_finished: + The value to assign to the time_finished property of this RefreshActivitySummary. + :type time_finished: datetime + + :param service_availability: + The value to assign to the service_availability property of this RefreshActivitySummary. + :type service_availability: str + + :param time_accepted: + The value to assign to the time_accepted property of this RefreshActivitySummary. + :type time_accepted: datetime + + :param time_updated: + The value to assign to the time_updated property of this RefreshActivitySummary. + :type time_updated: datetime + + :param lifecycle_details: + The value to assign to the lifecycle_details property of this RefreshActivitySummary. + :type lifecycle_details: str + + """ + self.swagger_types = { + 'id': 'str', + 'display_name': 'str', + 'source_fusion_environment_id': 'str', + 'time_of_restoration_point': 'datetime', + 'lifecycle_state': 'str', + 'time_scheduled_start': 'datetime', + 'time_expected_finish': 'datetime', + 'time_finished': 'datetime', + 'service_availability': 'str', + 'time_accepted': 'datetime', + 'time_updated': 'datetime', + 'lifecycle_details': 'str' + } + + self.attribute_map = { + 'id': 'id', + 'display_name': 'displayName', + 'source_fusion_environment_id': 'sourceFusionEnvironmentId', + 'time_of_restoration_point': 'timeOfRestorationPoint', + 'lifecycle_state': 'lifecycleState', + 'time_scheduled_start': 'timeScheduledStart', + 'time_expected_finish': 'timeExpectedFinish', + 'time_finished': 'timeFinished', + 'service_availability': 'serviceAvailability', + 'time_accepted': 'timeAccepted', + 'time_updated': 'timeUpdated', + 'lifecycle_details': 'lifecycleDetails' + } + + self._id = None + self._display_name = None + self._source_fusion_environment_id = None + self._time_of_restoration_point = None + self._lifecycle_state = None + self._time_scheduled_start = None + self._time_expected_finish = None + self._time_finished = None + self._service_availability = None + self._time_accepted = None + self._time_updated = None + self._lifecycle_details = None + + @property + def id(self): + """ + **[Required]** Gets the id of this RefreshActivitySummary. + The unique identifier (OCID) of the refresh activity. Can't be changed after creation. + + + :return: The id of this RefreshActivitySummary. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this RefreshActivitySummary. + The unique identifier (OCID) of the refresh activity. Can't be changed after creation. + + + :param id: The id of this RefreshActivitySummary. + :type: str + """ + self._id = id + + @property + def display_name(self): + """ + **[Required]** Gets the display_name of this RefreshActivitySummary. + A friendly name for the refresh activity. Can be changed later. + + + :return: The display_name of this RefreshActivitySummary. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this RefreshActivitySummary. + A friendly name for the refresh activity. Can be changed later. + + + :param display_name: The display_name of this RefreshActivitySummary. + :type: str + """ + self._display_name = display_name + + @property + def source_fusion_environment_id(self): + """ + **[Required]** Gets the source_fusion_environment_id of this RefreshActivitySummary. + The OCID of the Fusion environment that is the source environment for the refresh. + + + :return: The source_fusion_environment_id of this RefreshActivitySummary. + :rtype: str + """ + return self._source_fusion_environment_id + + @source_fusion_environment_id.setter + def source_fusion_environment_id(self, source_fusion_environment_id): + """ + Sets the source_fusion_environment_id of this RefreshActivitySummary. + The OCID of the Fusion environment that is the source environment for the refresh. + + + :param source_fusion_environment_id: The source_fusion_environment_id of this RefreshActivitySummary. + :type: str + """ + self._source_fusion_environment_id = source_fusion_environment_id + + @property + def time_of_restoration_point(self): + """ + Gets the time_of_restoration_point of this RefreshActivitySummary. + The date and time of the most recent source environment backup used for the environment refresh. + + + :return: The time_of_restoration_point of this RefreshActivitySummary. + :rtype: datetime + """ + return self._time_of_restoration_point + + @time_of_restoration_point.setter + def time_of_restoration_point(self, time_of_restoration_point): + """ + Sets the time_of_restoration_point of this RefreshActivitySummary. + The date and time of the most recent source environment backup used for the environment refresh. + + + :param time_of_restoration_point: The time_of_restoration_point of this RefreshActivitySummary. + :type: datetime + """ + self._time_of_restoration_point = time_of_restoration_point + + @property + def lifecycle_state(self): + """ + **[Required]** Gets the lifecycle_state of this RefreshActivitySummary. + The current state of the refresh activity. Valid values are Scheduled, In progress , Failed, Completed. + + + :return: The lifecycle_state of this RefreshActivitySummary. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this RefreshActivitySummary. + The current state of the refresh activity. Valid values are Scheduled, In progress , Failed, Completed. + + + :param lifecycle_state: The lifecycle_state of this RefreshActivitySummary. + :type: str + """ + self._lifecycle_state = lifecycle_state + + @property + def time_scheduled_start(self): + """ + **[Required]** Gets the time_scheduled_start of this RefreshActivitySummary. + The time the refresh activity is scheduled to start. An RFC3339 formatted datetime string. + + + :return: The time_scheduled_start of this RefreshActivitySummary. + :rtype: datetime + """ + return self._time_scheduled_start + + @time_scheduled_start.setter + def time_scheduled_start(self, time_scheduled_start): + """ + Sets the time_scheduled_start of this RefreshActivitySummary. + The time the refresh activity is scheduled to start. An RFC3339 formatted datetime string. + + + :param time_scheduled_start: The time_scheduled_start of this RefreshActivitySummary. + :type: datetime + """ + self._time_scheduled_start = time_scheduled_start + + @property + def time_expected_finish(self): + """ + **[Required]** Gets the time_expected_finish of this RefreshActivitySummary. + The time the refresh activity is scheduled to end. An RFC3339 formatted datetime string. + + + :return: The time_expected_finish of this RefreshActivitySummary. + :rtype: datetime + """ + return self._time_expected_finish + + @time_expected_finish.setter + def time_expected_finish(self, time_expected_finish): + """ + Sets the time_expected_finish of this RefreshActivitySummary. + The time the refresh activity is scheduled to end. An RFC3339 formatted datetime string. + + + :param time_expected_finish: The time_expected_finish of this RefreshActivitySummary. + :type: datetime + """ + self._time_expected_finish = time_expected_finish + + @property + def time_finished(self): + """ + Gets the time_finished of this RefreshActivitySummary. + The time the refresh activity actually completed / cancelled / failed. An RFC3339 formatted datetime string. + + + :return: The time_finished of this RefreshActivitySummary. + :rtype: datetime + """ + return self._time_finished + + @time_finished.setter + def time_finished(self, time_finished): + """ + Sets the time_finished of this RefreshActivitySummary. + The time the refresh activity actually completed / cancelled / failed. An RFC3339 formatted datetime string. + + + :param time_finished: The time_finished of this RefreshActivitySummary. + :type: datetime + """ + self._time_finished = time_finished + + @property + def service_availability(self): + """ + **[Required]** Gets the service_availability of this RefreshActivitySummary. + Service availability / impact during refresh activity execution, up down + + + :return: The service_availability of this RefreshActivitySummary. + :rtype: str + """ + return self._service_availability + + @service_availability.setter + def service_availability(self, service_availability): + """ + Sets the service_availability of this RefreshActivitySummary. + Service availability / impact during refresh activity execution, up down + + + :param service_availability: The service_availability of this RefreshActivitySummary. + :type: str + """ + self._service_availability = service_availability + + @property + def time_accepted(self): + """ + Gets the time_accepted of this RefreshActivitySummary. + The time the refresh activity record was created. An RFC3339 formatted datetime string. + + + :return: The time_accepted of this RefreshActivitySummary. + :rtype: datetime + """ + return self._time_accepted + + @time_accepted.setter + def time_accepted(self, time_accepted): + """ + Sets the time_accepted of this RefreshActivitySummary. + The time the refresh activity record was created. An RFC3339 formatted datetime string. + + + :param time_accepted: The time_accepted of this RefreshActivitySummary. + :type: datetime + """ + self._time_accepted = time_accepted + + @property + def time_updated(self): + """ + Gets the time_updated of this RefreshActivitySummary. + The time the refresh activity record was updated. An RFC3339 formatted datetime string. + + + :return: The time_updated of this RefreshActivitySummary. + :rtype: datetime + """ + return self._time_updated + + @time_updated.setter + def time_updated(self, time_updated): + """ + Sets the time_updated of this RefreshActivitySummary. + The time the refresh activity record was updated. An RFC3339 formatted datetime string. + + + :param time_updated: The time_updated of this RefreshActivitySummary. + :type: datetime + """ + self._time_updated = time_updated + + @property + def lifecycle_details(self): + """ + Gets the lifecycle_details of this RefreshActivitySummary. + A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. + + + :return: The lifecycle_details of this RefreshActivitySummary. + :rtype: str + """ + return self._lifecycle_details + + @lifecycle_details.setter + def lifecycle_details(self, lifecycle_details): + """ + Sets the lifecycle_details of this RefreshActivitySummary. + A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. + + + :param lifecycle_details: The lifecycle_details of this RefreshActivitySummary. + :type: str + """ + self._lifecycle_details = lifecycle_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/fusion_apps/models/refresh_details.py b/src/oci/fusion_apps/models/refresh_details.py new file mode 100644 index 0000000000..22e4164d34 --- /dev/null +++ b/src/oci/fusion_apps/models/refresh_details.py @@ -0,0 +1,132 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 RefreshDetails(object): + """ + Describes a refresh of a fusion environment + """ + + def __init__(self, **kwargs): + """ + Initializes a new RefreshDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param source_fusion_environment_id: + The value to assign to the source_fusion_environment_id property of this RefreshDetails. + :type source_fusion_environment_id: str + + :param time_finished: + The value to assign to the time_finished property of this RefreshDetails. + :type time_finished: datetime + + :param time_of_restoration_point: + The value to assign to the time_of_restoration_point property of this RefreshDetails. + :type time_of_restoration_point: datetime + + """ + self.swagger_types = { + 'source_fusion_environment_id': 'str', + 'time_finished': 'datetime', + 'time_of_restoration_point': 'datetime' + } + + self.attribute_map = { + 'source_fusion_environment_id': 'sourceFusionEnvironmentId', + 'time_finished': 'timeFinished', + 'time_of_restoration_point': 'timeOfRestorationPoint' + } + + self._source_fusion_environment_id = None + self._time_finished = None + self._time_of_restoration_point = None + + @property + def source_fusion_environment_id(self): + """ + **[Required]** Gets the source_fusion_environment_id of this RefreshDetails. + The source environment id for the last refresh + + + :return: The source_fusion_environment_id of this RefreshDetails. + :rtype: str + """ + return self._source_fusion_environment_id + + @source_fusion_environment_id.setter + def source_fusion_environment_id(self, source_fusion_environment_id): + """ + Sets the source_fusion_environment_id of this RefreshDetails. + The source environment id for the last refresh + + + :param source_fusion_environment_id: The source_fusion_environment_id of this RefreshDetails. + :type: str + """ + self._source_fusion_environment_id = source_fusion_environment_id + + @property + def time_finished(self): + """ + **[Required]** Gets the time_finished of this RefreshDetails. + The time of when the last refresh finish + + + :return: The time_finished of this RefreshDetails. + :rtype: datetime + """ + return self._time_finished + + @time_finished.setter + def time_finished(self, time_finished): + """ + Sets the time_finished of this RefreshDetails. + The time of when the last refresh finish + + + :param time_finished: The time_finished of this RefreshDetails. + :type: datetime + """ + self._time_finished = time_finished + + @property + def time_of_restoration_point(self): + """ + **[Required]** Gets the time_of_restoration_point of this RefreshDetails. + The point of time of the latest DB backup for the last refresh + + + :return: The time_of_restoration_point of this RefreshDetails. + :rtype: datetime + """ + return self._time_of_restoration_point + + @time_of_restoration_point.setter + def time_of_restoration_point(self, time_of_restoration_point): + """ + Sets the time_of_restoration_point of this RefreshDetails. + The point of time of the latest DB backup for the last refresh + + + :param time_of_restoration_point: The time_of_restoration_point of this RefreshDetails. + :type: datetime + """ + self._time_of_restoration_point = time_of_restoration_point + + 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/fusion_apps/models/reset_fusion_environment_password_details.py b/src/oci/fusion_apps/models/reset_fusion_environment_password_details.py new file mode 100644 index 0000000000..2d2699977f --- /dev/null +++ b/src/oci/fusion_apps/models/reset_fusion_environment_password_details.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 ResetFusionEnvironmentPasswordDetails(object): + """ + IDM admin credentials + """ + + def __init__(self, **kwargs): + """ + Initializes a new ResetFusionEnvironmentPasswordDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param password: + The value to assign to the password property of this ResetFusionEnvironmentPasswordDetails. + :type password: str + + """ + self.swagger_types = { + 'password': 'str' + } + + self.attribute_map = { + 'password': 'password' + } + + self._password = None + + @property + def password(self): + """ + **[Required]** Gets the password of this ResetFusionEnvironmentPasswordDetails. + Admin password + + + :return: The password of this ResetFusionEnvironmentPasswordDetails. + :rtype: str + """ + return self._password + + @password.setter + def password(self, password): + """ + Sets the password of this ResetFusionEnvironmentPasswordDetails. + Admin password + + + :param password: The password of this ResetFusionEnvironmentPasswordDetails. + :type: str + """ + self._password = password + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/fusion_apps/models/rule.py b/src/oci/fusion_apps/models/rule.py new file mode 100644 index 0000000000..a79e0f7c2e --- /dev/null +++ b/src/oci/fusion_apps/models/rule.py @@ -0,0 +1,99 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 Rule(object): + """ + An object that represents an action to apply to a listener. + """ + + #: A constant which can be used with the action property of a Rule. + #: This constant has a value of "ALLOW" + ACTION_ALLOW = "ALLOW" + + def __init__(self, **kwargs): + """ + Initializes a new Rule 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.fusion_apps.models.AllowRule` + + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param action: + The value to assign to the action property of this Rule. + Allowed values for this property are: "ALLOW", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type action: str + + """ + self.swagger_types = { + 'action': 'str' + } + + self.attribute_map = { + 'action': 'action' + } + + self._action = 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['action'] + + if type == 'ALLOW': + return 'AllowRule' + else: + return 'Rule' + + @property + def action(self): + """ + **[Required]** Gets the action of this Rule. + Rule type + + Allowed values for this property are: "ALLOW", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The action of this Rule. + :rtype: str + """ + return self._action + + @action.setter + def action(self, action): + """ + Sets the action of this Rule. + Rule type + + + :param action: The action of this Rule. + :type: str + """ + allowed_values = ["ALLOW"] + if not value_allowed_none_or_none_sentinel(action, allowed_values): + action = 'UNKNOWN_ENUM_VALUE' + self._action = action + + 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/fusion_apps/models/rule_condition.py b/src/oci/fusion_apps/models/rule_condition.py new file mode 100644 index 0000000000..f16f674586 --- /dev/null +++ b/src/oci/fusion_apps/models/rule_condition.py @@ -0,0 +1,115 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 RuleCondition(object): + """ + A condition to apply to an access control rule. + """ + + #: A constant which can be used with the attribute_name property of a RuleCondition. + #: This constant has a value of "SOURCE_IP_ADDRESS" + ATTRIBUTE_NAME_SOURCE_IP_ADDRESS = "SOURCE_IP_ADDRESS" + + #: A constant which can be used with the attribute_name property of a RuleCondition. + #: This constant has a value of "SOURCE_VCN_ID" + ATTRIBUTE_NAME_SOURCE_VCN_ID = "SOURCE_VCN_ID" + + #: A constant which can be used with the attribute_name property of a RuleCondition. + #: This constant has a value of "SOURCE_VCN_IP_ADDRESS" + ATTRIBUTE_NAME_SOURCE_VCN_IP_ADDRESS = "SOURCE_VCN_IP_ADDRESS" + + def __init__(self, **kwargs): + """ + Initializes a new RuleCondition 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.fusion_apps.models.SourceVcnIdCondition` + * :class:`~oci.fusion_apps.models.SourceIpAddressCondition` + * :class:`~oci.fusion_apps.models.SourceVcnIpAddressCondition` + + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param attribute_name: + The value to assign to the attribute_name property of this RuleCondition. + Allowed values for this property are: "SOURCE_IP_ADDRESS", "SOURCE_VCN_ID", "SOURCE_VCN_IP_ADDRESS", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type attribute_name: str + + """ + self.swagger_types = { + 'attribute_name': 'str' + } + + self.attribute_map = { + 'attribute_name': 'attributeName' + } + + self._attribute_name = 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['attributeName'] + + if type == 'SOURCE_VCN_ID': + return 'SourceVcnIdCondition' + + if type == 'SOURCE_IP_ADDRESS': + return 'SourceIpAddressCondition' + + if type == 'SOURCE_VCN_IP_ADDRESS': + return 'SourceVcnIpAddressCondition' + else: + return 'RuleCondition' + + @property + def attribute_name(self): + """ + **[Required]** Gets the attribute_name of this RuleCondition. + RuleCondition type + + Allowed values for this property are: "SOURCE_IP_ADDRESS", "SOURCE_VCN_ID", "SOURCE_VCN_IP_ADDRESS", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The attribute_name of this RuleCondition. + :rtype: str + """ + return self._attribute_name + + @attribute_name.setter + def attribute_name(self, attribute_name): + """ + Sets the attribute_name of this RuleCondition. + RuleCondition type + + + :param attribute_name: The attribute_name of this RuleCondition. + :type: str + """ + allowed_values = ["SOURCE_IP_ADDRESS", "SOURCE_VCN_ID", "SOURCE_VCN_IP_ADDRESS"] + if not value_allowed_none_or_none_sentinel(attribute_name, allowed_values): + attribute_name = 'UNKNOWN_ENUM_VALUE' + self._attribute_name = attribute_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/fusion_apps/models/scheduled_activity.py b/src/oci/fusion_apps/models/scheduled_activity.py new file mode 100644 index 0000000000..da99cd1fc4 --- /dev/null +++ b/src/oci/fusion_apps/models/scheduled_activity.py @@ -0,0 +1,569 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 ScheduledActivity(object): + """ + Details of scheduled activity. + """ + + #: A constant which can be used with the run_cycle property of a ScheduledActivity. + #: This constant has a value of "QUARTERLY" + RUN_CYCLE_QUARTERLY = "QUARTERLY" + + #: A constant which can be used with the run_cycle property of a ScheduledActivity. + #: This constant has a value of "MONTHLY" + RUN_CYCLE_MONTHLY = "MONTHLY" + + #: A constant which can be used with the run_cycle property of a ScheduledActivity. + #: This constant has a value of "ONEOFF" + RUN_CYCLE_ONEOFF = "ONEOFF" + + #: A constant which can be used with the run_cycle property of a ScheduledActivity. + #: This constant has a value of "VERTEX" + RUN_CYCLE_VERTEX = "VERTEX" + + #: A constant which can be used with the lifecycle_state property of a ScheduledActivity. + #: This constant has a value of "ACCEPTED" + LIFECYCLE_STATE_ACCEPTED = "ACCEPTED" + + #: A constant which can be used with the lifecycle_state property of a ScheduledActivity. + #: This constant has a value of "IN_PROGRESS" + LIFECYCLE_STATE_IN_PROGRESS = "IN_PROGRESS" + + #: A constant which can be used with the lifecycle_state property of a ScheduledActivity. + #: This constant has a value of "FAILED" + LIFECYCLE_STATE_FAILED = "FAILED" + + #: A constant which can be used with the lifecycle_state property of a ScheduledActivity. + #: This constant has a value of "SUCCEEDED" + LIFECYCLE_STATE_SUCCEEDED = "SUCCEEDED" + + #: A constant which can be used with the lifecycle_state property of a ScheduledActivity. + #: This constant has a value of "CANCELED" + LIFECYCLE_STATE_CANCELED = "CANCELED" + + #: A constant which can be used with the service_availability property of a ScheduledActivity. + #: This constant has a value of "AVAILABLE" + SERVICE_AVAILABILITY_AVAILABLE = "AVAILABLE" + + #: A constant which can be used with the service_availability property of a ScheduledActivity. + #: This constant has a value of "UNAVAILABLE" + SERVICE_AVAILABILITY_UNAVAILABLE = "UNAVAILABLE" + + #: A constant which can be used with the lifecycle_details property of a ScheduledActivity. + #: This constant has a value of "NONE" + LIFECYCLE_DETAILS_NONE = "NONE" + + #: A constant which can be used with the lifecycle_details property of a ScheduledActivity. + #: This constant has a value of "ROLLBACKACCEPTED" + LIFECYCLE_DETAILS_ROLLBACKACCEPTED = "ROLLBACKACCEPTED" + + #: A constant which can be used with the lifecycle_details property of a ScheduledActivity. + #: This constant has a value of "ROLLBACKINPROGRESS" + LIFECYCLE_DETAILS_ROLLBACKINPROGRESS = "ROLLBACKINPROGRESS" + + #: A constant which can be used with the lifecycle_details property of a ScheduledActivity. + #: This constant has a value of "ROLLBACKSUCCEEDED" + LIFECYCLE_DETAILS_ROLLBACKSUCCEEDED = "ROLLBACKSUCCEEDED" + + #: A constant which can be used with the lifecycle_details property of a ScheduledActivity. + #: This constant has a value of "ROLLBACKFAILED" + LIFECYCLE_DETAILS_ROLLBACKFAILED = "ROLLBACKFAILED" + + def __init__(self, **kwargs): + """ + Initializes a new ScheduledActivity 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 ScheduledActivity. + :type id: str + + :param display_name: + The value to assign to the display_name property of this ScheduledActivity. + :type display_name: str + + :param run_cycle: + The value to assign to the run_cycle property of this ScheduledActivity. + Allowed values for this property are: "QUARTERLY", "MONTHLY", "ONEOFF", "VERTEX", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type run_cycle: str + + :param fusion_environment_id: + The value to assign to the fusion_environment_id property of this ScheduledActivity. + :type fusion_environment_id: str + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this ScheduledActivity. + Allowed values for this property are: "ACCEPTED", "IN_PROGRESS", "FAILED", "SUCCEEDED", "CANCELED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type lifecycle_state: str + + :param actions: + The value to assign to the actions property of this ScheduledActivity. + :type actions: list[oci.fusion_apps.models.Action] + + :param service_availability: + The value to assign to the service_availability property of this ScheduledActivity. + Allowed values for this property are: "AVAILABLE", "UNAVAILABLE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type service_availability: str + + :param time_scheduled_start: + The value to assign to the time_scheduled_start property of this ScheduledActivity. + :type time_scheduled_start: datetime + + :param time_expected_finish: + The value to assign to the time_expected_finish property of this ScheduledActivity. + :type time_expected_finish: datetime + + :param time_finished: + The value to assign to the time_finished property of this ScheduledActivity. + :type time_finished: datetime + + :param delay_in_hours: + The value to assign to the delay_in_hours property of this ScheduledActivity. + :type delay_in_hours: int + + :param time_created: + The value to assign to the time_created property of this ScheduledActivity. + :type time_created: datetime + + :param time_updated: + The value to assign to the time_updated property of this ScheduledActivity. + :type time_updated: datetime + + :param lifecycle_details: + The value to assign to the lifecycle_details property of this ScheduledActivity. + Allowed values for this property are: "NONE", "ROLLBACKACCEPTED", "ROLLBACKINPROGRESS", "ROLLBACKSUCCEEDED", "ROLLBACKFAILED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type lifecycle_details: str + + """ + self.swagger_types = { + 'id': 'str', + 'display_name': 'str', + 'run_cycle': 'str', + 'fusion_environment_id': 'str', + 'lifecycle_state': 'str', + 'actions': 'list[Action]', + 'service_availability': 'str', + 'time_scheduled_start': 'datetime', + 'time_expected_finish': 'datetime', + 'time_finished': 'datetime', + 'delay_in_hours': 'int', + 'time_created': 'datetime', + 'time_updated': 'datetime', + 'lifecycle_details': 'str' + } + + self.attribute_map = { + 'id': 'id', + 'display_name': 'displayName', + 'run_cycle': 'runCycle', + 'fusion_environment_id': 'fusionEnvironmentId', + 'lifecycle_state': 'lifecycleState', + 'actions': 'actions', + 'service_availability': 'serviceAvailability', + 'time_scheduled_start': 'timeScheduledStart', + 'time_expected_finish': 'timeExpectedFinish', + 'time_finished': 'timeFinished', + 'delay_in_hours': 'delayInHours', + 'time_created': 'timeCreated', + 'time_updated': 'timeUpdated', + 'lifecycle_details': 'lifecycleDetails' + } + + self._id = None + self._display_name = None + self._run_cycle = None + self._fusion_environment_id = None + self._lifecycle_state = None + self._actions = None + self._service_availability = None + self._time_scheduled_start = None + self._time_expected_finish = None + self._time_finished = None + self._delay_in_hours = None + self._time_created = None + self._time_updated = None + self._lifecycle_details = None + + @property + def id(self): + """ + **[Required]** Gets the id of this ScheduledActivity. + Unique identifier that is immutable on creation. + + + :return: The id of this ScheduledActivity. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this ScheduledActivity. + Unique identifier that is immutable on creation. + + + :param id: The id of this ScheduledActivity. + :type: str + """ + self._id = id + + @property + def display_name(self): + """ + **[Required]** Gets the display_name of this ScheduledActivity. + scheduled activity display name, can be renamed. + + + :return: The display_name of this ScheduledActivity. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this ScheduledActivity. + scheduled activity display name, can be renamed. + + + :param display_name: The display_name of this ScheduledActivity. + :type: str + """ + self._display_name = display_name + + @property + def run_cycle(self): + """ + **[Required]** Gets the run_cycle of this ScheduledActivity. + run cadence. + + Allowed values for this property are: "QUARTERLY", "MONTHLY", "ONEOFF", "VERTEX", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The run_cycle of this ScheduledActivity. + :rtype: str + """ + return self._run_cycle + + @run_cycle.setter + def run_cycle(self, run_cycle): + """ + Sets the run_cycle of this ScheduledActivity. + run cadence. + + + :param run_cycle: The run_cycle of this ScheduledActivity. + :type: str + """ + allowed_values = ["QUARTERLY", "MONTHLY", "ONEOFF", "VERTEX"] + if not value_allowed_none_or_none_sentinel(run_cycle, allowed_values): + run_cycle = 'UNKNOWN_ENUM_VALUE' + self._run_cycle = run_cycle + + @property + def fusion_environment_id(self): + """ + **[Required]** Gets the fusion_environment_id of this ScheduledActivity. + FAaaS Environment Identifier. + + + :return: The fusion_environment_id of this ScheduledActivity. + :rtype: str + """ + return self._fusion_environment_id + + @fusion_environment_id.setter + def fusion_environment_id(self, fusion_environment_id): + """ + Sets the fusion_environment_id of this ScheduledActivity. + FAaaS Environment Identifier. + + + :param fusion_environment_id: The fusion_environment_id of this ScheduledActivity. + :type: str + """ + self._fusion_environment_id = fusion_environment_id + + @property + def lifecycle_state(self): + """ + **[Required]** Gets the lifecycle_state of this ScheduledActivity. + The current state of the scheduledActivity. + + Allowed values for this property are: "ACCEPTED", "IN_PROGRESS", "FAILED", "SUCCEEDED", "CANCELED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The lifecycle_state of this ScheduledActivity. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this ScheduledActivity. + The current state of the scheduledActivity. + + + :param lifecycle_state: The lifecycle_state of this ScheduledActivity. + :type: str + """ + allowed_values = ["ACCEPTED", "IN_PROGRESS", "FAILED", "SUCCEEDED", "CANCELED"] + if not value_allowed_none_or_none_sentinel(lifecycle_state, allowed_values): + lifecycle_state = 'UNKNOWN_ENUM_VALUE' + self._lifecycle_state = lifecycle_state + + @property + def actions(self): + """ + Gets the actions of this ScheduledActivity. + List of actions + + + :return: The actions of this ScheduledActivity. + :rtype: list[oci.fusion_apps.models.Action] + """ + return self._actions + + @actions.setter + def actions(self, actions): + """ + Sets the actions of this ScheduledActivity. + List of actions + + + :param actions: The actions of this ScheduledActivity. + :type: list[oci.fusion_apps.models.Action] + """ + self._actions = actions + + @property + def service_availability(self): + """ + **[Required]** Gets the service_availability of this ScheduledActivity. + Service availability / impact during scheduled activity execution up down + + Allowed values for this property are: "AVAILABLE", "UNAVAILABLE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The service_availability of this ScheduledActivity. + :rtype: str + """ + return self._service_availability + + @service_availability.setter + def service_availability(self, service_availability): + """ + Sets the service_availability of this ScheduledActivity. + Service availability / impact during scheduled activity execution up down + + + :param service_availability: The service_availability of this ScheduledActivity. + :type: str + """ + allowed_values = ["AVAILABLE", "UNAVAILABLE"] + if not value_allowed_none_or_none_sentinel(service_availability, allowed_values): + service_availability = 'UNKNOWN_ENUM_VALUE' + self._service_availability = service_availability + + @property + def time_scheduled_start(self): + """ + **[Required]** Gets the time_scheduled_start of this ScheduledActivity. + Current time the scheduled activity is scheduled to start. An RFC3339 formatted datetime string. + + + :return: The time_scheduled_start of this ScheduledActivity. + :rtype: datetime + """ + return self._time_scheduled_start + + @time_scheduled_start.setter + def time_scheduled_start(self, time_scheduled_start): + """ + Sets the time_scheduled_start of this ScheduledActivity. + Current time the scheduled activity is scheduled to start. An RFC3339 formatted datetime string. + + + :param time_scheduled_start: The time_scheduled_start of this ScheduledActivity. + :type: datetime + """ + self._time_scheduled_start = time_scheduled_start + + @property + def time_expected_finish(self): + """ + **[Required]** Gets the time_expected_finish of this ScheduledActivity. + Current time the scheduled activity is scheduled to end. An RFC3339 formatted datetime string. + + + :return: The time_expected_finish of this ScheduledActivity. + :rtype: datetime + """ + return self._time_expected_finish + + @time_expected_finish.setter + def time_expected_finish(self, time_expected_finish): + """ + Sets the time_expected_finish of this ScheduledActivity. + Current time the scheduled activity is scheduled to end. An RFC3339 formatted datetime string. + + + :param time_expected_finish: The time_expected_finish of this ScheduledActivity. + :type: datetime + """ + self._time_expected_finish = time_expected_finish + + @property + def time_finished(self): + """ + Gets the time_finished of this ScheduledActivity. + The time the scheduled activity actually completed / cancelled / failed. An RFC3339 formatted datetime string. + + + :return: The time_finished of this ScheduledActivity. + :rtype: datetime + """ + return self._time_finished + + @time_finished.setter + def time_finished(self, time_finished): + """ + Sets the time_finished of this ScheduledActivity. + The time the scheduled activity actually completed / cancelled / failed. An RFC3339 formatted datetime string. + + + :param time_finished: The time_finished of this ScheduledActivity. + :type: datetime + """ + self._time_finished = time_finished + + @property + def delay_in_hours(self): + """ + Gets the delay_in_hours of this ScheduledActivity. + Cumulative delay hours + + + :return: The delay_in_hours of this ScheduledActivity. + :rtype: int + """ + return self._delay_in_hours + + @delay_in_hours.setter + def delay_in_hours(self, delay_in_hours): + """ + Sets the delay_in_hours of this ScheduledActivity. + Cumulative delay hours + + + :param delay_in_hours: The delay_in_hours of this ScheduledActivity. + :type: int + """ + self._delay_in_hours = delay_in_hours + + @property + def time_created(self): + """ + Gets the time_created of this ScheduledActivity. + The time the scheduled activity record was created. An RFC3339 formatted datetime string. + + + :return: The time_created of this ScheduledActivity. + :rtype: datetime + """ + return self._time_created + + @time_created.setter + def time_created(self, time_created): + """ + Sets the time_created of this ScheduledActivity. + The time the scheduled activity record was created. An RFC3339 formatted datetime string. + + + :param time_created: The time_created of this ScheduledActivity. + :type: datetime + """ + self._time_created = time_created + + @property + def time_updated(self): + """ + Gets the time_updated of this ScheduledActivity. + The time the scheduled activity record was updated. An RFC3339 formatted datetime string. + + + :return: The time_updated of this ScheduledActivity. + :rtype: datetime + """ + return self._time_updated + + @time_updated.setter + def time_updated(self, time_updated): + """ + Sets the time_updated of this ScheduledActivity. + The time the scheduled activity record was updated. An RFC3339 formatted datetime string. + + + :param time_updated: The time_updated of this ScheduledActivity. + :type: datetime + """ + self._time_updated = time_updated + + @property + def lifecycle_details(self): + """ + Gets the lifecycle_details of this ScheduledActivity. + A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. + + Allowed values for this property are: "NONE", "ROLLBACKACCEPTED", "ROLLBACKINPROGRESS", "ROLLBACKSUCCEEDED", "ROLLBACKFAILED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The lifecycle_details of this ScheduledActivity. + :rtype: str + """ + return self._lifecycle_details + + @lifecycle_details.setter + def lifecycle_details(self, lifecycle_details): + """ + Sets the lifecycle_details of this ScheduledActivity. + A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. + + + :param lifecycle_details: The lifecycle_details of this ScheduledActivity. + :type: str + """ + allowed_values = ["NONE", "ROLLBACKACCEPTED", "ROLLBACKINPROGRESS", "ROLLBACKSUCCEEDED", "ROLLBACKFAILED"] + if not value_allowed_none_or_none_sentinel(lifecycle_details, allowed_values): + lifecycle_details = 'UNKNOWN_ENUM_VALUE' + self._lifecycle_details = lifecycle_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/fusion_apps/models/scheduled_activity_collection.py b/src/oci/fusion_apps/models/scheduled_activity_collection.py new file mode 100644 index 0000000000..1700a94ee7 --- /dev/null +++ b/src/oci/fusion_apps/models/scheduled_activity_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 ScheduledActivityCollection(object): + """ + Results of a scheduled activity search. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ScheduledActivityCollection 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 ScheduledActivityCollection. + :type items: list[oci.fusion_apps.models.ScheduledActivitySummary] + + """ + self.swagger_types = { + 'items': 'list[ScheduledActivitySummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this ScheduledActivityCollection. + A page of scheduled activity objects. + + + :return: The items of this ScheduledActivityCollection. + :rtype: list[oci.fusion_apps.models.ScheduledActivitySummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this ScheduledActivityCollection. + A page of scheduled activity objects. + + + :param items: The items of this ScheduledActivityCollection. + :type: list[oci.fusion_apps.models.ScheduledActivitySummary] + """ + 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/fusion_apps/models/scheduled_activity_summary.py b/src/oci/fusion_apps/models/scheduled_activity_summary.py new file mode 100644 index 0000000000..cb1f03d857 --- /dev/null +++ b/src/oci/fusion_apps/models/scheduled_activity_summary.py @@ -0,0 +1,539 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 ScheduledActivitySummary(object): + """ + Summary of the scheduled activity for a Fusion environment. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ScheduledActivitySummary 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 ScheduledActivitySummary. + :type id: str + + :param display_name: + The value to assign to the display_name property of this ScheduledActivitySummary. + :type display_name: str + + :param run_cycle: + The value to assign to the run_cycle property of this ScheduledActivitySummary. + :type run_cycle: str + + :param fusion_environment_id: + The value to assign to the fusion_environment_id property of this ScheduledActivitySummary. + :type fusion_environment_id: str + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this ScheduledActivitySummary. + :type lifecycle_state: str + + :param actions: + The value to assign to the actions property of this ScheduledActivitySummary. + :type actions: list[oci.fusion_apps.models.Action] + + :param time_scheduled_start: + The value to assign to the time_scheduled_start property of this ScheduledActivitySummary. + :type time_scheduled_start: datetime + + :param time_expected_finish: + The value to assign to the time_expected_finish property of this ScheduledActivitySummary. + :type time_expected_finish: datetime + + :param time_finished: + The value to assign to the time_finished property of this ScheduledActivitySummary. + :type time_finished: datetime + + :param delay_in_hours: + The value to assign to the delay_in_hours property of this ScheduledActivitySummary. + :type delay_in_hours: int + + :param service_availability: + The value to assign to the service_availability property of this ScheduledActivitySummary. + :type service_availability: str + + :param time_accepted: + The value to assign to the time_accepted property of this ScheduledActivitySummary. + :type time_accepted: datetime + + :param time_updated: + The value to assign to the time_updated property of this ScheduledActivitySummary. + :type time_updated: datetime + + :param lifecycle_details: + The value to assign to the lifecycle_details property of this ScheduledActivitySummary. + :type lifecycle_details: str + + :param freeform_tags: + The value to assign to the freeform_tags property of this ScheduledActivitySummary. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this ScheduledActivitySummary. + :type defined_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'id': 'str', + 'display_name': 'str', + 'run_cycle': 'str', + 'fusion_environment_id': 'str', + 'lifecycle_state': 'str', + 'actions': 'list[Action]', + 'time_scheduled_start': 'datetime', + 'time_expected_finish': 'datetime', + 'time_finished': 'datetime', + 'delay_in_hours': 'int', + 'service_availability': 'str', + 'time_accepted': 'datetime', + 'time_updated': 'datetime', + 'lifecycle_details': 'str', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))' + } + + self.attribute_map = { + 'id': 'id', + 'display_name': 'displayName', + 'run_cycle': 'runCycle', + 'fusion_environment_id': 'fusionEnvironmentId', + 'lifecycle_state': 'lifecycleState', + 'actions': 'actions', + 'time_scheduled_start': 'timeScheduledStart', + 'time_expected_finish': 'timeExpectedFinish', + 'time_finished': 'timeFinished', + 'delay_in_hours': 'delayInHours', + 'service_availability': 'serviceAvailability', + 'time_accepted': 'timeAccepted', + 'time_updated': 'timeUpdated', + 'lifecycle_details': 'lifecycleDetails', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags' + } + + self._id = None + self._display_name = None + self._run_cycle = None + self._fusion_environment_id = None + self._lifecycle_state = None + self._actions = None + self._time_scheduled_start = None + self._time_expected_finish = None + self._time_finished = None + self._delay_in_hours = None + self._service_availability = None + self._time_accepted = None + self._time_updated = None + self._lifecycle_details = None + self._freeform_tags = None + self._defined_tags = None + + @property + def id(self): + """ + **[Required]** Gets the id of this ScheduledActivitySummary. + Unique identifier that is immutable on creation. + + + :return: The id of this ScheduledActivitySummary. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this ScheduledActivitySummary. + Unique identifier that is immutable on creation. + + + :param id: The id of this ScheduledActivitySummary. + :type: str + """ + self._id = id + + @property + def display_name(self): + """ + **[Required]** Gets the display_name of this ScheduledActivitySummary. + A friendly name for the scheduled activity. Can be changed later. + + + :return: The display_name of this ScheduledActivitySummary. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this ScheduledActivitySummary. + A friendly name for the scheduled activity. Can be changed later. + + + :param display_name: The display_name of this ScheduledActivitySummary. + :type: str + """ + self._display_name = display_name + + @property + def run_cycle(self): + """ + **[Required]** Gets the run_cycle of this ScheduledActivitySummary. + The run cadence of this scheduled activity. Valid values are Quarterly, Monthly, OneOff, and Vertex. + + + :return: The run_cycle of this ScheduledActivitySummary. + :rtype: str + """ + return self._run_cycle + + @run_cycle.setter + def run_cycle(self, run_cycle): + """ + Sets the run_cycle of this ScheduledActivitySummary. + The run cadence of this scheduled activity. Valid values are Quarterly, Monthly, OneOff, and Vertex. + + + :param run_cycle: The run_cycle of this ScheduledActivitySummary. + :type: str + """ + self._run_cycle = run_cycle + + @property + def fusion_environment_id(self): + """ + **[Required]** Gets the fusion_environment_id of this ScheduledActivitySummary. + The OCID of the Fusion environment for the scheduled activity. + + + :return: The fusion_environment_id of this ScheduledActivitySummary. + :rtype: str + """ + return self._fusion_environment_id + + @fusion_environment_id.setter + def fusion_environment_id(self, fusion_environment_id): + """ + Sets the fusion_environment_id of this ScheduledActivitySummary. + The OCID of the Fusion environment for the scheduled activity. + + + :param fusion_environment_id: The fusion_environment_id of this ScheduledActivitySummary. + :type: str + """ + self._fusion_environment_id = fusion_environment_id + + @property + def lifecycle_state(self): + """ + **[Required]** Gets the lifecycle_state of this ScheduledActivitySummary. + The current state of the scheduled activity. Valid values are Scheduled, In progress , Failed, Completed. + + + :return: The lifecycle_state of this ScheduledActivitySummary. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this ScheduledActivitySummary. + The current state of the scheduled activity. Valid values are Scheduled, In progress , Failed, Completed. + + + :param lifecycle_state: The lifecycle_state of this ScheduledActivitySummary. + :type: str + """ + self._lifecycle_state = lifecycle_state + + @property + def actions(self): + """ + Gets the actions of this ScheduledActivitySummary. + List of actions + + + :return: The actions of this ScheduledActivitySummary. + :rtype: list[oci.fusion_apps.models.Action] + """ + return self._actions + + @actions.setter + def actions(self, actions): + """ + Sets the actions of this ScheduledActivitySummary. + List of actions + + + :param actions: The actions of this ScheduledActivitySummary. + :type: list[oci.fusion_apps.models.Action] + """ + self._actions = actions + + @property + def time_scheduled_start(self): + """ + **[Required]** Gets the time_scheduled_start of this ScheduledActivitySummary. + Current time the scheduled activity is scheduled to start. An RFC3339 formatted datetime string. + + + :return: The time_scheduled_start of this ScheduledActivitySummary. + :rtype: datetime + """ + return self._time_scheduled_start + + @time_scheduled_start.setter + def time_scheduled_start(self, time_scheduled_start): + """ + Sets the time_scheduled_start of this ScheduledActivitySummary. + Current time the scheduled activity is scheduled to start. An RFC3339 formatted datetime string. + + + :param time_scheduled_start: The time_scheduled_start of this ScheduledActivitySummary. + :type: datetime + """ + self._time_scheduled_start = time_scheduled_start + + @property + def time_expected_finish(self): + """ + **[Required]** Gets the time_expected_finish of this ScheduledActivitySummary. + Current time the scheduled activity is scheduled to end. An RFC3339 formatted datetime string. + + + :return: The time_expected_finish of this ScheduledActivitySummary. + :rtype: datetime + """ + return self._time_expected_finish + + @time_expected_finish.setter + def time_expected_finish(self, time_expected_finish): + """ + Sets the time_expected_finish of this ScheduledActivitySummary. + Current time the scheduled activity is scheduled to end. An RFC3339 formatted datetime string. + + + :param time_expected_finish: The time_expected_finish of this ScheduledActivitySummary. + :type: datetime + """ + self._time_expected_finish = time_expected_finish + + @property + def time_finished(self): + """ + Gets the time_finished of this ScheduledActivitySummary. + The time the scheduled activity actually completed / cancelled / failed. An RFC3339 formatted datetime string. + + + :return: The time_finished of this ScheduledActivitySummary. + :rtype: datetime + """ + return self._time_finished + + @time_finished.setter + def time_finished(self, time_finished): + """ + Sets the time_finished of this ScheduledActivitySummary. + The time the scheduled activity actually completed / cancelled / failed. An RFC3339 formatted datetime string. + + + :param time_finished: The time_finished of this ScheduledActivitySummary. + :type: datetime + """ + self._time_finished = time_finished + + @property + def delay_in_hours(self): + """ + Gets the delay_in_hours of this ScheduledActivitySummary. + Cumulative delay hours + + + :return: The delay_in_hours of this ScheduledActivitySummary. + :rtype: int + """ + return self._delay_in_hours + + @delay_in_hours.setter + def delay_in_hours(self, delay_in_hours): + """ + Sets the delay_in_hours of this ScheduledActivitySummary. + Cumulative delay hours + + + :param delay_in_hours: The delay_in_hours of this ScheduledActivitySummary. + :type: int + """ + self._delay_in_hours = delay_in_hours + + @property + def service_availability(self): + """ + **[Required]** Gets the service_availability of this ScheduledActivitySummary. + Service availability / impact during scheduled activity execution, up down + + + :return: The service_availability of this ScheduledActivitySummary. + :rtype: str + """ + return self._service_availability + + @service_availability.setter + def service_availability(self, service_availability): + """ + Sets the service_availability of this ScheduledActivitySummary. + Service availability / impact during scheduled activity execution, up down + + + :param service_availability: The service_availability of this ScheduledActivitySummary. + :type: str + """ + self._service_availability = service_availability + + @property + def time_accepted(self): + """ + Gets the time_accepted of this ScheduledActivitySummary. + The time the scheduled activity record was created. An RFC3339 formatted datetime string. + + + :return: The time_accepted of this ScheduledActivitySummary. + :rtype: datetime + """ + return self._time_accepted + + @time_accepted.setter + def time_accepted(self, time_accepted): + """ + Sets the time_accepted of this ScheduledActivitySummary. + The time the scheduled activity record was created. An RFC3339 formatted datetime string. + + + :param time_accepted: The time_accepted of this ScheduledActivitySummary. + :type: datetime + """ + self._time_accepted = time_accepted + + @property + def time_updated(self): + """ + Gets the time_updated of this ScheduledActivitySummary. + The time the scheduled activity record was updated. An RFC3339 formatted datetime string. + + + :return: The time_updated of this ScheduledActivitySummary. + :rtype: datetime + """ + return self._time_updated + + @time_updated.setter + def time_updated(self, time_updated): + """ + Sets the time_updated of this ScheduledActivitySummary. + The time the scheduled activity record was updated. An RFC3339 formatted datetime string. + + + :param time_updated: The time_updated of this ScheduledActivitySummary. + :type: datetime + """ + self._time_updated = time_updated + + @property + def lifecycle_details(self): + """ + Gets the lifecycle_details of this ScheduledActivitySummary. + A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. + + + :return: The lifecycle_details of this ScheduledActivitySummary. + :rtype: str + """ + return self._lifecycle_details + + @lifecycle_details.setter + def lifecycle_details(self, lifecycle_details): + """ + Sets the lifecycle_details of this ScheduledActivitySummary. + A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. + + + :param lifecycle_details: The lifecycle_details of this ScheduledActivitySummary. + :type: str + """ + self._lifecycle_details = lifecycle_details + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this ScheduledActivitySummary. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :return: The freeform_tags of this ScheduledActivitySummary. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this ScheduledActivitySummary. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :param freeform_tags: The freeform_tags of this ScheduledActivitySummary. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this ScheduledActivitySummary. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this ScheduledActivitySummary. + :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 ScheduledActivitySummary. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this ScheduledActivitySummary. + :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/fusion_apps/models/service_attachment.py b/src/oci/fusion_apps/models/service_attachment.py new file mode 100644 index 0000000000..8509e78b77 --- /dev/null +++ b/src/oci/fusion_apps/models/service_attachment.py @@ -0,0 +1,506 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 ServiceAttachment(object): + """ + Description of ServiceAttachment. + """ + + #: A constant which can be used with the service_instance_type property of a ServiceAttachment. + #: This constant has a value of "DIGITAL_ASSISTANT" + SERVICE_INSTANCE_TYPE_DIGITAL_ASSISTANT = "DIGITAL_ASSISTANT" + + #: A constant which can be used with the service_instance_type property of a ServiceAttachment. + #: This constant has a value of "INTEGRATION_CLOUD" + SERVICE_INSTANCE_TYPE_INTEGRATION_CLOUD = "INTEGRATION_CLOUD" + + #: A constant which can be used with the service_instance_type property of a ServiceAttachment. + #: This constant has a value of "ANALYTICS_WAREHOUSE" + SERVICE_INSTANCE_TYPE_ANALYTICS_WAREHOUSE = "ANALYTICS_WAREHOUSE" + + #: A constant which can be used with the service_instance_type property of a ServiceAttachment. + #: This constant has a value of "VBCS" + SERVICE_INSTANCE_TYPE_VBCS = "VBCS" + + #: A constant which can be used with the service_instance_type property of a ServiceAttachment. + #: This constant has a value of "VISUAL_BUILDER_STUDIO" + SERVICE_INSTANCE_TYPE_VISUAL_BUILDER_STUDIO = "VISUAL_BUILDER_STUDIO" + + #: A constant which can be used with the lifecycle_state property of a ServiceAttachment. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + #: A constant which can be used with the lifecycle_state property of a ServiceAttachment. + #: This constant has a value of "UPDATING" + LIFECYCLE_STATE_UPDATING = "UPDATING" + + #: A constant which can be used with the lifecycle_state property of a ServiceAttachment. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a ServiceAttachment. + #: This constant has a value of "DELETING" + LIFECYCLE_STATE_DELETING = "DELETING" + + #: A constant which can be used with the lifecycle_state property of a ServiceAttachment. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" + + #: A constant which can be used with the lifecycle_state property of a ServiceAttachment. + #: This constant has a value of "FAILED" + LIFECYCLE_STATE_FAILED = "FAILED" + + def __init__(self, **kwargs): + """ + Initializes a new ServiceAttachment 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 ServiceAttachment. + :type id: str + + :param action: + The value to assign to the action property of this ServiceAttachment. + :type action: str + + :param compartment_id: + The value to assign to the compartment_id property of this ServiceAttachment. + :type compartment_id: str + + :param service_instance_id: + The value to assign to the service_instance_id property of this ServiceAttachment. + :type service_instance_id: str + + :param display_name: + The value to assign to the display_name property of this ServiceAttachment. + :type display_name: str + + :param service_instance_type: + The value to assign to the service_instance_type property of this ServiceAttachment. + Allowed values for this property are: "DIGITAL_ASSISTANT", "INTEGRATION_CLOUD", "ANALYTICS_WAREHOUSE", "VBCS", "VISUAL_BUILDER_STUDIO", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type service_instance_type: str + + :param service_url: + The value to assign to the service_url property of this ServiceAttachment. + :type service_url: str + + :param time_created: + The value to assign to the time_created property of this ServiceAttachment. + :type time_created: datetime + + :param time_updated: + The value to assign to the time_updated property of this ServiceAttachment. + :type time_updated: datetime + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this ServiceAttachment. + Allowed values for this property are: "CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type lifecycle_state: str + + :param is_sku_based: + The value to assign to the is_sku_based property of this ServiceAttachment. + :type is_sku_based: bool + + :param freeform_tags: + The value to assign to the freeform_tags property of this ServiceAttachment. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this ServiceAttachment. + :type defined_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'id': 'str', + 'action': 'str', + 'compartment_id': 'str', + 'service_instance_id': 'str', + 'display_name': 'str', + 'service_instance_type': 'str', + 'service_url': 'str', + 'time_created': 'datetime', + 'time_updated': 'datetime', + 'lifecycle_state': 'str', + 'is_sku_based': 'bool', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))' + } + + self.attribute_map = { + 'id': 'id', + 'action': 'action', + 'compartment_id': 'compartmentId', + 'service_instance_id': 'serviceInstanceId', + 'display_name': 'displayName', + 'service_instance_type': 'serviceInstanceType', + 'service_url': 'serviceUrl', + 'time_created': 'timeCreated', + 'time_updated': 'timeUpdated', + 'lifecycle_state': 'lifecycleState', + 'is_sku_based': 'isSkuBased', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags' + } + + self._id = None + self._action = None + self._compartment_id = None + self._service_instance_id = None + self._display_name = None + self._service_instance_type = None + self._service_url = None + self._time_created = None + self._time_updated = None + self._lifecycle_state = None + self._is_sku_based = None + self._freeform_tags = None + self._defined_tags = None + + @property + def id(self): + """ + **[Required]** Gets the id of this ServiceAttachment. + Unique identifier that is immutable on creation + + + :return: The id of this ServiceAttachment. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this ServiceAttachment. + Unique identifier that is immutable on creation + + + :param id: The id of this ServiceAttachment. + :type: str + """ + self._id = id + + @property + def action(self): + """ + Gets the action of this ServiceAttachment. + Action + + + :return: The action of this ServiceAttachment. + :rtype: str + """ + return self._action + + @action.setter + def action(self, action): + """ + Sets the action of this ServiceAttachment. + Action + + + :param action: The action of this ServiceAttachment. + :type: str + """ + self._action = action + + @property + def compartment_id(self): + """ + Gets the compartment_id of this ServiceAttachment. + Compartment Identifier + + + :return: The compartment_id of this ServiceAttachment. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this ServiceAttachment. + Compartment Identifier + + + :param compartment_id: The compartment_id of this ServiceAttachment. + :type: str + """ + self._compartment_id = compartment_id + + @property + def service_instance_id(self): + """ + Gets the service_instance_id of this ServiceAttachment. + The ID of the service instance created that can be used to identify this on the service control plane + + + :return: The service_instance_id of this ServiceAttachment. + :rtype: str + """ + return self._service_instance_id + + @service_instance_id.setter + def service_instance_id(self, service_instance_id): + """ + Sets the service_instance_id of this ServiceAttachment. + The ID of the service instance created that can be used to identify this on the service control plane + + + :param service_instance_id: The service_instance_id of this ServiceAttachment. + :type: str + """ + self._service_instance_id = service_instance_id + + @property + def display_name(self): + """ + **[Required]** Gets the display_name of this ServiceAttachment. + Service Attachment Display name, can be renamed + + + :return: The display_name of this ServiceAttachment. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this ServiceAttachment. + Service Attachment Display name, can be renamed + + + :param display_name: The display_name of this ServiceAttachment. + :type: str + """ + self._display_name = display_name + + @property + def service_instance_type(self): + """ + **[Required]** Gets the service_instance_type of this ServiceAttachment. + Type of the serviceInstance. + + Allowed values for this property are: "DIGITAL_ASSISTANT", "INTEGRATION_CLOUD", "ANALYTICS_WAREHOUSE", "VBCS", "VISUAL_BUILDER_STUDIO", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The service_instance_type of this ServiceAttachment. + :rtype: str + """ + return self._service_instance_type + + @service_instance_type.setter + def service_instance_type(self, service_instance_type): + """ + Sets the service_instance_type of this ServiceAttachment. + Type of the serviceInstance. + + + :param service_instance_type: The service_instance_type of this ServiceAttachment. + :type: str + """ + allowed_values = ["DIGITAL_ASSISTANT", "INTEGRATION_CLOUD", "ANALYTICS_WAREHOUSE", "VBCS", "VISUAL_BUILDER_STUDIO"] + if not value_allowed_none_or_none_sentinel(service_instance_type, allowed_values): + service_instance_type = 'UNKNOWN_ENUM_VALUE' + self._service_instance_type = service_instance_type + + @property + def service_url(self): + """ + Gets the service_url of this ServiceAttachment. + Public URL + + + :return: The service_url of this ServiceAttachment. + :rtype: str + """ + return self._service_url + + @service_url.setter + def service_url(self, service_url): + """ + Sets the service_url of this ServiceAttachment. + Public URL + + + :param service_url: The service_url of this ServiceAttachment. + :type: str + """ + self._service_url = service_url + + @property + def time_created(self): + """ + Gets the time_created of this ServiceAttachment. + The time the the ServiceInstance was created. An RFC3339 formatted datetime string + + + :return: The time_created of this ServiceAttachment. + :rtype: datetime + """ + return self._time_created + + @time_created.setter + def time_created(self, time_created): + """ + Sets the time_created of this ServiceAttachment. + The time the the ServiceInstance was created. An RFC3339 formatted datetime string + + + :param time_created: The time_created of this ServiceAttachment. + :type: datetime + """ + self._time_created = time_created + + @property + def time_updated(self): + """ + Gets the time_updated of this ServiceAttachment. + The time the ServiceInstance was updated. An RFC3339 formatted datetime string + + + :return: The time_updated of this ServiceAttachment. + :rtype: datetime + """ + return self._time_updated + + @time_updated.setter + def time_updated(self, time_updated): + """ + Sets the time_updated of this ServiceAttachment. + The time the ServiceInstance was updated. An RFC3339 formatted datetime string + + + :param time_updated: The time_updated of this ServiceAttachment. + :type: datetime + """ + self._time_updated = time_updated + + @property + def lifecycle_state(self): + """ + **[Required]** Gets the lifecycle_state of this ServiceAttachment. + The current state of the ServiceInstance. + + Allowed values for this property are: "CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The lifecycle_state of this ServiceAttachment. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this ServiceAttachment. + The current state of the ServiceInstance. + + + :param lifecycle_state: The lifecycle_state of this ServiceAttachment. + :type: str + """ + allowed_values = ["CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED"] + if not value_allowed_none_or_none_sentinel(lifecycle_state, allowed_values): + lifecycle_state = 'UNKNOWN_ENUM_VALUE' + self._lifecycle_state = lifecycle_state + + @property + def is_sku_based(self): + """ + **[Required]** Gets the is_sku_based of this ServiceAttachment. + Whether this service is provisioned due to the customer being subscribed to a specific SKU + + + :return: The is_sku_based of this ServiceAttachment. + :rtype: bool + """ + return self._is_sku_based + + @is_sku_based.setter + def is_sku_based(self, is_sku_based): + """ + Sets the is_sku_based of this ServiceAttachment. + Whether this service is provisioned due to the customer being subscribed to a specific SKU + + + :param is_sku_based: The is_sku_based of this ServiceAttachment. + :type: bool + """ + self._is_sku_based = is_sku_based + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this ServiceAttachment. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :return: The freeform_tags of this ServiceAttachment. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this ServiceAttachment. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :param freeform_tags: The freeform_tags of this ServiceAttachment. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this ServiceAttachment. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this ServiceAttachment. + :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 ServiceAttachment. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this ServiceAttachment. + :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/fusion_apps/models/service_attachment_collection.py b/src/oci/fusion_apps/models/service_attachment_collection.py new file mode 100644 index 0000000000..1f08a4c909 --- /dev/null +++ b/src/oci/fusion_apps/models/service_attachment_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 ServiceAttachmentCollection(object): + """ + List of service attachments for a fusion instance. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ServiceAttachmentCollection 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 ServiceAttachmentCollection. + :type items: list[oci.fusion_apps.models.ServiceAttachmentSummary] + + """ + self.swagger_types = { + 'items': 'list[ServiceAttachmentSummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this ServiceAttachmentCollection. + A page of FusionEnvironmentFamilySummary objects. + + + :return: The items of this ServiceAttachmentCollection. + :rtype: list[oci.fusion_apps.models.ServiceAttachmentSummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this ServiceAttachmentCollection. + A page of FusionEnvironmentFamilySummary objects. + + + :param items: The items of this ServiceAttachmentCollection. + :type: list[oci.fusion_apps.models.ServiceAttachmentSummary] + """ + 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/fusion_apps/models/service_attachment_summary.py b/src/oci/fusion_apps/models/service_attachment_summary.py new file mode 100644 index 0000000000..8537ccf2cf --- /dev/null +++ b/src/oci/fusion_apps/models/service_attachment_summary.py @@ -0,0 +1,415 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 ServiceAttachmentSummary(object): + """ + Summary of the ServiceInstance. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ServiceAttachmentSummary 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 ServiceAttachmentSummary. + :type id: str + + :param display_name: + The value to assign to the display_name property of this ServiceAttachmentSummary. + :type display_name: str + + :param service_instance_type: + The value to assign to the service_instance_type property of this ServiceAttachmentSummary. + :type service_instance_type: str + + :param service_instance_id: + The value to assign to the service_instance_id property of this ServiceAttachmentSummary. + :type service_instance_id: str + + :param service_url: + The value to assign to the service_url property of this ServiceAttachmentSummary. + :type service_url: str + + :param time_created: + The value to assign to the time_created property of this ServiceAttachmentSummary. + :type time_created: datetime + + :param time_updated: + The value to assign to the time_updated property of this ServiceAttachmentSummary. + :type time_updated: datetime + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this ServiceAttachmentSummary. + :type lifecycle_state: str + + :param lifecycle_details: + The value to assign to the lifecycle_details property of this ServiceAttachmentSummary. + :type lifecycle_details: str + + :param is_sku_based: + The value to assign to the is_sku_based property of this ServiceAttachmentSummary. + :type is_sku_based: bool + + :param freeform_tags: + The value to assign to the freeform_tags property of this ServiceAttachmentSummary. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this ServiceAttachmentSummary. + :type defined_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'id': 'str', + 'display_name': 'str', + 'service_instance_type': 'str', + 'service_instance_id': 'str', + 'service_url': 'str', + 'time_created': 'datetime', + 'time_updated': 'datetime', + 'lifecycle_state': 'str', + 'lifecycle_details': 'str', + 'is_sku_based': 'bool', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))' + } + + self.attribute_map = { + 'id': 'id', + 'display_name': 'displayName', + 'service_instance_type': 'serviceInstanceType', + 'service_instance_id': 'serviceInstanceId', + 'service_url': 'serviceUrl', + 'time_created': 'timeCreated', + 'time_updated': 'timeUpdated', + 'lifecycle_state': 'lifecycleState', + 'lifecycle_details': 'lifecycleDetails', + 'is_sku_based': 'isSkuBased', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags' + } + + self._id = None + self._display_name = None + self._service_instance_type = None + self._service_instance_id = None + self._service_url = None + self._time_created = None + self._time_updated = None + self._lifecycle_state = None + self._lifecycle_details = None + self._is_sku_based = None + self._freeform_tags = None + self._defined_tags = None + + @property + def id(self): + """ + **[Required]** Gets the id of this ServiceAttachmentSummary. + Unique identifier that is immutable on creation + + + :return: The id of this ServiceAttachmentSummary. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this ServiceAttachmentSummary. + Unique identifier that is immutable on creation + + + :param id: The id of this ServiceAttachmentSummary. + :type: str + """ + self._id = id + + @property + def display_name(self): + """ + **[Required]** Gets the display_name of this ServiceAttachmentSummary. + ServiceInstance Identifier, can be renamed + + + :return: The display_name of this ServiceAttachmentSummary. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this ServiceAttachmentSummary. + ServiceInstance Identifier, can be renamed + + + :param display_name: The display_name of this ServiceAttachmentSummary. + :type: str + """ + self._display_name = display_name + + @property + def service_instance_type(self): + """ + **[Required]** Gets the service_instance_type of this ServiceAttachmentSummary. + Type of the service. + + + :return: The service_instance_type of this ServiceAttachmentSummary. + :rtype: str + """ + return self._service_instance_type + + @service_instance_type.setter + def service_instance_type(self, service_instance_type): + """ + Sets the service_instance_type of this ServiceAttachmentSummary. + Type of the service. + + + :param service_instance_type: The service_instance_type of this ServiceAttachmentSummary. + :type: str + """ + self._service_instance_type = service_instance_type + + @property + def service_instance_id(self): + """ + Gets the service_instance_id of this ServiceAttachmentSummary. + The ID of the service instance created that can be used to identify this on the service control plane + + + :return: The service_instance_id of this ServiceAttachmentSummary. + :rtype: str + """ + return self._service_instance_id + + @service_instance_id.setter + def service_instance_id(self, service_instance_id): + """ + Sets the service_instance_id of this ServiceAttachmentSummary. + The ID of the service instance created that can be used to identify this on the service control plane + + + :param service_instance_id: The service_instance_id of this ServiceAttachmentSummary. + :type: str + """ + self._service_instance_id = service_instance_id + + @property + def service_url(self): + """ + Gets the service_url of this ServiceAttachmentSummary. + Service URL of the instance + + + :return: The service_url of this ServiceAttachmentSummary. + :rtype: str + """ + return self._service_url + + @service_url.setter + def service_url(self, service_url): + """ + Sets the service_url of this ServiceAttachmentSummary. + Service URL of the instance + + + :param service_url: The service_url of this ServiceAttachmentSummary. + :type: str + """ + self._service_url = service_url + + @property + def time_created(self): + """ + Gets the time_created of this ServiceAttachmentSummary. + The time the service instance was created. An RFC3339 formatted datetime string + + + :return: The time_created of this ServiceAttachmentSummary. + :rtype: datetime + """ + return self._time_created + + @time_created.setter + def time_created(self, time_created): + """ + Sets the time_created of this ServiceAttachmentSummary. + The time the service instance was created. An RFC3339 formatted datetime string + + + :param time_created: The time_created of this ServiceAttachmentSummary. + :type: datetime + """ + self._time_created = time_created + + @property + def time_updated(self): + """ + Gets the time_updated of this ServiceAttachmentSummary. + The time the serivce instance was updated. An RFC3339 formatted datetime string + + + :return: The time_updated of this ServiceAttachmentSummary. + :rtype: datetime + """ + return self._time_updated + + @time_updated.setter + def time_updated(self, time_updated): + """ + Sets the time_updated of this ServiceAttachmentSummary. + The time the serivce instance was updated. An RFC3339 formatted datetime string + + + :param time_updated: The time_updated of this ServiceAttachmentSummary. + :type: datetime + """ + self._time_updated = time_updated + + @property + def lifecycle_state(self): + """ + **[Required]** Gets the lifecycle_state of this ServiceAttachmentSummary. + The current state of the ServiceInstance. + + + :return: The lifecycle_state of this ServiceAttachmentSummary. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this ServiceAttachmentSummary. + The current state of the ServiceInstance. + + + :param lifecycle_state: The lifecycle_state of this ServiceAttachmentSummary. + :type: str + """ + self._lifecycle_state = lifecycle_state + + @property + def lifecycle_details(self): + """ + Gets the lifecycle_details of this ServiceAttachmentSummary. + A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. + + + :return: The lifecycle_details of this ServiceAttachmentSummary. + :rtype: str + """ + return self._lifecycle_details + + @lifecycle_details.setter + def lifecycle_details(self, lifecycle_details): + """ + Sets the lifecycle_details of this ServiceAttachmentSummary. + A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. + + + :param lifecycle_details: The lifecycle_details of this ServiceAttachmentSummary. + :type: str + """ + self._lifecycle_details = lifecycle_details + + @property + def is_sku_based(self): + """ + **[Required]** Gets the is_sku_based of this ServiceAttachmentSummary. + Whether this service is provisioned due to the customer being subscribed to a specific SKU + + + :return: The is_sku_based of this ServiceAttachmentSummary. + :rtype: bool + """ + return self._is_sku_based + + @is_sku_based.setter + def is_sku_based(self, is_sku_based): + """ + Sets the is_sku_based of this ServiceAttachmentSummary. + Whether this service is provisioned due to the customer being subscribed to a specific SKU + + + :param is_sku_based: The is_sku_based of this ServiceAttachmentSummary. + :type: bool + """ + self._is_sku_based = is_sku_based + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this ServiceAttachmentSummary. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :return: The freeform_tags of this ServiceAttachmentSummary. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this ServiceAttachmentSummary. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :param freeform_tags: The freeform_tags of this ServiceAttachmentSummary. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this ServiceAttachmentSummary. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this ServiceAttachmentSummary. + :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 ServiceAttachmentSummary. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this ServiceAttachmentSummary. + :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/fusion_apps/models/source_ip_address_condition.py b/src/oci/fusion_apps/models/source_ip_address_condition.py new file mode 100644 index 0000000000..7a5e18fc6d --- /dev/null +++ b/src/oci/fusion_apps/models/source_ip_address_condition.py @@ -0,0 +1,86 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .rule_condition import RuleCondition +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 SourceIpAddressCondition(RuleCondition): + """ + An access control rule condition that requires a match on the specified source IP address or address range. + """ + + def __init__(self, **kwargs): + """ + Initializes a new SourceIpAddressCondition object with values from keyword arguments. The default value of the :py:attr:`~oci.fusion_apps.models.SourceIpAddressCondition.attribute_name` attribute + of this class is ``SOURCE_IP_ADDRESS`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param attribute_name: + The value to assign to the attribute_name property of this SourceIpAddressCondition. + Allowed values for this property are: "SOURCE_IP_ADDRESS", "SOURCE_VCN_ID", "SOURCE_VCN_IP_ADDRESS" + :type attribute_name: str + + :param attribute_value: + The value to assign to the attribute_value property of this SourceIpAddressCondition. + :type attribute_value: str + + """ + self.swagger_types = { + 'attribute_name': 'str', + 'attribute_value': 'str' + } + + self.attribute_map = { + 'attribute_name': 'attributeName', + 'attribute_value': 'attributeValue' + } + + self._attribute_name = None + self._attribute_value = None + self._attribute_name = 'SOURCE_IP_ADDRESS' + + @property + def attribute_value(self): + """ + Gets the attribute_value of this SourceIpAddressCondition. + An IPv4 or IPv6 address range that the source IP address of an incoming packet must match. + The service accepts only classless inter-domain routing (CIDR) format (x.x.x.x/y or x:x::x/y) strings. + Specify 0.0.0.0/0 or ::/0 to match all incoming traffic. + example: \"192.168.0.0/16\" + + + :return: The attribute_value of this SourceIpAddressCondition. + :rtype: str + """ + return self._attribute_value + + @attribute_value.setter + def attribute_value(self, attribute_value): + """ + Sets the attribute_value of this SourceIpAddressCondition. + An IPv4 or IPv6 address range that the source IP address of an incoming packet must match. + The service accepts only classless inter-domain routing (CIDR) format (x.x.x.x/y or x:x::x/y) strings. + Specify 0.0.0.0/0 or ::/0 to match all incoming traffic. + example: \"192.168.0.0/16\" + + + :param attribute_value: The attribute_value of this SourceIpAddressCondition. + :type: str + """ + self._attribute_value = attribute_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/fusion_apps/models/source_vcn_id_condition.py b/src/oci/fusion_apps/models/source_vcn_id_condition.py new file mode 100644 index 0000000000..85ce994a93 --- /dev/null +++ b/src/oci/fusion_apps/models/source_vcn_id_condition.py @@ -0,0 +1,86 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .rule_condition import RuleCondition +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 SourceVcnIdCondition(RuleCondition): + """ + An access control rule condition that requires a match on the specified source VCN OCID. + """ + + def __init__(self, **kwargs): + """ + Initializes a new SourceVcnIdCondition object with values from keyword arguments. The default value of the :py:attr:`~oci.fusion_apps.models.SourceVcnIdCondition.attribute_name` attribute + of this class is ``SOURCE_VCN_ID`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param attribute_name: + The value to assign to the attribute_name property of this SourceVcnIdCondition. + Allowed values for this property are: "SOURCE_IP_ADDRESS", "SOURCE_VCN_ID", "SOURCE_VCN_IP_ADDRESS" + :type attribute_name: str + + :param attribute_value: + The value to assign to the attribute_value property of this SourceVcnIdCondition. + :type attribute_value: str + + """ + self.swagger_types = { + 'attribute_name': 'str', + 'attribute_value': 'str' + } + + self.attribute_map = { + 'attribute_name': 'attributeName', + 'attribute_value': 'attributeValue' + } + + self._attribute_name = None + self._attribute_value = None + self._attribute_name = 'SOURCE_VCN_ID' + + @property + def attribute_value(self): + """ + **[Required]** Gets the attribute_value of this SourceVcnIdCondition. + The OCID of the originating VCN that an incoming packet must match. + You can use this condition in conjunction with `SourceVcnIpAddressCondition`. + **NOTE:** If you define this condition for a rule without a `SourceVcnIpAddressCondition`, this condition + matches all incoming traffic in the specified VCN. + + + :return: The attribute_value of this SourceVcnIdCondition. + :rtype: str + """ + return self._attribute_value + + @attribute_value.setter + def attribute_value(self, attribute_value): + """ + Sets the attribute_value of this SourceVcnIdCondition. + The OCID of the originating VCN that an incoming packet must match. + You can use this condition in conjunction with `SourceVcnIpAddressCondition`. + **NOTE:** If you define this condition for a rule without a `SourceVcnIpAddressCondition`, this condition + matches all incoming traffic in the specified VCN. + + + :param attribute_value: The attribute_value of this SourceVcnIdCondition. + :type: str + """ + self._attribute_value = attribute_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/fusion_apps/models/source_vcn_ip_address_condition.py b/src/oci/fusion_apps/models/source_vcn_ip_address_condition.py new file mode 100644 index 0000000000..c5a5e51b74 --- /dev/null +++ b/src/oci/fusion_apps/models/source_vcn_ip_address_condition.py @@ -0,0 +1,87 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .rule_condition import RuleCondition +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 SourceVcnIpAddressCondition(RuleCondition): + """ + An access control rule condition that requires a match on the specified source VCN and IP address range. + This condition must be used only in conjunction with `SourceVcnIdCondition`. + """ + + def __init__(self, **kwargs): + """ + Initializes a new SourceVcnIpAddressCondition object with values from keyword arguments. The default value of the :py:attr:`~oci.fusion_apps.models.SourceVcnIpAddressCondition.attribute_name` attribute + of this class is ``SOURCE_VCN_IP_ADDRESS`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param attribute_name: + The value to assign to the attribute_name property of this SourceVcnIpAddressCondition. + Allowed values for this property are: "SOURCE_IP_ADDRESS", "SOURCE_VCN_ID", "SOURCE_VCN_IP_ADDRESS" + :type attribute_name: str + + :param attribute_value: + The value to assign to the attribute_value property of this SourceVcnIpAddressCondition. + :type attribute_value: str + + """ + self.swagger_types = { + 'attribute_name': 'str', + 'attribute_value': 'str' + } + + self.attribute_map = { + 'attribute_name': 'attributeName', + 'attribute_value': 'attributeValue' + } + + self._attribute_name = None + self._attribute_value = None + self._attribute_name = 'SOURCE_VCN_IP_ADDRESS' + + @property + def attribute_value(self): + """ + **[Required]** Gets the attribute_value of this SourceVcnIpAddressCondition. + An IPv4 address range that the original client IP address (in the context of the specified VCN) of an + incoming packet must match. + The service accepts only classless inter-domain routing (CIDR) format (x.x.x.x/y) strings. + Specify 0.0.0.0/0 to match all incoming traffic in the customer VCN. + + + :return: The attribute_value of this SourceVcnIpAddressCondition. + :rtype: str + """ + return self._attribute_value + + @attribute_value.setter + def attribute_value(self, attribute_value): + """ + Sets the attribute_value of this SourceVcnIpAddressCondition. + An IPv4 address range that the original client IP address (in the context of the specified VCN) of an + incoming packet must match. + The service accepts only classless inter-domain routing (CIDR) format (x.x.x.x/y) strings. + Specify 0.0.0.0/0 to match all incoming traffic in the customer VCN. + + + :param attribute_value: The attribute_value of this SourceVcnIpAddressCondition. + :type: str + """ + self._attribute_value = attribute_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/fusion_apps/models/subscription.py b/src/oci/fusion_apps/models/subscription.py new file mode 100644 index 0000000000..3916761422 --- /dev/null +++ b/src/oci/fusion_apps/models/subscription.py @@ -0,0 +1,163 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 Subscription(object): + """ + Subscription information for compartmentId. Only root compartments are allowed. + """ + + def __init__(self, **kwargs): + """ + Initializes a new Subscription 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 Subscription. + :type id: str + + :param classic_subscription_id: + The value to assign to the classic_subscription_id property of this Subscription. + :type classic_subscription_id: str + + :param service_name: + The value to assign to the service_name property of this Subscription. + :type service_name: str + + :param skus: + The value to assign to the skus property of this Subscription. + :type skus: list[oci.fusion_apps.models.SubscriptionSku] + + """ + self.swagger_types = { + 'id': 'str', + 'classic_subscription_id': 'str', + 'service_name': 'str', + 'skus': 'list[SubscriptionSku]' + } + + self.attribute_map = { + 'id': 'id', + 'classic_subscription_id': 'classicSubscriptionId', + 'service_name': 'serviceName', + 'skus': 'skus' + } + + self._id = None + self._classic_subscription_id = None + self._service_name = None + self._skus = None + + @property + def id(self): + """ + **[Required]** Gets the id of this Subscription. + OCID of the subscription details for particular root compartment or tenancy. + + + :return: The id of this Subscription. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this Subscription. + OCID of the subscription details for particular root compartment or tenancy. + + + :param id: The id of this Subscription. + :type: str + """ + self._id = id + + @property + def classic_subscription_id(self): + """ + **[Required]** Gets the classic_subscription_id of this Subscription. + Subscription id. + + + :return: The classic_subscription_id of this Subscription. + :rtype: str + """ + return self._classic_subscription_id + + @classic_subscription_id.setter + def classic_subscription_id(self, classic_subscription_id): + """ + Sets the classic_subscription_id of this Subscription. + Subscription id. + + + :param classic_subscription_id: The classic_subscription_id of this Subscription. + :type: str + """ + self._classic_subscription_id = classic_subscription_id + + @property + def service_name(self): + """ + **[Required]** Gets the service_name of this Subscription. + The type of subscription, such as 'CLOUDCM'/'SAAS'/'CRM', etc. + + + :return: The service_name of this Subscription. + :rtype: str + """ + return self._service_name + + @service_name.setter + def service_name(self, service_name): + """ + Sets the service_name of this Subscription. + The type of subscription, such as 'CLOUDCM'/'SAAS'/'CRM', etc. + + + :param service_name: The service_name of this Subscription. + :type: str + """ + self._service_name = service_name + + @property + def skus(self): + """ + **[Required]** Gets the skus of this Subscription. + Stock keeping unit. + + + :return: The skus of this Subscription. + :rtype: list[oci.fusion_apps.models.SubscriptionSku] + """ + return self._skus + + @skus.setter + def skus(self, skus): + """ + Sets the skus of this Subscription. + Stock keeping unit. + + + :param skus: The skus of this Subscription. + :type: list[oci.fusion_apps.models.SubscriptionSku] + """ + self._skus = skus + + 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/fusion_apps/models/subscription_detail.py b/src/oci/fusion_apps/models/subscription_detail.py new file mode 100644 index 0000000000..9d21b9a6ba --- /dev/null +++ b/src/oci/fusion_apps/models/subscription_detail.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 SubscriptionDetail(object): + """ + Detail for the FusionEnvironmentFamily subscription. + """ + + def __init__(self, **kwargs): + """ + Initializes a new SubscriptionDetail object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param subscriptions: + The value to assign to the subscriptions property of this SubscriptionDetail. + :type subscriptions: list[oci.fusion_apps.models.Subscription] + + """ + self.swagger_types = { + 'subscriptions': 'list[Subscription]' + } + + self.attribute_map = { + 'subscriptions': 'subscriptions' + } + + self._subscriptions = None + + @property + def subscriptions(self): + """ + **[Required]** Gets the subscriptions of this SubscriptionDetail. + List of subscriptions. + + + :return: The subscriptions of this SubscriptionDetail. + :rtype: list[oci.fusion_apps.models.Subscription] + """ + return self._subscriptions + + @subscriptions.setter + def subscriptions(self, subscriptions): + """ + Sets the subscriptions of this SubscriptionDetail. + List of subscriptions. + + + :param subscriptions: The subscriptions of this SubscriptionDetail. + :type: list[oci.fusion_apps.models.Subscription] + """ + self._subscriptions = subscriptions + + 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/fusion_apps/models/subscription_sku.py b/src/oci/fusion_apps/models/subscription_sku.py new file mode 100644 index 0000000000..78cc095061 --- /dev/null +++ b/src/oci/fusion_apps/models/subscription_sku.py @@ -0,0 +1,194 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 SubscriptionSku(object): + """ + SKU information. + """ + + def __init__(self, **kwargs): + """ + Initializes a new SubscriptionSku object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param sku: + The value to assign to the sku property of this SubscriptionSku. + :type sku: str + + :param license_part_description: + The value to assign to the license_part_description property of this SubscriptionSku. + :type license_part_description: str + + :param metric_name: + The value to assign to the metric_name property of this SubscriptionSku. + :type metric_name: str + + :param quantity: + The value to assign to the quantity property of this SubscriptionSku. + :type quantity: int + + :param description: + The value to assign to the description property of this SubscriptionSku. + :type description: str + + """ + self.swagger_types = { + 'sku': 'str', + 'license_part_description': 'str', + 'metric_name': 'str', + 'quantity': 'int', + 'description': 'str' + } + + self.attribute_map = { + 'sku': 'sku', + 'license_part_description': 'licensePartDescription', + 'metric_name': 'metricName', + 'quantity': 'quantity', + 'description': 'description' + } + + self._sku = None + self._license_part_description = None + self._metric_name = None + self._quantity = None + self._description = None + + @property + def sku(self): + """ + **[Required]** Gets the sku of this SubscriptionSku. + Stock keeping unit id. + + + :return: The sku of this SubscriptionSku. + :rtype: str + """ + return self._sku + + @sku.setter + def sku(self, sku): + """ + Sets the sku of this SubscriptionSku. + Stock keeping unit id. + + + :param sku: The sku of this SubscriptionSku. + :type: str + """ + self._sku = sku + + @property + def license_part_description(self): + """ + Gets the license_part_description of this SubscriptionSku. + Description of the covered product belonging to this Sku. + + + :return: The license_part_description of this SubscriptionSku. + :rtype: str + """ + return self._license_part_description + + @license_part_description.setter + def license_part_description(self, license_part_description): + """ + Sets the license_part_description of this SubscriptionSku. + Description of the covered product belonging to this Sku. + + + :param license_part_description: The license_part_description of this SubscriptionSku. + :type: str + """ + self._license_part_description = license_part_description + + @property + def metric_name(self): + """ + Gets the metric_name of this SubscriptionSku. + Base metric for billing the service. + + + :return: The metric_name of this SubscriptionSku. + :rtype: str + """ + return self._metric_name + + @metric_name.setter + def metric_name(self, metric_name): + """ + Sets the metric_name of this SubscriptionSku. + Base metric for billing the service. + + + :param metric_name: The metric_name of this SubscriptionSku. + :type: str + """ + self._metric_name = metric_name + + @property + def quantity(self): + """ + **[Required]** Gets the quantity of this SubscriptionSku. + Quantity of the stock units. + + + :return: The quantity of this SubscriptionSku. + :rtype: int + """ + return self._quantity + + @quantity.setter + def quantity(self, quantity): + """ + Sets the quantity of this SubscriptionSku. + Quantity of the stock units. + + + :param quantity: The quantity of this SubscriptionSku. + :type: int + """ + self._quantity = quantity + + @property + def description(self): + """ + Gets the description of this SubscriptionSku. + Description of the stock units. + + + :return: The description of this SubscriptionSku. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this SubscriptionSku. + Description of the stock units. + + + :param description: The description of this SubscriptionSku. + :type: str + """ + self._description = description + + 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/fusion_apps/models/time_available_for_refresh.py b/src/oci/fusion_apps/models/time_available_for_refresh.py new file mode 100644 index 0000000000..416a15bdba --- /dev/null +++ b/src/oci/fusion_apps/models/time_available_for_refresh.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 TimeAvailableForRefresh(object): + """ + one available refresh time. + """ + + def __init__(self, **kwargs): + """ + Initializes a new TimeAvailableForRefresh object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param time_available_for_refresh: + The value to assign to the time_available_for_refresh property of this TimeAvailableForRefresh. + :type time_available_for_refresh: datetime + + """ + self.swagger_types = { + 'time_available_for_refresh': 'datetime' + } + + self.attribute_map = { + 'time_available_for_refresh': 'timeAvailableForRefresh' + } + + self._time_available_for_refresh = None + + @property + def time_available_for_refresh(self): + """ + **[Required]** Gets the time_available_for_refresh of this TimeAvailableForRefresh. + refresh time. + + + :return: The time_available_for_refresh of this TimeAvailableForRefresh. + :rtype: datetime + """ + return self._time_available_for_refresh + + @time_available_for_refresh.setter + def time_available_for_refresh(self, time_available_for_refresh): + """ + Sets the time_available_for_refresh of this TimeAvailableForRefresh. + refresh time. + + + :param time_available_for_refresh: The time_available_for_refresh of this TimeAvailableForRefresh. + :type: datetime + """ + self._time_available_for_refresh = time_available_for_refresh + + 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/fusion_apps/models/time_available_for_refresh_collection.py b/src/oci/fusion_apps/models/time_available_for_refresh_collection.py new file mode 100644 index 0000000000..4fb34c1ca5 --- /dev/null +++ b/src/oci/fusion_apps/models/time_available_for_refresh_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 TimeAvailableForRefreshCollection(object): + """ + The available refresh times for a fusion environment + """ + + def __init__(self, **kwargs): + """ + Initializes a new TimeAvailableForRefreshCollection 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 TimeAvailableForRefreshCollection. + :type items: list[oci.fusion_apps.models.TimeAvailableForRefreshSummary] + + """ + self.swagger_types = { + 'items': 'list[TimeAvailableForRefreshSummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this TimeAvailableForRefreshCollection. + A list of available refresh time objects. + + + :return: The items of this TimeAvailableForRefreshCollection. + :rtype: list[oci.fusion_apps.models.TimeAvailableForRefreshSummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this TimeAvailableForRefreshCollection. + A list of available refresh time objects. + + + :param items: The items of this TimeAvailableForRefreshCollection. + :type: list[oci.fusion_apps.models.TimeAvailableForRefreshSummary] + """ + 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/fusion_apps/models/time_available_for_refresh_summary.py b/src/oci/fusion_apps/models/time_available_for_refresh_summary.py new file mode 100644 index 0000000000..fb5fd25d82 --- /dev/null +++ b/src/oci/fusion_apps/models/time_available_for_refresh_summary.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 TimeAvailableForRefreshSummary(object): + """ + one available refresh time. + """ + + def __init__(self, **kwargs): + """ + Initializes a new TimeAvailableForRefreshSummary object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param time_available_for_refresh: + The value to assign to the time_available_for_refresh property of this TimeAvailableForRefreshSummary. + :type time_available_for_refresh: datetime + + """ + self.swagger_types = { + 'time_available_for_refresh': 'datetime' + } + + self.attribute_map = { + 'time_available_for_refresh': 'timeAvailableForRefresh' + } + + self._time_available_for_refresh = None + + @property + def time_available_for_refresh(self): + """ + **[Required]** Gets the time_available_for_refresh of this TimeAvailableForRefreshSummary. + refresh time. + + + :return: The time_available_for_refresh of this TimeAvailableForRefreshSummary. + :rtype: datetime + """ + return self._time_available_for_refresh + + @time_available_for_refresh.setter + def time_available_for_refresh(self, time_available_for_refresh): + """ + Sets the time_available_for_refresh of this TimeAvailableForRefreshSummary. + refresh time. + + + :param time_available_for_refresh: The time_available_for_refresh of this TimeAvailableForRefreshSummary. + :type: datetime + """ + self._time_available_for_refresh = time_available_for_refresh + + 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/fusion_apps/models/update_family_maintenance_policy_details.py b/src/oci/fusion_apps/models/update_family_maintenance_policy_details.py new file mode 100644 index 0000000000..e1435a84e3 --- /dev/null +++ b/src/oci/fusion_apps/models/update_family_maintenance_policy_details.py @@ -0,0 +1,101 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 UpdateFamilyMaintenancePolicyDetails(object): + """ + The editable settings of the policy that specifies the maintenance and upgrade preferences for an environment. + """ + + def __init__(self, **kwargs): + """ + Initializes a new UpdateFamilyMaintenancePolicyDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param is_monthly_patching_enabled: + The value to assign to the is_monthly_patching_enabled property of this UpdateFamilyMaintenancePolicyDetails. + :type is_monthly_patching_enabled: bool + + :param concurrent_maintenance: + The value to assign to the concurrent_maintenance property of this UpdateFamilyMaintenancePolicyDetails. + :type concurrent_maintenance: str + + """ + self.swagger_types = { + 'is_monthly_patching_enabled': 'bool', + 'concurrent_maintenance': 'str' + } + + self.attribute_map = { + 'is_monthly_patching_enabled': 'isMonthlyPatchingEnabled', + 'concurrent_maintenance': 'concurrentMaintenance' + } + + self._is_monthly_patching_enabled = None + self._concurrent_maintenance = None + + @property + def is_monthly_patching_enabled(self): + """ + Gets the is_monthly_patching_enabled of this UpdateFamilyMaintenancePolicyDetails. + Whether the Fusion environment receives monthly patching. + + + :return: The is_monthly_patching_enabled of this UpdateFamilyMaintenancePolicyDetails. + :rtype: bool + """ + return self._is_monthly_patching_enabled + + @is_monthly_patching_enabled.setter + def is_monthly_patching_enabled(self, is_monthly_patching_enabled): + """ + Sets the is_monthly_patching_enabled of this UpdateFamilyMaintenancePolicyDetails. + Whether the Fusion environment receives monthly patching. + + + :param is_monthly_patching_enabled: The is_monthly_patching_enabled of this UpdateFamilyMaintenancePolicyDetails. + :type: bool + """ + self._is_monthly_patching_enabled = is_monthly_patching_enabled + + @property + def concurrent_maintenance(self): + """ + Gets the concurrent_maintenance of this UpdateFamilyMaintenancePolicyDetails. + Whether production and non-production environments are upgraded concurrently. + + + :return: The concurrent_maintenance of this UpdateFamilyMaintenancePolicyDetails. + :rtype: str + """ + return self._concurrent_maintenance + + @concurrent_maintenance.setter + def concurrent_maintenance(self, concurrent_maintenance): + """ + Sets the concurrent_maintenance of this UpdateFamilyMaintenancePolicyDetails. + Whether production and non-production environments are upgraded concurrently. + + + :param concurrent_maintenance: The concurrent_maintenance of this UpdateFamilyMaintenancePolicyDetails. + :type: str + """ + self._concurrent_maintenance = concurrent_maintenance + + 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/fusion_apps/models/update_fusion_environment_details.py b/src/oci/fusion_apps/models/update_fusion_environment_details.py new file mode 100644 index 0000000000..1fc7458467 --- /dev/null +++ b/src/oci/fusion_apps/models/update_fusion_environment_details.py @@ -0,0 +1,256 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 UpdateFusionEnvironmentDetails(object): + """ + The information to be updated. + """ + + def __init__(self, **kwargs): + """ + Initializes a new UpdateFusionEnvironmentDetails 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 UpdateFusionEnvironmentDetails. + :type display_name: str + + :param kms_key_id: + The value to assign to the kms_key_id property of this UpdateFusionEnvironmentDetails. + :type kms_key_id: str + + :param maintenance_policy: + The value to assign to the maintenance_policy property of this UpdateFusionEnvironmentDetails. + :type maintenance_policy: oci.fusion_apps.models.MaintenancePolicy + + :param additional_language_packs: + The value to assign to the additional_language_packs property of this UpdateFusionEnvironmentDetails. + :type additional_language_packs: list[str] + + :param rules: + The value to assign to the rules property of this UpdateFusionEnvironmentDetails. + :type rules: list[oci.fusion_apps.models.Rule] + + :param freeform_tags: + The value to assign to the freeform_tags property of this UpdateFusionEnvironmentDetails. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this UpdateFusionEnvironmentDetails. + :type defined_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'display_name': 'str', + 'kms_key_id': 'str', + 'maintenance_policy': 'MaintenancePolicy', + 'additional_language_packs': 'list[str]', + 'rules': 'list[Rule]', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))' + } + + self.attribute_map = { + 'display_name': 'displayName', + 'kms_key_id': 'kmsKeyId', + 'maintenance_policy': 'maintenancePolicy', + 'additional_language_packs': 'additionalLanguagePacks', + 'rules': 'rules', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags' + } + + self._display_name = None + self._kms_key_id = None + self._maintenance_policy = None + self._additional_language_packs = None + self._rules = None + self._freeform_tags = None + self._defined_tags = None + + @property + def display_name(self): + """ + Gets the display_name of this UpdateFusionEnvironmentDetails. + FusionEnvironment Identifier, can be renamed + + + :return: The display_name of this UpdateFusionEnvironmentDetails. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this UpdateFusionEnvironmentDetails. + FusionEnvironment Identifier, can be renamed + + + :param display_name: The display_name of this UpdateFusionEnvironmentDetails. + :type: str + """ + self._display_name = display_name + + @property + def kms_key_id(self): + """ + Gets the kms_key_id of this UpdateFusionEnvironmentDetails. + byok kms keyId + + + :return: The kms_key_id of this UpdateFusionEnvironmentDetails. + :rtype: str + """ + return self._kms_key_id + + @kms_key_id.setter + def kms_key_id(self, kms_key_id): + """ + Sets the kms_key_id of this UpdateFusionEnvironmentDetails. + byok kms keyId + + + :param kms_key_id: The kms_key_id of this UpdateFusionEnvironmentDetails. + :type: str + """ + self._kms_key_id = kms_key_id + + @property + def maintenance_policy(self): + """ + Gets the maintenance_policy of this UpdateFusionEnvironmentDetails. + + :return: The maintenance_policy of this UpdateFusionEnvironmentDetails. + :rtype: oci.fusion_apps.models.MaintenancePolicy + """ + return self._maintenance_policy + + @maintenance_policy.setter + def maintenance_policy(self, maintenance_policy): + """ + Sets the maintenance_policy of this UpdateFusionEnvironmentDetails. + + :param maintenance_policy: The maintenance_policy of this UpdateFusionEnvironmentDetails. + :type: oci.fusion_apps.models.MaintenancePolicy + """ + self._maintenance_policy = maintenance_policy + + @property + def additional_language_packs(self): + """ + Gets the additional_language_packs of this UpdateFusionEnvironmentDetails. + Language packs + + + :return: The additional_language_packs of this UpdateFusionEnvironmentDetails. + :rtype: list[str] + """ + return self._additional_language_packs + + @additional_language_packs.setter + def additional_language_packs(self, additional_language_packs): + """ + Sets the additional_language_packs of this UpdateFusionEnvironmentDetails. + Language packs + + + :param additional_language_packs: The additional_language_packs of this UpdateFusionEnvironmentDetails. + :type: list[str] + """ + self._additional_language_packs = additional_language_packs + + @property + def rules(self): + """ + Gets the rules of this UpdateFusionEnvironmentDetails. + Network access control rules to limit internet traffic that can access the environment. For more information, see :func:`allow_rule`. + + + :return: The rules of this UpdateFusionEnvironmentDetails. + :rtype: list[oci.fusion_apps.models.Rule] + """ + return self._rules + + @rules.setter + def rules(self, rules): + """ + Sets the rules of this UpdateFusionEnvironmentDetails. + Network access control rules to limit internet traffic that can access the environment. For more information, see :func:`allow_rule`. + + + :param rules: The rules of this UpdateFusionEnvironmentDetails. + :type: list[oci.fusion_apps.models.Rule] + """ + self._rules = rules + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this UpdateFusionEnvironmentDetails. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :return: The freeform_tags of this UpdateFusionEnvironmentDetails. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this UpdateFusionEnvironmentDetails. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :param freeform_tags: The freeform_tags of this UpdateFusionEnvironmentDetails. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this UpdateFusionEnvironmentDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this UpdateFusionEnvironmentDetails. + :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 UpdateFusionEnvironmentDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this UpdateFusionEnvironmentDetails. + :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/fusion_apps/models/update_fusion_environment_family_details.py b/src/oci/fusion_apps/models/update_fusion_environment_family_details.py new file mode 100644 index 0000000000..88a63ad389 --- /dev/null +++ b/src/oci/fusion_apps/models/update_fusion_environment_family_details.py @@ -0,0 +1,194 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 UpdateFusionEnvironmentFamilyDetails(object): + """ + The details of the Fusion environment family to be updated. + """ + + def __init__(self, **kwargs): + """ + Initializes a new UpdateFusionEnvironmentFamilyDetails 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 UpdateFusionEnvironmentFamilyDetails. + :type display_name: str + + :param family_maintenance_policy: + The value to assign to the family_maintenance_policy property of this UpdateFusionEnvironmentFamilyDetails. + :type family_maintenance_policy: oci.fusion_apps.models.UpdateFamilyMaintenancePolicyDetails + + :param subscription_ids: + The value to assign to the subscription_ids property of this UpdateFusionEnvironmentFamilyDetails. + :type subscription_ids: list[str] + + :param freeform_tags: + The value to assign to the freeform_tags property of this UpdateFusionEnvironmentFamilyDetails. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this UpdateFusionEnvironmentFamilyDetails. + :type defined_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'display_name': 'str', + 'family_maintenance_policy': 'UpdateFamilyMaintenancePolicyDetails', + 'subscription_ids': 'list[str]', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))' + } + + self.attribute_map = { + 'display_name': 'displayName', + 'family_maintenance_policy': 'familyMaintenancePolicy', + 'subscription_ids': 'subscriptionIds', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags' + } + + self._display_name = None + self._family_maintenance_policy = None + self._subscription_ids = None + self._freeform_tags = None + self._defined_tags = None + + @property + def display_name(self): + """ + Gets the display_name of this UpdateFusionEnvironmentFamilyDetails. + A friendly name for the environment family. The name must contain only letters, numbers, dashes, and underscores. Can be changed later. + + + :return: The display_name of this UpdateFusionEnvironmentFamilyDetails. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this UpdateFusionEnvironmentFamilyDetails. + A friendly name for the environment family. The name must contain only letters, numbers, dashes, and underscores. Can be changed later. + + + :param display_name: The display_name of this UpdateFusionEnvironmentFamilyDetails. + :type: str + """ + self._display_name = display_name + + @property + def family_maintenance_policy(self): + """ + Gets the family_maintenance_policy of this UpdateFusionEnvironmentFamilyDetails. + + :return: The family_maintenance_policy of this UpdateFusionEnvironmentFamilyDetails. + :rtype: oci.fusion_apps.models.UpdateFamilyMaintenancePolicyDetails + """ + return self._family_maintenance_policy + + @family_maintenance_policy.setter + def family_maintenance_policy(self, family_maintenance_policy): + """ + Sets the family_maintenance_policy of this UpdateFusionEnvironmentFamilyDetails. + + :param family_maintenance_policy: The family_maintenance_policy of this UpdateFusionEnvironmentFamilyDetails. + :type: oci.fusion_apps.models.UpdateFamilyMaintenancePolicyDetails + """ + self._family_maintenance_policy = family_maintenance_policy + + @property + def subscription_ids(self): + """ + Gets the subscription_ids of this UpdateFusionEnvironmentFamilyDetails. + The list of the IDs of the applications subscriptions that are associated with the environment family. + + + :return: The subscription_ids of this UpdateFusionEnvironmentFamilyDetails. + :rtype: list[str] + """ + return self._subscription_ids + + @subscription_ids.setter + def subscription_ids(self, subscription_ids): + """ + Sets the subscription_ids of this UpdateFusionEnvironmentFamilyDetails. + The list of the IDs of the applications subscriptions that are associated with the environment family. + + + :param subscription_ids: The subscription_ids of this UpdateFusionEnvironmentFamilyDetails. + :type: list[str] + """ + self._subscription_ids = subscription_ids + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this UpdateFusionEnvironmentFamilyDetails. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :return: The freeform_tags of this UpdateFusionEnvironmentFamilyDetails. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this UpdateFusionEnvironmentFamilyDetails. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :param freeform_tags: The freeform_tags of this UpdateFusionEnvironmentFamilyDetails. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this UpdateFusionEnvironmentFamilyDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this UpdateFusionEnvironmentFamilyDetails. + :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 UpdateFusionEnvironmentFamilyDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this UpdateFusionEnvironmentFamilyDetails. + :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/fusion_apps/models/upgrade_action.py b/src/oci/fusion_apps/models/upgrade_action.py new file mode 100644 index 0000000000..ee4746f5ea --- /dev/null +++ b/src/oci/fusion_apps/models/upgrade_action.py @@ -0,0 +1,133 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .action import Action +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 UpgradeAction(Action): + """ + Quarterly upgrade details. + """ + + def __init__(self, **kwargs): + """ + Initializes a new UpgradeAction object with values from keyword arguments. The default value of the :py:attr:`~oci.fusion_apps.models.UpgradeAction.action_type` attribute + of this class is ``QUARTERLY_UPGRADE`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param reference_key: + The value to assign to the reference_key property of this UpgradeAction. + :type reference_key: str + + :param action_type: + The value to assign to the action_type property of this UpgradeAction. + Allowed values for this property are: "QUARTERLY_UPGRADE", "PATCH", "VERTEX" + :type action_type: str + + :param state: + The value to assign to the state property of this UpgradeAction. + Allowed values for this property are: "ACCEPTED", "IN_PROGRESS", "SUCCEEDED", "FAILED", "CANCELED" + :type state: str + + :param description: + The value to assign to the description property of this UpgradeAction. + :type description: str + + :param version: + The value to assign to the version property of this UpgradeAction. + :type version: str + + :param qualifier: + The value to assign to the qualifier property of this UpgradeAction. + :type qualifier: str + + """ + self.swagger_types = { + 'reference_key': 'str', + 'action_type': 'str', + 'state': 'str', + 'description': 'str', + 'version': 'str', + 'qualifier': 'str' + } + + self.attribute_map = { + 'reference_key': 'referenceKey', + 'action_type': 'actionType', + 'state': 'state', + 'description': 'description', + 'version': 'version', + 'qualifier': 'qualifier' + } + + self._reference_key = None + self._action_type = None + self._state = None + self._description = None + self._version = None + self._qualifier = None + self._action_type = 'QUARTERLY_UPGRADE' + + @property + def version(self): + """ + Gets the version of this UpgradeAction. + name of the repo + + + :return: The version of this UpgradeAction. + :rtype: str + """ + return self._version + + @version.setter + def version(self, version): + """ + Sets the version of this UpgradeAction. + name of the repo + + + :param version: The version of this UpgradeAction. + :type: str + """ + self._version = version + + @property + def qualifier(self): + """ + Gets the qualifier of this UpgradeAction. + month qualifier + + + :return: The qualifier of this UpgradeAction. + :rtype: str + """ + return self._qualifier + + @qualifier.setter + def qualifier(self, qualifier): + """ + Sets the qualifier of this UpgradeAction. + month qualifier + + + :param qualifier: The qualifier of this UpgradeAction. + :type: str + """ + self._qualifier = qualifier + + 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/fusion_apps/models/vertex_action.py b/src/oci/fusion_apps/models/vertex_action.py new file mode 100644 index 0000000000..1e3e0c1cf2 --- /dev/null +++ b/src/oci/fusion_apps/models/vertex_action.py @@ -0,0 +1,102 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .action import Action +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 VertexAction(Action): + """ + Vertex update action + """ + + def __init__(self, **kwargs): + """ + Initializes a new VertexAction object with values from keyword arguments. The default value of the :py:attr:`~oci.fusion_apps.models.VertexAction.action_type` attribute + of this class is ``VERTEX`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param reference_key: + The value to assign to the reference_key property of this VertexAction. + :type reference_key: str + + :param action_type: + The value to assign to the action_type property of this VertexAction. + Allowed values for this property are: "QUARTERLY_UPGRADE", "PATCH", "VERTEX" + :type action_type: str + + :param state: + The value to assign to the state property of this VertexAction. + Allowed values for this property are: "ACCEPTED", "IN_PROGRESS", "SUCCEEDED", "FAILED", "CANCELED" + :type state: str + + :param description: + The value to assign to the description property of this VertexAction. + :type description: str + + :param artifact: + The value to assign to the artifact property of this VertexAction. + :type artifact: str + + """ + self.swagger_types = { + 'reference_key': 'str', + 'action_type': 'str', + 'state': 'str', + 'description': 'str', + 'artifact': 'str' + } + + self.attribute_map = { + 'reference_key': 'referenceKey', + 'action_type': 'actionType', + 'state': 'state', + 'description': 'description', + 'artifact': 'artifact' + } + + self._reference_key = None + self._action_type = None + self._state = None + self._description = None + self._artifact = None + self._action_type = 'VERTEX' + + @property + def artifact(self): + """ + Gets the artifact of this VertexAction. + patch that delivered the vertex update prerequisite + + + :return: The artifact of this VertexAction. + :rtype: str + """ + return self._artifact + + @artifact.setter + def artifact(self, artifact): + """ + Sets the artifact of this VertexAction. + patch that delivered the vertex update prerequisite + + + :param artifact: The artifact of this VertexAction. + :type: str + """ + self._artifact = artifact + + 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/fusion_apps/models/work_request.py b/src/oci/fusion_apps/models/work_request.py new file mode 100644 index 0000000000..40bc1a7557 --- /dev/null +++ b/src/oci/fusion_apps/models/work_request.py @@ -0,0 +1,460 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 WorkRequest(object): + """ + A description of workrequest status + """ + + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "CREATE_FUSION_ENVIRONMENT" + OPERATION_TYPE_CREATE_FUSION_ENVIRONMENT = "CREATE_FUSION_ENVIRONMENT" + + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "UPDATE_FUSION_ENVIRONMENT" + OPERATION_TYPE_UPDATE_FUSION_ENVIRONMENT = "UPDATE_FUSION_ENVIRONMENT" + + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "RESET_FUSION_ENVIRONMENT_ADMIN_PASSWORD" + OPERATION_TYPE_RESET_FUSION_ENVIRONMENT_ADMIN_PASSWORD = "RESET_FUSION_ENVIRONMENT_ADMIN_PASSWORD" + + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "SCALE_FUSION_ENVIRONMENT" + OPERATION_TYPE_SCALE_FUSION_ENVIRONMENT = "SCALE_FUSION_ENVIRONMENT" + + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "ARCHIVE_FUSION_ENVIRONMENT" + OPERATION_TYPE_ARCHIVE_FUSION_ENVIRONMENT = "ARCHIVE_FUSION_ENVIRONMENT" + + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "RESTORE_FUSION_ENVIRONMENT" + OPERATION_TYPE_RESTORE_FUSION_ENVIRONMENT = "RESTORE_FUSION_ENVIRONMENT" + + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "CREATE_SERVICE_INSTANCE" + OPERATION_TYPE_CREATE_SERVICE_INSTANCE = "CREATE_SERVICE_INSTANCE" + + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "UPDATE_SERVICE_INSTANCE" + OPERATION_TYPE_UPDATE_SERVICE_INSTANCE = "UPDATE_SERVICE_INSTANCE" + + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "DETACH_SERVICE_INSTANCE" + OPERATION_TYPE_DETACH_SERVICE_INSTANCE = "DETACH_SERVICE_INSTANCE" + + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "ADD_USER" + OPERATION_TYPE_ADD_USER = "ADD_USER" + + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "REMOVE_USER" + OPERATION_TYPE_REMOVE_USER = "REMOVE_USER" + + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "DELETE_FUSION_ENVIRONMENT" + OPERATION_TYPE_DELETE_FUSION_ENVIRONMENT = "DELETE_FUSION_ENVIRONMENT" + + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "CHANGE_FUSION_ENVIRONMENT_COMPARTMENT" + OPERATION_TYPE_CHANGE_FUSION_ENVIRONMENT_COMPARTMENT = "CHANGE_FUSION_ENVIRONMENT_COMPARTMENT" + + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "UPGRADE_FUSION_ENVIRONMENT" + OPERATION_TYPE_UPGRADE_FUSION_ENVIRONMENT = "UPGRADE_FUSION_ENVIRONMENT" + + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "CREATE_FUSION_ENVIRONMENT_FAMILY" + OPERATION_TYPE_CREATE_FUSION_ENVIRONMENT_FAMILY = "CREATE_FUSION_ENVIRONMENT_FAMILY" + + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "DELETE_FUSION_ENVIRONMENT_FAMILY" + OPERATION_TYPE_DELETE_FUSION_ENVIRONMENT_FAMILY = "DELETE_FUSION_ENVIRONMENT_FAMILY" + + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "UPDATE_FUSION_ENVIRONMENT_FAMILY" + OPERATION_TYPE_UPDATE_FUSION_ENVIRONMENT_FAMILY = "UPDATE_FUSION_ENVIRONMENT_FAMILY" + + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "CHANGE_FUSION_ENVIRONMENT_FAMILY_COMPARTMENT" + OPERATION_TYPE_CHANGE_FUSION_ENVIRONMENT_FAMILY_COMPARTMENT = "CHANGE_FUSION_ENVIRONMENT_FAMILY_COMPARTMENT" + + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "REFRESH_FUSION_ENVIRONMENT" + OPERATION_TYPE_REFRESH_FUSION_ENVIRONMENT = "REFRESH_FUSION_ENVIRONMENT" + + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "EXECUTE_COLD_PATCH" + OPERATION_TYPE_EXECUTE_COLD_PATCH = "EXECUTE_COLD_PATCH" + + #: A constant which can be used with the status property of a WorkRequest. + #: This constant has a value of "ACCEPTED" + STATUS_ACCEPTED = "ACCEPTED" + + #: A constant which can be used with the status property of a WorkRequest. + #: This constant has a value of "IN_PROGRESS" + STATUS_IN_PROGRESS = "IN_PROGRESS" + + #: A constant which can be used with the status property of a WorkRequest. + #: This constant has a value of "FAILED" + STATUS_FAILED = "FAILED" + + #: A constant which can be used with the status property of a WorkRequest. + #: This constant has a value of "SUCCEEDED" + STATUS_SUCCEEDED = "SUCCEEDED" + + #: A constant which can be used with the status property of a WorkRequest. + #: This constant has a value of "CANCELING" + STATUS_CANCELING = "CANCELING" + + #: A constant which can be used with the status property of a WorkRequest. + #: This constant has a value of "CANCELED" + STATUS_CANCELED = "CANCELED" + + def __init__(self, **kwargs): + """ + Initializes a new WorkRequest object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param operation_type: + The value to assign to the operation_type property of this WorkRequest. + Allowed values for this property are: "CREATE_FUSION_ENVIRONMENT", "UPDATE_FUSION_ENVIRONMENT", "RESET_FUSION_ENVIRONMENT_ADMIN_PASSWORD", "SCALE_FUSION_ENVIRONMENT", "ARCHIVE_FUSION_ENVIRONMENT", "RESTORE_FUSION_ENVIRONMENT", "CREATE_SERVICE_INSTANCE", "UPDATE_SERVICE_INSTANCE", "DETACH_SERVICE_INSTANCE", "ADD_USER", "REMOVE_USER", "DELETE_FUSION_ENVIRONMENT", "CHANGE_FUSION_ENVIRONMENT_COMPARTMENT", "UPGRADE_FUSION_ENVIRONMENT", "CREATE_FUSION_ENVIRONMENT_FAMILY", "DELETE_FUSION_ENVIRONMENT_FAMILY", "UPDATE_FUSION_ENVIRONMENT_FAMILY", "CHANGE_FUSION_ENVIRONMENT_FAMILY_COMPARTMENT", "REFRESH_FUSION_ENVIRONMENT", "EXECUTE_COLD_PATCH", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type operation_type: str + + :param status: + The value to assign to the status property of this WorkRequest. + Allowed values for this property are: "ACCEPTED", "IN_PROGRESS", "FAILED", "SUCCEEDED", "CANCELING", "CANCELED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type status: str + + :param id: + The value to assign to the id property of this WorkRequest. + :type id: str + + :param compartment_id: + The value to assign to the compartment_id property of this WorkRequest. + :type compartment_id: str + + :param resources: + The value to assign to the resources property of this WorkRequest. + :type resources: list[oci.fusion_apps.models.WorkRequestResource] + + :param percent_complete: + The value to assign to the percent_complete property of this WorkRequest. + :type percent_complete: float + + :param time_accepted: + The value to assign to the time_accepted property of this WorkRequest. + :type time_accepted: datetime + + :param time_started: + The value to assign to the time_started property of this WorkRequest. + :type time_started: datetime + + :param time_finished: + The value to assign to the time_finished property of this WorkRequest. + :type time_finished: datetime + + """ + self.swagger_types = { + 'operation_type': 'str', + 'status': 'str', + 'id': 'str', + 'compartment_id': 'str', + 'resources': 'list[WorkRequestResource]', + 'percent_complete': 'float', + 'time_accepted': 'datetime', + 'time_started': 'datetime', + 'time_finished': 'datetime' + } + + self.attribute_map = { + 'operation_type': 'operationType', + 'status': 'status', + 'id': 'id', + 'compartment_id': 'compartmentId', + 'resources': 'resources', + 'percent_complete': 'percentComplete', + 'time_accepted': 'timeAccepted', + 'time_started': 'timeStarted', + 'time_finished': 'timeFinished' + } + + self._operation_type = None + self._status = None + self._id = None + self._compartment_id = None + self._resources = None + self._percent_complete = None + self._time_accepted = None + self._time_started = None + self._time_finished = None + + @property + def operation_type(self): + """ + **[Required]** Gets the operation_type of this WorkRequest. + Possible operation types. + + Allowed values for this property are: "CREATE_FUSION_ENVIRONMENT", "UPDATE_FUSION_ENVIRONMENT", "RESET_FUSION_ENVIRONMENT_ADMIN_PASSWORD", "SCALE_FUSION_ENVIRONMENT", "ARCHIVE_FUSION_ENVIRONMENT", "RESTORE_FUSION_ENVIRONMENT", "CREATE_SERVICE_INSTANCE", "UPDATE_SERVICE_INSTANCE", "DETACH_SERVICE_INSTANCE", "ADD_USER", "REMOVE_USER", "DELETE_FUSION_ENVIRONMENT", "CHANGE_FUSION_ENVIRONMENT_COMPARTMENT", "UPGRADE_FUSION_ENVIRONMENT", "CREATE_FUSION_ENVIRONMENT_FAMILY", "DELETE_FUSION_ENVIRONMENT_FAMILY", "UPDATE_FUSION_ENVIRONMENT_FAMILY", "CHANGE_FUSION_ENVIRONMENT_FAMILY_COMPARTMENT", "REFRESH_FUSION_ENVIRONMENT", "EXECUTE_COLD_PATCH", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The operation_type of this WorkRequest. + :rtype: str + """ + return self._operation_type + + @operation_type.setter + def operation_type(self, operation_type): + """ + Sets the operation_type of this WorkRequest. + Possible operation types. + + + :param operation_type: The operation_type of this WorkRequest. + :type: str + """ + allowed_values = ["CREATE_FUSION_ENVIRONMENT", "UPDATE_FUSION_ENVIRONMENT", "RESET_FUSION_ENVIRONMENT_ADMIN_PASSWORD", "SCALE_FUSION_ENVIRONMENT", "ARCHIVE_FUSION_ENVIRONMENT", "RESTORE_FUSION_ENVIRONMENT", "CREATE_SERVICE_INSTANCE", "UPDATE_SERVICE_INSTANCE", "DETACH_SERVICE_INSTANCE", "ADD_USER", "REMOVE_USER", "DELETE_FUSION_ENVIRONMENT", "CHANGE_FUSION_ENVIRONMENT_COMPARTMENT", "UPGRADE_FUSION_ENVIRONMENT", "CREATE_FUSION_ENVIRONMENT_FAMILY", "DELETE_FUSION_ENVIRONMENT_FAMILY", "UPDATE_FUSION_ENVIRONMENT_FAMILY", "CHANGE_FUSION_ENVIRONMENT_FAMILY_COMPARTMENT", "REFRESH_FUSION_ENVIRONMENT", "EXECUTE_COLD_PATCH"] + if not value_allowed_none_or_none_sentinel(operation_type, allowed_values): + operation_type = 'UNKNOWN_ENUM_VALUE' + self._operation_type = operation_type + + @property + def status(self): + """ + **[Required]** Gets the status of this WorkRequest. + Possible operation status. + + Allowed values for this property are: "ACCEPTED", "IN_PROGRESS", "FAILED", "SUCCEEDED", "CANCELING", "CANCELED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The status of this WorkRequest. + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """ + Sets the status of this WorkRequest. + Possible operation status. + + + :param status: The status of this WorkRequest. + :type: str + """ + allowed_values = ["ACCEPTED", "IN_PROGRESS", "FAILED", "SUCCEEDED", "CANCELING", "CANCELED"] + if not value_allowed_none_or_none_sentinel(status, allowed_values): + status = 'UNKNOWN_ENUM_VALUE' + self._status = status + + @property + def id(self): + """ + **[Required]** Gets the id of this WorkRequest. + The id of the work request. + + + :return: The id of this WorkRequest. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this WorkRequest. + The id of the work request. + + + :param id: The id of this WorkRequest. + :type: str + """ + self._id = id + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this WorkRequest. + The ocid of the compartment that contains the work request. Work requests should be scoped to + the same compartment as the resource the work request affects. If the work request affects multiple resources, + and those resources are not in the same compartment, it is up to the service team to pick the primary + resource whose compartment should be used + + + :return: The compartment_id of this WorkRequest. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this WorkRequest. + The ocid of the compartment that contains the work request. Work requests should be scoped to + the same compartment as the resource the work request affects. If the work request affects multiple resources, + and those resources are not in the same compartment, it is up to the service team to pick the primary + resource whose compartment should be used + + + :param compartment_id: The compartment_id of this WorkRequest. + :type: str + """ + self._compartment_id = compartment_id + + @property + def resources(self): + """ + **[Required]** Gets the resources of this WorkRequest. + The resources affected by this work request. + + + :return: The resources of this WorkRequest. + :rtype: list[oci.fusion_apps.models.WorkRequestResource] + """ + return self._resources + + @resources.setter + def resources(self, resources): + """ + Sets the resources of this WorkRequest. + The resources affected by this work request. + + + :param resources: The resources of this WorkRequest. + :type: list[oci.fusion_apps.models.WorkRequestResource] + """ + self._resources = resources + + @property + def percent_complete(self): + """ + **[Required]** Gets the percent_complete of this WorkRequest. + Percentage of the request completed. + + + :return: The percent_complete of this WorkRequest. + :rtype: float + """ + return self._percent_complete + + @percent_complete.setter + def percent_complete(self, percent_complete): + """ + Sets the percent_complete of this WorkRequest. + Percentage of the request completed. + + + :param percent_complete: The percent_complete of this WorkRequest. + :type: float + """ + self._percent_complete = percent_complete + + @property + def time_accepted(self): + """ + **[Required]** Gets the time_accepted of this WorkRequest. + The date and time the request was created, as described in + `RFC 3339`__, section 14.29. + + __ https://tools.ietf.org/rfc/rfc3339 + + + :return: The time_accepted of this WorkRequest. + :rtype: datetime + """ + return self._time_accepted + + @time_accepted.setter + def time_accepted(self, time_accepted): + """ + Sets the time_accepted of this WorkRequest. + The date and time the request was created, as described in + `RFC 3339`__, section 14.29. + + __ https://tools.ietf.org/rfc/rfc3339 + + + :param time_accepted: The time_accepted of this WorkRequest. + :type: datetime + """ + self._time_accepted = time_accepted + + @property + def time_started(self): + """ + Gets the time_started of this WorkRequest. + The date and time the request was started, as described in `RFC 3339`__, + section 14.29. + + __ https://tools.ietf.org/rfc/rfc3339 + + + :return: The time_started of this WorkRequest. + :rtype: datetime + """ + return self._time_started + + @time_started.setter + def time_started(self, time_started): + """ + Sets the time_started of this WorkRequest. + The date and time the request was started, as described in `RFC 3339`__, + section 14.29. + + __ https://tools.ietf.org/rfc/rfc3339 + + + :param time_started: The time_started of this WorkRequest. + :type: datetime + """ + self._time_started = time_started + + @property + def time_finished(self): + """ + Gets the time_finished of this WorkRequest. + The date and time the object was finished, as described in `RFC 3339`__. + + __ https://tools.ietf.org/rfc/rfc3339 + + + :return: The time_finished of this WorkRequest. + :rtype: datetime + """ + return self._time_finished + + @time_finished.setter + def time_finished(self, time_finished): + """ + Sets the time_finished of this WorkRequest. + The date and time the object was finished, as described in `RFC 3339`__. + + __ https://tools.ietf.org/rfc/rfc3339 + + + :param time_finished: The time_finished of this WorkRequest. + :type: datetime + """ + self._time_finished = time_finished + + 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/fusion_apps/models/work_request_error.py b/src/oci/fusion_apps/models/work_request_error.py new file mode 100644 index 0000000000..26ac6a8cc9 --- /dev/null +++ b/src/oci/fusion_apps/models/work_request_error.py @@ -0,0 +1,134 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 WorkRequestError(object): + """ + An error encountered while executing a work request. + """ + + def __init__(self, **kwargs): + """ + Initializes a new WorkRequestError object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param code: + The value to assign to the code property of this WorkRequestError. + :type code: str + + :param message: + The value to assign to the message property of this WorkRequestError. + :type message: str + + :param timestamp: + The value to assign to the timestamp property of this WorkRequestError. + :type timestamp: datetime + + """ + self.swagger_types = { + 'code': 'str', + 'message': 'str', + 'timestamp': 'datetime' + } + + self.attribute_map = { + 'code': 'code', + 'message': 'message', + 'timestamp': 'timestamp' + } + + self._code = None + self._message = None + self._timestamp = None + + @property + def code(self): + """ + **[Required]** Gets the code of this WorkRequestError. + A machine-usable code for the error that occured. Error codes are listed on + (https://docs.cloud.oracle.com/Content/API/References/apierrors.htm) + + + :return: The code of this WorkRequestError. + :rtype: str + """ + return self._code + + @code.setter + def code(self, code): + """ + Sets the code of this WorkRequestError. + A machine-usable code for the error that occured. Error codes are listed on + (https://docs.cloud.oracle.com/Content/API/References/apierrors.htm) + + + :param code: The code of this WorkRequestError. + :type: str + """ + self._code = code + + @property + def message(self): + """ + **[Required]** Gets the message of this WorkRequestError. + A human readable description of the issue encountered. + + + :return: The message of this WorkRequestError. + :rtype: str + """ + return self._message + + @message.setter + def message(self, message): + """ + Sets the message of this WorkRequestError. + A human readable description of the issue encountered. + + + :param message: The message of this WorkRequestError. + :type: str + """ + self._message = message + + @property + def timestamp(self): + """ + **[Required]** Gets the timestamp of this WorkRequestError. + The time the error occured. An RFC3339 formatted datetime string. + + + :return: The timestamp of this WorkRequestError. + :rtype: datetime + """ + return self._timestamp + + @timestamp.setter + def timestamp(self, timestamp): + """ + Sets the timestamp of this WorkRequestError. + The time the error occured. An RFC3339 formatted datetime string. + + + :param timestamp: The timestamp of this WorkRequestError. + :type: datetime + """ + self._timestamp = timestamp + + 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/fusion_apps/models/work_request_error_collection.py b/src/oci/fusion_apps/models/work_request_error_collection.py new file mode 100644 index 0000000000..18c40f9b99 --- /dev/null +++ b/src/oci/fusion_apps/models/work_request_error_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 WorkRequestErrorCollection(object): + """ + Results of a workRequestError search. Contains both WorkRequestError items and other information, such as metadata. + """ + + def __init__(self, **kwargs): + """ + Initializes a new WorkRequestErrorCollection 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 WorkRequestErrorCollection. + :type items: list[oci.fusion_apps.models.WorkRequestError] + + """ + self.swagger_types = { + 'items': 'list[WorkRequestError]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this WorkRequestErrorCollection. + List of workRequestError objects. + + + :return: The items of this WorkRequestErrorCollection. + :rtype: list[oci.fusion_apps.models.WorkRequestError] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this WorkRequestErrorCollection. + List of workRequestError objects. + + + :param items: The items of this WorkRequestErrorCollection. + :type: list[oci.fusion_apps.models.WorkRequestError] + """ + 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/fusion_apps/models/work_request_log_entry.py b/src/oci/fusion_apps/models/work_request_log_entry.py new file mode 100644 index 0000000000..7b37ab8d12 --- /dev/null +++ b/src/oci/fusion_apps/models/work_request_log_entry.py @@ -0,0 +1,101 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 WorkRequestLogEntry(object): + """ + A log message from the execution of a work request. + """ + + def __init__(self, **kwargs): + """ + Initializes a new WorkRequestLogEntry object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param message: + The value to assign to the message property of this WorkRequestLogEntry. + :type message: str + + :param timestamp: + The value to assign to the timestamp property of this WorkRequestLogEntry. + :type timestamp: datetime + + """ + self.swagger_types = { + 'message': 'str', + 'timestamp': 'datetime' + } + + self.attribute_map = { + 'message': 'message', + 'timestamp': 'timestamp' + } + + self._message = None + self._timestamp = None + + @property + def message(self): + """ + **[Required]** Gets the message of this WorkRequestLogEntry. + Human-readable log message. + + + :return: The message of this WorkRequestLogEntry. + :rtype: str + """ + return self._message + + @message.setter + def message(self, message): + """ + Sets the message of this WorkRequestLogEntry. + Human-readable log message. + + + :param message: The message of this WorkRequestLogEntry. + :type: str + """ + self._message = message + + @property + def timestamp(self): + """ + **[Required]** Gets the timestamp of this WorkRequestLogEntry. + The time the log message was written. An RFC3339 formatted datetime string + + + :return: The timestamp of this WorkRequestLogEntry. + :rtype: datetime + """ + return self._timestamp + + @timestamp.setter + def timestamp(self, timestamp): + """ + Sets the timestamp of this WorkRequestLogEntry. + The time the log message was written. An RFC3339 formatted datetime string + + + :param timestamp: The timestamp of this WorkRequestLogEntry. + :type: datetime + """ + self._timestamp = timestamp + + 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/fusion_apps/models/work_request_log_entry_collection.py b/src/oci/fusion_apps/models/work_request_log_entry_collection.py new file mode 100644 index 0000000000..ac568cd94f --- /dev/null +++ b/src/oci/fusion_apps/models/work_request_log_entry_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 WorkRequestLogEntryCollection(object): + """ + Results of a workRequestLog search. Contains both workRequestLog items and other information, such as metadata. + """ + + def __init__(self, **kwargs): + """ + Initializes a new WorkRequestLogEntryCollection 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 WorkRequestLogEntryCollection. + :type items: list[oci.fusion_apps.models.WorkRequestLogEntry] + + """ + self.swagger_types = { + 'items': 'list[WorkRequestLogEntry]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this WorkRequestLogEntryCollection. + List of workRequestLogEntries. + + + :return: The items of this WorkRequestLogEntryCollection. + :rtype: list[oci.fusion_apps.models.WorkRequestLogEntry] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this WorkRequestLogEntryCollection. + List of workRequestLogEntries. + + + :param items: The items of this WorkRequestLogEntryCollection. + :type: list[oci.fusion_apps.models.WorkRequestLogEntry] + """ + 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/fusion_apps/models/work_request_resource.py b/src/oci/fusion_apps/models/work_request_resource.py new file mode 100644 index 0000000000..5f8d9f0192 --- /dev/null +++ b/src/oci/fusion_apps/models/work_request_resource.py @@ -0,0 +1,201 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 WorkRequestResource(object): + """ + A resource created or operated on by a work request. + """ + + #: A constant which can be used with the action_type property of a WorkRequestResource. + #: This constant has a value of "CREATED" + ACTION_TYPE_CREATED = "CREATED" + + #: A constant which can be used with the action_type property of a WorkRequestResource. + #: This constant has a value of "UPDATED" + ACTION_TYPE_UPDATED = "UPDATED" + + #: A constant which can be used with the action_type property of a WorkRequestResource. + #: This constant has a value of "DELETED" + ACTION_TYPE_DELETED = "DELETED" + + #: A constant which can be used with the action_type property of a WorkRequestResource. + #: This constant has a value of "IN_PROGRESS" + ACTION_TYPE_IN_PROGRESS = "IN_PROGRESS" + + #: A constant which can be used with the action_type property of a WorkRequestResource. + #: This constant has a value of "RELATED" + ACTION_TYPE_RELATED = "RELATED" + + #: A constant which can be used with the action_type property of a WorkRequestResource. + #: This constant has a value of "FAILED" + ACTION_TYPE_FAILED = "FAILED" + + def __init__(self, **kwargs): + """ + Initializes a new WorkRequestResource object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param entity_type: + The value to assign to the entity_type property of this WorkRequestResource. + :type entity_type: str + + :param action_type: + The value to assign to the action_type property of this WorkRequestResource. + Allowed values for this property are: "CREATED", "UPDATED", "DELETED", "IN_PROGRESS", "RELATED", "FAILED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type action_type: str + + :param identifier: + The value to assign to the identifier property of this WorkRequestResource. + :type identifier: str + + :param entity_uri: + The value to assign to the entity_uri property of this WorkRequestResource. + :type entity_uri: str + + """ + self.swagger_types = { + 'entity_type': 'str', + 'action_type': 'str', + 'identifier': 'str', + 'entity_uri': 'str' + } + + self.attribute_map = { + 'entity_type': 'entityType', + 'action_type': 'actionType', + 'identifier': 'identifier', + 'entity_uri': 'entityUri' + } + + self._entity_type = None + self._action_type = None + self._identifier = None + self._entity_uri = None + + @property + def entity_type(self): + """ + **[Required]** Gets the entity_type of this WorkRequestResource. + The resource type the work request affects. + + + :return: The entity_type of this WorkRequestResource. + :rtype: str + """ + return self._entity_type + + @entity_type.setter + def entity_type(self, entity_type): + """ + Sets the entity_type of this WorkRequestResource. + The resource type the work request affects. + + + :param entity_type: The entity_type of this WorkRequestResource. + :type: str + """ + self._entity_type = entity_type + + @property + def action_type(self): + """ + **[Required]** Gets the action_type of this WorkRequestResource. + The way in which this resource is affected by the work tracked in the work request. + A resource being created, updated, or deleted will remain in the IN_PROGRESS state until + work is complete for that resource at which point it will transition to CREATED, UPDATED, + or DELETED, respectively. + + Allowed values for this property are: "CREATED", "UPDATED", "DELETED", "IN_PROGRESS", "RELATED", "FAILED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The action_type of this WorkRequestResource. + :rtype: str + """ + return self._action_type + + @action_type.setter + def action_type(self, action_type): + """ + Sets the action_type of this WorkRequestResource. + The way in which this resource is affected by the work tracked in the work request. + A resource being created, updated, or deleted will remain in the IN_PROGRESS state until + work is complete for that resource at which point it will transition to CREATED, UPDATED, + or DELETED, respectively. + + + :param action_type: The action_type of this WorkRequestResource. + :type: str + """ + allowed_values = ["CREATED", "UPDATED", "DELETED", "IN_PROGRESS", "RELATED", "FAILED"] + if not value_allowed_none_or_none_sentinel(action_type, allowed_values): + action_type = 'UNKNOWN_ENUM_VALUE' + self._action_type = action_type + + @property + def identifier(self): + """ + **[Required]** Gets the identifier of this WorkRequestResource. + The identifier of the resource the work request affects. + + + :return: The identifier of this WorkRequestResource. + :rtype: str + """ + return self._identifier + + @identifier.setter + def identifier(self, identifier): + """ + Sets the identifier of this WorkRequestResource. + The identifier of the resource the work request affects. + + + :param identifier: The identifier of this WorkRequestResource. + :type: str + """ + self._identifier = identifier + + @property + def entity_uri(self): + """ + Gets the entity_uri of this WorkRequestResource. + The URI path that the user can do a GET on to access the resource metadata + + + :return: The entity_uri of this WorkRequestResource. + :rtype: str + """ + return self._entity_uri + + @entity_uri.setter + def entity_uri(self, entity_uri): + """ + Sets the entity_uri of this WorkRequestResource. + The URI path that the user can do a GET on to access the resource metadata + + + :param entity_uri: The entity_uri of this WorkRequestResource. + :type: str + """ + self._entity_uri = entity_uri + + 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/fusion_apps/models/work_request_summary.py b/src/oci/fusion_apps/models/work_request_summary.py new file mode 100644 index 0000000000..2ff12704f7 --- /dev/null +++ b/src/oci/fusion_apps/models/work_request_summary.py @@ -0,0 +1,340 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 WorkRequestSummary(object): + """ + A summary of the status of a work request. + """ + + def __init__(self, **kwargs): + """ + Initializes a new WorkRequestSummary object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param operation_type: + The value to assign to the operation_type property of this WorkRequestSummary. + :type operation_type: str + + :param status: + The value to assign to the status property of this WorkRequestSummary. + :type status: str + + :param id: + The value to assign to the id property of this WorkRequestSummary. + :type id: str + + :param compartment_id: + The value to assign to the compartment_id property of this WorkRequestSummary. + :type compartment_id: str + + :param resources: + The value to assign to the resources property of this WorkRequestSummary. + :type resources: list[oci.fusion_apps.models.WorkRequestResource] + + :param percent_complete: + The value to assign to the percent_complete property of this WorkRequestSummary. + :type percent_complete: float + + :param time_accepted: + The value to assign to the time_accepted property of this WorkRequestSummary. + :type time_accepted: datetime + + :param time_started: + The value to assign to the time_started property of this WorkRequestSummary. + :type time_started: datetime + + :param time_finished: + The value to assign to the time_finished property of this WorkRequestSummary. + :type time_finished: datetime + + """ + self.swagger_types = { + 'operation_type': 'str', + 'status': 'str', + 'id': 'str', + 'compartment_id': 'str', + 'resources': 'list[WorkRequestResource]', + 'percent_complete': 'float', + 'time_accepted': 'datetime', + 'time_started': 'datetime', + 'time_finished': 'datetime' + } + + self.attribute_map = { + 'operation_type': 'operationType', + 'status': 'status', + 'id': 'id', + 'compartment_id': 'compartmentId', + 'resources': 'resources', + 'percent_complete': 'percentComplete', + 'time_accepted': 'timeAccepted', + 'time_started': 'timeStarted', + 'time_finished': 'timeFinished' + } + + self._operation_type = None + self._status = None + self._id = None + self._compartment_id = None + self._resources = None + self._percent_complete = None + self._time_accepted = None + self._time_started = None + self._time_finished = None + + @property + def operation_type(self): + """ + **[Required]** Gets the operation_type of this WorkRequestSummary. + Possible operation types. + + + :return: The operation_type of this WorkRequestSummary. + :rtype: str + """ + return self._operation_type + + @operation_type.setter + def operation_type(self, operation_type): + """ + Sets the operation_type of this WorkRequestSummary. + Possible operation types. + + + :param operation_type: The operation_type of this WorkRequestSummary. + :type: str + """ + self._operation_type = operation_type + + @property + def status(self): + """ + **[Required]** Gets the status of this WorkRequestSummary. + Possible operation status. + + + :return: The status of this WorkRequestSummary. + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """ + Sets the status of this WorkRequestSummary. + Possible operation status. + + + :param status: The status of this WorkRequestSummary. + :type: str + """ + self._status = status + + @property + def id(self): + """ + **[Required]** Gets the id of this WorkRequestSummary. + The id of the work request. + + + :return: The id of this WorkRequestSummary. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this WorkRequestSummary. + The id of the work request. + + + :param id: The id of this WorkRequestSummary. + :type: str + """ + self._id = id + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this WorkRequestSummary. + The ocid of the compartment that contains the work request. Work requests should be scoped to + the same compartment as the resource the work request affects. If the work request affects multiple resources, + and those resources are not in the same compartment, it is up to the service team to pick the primary + resource whose compartment should be used + + + :return: The compartment_id of this WorkRequestSummary. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this WorkRequestSummary. + The ocid of the compartment that contains the work request. Work requests should be scoped to + the same compartment as the resource the work request affects. If the work request affects multiple resources, + and those resources are not in the same compartment, it is up to the service team to pick the primary + resource whose compartment should be used + + + :param compartment_id: The compartment_id of this WorkRequestSummary. + :type: str + """ + self._compartment_id = compartment_id + + @property + def resources(self): + """ + **[Required]** Gets the resources of this WorkRequestSummary. + The resources affected by this work request. + + + :return: The resources of this WorkRequestSummary. + :rtype: list[oci.fusion_apps.models.WorkRequestResource] + """ + return self._resources + + @resources.setter + def resources(self, resources): + """ + Sets the resources of this WorkRequestSummary. + The resources affected by this work request. + + + :param resources: The resources of this WorkRequestSummary. + :type: list[oci.fusion_apps.models.WorkRequestResource] + """ + self._resources = resources + + @property + def percent_complete(self): + """ + **[Required]** Gets the percent_complete of this WorkRequestSummary. + Percentage of the request completed. + + + :return: The percent_complete of this WorkRequestSummary. + :rtype: float + """ + return self._percent_complete + + @percent_complete.setter + def percent_complete(self, percent_complete): + """ + Sets the percent_complete of this WorkRequestSummary. + Percentage of the request completed. + + + :param percent_complete: The percent_complete of this WorkRequestSummary. + :type: float + """ + self._percent_complete = percent_complete + + @property + def time_accepted(self): + """ + **[Required]** Gets the time_accepted of this WorkRequestSummary. + The date and time the request was created, as described in + `RFC 3339`__, section 14.29. + + __ https://tools.ietf.org/rfc/rfc3339 + + + :return: The time_accepted of this WorkRequestSummary. + :rtype: datetime + """ + return self._time_accepted + + @time_accepted.setter + def time_accepted(self, time_accepted): + """ + Sets the time_accepted of this WorkRequestSummary. + The date and time the request was created, as described in + `RFC 3339`__, section 14.29. + + __ https://tools.ietf.org/rfc/rfc3339 + + + :param time_accepted: The time_accepted of this WorkRequestSummary. + :type: datetime + """ + self._time_accepted = time_accepted + + @property + def time_started(self): + """ + Gets the time_started of this WorkRequestSummary. + The date and time the request was started, as described in `RFC 3339`__, + section 14.29. + + __ https://tools.ietf.org/rfc/rfc3339 + + + :return: The time_started of this WorkRequestSummary. + :rtype: datetime + """ + return self._time_started + + @time_started.setter + def time_started(self, time_started): + """ + Sets the time_started of this WorkRequestSummary. + The date and time the request was started, as described in `RFC 3339`__, + section 14.29. + + __ https://tools.ietf.org/rfc/rfc3339 + + + :param time_started: The time_started of this WorkRequestSummary. + :type: datetime + """ + self._time_started = time_started + + @property + def time_finished(self): + """ + Gets the time_finished of this WorkRequestSummary. + The date and time the object was finished, as described in `RFC 3339`__. + + __ https://tools.ietf.org/rfc/rfc3339 + + + :return: The time_finished of this WorkRequestSummary. + :rtype: datetime + """ + return self._time_finished + + @time_finished.setter + def time_finished(self, time_finished): + """ + Sets the time_finished of this WorkRequestSummary. + The date and time the object was finished, as described in `RFC 3339`__. + + __ https://tools.ietf.org/rfc/rfc3339 + + + :param time_finished: The time_finished of this WorkRequestSummary. + :type: datetime + """ + self._time_finished = time_finished + + 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/fusion_apps/models/work_request_summary_collection.py b/src/oci/fusion_apps/models/work_request_summary_collection.py new file mode 100644 index 0000000000..72265b2840 --- /dev/null +++ b/src/oci/fusion_apps/models/work_request_summary_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 WorkRequestSummaryCollection(object): + """ + Results of a workRequest search. Contains both WorkRequest items and other information, such as metadata. + """ + + def __init__(self, **kwargs): + """ + Initializes a new WorkRequestSummaryCollection 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 WorkRequestSummaryCollection. + :type items: list[oci.fusion_apps.models.WorkRequestSummary] + + """ + self.swagger_types = { + 'items': 'list[WorkRequestSummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this WorkRequestSummaryCollection. + List of workRequestSummary objects. + + + :return: The items of this WorkRequestSummaryCollection. + :rtype: list[oci.fusion_apps.models.WorkRequestSummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this WorkRequestSummaryCollection. + List of workRequestSummary objects. + + + :param items: The items of this WorkRequestSummaryCollection. + :type: list[oci.fusion_apps.models.WorkRequestSummary] + """ + 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/fusion_apps/refresh_activity_client.py b/src/oci/fusion_apps/refresh_activity_client.py new file mode 100644 index 0000000000..30ec39b998 --- /dev/null +++ b/src/oci/fusion_apps/refresh_activity_client.py @@ -0,0 +1,607 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from __future__ import absolute_import + +from oci._vendor import requests # noqa: F401 +from oci._vendor import six + +from oci import retry, circuit_breaker # noqa: F401 +from oci.base_client import BaseClient +from oci.config import get_config_value_or_default, validate_config +from oci.signer import Signer +from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from .models import fusion_apps_type_mapping +missing = Sentinel("Missing") + + +class RefreshActivityClient(object): + """ + Use the Fusion Applications Environment Management API to manage the environments where your Fusion Applications run. For more information, see the [Fusion Applications Environment Management documentation](/iaas/Content/Identity/fusion-applications/home.htm). + """ + + def __init__(self, config, **kwargs): + """ + Creates a new service client + + :param dict config: + Configuration keys and values as per `SDK and Tool Configuration `__. + The :py:meth:`~oci.config.from_file` method can be used to load configuration from a file. Alternatively, a ``dict`` can be passed. You can validate_config + the dict using :py:meth:`~oci.config.validate_config` + + :param str service_endpoint: (optional) + The endpoint of the service to call using this client. For example ``https://iaas.us-ashburn-1.oraclecloud.com``. If this keyword argument is + not provided then it will be derived using the region in the config parameter. You should only provide this keyword argument if you have an explicit + need to specify a service endpoint. + + :param timeout: (optional) + The connection and read timeouts for the client. The default values are connection timeout 10 seconds and read timeout 60 seconds. This keyword argument can be provided + as a single float, in which case the value provided is used for both the read and connection timeouts, or as a tuple of two floats. If + a tuple is provided then the first value is used as the connection timeout and the second value as the read timeout. + :type timeout: float or tuple(float, float) + + :param signer: (optional) + The signer to use when signing requests made by the service client. The default is to use a :py:class:`~oci.signer.Signer` based on the values + provided in the config parameter. + + One use case for this parameter is for `Instance Principals authentication `__ + by passing an instance of :py:class:`~oci.auth.signers.InstancePrincipalsSecurityTokenSigner` as the value for this keyword argument + :type signer: :py:class:`~oci.signer.AbstractBaseSigner` + + :param obj retry_strategy: (optional) + A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. + Retry strategies can also be applied at the operation level by passing a ``retry_strategy`` keyword argument as part of calling the operation. + Any value provided at the operation level will override whatever is specified at the client level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` + is also available. The specifics of the default retry strategy are described `here `__. + + :param obj circuit_breaker_strategy: (optional) + A circuit breaker strategy to apply to all calls made by this service client (i.e. at the client level). + This client uses :py:data:`~oci.circuit_breaker.DEFAULT_CIRCUIT_BREAKER_STRATEGY` as default if no circuit breaker strategy is provided. + The specifics of circuit breaker strategy are described `here `__. + + :param function circuit_breaker_callback: (optional) + Callback function to receive any exceptions triggerred by the circuit breaker. + + :param allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not + allow control characters to be in the response object. + """ + validate_config(config, signer=kwargs.get('signer')) + if 'signer' in kwargs: + signer = kwargs['signer'] + + elif AUTHENTICATION_TYPE_FIELD_NAME in config: + signer = get_signer_from_authentication_type(config) + + else: + signer = Signer( + tenancy=config["tenancy"], + user=config["user"], + fingerprint=config["fingerprint"], + private_key_file_location=config.get("key_file"), + pass_phrase=get_config_value_or_default(config, "pass_phrase"), + private_key_content=config.get("key_content") + ) + + base_client_init_kwargs = { + 'regional_client': True, + 'service_endpoint': kwargs.get('service_endpoint'), + 'base_path': '/20211201', + 'service_endpoint_template': 'https://fusionapps.{region}.oci.{secondLevelDomain}', + 'skip_deserialization': kwargs.get('skip_deserialization', False), + 'circuit_breaker_strategy': kwargs.get('circuit_breaker_strategy', circuit_breaker.GLOBAL_CIRCUIT_BREAKER_STRATEGY) + } + if 'timeout' in kwargs: + base_client_init_kwargs['timeout'] = kwargs.get('timeout') + if base_client_init_kwargs.get('circuit_breaker_strategy') is None: + base_client_init_kwargs['circuit_breaker_strategy'] = circuit_breaker.DEFAULT_CIRCUIT_BREAKER_STRATEGY + if 'allow_control_chars' in kwargs: + base_client_init_kwargs['allow_control_chars'] = kwargs.get('allow_control_chars') + self.base_client = BaseClient("refresh_activity", config, signer, fusion_apps_type_mapping, **base_client_init_kwargs) + self.retry_strategy = kwargs.get('retry_strategy') + self.circuit_breaker_callback = kwargs.get('circuit_breaker_callback') + + def create_refresh_activity(self, fusion_environment_id, create_refresh_activity_details, **kwargs): + """ + Creates a new RefreshActivity. + + + :param str fusion_environment_id: (required) + unique FusionEnvironment identifier + + :param oci.fusion_apps.models.CreateRefreshActivityDetails create_refresh_activity_details: (required) + Details for the new RefreshActivity. + + :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) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use create_refresh_activity API. + """ + resource_path = "/fusionEnvironments/{fusionEnvironmentId}/refreshActivities" + method = "POST" + operation_name = "create_refresh_activity" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_retry_token", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "create_refresh_activity got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "fusionEnvironmentId": fusion_environment_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-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: + 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=create_refresh_activity_details, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=create_refresh_activity_details, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def get_refresh_activity(self, fusion_environment_id, refresh_activity_id, **kwargs): + """ + Gets a RefreshActivity by identifier + + + :param str fusion_environment_id: (required) + unique FusionEnvironment identifier + + :param str refresh_activity_id: (required) + The unique identifier (OCID) of the Refresh activity. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.fusion_apps.models.RefreshActivity` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_refresh_activity API. + """ + resource_path = "/fusionEnvironments/{fusionEnvironmentId}/refreshActivities/{refreshActivityId}" + method = "GET" + operation_name = "get_refresh_activity" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "get_refresh_activity got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "fusionEnvironmentId": fusion_environment_id, + "refreshActivityId": refresh_activity_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="RefreshActivity", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="RefreshActivity", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def list_refresh_activities(self, fusion_environment_id, **kwargs): + """ + Returns a list of RefreshActivities. + + + :param str fusion_environment_id: (required) + unique FusionEnvironment identifier + + :param str display_name: (optional) + A filter to return only resources that match the entire display name given. + + :param datetime time_scheduled_start_greater_than_or_equal_to: (optional) + A filter that returns all resources that are scheduled after this date + + :param datetime time_expected_finish_less_than_or_equal_to: (optional) + A filter that returns all resources that end before this date + + :param str lifecycle_state: (optional) + A filter that returns all resources that match the specified status + + Allowed values are: "ACCEPTED", "IN_PROGRESS", "FAILED", "SUCCEEDED", "CANCELED" + + :param int limit: (optional) + The maximum number of items to return. + + :param str page: (optional) + The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. + + :param str sort_order: (optional) + The sort order to use, either 'asc' or 'desc'. + + Allowed values are: "ASC", "DESC" + + :param str sort_by: (optional) + The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. + + Allowed values are: "TIME_CREATED", "DISPLAY_NAME" + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.fusion_apps.models.RefreshActivityCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_refresh_activities API. + """ + resource_path = "/fusionEnvironments/{fusionEnvironmentId}/refreshActivities" + method = "GET" + operation_name = "list_refresh_activities" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "display_name", + "time_scheduled_start_greater_than_or_equal_to", + "time_expected_finish_less_than_or_equal_to", + "lifecycle_state", + "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( + "list_refresh_activities got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "fusionEnvironmentId": fusion_environment_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + if 'lifecycle_state' in kwargs: + lifecycle_state_allowed_values = ["ACCEPTED", "IN_PROGRESS", "FAILED", "SUCCEEDED", "CANCELED"] + if kwargs['lifecycle_state'] not in lifecycle_state_allowed_values: + raise ValueError( + "Invalid value for `lifecycle_state`, must be one of {0}".format(lifecycle_state_allowed_values) + ) + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + "Invalid value for `sort_order`, must be one of {0}".format(sort_order_allowed_values) + ) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["TIME_CREATED", "DISPLAY_NAME"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) + ) + + query_params = { + "displayName": kwargs.get("display_name", missing), + "timeScheduledStartGreaterThanOrEqualTo": kwargs.get("time_scheduled_start_greater_than_or_equal_to", missing), + "timeExpectedFinishLessThanOrEqualTo": kwargs.get("time_expected_finish_less_than_or_equal_to", missing), + "lifecycleState": kwargs.get("lifecycle_state", 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: + 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="RefreshActivityCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + 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="RefreshActivityCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def list_time_available_for_refreshes(self, fusion_environment_id, **kwargs): + """ + Gets available refresh time for this fusion environment + + + :param str fusion_environment_id: (required) + unique FusionEnvironment identifier + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param int limit: (optional) + The maximum number of items to return. + + :param str page: (optional) + The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. + + :param str sort_order: (optional) + The sort order to use, either 'asc' or 'desc'. + + Allowed values are: "ASC", "DESC" + + :param str sort_by: (optional) + The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. + + Allowed values are: "TIME_CREATED", "DISPLAY_NAME" + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.fusion_apps.models.TimeAvailableForRefreshCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_time_available_for_refreshes API. + """ + resource_path = "/fusionEnvironments/{fusionEnvironmentId}/timeAvailableForRefresh" + method = "GET" + operation_name = "list_time_available_for_refreshes" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id", + "limit", + "page", + "sort_order", + "sort_by" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_time_available_for_refreshes got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "fusionEnvironmentId": fusion_environment_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + "Invalid value for `sort_order`, must be one of {0}".format(sort_order_allowed_values) + ) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["TIME_CREATED", "DISPLAY_NAME"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) + ) + + query_params = { + "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: + 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="TimeAvailableForRefreshCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + 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="TimeAvailableForRefreshCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) diff --git a/src/oci/fusion_apps/refresh_activity_client_composite_operations.py b/src/oci/fusion_apps/refresh_activity_client_composite_operations.py new file mode 100644 index 0000000000..25dc8b2cc3 --- /dev/null +++ b/src/oci/fusion_apps/refresh_activity_client_composite_operations.py @@ -0,0 +1,65 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, 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. + +import oci # noqa: F401 +from oci.util import WAIT_RESOURCE_NOT_FOUND # noqa: F401 + + +class RefreshActivityClientCompositeOperations(object): + """ + This class provides a wrapper around :py:class:`~oci.fusion_apps.RefreshActivityClient` and offers convenience methods + for operations that would otherwise need to be chained together. For example, instead of performing an action + on a resource (e.g. launching an instance, creating a load balancer) and then using a waiter to wait for the resource + to enter a given state, you can call a single method in this class to accomplish the same functionality + """ + + def __init__(self, client, **kwargs): + """ + Creates a new RefreshActivityClientCompositeOperations object + + :param RefreshActivityClient client: + The service client which will be wrapped by this object + """ + self.client = client + + def create_refresh_activity_and_wait_for_state(self, fusion_environment_id, create_refresh_activity_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.fusion_apps.RefreshActivityClient.create_refresh_activity` and waits for the :py:class:`~oci.fusion_apps.models.WorkRequest` + to enter the given state(s). + + :param str fusion_environment_id: (required) + unique FusionEnvironment identifier + + :param oci.fusion_apps.models.CreateRefreshActivityDetails create_refresh_activity_details: (required) + Details for the new RefreshActivity. + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.fusion_apps.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.fusion_apps.RefreshActivityClient.create_refresh_activity` + + :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_refresh_activity(fusion_environment_id, create_refresh_activity_details, **operation_kwargs) + if not wait_for_states: + return operation_result + + lowered_wait_for_states = [w.lower() for w in wait_for_states] + 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/fusion_apps/scheduled_activity_client.py b/src/oci/fusion_apps/scheduled_activity_client.py new file mode 100644 index 0000000000..0c3ee98c23 --- /dev/null +++ b/src/oci/fusion_apps/scheduled_activity_client.py @@ -0,0 +1,380 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from __future__ import absolute_import + +from oci._vendor import requests # noqa: F401 +from oci._vendor import six + +from oci import retry, circuit_breaker # noqa: F401 +from oci.base_client import BaseClient +from oci.config import get_config_value_or_default, validate_config +from oci.signer import Signer +from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from .models import fusion_apps_type_mapping +missing = Sentinel("Missing") + + +class ScheduledActivityClient(object): + """ + Use the Fusion Applications Environment Management API to manage the environments where your Fusion Applications run. For more information, see the [Fusion Applications Environment Management documentation](/iaas/Content/Identity/fusion-applications/home.htm). + """ + + def __init__(self, config, **kwargs): + """ + Creates a new service client + + :param dict config: + Configuration keys and values as per `SDK and Tool Configuration `__. + The :py:meth:`~oci.config.from_file` method can be used to load configuration from a file. Alternatively, a ``dict`` can be passed. You can validate_config + the dict using :py:meth:`~oci.config.validate_config` + + :param str service_endpoint: (optional) + The endpoint of the service to call using this client. For example ``https://iaas.us-ashburn-1.oraclecloud.com``. If this keyword argument is + not provided then it will be derived using the region in the config parameter. You should only provide this keyword argument if you have an explicit + need to specify a service endpoint. + + :param timeout: (optional) + The connection and read timeouts for the client. The default values are connection timeout 10 seconds and read timeout 60 seconds. This keyword argument can be provided + as a single float, in which case the value provided is used for both the read and connection timeouts, or as a tuple of two floats. If + a tuple is provided then the first value is used as the connection timeout and the second value as the read timeout. + :type timeout: float or tuple(float, float) + + :param signer: (optional) + The signer to use when signing requests made by the service client. The default is to use a :py:class:`~oci.signer.Signer` based on the values + provided in the config parameter. + + One use case for this parameter is for `Instance Principals authentication `__ + by passing an instance of :py:class:`~oci.auth.signers.InstancePrincipalsSecurityTokenSigner` as the value for this keyword argument + :type signer: :py:class:`~oci.signer.AbstractBaseSigner` + + :param obj retry_strategy: (optional) + A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. + Retry strategies can also be applied at the operation level by passing a ``retry_strategy`` keyword argument as part of calling the operation. + Any value provided at the operation level will override whatever is specified at the client level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` + is also available. The specifics of the default retry strategy are described `here `__. + + :param obj circuit_breaker_strategy: (optional) + A circuit breaker strategy to apply to all calls made by this service client (i.e. at the client level). + This client uses :py:data:`~oci.circuit_breaker.DEFAULT_CIRCUIT_BREAKER_STRATEGY` as default if no circuit breaker strategy is provided. + The specifics of circuit breaker strategy are described `here `__. + + :param function circuit_breaker_callback: (optional) + Callback function to receive any exceptions triggerred by the circuit breaker. + + :param allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not + allow control characters to be in the response object. + """ + validate_config(config, signer=kwargs.get('signer')) + if 'signer' in kwargs: + signer = kwargs['signer'] + + elif AUTHENTICATION_TYPE_FIELD_NAME in config: + signer = get_signer_from_authentication_type(config) + + else: + signer = Signer( + tenancy=config["tenancy"], + user=config["user"], + fingerprint=config["fingerprint"], + private_key_file_location=config.get("key_file"), + pass_phrase=get_config_value_or_default(config, "pass_phrase"), + private_key_content=config.get("key_content") + ) + + base_client_init_kwargs = { + 'regional_client': True, + 'service_endpoint': kwargs.get('service_endpoint'), + 'base_path': '/20211201', + 'service_endpoint_template': 'https://fusionapps.{region}.oci.{secondLevelDomain}', + 'skip_deserialization': kwargs.get('skip_deserialization', False), + 'circuit_breaker_strategy': kwargs.get('circuit_breaker_strategy', circuit_breaker.GLOBAL_CIRCUIT_BREAKER_STRATEGY) + } + if 'timeout' in kwargs: + base_client_init_kwargs['timeout'] = kwargs.get('timeout') + if base_client_init_kwargs.get('circuit_breaker_strategy') is None: + base_client_init_kwargs['circuit_breaker_strategy'] = circuit_breaker.DEFAULT_CIRCUIT_BREAKER_STRATEGY + if 'allow_control_chars' in kwargs: + base_client_init_kwargs['allow_control_chars'] = kwargs.get('allow_control_chars') + self.base_client = BaseClient("scheduled_activity", config, signer, fusion_apps_type_mapping, **base_client_init_kwargs) + self.retry_strategy = kwargs.get('retry_strategy') + self.circuit_breaker_callback = kwargs.get('circuit_breaker_callback') + + def get_scheduled_activity(self, fusion_environment_id, scheduled_activity_id, **kwargs): + """ + Gets a ScheduledActivity by identifier + + + :param str fusion_environment_id: (required) + unique FusionEnvironment identifier + + :param str scheduled_activity_id: (required) + Unique ScheduledActivity identifier. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.fusion_apps.models.ScheduledActivity` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_scheduled_activity API. + """ + resource_path = "/fusionEnvironments/{fusionEnvironmentId}/scheduledActivities/{scheduledActivityId}" + method = "GET" + operation_name = "get_scheduled_activity" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "get_scheduled_activity got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "fusionEnvironmentId": fusion_environment_id, + "scheduledActivityId": scheduled_activity_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="ScheduledActivity", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="ScheduledActivity", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def list_scheduled_activities(self, fusion_environment_id, **kwargs): + """ + Returns a list of ScheduledActivities. + + + :param str fusion_environment_id: (required) + unique FusionEnvironment identifier + + :param str display_name: (optional) + A filter to return only resources that match the entire display name given. + + :param datetime time_scheduled_start_greater_than_or_equal_to: (optional) + A filter that returns all resources that are scheduled after this date + + :param datetime time_expected_finish_less_than_or_equal_to: (optional) + A filter that returns all resources that end before this date + + :param str run_cycle: (optional) + A filter that returns all resources that match the specified run cycle. + + Allowed values are: "QUARTERLY", "MONTHLY", "ONEOFF", "VERTEX" + + :param str lifecycle_state: (optional) + A filter that returns all resources that match the specified status + + Allowed values are: "ACCEPTED", "IN_PROGRESS", "FAILED", "SUCCEEDED", "CANCELED" + + :param int limit: (optional) + The maximum number of items to return. + + :param str page: (optional) + The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. + + :param str sort_order: (optional) + The sort order to use, either 'asc' or 'desc'. + + Allowed values are: "ASC", "DESC" + + :param str sort_by: (optional) + The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. + + Allowed values are: "TIME_CREATED", "DISPLAY_NAME" + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.fusion_apps.models.ScheduledActivityCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_scheduled_activities API. + """ + resource_path = "/fusionEnvironments/{fusionEnvironmentId}/scheduledActivities" + method = "GET" + operation_name = "list_scheduled_activities" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "display_name", + "time_scheduled_start_greater_than_or_equal_to", + "time_expected_finish_less_than_or_equal_to", + "run_cycle", + "lifecycle_state", + "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( + "list_scheduled_activities got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "fusionEnvironmentId": fusion_environment_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + if 'run_cycle' in kwargs: + run_cycle_allowed_values = ["QUARTERLY", "MONTHLY", "ONEOFF", "VERTEX"] + if kwargs['run_cycle'] not in run_cycle_allowed_values: + raise ValueError( + "Invalid value for `run_cycle`, must be one of {0}".format(run_cycle_allowed_values) + ) + + if 'lifecycle_state' in kwargs: + lifecycle_state_allowed_values = ["ACCEPTED", "IN_PROGRESS", "FAILED", "SUCCEEDED", "CANCELED"] + if kwargs['lifecycle_state'] not in lifecycle_state_allowed_values: + raise ValueError( + "Invalid value for `lifecycle_state`, must be one of {0}".format(lifecycle_state_allowed_values) + ) + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + "Invalid value for `sort_order`, must be one of {0}".format(sort_order_allowed_values) + ) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["TIME_CREATED", "DISPLAY_NAME"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) + ) + + query_params = { + "displayName": kwargs.get("display_name", missing), + "timeScheduledStartGreaterThanOrEqualTo": kwargs.get("time_scheduled_start_greater_than_or_equal_to", missing), + "timeExpectedFinishLessThanOrEqualTo": kwargs.get("time_expected_finish_less_than_or_equal_to", missing), + "runCycle": kwargs.get("run_cycle", missing), + "lifecycleState": kwargs.get("lifecycle_state", 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: + 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="ScheduledActivityCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + 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="ScheduledActivityCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) diff --git a/src/oci/fusion_apps/scheduled_activity_client_composite_operations.py b/src/oci/fusion_apps/scheduled_activity_client_composite_operations.py new file mode 100644 index 0000000000..252647d94b --- /dev/null +++ b/src/oci/fusion_apps/scheduled_activity_client_composite_operations.py @@ -0,0 +1,24 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, 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. + +import oci # noqa: F401 +from oci.util import WAIT_RESOURCE_NOT_FOUND # noqa: F401 + + +class ScheduledActivityClientCompositeOperations(object): + """ + This class provides a wrapper around :py:class:`~oci.fusion_apps.ScheduledActivityClient` and offers convenience methods + for operations that would otherwise need to be chained together. For example, instead of performing an action + on a resource (e.g. launching an instance, creating a load balancer) and then using a waiter to wait for the resource + to enter a given state, you can call a single method in this class to accomplish the same functionality + """ + + def __init__(self, client, **kwargs): + """ + Creates a new ScheduledActivityClientCompositeOperations object + + :param ScheduledActivityClient client: + The service client which will be wrapped by this object + """ + self.client = client diff --git a/src/oci/fusion_apps/service_attachment_client.py b/src/oci/fusion_apps/service_attachment_client.py new file mode 100644 index 0000000000..0e77a79db5 --- /dev/null +++ b/src/oci/fusion_apps/service_attachment_client.py @@ -0,0 +1,370 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from __future__ import absolute_import + +from oci._vendor import requests # noqa: F401 +from oci._vendor import six + +from oci import retry, circuit_breaker # noqa: F401 +from oci.base_client import BaseClient +from oci.config import get_config_value_or_default, validate_config +from oci.signer import Signer +from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from .models import fusion_apps_type_mapping +missing = Sentinel("Missing") + + +class ServiceAttachmentClient(object): + """ + Use the Fusion Applications Environment Management API to manage the environments where your Fusion Applications run. For more information, see the [Fusion Applications Environment Management documentation](/iaas/Content/Identity/fusion-applications/home.htm). + """ + + def __init__(self, config, **kwargs): + """ + Creates a new service client + + :param dict config: + Configuration keys and values as per `SDK and Tool Configuration `__. + The :py:meth:`~oci.config.from_file` method can be used to load configuration from a file. Alternatively, a ``dict`` can be passed. You can validate_config + the dict using :py:meth:`~oci.config.validate_config` + + :param str service_endpoint: (optional) + The endpoint of the service to call using this client. For example ``https://iaas.us-ashburn-1.oraclecloud.com``. If this keyword argument is + not provided then it will be derived using the region in the config parameter. You should only provide this keyword argument if you have an explicit + need to specify a service endpoint. + + :param timeout: (optional) + The connection and read timeouts for the client. The default values are connection timeout 10 seconds and read timeout 60 seconds. This keyword argument can be provided + as a single float, in which case the value provided is used for both the read and connection timeouts, or as a tuple of two floats. If + a tuple is provided then the first value is used as the connection timeout and the second value as the read timeout. + :type timeout: float or tuple(float, float) + + :param signer: (optional) + The signer to use when signing requests made by the service client. The default is to use a :py:class:`~oci.signer.Signer` based on the values + provided in the config parameter. + + One use case for this parameter is for `Instance Principals authentication `__ + by passing an instance of :py:class:`~oci.auth.signers.InstancePrincipalsSecurityTokenSigner` as the value for this keyword argument + :type signer: :py:class:`~oci.signer.AbstractBaseSigner` + + :param obj retry_strategy: (optional) + A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. + Retry strategies can also be applied at the operation level by passing a ``retry_strategy`` keyword argument as part of calling the operation. + Any value provided at the operation level will override whatever is specified at the client level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` + is also available. The specifics of the default retry strategy are described `here `__. + + :param obj circuit_breaker_strategy: (optional) + A circuit breaker strategy to apply to all calls made by this service client (i.e. at the client level). + This client uses :py:data:`~oci.circuit_breaker.DEFAULT_CIRCUIT_BREAKER_STRATEGY` as default if no circuit breaker strategy is provided. + The specifics of circuit breaker strategy are described `here `__. + + :param function circuit_breaker_callback: (optional) + Callback function to receive any exceptions triggerred by the circuit breaker. + + :param allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not + allow control characters to be in the response object. + """ + validate_config(config, signer=kwargs.get('signer')) + if 'signer' in kwargs: + signer = kwargs['signer'] + + elif AUTHENTICATION_TYPE_FIELD_NAME in config: + signer = get_signer_from_authentication_type(config) + + else: + signer = Signer( + tenancy=config["tenancy"], + user=config["user"], + fingerprint=config["fingerprint"], + private_key_file_location=config.get("key_file"), + pass_phrase=get_config_value_or_default(config, "pass_phrase"), + private_key_content=config.get("key_content") + ) + + base_client_init_kwargs = { + 'regional_client': True, + 'service_endpoint': kwargs.get('service_endpoint'), + 'base_path': '/20211201', + 'service_endpoint_template': 'https://fusionapps.{region}.oci.{secondLevelDomain}', + 'skip_deserialization': kwargs.get('skip_deserialization', False), + 'circuit_breaker_strategy': kwargs.get('circuit_breaker_strategy', circuit_breaker.GLOBAL_CIRCUIT_BREAKER_STRATEGY) + } + if 'timeout' in kwargs: + base_client_init_kwargs['timeout'] = kwargs.get('timeout') + if base_client_init_kwargs.get('circuit_breaker_strategy') is None: + base_client_init_kwargs['circuit_breaker_strategy'] = circuit_breaker.DEFAULT_CIRCUIT_BREAKER_STRATEGY + if 'allow_control_chars' in kwargs: + base_client_init_kwargs['allow_control_chars'] = kwargs.get('allow_control_chars') + self.base_client = BaseClient("service_attachment", config, signer, fusion_apps_type_mapping, **base_client_init_kwargs) + self.retry_strategy = kwargs.get('retry_strategy') + self.circuit_breaker_callback = kwargs.get('circuit_breaker_callback') + + def get_service_attachment(self, fusion_environment_id, service_attachment_id, **kwargs): + """ + Gets a Service Attachment by identifier + + + :param str fusion_environment_id: (required) + unique FusionEnvironment identifier + + :param str service_attachment_id: (required) + OCID of the Service Attachment + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.fusion_apps.models.ServiceAttachment` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_service_attachment API. + """ + resource_path = "/fusionEnvironments/{fusionEnvironmentId}/serviceAttachments/{serviceAttachmentId}" + method = "GET" + operation_name = "get_service_attachment" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "get_service_attachment got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "fusionEnvironmentId": fusion_environment_id, + "serviceAttachmentId": service_attachment_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="ServiceAttachment", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="ServiceAttachment", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def list_service_attachments(self, fusion_environment_id, **kwargs): + """ + Returns a list of service attachments. + + + :param str fusion_environment_id: (required) + unique FusionEnvironment identifier + + :param str display_name: (optional) + A filter to return only resources that match the entire display name given. + + :param str lifecycle_state: (optional) + A filter that returns all resources that match the specified lifecycle state. + + Allowed values are: "CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED" + + :param str service_instance_type: (optional) + A filter that returns all resources that match the specified lifecycle state. + + Allowed values are: "DIGITAL_ASSISTANT", "INTEGRATION_CLOUD", "ANALYTICS_WAREHOUSE", "VBCS", "VISUAL_BUILDER_STUDIO" + + :param int limit: (optional) + The maximum number of items to return. + + :param str page: (optional) + The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. + + :param str sort_order: (optional) + The sort order to use, either 'asc' or 'desc'. + + Allowed values are: "ASC", "DESC" + + :param str sort_by: (optional) + The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. + + Allowed values are: "TIME_CREATED", "DISPLAY_NAME" + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.fusion_apps.models.ServiceAttachmentCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_service_attachments API. + """ + resource_path = "/fusionEnvironments/{fusionEnvironmentId}/serviceAttachments" + method = "GET" + operation_name = "list_service_attachments" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "display_name", + "lifecycle_state", + "service_instance_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( + "list_service_attachments got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "fusionEnvironmentId": fusion_environment_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + if 'lifecycle_state' in kwargs: + lifecycle_state_allowed_values = ["CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED"] + if kwargs['lifecycle_state'] not in lifecycle_state_allowed_values: + raise ValueError( + "Invalid value for `lifecycle_state`, must be one of {0}".format(lifecycle_state_allowed_values) + ) + + if 'service_instance_type' in kwargs: + service_instance_type_allowed_values = ["DIGITAL_ASSISTANT", "INTEGRATION_CLOUD", "ANALYTICS_WAREHOUSE", "VBCS", "VISUAL_BUILDER_STUDIO"] + if kwargs['service_instance_type'] not in service_instance_type_allowed_values: + raise ValueError( + "Invalid value for `service_instance_type`, must be one of {0}".format(service_instance_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( + "Invalid value for `sort_order`, must be one of {0}".format(sort_order_allowed_values) + ) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["TIME_CREATED", "DISPLAY_NAME"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) + ) + + query_params = { + "displayName": kwargs.get("display_name", missing), + "lifecycleState": kwargs.get("lifecycle_state", missing), + "serviceInstanceType": kwargs.get("service_instance_type", 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: + 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="ServiceAttachmentCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + 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="ServiceAttachmentCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) diff --git a/src/oci/fusion_apps/service_attachment_client_composite_operations.py b/src/oci/fusion_apps/service_attachment_client_composite_operations.py new file mode 100644 index 0000000000..00ba7760e8 --- /dev/null +++ b/src/oci/fusion_apps/service_attachment_client_composite_operations.py @@ -0,0 +1,24 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, 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. + +import oci # noqa: F401 +from oci.util import WAIT_RESOURCE_NOT_FOUND # noqa: F401 + + +class ServiceAttachmentClientCompositeOperations(object): + """ + This class provides a wrapper around :py:class:`~oci.fusion_apps.ServiceAttachmentClient` and offers convenience methods + for operations that would otherwise need to be chained together. For example, instead of performing an action + on a resource (e.g. launching an instance, creating a load balancer) and then using a waiter to wait for the resource + to enter a given state, you can call a single method in this class to accomplish the same functionality + """ + + def __init__(self, client, **kwargs): + """ + Creates a new ServiceAttachmentClientCompositeOperations object + + :param ServiceAttachmentClient client: + The service client which will be wrapped by this object + """ + self.client = client diff --git a/src/oci/lockbox/__init__.py b/src/oci/lockbox/__init__.py new file mode 100644 index 0000000000..592ffb69e4 --- /dev/null +++ b/src/oci/lockbox/__init__.py @@ -0,0 +1,12 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from __future__ import absolute_import + + +from .lockbox_client import LockboxClient +from .lockbox_client_composite_operations import LockboxClientCompositeOperations +from . import models + +__all__ = ["LockboxClient", "LockboxClientCompositeOperations", "models"] diff --git a/src/oci/lockbox/lockbox_client.py b/src/oci/lockbox/lockbox_client.py new file mode 100644 index 0000000000..cd3893f5a5 --- /dev/null +++ b/src/oci/lockbox/lockbox_client.py @@ -0,0 +1,2614 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from __future__ import absolute_import + +from oci._vendor import requests # noqa: F401 +from oci._vendor import six + +from oci import retry, circuit_breaker # noqa: F401 +from oci.base_client import BaseClient +from oci.config import get_config_value_or_default, validate_config +from oci.signer import Signer +from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from .models import lockbox_type_mapping +missing = Sentinel("Missing") + + +class LockboxClient(object): + """ + Use the Managed Access API to approve access requests, create and manage templates, and manage resource approval settings. For more information, see [Managed Access Overview](https://docs.oracle.com/en-us/iaas/managed-access/overview.htm). + + Use the table of contents and search tool to explore the Managed Access API. + """ + + def __init__(self, config, **kwargs): + """ + Creates a new service client + + :param dict config: + Configuration keys and values as per `SDK and Tool Configuration `__. + The :py:meth:`~oci.config.from_file` method can be used to load configuration from a file. Alternatively, a ``dict`` can be passed. You can validate_config + the dict using :py:meth:`~oci.config.validate_config` + + :param str service_endpoint: (optional) + The endpoint of the service to call using this client. For example ``https://iaas.us-ashburn-1.oraclecloud.com``. If this keyword argument is + not provided then it will be derived using the region in the config parameter. You should only provide this keyword argument if you have an explicit + need to specify a service endpoint. + + :param timeout: (optional) + The connection and read timeouts for the client. The default values are connection timeout 10 seconds and read timeout 60 seconds. This keyword argument can be provided + as a single float, in which case the value provided is used for both the read and connection timeouts, or as a tuple of two floats. If + a tuple is provided then the first value is used as the connection timeout and the second value as the read timeout. + :type timeout: float or tuple(float, float) + + :param signer: (optional) + The signer to use when signing requests made by the service client. The default is to use a :py:class:`~oci.signer.Signer` based on the values + provided in the config parameter. + + One use case for this parameter is for `Instance Principals authentication `__ + by passing an instance of :py:class:`~oci.auth.signers.InstancePrincipalsSecurityTokenSigner` as the value for this keyword argument + :type signer: :py:class:`~oci.signer.AbstractBaseSigner` + + :param obj retry_strategy: (optional) + A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. + Retry strategies can also be applied at the operation level by passing a ``retry_strategy`` keyword argument as part of calling the operation. + Any value provided at the operation level will override whatever is specified at the client level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` + is also available. The specifics of the default retry strategy are described `here `__. + + :param obj circuit_breaker_strategy: (optional) + A circuit breaker strategy to apply to all calls made by this service client (i.e. at the client level). + This client uses :py:data:`~oci.circuit_breaker.DEFAULT_CIRCUIT_BREAKER_STRATEGY` as default if no circuit breaker strategy is provided. + The specifics of circuit breaker strategy are described `here `__. + + :param function circuit_breaker_callback: (optional) + Callback function to receive any exceptions triggerred by the circuit breaker. + + :param allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not + allow control characters to be in the response object. + """ + validate_config(config, signer=kwargs.get('signer')) + if 'signer' in kwargs: + signer = kwargs['signer'] + + elif AUTHENTICATION_TYPE_FIELD_NAME in config: + signer = get_signer_from_authentication_type(config) + + else: + signer = Signer( + tenancy=config["tenancy"], + user=config["user"], + fingerprint=config["fingerprint"], + private_key_file_location=config.get("key_file"), + pass_phrase=get_config_value_or_default(config, "pass_phrase"), + private_key_content=config.get("key_content") + ) + + base_client_init_kwargs = { + 'regional_client': True, + 'service_endpoint': kwargs.get('service_endpoint'), + 'base_path': '/20220126', + 'service_endpoint_template': 'https://managed-access.{region}.oci.{secondLevelDomain}', + 'skip_deserialization': kwargs.get('skip_deserialization', False), + 'circuit_breaker_strategy': kwargs.get('circuit_breaker_strategy', circuit_breaker.GLOBAL_CIRCUIT_BREAKER_STRATEGY) + } + if 'timeout' in kwargs: + base_client_init_kwargs['timeout'] = kwargs.get('timeout') + if base_client_init_kwargs.get('circuit_breaker_strategy') is None: + base_client_init_kwargs['circuit_breaker_strategy'] = circuit_breaker.DEFAULT_CIRCUIT_BREAKER_STRATEGY + if 'allow_control_chars' in kwargs: + base_client_init_kwargs['allow_control_chars'] = kwargs.get('allow_control_chars') + self.base_client = BaseClient("lockbox", config, signer, lockbox_type_mapping, **base_client_init_kwargs) + self.retry_strategy = kwargs.get('retry_strategy') + self.circuit_breaker_callback = kwargs.get('circuit_breaker_callback') + + def cancel_work_request(self, work_request_id, **kwargs): + """ + Cancels the work request with the given ID. + + + :param str work_request_id: (required) + The ID of the asynchronous 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 str opc_request_id: (optional) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use cancel_work_request API. + """ + resource_path = "/workRequests/{workRequestId}" + method = "DELETE" + operation_name = "cancel_work_request" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/managed-access/20220126/WorkRequest/CancelWorkRequest" + + # 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( + "cancel_work_request got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "workRequestId": work_request_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "if-match": kwargs.get("if_match", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + 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) + 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) + + def change_approval_template_compartment(self, approval_template_id, change_approval_template_compartment_details, **kwargs): + """ + Moves an ApprovalTemplate resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource. + + + :param str approval_template_id: (required) + The unique identifier (OCID) of the approval template. + + :param oci.lockbox.models.ChangeApprovalTemplateCompartmentDetails change_approval_template_compartment_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 will be updated or deleted only if the etag you + provide matches the resource's current etag value. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param str opc_retry_token: (optional) + A token that uniquely identifies a request so it can be retried in case of a timeout or + server error without risk of executing that same action again. Retry tokens expire after 24 + hours, but can be invalidated before then due to conflicting operations. For example, if a resource + has been deleted and purged from the system, then a retry of the original creation request + might be rejected. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + 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_approval_template_compartment API. + """ + resource_path = "/approvalTemplates/{approvalTemplateId}/actions/changeCompartment" + method = "POST" + operation_name = "change_approval_template_compartment" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/managed-access/20220126/ApprovalTemplate/ChangeApprovalTemplateCompartment" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "if_match", + "opc_request_id", + "opc_retry_token" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "change_approval_template_compartment got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "approvalTemplateId": approval_template_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "if-match": kwargs.get("if_match", missing), + "opc-request-id": kwargs.get("opc_request_id", missing), + "opc-retry-token": kwargs.get("opc_retry_token", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + 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_approval_template_compartment_details, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=change_approval_template_compartment_details, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def change_lockbox_compartment(self, lockbox_id, change_lockbox_compartment_details, **kwargs): + """ + Moves a Lockbox resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource. + + + :param str lockbox_id: (required) + unique Lockbox identifier + + :param oci.lockbox.models.ChangeLockboxCompartmentDetails change_lockbox_compartment_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 will be updated or deleted only if the etag you + provide matches the resource's current etag value. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param str opc_retry_token: (optional) + A token that uniquely identifies a request so it can be retried in case of a timeout or + server error without risk of executing that same action again. Retry tokens expire after 24 + hours, but can be invalidated before then due to conflicting operations. For example, if a resource + has been deleted and purged from the system, then a retry of the original creation request + might be rejected. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + 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_lockbox_compartment API. + """ + resource_path = "/lockboxes/{lockboxId}/actions/changeCompartment" + method = "POST" + operation_name = "change_lockbox_compartment" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/managed-access/20220126/Lockbox/ChangeLockboxCompartment" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "if_match", + "opc_request_id", + "opc_retry_token" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "change_lockbox_compartment got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "lockboxId": lockbox_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "if-match": kwargs.get("if_match", missing), + "opc-request-id": kwargs.get("opc_request_id", missing), + "opc-retry-token": kwargs.get("opc_retry_token", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + 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_lockbox_compartment_details, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=change_lockbox_compartment_details, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def create_access_request(self, create_access_request_details, **kwargs): + """ + Creates a new access request. + + + :param oci.lockbox.models.CreateAccessRequestDetails create_access_request_details: (required) + Details for the new access 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) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.lockbox.models.AccessRequest` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use create_access_request API. + """ + resource_path = "/accessRequests" + method = "POST" + operation_name = "create_access_request" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/managed-access/20220126/AccessRequest/CreateAccessRequest" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_retry_token", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "create_access_request got unknown kwargs: {!r}".format(extra_kwargs)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-retry-token": kwargs.get("opc_retry_token", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + 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_access_request_details, + response_type="AccessRequest", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + header_params=header_params, + body=create_access_request_details, + response_type="AccessRequest", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def create_approval_template(self, create_approval_template_details, **kwargs): + """ + Creates a new approval template. + + + :param oci.lockbox.models.CreateApprovalTemplateDetails create_approval_template_details: (required) + Details for the new approval template. + + :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) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.lockbox.models.ApprovalTemplate` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use create_approval_template API. + """ + resource_path = "/approvalTemplates" + method = "POST" + operation_name = "create_approval_template" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/managed-access/20220126/ApprovalTemplate/CreateApprovalTemplate" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_retry_token", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "create_approval_template got unknown kwargs: {!r}".format(extra_kwargs)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-retry-token": kwargs.get("opc_retry_token", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + 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_approval_template_details, + response_type="ApprovalTemplate", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + header_params=header_params, + body=create_approval_template_details, + response_type="ApprovalTemplate", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def create_lockbox(self, create_lockbox_details, **kwargs): + """ + Creates a new Lockbox. + + + :param oci.lockbox.models.CreateLockboxDetails create_lockbox_details: (required) + Details for the new Lockbox. + + :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) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.lockbox.models.Lockbox` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use create_lockbox API. + """ + resource_path = "/lockboxes" + method = "POST" + operation_name = "create_lockbox" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/managed-access/20220126/Lockbox/CreateLockbox" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_retry_token", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "create_lockbox got unknown kwargs: {!r}".format(extra_kwargs)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-retry-token": kwargs.get("opc_retry_token", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + 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_lockbox_details, + response_type="Lockbox", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + header_params=header_params, + body=create_lockbox_details, + response_type="Lockbox", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def delete_approval_template(self, approval_template_id, **kwargs): + """ + Deletes an ApprovalTemplate resource by identifier + + + :param str approval_template_id: (required) + The unique identifier (OCID) of the approval template. + + :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) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use delete_approval_template API. + """ + resource_path = "/approvalTemplates/{approvalTemplateId}" + method = "DELETE" + operation_name = "delete_approval_template" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/managed-access/20220126/ApprovalTemplate/DeleteApprovalTemplate" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "if_match", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "delete_approval_template got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "approvalTemplateId": approval_template_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "if-match": kwargs.get("if_match", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + 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) + 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) + + def delete_lockbox(self, lockbox_id, **kwargs): + """ + Deletes a Lockbox resource by identifier + + + :param str lockbox_id: (required) + unique Lockbox identifier + + :param str if_match: (optional) + For optimistic concurrency control. In the PUT or DELETE call + for a resource, set the `if-match` parameter to the value of the + etag from a previous GET or POST response for that resource. + The resource will be updated or deleted only if the etag you + provide matches the resource's current etag value. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param str opc_retry_token: (optional) + A token that uniquely identifies a request so it can be retried in case of a timeout or + server error without risk of executing that same action again. Retry tokens expire after 24 + hours, but can be invalidated before then due to conflicting operations. For example, if a resource + has been deleted and purged from the system, then a retry of the original creation request + might be rejected. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + 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_lockbox API. + """ + resource_path = "/lockboxes/{lockboxId}" + method = "DELETE" + operation_name = "delete_lockbox" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/managed-access/20220126/Lockbox/DeleteLockbox" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "if_match", + "opc_request_id", + "opc_retry_token" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "delete_lockbox got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "lockboxId": lockbox_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "if-match": kwargs.get("if_match", missing), + "opc-request-id": kwargs.get("opc_request_id", missing), + "opc-retry-token": kwargs.get("opc_retry_token", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + 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) + 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) + + def get_access_materials(self, access_request_id, **kwargs): + """ + Retrieves the access credential/material associated with the access request. + + + :param str access_request_id: (required) + The unique identifier (OCID) of the access request. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.lockbox.models.AccessMaterials` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_access_materials API. + """ + resource_path = "/accessRequests/{accessRequestId}/accessMaterials" + method = "GET" + operation_name = "get_access_materials" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/managed-access/20220126/AccessMaterials/GetAccessMaterials" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "get_access_materials got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "accessRequestId": access_request_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="AccessMaterials", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="AccessMaterials", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def get_access_request(self, access_request_id, **kwargs): + """ + Retrieves an access request identified by the access request ID. + + + :param str access_request_id: (required) + The unique identifier (OCID) of the access request. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.lockbox.models.AccessRequest` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_access_request API. + """ + resource_path = "/accessRequests/{accessRequestId}" + method = "GET" + operation_name = "get_access_request" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/managed-access/20220126/AccessRequest/GetAccessRequest" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "get_access_request got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "accessRequestId": access_request_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="AccessRequest", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="AccessRequest", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def get_approval_template(self, approval_template_id, **kwargs): + """ + Retrieves an approval template identified by the approval template ID. + + + :param str approval_template_id: (required) + The unique identifier (OCID) of the approval template. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.lockbox.models.ApprovalTemplate` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_approval_template API. + """ + resource_path = "/approvalTemplates/{approvalTemplateId}" + method = "GET" + operation_name = "get_approval_template" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/managed-access/20220126/ApprovalTemplate/GetApprovalTemplate" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "get_approval_template got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "approvalTemplateId": approval_template_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="ApprovalTemplate", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="ApprovalTemplate", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def get_lockbox(self, lockbox_id, **kwargs): + """ + Gets a Lockbox by identifier + + + :param str lockbox_id: (required) + unique Lockbox identifier + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.lockbox.models.Lockbox` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_lockbox API. + """ + resource_path = "/lockboxes/{lockboxId}" + method = "GET" + operation_name = "get_lockbox" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/managed-access/20220126/Lockbox/GetLockbox" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "get_lockbox got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "lockboxId": lockbox_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="Lockbox", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="Lockbox", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def get_work_request(self, work_request_id, **kwargs): + """ + Gets details of the work request with the given ID. + + + :param str work_request_id: (required) + The ID of the asynchronous request. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.lockbox.models.WorkRequest` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_work_request API. + """ + resource_path = "/workRequests/{workRequestId}" + method = "GET" + operation_name = "get_work_request" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/managed-access/20220126/WorkRequest/GetWorkRequest" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "get_work_request got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "workRequestId": work_request_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="WorkRequest", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="WorkRequest", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def handle_access_request(self, access_request_id, handle_access_request_details, **kwargs): + """ + Handle the AccessRequest + + + :param str access_request_id: (required) + The unique identifier (OCID) of the access request. + + :param oci.lockbox.models.HandleAccessRequestDetails handle_access_request_details: (required) + The details of handling access 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 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) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use handle_access_request API. + """ + resource_path = "/accessRequests/{accessRequestId}/actions/handle" + method = "POST" + operation_name = "handle_access_request" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/managed-access/20220126/AccessRequest/HandleAccessRequest" + + # 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( + "handle_access_request got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "accessRequestId": access_request_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "if-match": kwargs.get("if_match", missing), + "opc-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: + 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=handle_access_request_details, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=handle_access_request_details, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def list_access_requests(self, **kwargs): + """ + Retrieves a list of AccessRequestSummary objects in a compartment. + + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param str lockbox_id: (optional) + The unique identifier (OCID) of the associated lockbox. + + :param str id: (optional) + A generic Id query param used to filter lockbox, access request and approval template by Id. + + :param str display_name: (optional) + A filter to return only resources that match the entire display name given. + + :param str lifecycle_state: (optional) + A filter to return only resources their lifecycleState matches the given lifecycleState. + + Allowed values are: "IN_PROGRESS", "WAITING", "SUCCEEDED", "CANCELING", "CANCELED", "FAILED" + + :param str lockbox_partner: (optional) + The name of the lockbox partner. + + Allowed values are: "FAAAS", "CANARY" + + :param str requestor_id: (optional) + The unique identifier (OCID) of the requestor in which to list resources. + + :param int limit: (optional) + The maximum number of items to return. + + :param str page: (optional) + A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response. + + :param str sort_order: (optional) + The sort order to use, either 'ASC' or 'DESC'. + + Allowed values are: "ASC", "DESC" + + :param str sort_by: (optional) + The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. + + Allowed values are: "timeCreated", "displayName", "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 :class:`~oci.lockbox.models.AccessRequestCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_access_requests API. + """ + resource_path = "/accessRequests" + method = "GET" + operation_name = "list_access_requests" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/managed-access/20220126/AccessRequestCollection/ListAccessRequests" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id", + "lockbox_id", + "id", + "display_name", + "lifecycle_state", + "lockbox_partner", + "requestor_id", + "limit", + "page", + "sort_order", + "sort_by" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_access_requests got unknown kwargs: {!r}".format(extra_kwargs)) + + if 'lifecycle_state' in kwargs: + lifecycle_state_allowed_values = ["IN_PROGRESS", "WAITING", "SUCCEEDED", "CANCELING", "CANCELED", "FAILED"] + if kwargs['lifecycle_state'] not in lifecycle_state_allowed_values: + raise ValueError( + "Invalid value for `lifecycle_state`, must be one of {0}".format(lifecycle_state_allowed_values) + ) + + if 'lockbox_partner' in kwargs: + lockbox_partner_allowed_values = ["FAAAS", "CANARY"] + if kwargs['lockbox_partner'] not in lockbox_partner_allowed_values: + raise ValueError( + "Invalid value for `lockbox_partner`, must be one of {0}".format(lockbox_partner_allowed_values) + ) + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + "Invalid value for `sort_order`, must be one of {0}".format(sort_order_allowed_values) + ) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["timeCreated", "displayName", "id"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) + ) + + query_params = { + "lockboxId": kwargs.get("lockbox_id", missing), + "id": kwargs.get("id", missing), + "displayName": kwargs.get("display_name", missing), + "lifecycleState": kwargs.get("lifecycle_state", missing), + "lockboxPartner": kwargs.get("lockbox_partner", missing), + "requestorId": kwargs.get("requestor_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: + 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="AccessRequestCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + query_params=query_params, + header_params=header_params, + response_type="AccessRequestCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def list_approval_templates(self, **kwargs): + """ + Retrieves a list of ApprovalTemplateSummary objects in a compartment. + + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param str compartment_id: (optional) + The ID of the compartment in which to list resources. + + :param str id: (optional) + A generic Id query param used to filter lockbox, access request and approval template by Id. + + :param str display_name: (optional) + A filter to return only resources that match the entire display name given. + + :param str lifecycle_state: (optional) + A filter to return only resources for which their lifecycleState matches the given lifecycleState. + + Allowed values are: "ACTIVE", "CREATING", "UPDATING", "DELETING", "DELETED", "FAILED" + + :param int limit: (optional) + The maximum number of items to return. + + :param str page: (optional) + A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response. + + :param str sort_order: (optional) + The sort order to use, either 'ASC' or 'DESC'. + + Allowed values are: "ASC", "DESC" + + :param str sort_by: (optional) + The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. + + Allowed values are: "timeCreated", "displayName", "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 :class:`~oci.lockbox.models.ApprovalTemplateCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_approval_templates API. + """ + resource_path = "/approvalTemplates" + method = "GET" + operation_name = "list_approval_templates" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/managed-access/20220126/ApprovalTemplateCollection/ListApprovalTemplates" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id", + "compartment_id", + "id", + "display_name", + "lifecycle_state", + "limit", + "page", + "sort_order", + "sort_by" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_approval_templates got unknown kwargs: {!r}".format(extra_kwargs)) + + if 'lifecycle_state' in kwargs: + lifecycle_state_allowed_values = ["ACTIVE", "CREATING", "UPDATING", "DELETING", "DELETED", "FAILED"] + if kwargs['lifecycle_state'] not in lifecycle_state_allowed_values: + raise ValueError( + "Invalid value for `lifecycle_state`, must be one of {0}".format(lifecycle_state_allowed_values) + ) + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + "Invalid value for `sort_order`, must be one of {0}".format(sort_order_allowed_values) + ) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["timeCreated", "displayName", "id"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) + ) + + query_params = { + "compartmentId": kwargs.get("compartment_id", missing), + "id": kwargs.get("id", missing), + "displayName": kwargs.get("display_name", missing), + "lifecycleState": kwargs.get("lifecycle_state", 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: + 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="ApprovalTemplateCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + query_params=query_params, + header_params=header_params, + response_type="ApprovalTemplateCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def list_lockboxes(self, **kwargs): + """ + Returns a list of Lockboxes. + + + :param str compartment_id: (optional) + The ID of the compartment in which to list resources. + + :param str lifecycle_state: (optional) + A filter to return only resources their lifecycleState matches the given lifecycleState. + + Allowed values are: "ACTIVE", "CREATING", "UPDATING", "DELETING", "DELETED", "FAILED" + + :param str display_name: (optional) + A filter to return only resources that match the entire display name given. + + :param str id: (optional) + unique Lockbox identifier + + :param str resource_id: (optional) + The ID of the resource associated with the lockbox. + + :param str lockbox_partner: (optional) + The name of the lockbox partner. + + Allowed values are: "FAAAS", "CANARY" + + :param int limit: (optional) + The maximum number of items to return. + + :param str page: (optional) + A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response. + + :param str sort_order: (optional) + The sort order to use, either 'ASC' or 'DESC'. + + Allowed values are: "ASC", "DESC" + + :param str sort_by: (optional) + The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. + + Allowed values are: "timeCreated", "displayName", "id" + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.lockbox.models.LockboxCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_lockboxes API. + """ + resource_path = "/lockboxes" + method = "GET" + operation_name = "list_lockboxes" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/managed-access/20220126/LockboxCollection/ListLockboxes" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "compartment_id", + "lifecycle_state", + "display_name", + "id", + "resource_id", + "lockbox_partner", + "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( + "list_lockboxes got unknown kwargs: {!r}".format(extra_kwargs)) + + if 'lifecycle_state' in kwargs: + lifecycle_state_allowed_values = ["ACTIVE", "CREATING", "UPDATING", "DELETING", "DELETED", "FAILED"] + if kwargs['lifecycle_state'] not in lifecycle_state_allowed_values: + raise ValueError( + "Invalid value for `lifecycle_state`, must be one of {0}".format(lifecycle_state_allowed_values) + ) + + if 'lockbox_partner' in kwargs: + lockbox_partner_allowed_values = ["FAAAS", "CANARY"] + if kwargs['lockbox_partner'] not in lockbox_partner_allowed_values: + raise ValueError( + "Invalid value for `lockbox_partner`, must be one of {0}".format(lockbox_partner_allowed_values) + ) + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + "Invalid value for `sort_order`, must be one of {0}".format(sort_order_allowed_values) + ) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["timeCreated", "displayName", "id"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) + ) + + query_params = { + "compartmentId": kwargs.get("compartment_id", missing), + "lifecycleState": kwargs.get("lifecycle_state", missing), + "displayName": kwargs.get("display_name", missing), + "id": kwargs.get("id", missing), + "resourceId": kwargs.get("resource_id", missing), + "lockboxPartner": kwargs.get("lockbox_partner", 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: + 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="LockboxCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + query_params=query_params, + header_params=header_params, + response_type="LockboxCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def list_work_request_errors(self, work_request_id, **kwargs): + """ + Returns a (paginated) list of errors for the work request with the given ID. + + + :param str work_request_id: (required) + The ID of the asynchronous request. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param str page: (optional) + A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response. + + :param int limit: (optional) + The maximum number of items to return. + + :param str sort_by: (optional) + The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending. + + Allowed values are: "timeAccepted" + + :param str sort_order: (optional) + The sort order to use, either 'ASC' or 'DESC'. + + Allowed values are: "ASC", "DESC" + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.lockbox.models.WorkRequestErrorCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_work_request_errors API. + """ + resource_path = "/workRequests/{workRequestId}/errors" + method = "GET" + operation_name = "list_work_request_errors" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/managed-access/20220126/WorkRequestError/ListWorkRequestErrors" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id", + "page", + "limit", + "sort_by", + "sort_order" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_work_request_errors got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "workRequestId": work_request_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["timeAccepted"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) + ) + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + "Invalid value for `sort_order`, must be one of {0}".format(sort_order_allowed_values) + ) + + query_params = { + "page": kwargs.get("page", missing), + "limit": kwargs.get("limit", missing), + "sortBy": kwargs.get("sort_by", missing), + "sortOrder": kwargs.get("sort_order", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + query_params=query_params, + header_params=header_params, + response_type="WorkRequestErrorCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + 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="WorkRequestErrorCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def list_work_request_logs(self, work_request_id, **kwargs): + """ + Returns a (paginated) list of logs for the work request with the given ID. + + + :param str work_request_id: (required) + The ID of the asynchronous request. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param str page: (optional) + A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response. + + :param int limit: (optional) + The maximum number of items to return. + + :param str sort_by: (optional) + The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending. + + Allowed values are: "timeAccepted" + + :param str sort_order: (optional) + The sort order to use, either 'ASC' or 'DESC'. + + Allowed values are: "ASC", "DESC" + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.lockbox.models.WorkRequestLogEntryCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_work_request_logs API. + """ + resource_path = "/workRequests/{workRequestId}/logs" + method = "GET" + operation_name = "list_work_request_logs" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/managed-access/20220126/WorkRequestLogEntry/ListWorkRequestLogs" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id", + "page", + "limit", + "sort_by", + "sort_order" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_work_request_logs got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "workRequestId": work_request_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["timeAccepted"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) + ) + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + "Invalid value for `sort_order`, must be one of {0}".format(sort_order_allowed_values) + ) + + query_params = { + "page": kwargs.get("page", missing), + "limit": kwargs.get("limit", missing), + "sortBy": kwargs.get("sort_by", missing), + "sortOrder": kwargs.get("sort_order", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + query_params=query_params, + header_params=header_params, + response_type="WorkRequestLogEntryCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + 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="WorkRequestLogEntryCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def list_work_requests(self, **kwargs): + """ + Lists the work requests in a compartment. + + + :param str compartment_id: (optional) + The ID of the compartment in which to list resources. + + :param str work_request_id: (optional) + The ID of the asynchronous work request. + + :param str status: (optional) + A filter to return only resources their lifecycleState matches the given OperationStatus. + + Allowed values are: "ACCEPTED", "IN_PROGRESS", "WAITING", "FAILED", "SUCCEEDED", "CANCELING", "CANCELED" + + :param str resource_id: (optional) + The ID of the resource affected by the work request. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param str page: (optional) + A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response. + + :param int limit: (optional) + The maximum number of items to return. + + :param str sort_order: (optional) + The sort order to use, either 'ASC' or 'DESC'. + + Allowed values are: "ASC", "DESC" + + :param str sort_by: (optional) + The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending. + + Allowed values are: "timeAccepted" + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.lockbox.models.WorkRequestSummaryCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_work_requests API. + """ + resource_path = "/workRequests" + method = "GET" + operation_name = "list_work_requests" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/managed-access/20220126/WorkRequest/ListWorkRequests" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "compartment_id", + "work_request_id", + "status", + "resource_id", + "opc_request_id", + "page", + "limit", + "sort_order", + "sort_by" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_work_requests got unknown kwargs: {!r}".format(extra_kwargs)) + + if 'status' in kwargs: + status_allowed_values = ["ACCEPTED", "IN_PROGRESS", "WAITING", "FAILED", "SUCCEEDED", "CANCELING", "CANCELED"] + if kwargs['status'] not in status_allowed_values: + raise ValueError( + "Invalid value for `status`, must be one of {0}".format(status_allowed_values) + ) + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + "Invalid value for `sort_order`, must be one of {0}".format(sort_order_allowed_values) + ) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["timeAccepted"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) + ) + + query_params = { + "compartmentId": kwargs.get("compartment_id", missing), + "workRequestId": kwargs.get("work_request_id", missing), + "status": kwargs.get("status", missing), + "resourceId": kwargs.get("resource_id", missing), + "page": kwargs.get("page", missing), + "limit": kwargs.get("limit", 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: + 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="WorkRequestSummaryCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + query_params=query_params, + header_params=header_params, + response_type="WorkRequestSummaryCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def update_approval_template(self, approval_template_id, update_approval_template_details, **kwargs): + """ + Updates the ApprovalTemplate + + + :param str approval_template_id: (required) + The unique identifier (OCID) of the approval template. + + :param oci.lockbox.models.UpdateApprovalTemplateDetails update_approval_template_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 will be updated or deleted only if the etag you + provide matches the resource's current etag value. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.lockbox.models.ApprovalTemplate` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use update_approval_template API. + """ + resource_path = "/approvalTemplates/{approvalTemplateId}" + method = "PUT" + operation_name = "update_approval_template" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/managed-access/20220126/ApprovalTemplate/UpdateApprovalTemplate" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "if_match", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "update_approval_template got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "approvalTemplateId": approval_template_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "if-match": kwargs.get("if_match", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + 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_approval_template_details, + response_type="ApprovalTemplate", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=update_approval_template_details, + response_type="ApprovalTemplate", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def update_lockbox(self, lockbox_id, update_lockbox_details, **kwargs): + """ + Updates the Lockbox + + + :param str lockbox_id: (required) + unique Lockbox identifier + + :param oci.lockbox.models.UpdateLockboxDetails update_lockbox_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 will be updated or deleted only if the etag you + provide matches the resource's current etag value. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.lockbox.models.Lockbox` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use update_lockbox API. + """ + resource_path = "/lockboxes/{lockboxId}" + method = "PUT" + operation_name = "update_lockbox" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/managed-access/20220126/Lockbox/UpdateLockbox" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "if_match", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "update_lockbox got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "lockboxId": lockbox_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "if-match": kwargs.get("if_match", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + 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_lockbox_details, + response_type="Lockbox", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=update_lockbox_details, + response_type="Lockbox", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) diff --git a/src/oci/lockbox/lockbox_client_composite_operations.py b/src/oci/lockbox/lockbox_client_composite_operations.py new file mode 100644 index 0000000000..8056cf3e6a --- /dev/null +++ b/src/oci/lockbox/lockbox_client_composite_operations.py @@ -0,0 +1,355 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, 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. + +import oci # noqa: F401 +from oci.util import WAIT_RESOURCE_NOT_FOUND # noqa: F401 + + +class LockboxClientCompositeOperations(object): + """ + This class provides a wrapper around :py:class:`~oci.lockbox.LockboxClient` and offers convenience methods + for operations that would otherwise need to be chained together. For example, instead of performing an action + on a resource (e.g. launching an instance, creating a load balancer) and then using a waiter to wait for the resource + to enter a given state, you can call a single method in this class to accomplish the same functionality + """ + + def __init__(self, client, **kwargs): + """ + Creates a new LockboxClientCompositeOperations object + + :param LockboxClient client: + The service client which will be wrapped by this object + """ + self.client = client + + def create_access_request_and_wait_for_state(self, create_access_request_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.lockbox.LockboxClient.create_access_request` and waits for the :py:class:`~oci.lockbox.models.WorkRequest` + to enter the given state(s). + + :param oci.lockbox.models.CreateAccessRequestDetails create_access_request_details: (required) + Details for the new access request. + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.lockbox.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.lockbox.LockboxClient.create_access_request` + + :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_access_request(create_access_request_details, **operation_kwargs) + if not wait_for_states: + return operation_result + + lowered_wait_for_states = [w.lower() for w in wait_for_states] + 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_approval_template_and_wait_for_state(self, create_approval_template_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.lockbox.LockboxClient.create_approval_template` and waits for the :py:class:`~oci.lockbox.models.ApprovalTemplate` acted upon + to enter the given state(s). + + :param oci.lockbox.models.CreateApprovalTemplateDetails create_approval_template_details: (required) + Details for the new approval template. + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.lockbox.models.ApprovalTemplate.lifecycle_state` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.lockbox.LockboxClient.create_approval_template` + + :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_approval_template(create_approval_template_details, **operation_kwargs) + if not wait_for_states: + return operation_result + + lowered_wait_for_states = [w.lower() for w in wait_for_states] + wait_for_resource_id = operation_result.data.id + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_approval_template(wait_for_resource_id), + 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 Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + + def create_lockbox_and_wait_for_state(self, create_lockbox_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.lockbox.LockboxClient.create_lockbox` and waits for the :py:class:`~oci.lockbox.models.Lockbox` acted upon + to enter the given state(s). + + :param oci.lockbox.models.CreateLockboxDetails create_lockbox_details: (required) + Details for the new Lockbox. + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.lockbox.models.Lockbox.lifecycle_state` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.lockbox.LockboxClient.create_lockbox` + + :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_lockbox(create_lockbox_details, **operation_kwargs) + if not wait_for_states: + return operation_result + + lowered_wait_for_states = [w.lower() for w in wait_for_states] + wait_for_resource_id = operation_result.data.id + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_lockbox(wait_for_resource_id), + 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 Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + + def delete_approval_template_and_wait_for_state(self, approval_template_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.lockbox.LockboxClient.delete_approval_template` and waits for the :py:class:`~oci.lockbox.models.ApprovalTemplate` acted upon + to enter the given state(s). + + :param str approval_template_id: (required) + The unique identifier (OCID) of the approval template. + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.lockbox.models.ApprovalTemplate.lifecycle_state` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.lockbox.LockboxClient.delete_approval_template` + + :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_approval_template(approval_template_id) + operation_result = None + try: + operation_result = self.client.delete_approval_template(approval_template_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: + waiter_result = oci.wait_until( + self.client, + initial_get_result, + evaluate_response=lambda r: getattr(r.data, 'lifecycle_state') and getattr(r.data, 'lifecycle_state').lower() in lowered_wait_for_states, + succeed_on_not_found=True, + **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_lockbox_and_wait_for_state(self, lockbox_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.lockbox.LockboxClient.delete_lockbox` and waits for the :py:class:`~oci.lockbox.models.Lockbox` acted upon + to enter the given state(s). + + :param str lockbox_id: (required) + unique Lockbox identifier + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.lockbox.models.Lockbox.lifecycle_state` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.lockbox.LockboxClient.delete_lockbox` + + :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_lockbox(lockbox_id) + operation_result = None + try: + operation_result = self.client.delete_lockbox(lockbox_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: + waiter_result = oci.wait_until( + self.client, + initial_get_result, + evaluate_response=lambda r: getattr(r.data, 'lifecycle_state') and getattr(r.data, 'lifecycle_state').lower() in lowered_wait_for_states, + succeed_on_not_found=True, + **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 handle_access_request_and_wait_for_state(self, access_request_id, handle_access_request_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.lockbox.LockboxClient.handle_access_request` and waits for the :py:class:`~oci.lockbox.models.WorkRequest` + to enter the given state(s). + + :param str access_request_id: (required) + The unique identifier (OCID) of the access request. + + :param oci.lockbox.models.HandleAccessRequestDetails handle_access_request_details: (required) + The details of handling access request + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.lockbox.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.lockbox.LockboxClient.handle_access_request` + + :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.handle_access_request(access_request_id, handle_access_request_details, **operation_kwargs) + if not wait_for_states: + return operation_result + + lowered_wait_for_states = [w.lower() for w in wait_for_states] + 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_approval_template_and_wait_for_state(self, approval_template_id, update_approval_template_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.lockbox.LockboxClient.update_approval_template` and waits for the :py:class:`~oci.lockbox.models.ApprovalTemplate` acted upon + to enter the given state(s). + + :param str approval_template_id: (required) + The unique identifier (OCID) of the approval template. + + :param oci.lockbox.models.UpdateApprovalTemplateDetails update_approval_template_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.lockbox.models.ApprovalTemplate.lifecycle_state` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.lockbox.LockboxClient.update_approval_template` + + :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_approval_template(approval_template_id, update_approval_template_details, **operation_kwargs) + if not wait_for_states: + return operation_result + + lowered_wait_for_states = [w.lower() for w in wait_for_states] + wait_for_resource_id = operation_result.data.id + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_approval_template(wait_for_resource_id), + 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 Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + + def update_lockbox_and_wait_for_state(self, lockbox_id, update_lockbox_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.lockbox.LockboxClient.update_lockbox` and waits for the :py:class:`~oci.lockbox.models.Lockbox` acted upon + to enter the given state(s). + + :param str lockbox_id: (required) + unique Lockbox identifier + + :param oci.lockbox.models.UpdateLockboxDetails update_lockbox_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.lockbox.models.Lockbox.lifecycle_state` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.lockbox.LockboxClient.update_lockbox` + + :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_lockbox(lockbox_id, update_lockbox_details, **operation_kwargs) + if not wait_for_states: + return operation_result + + lowered_wait_for_states = [w.lower() for w in wait_for_states] + wait_for_resource_id = operation_result.data.id + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_lockbox(wait_for_resource_id), + 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 Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) diff --git a/src/oci/lockbox/models/__init__.py b/src/oci/lockbox/models/__init__.py new file mode 100644 index 0000000000..8d3d2f911e --- /dev/null +++ b/src/oci/lockbox/models/__init__.py @@ -0,0 +1,72 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from __future__ import absolute_import + +from .access_context_attribute import AccessContextAttribute +from .access_context_attribute_collection import AccessContextAttributeCollection +from .access_materials import AccessMaterials +from .access_request import AccessRequest +from .access_request_collection import AccessRequestCollection +from .access_request_summary import AccessRequestSummary +from .activity_log import ActivityLog +from .approval_template import ApprovalTemplate +from .approval_template_collection import ApprovalTemplateCollection +from .approval_template_summary import ApprovalTemplateSummary +from .approver_info import ApproverInfo +from .approver_levels import ApproverLevels +from .change_approval_template_compartment_details import ChangeApprovalTemplateCompartmentDetails +from .change_lockbox_compartment_details import ChangeLockboxCompartmentDetails +from .create_access_request_details import CreateAccessRequestDetails +from .create_approval_template_details import CreateApprovalTemplateDetails +from .create_lockbox_details import CreateLockboxDetails +from .handle_access_request_details import HandleAccessRequestDetails +from .lockbox import Lockbox +from .lockbox_collection import LockboxCollection +from .lockbox_summary import LockboxSummary +from .update_approval_template_details import UpdateApprovalTemplateDetails +from .update_lockbox_details import UpdateLockboxDetails +from .work_request import WorkRequest +from .work_request_error import WorkRequestError +from .work_request_error_collection import WorkRequestErrorCollection +from .work_request_log_entry import WorkRequestLogEntry +from .work_request_log_entry_collection import WorkRequestLogEntryCollection +from .work_request_resource import WorkRequestResource +from .work_request_summary import WorkRequestSummary +from .work_request_summary_collection import WorkRequestSummaryCollection + +# Maps type names to classes for lockbox services. +lockbox_type_mapping = { + "AccessContextAttribute": AccessContextAttribute, + "AccessContextAttributeCollection": AccessContextAttributeCollection, + "AccessMaterials": AccessMaterials, + "AccessRequest": AccessRequest, + "AccessRequestCollection": AccessRequestCollection, + "AccessRequestSummary": AccessRequestSummary, + "ActivityLog": ActivityLog, + "ApprovalTemplate": ApprovalTemplate, + "ApprovalTemplateCollection": ApprovalTemplateCollection, + "ApprovalTemplateSummary": ApprovalTemplateSummary, + "ApproverInfo": ApproverInfo, + "ApproverLevels": ApproverLevels, + "ChangeApprovalTemplateCompartmentDetails": ChangeApprovalTemplateCompartmentDetails, + "ChangeLockboxCompartmentDetails": ChangeLockboxCompartmentDetails, + "CreateAccessRequestDetails": CreateAccessRequestDetails, + "CreateApprovalTemplateDetails": CreateApprovalTemplateDetails, + "CreateLockboxDetails": CreateLockboxDetails, + "HandleAccessRequestDetails": HandleAccessRequestDetails, + "Lockbox": Lockbox, + "LockboxCollection": LockboxCollection, + "LockboxSummary": LockboxSummary, + "UpdateApprovalTemplateDetails": UpdateApprovalTemplateDetails, + "UpdateLockboxDetails": UpdateLockboxDetails, + "WorkRequest": WorkRequest, + "WorkRequestError": WorkRequestError, + "WorkRequestErrorCollection": WorkRequestErrorCollection, + "WorkRequestLogEntry": WorkRequestLogEntry, + "WorkRequestLogEntryCollection": WorkRequestLogEntryCollection, + "WorkRequestResource": WorkRequestResource, + "WorkRequestSummary": WorkRequestSummary, + "WorkRequestSummaryCollection": WorkRequestSummaryCollection +} diff --git a/src/oci/lockbox/models/access_context_attribute.py b/src/oci/lockbox/models/access_context_attribute.py new file mode 100644 index 0000000000..e28caa78a7 --- /dev/null +++ b/src/oci/lockbox/models/access_context_attribute.py @@ -0,0 +1,132 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 AccessContextAttribute(object): + """ + Defined by partner while creating a lockbox. These attributes provides context for creating access request + """ + + def __init__(self, **kwargs): + """ + Initializes a new AccessContextAttribute 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 AccessContextAttribute. + :type name: str + + :param description: + The value to assign to the description property of this AccessContextAttribute. + :type description: str + + :param default_value: + The value to assign to the default_value property of this AccessContextAttribute. + :type default_value: str + + """ + self.swagger_types = { + 'name': 'str', + 'description': 'str', + 'default_value': 'str' + } + + self.attribute_map = { + 'name': 'name', + 'description': 'description', + 'default_value': 'defaultValue' + } + + self._name = None + self._description = None + self._default_value = None + + @property + def name(self): + """ + **[Required]** Gets the name of this AccessContextAttribute. + The name of the context attribute + + + :return: The name of this AccessContextAttribute. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this AccessContextAttribute. + The name of the context attribute + + + :param name: The name of this AccessContextAttribute. + :type: str + """ + self._name = name + + @property + def description(self): + """ + Gets the description of this AccessContextAttribute. + The description of the context attribute + + + :return: The description of this AccessContextAttribute. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this AccessContextAttribute. + The description of the context attribute + + + :param description: The description of this AccessContextAttribute. + :type: str + """ + self._description = description + + @property + def default_value(self): + """ + Gets the default_value of this AccessContextAttribute. + An optional default value used when access request context value is not provided + + + :return: The default_value of this AccessContextAttribute. + :rtype: str + """ + return self._default_value + + @default_value.setter + def default_value(self, default_value): + """ + Sets the default_value of this AccessContextAttribute. + An optional default value used when access request context value is not provided + + + :param default_value: The default_value of this AccessContextAttribute. + :type: str + """ + self._default_value = default_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/lockbox/models/access_context_attribute_collection.py b/src/oci/lockbox/models/access_context_attribute_collection.py new file mode 100644 index 0000000000..e6dbffa71c --- /dev/null +++ b/src/oci/lockbox/models/access_context_attribute_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 AccessContextAttributeCollection(object): + """ + Contains context attribute entries defined while creating or updating a lockbox. + """ + + def __init__(self, **kwargs): + """ + Initializes a new AccessContextAttributeCollection 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 AccessContextAttributeCollection. + :type items: list[oci.lockbox.models.AccessContextAttribute] + + """ + self.swagger_types = { + 'items': 'list[AccessContextAttribute]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this AccessContextAttributeCollection. + List of context attributes. + + + :return: The items of this AccessContextAttributeCollection. + :rtype: list[oci.lockbox.models.AccessContextAttribute] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this AccessContextAttributeCollection. + List of context attributes. + + + :param items: The items of this AccessContextAttributeCollection. + :type: list[oci.lockbox.models.AccessContextAttribute] + """ + 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/lockbox/models/access_materials.py b/src/oci/lockbox/models/access_materials.py new file mode 100644 index 0000000000..7e6b670181 --- /dev/null +++ b/src/oci/lockbox/models/access_materials.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 AccessMaterials(object): + """ + Access materials details. + """ + + def __init__(self, **kwargs): + """ + Initializes a new AccessMaterials object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param details: + The value to assign to the details property of this AccessMaterials. + :type details: dict(str, str) + + """ + self.swagger_types = { + 'details': 'dict(str, str)' + } + + self.attribute_map = { + 'details': 'details' + } + + self._details = None + + @property + def details(self): + """ + **[Required]** Gets the details of this AccessMaterials. + The contents of the material. This is a map that contains the various fields needed for access. + + + :return: The details of this AccessMaterials. + :rtype: dict(str, str) + """ + return self._details + + @details.setter + def details(self, details): + """ + Sets the details of this AccessMaterials. + The contents of the material. This is a map that contains the various fields needed for access. + + + :param details: The details of this AccessMaterials. + :type: dict(str, str) + """ + self._details = 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/lockbox/models/access_request.py b/src/oci/lockbox/models/access_request.py new file mode 100644 index 0000000000..08065b2c75 --- /dev/null +++ b/src/oci/lockbox/models/access_request.py @@ -0,0 +1,537 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 AccessRequest(object): + """ + An access request to a customer's resource. + An access request is a subsidiary resource of the Lockbox entity. + """ + + #: A constant which can be used with the lifecycle_state property of a AccessRequest. + #: This constant has a value of "IN_PROGRESS" + LIFECYCLE_STATE_IN_PROGRESS = "IN_PROGRESS" + + #: A constant which can be used with the lifecycle_state property of a AccessRequest. + #: This constant has a value of "WAITING" + LIFECYCLE_STATE_WAITING = "WAITING" + + #: A constant which can be used with the lifecycle_state property of a AccessRequest. + #: This constant has a value of "SUCCEEDED" + LIFECYCLE_STATE_SUCCEEDED = "SUCCEEDED" + + #: A constant which can be used with the lifecycle_state property of a AccessRequest. + #: This constant has a value of "CANCELING" + LIFECYCLE_STATE_CANCELING = "CANCELING" + + #: A constant which can be used with the lifecycle_state property of a AccessRequest. + #: This constant has a value of "CANCELED" + LIFECYCLE_STATE_CANCELED = "CANCELED" + + #: A constant which can be used with the lifecycle_state property of a AccessRequest. + #: This constant has a value of "FAILED" + LIFECYCLE_STATE_FAILED = "FAILED" + + #: A constant which can be used with the lifecycle_state_details property of a AccessRequest. + #: This constant has a value of "PROCESSING" + LIFECYCLE_STATE_DETAILS_PROCESSING = "PROCESSING" + + #: A constant which can be used with the lifecycle_state_details property of a AccessRequest. + #: This constant has a value of "WAITING_FOR_APPROVALS" + LIFECYCLE_STATE_DETAILS_WAITING_FOR_APPROVALS = "WAITING_FOR_APPROVALS" + + #: A constant which can be used with the lifecycle_state_details property of a AccessRequest. + #: This constant has a value of "APPROVED" + LIFECYCLE_STATE_DETAILS_APPROVED = "APPROVED" + + #: A constant which can be used with the lifecycle_state_details property of a AccessRequest. + #: This constant has a value of "AUTO_APPROVED" + LIFECYCLE_STATE_DETAILS_AUTO_APPROVED = "AUTO_APPROVED" + + #: A constant which can be used with the lifecycle_state_details property of a AccessRequest. + #: This constant has a value of "CANCELLING_ACCESS" + LIFECYCLE_STATE_DETAILS_CANCELLING_ACCESS = "CANCELLING_ACCESS" + + #: A constant which can be used with the lifecycle_state_details property of a AccessRequest. + #: This constant has a value of "EXPIRED" + LIFECYCLE_STATE_DETAILS_EXPIRED = "EXPIRED" + + #: A constant which can be used with the lifecycle_state_details property of a AccessRequest. + #: This constant has a value of "REVOKED" + LIFECYCLE_STATE_DETAILS_REVOKED = "REVOKED" + + #: A constant which can be used with the lifecycle_state_details property of a AccessRequest. + #: This constant has a value of "DENIED" + LIFECYCLE_STATE_DETAILS_DENIED = "DENIED" + + #: A constant which can be used with the lifecycle_state_details property of a AccessRequest. + #: This constant has a value of "ERROR" + LIFECYCLE_STATE_DETAILS_ERROR = "ERROR" + + def __init__(self, **kwargs): + """ + Initializes a new AccessRequest 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 AccessRequest. + :type id: str + + :param lockbox_id: + The value to assign to the lockbox_id property of this AccessRequest. + :type lockbox_id: str + + :param display_name: + The value to assign to the display_name property of this AccessRequest. + :type display_name: str + + :param description: + The value to assign to the description property of this AccessRequest. + :type description: str + + :param requestor_id: + The value to assign to the requestor_id property of this AccessRequest. + :type requestor_id: str + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this AccessRequest. + Allowed values for this property are: "IN_PROGRESS", "WAITING", "SUCCEEDED", "CANCELING", "CANCELED", "FAILED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type lifecycle_state: str + + :param lifecycle_state_details: + The value to assign to the lifecycle_state_details property of this AccessRequest. + Allowed values for this property are: "PROCESSING", "WAITING_FOR_APPROVALS", "APPROVED", "AUTO_APPROVED", "CANCELLING_ACCESS", "EXPIRED", "REVOKED", "DENIED", "ERROR", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type lifecycle_state_details: str + + :param access_duration: + The value to assign to the access_duration property of this AccessRequest. + :type access_duration: str + + :param context: + The value to assign to the context property of this AccessRequest. + :type context: dict(str, str) + + :param activity_logs: + The value to assign to the activity_logs property of this AccessRequest. + :type activity_logs: list[oci.lockbox.models.ActivityLog] + + :param time_created: + The value to assign to the time_created property of this AccessRequest. + :type time_created: datetime + + :param time_updated: + The value to assign to the time_updated property of this AccessRequest. + :type time_updated: datetime + + :param time_expired: + The value to assign to the time_expired property of this AccessRequest. + :type time_expired: datetime + + """ + self.swagger_types = { + 'id': 'str', + 'lockbox_id': 'str', + 'display_name': 'str', + 'description': 'str', + 'requestor_id': 'str', + 'lifecycle_state': 'str', + 'lifecycle_state_details': 'str', + 'access_duration': 'str', + 'context': 'dict(str, str)', + 'activity_logs': 'list[ActivityLog]', + 'time_created': 'datetime', + 'time_updated': 'datetime', + 'time_expired': 'datetime' + } + + self.attribute_map = { + 'id': 'id', + 'lockbox_id': 'lockboxId', + 'display_name': 'displayName', + 'description': 'description', + 'requestor_id': 'requestorId', + 'lifecycle_state': 'lifecycleState', + 'lifecycle_state_details': 'lifecycleStateDetails', + 'access_duration': 'accessDuration', + 'context': 'context', + 'activity_logs': 'activityLogs', + 'time_created': 'timeCreated', + 'time_updated': 'timeUpdated', + 'time_expired': 'timeExpired' + } + + self._id = None + self._lockbox_id = None + self._display_name = None + self._description = None + self._requestor_id = None + self._lifecycle_state = None + self._lifecycle_state_details = None + self._access_duration = None + self._context = None + self._activity_logs = None + self._time_created = None + self._time_updated = None + self._time_expired = None + + @property + def id(self): + """ + **[Required]** Gets the id of this AccessRequest. + The unique identifier (OCID) of the access request, which can't be changed after creation. + + + :return: The id of this AccessRequest. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this AccessRequest. + The unique identifier (OCID) of the access request, which can't be changed after creation. + + + :param id: The id of this AccessRequest. + :type: str + """ + self._id = id + + @property + def lockbox_id(self): + """ + **[Required]** Gets the lockbox_id of this AccessRequest. + The unique identifier (OCID) of the lockbox box that the access request is associated with, which can't be changed after creation. + + + :return: The lockbox_id of this AccessRequest. + :rtype: str + """ + return self._lockbox_id + + @lockbox_id.setter + def lockbox_id(self, lockbox_id): + """ + Sets the lockbox_id of this AccessRequest. + The unique identifier (OCID) of the lockbox box that the access request is associated with, which can't be changed after creation. + + + :param lockbox_id: The lockbox_id of this AccessRequest. + :type: str + """ + self._lockbox_id = lockbox_id + + @property + def display_name(self): + """ + **[Required]** Gets the display_name of this AccessRequest. + The name of the access request. + + + :return: The display_name of this AccessRequest. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this AccessRequest. + The name of the access request. + + + :param display_name: The display_name of this AccessRequest. + :type: str + """ + self._display_name = display_name + + @property + def description(self): + """ + **[Required]** Gets the description of this AccessRequest. + The rationale for requesting the access request and any other related details.. + + + :return: The description of this AccessRequest. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this AccessRequest. + The rationale for requesting the access request and any other related details.. + + + :param description: The description of this AccessRequest. + :type: str + """ + self._description = description + + @property + def requestor_id(self): + """ + **[Required]** Gets the requestor_id of this AccessRequest. + The unique identifier of the requestor. + + + :return: The requestor_id of this AccessRequest. + :rtype: str + """ + return self._requestor_id + + @requestor_id.setter + def requestor_id(self, requestor_id): + """ + Sets the requestor_id of this AccessRequest. + The unique identifier of the requestor. + + + :param requestor_id: The requestor_id of this AccessRequest. + :type: str + """ + self._requestor_id = requestor_id + + @property + def lifecycle_state(self): + """ + **[Required]** Gets the lifecycle_state of this AccessRequest. + Possible access request lifecycle states. + + Allowed values for this property are: "IN_PROGRESS", "WAITING", "SUCCEEDED", "CANCELING", "CANCELED", "FAILED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The lifecycle_state of this AccessRequest. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this AccessRequest. + Possible access request lifecycle states. + + + :param lifecycle_state: The lifecycle_state of this AccessRequest. + :type: str + """ + allowed_values = ["IN_PROGRESS", "WAITING", "SUCCEEDED", "CANCELING", "CANCELED", "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_state_details(self): + """ + **[Required]** Gets the lifecycle_state_details of this AccessRequest. + Details of access request lifecycle state. + + Allowed values for this property are: "PROCESSING", "WAITING_FOR_APPROVALS", "APPROVED", "AUTO_APPROVED", "CANCELLING_ACCESS", "EXPIRED", "REVOKED", "DENIED", "ERROR", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The lifecycle_state_details of this AccessRequest. + :rtype: str + """ + return self._lifecycle_state_details + + @lifecycle_state_details.setter + def lifecycle_state_details(self, lifecycle_state_details): + """ + Sets the lifecycle_state_details of this AccessRequest. + Details of access request lifecycle state. + + + :param lifecycle_state_details: The lifecycle_state_details of this AccessRequest. + :type: str + """ + allowed_values = ["PROCESSING", "WAITING_FOR_APPROVALS", "APPROVED", "AUTO_APPROVED", "CANCELLING_ACCESS", "EXPIRED", "REVOKED", "DENIED", "ERROR"] + if not value_allowed_none_or_none_sentinel(lifecycle_state_details, allowed_values): + lifecycle_state_details = 'UNKNOWN_ENUM_VALUE' + self._lifecycle_state_details = lifecycle_state_details + + @property + def access_duration(self): + """ + **[Required]** Gets the access_duration of this AccessRequest. + The maximum amount of time operator has access to associated resources. + + + :return: The access_duration of this AccessRequest. + :rtype: str + """ + return self._access_duration + + @access_duration.setter + def access_duration(self, access_duration): + """ + Sets the access_duration of this AccessRequest. + The maximum amount of time operator has access to associated resources. + + + :param access_duration: The access_duration of this AccessRequest. + :type: str + """ + self._access_duration = access_duration + + @property + def context(self): + """ + Gets the context of this AccessRequest. + The context object containing the access request specific details. + + + :return: The context of this AccessRequest. + :rtype: dict(str, str) + """ + return self._context + + @context.setter + def context(self, context): + """ + Sets the context of this AccessRequest. + The context object containing the access request specific details. + + + :param context: The context of this AccessRequest. + :type: dict(str, str) + """ + self._context = context + + @property + def activity_logs(self): + """ + **[Required]** Gets the activity_logs of this AccessRequest. + The actions taken by different persona on the access request, e.g. approve/deny/revoke + + + :return: The activity_logs of this AccessRequest. + :rtype: list[oci.lockbox.models.ActivityLog] + """ + return self._activity_logs + + @activity_logs.setter + def activity_logs(self, activity_logs): + """ + Sets the activity_logs of this AccessRequest. + The actions taken by different persona on the access request, e.g. approve/deny/revoke + + + :param activity_logs: The activity_logs of this AccessRequest. + :type: list[oci.lockbox.models.ActivityLog] + """ + self._activity_logs = activity_logs + + @property + def time_created(self): + """ + **[Required]** Gets the time_created of this AccessRequest. + The time the access request was created. Format is defined by `RFC3339`__. + Example: `2020-01-25T21:10:29.600Z` + + __ https://tools.ietf.org/html/rfc3339 + + + :return: The time_created of this AccessRequest. + :rtype: datetime + """ + return self._time_created + + @time_created.setter + def time_created(self, time_created): + """ + Sets the time_created of this AccessRequest. + The time the access request was created. Format is defined by `RFC3339`__. + Example: `2020-01-25T21:10:29.600Z` + + __ https://tools.ietf.org/html/rfc3339 + + + :param time_created: The time_created of this AccessRequest. + :type: datetime + """ + self._time_created = time_created + + @property + def time_updated(self): + """ + **[Required]** Gets the time_updated of this AccessRequest. + The time the access request was last updated. Format is defined by `RFC3339`__. + Example: `2020-01-25T21:10:29.600Z` + + __ https://tools.ietf.org/html/rfc3339 + + + :return: The time_updated of this AccessRequest. + :rtype: datetime + """ + return self._time_updated + + @time_updated.setter + def time_updated(self, time_updated): + """ + Sets the time_updated of this AccessRequest. + The time the access request was last updated. Format is defined by `RFC3339`__. + Example: `2020-01-25T21:10:29.600Z` + + __ https://tools.ietf.org/html/rfc3339 + + + :param time_updated: The time_updated of this AccessRequest. + :type: datetime + """ + self._time_updated = time_updated + + @property + def time_expired(self): + """ + **[Required]** Gets the time_expired of this AccessRequest. + The time the access request expired. Format is defined by `RFC3339`__. + Example: `2020-01-25T21:10:29.600Z` + + __ https://tools.ietf.org/html/rfc3339 + + + :return: The time_expired of this AccessRequest. + :rtype: datetime + """ + return self._time_expired + + @time_expired.setter + def time_expired(self, time_expired): + """ + Sets the time_expired of this AccessRequest. + The time the access request expired. Format is defined by `RFC3339`__. + Example: `2020-01-25T21:10:29.600Z` + + __ https://tools.ietf.org/html/rfc3339 + + + :param time_expired: The time_expired of this AccessRequest. + :type: datetime + """ + self._time_expired = time_expired + + 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/lockbox/models/access_request_collection.py b/src/oci/lockbox/models/access_request_collection.py new file mode 100644 index 0000000000..d7edc06341 --- /dev/null +++ b/src/oci/lockbox/models/access_request_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 AccessRequestCollection(object): + """ + Results of access request search. Contains both AccessRequestSummary items and other information, such as metadata. + """ + + def __init__(self, **kwargs): + """ + Initializes a new AccessRequestCollection 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 AccessRequestCollection. + :type items: list[oci.lockbox.models.AccessRequestSummary] + + """ + self.swagger_types = { + 'items': 'list[AccessRequestSummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this AccessRequestCollection. + List of AccessRequestSummary. + + + :return: The items of this AccessRequestCollection. + :rtype: list[oci.lockbox.models.AccessRequestSummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this AccessRequestCollection. + List of AccessRequestSummary. + + + :param items: The items of this AccessRequestCollection. + :type: list[oci.lockbox.models.AccessRequestSummary] + """ + 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/lockbox/models/access_request_summary.py b/src/oci/lockbox/models/access_request_summary.py new file mode 100644 index 0000000000..296c854e5e --- /dev/null +++ b/src/oci/lockbox/models/access_request_summary.py @@ -0,0 +1,367 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 AccessRequestSummary(object): + """ + Summary information for an access request. + """ + + def __init__(self, **kwargs): + """ + Initializes a new AccessRequestSummary 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 AccessRequestSummary. + :type id: str + + :param lockbox_id: + The value to assign to the lockbox_id property of this AccessRequestSummary. + :type lockbox_id: str + + :param display_name: + The value to assign to the display_name property of this AccessRequestSummary. + :type display_name: str + + :param description: + The value to assign to the description property of this AccessRequestSummary. + :type description: str + + :param requestor_id: + The value to assign to the requestor_id property of this AccessRequestSummary. + :type requestor_id: str + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this AccessRequestSummary. + :type lifecycle_state: str + + :param access_duration: + The value to assign to the access_duration property of this AccessRequestSummary. + :type access_duration: str + + :param time_created: + The value to assign to the time_created property of this AccessRequestSummary. + :type time_created: datetime + + :param time_updated: + The value to assign to the time_updated property of this AccessRequestSummary. + :type time_updated: datetime + + :param time_expired: + The value to assign to the time_expired property of this AccessRequestSummary. + :type time_expired: datetime + + """ + self.swagger_types = { + 'id': 'str', + 'lockbox_id': 'str', + 'display_name': 'str', + 'description': 'str', + 'requestor_id': 'str', + 'lifecycle_state': 'str', + 'access_duration': 'str', + 'time_created': 'datetime', + 'time_updated': 'datetime', + 'time_expired': 'datetime' + } + + self.attribute_map = { + 'id': 'id', + 'lockbox_id': 'lockboxId', + 'display_name': 'displayName', + 'description': 'description', + 'requestor_id': 'requestorId', + 'lifecycle_state': 'lifecycleState', + 'access_duration': 'accessDuration', + 'time_created': 'timeCreated', + 'time_updated': 'timeUpdated', + 'time_expired': 'timeExpired' + } + + self._id = None + self._lockbox_id = None + self._display_name = None + self._description = None + self._requestor_id = None + self._lifecycle_state = None + self._access_duration = None + self._time_created = None + self._time_updated = None + self._time_expired = None + + @property + def id(self): + """ + **[Required]** Gets the id of this AccessRequestSummary. + The unique identifier (OCID) of the access request, which can't be changed after creation. + + + :return: The id of this AccessRequestSummary. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this AccessRequestSummary. + The unique identifier (OCID) of the access request, which can't be changed after creation. + + + :param id: The id of this AccessRequestSummary. + :type: str + """ + self._id = id + + @property + def lockbox_id(self): + """ + **[Required]** Gets the lockbox_id of this AccessRequestSummary. + The unique identifier (OCID) of the lockbox box that the access request is associated with, which can't be changed after creation. + + + :return: The lockbox_id of this AccessRequestSummary. + :rtype: str + """ + return self._lockbox_id + + @lockbox_id.setter + def lockbox_id(self, lockbox_id): + """ + Sets the lockbox_id of this AccessRequestSummary. + The unique identifier (OCID) of the lockbox box that the access request is associated with, which can't be changed after creation. + + + :param lockbox_id: The lockbox_id of this AccessRequestSummary. + :type: str + """ + self._lockbox_id = lockbox_id + + @property + def display_name(self): + """ + **[Required]** Gets the display_name of this AccessRequestSummary. + The name of the access request. + + + :return: The display_name of this AccessRequestSummary. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this AccessRequestSummary. + The name of the access request. + + + :param display_name: The display_name of this AccessRequestSummary. + :type: str + """ + self._display_name = display_name + + @property + def description(self): + """ + **[Required]** Gets the description of this AccessRequestSummary. + The rationale for requesting the access request. + + + :return: The description of this AccessRequestSummary. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this AccessRequestSummary. + The rationale for requesting the access request. + + + :param description: The description of this AccessRequestSummary. + :type: str + """ + self._description = description + + @property + def requestor_id(self): + """ + **[Required]** Gets the requestor_id of this AccessRequestSummary. + The unique identifier of the requestor. + + + :return: The requestor_id of this AccessRequestSummary. + :rtype: str + """ + return self._requestor_id + + @requestor_id.setter + def requestor_id(self, requestor_id): + """ + Sets the requestor_id of this AccessRequestSummary. + The unique identifier of the requestor. + + + :param requestor_id: The requestor_id of this AccessRequestSummary. + :type: str + """ + self._requestor_id = requestor_id + + @property + def lifecycle_state(self): + """ + **[Required]** Gets the lifecycle_state of this AccessRequestSummary. + The current state of the access request. + + + :return: The lifecycle_state of this AccessRequestSummary. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this AccessRequestSummary. + The current state of the access request. + + + :param lifecycle_state: The lifecycle_state of this AccessRequestSummary. + :type: str + """ + self._lifecycle_state = lifecycle_state + + @property + def access_duration(self): + """ + Gets the access_duration of this AccessRequestSummary. + The maximum amount of time operator has access to associated resources. + + + :return: The access_duration of this AccessRequestSummary. + :rtype: str + """ + return self._access_duration + + @access_duration.setter + def access_duration(self, access_duration): + """ + Sets the access_duration of this AccessRequestSummary. + The maximum amount of time operator has access to associated resources. + + + :param access_duration: The access_duration of this AccessRequestSummary. + :type: str + """ + self._access_duration = access_duration + + @property + def time_created(self): + """ + **[Required]** Gets the time_created of this AccessRequestSummary. + The time the access request was created. Format is defined by `RFC3339`__. + Example: `2020-01-25T21:10:29.600Z` + + __ https://tools.ietf.org/html/rfc3339 + + + :return: The time_created of this AccessRequestSummary. + :rtype: datetime + """ + return self._time_created + + @time_created.setter + def time_created(self, time_created): + """ + Sets the time_created of this AccessRequestSummary. + The time the access request was created. Format is defined by `RFC3339`__. + Example: `2020-01-25T21:10:29.600Z` + + __ https://tools.ietf.org/html/rfc3339 + + + :param time_created: The time_created of this AccessRequestSummary. + :type: datetime + """ + self._time_created = time_created + + @property + def time_updated(self): + """ + **[Required]** Gets the time_updated of this AccessRequestSummary. + The time the access request was last updated. Format is defined by `RFC3339`__. + Example: `2020-01-25T21:10:29.600Z` + + __ https://tools.ietf.org/html/rfc3339 + + + :return: The time_updated of this AccessRequestSummary. + :rtype: datetime + """ + return self._time_updated + + @time_updated.setter + def time_updated(self, time_updated): + """ + Sets the time_updated of this AccessRequestSummary. + The time the access request was last updated. Format is defined by `RFC3339`__. + Example: `2020-01-25T21:10:29.600Z` + + __ https://tools.ietf.org/html/rfc3339 + + + :param time_updated: The time_updated of this AccessRequestSummary. + :type: datetime + """ + self._time_updated = time_updated + + @property + def time_expired(self): + """ + **[Required]** Gets the time_expired of this AccessRequestSummary. + The time the access request expired. Format is defined by `RFC3339`__. + Example: `2020-01-25T21:10:29.600Z` + + __ https://tools.ietf.org/html/rfc3339 + + + :return: The time_expired of this AccessRequestSummary. + :rtype: datetime + """ + return self._time_expired + + @time_expired.setter + def time_expired(self, time_expired): + """ + Sets the time_expired of this AccessRequestSummary. + The time the access request expired. Format is defined by `RFC3339`__. + Example: `2020-01-25T21:10:29.600Z` + + __ https://tools.ietf.org/html/rfc3339 + + + :param time_expired: The time_expired of this AccessRequestSummary. + :type: datetime + """ + self._time_expired = time_expired + + 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/lockbox/models/activity_log.py b/src/oci/lockbox/models/activity_log.py new file mode 100644 index 0000000000..c11eeda52d --- /dev/null +++ b/src/oci/lockbox/models/activity_log.py @@ -0,0 +1,252 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 ActivityLog(object): + """ + The log of the action taken by different persona on the access request, e.g. approve/deny/revoke + """ + + #: A constant which can be used with the user_level property of a ActivityLog. + #: This constant has a value of "LEVEL1" + USER_LEVEL_LEVEL1 = "LEVEL1" + + #: A constant which can be used with the user_level property of a ActivityLog. + #: This constant has a value of "LEVEL2" + USER_LEVEL_LEVEL2 = "LEVEL2" + + #: A constant which can be used with the user_level property of a ActivityLog. + #: This constant has a value of "LEVEL3" + USER_LEVEL_LEVEL3 = "LEVEL3" + + #: A constant which can be used with the user_level property of a ActivityLog. + #: This constant has a value of "ADMIN" + USER_LEVEL_ADMIN = "ADMIN" + + #: A constant which can be used with the user_level property of a ActivityLog. + #: This constant has a value of "OPERATOR" + USER_LEVEL_OPERATOR = "OPERATOR" + + #: A constant which can be used with the action property of a ActivityLog. + #: This constant has a value of "APPROVE" + ACTION_APPROVE = "APPROVE" + + #: A constant which can be used with the action property of a ActivityLog. + #: This constant has a value of "DENY" + ACTION_DENY = "DENY" + + #: A constant which can be used with the action property of a ActivityLog. + #: This constant has a value of "REVOKE" + ACTION_REVOKE = "REVOKE" + + #: A constant which can be used with the action property of a ActivityLog. + #: This constant has a value of "CANCEL" + ACTION_CANCEL = "CANCEL" + + def __init__(self, **kwargs): + """ + Initializes a new ActivityLog object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param user_id: + The value to assign to the user_id property of this ActivityLog. + :type user_id: str + + :param user_level: + The value to assign to the user_level property of this ActivityLog. + Allowed values for this property are: "LEVEL1", "LEVEL2", "LEVEL3", "ADMIN", "OPERATOR", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type user_level: str + + :param action: + The value to assign to the action property of this ActivityLog. + Allowed values for this property are: "APPROVE", "DENY", "REVOKE", "CANCEL", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type action: str + + :param message: + The value to assign to the message property of this ActivityLog. + :type message: str + + :param time_updated: + The value to assign to the time_updated property of this ActivityLog. + :type time_updated: datetime + + """ + self.swagger_types = { + 'user_id': 'str', + 'user_level': 'str', + 'action': 'str', + 'message': 'str', + 'time_updated': 'datetime' + } + + self.attribute_map = { + 'user_id': 'userId', + 'user_level': 'userLevel', + 'action': 'action', + 'message': 'message', + 'time_updated': 'timeUpdated' + } + + self._user_id = None + self._user_level = None + self._action = None + self._message = None + self._time_updated = None + + @property + def user_id(self): + """ + Gets the user_id of this ActivityLog. + User OCID of the persona + + + :return: The user_id of this ActivityLog. + :rtype: str + """ + return self._user_id + + @user_id.setter + def user_id(self, user_id): + """ + Sets the user_id of this ActivityLog. + User OCID of the persona + + + :param user_id: The user_id of this ActivityLog. + :type: str + """ + self._user_id = user_id + + @property + def user_level(self): + """ + Gets the user_level of this ActivityLog. + Level of the persona + + Allowed values for this property are: "LEVEL1", "LEVEL2", "LEVEL3", "ADMIN", "OPERATOR", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The user_level of this ActivityLog. + :rtype: str + """ + return self._user_level + + @user_level.setter + def user_level(self, user_level): + """ + Sets the user_level of this ActivityLog. + Level of the persona + + + :param user_level: The user_level of this ActivityLog. + :type: str + """ + allowed_values = ["LEVEL1", "LEVEL2", "LEVEL3", "ADMIN", "OPERATOR"] + if not value_allowed_none_or_none_sentinel(user_level, allowed_values): + user_level = 'UNKNOWN_ENUM_VALUE' + self._user_level = user_level + + @property + def action(self): + """ + Gets the action of this ActivityLog. + The action take by persona + + Allowed values for this property are: "APPROVE", "DENY", "REVOKE", "CANCEL", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The action of this ActivityLog. + :rtype: str + """ + return self._action + + @action.setter + def action(self, action): + """ + Sets the action of this ActivityLog. + The action take by persona + + + :param action: The action of this ActivityLog. + :type: str + """ + allowed_values = ["APPROVE", "DENY", "REVOKE", "CANCEL"] + if not value_allowed_none_or_none_sentinel(action, allowed_values): + action = 'UNKNOWN_ENUM_VALUE' + self._action = action + + @property + def message(self): + """ + Gets the message of this ActivityLog. + The action justification or details. + + + :return: The message of this ActivityLog. + :rtype: str + """ + return self._message + + @message.setter + def message(self, message): + """ + Sets the message of this ActivityLog. + The action justification or details. + + + :param message: The message of this ActivityLog. + :type: str + """ + self._message = message + + @property + def time_updated(self): + """ + Gets the time_updated of this ActivityLog. + The time the action was taken. Format is defined by `RFC3339`__. + Example: `2020-01-25T21:10:29.600Z` + + __ https://tools.ietf.org/html/rfc3339 + + + :return: The time_updated of this ActivityLog. + :rtype: datetime + """ + return self._time_updated + + @time_updated.setter + def time_updated(self, time_updated): + """ + Sets the time_updated of this ActivityLog. + The time the action was taken. Format is defined by `RFC3339`__. + Example: `2020-01-25T21:10:29.600Z` + + __ https://tools.ietf.org/html/rfc3339 + + + :param time_updated: The time_updated of this ActivityLog. + :type: datetime + """ + self._time_updated = time_updated + + 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/lockbox/models/approval_template.py b/src/oci/lockbox/models/approval_template.py new file mode 100644 index 0000000000..b41d4a21e2 --- /dev/null +++ b/src/oci/lockbox/models/approval_template.py @@ -0,0 +1,430 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 ApprovalTemplate(object): + """ + Group/User OCIDs of those who can approve/deny/revoke operator's request to access associated resources. + """ + + #: A constant which can be used with the lifecycle_state property of a ApprovalTemplate. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a ApprovalTemplate. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + #: A constant which can be used with the lifecycle_state property of a ApprovalTemplate. + #: This constant has a value of "UPDATING" + LIFECYCLE_STATE_UPDATING = "UPDATING" + + #: A constant which can be used with the lifecycle_state property of a ApprovalTemplate. + #: This constant has a value of "DELETING" + LIFECYCLE_STATE_DELETING = "DELETING" + + #: A constant which can be used with the lifecycle_state property of a ApprovalTemplate. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" + + #: A constant which can be used with the lifecycle_state property of a ApprovalTemplate. + #: This constant has a value of "FAILED" + LIFECYCLE_STATE_FAILED = "FAILED" + + #: A constant which can be used with the auto_approval_state property of a ApprovalTemplate. + #: This constant has a value of "ENABLED" + AUTO_APPROVAL_STATE_ENABLED = "ENABLED" + + #: A constant which can be used with the auto_approval_state property of a ApprovalTemplate. + #: This constant has a value of "DISABLED" + AUTO_APPROVAL_STATE_DISABLED = "DISABLED" + + def __init__(self, **kwargs): + """ + Initializes a new ApprovalTemplate 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 ApprovalTemplate. + :type id: str + + :param display_name: + The value to assign to the display_name property of this ApprovalTemplate. + :type display_name: str + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this ApprovalTemplate. + Allowed values for this property are: "ACTIVE", "CREATING", "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 approver_levels: + The value to assign to the approver_levels property of this ApprovalTemplate. + :type approver_levels: oci.lockbox.models.ApproverLevels + + :param compartment_id: + The value to assign to the compartment_id property of this ApprovalTemplate. + :type compartment_id: str + + :param auto_approval_state: + The value to assign to the auto_approval_state property of this ApprovalTemplate. + Allowed values for this property are: "ENABLED", "DISABLED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type auto_approval_state: str + + :param time_created: + The value to assign to the time_created property of this ApprovalTemplate. + :type time_created: datetime + + :param time_updated: + The value to assign to the time_updated property of this ApprovalTemplate. + :type time_updated: datetime + + :param freeform_tags: + The value to assign to the freeform_tags property of this ApprovalTemplate. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this ApprovalTemplate. + :type defined_tags: dict(str, dict(str, object)) + + :param system_tags: + The value to assign to the system_tags property of this ApprovalTemplate. + :type system_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'id': 'str', + 'display_name': 'str', + 'lifecycle_state': 'str', + 'approver_levels': 'ApproverLevels', + 'compartment_id': 'str', + 'auto_approval_state': 'str', + 'time_created': 'datetime', + 'time_updated': 'datetime', + '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', + 'lifecycle_state': 'lifecycleState', + 'approver_levels': 'approverLevels', + 'compartment_id': 'compartmentId', + 'auto_approval_state': 'autoApprovalState', + 'time_created': 'timeCreated', + 'time_updated': 'timeUpdated', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags', + 'system_tags': 'systemTags' + } + + self._id = None + self._display_name = None + self._lifecycle_state = None + self._approver_levels = None + self._compartment_id = None + self._auto_approval_state = None + self._time_created = None + self._time_updated = None + self._freeform_tags = None + self._defined_tags = None + self._system_tags = None + + @property + def id(self): + """ + **[Required]** Gets the id of this ApprovalTemplate. + The unique identifier (OCID) of the approval template, which can't be changed after creation. + + + :return: The id of this ApprovalTemplate. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this ApprovalTemplate. + The unique identifier (OCID) of the approval template, which can't be changed after creation. + + + :param id: The id of this ApprovalTemplate. + :type: str + """ + self._id = id + + @property + def display_name(self): + """ + **[Required]** Gets the display_name of this ApprovalTemplate. + The approval template display name. + + + :return: The display_name of this ApprovalTemplate. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this ApprovalTemplate. + The approval template display name. + + + :param display_name: The display_name of this ApprovalTemplate. + :type: str + """ + self._display_name = display_name + + @property + def lifecycle_state(self): + """ + Gets the lifecycle_state of this ApprovalTemplate. + The current state of the approval template. + + Allowed values for this property are: "ACTIVE", "CREATING", "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 ApprovalTemplate. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this ApprovalTemplate. + The current state of the approval template. + + + :param lifecycle_state: The lifecycle_state of this ApprovalTemplate. + :type: str + """ + allowed_values = ["ACTIVE", "CREATING", "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 approver_levels(self): + """ + **[Required]** Gets the approver_levels of this ApprovalTemplate. + + :return: The approver_levels of this ApprovalTemplate. + :rtype: oci.lockbox.models.ApproverLevels + """ + return self._approver_levels + + @approver_levels.setter + def approver_levels(self, approver_levels): + """ + Sets the approver_levels of this ApprovalTemplate. + + :param approver_levels: The approver_levels of this ApprovalTemplate. + :type: oci.lockbox.models.ApproverLevels + """ + self._approver_levels = approver_levels + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this ApprovalTemplate. + The unique identifier (OCID) of the customer compartment where the approval template is located. + + + :return: The compartment_id of this ApprovalTemplate. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this ApprovalTemplate. + The unique identifier (OCID) of the customer compartment where the approval template is located. + + + :param compartment_id: The compartment_id of this ApprovalTemplate. + :type: str + """ + self._compartment_id = compartment_id + + @property + def auto_approval_state(self): + """ + Gets the auto_approval_state of this ApprovalTemplate. + The auto approval state of the lockbox. + + Allowed values for this property are: "ENABLED", "DISABLED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The auto_approval_state of this ApprovalTemplate. + :rtype: str + """ + return self._auto_approval_state + + @auto_approval_state.setter + def auto_approval_state(self, auto_approval_state): + """ + Sets the auto_approval_state of this ApprovalTemplate. + The auto approval state of the lockbox. + + + :param auto_approval_state: The auto_approval_state of this ApprovalTemplate. + :type: str + """ + allowed_values = ["ENABLED", "DISABLED"] + if not value_allowed_none_or_none_sentinel(auto_approval_state, allowed_values): + auto_approval_state = 'UNKNOWN_ENUM_VALUE' + self._auto_approval_state = auto_approval_state + + @property + def time_created(self): + """ + **[Required]** Gets the time_created of this ApprovalTemplate. + The time the the approval template was created. An RFC3339 formatted datetime string + + + :return: The time_created of this ApprovalTemplate. + :rtype: datetime + """ + return self._time_created + + @time_created.setter + def time_created(self, time_created): + """ + Sets the time_created of this ApprovalTemplate. + The time the the approval template was created. An RFC3339 formatted datetime string + + + :param time_created: The time_created of this ApprovalTemplate. + :type: datetime + """ + self._time_created = time_created + + @property + def time_updated(self): + """ + Gets the time_updated of this ApprovalTemplate. + The time the approval template was updated. An RFC3339 formatted datetime string + + + :return: The time_updated of this ApprovalTemplate. + :rtype: datetime + """ + return self._time_updated + + @time_updated.setter + def time_updated(self, time_updated): + """ + Sets the time_updated of this ApprovalTemplate. + The time the approval template was updated. An RFC3339 formatted datetime string + + + :param time_updated: The time_updated of this ApprovalTemplate. + :type: datetime + """ + self._time_updated = time_updated + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this ApprovalTemplate. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :return: The freeform_tags of this ApprovalTemplate. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this ApprovalTemplate. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :param freeform_tags: The freeform_tags of this ApprovalTemplate. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this ApprovalTemplate. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this ApprovalTemplate. + :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 ApprovalTemplate. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this ApprovalTemplate. + :type: dict(str, dict(str, object)) + """ + self._defined_tags = defined_tags + + @property + def system_tags(self): + """ + Gets the system_tags of this ApprovalTemplate. + 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 ApprovalTemplate. + :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 ApprovalTemplate. + 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 ApprovalTemplate. + :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/lockbox/models/approval_template_collection.py b/src/oci/lockbox/models/approval_template_collection.py new file mode 100644 index 0000000000..5aeed4eb83 --- /dev/null +++ b/src/oci/lockbox/models/approval_template_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 ApprovalTemplateCollection(object): + """ + Results of approval template search. Contains both ApprovalTemplateSummary items and other information, such as metadata. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ApprovalTemplateCollection 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 ApprovalTemplateCollection. + :type items: list[oci.lockbox.models.ApprovalTemplateSummary] + + """ + self.swagger_types = { + 'items': 'list[ApprovalTemplateSummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this ApprovalTemplateCollection. + List of ApprovalTemplateSummary. + + + :return: The items of this ApprovalTemplateCollection. + :rtype: list[oci.lockbox.models.ApprovalTemplateSummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this ApprovalTemplateCollection. + List of ApprovalTemplateSummary. + + + :param items: The items of this ApprovalTemplateCollection. + :type: list[oci.lockbox.models.ApprovalTemplateSummary] + """ + 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/lockbox/models/approval_template_summary.py b/src/oci/lockbox/models/approval_template_summary.py new file mode 100644 index 0000000000..7075febe62 --- /dev/null +++ b/src/oci/lockbox/models/approval_template_summary.py @@ -0,0 +1,398 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 ApprovalTemplateSummary(object): + """ + Summary info for an approval tmeplate. + """ + + #: A constant which can be used with the auto_approval_state property of a ApprovalTemplateSummary. + #: This constant has a value of "ENABLED" + AUTO_APPROVAL_STATE_ENABLED = "ENABLED" + + #: A constant which can be used with the auto_approval_state property of a ApprovalTemplateSummary. + #: This constant has a value of "DISABLED" + AUTO_APPROVAL_STATE_DISABLED = "DISABLED" + + def __init__(self, **kwargs): + """ + Initializes a new ApprovalTemplateSummary 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 ApprovalTemplateSummary. + :type id: str + + :param display_name: + The value to assign to the display_name property of this ApprovalTemplateSummary. + :type display_name: str + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this ApprovalTemplateSummary. + :type lifecycle_state: str + + :param approver_levels: + The value to assign to the approver_levels property of this ApprovalTemplateSummary. + :type approver_levels: oci.lockbox.models.ApproverLevels + + :param compartment_id: + The value to assign to the compartment_id property of this ApprovalTemplateSummary. + :type compartment_id: str + + :param auto_approval_state: + The value to assign to the auto_approval_state property of this ApprovalTemplateSummary. + Allowed values for this property are: "ENABLED", "DISABLED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type auto_approval_state: str + + :param time_created: + The value to assign to the time_created property of this ApprovalTemplateSummary. + :type time_created: datetime + + :param time_updated: + The value to assign to the time_updated property of this ApprovalTemplateSummary. + :type time_updated: datetime + + :param freeform_tags: + The value to assign to the freeform_tags property of this ApprovalTemplateSummary. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this ApprovalTemplateSummary. + :type defined_tags: dict(str, dict(str, object)) + + :param system_tags: + The value to assign to the system_tags property of this ApprovalTemplateSummary. + :type system_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'id': 'str', + 'display_name': 'str', + 'lifecycle_state': 'str', + 'approver_levels': 'ApproverLevels', + 'compartment_id': 'str', + 'auto_approval_state': 'str', + 'time_created': 'datetime', + 'time_updated': 'datetime', + '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', + 'lifecycle_state': 'lifecycleState', + 'approver_levels': 'approverLevels', + 'compartment_id': 'compartmentId', + 'auto_approval_state': 'autoApprovalState', + 'time_created': 'timeCreated', + 'time_updated': 'timeUpdated', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags', + 'system_tags': 'systemTags' + } + + self._id = None + self._display_name = None + self._lifecycle_state = None + self._approver_levels = None + self._compartment_id = None + self._auto_approval_state = None + self._time_created = None + self._time_updated = None + self._freeform_tags = None + self._defined_tags = None + self._system_tags = None + + @property + def id(self): + """ + **[Required]** Gets the id of this ApprovalTemplateSummary. + The unique identifier (OCID) of the approval template, which can't be changed after creation. + + + :return: The id of this ApprovalTemplateSummary. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this ApprovalTemplateSummary. + The unique identifier (OCID) of the approval template, which can't be changed after creation. + + + :param id: The id of this ApprovalTemplateSummary. + :type: str + """ + self._id = id + + @property + def display_name(self): + """ + **[Required]** Gets the display_name of this ApprovalTemplateSummary. + The approval template display name. + + + :return: The display_name of this ApprovalTemplateSummary. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this ApprovalTemplateSummary. + The approval template display name. + + + :param display_name: The display_name of this ApprovalTemplateSummary. + :type: str + """ + self._display_name = display_name + + @property + def lifecycle_state(self): + """ + Gets the lifecycle_state of this ApprovalTemplateSummary. + The current state of the approval template. + + + :return: The lifecycle_state of this ApprovalTemplateSummary. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this ApprovalTemplateSummary. + The current state of the approval template. + + + :param lifecycle_state: The lifecycle_state of this ApprovalTemplateSummary. + :type: str + """ + self._lifecycle_state = lifecycle_state + + @property + def approver_levels(self): + """ + **[Required]** Gets the approver_levels of this ApprovalTemplateSummary. + + :return: The approver_levels of this ApprovalTemplateSummary. + :rtype: oci.lockbox.models.ApproverLevels + """ + return self._approver_levels + + @approver_levels.setter + def approver_levels(self, approver_levels): + """ + Sets the approver_levels of this ApprovalTemplateSummary. + + :param approver_levels: The approver_levels of this ApprovalTemplateSummary. + :type: oci.lockbox.models.ApproverLevels + """ + self._approver_levels = approver_levels + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this ApprovalTemplateSummary. + The unique identifier (OCID) of the customer compartment where the approval template is located. + + + :return: The compartment_id of this ApprovalTemplateSummary. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this ApprovalTemplateSummary. + The unique identifier (OCID) of the customer compartment where the approval template is located. + + + :param compartment_id: The compartment_id of this ApprovalTemplateSummary. + :type: str + """ + self._compartment_id = compartment_id + + @property + def auto_approval_state(self): + """ + Gets the auto_approval_state of this ApprovalTemplateSummary. + The auto approval state of the lockbox. + + Allowed values for this property are: "ENABLED", "DISABLED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The auto_approval_state of this ApprovalTemplateSummary. + :rtype: str + """ + return self._auto_approval_state + + @auto_approval_state.setter + def auto_approval_state(self, auto_approval_state): + """ + Sets the auto_approval_state of this ApprovalTemplateSummary. + The auto approval state of the lockbox. + + + :param auto_approval_state: The auto_approval_state of this ApprovalTemplateSummary. + :type: str + """ + allowed_values = ["ENABLED", "DISABLED"] + if not value_allowed_none_or_none_sentinel(auto_approval_state, allowed_values): + auto_approval_state = 'UNKNOWN_ENUM_VALUE' + self._auto_approval_state = auto_approval_state + + @property + def time_created(self): + """ + **[Required]** Gets the time_created of this ApprovalTemplateSummary. + The time the the approval template was created. An RFC3339 formatted datetime string + + + :return: The time_created of this ApprovalTemplateSummary. + :rtype: datetime + """ + return self._time_created + + @time_created.setter + def time_created(self, time_created): + """ + Sets the time_created of this ApprovalTemplateSummary. + The time the the approval template was created. An RFC3339 formatted datetime string + + + :param time_created: The time_created of this ApprovalTemplateSummary. + :type: datetime + """ + self._time_created = time_created + + @property + def time_updated(self): + """ + Gets the time_updated of this ApprovalTemplateSummary. + The time the approval template was updated. An RFC3339 formatted datetime string + + + :return: The time_updated of this ApprovalTemplateSummary. + :rtype: datetime + """ + return self._time_updated + + @time_updated.setter + def time_updated(self, time_updated): + """ + Sets the time_updated of this ApprovalTemplateSummary. + The time the approval template was updated. An RFC3339 formatted datetime string + + + :param time_updated: The time_updated of this ApprovalTemplateSummary. + :type: datetime + """ + self._time_updated = time_updated + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this ApprovalTemplateSummary. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :return: The freeform_tags of this ApprovalTemplateSummary. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this ApprovalTemplateSummary. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :param freeform_tags: The freeform_tags of this ApprovalTemplateSummary. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this ApprovalTemplateSummary. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this ApprovalTemplateSummary. + :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 ApprovalTemplateSummary. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this ApprovalTemplateSummary. + :type: dict(str, dict(str, object)) + """ + self._defined_tags = defined_tags + + @property + def system_tags(self): + """ + Gets the system_tags of this ApprovalTemplateSummary. + 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 ApprovalTemplateSummary. + :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 ApprovalTemplateSummary. + 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 ApprovalTemplateSummary. + :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/lockbox/models/approver_info.py b/src/oci/lockbox/models/approver_info.py new file mode 100644 index 0000000000..357971a1ce --- /dev/null +++ b/src/oci/lockbox/models/approver_info.py @@ -0,0 +1,117 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 ApproverInfo(object): + """ + The approver data for this approver level. + """ + + #: A constant which can be used with the approver_type property of a ApproverInfo. + #: This constant has a value of "GROUP" + APPROVER_TYPE_GROUP = "GROUP" + + #: A constant which can be used with the approver_type property of a ApproverInfo. + #: This constant has a value of "USER" + APPROVER_TYPE_USER = "USER" + + def __init__(self, **kwargs): + """ + Initializes a new ApproverInfo object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param approver_type: + The value to assign to the approver_type property of this ApproverInfo. + Allowed values for this property are: "GROUP", "USER", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type approver_type: str + + :param approver_id: + The value to assign to the approver_id property of this ApproverInfo. + :type approver_id: str + + """ + self.swagger_types = { + 'approver_type': 'str', + 'approver_id': 'str' + } + + self.attribute_map = { + 'approver_type': 'approverType', + 'approver_id': 'approverId' + } + + self._approver_type = None + self._approver_id = None + + @property + def approver_type(self): + """ + **[Required]** Gets the approver_type of this ApproverInfo. + The approver type of this approver level. + + Allowed values for this property are: "GROUP", "USER", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The approver_type of this ApproverInfo. + :rtype: str + """ + return self._approver_type + + @approver_type.setter + def approver_type(self, approver_type): + """ + Sets the approver_type of this ApproverInfo. + The approver type of this approver level. + + + :param approver_type: The approver_type of this ApproverInfo. + :type: str + """ + allowed_values = ["GROUP", "USER"] + if not value_allowed_none_or_none_sentinel(approver_type, allowed_values): + approver_type = 'UNKNOWN_ENUM_VALUE' + self._approver_type = approver_type + + @property + def approver_id(self): + """ + **[Required]** Gets the approver_id of this ApproverInfo. + The group or user ocid of the approver for this approver level. + + + :return: The approver_id of this ApproverInfo. + :rtype: str + """ + return self._approver_id + + @approver_id.setter + def approver_id(self, approver_id): + """ + Sets the approver_id of this ApproverInfo. + The group or user ocid of the approver for this approver level. + + + :param approver_id: The approver_id of this ApproverInfo. + :type: str + """ + self._approver_id = approver_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/lockbox/models/approver_levels.py b/src/oci/lockbox/models/approver_levels.py new file mode 100644 index 0000000000..55074c332e --- /dev/null +++ b/src/oci/lockbox/models/approver_levels.py @@ -0,0 +1,120 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 ApproverLevels(object): + """ + The approver levels. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ApproverLevels object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param level1: + The value to assign to the level1 property of this ApproverLevels. + :type level1: oci.lockbox.models.ApproverInfo + + :param level2: + The value to assign to the level2 property of this ApproverLevels. + :type level2: oci.lockbox.models.ApproverInfo + + :param level3: + The value to assign to the level3 property of this ApproverLevels. + :type level3: oci.lockbox.models.ApproverInfo + + """ + self.swagger_types = { + 'level1': 'ApproverInfo', + 'level2': 'ApproverInfo', + 'level3': 'ApproverInfo' + } + + self.attribute_map = { + 'level1': 'level1', + 'level2': 'level2', + 'level3': 'level3' + } + + self._level1 = None + self._level2 = None + self._level3 = None + + @property + def level1(self): + """ + **[Required]** Gets the level1 of this ApproverLevels. + + :return: The level1 of this ApproverLevels. + :rtype: oci.lockbox.models.ApproverInfo + """ + return self._level1 + + @level1.setter + def level1(self, level1): + """ + Sets the level1 of this ApproverLevels. + + :param level1: The level1 of this ApproverLevels. + :type: oci.lockbox.models.ApproverInfo + """ + self._level1 = level1 + + @property + def level2(self): + """ + Gets the level2 of this ApproverLevels. + + :return: The level2 of this ApproverLevels. + :rtype: oci.lockbox.models.ApproverInfo + """ + return self._level2 + + @level2.setter + def level2(self, level2): + """ + Sets the level2 of this ApproverLevels. + + :param level2: The level2 of this ApproverLevels. + :type: oci.lockbox.models.ApproverInfo + """ + self._level2 = level2 + + @property + def level3(self): + """ + Gets the level3 of this ApproverLevels. + + :return: The level3 of this ApproverLevels. + :rtype: oci.lockbox.models.ApproverInfo + """ + return self._level3 + + @level3.setter + def level3(self, level3): + """ + Sets the level3 of this ApproverLevels. + + :param level3: The level3 of this ApproverLevels. + :type: oci.lockbox.models.ApproverInfo + """ + self._level3 = level3 + + 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/lockbox/models/change_approval_template_compartment_details.py b/src/oci/lockbox/models/change_approval_template_compartment_details.py new file mode 100644 index 0000000000..bbab9d1e77 --- /dev/null +++ b/src/oci/lockbox/models/change_approval_template_compartment_details.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 ChangeApprovalTemplateCompartmentDetails(object): + """ + The information to be updated. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ChangeApprovalTemplateCompartmentDetails 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 ChangeApprovalTemplateCompartmentDetails. + :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 ChangeApprovalTemplateCompartmentDetails. + The unique identifier (OCID) of the compartment where the resource is located. + + + :return: The compartment_id of this ChangeApprovalTemplateCompartmentDetails. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this ChangeApprovalTemplateCompartmentDetails. + The unique identifier (OCID) of the compartment where the resource is located. + + + :param compartment_id: The compartment_id of this ChangeApprovalTemplateCompartmentDetails. + :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/lockbox/models/change_lockbox_compartment_details.py b/src/oci/lockbox/models/change_lockbox_compartment_details.py new file mode 100644 index 0000000000..a1114ccd61 --- /dev/null +++ b/src/oci/lockbox/models/change_lockbox_compartment_details.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 ChangeLockboxCompartmentDetails(object): + """ + The information to be updated. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ChangeLockboxCompartmentDetails 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 ChangeLockboxCompartmentDetails. + :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 ChangeLockboxCompartmentDetails. + The unique identifier (OCID) of the compartment where the resource is located. + + + :return: The compartment_id of this ChangeLockboxCompartmentDetails. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this ChangeLockboxCompartmentDetails. + The unique identifier (OCID) of the compartment where the resource is located. + + + :param compartment_id: The compartment_id of this ChangeLockboxCompartmentDetails. + :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/lockbox/models/create_access_request_details.py b/src/oci/lockbox/models/create_access_request_details.py new file mode 100644 index 0000000000..66f4294028 --- /dev/null +++ b/src/oci/lockbox/models/create_access_request_details.py @@ -0,0 +1,196 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 CreateAccessRequestDetails(object): + """ + The configuration details for a new access request. + We don't accept a compartmentId parameter because it is implied to be the same as the lockbox as a subsidiary resource. + The requestorId is also based on the caller user info. + """ + + def __init__(self, **kwargs): + """ + Initializes a new CreateAccessRequestDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param lockbox_id: + The value to assign to the lockbox_id property of this CreateAccessRequestDetails. + :type lockbox_id: str + + :param display_name: + The value to assign to the display_name property of this CreateAccessRequestDetails. + :type display_name: str + + :param description: + The value to assign to the description property of this CreateAccessRequestDetails. + :type description: str + + :param context: + The value to assign to the context property of this CreateAccessRequestDetails. + :type context: dict(str, str) + + :param access_duration: + The value to assign to the access_duration property of this CreateAccessRequestDetails. + :type access_duration: str + + """ + self.swagger_types = { + 'lockbox_id': 'str', + 'display_name': 'str', + 'description': 'str', + 'context': 'dict(str, str)', + 'access_duration': 'str' + } + + self.attribute_map = { + 'lockbox_id': 'lockboxId', + 'display_name': 'displayName', + 'description': 'description', + 'context': 'context', + 'access_duration': 'accessDuration' + } + + self._lockbox_id = None + self._display_name = None + self._description = None + self._context = None + self._access_duration = None + + @property + def lockbox_id(self): + """ + **[Required]** Gets the lockbox_id of this CreateAccessRequestDetails. + The unique identifier (OCID) of the lockbox box that the access request is associated with which is immutable. + + + :return: The lockbox_id of this CreateAccessRequestDetails. + :rtype: str + """ + return self._lockbox_id + + @lockbox_id.setter + def lockbox_id(self, lockbox_id): + """ + Sets the lockbox_id of this CreateAccessRequestDetails. + The unique identifier (OCID) of the lockbox box that the access request is associated with which is immutable. + + + :param lockbox_id: The lockbox_id of this CreateAccessRequestDetails. + :type: str + """ + self._lockbox_id = lockbox_id + + @property + def display_name(self): + """ + Gets the display_name of this CreateAccessRequestDetails. + The name of the access request. + + + :return: The display_name of this CreateAccessRequestDetails. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this CreateAccessRequestDetails. + The name of the access request. + + + :param display_name: The display_name of this CreateAccessRequestDetails. + :type: str + """ + self._display_name = display_name + + @property + def description(self): + """ + **[Required]** Gets the description of this CreateAccessRequestDetails. + The rationale for requesting the access request. + + + :return: The description of this CreateAccessRequestDetails. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this CreateAccessRequestDetails. + The rationale for requesting the access request. + + + :param description: The description of this CreateAccessRequestDetails. + :type: str + """ + self._description = description + + @property + def context(self): + """ + Gets the context of this CreateAccessRequestDetails. + The context object containing the access request specific details. + + + :return: The context of this CreateAccessRequestDetails. + :rtype: dict(str, str) + """ + return self._context + + @context.setter + def context(self, context): + """ + Sets the context of this CreateAccessRequestDetails. + The context object containing the access request specific details. + + + :param context: The context of this CreateAccessRequestDetails. + :type: dict(str, str) + """ + self._context = context + + @property + def access_duration(self): + """ + **[Required]** Gets the access_duration of this CreateAccessRequestDetails. + The maximum amount of time operator has access to associated resources. + + + :return: The access_duration of this CreateAccessRequestDetails. + :rtype: str + """ + return self._access_duration + + @access_duration.setter + def access_duration(self, access_duration): + """ + Sets the access_duration of this CreateAccessRequestDetails. + The maximum amount of time operator has access to associated resources. + + + :param access_duration: The access_duration of this CreateAccessRequestDetails. + :type: str + """ + self._access_duration = access_duration + + 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/lockbox/models/create_approval_template_details.py b/src/oci/lockbox/models/create_approval_template_details.py new file mode 100644 index 0000000000..f2e36d3131 --- /dev/null +++ b/src/oci/lockbox/models/create_approval_template_details.py @@ -0,0 +1,242 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 CreateApprovalTemplateDetails(object): + """ + The configuration details for a new approval template. + """ + + #: A constant which can be used with the auto_approval_state property of a CreateApprovalTemplateDetails. + #: This constant has a value of "ENABLED" + AUTO_APPROVAL_STATE_ENABLED = "ENABLED" + + #: A constant which can be used with the auto_approval_state property of a CreateApprovalTemplateDetails. + #: This constant has a value of "DISABLED" + AUTO_APPROVAL_STATE_DISABLED = "DISABLED" + + def __init__(self, **kwargs): + """ + Initializes a new CreateApprovalTemplateDetails 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 CreateApprovalTemplateDetails. + :type compartment_id: str + + :param display_name: + The value to assign to the display_name property of this CreateApprovalTemplateDetails. + :type display_name: str + + :param approver_levels: + The value to assign to the approver_levels property of this CreateApprovalTemplateDetails. + :type approver_levels: oci.lockbox.models.ApproverLevels + + :param auto_approval_state: + The value to assign to the auto_approval_state property of this CreateApprovalTemplateDetails. + Allowed values for this property are: "ENABLED", "DISABLED" + :type auto_approval_state: str + + :param freeform_tags: + The value to assign to the freeform_tags property of this CreateApprovalTemplateDetails. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this CreateApprovalTemplateDetails. + :type defined_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'compartment_id': 'str', + 'display_name': 'str', + 'approver_levels': 'ApproverLevels', + 'auto_approval_state': 'str', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))' + } + + self.attribute_map = { + 'compartment_id': 'compartmentId', + 'display_name': 'displayName', + 'approver_levels': 'approverLevels', + 'auto_approval_state': 'autoApprovalState', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags' + } + + self._compartment_id = None + self._display_name = None + self._approver_levels = None + self._auto_approval_state = None + self._freeform_tags = None + self._defined_tags = None + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this CreateApprovalTemplateDetails. + The unique identifier (OCID) of the compartment where the resource is located. + + + :return: The compartment_id of this CreateApprovalTemplateDetails. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this CreateApprovalTemplateDetails. + The unique identifier (OCID) of the compartment where the resource is located. + + + :param compartment_id: The compartment_id of this CreateApprovalTemplateDetails. + :type: str + """ + self._compartment_id = compartment_id + + @property + def display_name(self): + """ + Gets the display_name of this CreateApprovalTemplateDetails. + approval template identifier + + + :return: The display_name of this CreateApprovalTemplateDetails. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this CreateApprovalTemplateDetails. + approval template identifier + + + :param display_name: The display_name of this CreateApprovalTemplateDetails. + :type: str + """ + self._display_name = display_name + + @property + def approver_levels(self): + """ + **[Required]** Gets the approver_levels of this CreateApprovalTemplateDetails. + + :return: The approver_levels of this CreateApprovalTemplateDetails. + :rtype: oci.lockbox.models.ApproverLevels + """ + return self._approver_levels + + @approver_levels.setter + def approver_levels(self, approver_levels): + """ + Sets the approver_levels of this CreateApprovalTemplateDetails. + + :param approver_levels: The approver_levels of this CreateApprovalTemplateDetails. + :type: oci.lockbox.models.ApproverLevels + """ + self._approver_levels = approver_levels + + @property + def auto_approval_state(self): + """ + Gets the auto_approval_state of this CreateApprovalTemplateDetails. + The auto approval state of the lockbox. + + Allowed values for this property are: "ENABLED", "DISABLED" + + + :return: The auto_approval_state of this CreateApprovalTemplateDetails. + :rtype: str + """ + return self._auto_approval_state + + @auto_approval_state.setter + def auto_approval_state(self, auto_approval_state): + """ + Sets the auto_approval_state of this CreateApprovalTemplateDetails. + The auto approval state of the lockbox. + + + :param auto_approval_state: The auto_approval_state of this CreateApprovalTemplateDetails. + :type: str + """ + allowed_values = ["ENABLED", "DISABLED"] + if not value_allowed_none_or_none_sentinel(auto_approval_state, allowed_values): + raise ValueError( + "Invalid value for `auto_approval_state`, must be None or one of {0}" + .format(allowed_values) + ) + self._auto_approval_state = auto_approval_state + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this CreateApprovalTemplateDetails. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :return: The freeform_tags of this CreateApprovalTemplateDetails. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this CreateApprovalTemplateDetails. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :param freeform_tags: The freeform_tags of this CreateApprovalTemplateDetails. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this CreateApprovalTemplateDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this CreateApprovalTemplateDetails. + :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 CreateApprovalTemplateDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this CreateApprovalTemplateDetails. + :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/lockbox/models/create_lockbox_details.py b/src/oci/lockbox/models/create_lockbox_details.py new file mode 100644 index 0000000000..05670c915d --- /dev/null +++ b/src/oci/lockbox/models/create_lockbox_details.py @@ -0,0 +1,366 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 CreateLockboxDetails(object): + """ + The information about new Lockbox. + """ + + #: A constant which can be used with the lockbox_partner property of a CreateLockboxDetails. + #: This constant has a value of "FAAAS" + LOCKBOX_PARTNER_FAAAS = "FAAAS" + + #: A constant which can be used with the lockbox_partner property of a CreateLockboxDetails. + #: This constant has a value of "CANARY" + LOCKBOX_PARTNER_CANARY = "CANARY" + + def __init__(self, **kwargs): + """ + Initializes a new CreateLockboxDetails 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 CreateLockboxDetails. + :type display_name: str + + :param resource_id: + The value to assign to the resource_id property of this CreateLockboxDetails. + :type resource_id: str + + :param lockbox_partner: + The value to assign to the lockbox_partner property of this CreateLockboxDetails. + Allowed values for this property are: "FAAAS", "CANARY" + :type lockbox_partner: str + + :param compartment_id: + The value to assign to the compartment_id property of this CreateLockboxDetails. + :type compartment_id: str + + :param partner_compartment_id: + The value to assign to the partner_compartment_id property of this CreateLockboxDetails. + :type partner_compartment_id: str + + :param approval_template_id: + The value to assign to the approval_template_id property of this CreateLockboxDetails. + :type approval_template_id: str + + :param max_access_duration: + The value to assign to the max_access_duration property of this CreateLockboxDetails. + :type max_access_duration: str + + :param access_context_attributes: + The value to assign to the access_context_attributes property of this CreateLockboxDetails. + :type access_context_attributes: oci.lockbox.models.AccessContextAttributeCollection + + :param freeform_tags: + The value to assign to the freeform_tags property of this CreateLockboxDetails. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this CreateLockboxDetails. + :type defined_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'display_name': 'str', + 'resource_id': 'str', + 'lockbox_partner': 'str', + 'compartment_id': 'str', + 'partner_compartment_id': 'str', + 'approval_template_id': 'str', + 'max_access_duration': 'str', + 'access_context_attributes': 'AccessContextAttributeCollection', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))' + } + + self.attribute_map = { + 'display_name': 'displayName', + 'resource_id': 'resourceId', + 'lockbox_partner': 'lockboxPartner', + 'compartment_id': 'compartmentId', + 'partner_compartment_id': 'partnerCompartmentId', + 'approval_template_id': 'approvalTemplateId', + 'max_access_duration': 'maxAccessDuration', + 'access_context_attributes': 'accessContextAttributes', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags' + } + + self._display_name = None + self._resource_id = None + self._lockbox_partner = None + self._compartment_id = None + self._partner_compartment_id = None + self._approval_template_id = None + self._max_access_duration = None + self._access_context_attributes = None + self._freeform_tags = None + self._defined_tags = None + + @property + def display_name(self): + """ + Gets the display_name of this CreateLockboxDetails. + Lockbox Identifier + + + :return: The display_name of this CreateLockboxDetails. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this CreateLockboxDetails. + Lockbox Identifier + + + :param display_name: The display_name of this CreateLockboxDetails. + :type: str + """ + self._display_name = display_name + + @property + def resource_id(self): + """ + **[Required]** Gets the resource_id of this CreateLockboxDetails. + The unique identifier (OCID) of the customer's resource. + + + :return: The resource_id of this CreateLockboxDetails. + :rtype: str + """ + return self._resource_id + + @resource_id.setter + def resource_id(self, resource_id): + """ + Sets the resource_id of this CreateLockboxDetails. + The unique identifier (OCID) of the customer's resource. + + + :param resource_id: The resource_id of this CreateLockboxDetails. + :type: str + """ + self._resource_id = resource_id + + @property + def lockbox_partner(self): + """ + **[Required]** Gets the lockbox_partner of this CreateLockboxDetails. + The partner using this lockbox to lock a resource. + + Allowed values for this property are: "FAAAS", "CANARY" + + + :return: The lockbox_partner of this CreateLockboxDetails. + :rtype: str + """ + return self._lockbox_partner + + @lockbox_partner.setter + def lockbox_partner(self, lockbox_partner): + """ + Sets the lockbox_partner of this CreateLockboxDetails. + The partner using this lockbox to lock a resource. + + + :param lockbox_partner: The lockbox_partner of this CreateLockboxDetails. + :type: str + """ + allowed_values = ["FAAAS", "CANARY"] + if not value_allowed_none_or_none_sentinel(lockbox_partner, allowed_values): + raise ValueError( + "Invalid value for `lockbox_partner`, must be None or one of {0}" + .format(allowed_values) + ) + self._lockbox_partner = lockbox_partner + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this CreateLockboxDetails. + The unique identifier (OCID) of the compartment where the resource is located. + + + :return: The compartment_id of this CreateLockboxDetails. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this CreateLockboxDetails. + The unique identifier (OCID) of the compartment where the resource is located. + + + :param compartment_id: The compartment_id of this CreateLockboxDetails. + :type: str + """ + self._compartment_id = compartment_id + + @property + def partner_compartment_id(self): + """ + **[Required]** Gets the partner_compartment_id of this CreateLockboxDetails. + Compartment Identifier + + + :return: The partner_compartment_id of this CreateLockboxDetails. + :rtype: str + """ + return self._partner_compartment_id + + @partner_compartment_id.setter + def partner_compartment_id(self, partner_compartment_id): + """ + Sets the partner_compartment_id of this CreateLockboxDetails. + Compartment Identifier + + + :param partner_compartment_id: The partner_compartment_id of this CreateLockboxDetails. + :type: str + """ + self._partner_compartment_id = partner_compartment_id + + @property + def approval_template_id(self): + """ + Gets the approval_template_id of this CreateLockboxDetails. + Approval template ID + + + :return: The approval_template_id of this CreateLockboxDetails. + :rtype: str + """ + return self._approval_template_id + + @approval_template_id.setter + def approval_template_id(self, approval_template_id): + """ + Sets the approval_template_id of this CreateLockboxDetails. + Approval template ID + + + :param approval_template_id: The approval_template_id of this CreateLockboxDetails. + :type: str + """ + self._approval_template_id = approval_template_id + + @property + def max_access_duration(self): + """ + Gets the max_access_duration of this CreateLockboxDetails. + The maximum amount of time operator has access to associated resources. + + + :return: The max_access_duration of this CreateLockboxDetails. + :rtype: str + """ + return self._max_access_duration + + @max_access_duration.setter + def max_access_duration(self, max_access_duration): + """ + Sets the max_access_duration of this CreateLockboxDetails. + The maximum amount of time operator has access to associated resources. + + + :param max_access_duration: The max_access_duration of this CreateLockboxDetails. + :type: str + """ + self._max_access_duration = max_access_duration + + @property + def access_context_attributes(self): + """ + **[Required]** Gets the access_context_attributes of this CreateLockboxDetails. + + :return: The access_context_attributes of this CreateLockboxDetails. + :rtype: oci.lockbox.models.AccessContextAttributeCollection + """ + return self._access_context_attributes + + @access_context_attributes.setter + def access_context_attributes(self, access_context_attributes): + """ + Sets the access_context_attributes of this CreateLockboxDetails. + + :param access_context_attributes: The access_context_attributes of this CreateLockboxDetails. + :type: oci.lockbox.models.AccessContextAttributeCollection + """ + self._access_context_attributes = access_context_attributes + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this CreateLockboxDetails. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :return: The freeform_tags of this CreateLockboxDetails. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this CreateLockboxDetails. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :param freeform_tags: The freeform_tags of this CreateLockboxDetails. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this CreateLockboxDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this CreateLockboxDetails. + :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 CreateLockboxDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this CreateLockboxDetails. + :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/lockbox/models/handle_access_request_details.py b/src/oci/lockbox/models/handle_access_request_details.py new file mode 100644 index 0000000000..8c089735c6 --- /dev/null +++ b/src/oci/lockbox/models/handle_access_request_details.py @@ -0,0 +1,126 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 HandleAccessRequestDetails(object): + """ + The details for handling access request. + """ + + #: A constant which can be used with the action property of a HandleAccessRequestDetails. + #: This constant has a value of "APPROVE" + ACTION_APPROVE = "APPROVE" + + #: A constant which can be used with the action property of a HandleAccessRequestDetails. + #: This constant has a value of "DENY" + ACTION_DENY = "DENY" + + #: A constant which can be used with the action property of a HandleAccessRequestDetails. + #: This constant has a value of "REVOKE" + ACTION_REVOKE = "REVOKE" + + #: A constant which can be used with the action property of a HandleAccessRequestDetails. + #: This constant has a value of "CANCEL" + ACTION_CANCEL = "CANCEL" + + def __init__(self, **kwargs): + """ + Initializes a new HandleAccessRequestDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param action: + The value to assign to the action property of this HandleAccessRequestDetails. + Allowed values for this property are: "APPROVE", "DENY", "REVOKE", "CANCEL" + :type action: str + + :param message: + The value to assign to the message property of this HandleAccessRequestDetails. + :type message: str + + """ + self.swagger_types = { + 'action': 'str', + 'message': 'str' + } + + self.attribute_map = { + 'action': 'action', + 'message': 'message' + } + + self._action = None + self._message = None + + @property + def action(self): + """ + **[Required]** Gets the action of this HandleAccessRequestDetails. + The action take by persona + + Allowed values for this property are: "APPROVE", "DENY", "REVOKE", "CANCEL" + + + :return: The action of this HandleAccessRequestDetails. + :rtype: str + """ + return self._action + + @action.setter + def action(self, action): + """ + Sets the action of this HandleAccessRequestDetails. + The action take by persona + + + :param action: The action of this HandleAccessRequestDetails. + :type: str + """ + allowed_values = ["APPROVE", "DENY", "REVOKE", "CANCEL"] + if not value_allowed_none_or_none_sentinel(action, allowed_values): + raise ValueError( + "Invalid value for `action`, must be None or one of {0}" + .format(allowed_values) + ) + self._action = action + + @property + def message(self): + """ + Gets the message of this HandleAccessRequestDetails. + Action justification or details. + + + :return: The message of this HandleAccessRequestDetails. + :rtype: str + """ + return self._message + + @message.setter + def message(self, message): + """ + Sets the message of this HandleAccessRequestDetails. + Action justification or details. + + + :param message: The message of this HandleAccessRequestDetails. + :type: str + """ + self._message = message + + 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/lockbox/models/lockbox.py b/src/oci/lockbox/models/lockbox.py new file mode 100644 index 0000000000..3e95a2b9c2 --- /dev/null +++ b/src/oci/lockbox/models/lockbox.py @@ -0,0 +1,585 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 Lockbox(object): + """ + Description of Lockbox. + """ + + #: A constant which can be used with the lockbox_partner property of a Lockbox. + #: This constant has a value of "FAAAS" + LOCKBOX_PARTNER_FAAAS = "FAAAS" + + #: A constant which can be used with the lockbox_partner property of a Lockbox. + #: This constant has a value of "CANARY" + LOCKBOX_PARTNER_CANARY = "CANARY" + + #: A constant which can be used with the lifecycle_state property of a Lockbox. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a Lockbox. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + #: A constant which can be used with the lifecycle_state property of a Lockbox. + #: This constant has a value of "UPDATING" + LIFECYCLE_STATE_UPDATING = "UPDATING" + + #: A constant which can be used with the lifecycle_state property of a Lockbox. + #: This constant has a value of "DELETING" + LIFECYCLE_STATE_DELETING = "DELETING" + + #: A constant which can be used with the lifecycle_state property of a Lockbox. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" + + #: A constant which can be used with the lifecycle_state property of a Lockbox. + #: This constant has a value of "FAILED" + LIFECYCLE_STATE_FAILED = "FAILED" + + def __init__(self, **kwargs): + """ + Initializes a new Lockbox 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 Lockbox. + :type id: str + + :param display_name: + The value to assign to the display_name property of this Lockbox. + :type display_name: str + + :param compartment_id: + The value to assign to the compartment_id property of this Lockbox. + :type compartment_id: str + + :param partner_compartment_id: + The value to assign to the partner_compartment_id property of this Lockbox. + :type partner_compartment_id: str + + :param resource_id: + The value to assign to the resource_id property of this Lockbox. + :type resource_id: str + + :param lockbox_partner: + The value to assign to the lockbox_partner property of this Lockbox. + Allowed values for this property are: "FAAAS", "CANARY", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type lockbox_partner: str + + :param time_created: + The value to assign to the time_created property of this Lockbox. + :type time_created: datetime + + :param time_updated: + The value to assign to the time_updated property of this Lockbox. + :type time_updated: datetime + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this Lockbox. + Allowed values for this property are: "ACTIVE", "CREATING", "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 access_context_attributes: + The value to assign to the access_context_attributes property of this Lockbox. + :type access_context_attributes: oci.lockbox.models.AccessContextAttributeCollection + + :param approval_template_id: + The value to assign to the approval_template_id property of this Lockbox. + :type approval_template_id: str + + :param max_access_duration: + The value to assign to the max_access_duration property of this Lockbox. + :type max_access_duration: str + + :param lifecycle_details: + The value to assign to the lifecycle_details property of this Lockbox. + :type lifecycle_details: str + + :param freeform_tags: + The value to assign to the freeform_tags property of this Lockbox. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this Lockbox. + :type defined_tags: dict(str, dict(str, object)) + + :param system_tags: + The value to assign to the system_tags property of this Lockbox. + :type system_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'id': 'str', + 'display_name': 'str', + 'compartment_id': 'str', + 'partner_compartment_id': 'str', + 'resource_id': 'str', + 'lockbox_partner': 'str', + 'time_created': 'datetime', + 'time_updated': 'datetime', + 'lifecycle_state': 'str', + 'access_context_attributes': 'AccessContextAttributeCollection', + 'approval_template_id': 'str', + 'max_access_duration': 'str', + 'lifecycle_details': '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', + 'partner_compartment_id': 'partnerCompartmentId', + 'resource_id': 'resourceId', + 'lockbox_partner': 'lockboxPartner', + 'time_created': 'timeCreated', + 'time_updated': 'timeUpdated', + 'lifecycle_state': 'lifecycleState', + 'access_context_attributes': 'accessContextAttributes', + 'approval_template_id': 'approvalTemplateId', + 'max_access_duration': 'maxAccessDuration', + 'lifecycle_details': 'lifecycleDetails', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags', + 'system_tags': 'systemTags' + } + + self._id = None + self._display_name = None + self._compartment_id = None + self._partner_compartment_id = None + self._resource_id = None + self._lockbox_partner = None + self._time_created = None + self._time_updated = None + self._lifecycle_state = None + self._access_context_attributes = None + self._approval_template_id = None + self._max_access_duration = None + self._lifecycle_details = None + self._freeform_tags = None + self._defined_tags = None + self._system_tags = None + + @property + def id(self): + """ + **[Required]** Gets the id of this Lockbox. + Unique identifier that is immutable on creation + + + :return: The id of this Lockbox. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this Lockbox. + Unique identifier that is immutable on creation + + + :param id: The id of this Lockbox. + :type: str + """ + self._id = id + + @property + def display_name(self): + """ + **[Required]** Gets the display_name of this Lockbox. + Lockbox Identifier, can be renamed + + + :return: The display_name of this Lockbox. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this Lockbox. + Lockbox Identifier, can be renamed + + + :param display_name: The display_name of this Lockbox. + :type: str + """ + self._display_name = display_name + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this Lockbox. + Compartment Identifier + + + :return: The compartment_id of this Lockbox. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this Lockbox. + Compartment Identifier + + + :param compartment_id: The compartment_id of this Lockbox. + :type: str + """ + self._compartment_id = compartment_id + + @property + def partner_compartment_id(self): + """ + **[Required]** Gets the partner_compartment_id of this Lockbox. + Compartment Identifier + + + :return: The partner_compartment_id of this Lockbox. + :rtype: str + """ + return self._partner_compartment_id + + @partner_compartment_id.setter + def partner_compartment_id(self, partner_compartment_id): + """ + Sets the partner_compartment_id of this Lockbox. + Compartment Identifier + + + :param partner_compartment_id: The partner_compartment_id of this Lockbox. + :type: str + """ + self._partner_compartment_id = partner_compartment_id + + @property + def resource_id(self): + """ + **[Required]** Gets the resource_id of this Lockbox. + The unique identifier (OCID) of associated resource that the lockbox is created for. + + + :return: The resource_id of this Lockbox. + :rtype: str + """ + return self._resource_id + + @resource_id.setter + def resource_id(self, resource_id): + """ + Sets the resource_id of this Lockbox. + The unique identifier (OCID) of associated resource that the lockbox is created for. + + + :param resource_id: The resource_id of this Lockbox. + :type: str + """ + self._resource_id = resource_id + + @property + def lockbox_partner(self): + """ + **[Required]** Gets the lockbox_partner of this Lockbox. + The partner using this lockbox to lock a resource. + + Allowed values for this property are: "FAAAS", "CANARY", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The lockbox_partner of this Lockbox. + :rtype: str + """ + return self._lockbox_partner + + @lockbox_partner.setter + def lockbox_partner(self, lockbox_partner): + """ + Sets the lockbox_partner of this Lockbox. + The partner using this lockbox to lock a resource. + + + :param lockbox_partner: The lockbox_partner of this Lockbox. + :type: str + """ + allowed_values = ["FAAAS", "CANARY"] + if not value_allowed_none_or_none_sentinel(lockbox_partner, allowed_values): + lockbox_partner = 'UNKNOWN_ENUM_VALUE' + self._lockbox_partner = lockbox_partner + + @property + def time_created(self): + """ + **[Required]** Gets the time_created of this Lockbox. + The time the the Lockbox was created. An RFC3339 formatted datetime string + + + :return: The time_created of this Lockbox. + :rtype: datetime + """ + return self._time_created + + @time_created.setter + def time_created(self, time_created): + """ + Sets the time_created of this Lockbox. + The time the the Lockbox was created. An RFC3339 formatted datetime string + + + :param time_created: The time_created of this Lockbox. + :type: datetime + """ + self._time_created = time_created + + @property + def time_updated(self): + """ + Gets the time_updated of this Lockbox. + The time the Lockbox was updated. An RFC3339 formatted datetime string + + + :return: The time_updated of this Lockbox. + :rtype: datetime + """ + return self._time_updated + + @time_updated.setter + def time_updated(self, time_updated): + """ + Sets the time_updated of this Lockbox. + The time the Lockbox was updated. An RFC3339 formatted datetime string + + + :param time_updated: The time_updated of this Lockbox. + :type: datetime + """ + self._time_updated = time_updated + + @property + def lifecycle_state(self): + """ + **[Required]** Gets the lifecycle_state of this Lockbox. + The current state of the Lockbox. + + Allowed values for this property are: "ACTIVE", "CREATING", "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 Lockbox. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this Lockbox. + The current state of the Lockbox. + + + :param lifecycle_state: The lifecycle_state of this Lockbox. + :type: str + """ + allowed_values = ["ACTIVE", "CREATING", "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 access_context_attributes(self): + """ + Gets the access_context_attributes of this Lockbox. + + :return: The access_context_attributes of this Lockbox. + :rtype: oci.lockbox.models.AccessContextAttributeCollection + """ + return self._access_context_attributes + + @access_context_attributes.setter + def access_context_attributes(self, access_context_attributes): + """ + Sets the access_context_attributes of this Lockbox. + + :param access_context_attributes: The access_context_attributes of this Lockbox. + :type: oci.lockbox.models.AccessContextAttributeCollection + """ + self._access_context_attributes = access_context_attributes + + @property + def approval_template_id(self): + """ + Gets the approval_template_id of this Lockbox. + Approval template ID + + + :return: The approval_template_id of this Lockbox. + :rtype: str + """ + return self._approval_template_id + + @approval_template_id.setter + def approval_template_id(self, approval_template_id): + """ + Sets the approval_template_id of this Lockbox. + Approval template ID + + + :param approval_template_id: The approval_template_id of this Lockbox. + :type: str + """ + self._approval_template_id = approval_template_id + + @property + def max_access_duration(self): + """ + Gets the max_access_duration of this Lockbox. + The maximum amount of time operator has access to associated resources. + + + :return: The max_access_duration of this Lockbox. + :rtype: str + """ + return self._max_access_duration + + @max_access_duration.setter + def max_access_duration(self, max_access_duration): + """ + Sets the max_access_duration of this Lockbox. + The maximum amount of time operator has access to associated resources. + + + :param max_access_duration: The max_access_duration of this Lockbox. + :type: str + """ + self._max_access_duration = max_access_duration + + @property + def lifecycle_details(self): + """ + Gets the lifecycle_details of this Lockbox. + A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. + + + :return: The lifecycle_details of this Lockbox. + :rtype: str + """ + return self._lifecycle_details + + @lifecycle_details.setter + def lifecycle_details(self, lifecycle_details): + """ + Sets the lifecycle_details of this Lockbox. + A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. + + + :param lifecycle_details: The lifecycle_details of this Lockbox. + :type: str + """ + self._lifecycle_details = lifecycle_details + + @property + def freeform_tags(self): + """ + **[Required]** Gets the freeform_tags of this Lockbox. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :return: The freeform_tags of this Lockbox. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this Lockbox. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :param freeform_tags: The freeform_tags of this Lockbox. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + **[Required]** Gets the defined_tags of this Lockbox. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this Lockbox. + :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 Lockbox. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this Lockbox. + :type: dict(str, dict(str, object)) + """ + self._defined_tags = defined_tags + + @property + def system_tags(self): + """ + Gets the system_tags of this Lockbox. + 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 Lockbox. + :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 Lockbox. + 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 Lockbox. + :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/lockbox/models/lockbox_collection.py b/src/oci/lockbox/models/lockbox_collection.py new file mode 100644 index 0000000000..da66a18743 --- /dev/null +++ b/src/oci/lockbox/models/lockbox_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 LockboxCollection(object): + """ + Results of a lockbox search. Contains both LockboxSummary items and other information, such as metadata. + """ + + def __init__(self, **kwargs): + """ + Initializes a new LockboxCollection 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 LockboxCollection. + :type items: list[oci.lockbox.models.LockboxSummary] + + """ + self.swagger_types = { + 'items': 'list[LockboxSummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this LockboxCollection. + List of lockboxes. + + + :return: The items of this LockboxCollection. + :rtype: list[oci.lockbox.models.LockboxSummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this LockboxCollection. + List of lockboxes. + + + :param items: The items of this LockboxCollection. + :type: list[oci.lockbox.models.LockboxSummary] + """ + 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/lockbox/models/lockbox_summary.py b/src/oci/lockbox/models/lockbox_summary.py new file mode 100644 index 0000000000..4aaa372bfd --- /dev/null +++ b/src/oci/lockbox/models/lockbox_summary.py @@ -0,0 +1,526 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 LockboxSummary(object): + """ + Summary of the Lockbox. + """ + + #: A constant which can be used with the lockbox_partner property of a LockboxSummary. + #: This constant has a value of "FAAAS" + LOCKBOX_PARTNER_FAAAS = "FAAAS" + + #: A constant which can be used with the lockbox_partner property of a LockboxSummary. + #: This constant has a value of "CANARY" + LOCKBOX_PARTNER_CANARY = "CANARY" + + def __init__(self, **kwargs): + """ + Initializes a new LockboxSummary 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 LockboxSummary. + :type id: str + + :param display_name: + The value to assign to the display_name property of this LockboxSummary. + :type display_name: str + + :param lockbox_partner: + The value to assign to the lockbox_partner property of this LockboxSummary. + Allowed values for this property are: "FAAAS", "CANARY", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type lockbox_partner: str + + :param compartment_id: + The value to assign to the compartment_id property of this LockboxSummary. + :type compartment_id: str + + :param partner_compartment_id: + The value to assign to the partner_compartment_id property of this LockboxSummary. + :type partner_compartment_id: str + + :param resource_id: + The value to assign to the resource_id property of this LockboxSummary. + :type resource_id: str + + :param approval_template_id: + The value to assign to the approval_template_id property of this LockboxSummary. + :type approval_template_id: str + + :param max_access_duration: + The value to assign to the max_access_duration property of this LockboxSummary. + :type max_access_duration: str + + :param time_created: + The value to assign to the time_created property of this LockboxSummary. + :type time_created: datetime + + :param time_updated: + The value to assign to the time_updated property of this LockboxSummary. + :type time_updated: datetime + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this LockboxSummary. + :type lifecycle_state: str + + :param lifecycle_details: + The value to assign to the lifecycle_details property of this LockboxSummary. + :type lifecycle_details: str + + :param freeform_tags: + The value to assign to the freeform_tags property of this LockboxSummary. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this LockboxSummary. + :type defined_tags: dict(str, dict(str, object)) + + :param system_tags: + The value to assign to the system_tags property of this LockboxSummary. + :type system_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'id': 'str', + 'display_name': 'str', + 'lockbox_partner': 'str', + 'compartment_id': 'str', + 'partner_compartment_id': 'str', + 'resource_id': 'str', + 'approval_template_id': 'str', + 'max_access_duration': 'str', + 'time_created': 'datetime', + 'time_updated': 'datetime', + 'lifecycle_state': 'str', + 'lifecycle_details': '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', + 'lockbox_partner': 'lockboxPartner', + 'compartment_id': 'compartmentId', + 'partner_compartment_id': 'partnerCompartmentId', + 'resource_id': 'resourceId', + 'approval_template_id': 'approvalTemplateId', + 'max_access_duration': 'maxAccessDuration', + 'time_created': 'timeCreated', + 'time_updated': 'timeUpdated', + 'lifecycle_state': 'lifecycleState', + 'lifecycle_details': 'lifecycleDetails', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags', + 'system_tags': 'systemTags' + } + + self._id = None + self._display_name = None + self._lockbox_partner = None + self._compartment_id = None + self._partner_compartment_id = None + self._resource_id = None + self._approval_template_id = None + self._max_access_duration = None + self._time_created = None + self._time_updated = None + self._lifecycle_state = None + self._lifecycle_details = None + self._freeform_tags = None + self._defined_tags = None + self._system_tags = None + + @property + def id(self): + """ + **[Required]** Gets the id of this LockboxSummary. + Unique identifier that is immutable on creation + + + :return: The id of this LockboxSummary. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this LockboxSummary. + Unique identifier that is immutable on creation + + + :param id: The id of this LockboxSummary. + :type: str + """ + self._id = id + + @property + def display_name(self): + """ + **[Required]** Gets the display_name of this LockboxSummary. + Lockbox Identifier, can be renamed + + + :return: The display_name of this LockboxSummary. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this LockboxSummary. + Lockbox Identifier, can be renamed + + + :param display_name: The display_name of this LockboxSummary. + :type: str + """ + self._display_name = display_name + + @property + def lockbox_partner(self): + """ + **[Required]** Gets the lockbox_partner of this LockboxSummary. + The partner using this lockbox to lock a resource. + + Allowed values for this property are: "FAAAS", "CANARY", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The lockbox_partner of this LockboxSummary. + :rtype: str + """ + return self._lockbox_partner + + @lockbox_partner.setter + def lockbox_partner(self, lockbox_partner): + """ + Sets the lockbox_partner of this LockboxSummary. + The partner using this lockbox to lock a resource. + + + :param lockbox_partner: The lockbox_partner of this LockboxSummary. + :type: str + """ + allowed_values = ["FAAAS", "CANARY"] + if not value_allowed_none_or_none_sentinel(lockbox_partner, allowed_values): + lockbox_partner = 'UNKNOWN_ENUM_VALUE' + self._lockbox_partner = lockbox_partner + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this LockboxSummary. + Compartment Identifier + + + :return: The compartment_id of this LockboxSummary. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this LockboxSummary. + Compartment Identifier + + + :param compartment_id: The compartment_id of this LockboxSummary. + :type: str + """ + self._compartment_id = compartment_id + + @property + def partner_compartment_id(self): + """ + **[Required]** Gets the partner_compartment_id of this LockboxSummary. + Compartment Identifier + + + :return: The partner_compartment_id of this LockboxSummary. + :rtype: str + """ + return self._partner_compartment_id + + @partner_compartment_id.setter + def partner_compartment_id(self, partner_compartment_id): + """ + Sets the partner_compartment_id of this LockboxSummary. + Compartment Identifier + + + :param partner_compartment_id: The partner_compartment_id of this LockboxSummary. + :type: str + """ + self._partner_compartment_id = partner_compartment_id + + @property + def resource_id(self): + """ + **[Required]** Gets the resource_id of this LockboxSummary. + The unique identifier (OCID) of associated resource that the lockbox is created for. + + + :return: The resource_id of this LockboxSummary. + :rtype: str + """ + return self._resource_id + + @resource_id.setter + def resource_id(self, resource_id): + """ + Sets the resource_id of this LockboxSummary. + The unique identifier (OCID) of associated resource that the lockbox is created for. + + + :param resource_id: The resource_id of this LockboxSummary. + :type: str + """ + self._resource_id = resource_id + + @property + def approval_template_id(self): + """ + Gets the approval_template_id of this LockboxSummary. + Approval template ID + + + :return: The approval_template_id of this LockboxSummary. + :rtype: str + """ + return self._approval_template_id + + @approval_template_id.setter + def approval_template_id(self, approval_template_id): + """ + Sets the approval_template_id of this LockboxSummary. + Approval template ID + + + :param approval_template_id: The approval_template_id of this LockboxSummary. + :type: str + """ + self._approval_template_id = approval_template_id + + @property + def max_access_duration(self): + """ + Gets the max_access_duration of this LockboxSummary. + The maximum amount of time operator has access to associated resources. + + + :return: The max_access_duration of this LockboxSummary. + :rtype: str + """ + return self._max_access_duration + + @max_access_duration.setter + def max_access_duration(self, max_access_duration): + """ + Sets the max_access_duration of this LockboxSummary. + The maximum amount of time operator has access to associated resources. + + + :param max_access_duration: The max_access_duration of this LockboxSummary. + :type: str + """ + self._max_access_duration = max_access_duration + + @property + def time_created(self): + """ + **[Required]** Gets the time_created of this LockboxSummary. + The time the the Lockbox was created. An RFC3339 formatted datetime string + + + :return: The time_created of this LockboxSummary. + :rtype: datetime + """ + return self._time_created + + @time_created.setter + def time_created(self, time_created): + """ + Sets the time_created of this LockboxSummary. + The time the the Lockbox was created. An RFC3339 formatted datetime string + + + :param time_created: The time_created of this LockboxSummary. + :type: datetime + """ + self._time_created = time_created + + @property + def time_updated(self): + """ + Gets the time_updated of this LockboxSummary. + The time the Lockbox was updated. An RFC3339 formatted datetime string + + + :return: The time_updated of this LockboxSummary. + :rtype: datetime + """ + return self._time_updated + + @time_updated.setter + def time_updated(self, time_updated): + """ + Sets the time_updated of this LockboxSummary. + The time the Lockbox was updated. An RFC3339 formatted datetime string + + + :param time_updated: The time_updated of this LockboxSummary. + :type: datetime + """ + self._time_updated = time_updated + + @property + def lifecycle_state(self): + """ + **[Required]** Gets the lifecycle_state of this LockboxSummary. + The current state of the Lockbox. + + + :return: The lifecycle_state of this LockboxSummary. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this LockboxSummary. + The current state of the Lockbox. + + + :param lifecycle_state: The lifecycle_state of this LockboxSummary. + :type: str + """ + self._lifecycle_state = lifecycle_state + + @property + def lifecycle_details(self): + """ + Gets the lifecycle_details of this LockboxSummary. + A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. + + + :return: The lifecycle_details of this LockboxSummary. + :rtype: str + """ + return self._lifecycle_details + + @lifecycle_details.setter + def lifecycle_details(self, lifecycle_details): + """ + Sets the lifecycle_details of this LockboxSummary. + A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. + + + :param lifecycle_details: The lifecycle_details of this LockboxSummary. + :type: str + """ + self._lifecycle_details = lifecycle_details + + @property + def freeform_tags(self): + """ + **[Required]** Gets the freeform_tags of this LockboxSummary. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :return: The freeform_tags of this LockboxSummary. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this LockboxSummary. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :param freeform_tags: The freeform_tags of this LockboxSummary. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + **[Required]** Gets the defined_tags of this LockboxSummary. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this LockboxSummary. + :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 LockboxSummary. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this LockboxSummary. + :type: dict(str, dict(str, object)) + """ + self._defined_tags = defined_tags + + @property + def system_tags(self): + """ + Gets the system_tags of this LockboxSummary. + 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 LockboxSummary. + :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 LockboxSummary. + 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 LockboxSummary. + :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/lockbox/models/update_approval_template_details.py b/src/oci/lockbox/models/update_approval_template_details.py new file mode 100644 index 0000000000..d8c8a0c1f6 --- /dev/null +++ b/src/oci/lockbox/models/update_approval_template_details.py @@ -0,0 +1,211 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 UpdateApprovalTemplateDetails(object): + """ + The action to be updated. + """ + + #: A constant which can be used with the auto_approval_state property of a UpdateApprovalTemplateDetails. + #: This constant has a value of "ENABLED" + AUTO_APPROVAL_STATE_ENABLED = "ENABLED" + + #: A constant which can be used with the auto_approval_state property of a UpdateApprovalTemplateDetails. + #: This constant has a value of "DISABLED" + AUTO_APPROVAL_STATE_DISABLED = "DISABLED" + + def __init__(self, **kwargs): + """ + Initializes a new UpdateApprovalTemplateDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param approver_levels: + The value to assign to the approver_levels property of this UpdateApprovalTemplateDetails. + :type approver_levels: oci.lockbox.models.ApproverLevels + + :param display_name: + The value to assign to the display_name property of this UpdateApprovalTemplateDetails. + :type display_name: str + + :param auto_approval_state: + The value to assign to the auto_approval_state property of this UpdateApprovalTemplateDetails. + Allowed values for this property are: "ENABLED", "DISABLED" + :type auto_approval_state: str + + :param freeform_tags: + The value to assign to the freeform_tags property of this UpdateApprovalTemplateDetails. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this UpdateApprovalTemplateDetails. + :type defined_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'approver_levels': 'ApproverLevels', + 'display_name': 'str', + 'auto_approval_state': 'str', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))' + } + + self.attribute_map = { + 'approver_levels': 'approverLevels', + 'display_name': 'displayName', + 'auto_approval_state': 'autoApprovalState', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags' + } + + self._approver_levels = None + self._display_name = None + self._auto_approval_state = None + self._freeform_tags = None + self._defined_tags = None + + @property + def approver_levels(self): + """ + Gets the approver_levels of this UpdateApprovalTemplateDetails. + + :return: The approver_levels of this UpdateApprovalTemplateDetails. + :rtype: oci.lockbox.models.ApproverLevels + """ + return self._approver_levels + + @approver_levels.setter + def approver_levels(self, approver_levels): + """ + Sets the approver_levels of this UpdateApprovalTemplateDetails. + + :param approver_levels: The approver_levels of this UpdateApprovalTemplateDetails. + :type: oci.lockbox.models.ApproverLevels + """ + self._approver_levels = approver_levels + + @property + def display_name(self): + """ + Gets the display_name of this UpdateApprovalTemplateDetails. + approval template identifier + + + :return: The display_name of this UpdateApprovalTemplateDetails. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this UpdateApprovalTemplateDetails. + approval template identifier + + + :param display_name: The display_name of this UpdateApprovalTemplateDetails. + :type: str + """ + self._display_name = display_name + + @property + def auto_approval_state(self): + """ + Gets the auto_approval_state of this UpdateApprovalTemplateDetails. + The auto approval state of the lockbox. + + Allowed values for this property are: "ENABLED", "DISABLED" + + + :return: The auto_approval_state of this UpdateApprovalTemplateDetails. + :rtype: str + """ + return self._auto_approval_state + + @auto_approval_state.setter + def auto_approval_state(self, auto_approval_state): + """ + Sets the auto_approval_state of this UpdateApprovalTemplateDetails. + The auto approval state of the lockbox. + + + :param auto_approval_state: The auto_approval_state of this UpdateApprovalTemplateDetails. + :type: str + """ + allowed_values = ["ENABLED", "DISABLED"] + if not value_allowed_none_or_none_sentinel(auto_approval_state, allowed_values): + raise ValueError( + "Invalid value for `auto_approval_state`, must be None or one of {0}" + .format(allowed_values) + ) + self._auto_approval_state = auto_approval_state + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this UpdateApprovalTemplateDetails. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :return: The freeform_tags of this UpdateApprovalTemplateDetails. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this UpdateApprovalTemplateDetails. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :param freeform_tags: The freeform_tags of this UpdateApprovalTemplateDetails. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this UpdateApprovalTemplateDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this UpdateApprovalTemplateDetails. + :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 UpdateApprovalTemplateDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this UpdateApprovalTemplateDetails. + :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/lockbox/models/update_lockbox_details.py b/src/oci/lockbox/models/update_lockbox_details.py new file mode 100644 index 0000000000..f51b074d20 --- /dev/null +++ b/src/oci/lockbox/models/update_lockbox_details.py @@ -0,0 +1,198 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 UpdateLockboxDetails(object): + """ + The information to be updated. + """ + + def __init__(self, **kwargs): + """ + Initializes a new UpdateLockboxDetails 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 UpdateLockboxDetails. + :type display_name: str + + :param approval_template_id: + The value to assign to the approval_template_id property of this UpdateLockboxDetails. + :type approval_template_id: str + + :param max_access_duration: + The value to assign to the max_access_duration property of this UpdateLockboxDetails. + :type max_access_duration: str + + :param freeform_tags: + The value to assign to the freeform_tags property of this UpdateLockboxDetails. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this UpdateLockboxDetails. + :type defined_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'display_name': 'str', + 'approval_template_id': 'str', + 'max_access_duration': 'str', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))' + } + + self.attribute_map = { + 'display_name': 'displayName', + 'approval_template_id': 'approvalTemplateId', + 'max_access_duration': 'maxAccessDuration', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags' + } + + self._display_name = None + self._approval_template_id = None + self._max_access_duration = None + self._freeform_tags = None + self._defined_tags = None + + @property + def display_name(self): + """ + Gets the display_name of this UpdateLockboxDetails. + Lockbox Identifier + + + :return: The display_name of this UpdateLockboxDetails. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this UpdateLockboxDetails. + Lockbox Identifier + + + :param display_name: The display_name of this UpdateLockboxDetails. + :type: str + """ + self._display_name = display_name + + @property + def approval_template_id(self): + """ + Gets the approval_template_id of this UpdateLockboxDetails. + Approval template ID + + + :return: The approval_template_id of this UpdateLockboxDetails. + :rtype: str + """ + return self._approval_template_id + + @approval_template_id.setter + def approval_template_id(self, approval_template_id): + """ + Sets the approval_template_id of this UpdateLockboxDetails. + Approval template ID + + + :param approval_template_id: The approval_template_id of this UpdateLockboxDetails. + :type: str + """ + self._approval_template_id = approval_template_id + + @property + def max_access_duration(self): + """ + Gets the max_access_duration of this UpdateLockboxDetails. + The maximum amount of time operator has access to associated resources. + + + :return: The max_access_duration of this UpdateLockboxDetails. + :rtype: str + """ + return self._max_access_duration + + @max_access_duration.setter + def max_access_duration(self, max_access_duration): + """ + Sets the max_access_duration of this UpdateLockboxDetails. + The maximum amount of time operator has access to associated resources. + + + :param max_access_duration: The max_access_duration of this UpdateLockboxDetails. + :type: str + """ + self._max_access_duration = max_access_duration + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this UpdateLockboxDetails. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :return: The freeform_tags of this UpdateLockboxDetails. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this UpdateLockboxDetails. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :param freeform_tags: The freeform_tags of this UpdateLockboxDetails. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this UpdateLockboxDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this UpdateLockboxDetails. + :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 UpdateLockboxDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this UpdateLockboxDetails. + :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/lockbox/models/work_request.py b/src/oci/lockbox/models/work_request.py new file mode 100644 index 0000000000..fcd277ebc2 --- /dev/null +++ b/src/oci/lockbox/models/work_request.py @@ -0,0 +1,428 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 WorkRequest(object): + """ + A description of workrequest status + """ + + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "CREATE_LOCKBOX" + OPERATION_TYPE_CREATE_LOCKBOX = "CREATE_LOCKBOX" + + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "UPDATE_LOCKBOX" + OPERATION_TYPE_UPDATE_LOCKBOX = "UPDATE_LOCKBOX" + + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "DELETE_LOCKBOX" + OPERATION_TYPE_DELETE_LOCKBOX = "DELETE_LOCKBOX" + + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "MOVE_LOCKBOX" + OPERATION_TYPE_MOVE_LOCKBOX = "MOVE_LOCKBOX" + + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "CREATE_ACCESS_REQUEST" + OPERATION_TYPE_CREATE_ACCESS_REQUEST = "CREATE_ACCESS_REQUEST" + + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "APPROVE_ACCESS_REQUEST" + OPERATION_TYPE_APPROVE_ACCESS_REQUEST = "APPROVE_ACCESS_REQUEST" + + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "REVOKE_ACCESS_REQUEST" + OPERATION_TYPE_REVOKE_ACCESS_REQUEST = "REVOKE_ACCESS_REQUEST" + + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "CREATE_APPROVAL_TEMPLATE" + OPERATION_TYPE_CREATE_APPROVAL_TEMPLATE = "CREATE_APPROVAL_TEMPLATE" + + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "MOVE_APPROVAL_TEMPLATE" + OPERATION_TYPE_MOVE_APPROVAL_TEMPLATE = "MOVE_APPROVAL_TEMPLATE" + + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "UPDATE_APPROVAL_TEMPLATE" + OPERATION_TYPE_UPDATE_APPROVAL_TEMPLATE = "UPDATE_APPROVAL_TEMPLATE" + + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "DELETE_APPROVAL_TEMPLATE" + OPERATION_TYPE_DELETE_APPROVAL_TEMPLATE = "DELETE_APPROVAL_TEMPLATE" + + #: A constant which can be used with the status property of a WorkRequest. + #: This constant has a value of "ACCEPTED" + STATUS_ACCEPTED = "ACCEPTED" + + #: A constant which can be used with the status property of a WorkRequest. + #: This constant has a value of "IN_PROGRESS" + STATUS_IN_PROGRESS = "IN_PROGRESS" + + #: A constant which can be used with the status property of a WorkRequest. + #: This constant has a value of "WAITING" + STATUS_WAITING = "WAITING" + + #: A constant which can be used with the status property of a WorkRequest. + #: This constant has a value of "FAILED" + STATUS_FAILED = "FAILED" + + #: A constant which can be used with the status property of a WorkRequest. + #: This constant has a value of "SUCCEEDED" + STATUS_SUCCEEDED = "SUCCEEDED" + + #: A constant which can be used with the status property of a WorkRequest. + #: This constant has a value of "CANCELING" + STATUS_CANCELING = "CANCELING" + + #: A constant which can be used with the status property of a WorkRequest. + #: This constant has a value of "CANCELED" + STATUS_CANCELED = "CANCELED" + + def __init__(self, **kwargs): + """ + Initializes a new WorkRequest object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param operation_type: + The value to assign to the operation_type property of this WorkRequest. + Allowed values for this property are: "CREATE_LOCKBOX", "UPDATE_LOCKBOX", "DELETE_LOCKBOX", "MOVE_LOCKBOX", "CREATE_ACCESS_REQUEST", "APPROVE_ACCESS_REQUEST", "REVOKE_ACCESS_REQUEST", "CREATE_APPROVAL_TEMPLATE", "MOVE_APPROVAL_TEMPLATE", "UPDATE_APPROVAL_TEMPLATE", "DELETE_APPROVAL_TEMPLATE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type operation_type: str + + :param status: + The value to assign to the status property of this WorkRequest. + Allowed values for this property are: "ACCEPTED", "IN_PROGRESS", "WAITING", "FAILED", "SUCCEEDED", "CANCELING", "CANCELED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type status: str + + :param id: + The value to assign to the id property of this WorkRequest. + :type id: str + + :param compartment_id: + The value to assign to the compartment_id property of this WorkRequest. + :type compartment_id: str + + :param resources: + The value to assign to the resources property of this WorkRequest. + :type resources: list[oci.lockbox.models.WorkRequestResource] + + :param percent_complete: + The value to assign to the percent_complete property of this WorkRequest. + :type percent_complete: float + + :param time_accepted: + The value to assign to the time_accepted property of this WorkRequest. + :type time_accepted: datetime + + :param time_started: + The value to assign to the time_started property of this WorkRequest. + :type time_started: datetime + + :param time_finished: + The value to assign to the time_finished property of this WorkRequest. + :type time_finished: datetime + + """ + self.swagger_types = { + 'operation_type': 'str', + 'status': 'str', + 'id': 'str', + 'compartment_id': 'str', + 'resources': 'list[WorkRequestResource]', + 'percent_complete': 'float', + 'time_accepted': 'datetime', + 'time_started': 'datetime', + 'time_finished': 'datetime' + } + + self.attribute_map = { + 'operation_type': 'operationType', + 'status': 'status', + 'id': 'id', + 'compartment_id': 'compartmentId', + 'resources': 'resources', + 'percent_complete': 'percentComplete', + 'time_accepted': 'timeAccepted', + 'time_started': 'timeStarted', + 'time_finished': 'timeFinished' + } + + self._operation_type = None + self._status = None + self._id = None + self._compartment_id = None + self._resources = None + self._percent_complete = None + self._time_accepted = None + self._time_started = None + self._time_finished = None + + @property + def operation_type(self): + """ + **[Required]** Gets the operation_type of this WorkRequest. + Type of the work request + + Allowed values for this property are: "CREATE_LOCKBOX", "UPDATE_LOCKBOX", "DELETE_LOCKBOX", "MOVE_LOCKBOX", "CREATE_ACCESS_REQUEST", "APPROVE_ACCESS_REQUEST", "REVOKE_ACCESS_REQUEST", "CREATE_APPROVAL_TEMPLATE", "MOVE_APPROVAL_TEMPLATE", "UPDATE_APPROVAL_TEMPLATE", "DELETE_APPROVAL_TEMPLATE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The operation_type of this WorkRequest. + :rtype: str + """ + return self._operation_type + + @operation_type.setter + def operation_type(self, operation_type): + """ + Sets the operation_type of this WorkRequest. + Type of the work request + + + :param operation_type: The operation_type of this WorkRequest. + :type: str + """ + allowed_values = ["CREATE_LOCKBOX", "UPDATE_LOCKBOX", "DELETE_LOCKBOX", "MOVE_LOCKBOX", "CREATE_ACCESS_REQUEST", "APPROVE_ACCESS_REQUEST", "REVOKE_ACCESS_REQUEST", "CREATE_APPROVAL_TEMPLATE", "MOVE_APPROVAL_TEMPLATE", "UPDATE_APPROVAL_TEMPLATE", "DELETE_APPROVAL_TEMPLATE"] + if not value_allowed_none_or_none_sentinel(operation_type, allowed_values): + operation_type = 'UNKNOWN_ENUM_VALUE' + self._operation_type = operation_type + + @property + def status(self): + """ + **[Required]** Gets the status of this WorkRequest. + Status of current work request. + + Allowed values for this property are: "ACCEPTED", "IN_PROGRESS", "WAITING", "FAILED", "SUCCEEDED", "CANCELING", "CANCELED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The status of this WorkRequest. + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """ + Sets the status of this WorkRequest. + Status of current work request. + + + :param status: The status of this WorkRequest. + :type: str + """ + allowed_values = ["ACCEPTED", "IN_PROGRESS", "WAITING", "FAILED", "SUCCEEDED", "CANCELING", "CANCELED"] + if not value_allowed_none_or_none_sentinel(status, allowed_values): + status = 'UNKNOWN_ENUM_VALUE' + self._status = status + + @property + def id(self): + """ + **[Required]** Gets the id of this WorkRequest. + The id of the work request. + + + :return: The id of this WorkRequest. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this WorkRequest. + The id of the work request. + + + :param id: The id of this WorkRequest. + :type: str + """ + self._id = id + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this WorkRequest. + The ocid of the compartment that contains the work request. Work requests should be scoped to + the same compartment as the resource the work request affects. If the work request affects multiple resources, + and those resources are not in the same compartment, it is up to the service team to pick the primary + resource whose compartment should be used + + + :return: The compartment_id of this WorkRequest. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this WorkRequest. + The ocid of the compartment that contains the work request. Work requests should be scoped to + the same compartment as the resource the work request affects. If the work request affects multiple resources, + and those resources are not in the same compartment, it is up to the service team to pick the primary + resource whose compartment should be used + + + :param compartment_id: The compartment_id of this WorkRequest. + :type: str + """ + self._compartment_id = compartment_id + + @property + def resources(self): + """ + **[Required]** Gets the resources of this WorkRequest. + The resources affected by this work request. + + + :return: The resources of this WorkRequest. + :rtype: list[oci.lockbox.models.WorkRequestResource] + """ + return self._resources + + @resources.setter + def resources(self, resources): + """ + Sets the resources of this WorkRequest. + The resources affected by this work request. + + + :param resources: The resources of this WorkRequest. + :type: list[oci.lockbox.models.WorkRequestResource] + """ + self._resources = resources + + @property + def percent_complete(self): + """ + **[Required]** Gets the percent_complete of this WorkRequest. + Percentage of the request completed. + + + :return: The percent_complete of this WorkRequest. + :rtype: float + """ + return self._percent_complete + + @percent_complete.setter + def percent_complete(self, percent_complete): + """ + Sets the percent_complete of this WorkRequest. + Percentage of the request completed. + + + :param percent_complete: The percent_complete of this WorkRequest. + :type: float + """ + self._percent_complete = percent_complete + + @property + def time_accepted(self): + """ + **[Required]** Gets the time_accepted of this WorkRequest. + The date and time the request was created, as described in + `RFC 3339`__, section 14.29. + + __ https://tools.ietf.org/rfc/rfc3339 + + + :return: The time_accepted of this WorkRequest. + :rtype: datetime + """ + return self._time_accepted + + @time_accepted.setter + def time_accepted(self, time_accepted): + """ + Sets the time_accepted of this WorkRequest. + The date and time the request was created, as described in + `RFC 3339`__, section 14.29. + + __ https://tools.ietf.org/rfc/rfc3339 + + + :param time_accepted: The time_accepted of this WorkRequest. + :type: datetime + """ + self._time_accepted = time_accepted + + @property + def time_started(self): + """ + Gets the time_started of this WorkRequest. + The date and time the request was started, as described in `RFC 3339`__, + section 14.29. + + __ https://tools.ietf.org/rfc/rfc3339 + + + :return: The time_started of this WorkRequest. + :rtype: datetime + """ + return self._time_started + + @time_started.setter + def time_started(self, time_started): + """ + Sets the time_started of this WorkRequest. + The date and time the request was started, as described in `RFC 3339`__, + section 14.29. + + __ https://tools.ietf.org/rfc/rfc3339 + + + :param time_started: The time_started of this WorkRequest. + :type: datetime + """ + self._time_started = time_started + + @property + def time_finished(self): + """ + Gets the time_finished of this WorkRequest. + The date and time the object was finished, as described in `RFC 3339`__. + + __ https://tools.ietf.org/rfc/rfc3339 + + + :return: The time_finished of this WorkRequest. + :rtype: datetime + """ + return self._time_finished + + @time_finished.setter + def time_finished(self, time_finished): + """ + Sets the time_finished of this WorkRequest. + The date and time the object was finished, as described in `RFC 3339`__. + + __ https://tools.ietf.org/rfc/rfc3339 + + + :param time_finished: The time_finished of this WorkRequest. + :type: datetime + """ + self._time_finished = time_finished + + 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/lockbox/models/work_request_error.py b/src/oci/lockbox/models/work_request_error.py new file mode 100644 index 0000000000..26ac6a8cc9 --- /dev/null +++ b/src/oci/lockbox/models/work_request_error.py @@ -0,0 +1,134 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 WorkRequestError(object): + """ + An error encountered while executing a work request. + """ + + def __init__(self, **kwargs): + """ + Initializes a new WorkRequestError object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param code: + The value to assign to the code property of this WorkRequestError. + :type code: str + + :param message: + The value to assign to the message property of this WorkRequestError. + :type message: str + + :param timestamp: + The value to assign to the timestamp property of this WorkRequestError. + :type timestamp: datetime + + """ + self.swagger_types = { + 'code': 'str', + 'message': 'str', + 'timestamp': 'datetime' + } + + self.attribute_map = { + 'code': 'code', + 'message': 'message', + 'timestamp': 'timestamp' + } + + self._code = None + self._message = None + self._timestamp = None + + @property + def code(self): + """ + **[Required]** Gets the code of this WorkRequestError. + A machine-usable code for the error that occured. Error codes are listed on + (https://docs.cloud.oracle.com/Content/API/References/apierrors.htm) + + + :return: The code of this WorkRequestError. + :rtype: str + """ + return self._code + + @code.setter + def code(self, code): + """ + Sets the code of this WorkRequestError. + A machine-usable code for the error that occured. Error codes are listed on + (https://docs.cloud.oracle.com/Content/API/References/apierrors.htm) + + + :param code: The code of this WorkRequestError. + :type: str + """ + self._code = code + + @property + def message(self): + """ + **[Required]** Gets the message of this WorkRequestError. + A human readable description of the issue encountered. + + + :return: The message of this WorkRequestError. + :rtype: str + """ + return self._message + + @message.setter + def message(self, message): + """ + Sets the message of this WorkRequestError. + A human readable description of the issue encountered. + + + :param message: The message of this WorkRequestError. + :type: str + """ + self._message = message + + @property + def timestamp(self): + """ + **[Required]** Gets the timestamp of this WorkRequestError. + The time the error occured. An RFC3339 formatted datetime string. + + + :return: The timestamp of this WorkRequestError. + :rtype: datetime + """ + return self._timestamp + + @timestamp.setter + def timestamp(self, timestamp): + """ + Sets the timestamp of this WorkRequestError. + The time the error occured. An RFC3339 formatted datetime string. + + + :param timestamp: The timestamp of this WorkRequestError. + :type: datetime + """ + self._timestamp = timestamp + + 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/lockbox/models/work_request_error_collection.py b/src/oci/lockbox/models/work_request_error_collection.py new file mode 100644 index 0000000000..ff8aeef0a1 --- /dev/null +++ b/src/oci/lockbox/models/work_request_error_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 WorkRequestErrorCollection(object): + """ + Results of a workRequestError search. Contains both WorkRequestError items and other information, such as metadata. + """ + + def __init__(self, **kwargs): + """ + Initializes a new WorkRequestErrorCollection 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 WorkRequestErrorCollection. + :type items: list[oci.lockbox.models.WorkRequestError] + + """ + self.swagger_types = { + 'items': 'list[WorkRequestError]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this WorkRequestErrorCollection. + List of workRequestError objects. + + + :return: The items of this WorkRequestErrorCollection. + :rtype: list[oci.lockbox.models.WorkRequestError] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this WorkRequestErrorCollection. + List of workRequestError objects. + + + :param items: The items of this WorkRequestErrorCollection. + :type: list[oci.lockbox.models.WorkRequestError] + """ + 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/lockbox/models/work_request_log_entry.py b/src/oci/lockbox/models/work_request_log_entry.py new file mode 100644 index 0000000000..7b37ab8d12 --- /dev/null +++ b/src/oci/lockbox/models/work_request_log_entry.py @@ -0,0 +1,101 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 WorkRequestLogEntry(object): + """ + A log message from the execution of a work request. + """ + + def __init__(self, **kwargs): + """ + Initializes a new WorkRequestLogEntry object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param message: + The value to assign to the message property of this WorkRequestLogEntry. + :type message: str + + :param timestamp: + The value to assign to the timestamp property of this WorkRequestLogEntry. + :type timestamp: datetime + + """ + self.swagger_types = { + 'message': 'str', + 'timestamp': 'datetime' + } + + self.attribute_map = { + 'message': 'message', + 'timestamp': 'timestamp' + } + + self._message = None + self._timestamp = None + + @property + def message(self): + """ + **[Required]** Gets the message of this WorkRequestLogEntry. + Human-readable log message. + + + :return: The message of this WorkRequestLogEntry. + :rtype: str + """ + return self._message + + @message.setter + def message(self, message): + """ + Sets the message of this WorkRequestLogEntry. + Human-readable log message. + + + :param message: The message of this WorkRequestLogEntry. + :type: str + """ + self._message = message + + @property + def timestamp(self): + """ + **[Required]** Gets the timestamp of this WorkRequestLogEntry. + The time the log message was written. An RFC3339 formatted datetime string + + + :return: The timestamp of this WorkRequestLogEntry. + :rtype: datetime + """ + return self._timestamp + + @timestamp.setter + def timestamp(self, timestamp): + """ + Sets the timestamp of this WorkRequestLogEntry. + The time the log message was written. An RFC3339 formatted datetime string + + + :param timestamp: The timestamp of this WorkRequestLogEntry. + :type: datetime + """ + self._timestamp = timestamp + + 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/lockbox/models/work_request_log_entry_collection.py b/src/oci/lockbox/models/work_request_log_entry_collection.py new file mode 100644 index 0000000000..0b214bfb4e --- /dev/null +++ b/src/oci/lockbox/models/work_request_log_entry_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 WorkRequestLogEntryCollection(object): + """ + Results of a workRequestLog search. Contains both workRequestLog items and other information, such as metadata. + """ + + def __init__(self, **kwargs): + """ + Initializes a new WorkRequestLogEntryCollection 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 WorkRequestLogEntryCollection. + :type items: list[oci.lockbox.models.WorkRequestLogEntry] + + """ + self.swagger_types = { + 'items': 'list[WorkRequestLogEntry]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this WorkRequestLogEntryCollection. + List of workRequestLogEntries. + + + :return: The items of this WorkRequestLogEntryCollection. + :rtype: list[oci.lockbox.models.WorkRequestLogEntry] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this WorkRequestLogEntryCollection. + List of workRequestLogEntries. + + + :param items: The items of this WorkRequestLogEntryCollection. + :type: list[oci.lockbox.models.WorkRequestLogEntry] + """ + 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/lockbox/models/work_request_resource.py b/src/oci/lockbox/models/work_request_resource.py new file mode 100644 index 0000000000..c9a657433f --- /dev/null +++ b/src/oci/lockbox/models/work_request_resource.py @@ -0,0 +1,232 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 WorkRequestResource(object): + """ + A resource created or operated on by a work request. + """ + + #: A constant which can be used with the action_type property of a WorkRequestResource. + #: This constant has a value of "CREATED" + ACTION_TYPE_CREATED = "CREATED" + + #: A constant which can be used with the action_type property of a WorkRequestResource. + #: This constant has a value of "UPDATED" + ACTION_TYPE_UPDATED = "UPDATED" + + #: A constant which can be used with the action_type property of a WorkRequestResource. + #: This constant has a value of "DELETED" + ACTION_TYPE_DELETED = "DELETED" + + #: A constant which can be used with the action_type property of a WorkRequestResource. + #: This constant has a value of "IN_PROGRESS" + ACTION_TYPE_IN_PROGRESS = "IN_PROGRESS" + + #: A constant which can be used with the action_type property of a WorkRequestResource. + #: This constant has a value of "RELATED" + ACTION_TYPE_RELATED = "RELATED" + + #: A constant which can be used with the action_type property of a WorkRequestResource. + #: This constant has a value of "FAILED" + ACTION_TYPE_FAILED = "FAILED" + + def __init__(self, **kwargs): + """ + Initializes a new WorkRequestResource object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param entity_type: + The value to assign to the entity_type property of this WorkRequestResource. + :type entity_type: str + + :param action_type: + The value to assign to the action_type property of this WorkRequestResource. + Allowed values for this property are: "CREATED", "UPDATED", "DELETED", "IN_PROGRESS", "RELATED", "FAILED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type action_type: str + + :param identifier: + The value to assign to the identifier property of this WorkRequestResource. + :type identifier: str + + :param entity_uri: + The value to assign to the entity_uri property of this WorkRequestResource. + :type entity_uri: str + + :param metadata: + The value to assign to the metadata property of this WorkRequestResource. + :type metadata: dict(str, str) + + """ + self.swagger_types = { + 'entity_type': 'str', + 'action_type': 'str', + 'identifier': 'str', + 'entity_uri': 'str', + 'metadata': 'dict(str, str)' + } + + self.attribute_map = { + 'entity_type': 'entityType', + 'action_type': 'actionType', + 'identifier': 'identifier', + 'entity_uri': 'entityUri', + 'metadata': 'metadata' + } + + self._entity_type = None + self._action_type = None + self._identifier = None + self._entity_uri = None + self._metadata = None + + @property + def entity_type(self): + """ + **[Required]** Gets the entity_type of this WorkRequestResource. + The resource type the work request affects. + + + :return: The entity_type of this WorkRequestResource. + :rtype: str + """ + return self._entity_type + + @entity_type.setter + def entity_type(self, entity_type): + """ + Sets the entity_type of this WorkRequestResource. + The resource type the work request affects. + + + :param entity_type: The entity_type of this WorkRequestResource. + :type: str + """ + self._entity_type = entity_type + + @property + def action_type(self): + """ + **[Required]** Gets the action_type of this WorkRequestResource. + The way in which this resource is affected by the work tracked in the work request. + A resource being created, updated, or deleted will remain in the IN_PROGRESS state until + work is complete for that resource at which point it will transition to CREATED, UPDATED, + or DELETED, respectively. + + Allowed values for this property are: "CREATED", "UPDATED", "DELETED", "IN_PROGRESS", "RELATED", "FAILED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The action_type of this WorkRequestResource. + :rtype: str + """ + return self._action_type + + @action_type.setter + def action_type(self, action_type): + """ + Sets the action_type of this WorkRequestResource. + The way in which this resource is affected by the work tracked in the work request. + A resource being created, updated, or deleted will remain in the IN_PROGRESS state until + work is complete for that resource at which point it will transition to CREATED, UPDATED, + or DELETED, respectively. + + + :param action_type: The action_type of this WorkRequestResource. + :type: str + """ + allowed_values = ["CREATED", "UPDATED", "DELETED", "IN_PROGRESS", "RELATED", "FAILED"] + if not value_allowed_none_or_none_sentinel(action_type, allowed_values): + action_type = 'UNKNOWN_ENUM_VALUE' + self._action_type = action_type + + @property + def identifier(self): + """ + **[Required]** Gets the identifier of this WorkRequestResource. + The identifier of the resource the work request affects. + + + :return: The identifier of this WorkRequestResource. + :rtype: str + """ + return self._identifier + + @identifier.setter + def identifier(self, identifier): + """ + Sets the identifier of this WorkRequestResource. + The identifier of the resource the work request affects. + + + :param identifier: The identifier of this WorkRequestResource. + :type: str + """ + self._identifier = identifier + + @property + def entity_uri(self): + """ + Gets the entity_uri of this WorkRequestResource. + The URI path that the user can do a GET on to access the resource metadata + + + :return: The entity_uri of this WorkRequestResource. + :rtype: str + """ + return self._entity_uri + + @entity_uri.setter + def entity_uri(self, entity_uri): + """ + Sets the entity_uri of this WorkRequestResource. + The URI path that the user can do a GET on to access the resource metadata + + + :param entity_uri: The entity_uri of this WorkRequestResource. + :type: str + """ + self._entity_uri = entity_uri + + @property + def metadata(self): + """ + Gets the metadata of this WorkRequestResource. + Additional information that helps to explain the resource. + + + :return: The metadata of this WorkRequestResource. + :rtype: dict(str, str) + """ + return self._metadata + + @metadata.setter + def metadata(self, metadata): + """ + Sets the metadata of this WorkRequestResource. + Additional information that helps to explain the resource. + + + :param metadata: The metadata of this WorkRequestResource. + :type: dict(str, str) + """ + self._metadata = metadata + + 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/lockbox/models/work_request_summary.py b/src/oci/lockbox/models/work_request_summary.py new file mode 100644 index 0000000000..a865099d6d --- /dev/null +++ b/src/oci/lockbox/models/work_request_summary.py @@ -0,0 +1,428 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 WorkRequestSummary(object): + """ + A summary of the status of a work request. + """ + + #: A constant which can be used with the operation_type property of a WorkRequestSummary. + #: This constant has a value of "CREATE_LOCKBOX" + OPERATION_TYPE_CREATE_LOCKBOX = "CREATE_LOCKBOX" + + #: A constant which can be used with the operation_type property of a WorkRequestSummary. + #: This constant has a value of "UPDATE_LOCKBOX" + OPERATION_TYPE_UPDATE_LOCKBOX = "UPDATE_LOCKBOX" + + #: A constant which can be used with the operation_type property of a WorkRequestSummary. + #: This constant has a value of "DELETE_LOCKBOX" + OPERATION_TYPE_DELETE_LOCKBOX = "DELETE_LOCKBOX" + + #: A constant which can be used with the operation_type property of a WorkRequestSummary. + #: This constant has a value of "MOVE_LOCKBOX" + OPERATION_TYPE_MOVE_LOCKBOX = "MOVE_LOCKBOX" + + #: A constant which can be used with the operation_type property of a WorkRequestSummary. + #: This constant has a value of "CREATE_ACCESS_REQUEST" + OPERATION_TYPE_CREATE_ACCESS_REQUEST = "CREATE_ACCESS_REQUEST" + + #: A constant which can be used with the operation_type property of a WorkRequestSummary. + #: This constant has a value of "APPROVE_ACCESS_REQUEST" + OPERATION_TYPE_APPROVE_ACCESS_REQUEST = "APPROVE_ACCESS_REQUEST" + + #: A constant which can be used with the operation_type property of a WorkRequestSummary. + #: This constant has a value of "REVOKE_ACCESS_REQUEST" + OPERATION_TYPE_REVOKE_ACCESS_REQUEST = "REVOKE_ACCESS_REQUEST" + + #: A constant which can be used with the operation_type property of a WorkRequestSummary. + #: This constant has a value of "CREATE_APPROVAL_TEMPLATE" + OPERATION_TYPE_CREATE_APPROVAL_TEMPLATE = "CREATE_APPROVAL_TEMPLATE" + + #: A constant which can be used with the operation_type property of a WorkRequestSummary. + #: This constant has a value of "MOVE_APPROVAL_TEMPLATE" + OPERATION_TYPE_MOVE_APPROVAL_TEMPLATE = "MOVE_APPROVAL_TEMPLATE" + + #: A constant which can be used with the operation_type property of a WorkRequestSummary. + #: This constant has a value of "UPDATE_APPROVAL_TEMPLATE" + OPERATION_TYPE_UPDATE_APPROVAL_TEMPLATE = "UPDATE_APPROVAL_TEMPLATE" + + #: A constant which can be used with the operation_type property of a WorkRequestSummary. + #: This constant has a value of "DELETE_APPROVAL_TEMPLATE" + OPERATION_TYPE_DELETE_APPROVAL_TEMPLATE = "DELETE_APPROVAL_TEMPLATE" + + #: A constant which can be used with the status property of a WorkRequestSummary. + #: This constant has a value of "ACCEPTED" + STATUS_ACCEPTED = "ACCEPTED" + + #: A constant which can be used with the status property of a WorkRequestSummary. + #: This constant has a value of "IN_PROGRESS" + STATUS_IN_PROGRESS = "IN_PROGRESS" + + #: A constant which can be used with the status property of a WorkRequestSummary. + #: This constant has a value of "WAITING" + STATUS_WAITING = "WAITING" + + #: A constant which can be used with the status property of a WorkRequestSummary. + #: This constant has a value of "FAILED" + STATUS_FAILED = "FAILED" + + #: A constant which can be used with the status property of a WorkRequestSummary. + #: This constant has a value of "SUCCEEDED" + STATUS_SUCCEEDED = "SUCCEEDED" + + #: A constant which can be used with the status property of a WorkRequestSummary. + #: This constant has a value of "CANCELING" + STATUS_CANCELING = "CANCELING" + + #: A constant which can be used with the status property of a WorkRequestSummary. + #: This constant has a value of "CANCELED" + STATUS_CANCELED = "CANCELED" + + def __init__(self, **kwargs): + """ + Initializes a new WorkRequestSummary object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param operation_type: + The value to assign to the operation_type property of this WorkRequestSummary. + Allowed values for this property are: "CREATE_LOCKBOX", "UPDATE_LOCKBOX", "DELETE_LOCKBOX", "MOVE_LOCKBOX", "CREATE_ACCESS_REQUEST", "APPROVE_ACCESS_REQUEST", "REVOKE_ACCESS_REQUEST", "CREATE_APPROVAL_TEMPLATE", "MOVE_APPROVAL_TEMPLATE", "UPDATE_APPROVAL_TEMPLATE", "DELETE_APPROVAL_TEMPLATE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type operation_type: str + + :param status: + The value to assign to the status property of this WorkRequestSummary. + Allowed values for this property are: "ACCEPTED", "IN_PROGRESS", "WAITING", "FAILED", "SUCCEEDED", "CANCELING", "CANCELED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type status: str + + :param id: + The value to assign to the id property of this WorkRequestSummary. + :type id: str + + :param compartment_id: + The value to assign to the compartment_id property of this WorkRequestSummary. + :type compartment_id: str + + :param resources: + The value to assign to the resources property of this WorkRequestSummary. + :type resources: list[oci.lockbox.models.WorkRequestResource] + + :param percent_complete: + The value to assign to the percent_complete property of this WorkRequestSummary. + :type percent_complete: float + + :param time_accepted: + The value to assign to the time_accepted property of this WorkRequestSummary. + :type time_accepted: datetime + + :param time_started: + The value to assign to the time_started property of this WorkRequestSummary. + :type time_started: datetime + + :param time_finished: + The value to assign to the time_finished property of this WorkRequestSummary. + :type time_finished: datetime + + """ + self.swagger_types = { + 'operation_type': 'str', + 'status': 'str', + 'id': 'str', + 'compartment_id': 'str', + 'resources': 'list[WorkRequestResource]', + 'percent_complete': 'float', + 'time_accepted': 'datetime', + 'time_started': 'datetime', + 'time_finished': 'datetime' + } + + self.attribute_map = { + 'operation_type': 'operationType', + 'status': 'status', + 'id': 'id', + 'compartment_id': 'compartmentId', + 'resources': 'resources', + 'percent_complete': 'percentComplete', + 'time_accepted': 'timeAccepted', + 'time_started': 'timeStarted', + 'time_finished': 'timeFinished' + } + + self._operation_type = None + self._status = None + self._id = None + self._compartment_id = None + self._resources = None + self._percent_complete = None + self._time_accepted = None + self._time_started = None + self._time_finished = None + + @property + def operation_type(self): + """ + **[Required]** Gets the operation_type of this WorkRequestSummary. + Type of the work request + + Allowed values for this property are: "CREATE_LOCKBOX", "UPDATE_LOCKBOX", "DELETE_LOCKBOX", "MOVE_LOCKBOX", "CREATE_ACCESS_REQUEST", "APPROVE_ACCESS_REQUEST", "REVOKE_ACCESS_REQUEST", "CREATE_APPROVAL_TEMPLATE", "MOVE_APPROVAL_TEMPLATE", "UPDATE_APPROVAL_TEMPLATE", "DELETE_APPROVAL_TEMPLATE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The operation_type of this WorkRequestSummary. + :rtype: str + """ + return self._operation_type + + @operation_type.setter + def operation_type(self, operation_type): + """ + Sets the operation_type of this WorkRequestSummary. + Type of the work request + + + :param operation_type: The operation_type of this WorkRequestSummary. + :type: str + """ + allowed_values = ["CREATE_LOCKBOX", "UPDATE_LOCKBOX", "DELETE_LOCKBOX", "MOVE_LOCKBOX", "CREATE_ACCESS_REQUEST", "APPROVE_ACCESS_REQUEST", "REVOKE_ACCESS_REQUEST", "CREATE_APPROVAL_TEMPLATE", "MOVE_APPROVAL_TEMPLATE", "UPDATE_APPROVAL_TEMPLATE", "DELETE_APPROVAL_TEMPLATE"] + if not value_allowed_none_or_none_sentinel(operation_type, allowed_values): + operation_type = 'UNKNOWN_ENUM_VALUE' + self._operation_type = operation_type + + @property + def status(self): + """ + **[Required]** Gets the status of this WorkRequestSummary. + Status of current work request. + + Allowed values for this property are: "ACCEPTED", "IN_PROGRESS", "WAITING", "FAILED", "SUCCEEDED", "CANCELING", "CANCELED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The status of this WorkRequestSummary. + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """ + Sets the status of this WorkRequestSummary. + Status of current work request. + + + :param status: The status of this WorkRequestSummary. + :type: str + """ + allowed_values = ["ACCEPTED", "IN_PROGRESS", "WAITING", "FAILED", "SUCCEEDED", "CANCELING", "CANCELED"] + if not value_allowed_none_or_none_sentinel(status, allowed_values): + status = 'UNKNOWN_ENUM_VALUE' + self._status = status + + @property + def id(self): + """ + **[Required]** Gets the id of this WorkRequestSummary. + The id of the work request. + + + :return: The id of this WorkRequestSummary. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this WorkRequestSummary. + The id of the work request. + + + :param id: The id of this WorkRequestSummary. + :type: str + """ + self._id = id + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this WorkRequestSummary. + The ocid of the compartment that contains the work request. Work requests should be scoped to + the same compartment as the resource the work request affects. If the work request affects multiple resources, + and those resources are not in the same compartment, it is up to the service team to pick the primary + resource whose compartment should be used + + + :return: The compartment_id of this WorkRequestSummary. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this WorkRequestSummary. + The ocid of the compartment that contains the work request. Work requests should be scoped to + the same compartment as the resource the work request affects. If the work request affects multiple resources, + and those resources are not in the same compartment, it is up to the service team to pick the primary + resource whose compartment should be used + + + :param compartment_id: The compartment_id of this WorkRequestSummary. + :type: str + """ + self._compartment_id = compartment_id + + @property + def resources(self): + """ + **[Required]** Gets the resources of this WorkRequestSummary. + The resources affected by this work request. + + + :return: The resources of this WorkRequestSummary. + :rtype: list[oci.lockbox.models.WorkRequestResource] + """ + return self._resources + + @resources.setter + def resources(self, resources): + """ + Sets the resources of this WorkRequestSummary. + The resources affected by this work request. + + + :param resources: The resources of this WorkRequestSummary. + :type: list[oci.lockbox.models.WorkRequestResource] + """ + self._resources = resources + + @property + def percent_complete(self): + """ + **[Required]** Gets the percent_complete of this WorkRequestSummary. + Percentage of the request completed. + + + :return: The percent_complete of this WorkRequestSummary. + :rtype: float + """ + return self._percent_complete + + @percent_complete.setter + def percent_complete(self, percent_complete): + """ + Sets the percent_complete of this WorkRequestSummary. + Percentage of the request completed. + + + :param percent_complete: The percent_complete of this WorkRequestSummary. + :type: float + """ + self._percent_complete = percent_complete + + @property + def time_accepted(self): + """ + **[Required]** Gets the time_accepted of this WorkRequestSummary. + The date and time the request was created, as described in + `RFC 3339`__, section 14.29. + + __ https://tools.ietf.org/rfc/rfc3339 + + + :return: The time_accepted of this WorkRequestSummary. + :rtype: datetime + """ + return self._time_accepted + + @time_accepted.setter + def time_accepted(self, time_accepted): + """ + Sets the time_accepted of this WorkRequestSummary. + The date and time the request was created, as described in + `RFC 3339`__, section 14.29. + + __ https://tools.ietf.org/rfc/rfc3339 + + + :param time_accepted: The time_accepted of this WorkRequestSummary. + :type: datetime + """ + self._time_accepted = time_accepted + + @property + def time_started(self): + """ + Gets the time_started of this WorkRequestSummary. + The date and time the request was started, as described in `RFC 3339`__, + section 14.29. + + __ https://tools.ietf.org/rfc/rfc3339 + + + :return: The time_started of this WorkRequestSummary. + :rtype: datetime + """ + return self._time_started + + @time_started.setter + def time_started(self, time_started): + """ + Sets the time_started of this WorkRequestSummary. + The date and time the request was started, as described in `RFC 3339`__, + section 14.29. + + __ https://tools.ietf.org/rfc/rfc3339 + + + :param time_started: The time_started of this WorkRequestSummary. + :type: datetime + """ + self._time_started = time_started + + @property + def time_finished(self): + """ + Gets the time_finished of this WorkRequestSummary. + The date and time the object was finished, as described in `RFC 3339`__. + + __ https://tools.ietf.org/rfc/rfc3339 + + + :return: The time_finished of this WorkRequestSummary. + :rtype: datetime + """ + return self._time_finished + + @time_finished.setter + def time_finished(self, time_finished): + """ + Sets the time_finished of this WorkRequestSummary. + The date and time the object was finished, as described in `RFC 3339`__. + + __ https://tools.ietf.org/rfc/rfc3339 + + + :param time_finished: The time_finished of this WorkRequestSummary. + :type: datetime + """ + self._time_finished = time_finished + + 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/lockbox/models/work_request_summary_collection.py b/src/oci/lockbox/models/work_request_summary_collection.py new file mode 100644 index 0000000000..53c743c4d2 --- /dev/null +++ b/src/oci/lockbox/models/work_request_summary_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 WorkRequestSummaryCollection(object): + """ + Results of a workRequest search. Contains both WorkRequest items and other information, such as metadata. + """ + + def __init__(self, **kwargs): + """ + Initializes a new WorkRequestSummaryCollection 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 WorkRequestSummaryCollection. + :type items: list[oci.lockbox.models.WorkRequestSummary] + + """ + self.swagger_types = { + 'items': 'list[WorkRequestSummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this WorkRequestSummaryCollection. + List of workRequestSummary objects. + + + :return: The items of this WorkRequestSummaryCollection. + :rtype: list[oci.lockbox.models.WorkRequestSummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this WorkRequestSummaryCollection. + List of workRequestSummary objects. + + + :param items: The items of this WorkRequestSummaryCollection. + :type: list[oci.lockbox.models.WorkRequestSummary] + """ + 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/media_services/__init__.py b/src/oci/media_services/__init__.py new file mode 100644 index 0000000000..0bcc2b42c0 --- /dev/null +++ b/src/oci/media_services/__init__.py @@ -0,0 +1,12 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from __future__ import absolute_import + + +from .media_services_client import MediaServicesClient +from .media_services_client_composite_operations import MediaServicesClientCompositeOperations +from . import models + +__all__ = ["MediaServicesClient", "MediaServicesClientCompositeOperations", "models"] diff --git a/src/oci/media_services/media_services_client.py b/src/oci/media_services/media_services_client.py new file mode 100644 index 0000000000..eea10ae8ad --- /dev/null +++ b/src/oci/media_services/media_services_client.py @@ -0,0 +1,5619 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from __future__ import absolute_import + +from oci._vendor import requests # noqa: F401 +from oci._vendor import six + +from oci import retry, circuit_breaker # noqa: F401 +from oci.base_client import BaseClient +from oci.config import get_config_value_or_default, validate_config +from oci.signer import Signer +from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from .models import media_services_type_mapping +missing = Sentinel("Missing") + + +class MediaServicesClient(object): + """ + Media Services (includes Media Flow and Media Streams) is a fully managed service for processing media (video) source content. Use Media Flow and Media Streams to transcode and package digital video using configurable workflows and stream video outputs. + + Use the Media Services API to configure media workflows and run Media Flow jobs, create distribution channels, ingest assets, create Preview URLs and play assets. For more information, see [Media Flow](/iaas/Content/dms-mediaflow/home.htm) and Media Streams [Media Streams](/iaas/Content/dms-mediastream/home.htm). + + Use the table of contents and search tool to explore the Media Flow API and Media Streams API. + """ + + def __init__(self, config, **kwargs): + """ + Creates a new service client + + :param dict config: + Configuration keys and values as per `SDK and Tool Configuration `__. + The :py:meth:`~oci.config.from_file` method can be used to load configuration from a file. Alternatively, a ``dict`` can be passed. You can validate_config + the dict using :py:meth:`~oci.config.validate_config` + + :param str service_endpoint: (optional) + The endpoint of the service to call using this client. For example ``https://iaas.us-ashburn-1.oraclecloud.com``. If this keyword argument is + not provided then it will be derived using the region in the config parameter. You should only provide this keyword argument if you have an explicit + need to specify a service endpoint. + + :param timeout: (optional) + The connection and read timeouts for the client. The default values are connection timeout 10 seconds and read timeout 60 seconds. This keyword argument can be provided + as a single float, in which case the value provided is used for both the read and connection timeouts, or as a tuple of two floats. If + a tuple is provided then the first value is used as the connection timeout and the second value as the read timeout. + :type timeout: float or tuple(float, float) + + :param signer: (optional) + The signer to use when signing requests made by the service client. The default is to use a :py:class:`~oci.signer.Signer` based on the values + provided in the config parameter. + + One use case for this parameter is for `Instance Principals authentication `__ + by passing an instance of :py:class:`~oci.auth.signers.InstancePrincipalsSecurityTokenSigner` as the value for this keyword argument + :type signer: :py:class:`~oci.signer.AbstractBaseSigner` + + :param obj retry_strategy: (optional) + A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. + Retry strategies can also be applied at the operation level by passing a ``retry_strategy`` keyword argument as part of calling the operation. + Any value provided at the operation level will override whatever is specified at the client level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` + is also available. The specifics of the default retry strategy are described `here `__. + + :param obj circuit_breaker_strategy: (optional) + A circuit breaker strategy to apply to all calls made by this service client (i.e. at the client level). + This client uses :py:data:`~oci.circuit_breaker.DEFAULT_CIRCUIT_BREAKER_STRATEGY` as default if no circuit breaker strategy is provided. + The specifics of circuit breaker strategy are described `here `__. + + :param function circuit_breaker_callback: (optional) + Callback function to receive any exceptions triggerred by the circuit breaker. + + :param allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not + allow control characters to be in the response object. + """ + validate_config(config, signer=kwargs.get('signer')) + if 'signer' in kwargs: + signer = kwargs['signer'] + + elif AUTHENTICATION_TYPE_FIELD_NAME in config: + signer = get_signer_from_authentication_type(config) + + else: + signer = Signer( + tenancy=config["tenancy"], + user=config["user"], + fingerprint=config["fingerprint"], + private_key_file_location=config.get("key_file"), + pass_phrase=get_config_value_or_default(config, "pass_phrase"), + private_key_content=config.get("key_content") + ) + + base_client_init_kwargs = { + 'regional_client': True, + 'service_endpoint': kwargs.get('service_endpoint'), + 'base_path': '/20211101', + 'service_endpoint_template': 'https://mediaservices.{region}.oci.{secondLevelDomain}', + 'skip_deserialization': kwargs.get('skip_deserialization', False), + 'circuit_breaker_strategy': kwargs.get('circuit_breaker_strategy', circuit_breaker.GLOBAL_CIRCUIT_BREAKER_STRATEGY) + } + if 'timeout' in kwargs: + base_client_init_kwargs['timeout'] = kwargs.get('timeout') + if base_client_init_kwargs.get('circuit_breaker_strategy') is None: + base_client_init_kwargs['circuit_breaker_strategy'] = circuit_breaker.DEFAULT_CIRCUIT_BREAKER_STRATEGY + if 'allow_control_chars' in kwargs: + base_client_init_kwargs['allow_control_chars'] = kwargs.get('allow_control_chars') + self.base_client = BaseClient("media_services", config, signer, media_services_type_mapping, **base_client_init_kwargs) + self.retry_strategy = kwargs.get('retry_strategy') + self.circuit_breaker_callback = kwargs.get('circuit_breaker_callback') + + def change_media_asset_compartment(self, media_asset_id, change_media_asset_compartment_details, **kwargs): + """ + Moves a MediaAsset resource from one compartment identifier to another. + + + :param str media_asset_id: (required) + Unique MediaAsset identifier + + :param oci.media_services.models.ChangeMediaAssetCompartmentDetails change_media_asset_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 the 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 will be updated or deleted only if the etag you + provide matches the resource's current etag value. + + :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 None + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use change_media_asset_compartment API. + """ + resource_path = "/mediaAssets/{mediaAssetId}/actions/changeCompartment" + method = "POST" + operation_name = "change_media_asset_compartment" + api_reference_link = "" + + # 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( + "change_media_asset_compartment got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "mediaAssetId": media_asset_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-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_media_asset_compartment_details, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=change_media_asset_compartment_details, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def change_media_workflow_compartment(self, media_workflow_id, change_media_workflow_compartment_details, **kwargs): + """ + Moves a MediaWorkflow resource from one compartment identifier to another. + + + :param str media_workflow_id: (required) + Unique MediaWorkflow identifier. + + :param oci.media_services.models.ChangeMediaWorkflowCompartmentDetails change_media_workflow_compartment_details: (required) + The change compartment payload. + + :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 the 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 will be updated or deleted only if the etag you + provide matches the resource's current etag value. + + :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 None + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use change_media_workflow_compartment API. + """ + resource_path = "/mediaWorkflows/{mediaWorkflowId}/actions/changeCompartment" + method = "POST" + operation_name = "change_media_workflow_compartment" + api_reference_link = "" + + # 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( + "change_media_workflow_compartment got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "mediaWorkflowId": media_workflow_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-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_media_workflow_compartment_details, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=change_media_workflow_compartment_details, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def change_media_workflow_configuration_compartment(self, media_workflow_configuration_id, change_media_workflow_configuration_compartment_details, **kwargs): + """ + Moves a MediaWorkflowConfiguration resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource. + + + :param str media_workflow_configuration_id: (required) + Unique MediaWorkflowConfiguration identifier. + + :param oci.media_services.models.ChangeMediaWorkflowConfigurationCompartmentDetails change_media_workflow_configuration_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 the 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 will be updated or deleted only if the etag you + provide matches the resource's current etag value. + + :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 None + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use change_media_workflow_configuration_compartment API. + """ + resource_path = "/mediaWorkflowConfigurations/{mediaWorkflowConfigurationId}/actions/changeCompartment" + method = "POST" + operation_name = "change_media_workflow_configuration_compartment" + api_reference_link = "" + + # 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( + "change_media_workflow_configuration_compartment got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "mediaWorkflowConfigurationId": media_workflow_configuration_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-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_media_workflow_configuration_compartment_details, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=change_media_workflow_configuration_compartment_details, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def change_media_workflow_job_compartment(self, media_workflow_job_id, change_media_workflow_job_compartment_details, **kwargs): + """ + Moves a MediaWorkflowJob resource from one compartment identifier to another. + + + :param str media_workflow_job_id: (required) + Unique MediaWorkflowJob identifier. + + :param oci.media_services.models.ChangeMediaWorkflowJobCompartmentDetails change_media_workflow_job_compartment_details: (required) + The change compartment payload. + + :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 the 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 will be updated or deleted only if the etag you + provide matches the resource's current etag value. + + :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 None + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use change_media_workflow_job_compartment API. + """ + resource_path = "/mediaWorkflowJobs/{mediaWorkflowJobId}/actions/changeCompartment" + method = "POST" + operation_name = "change_media_workflow_job_compartment" + api_reference_link = "" + + # 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( + "change_media_workflow_job_compartment got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "mediaWorkflowJobId": media_workflow_job_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-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_media_workflow_job_compartment_details, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=change_media_workflow_job_compartment_details, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def change_stream_distribution_channel_compartment(self, stream_distribution_channel_id, change_stream_distribution_channel_compartment_details, **kwargs): + """ + Moves a Stream Distribution Channel resource from one compartment identifier to another. + + + :param str stream_distribution_channel_id: (required) + Unique Stream Distribution Channel path identifier. + + :param oci.media_services.models.ChangeStreamDistributionChannelCompartmentDetails change_stream_distribution_channel_compartment_details: (required) + The change compartment payload. + + :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 the 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 will be updated or deleted only if the etag you + provide matches the resource's current etag value. + + :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 None + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use change_stream_distribution_channel_compartment API. + """ + resource_path = "/streamDistributionChannels/{streamDistributionChannelId}/actions/changeCompartment" + method = "POST" + operation_name = "change_stream_distribution_channel_compartment" + api_reference_link = "" + + # 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( + "change_stream_distribution_channel_compartment got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "streamDistributionChannelId": stream_distribution_channel_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-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_stream_distribution_channel_compartment_details, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=change_stream_distribution_channel_compartment_details, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def create_media_asset(self, create_media_asset_details, **kwargs): + """ + Creates a new MediaAsset. + + + :param oci.media_services.models.CreateMediaAssetDetails create_media_asset_details: (required) + Details for the new MediaAsset. + + :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 the 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) + 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.media_services.models.MediaAsset` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use create_media_asset API. + """ + resource_path = "/mediaAssets" + method = "POST" + operation_name = "create_media_asset" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_retry_token", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "create_media_asset got unknown kwargs: {!r}".format(extra_kwargs)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-retry-token": kwargs.get("opc_retry_token", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_retry_token_if_needed(header_params) + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + header_params=header_params, + body=create_media_asset_details, + response_type="MediaAsset", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + header_params=header_params, + body=create_media_asset_details, + response_type="MediaAsset", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def create_media_workflow(self, create_media_workflow_details, **kwargs): + """ + Creates a new MediaWorkflow. + + + :param oci.media_services.models.CreateMediaWorkflowDetails create_media_workflow_details: (required) + Details for the new MediaWorkflow. + + :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 the 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) + 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.media_services.models.MediaWorkflow` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use create_media_workflow API. + """ + resource_path = "/mediaWorkflows" + method = "POST" + operation_name = "create_media_workflow" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_retry_token", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "create_media_workflow got unknown kwargs: {!r}".format(extra_kwargs)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-retry-token": kwargs.get("opc_retry_token", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_retry_token_if_needed(header_params) + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + header_params=header_params, + body=create_media_workflow_details, + response_type="MediaWorkflow", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + header_params=header_params, + body=create_media_workflow_details, + response_type="MediaWorkflow", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def create_media_workflow_configuration(self, create_media_workflow_configuration_details, **kwargs): + """ + Creates a new MediaWorkflowConfiguration. + + + :param oci.media_services.models.CreateMediaWorkflowConfigurationDetails create_media_workflow_configuration_details: (required) + Details for the new MediaWorkflowConfiguration. + + :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 the 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) + 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.media_services.models.MediaWorkflowConfiguration` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use create_media_workflow_configuration API. + """ + resource_path = "/mediaWorkflowConfigurations" + method = "POST" + operation_name = "create_media_workflow_configuration" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_retry_token", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "create_media_workflow_configuration got unknown kwargs: {!r}".format(extra_kwargs)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-retry-token": kwargs.get("opc_retry_token", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_retry_token_if_needed(header_params) + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + header_params=header_params, + body=create_media_workflow_configuration_details, + response_type="MediaWorkflowConfiguration", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + header_params=header_params, + body=create_media_workflow_configuration_details, + response_type="MediaWorkflowConfiguration", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def create_media_workflow_job(self, create_media_workflow_job_details, **kwargs): + """ + Run the MediaWorkflow according to the given mediaWorkflow definition and configuration. + + + :param oci.media_services.models.CreateMediaWorkflowJobDetails create_media_workflow_job_details: (required) + The information to run the mediaWorkflow. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param str opc_retry_token: (optional) + A token that uniquely identifies a request so it can be retried in case of a timeout or + server error without the risk of executing that same action again. Retry tokens expire after 24 + hours, but can be invalidated before then due to conflicting operations. For example, if a resource + has been deleted and purged from the system, then a retry of the original creation request + might be rejected. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.media_services.models.MediaWorkflowJob` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use create_media_workflow_job API. + """ + resource_path = "/mediaWorkflowJobs" + method = "POST" + operation_name = "create_media_workflow_job" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id", + "opc_retry_token" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "create_media_workflow_job got unknown kwargs: {!r}".format(extra_kwargs)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing), + "opc-retry-token": kwargs.get("opc_retry_token", missing) + } + 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_media_workflow_job_details, + response_type="MediaWorkflowJob", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + header_params=header_params, + body=create_media_workflow_job_details, + response_type="MediaWorkflowJob", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def create_stream_cdn_config(self, create_stream_cdn_config_details, **kwargs): + """ + Creates a new CDN Configuration. + + + :param oci.media_services.models.CreateStreamCdnConfigDetails create_stream_cdn_config_details: (required) + Details for the new StreamCdnConfig. + + :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 the 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) + 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.media_services.models.StreamCdnConfig` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use create_stream_cdn_config API. + """ + resource_path = "/streamCdnConfigs" + method = "POST" + operation_name = "create_stream_cdn_config" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_retry_token", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "create_stream_cdn_config got unknown kwargs: {!r}".format(extra_kwargs)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-retry-token": kwargs.get("opc_retry_token", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_retry_token_if_needed(header_params) + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + header_params=header_params, + body=create_stream_cdn_config_details, + response_type="StreamCdnConfig", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + header_params=header_params, + body=create_stream_cdn_config_details, + response_type="StreamCdnConfig", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def create_stream_distribution_channel(self, create_stream_distribution_channel_details, **kwargs): + """ + Creates a new Stream Distribution Channel. + + + :param oci.media_services.models.CreateStreamDistributionChannelDetails create_stream_distribution_channel_details: (required) + Details for the new Stream Distribution Channel. + + :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 the 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) + 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.media_services.models.StreamDistributionChannel` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use create_stream_distribution_channel API. + """ + resource_path = "/streamDistributionChannels" + method = "POST" + operation_name = "create_stream_distribution_channel" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_retry_token", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "create_stream_distribution_channel got unknown kwargs: {!r}".format(extra_kwargs)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-retry-token": kwargs.get("opc_retry_token", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_retry_token_if_needed(header_params) + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + header_params=header_params, + body=create_stream_distribution_channel_details, + response_type="StreamDistributionChannel", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + header_params=header_params, + body=create_stream_distribution_channel_details, + response_type="StreamDistributionChannel", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def create_stream_packaging_config(self, create_stream_packaging_config_details, **kwargs): + """ + Creates a new Packaging Configuration. + + + :param oci.media_services.models.CreateStreamPackagingConfigDetails create_stream_packaging_config_details: (required) + Details for the new Stream Packaging Configuration. + + :param str opc_retry_token: (optional) + A token that uniquely identifies a request so it can be retried in case of a timeout or + server error without the 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) + 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.media_services.models.StreamPackagingConfig` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use create_stream_packaging_config API. + """ + resource_path = "/streamPackagingConfigs" + method = "POST" + operation_name = "create_stream_packaging_config" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_retry_token", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "create_stream_packaging_config got unknown kwargs: {!r}".format(extra_kwargs)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-retry-token": kwargs.get("opc_retry_token", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_retry_token_if_needed(header_params) + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + header_params=header_params, + body=create_stream_packaging_config_details, + response_type="StreamPackagingConfig", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + header_params=header_params, + body=create_stream_packaging_config_details, + response_type="StreamPackagingConfig", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def delete_media_asset(self, media_asset_id, **kwargs): + """ + Deletes a MediaAsset resource by identifier. If DeleteChildren is passed in as the mode, all the assets with the parentMediaAssetId matching the ID will be deleted. If DeleteDerivatives is set as the mode, all the assets with the masterMediaAssetId matching the ID will be deleted. + + + :param str media_asset_id: (required) + Unique MediaAsset identifier + + :param str if_match: (optional) + For optimistic concurrency control. In the PUT or DELETE call + for a resource, set the `if-match` parameter to the value of the + etag from a previous GET or POST response for that resource. + The resource will be updated or deleted only if the etag you + provide matches the resource's current etag value. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param str delete_mode: (optional) + DeleteMode decides whether to delete all the immediate children or all assets with the asset's ID as their masterMediaAssetId. + + Allowed values are: "DELETE_CHILDREN", "DELETE_DERIVATIONS" + + :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_media_asset API. + """ + resource_path = "/mediaAssets/{mediaAssetId}" + method = "DELETE" + operation_name = "delete_media_asset" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "if_match", + "opc_request_id", + "delete_mode" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "delete_media_asset got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "mediaAssetId": media_asset_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + if 'delete_mode' in kwargs: + delete_mode_allowed_values = ["DELETE_CHILDREN", "DELETE_DERIVATIONS"] + if kwargs['delete_mode'] not in delete_mode_allowed_values: + raise ValueError( + "Invalid value for `delete_mode`, must be one of {0}".format(delete_mode_allowed_values) + ) + + query_params = { + "deleteMode": kwargs.get("delete_mode", 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 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, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + 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) + + def delete_media_asset_distribution_channel_attachment(self, media_asset_id, distribution_channel_id, **kwargs): + """ + Deletes a MediaAsset from the DistributionChannel by identifiers. + + + :param str media_asset_id: (required) + Unique MediaAsset identifier + + :param str distribution_channel_id: (required) + Unique DistributionChannel identifier. + + :param str if_match: (optional) + For optimistic concurrency control. In the PUT or DELETE call + for a resource, set the `if-match` parameter to the value of the + etag from a previous GET or POST response for that resource. + The resource will be updated or deleted only if the etag you + provide matches the resource's current etag value. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param int version: (optional) + Version of the attachment. + + :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_media_asset_distribution_channel_attachment API. + """ + resource_path = "/mediaAssets/{mediaAssetId}/distributionChannelAttachments/{distributionChannelId}" + method = "DELETE" + operation_name = "delete_media_asset_distribution_channel_attachment" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "if_match", + "opc_request_id", + "version" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "delete_media_asset_distribution_channel_attachment got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "mediaAssetId": media_asset_id, + "distributionChannelId": distribution_channel_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + query_params = { + "version": kwargs.get("version", 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 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, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + 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) + + def delete_media_workflow(self, media_workflow_id, **kwargs): + """ + The MediaWorkflow lifecycleState will change to DELETED. + + + :param str media_workflow_id: (required) + Unique MediaWorkflow identifier. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :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 delete_media_workflow API. + """ + resource_path = "/mediaWorkflows/{mediaWorkflowId}" + method = "DELETE" + operation_name = "delete_media_workflow" + api_reference_link = "" + + # 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( + "delete_media_workflow got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "mediaWorkflowId": media_workflow_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing), + "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, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + 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) + + def delete_media_workflow_configuration(self, media_workflow_configuration_id, **kwargs): + """ + Deletes a MediaWorkflowConfiguration resource by identifier. + + + :param str media_workflow_configuration_id: (required) + Unique MediaWorkflowConfiguration identifier. + + :param str if_match: (optional) + For optimistic concurrency control. In the PUT or DELETE call + for a resource, set the `if-match` parameter to the value of the + etag from a previous GET or POST response for that resource. + The resource will be updated or deleted only if the etag you + provide matches the resource's current etag value. + + :param str opc_request_id: (optional) + 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 None + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use delete_media_workflow_configuration API. + """ + resource_path = "/mediaWorkflowConfigurations/{mediaWorkflowConfigurationId}" + method = "DELETE" + operation_name = "delete_media_workflow_configuration" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "if_match", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "delete_media_workflow_configuration got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "mediaWorkflowConfigurationId": media_workflow_configuration_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "if-match": kwargs.get("if_match", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + 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) + + def delete_media_workflow_job(self, media_workflow_job_id, **kwargs): + """ + This is an asynchronous operation. The MediaWorkflowJob lifecycleState will change to CANCELING temporarily until the job is completely CANCELED. + + + :param str media_workflow_job_id: (required) + Unique MediaWorkflowJob identifier. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :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 delete_media_workflow_job API. + """ + resource_path = "/mediaWorkflowJobs/{mediaWorkflowJobId}" + method = "DELETE" + operation_name = "delete_media_workflow_job" + api_reference_link = "" + + # 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( + "delete_media_workflow_job got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "mediaWorkflowJobId": media_workflow_job_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing), + "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, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + 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) + + def delete_stream_cdn_config(self, stream_cdn_config_id, **kwargs): + """ + The StreamCdnConfig lifecycleState will change to DELETED. + + + :param str stream_cdn_config_id: (required) + Unique StreamCdnConfig identifier. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :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 delete_stream_cdn_config API. + """ + resource_path = "/streamCdnConfigs/{streamCdnConfigId}" + method = "DELETE" + operation_name = "delete_stream_cdn_config" + api_reference_link = "" + + # 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( + "delete_stream_cdn_config got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "streamCdnConfigId": stream_cdn_config_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing), + "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, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + 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) + + def delete_stream_distribution_channel(self, stream_distribution_channel_id, **kwargs): + """ + The Stream Distribution Channel lifecycleState will change to DELETED. + + + :param str stream_distribution_channel_id: (required) + Unique Stream Distribution Channel path identifier. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :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 delete_stream_distribution_channel API. + """ + resource_path = "/streamDistributionChannels/{streamDistributionChannelId}" + method = "DELETE" + operation_name = "delete_stream_distribution_channel" + api_reference_link = "" + + # 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( + "delete_stream_distribution_channel got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "streamDistributionChannelId": stream_distribution_channel_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing), + "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, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + 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) + + def delete_stream_packaging_config(self, stream_packaging_config_id, **kwargs): + """ + The Stream Packaging Configuration lifecycleState will change to DELETED. + + + :param str stream_packaging_config_id: (required) + Unique Stream Packaging Configuration path identifier. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :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 delete_stream_packaging_config API. + """ + resource_path = "/streamPackagingConfigs/{streamPackagingConfigId}" + method = "DELETE" + operation_name = "delete_stream_packaging_config" + api_reference_link = "" + + # 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( + "delete_stream_packaging_config got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "streamPackagingConfigId": stream_packaging_config_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing), + "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, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + 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) + + def get_media_asset(self, media_asset_id, **kwargs): + """ + Gets a MediaAsset by identifier. + + + :param str media_asset_id: (required) + Unique MediaAsset identifier + + :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.media_services.models.MediaAsset` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_media_asset API. + """ + resource_path = "/mediaAssets/{mediaAssetId}" + method = "GET" + operation_name = "get_media_asset" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "get_media_asset got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "mediaAssetId": media_asset_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + if retry_strategy 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="MediaAsset", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="MediaAsset", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def get_media_asset_distribution_channel_attachment(self, media_asset_id, distribution_channel_id, **kwargs): + """ + Gets a MediaAssetDistributionChannelAttachment for a MediaAsset by identifiers. + + + :param str media_asset_id: (required) + Unique MediaAsset identifier + + :param str distribution_channel_id: (required) + Unique DistributionChannel identifier. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param int version: (optional) + Version of the attachment. + + :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.media_services.models.MediaAssetDistributionChannelAttachment` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_media_asset_distribution_channel_attachment API. + """ + resource_path = "/mediaAssets/{mediaAssetId}/distributionChannelAttachments/{distributionChannelId}" + method = "GET" + operation_name = "get_media_asset_distribution_channel_attachment" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id", + "version" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "get_media_asset_distribution_channel_attachment got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "mediaAssetId": media_asset_id, + "distributionChannelId": distribution_channel_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + query_params = { + "version": kwargs.get("version", 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="MediaAssetDistributionChannelAttachment", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + 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="MediaAssetDistributionChannelAttachment", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def get_media_workflow(self, media_workflow_id, **kwargs): + """ + Gets a MediaWorkflow by identifier. + + + :param str media_workflow_id: (required) + Unique MediaWorkflow identifier. + + :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.media_services.models.MediaWorkflow` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_media_workflow API. + """ + resource_path = "/mediaWorkflows/{mediaWorkflowId}" + method = "GET" + operation_name = "get_media_workflow" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "get_media_workflow got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "mediaWorkflowId": media_workflow_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + if retry_strategy 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="MediaWorkflow", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="MediaWorkflow", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def get_media_workflow_configuration(self, media_workflow_configuration_id, **kwargs): + """ + Gets a MediaWorkflowConfiguration by identifier + + + :param str media_workflow_configuration_id: (required) + Unique MediaWorkflowConfiguration identifier. + + :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.media_services.models.MediaWorkflowConfiguration` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_media_workflow_configuration API. + """ + resource_path = "/mediaWorkflowConfigurations/{mediaWorkflowConfigurationId}" + method = "GET" + operation_name = "get_media_workflow_configuration" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "get_media_workflow_configuration got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "mediaWorkflowConfigurationId": media_workflow_configuration_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + if retry_strategy 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="MediaWorkflowConfiguration", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="MediaWorkflowConfiguration", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def get_media_workflow_job(self, media_workflow_job_id, **kwargs): + """ + Gets the MediaWorkflowJob. + + + :param str media_workflow_job_id: (required) + Unique MediaWorkflowJob identifier. + + :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.media_services.models.MediaWorkflowJob` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_media_workflow_job API. + """ + resource_path = "/mediaWorkflowJobs/{mediaWorkflowJobId}" + method = "GET" + operation_name = "get_media_workflow_job" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "get_media_workflow_job got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "mediaWorkflowJobId": media_workflow_job_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + if retry_strategy 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="MediaWorkflowJob", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="MediaWorkflowJob", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def get_media_workflow_job_fact(self, media_workflow_job_id, key, **kwargs): + """ + Get the MediaWorkflowJobFact identified by the mediaWorkflowJobId and Fact ID. + + + :param str media_workflow_job_id: (required) + Unique MediaWorkflowJob identifier. + + :param int key: (required) + Identifier of the MediaWorkflowJobFact within a MediaWorkflowJob. + + :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.media_services.models.MediaWorkflowJobFact` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_media_workflow_job_fact API. + """ + resource_path = "/mediaWorkflowJobs/{mediaWorkflowJobId}/facts/{key}" + method = "GET" + operation_name = "get_media_workflow_job_fact" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "get_media_workflow_job_fact got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "mediaWorkflowJobId": media_workflow_job_id, + "key": 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('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + if retry_strategy 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="MediaWorkflowJobFact", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="MediaWorkflowJobFact", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def get_stream_cdn_config(self, stream_cdn_config_id, **kwargs): + """ + Gets a StreamCdnConfig by identifier. + + + :param str stream_cdn_config_id: (required) + Unique StreamCdnConfig identifier. + + :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.media_services.models.StreamCdnConfig` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_stream_cdn_config API. + """ + resource_path = "/streamCdnConfigs/{streamCdnConfigId}" + method = "GET" + operation_name = "get_stream_cdn_config" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "get_stream_cdn_config got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "streamCdnConfigId": stream_cdn_config_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + 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="StreamCdnConfig", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="StreamCdnConfig", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def get_stream_distribution_channel(self, stream_distribution_channel_id, **kwargs): + """ + Gets a Stream Distribution Channel by identifier. + + + :param str stream_distribution_channel_id: (required) + Unique Stream Distribution Channel path identifier. + + :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.media_services.models.StreamDistributionChannel` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_stream_distribution_channel API. + """ + resource_path = "/streamDistributionChannels/{streamDistributionChannelId}" + method = "GET" + operation_name = "get_stream_distribution_channel" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "get_stream_distribution_channel got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "streamDistributionChannelId": stream_distribution_channel_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + if retry_strategy 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="StreamDistributionChannel", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="StreamDistributionChannel", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def get_stream_packaging_config(self, stream_packaging_config_id, **kwargs): + """ + Gets a Stream Packaging Configuration by identifier. + + + :param str stream_packaging_config_id: (required) + Unique Stream Packaging Configuration path identifier. + + :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.media_services.models.StreamPackagingConfig` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_stream_packaging_config API. + """ + resource_path = "/streamPackagingConfigs/{streamPackagingConfigId}" + method = "GET" + operation_name = "get_stream_packaging_config" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "get_stream_packaging_config got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "streamPackagingConfigId": stream_packaging_config_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + 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="StreamPackagingConfig", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="StreamPackagingConfig", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def ingest_stream_distribution_channel(self, stream_distribution_channel_id, ingest_stream_distribution_channel_details, **kwargs): + """ + Ingests an Asset into a Distribution Channel. + + + :param str stream_distribution_channel_id: (required) + Unique Stream Distribution Channel path identifier. + + :param oci.media_services.models.IngestStreamDistributionChannelDetails ingest_stream_distribution_channel_details: (required) + Playlist entry information. + + :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 the 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) + 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.media_services.models.IngestStreamDistributionChannelResult` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use ingest_stream_distribution_channel API. + """ + resource_path = "/streamDistributionChannels/{streamDistributionChannelId}/actions/ingest" + method = "POST" + operation_name = "ingest_stream_distribution_channel" + api_reference_link = "" + + # 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( + "ingest_stream_distribution_channel got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "streamDistributionChannelId": stream_distribution_channel_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-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=ingest_stream_distribution_channel_details, + response_type="IngestStreamDistributionChannelResult", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=ingest_stream_distribution_channel_details, + response_type="IngestStreamDistributionChannelResult", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def list_media_asset_distribution_channel_attachments(self, media_asset_id, **kwargs): + """ + Lists the MediaAssetDistributionChannelAttachments for a MediaAsset by identifier. + + + :param str media_asset_id: (required) + Unique MediaAsset identifier + + :param str display_name: (optional) + A filter to return only the resources that match the entire display name given. + + :param int limit: (optional) + The maximum number of items to return. + + :param str page: (optional) + A token representing the position at which to start retrieving results. This must come from the + `opc-next-page` header field of a previous response. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param str sort_order: (optional) + The sort order to use, either 'ASC' or 'DESC'. + + Allowed values are: "ASC", "DESC" + + :param str sort_by: (optional) + The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. + + Allowed values are: "mediaAssetId", "distributionChannelId", "displayName", "version" + + :param str distribution_channel_id: (optional) + Unique DistributionChannel identifier. + + :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.media_services.models.MediaAssetDistributionChannelAttachmentCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_media_asset_distribution_channel_attachments API. + """ + resource_path = "/mediaAssets/{mediaAssetId}/distributionChannelAttachments" + method = "GET" + operation_name = "list_media_asset_distribution_channel_attachments" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "display_name", + "limit", + "page", + "opc_request_id", + "sort_order", + "sort_by", + "distribution_channel_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_media_asset_distribution_channel_attachments got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "mediaAssetId": media_asset_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + "Invalid value for `sort_order`, must be one of {0}".format(sort_order_allowed_values) + ) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["mediaAssetId", "distributionChannelId", "displayName", "version"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) + ) + + query_params = { + "displayName": kwargs.get("display_name", missing), + "limit": kwargs.get("limit", missing), + "page": kwargs.get("page", missing), + "sortOrder": kwargs.get("sort_order", missing), + "sortBy": kwargs.get("sort_by", missing), + "distributionChannelId": kwargs.get("distribution_channel_id", 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="MediaAssetDistributionChannelAttachmentCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + 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="MediaAssetDistributionChannelAttachmentCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def list_media_assets(self, **kwargs): + """ + Returns a list of MediaAssetSummary. + + + :param str compartment_id: (optional) + The ID of the compartment in which to list resources. + + :param str display_name: (optional) + A filter to return only the resources that match the entire display name given. + + :param int limit: (optional) + The maximum number of items to return. + + :param str page: (optional) + A token representing the position at which to start retrieving results. This must come from the + `opc-next-page` header field of a previous response. + + :param str lifecycle_state: (optional) + A filter to return only the resources with lifecycleState matching the given lifecycleState. + + Allowed values are: "CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED" + + :param str sort_order: (optional) + The sort order to use, either 'ASC' or 'DESC'. + + Allowed values are: "ASC", "DESC" + + :param str sort_by: (optional) + The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. + + Allowed values are: "compartmentId", "type", "lifecycleState", "parentMediaAssetId", "masterMediaAssetId", "displayName", "timeCreated", "timeUpdated" + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param str distribution_channel_id: (optional) + Unique DistributionChannel identifier. + + :param str parent_media_asset_id: (optional) + Unique MediaAsset identifier of the asset from which this asset is derived. + + :param str master_media_asset_id: (optional) + Unique MediaAsset identifier of the first asset upload. + + :param str type: (optional) + Filter MediaAsset by the asset type. + + Allowed values are: "AUDIO", "VIDEO", "PLAYLIST", "IMAGE", "CAPTION_FILE", "UNKNOWN" + + :param str bucket_name: (optional) + Filter MediaAsset by the bucket where the object is stored. + + :param str object_name: (optional) + Filter MediaAsset by the name of the object in object storage. + + :param str media_workflow_job_id: (optional) + The ID of the MediaWorkflowJob used to produce this asset, if this parameter is supplied then the workflow ID must also be supplied. + + :param str source_media_workflow_id: (optional) + The ID of the MediaWorkflow used to produce this asset. + + :param int source_media_workflow_version: (optional) + The version of the MediaWorkflow used to produce this asset. + + :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.media_services.models.MediaAssetCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_media_assets API. + """ + resource_path = "/mediaAssets" + method = "GET" + operation_name = "list_media_assets" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "compartment_id", + "display_name", + "limit", + "page", + "lifecycle_state", + "sort_order", + "sort_by", + "opc_request_id", + "distribution_channel_id", + "parent_media_asset_id", + "master_media_asset_id", + "type", + "bucket_name", + "object_name", + "media_workflow_job_id", + "source_media_workflow_id", + "source_media_workflow_version" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_media_assets got unknown kwargs: {!r}".format(extra_kwargs)) + + if 'lifecycle_state' in kwargs: + lifecycle_state_allowed_values = ["CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED"] + if kwargs['lifecycle_state'] not in lifecycle_state_allowed_values: + raise ValueError( + "Invalid value for `lifecycle_state`, must be one of {0}".format(lifecycle_state_allowed_values) + ) + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + "Invalid value for `sort_order`, must be one of {0}".format(sort_order_allowed_values) + ) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["compartmentId", "type", "lifecycleState", "parentMediaAssetId", "masterMediaAssetId", "displayName", "timeCreated", "timeUpdated"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) + ) + + if 'type' in kwargs: + type_allowed_values = ["AUDIO", "VIDEO", "PLAYLIST", "IMAGE", "CAPTION_FILE", "UNKNOWN"] + if kwargs['type'] not in type_allowed_values: + raise ValueError( + "Invalid value for `type`, must be one of {0}".format(type_allowed_values) + ) + + query_params = { + "compartmentId": kwargs.get("compartment_id", missing), + "displayName": kwargs.get("display_name", missing), + "limit": kwargs.get("limit", missing), + "page": kwargs.get("page", missing), + "lifecycleState": kwargs.get("lifecycle_state", missing), + "sortOrder": kwargs.get("sort_order", missing), + "sortBy": kwargs.get("sort_by", missing), + "distributionChannelId": kwargs.get("distribution_channel_id", missing), + "parentMediaAssetId": kwargs.get("parent_media_asset_id", missing), + "masterMediaAssetId": kwargs.get("master_media_asset_id", missing), + "type": kwargs.get("type", missing), + "bucketName": kwargs.get("bucket_name", missing), + "objectName": kwargs.get("object_name", missing), + "mediaWorkflowJobId": kwargs.get("media_workflow_job_id", missing), + "sourceMediaWorkflowId": kwargs.get("source_media_workflow_id", missing), + "sourceMediaWorkflowVersion": kwargs.get("source_media_workflow_version", 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="MediaAssetCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + query_params=query_params, + header_params=header_params, + response_type="MediaAssetCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def list_media_workflow_configurations(self, **kwargs): + """ + Returns a list of MediaWorkflowConfigurations. + + + :param str compartment_id: (optional) + The ID of the compartment in which to list resources. + + :param str lifecycle_state: (optional) + A filter to return only the resources with lifecycleState matching the given lifecycleState. + + Allowed values are: "ACTIVE", "NEEDS_ATTENTION", "DELETED" + + :param str display_name: (optional) + A filter to return only the resources that match the entire display name given. + + :param str id: (optional) + Unique MediaWorkflowConfiguration identifier. + + :param int limit: (optional) + The maximum number of items to return. + + :param str page: (optional) + A token representing the position at which to start retrieving results. This must come from the + `opc-next-page` header field of a previous response. + + :param str sort_order: (optional) + The sort order to use, either 'ASC' or 'DESC'. + + Allowed values are: "ASC", "DESC" + + :param str sort_by: (optional) + The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default + order for displayName is ascending. + + Allowed values are: "timeCreated", "displayName" + + :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.media_services.models.MediaWorkflowConfigurationCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_media_workflow_configurations API. + """ + resource_path = "/mediaWorkflowConfigurations" + method = "GET" + operation_name = "list_media_workflow_configurations" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "compartment_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( + "list_media_workflow_configurations got unknown kwargs: {!r}".format(extra_kwargs)) + + if 'lifecycle_state' in kwargs: + lifecycle_state_allowed_values = ["ACTIVE", "NEEDS_ATTENTION", "DELETED"] + if kwargs['lifecycle_state'] not in lifecycle_state_allowed_values: + raise ValueError( + "Invalid value for `lifecycle_state`, must be one of {0}".format(lifecycle_state_allowed_values) + ) + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + "Invalid value for `sort_order`, must be one of {0}".format(sort_order_allowed_values) + ) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["timeCreated", "displayName"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) + ) + + query_params = { + "compartmentId": kwargs.get("compartment_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="MediaWorkflowConfigurationCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + query_params=query_params, + header_params=header_params, + response_type="MediaWorkflowConfigurationCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def list_media_workflow_job_facts(self, media_workflow_job_id, **kwargs): + """ + Internal API to get a point-in-time snapshot of a MediaWorkflowJob. + + + :param str media_workflow_job_id: (required) + Unique MediaWorkflowJob identifier. + + :param int key: (optional) + Filter by MediaWorkflowJob ID and MediaWorkflowJobFact key. + + :param str type: (optional) + Types of details to include. + + Allowed values are: "runnableJob", "taskDeclaration", "workflow", "configuration", "parameterResolutionEvent" + + :param str sort_by: (optional) + Types of details to include. + + Allowed values are: "key" + + :param str sort_order: (optional) + The sort order to use, either 'ASC' or 'DESC'. + + Allowed values are: "ASC", "DESC" + + :param str page: (optional) + A token representing the position at which to start retrieving results. This must come from the + `opc-next-page` header field of a previous response. + + :param int limit: (optional) + The maximum number of items to return. + + :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.media_services.models.MediaWorkflowJobFactCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_media_workflow_job_facts API. + """ + resource_path = "/mediaWorkflowJobs/{mediaWorkflowJobId}/facts" + method = "GET" + operation_name = "list_media_workflow_job_facts" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "key", + "type", + "sort_by", + "sort_order", + "page", + "limit", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_media_workflow_job_facts got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "mediaWorkflowJobId": media_workflow_job_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + if 'type' in kwargs: + type_allowed_values = ["runnableJob", "taskDeclaration", "workflow", "configuration", "parameterResolutionEvent"] + if kwargs['type'] not in type_allowed_values: + raise ValueError( + "Invalid value for `type`, must be one of {0}".format(type_allowed_values) + ) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["key"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) + ) + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + "Invalid value for `sort_order`, must be one of {0}".format(sort_order_allowed_values) + ) + + query_params = { + "key": kwargs.get("key", missing), + "type": kwargs.get("type", missing), + "sortBy": kwargs.get("sort_by", missing), + "sortOrder": kwargs.get("sort_order", missing), + "page": kwargs.get("page", missing), + "limit": kwargs.get("limit", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + if retry_strategy 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="MediaWorkflowJobFactCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + 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="MediaWorkflowJobFactCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def list_media_workflow_jobs(self, **kwargs): + """ + Lists the MediaWorkflowJobs. + + + :param str compartment_id: (optional) + The ID of the compartment in which to list resources. + + :param str id: (optional) + unique MediaWorkflowJob identifier + + :param str media_workflow_id: (optional) + Unique MediaWorkflow identifier. + + :param str display_name: (optional) + A filter to return only the resources that match the entire display name given. + + :param str lifecycle_state: (optional) + A filter to return only the resources with lifecycleState matching the given lifecycleState. + + Allowed values are: "ACCEPTED", "IN_PROGRESS", "WAITING", "FAILED", "SUCCEEDED", "CANCELING", "CANCELED" + + :param str page: (optional) + A token representing the position at which to start retrieving results. This must come from the + `opc-next-page` header field of a previous response. + + :param int limit: (optional) + The maximum number of items to return. + + :param str sort_by: (optional) + The parameter sort by. + + Allowed values are: "timeCreated", "workflowId", "lifecycleState" + + :param str sort_order: (optional) + The sort order to use, either 'ASC' or 'DESC'. + + Allowed values are: "ASC", "DESC" + + :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.media_services.models.MediaWorkflowJobCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_media_workflow_jobs API. + """ + resource_path = "/mediaWorkflowJobs" + method = "GET" + operation_name = "list_media_workflow_jobs" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "compartment_id", + "id", + "media_workflow_id", + "display_name", + "lifecycle_state", + "page", + "limit", + "sort_by", + "sort_order", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_media_workflow_jobs got unknown kwargs: {!r}".format(extra_kwargs)) + + if 'lifecycle_state' in kwargs: + lifecycle_state_allowed_values = ["ACCEPTED", "IN_PROGRESS", "WAITING", "FAILED", "SUCCEEDED", "CANCELING", "CANCELED"] + if kwargs['lifecycle_state'] not in lifecycle_state_allowed_values: + raise ValueError( + "Invalid value for `lifecycle_state`, must be one of {0}".format(lifecycle_state_allowed_values) + ) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["timeCreated", "workflowId", "lifecycleState"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) + ) + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + "Invalid value for `sort_order`, must be one of {0}".format(sort_order_allowed_values) + ) + + query_params = { + "compartmentId": kwargs.get("compartment_id", missing), + "id": kwargs.get("id", missing), + "mediaWorkflowId": kwargs.get("media_workflow_id", missing), + "displayName": kwargs.get("display_name", missing), + "lifecycleState": kwargs.get("lifecycle_state", missing), + "page": kwargs.get("page", missing), + "limit": kwargs.get("limit", missing), + "sortBy": kwargs.get("sort_by", missing), + "sortOrder": kwargs.get("sort_order", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + 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="MediaWorkflowJobCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + query_params=query_params, + header_params=header_params, + response_type="MediaWorkflowJobCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def list_media_workflow_task_declarations(self, **kwargs): + """ + Returns a list of MediaWorkflowTaskDeclarations. + + + :param str compartment_id: (optional) + The ID of the compartment in which to list resources. + + :param str name: (optional) + A filter to return only the resources with their system defined, unique name matching the given name. + + :param int version: (optional) + A filter to select MediaWorkflowTaskDeclaration by version. + + :param bool is_current: (optional) + A filter to only select the newest version for each MediaWorkflowTaskDeclaration name. + + :param str sort_by: (optional) + The field to sort by. Only one sort order may be provided. + + Allowed values are: "name", "version" + + :param int limit: (optional) + The maximum number of items to return. + + :param str page: (optional) + A token representing the position at which to start retrieving results. This must come from the + `opc-next-page` header field of a previous response. + + :param str sort_order: (optional) + The sort order to use, either 'ASC' or 'DESC'. + + Allowed values are: "ASC", "DESC" + + :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.media_services.models.MediaWorkflowTaskDeclarationCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_media_workflow_task_declarations API. + """ + resource_path = "/mediaWorkflowTaskDeclarations" + method = "GET" + operation_name = "list_media_workflow_task_declarations" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "compartment_id", + "name", + "version", + "is_current", + "sort_by", + "limit", + "page", + "sort_order", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_media_workflow_task_declarations got unknown kwargs: {!r}".format(extra_kwargs)) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["name", "version"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) + ) + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + "Invalid value for `sort_order`, must be one of {0}".format(sort_order_allowed_values) + ) + + query_params = { + "compartmentId": kwargs.get("compartment_id", missing), + "name": kwargs.get("name", missing), + "version": kwargs.get("version", missing), + "isCurrent": kwargs.get("is_current", missing), + "sortBy": kwargs.get("sort_by", missing), + "limit": kwargs.get("limit", missing), + "page": kwargs.get("page", missing), + "sortOrder": kwargs.get("sort_order", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + 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="MediaWorkflowTaskDeclarationCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + query_params=query_params, + header_params=header_params, + response_type="MediaWorkflowTaskDeclarationCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def list_media_workflows(self, **kwargs): + """ + Lists the MediaWorkflows. + + + :param str compartment_id: (optional) + The ID of the compartment in which to list resources. + + :param str id: (optional) + Unique MediaWorkflow identifier. + + :param str lifecycle_state: (optional) + A filter to return only the resources with lifecycleState matching the given lifecycleState. + + Allowed values are: "ACTIVE", "NEEDS_ATTENTION", "DELETED" + + :param str display_name: (optional) + A filter to return only the resources that match the entire display name given. + + :param str sort_order: (optional) + The sort order to use, either 'ASC' or 'DESC'. + + Allowed values are: "ASC", "DESC" + + :param str sort_by: (optional) + The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default + order for displayName is ascending. + + Allowed values are: "timeCreated", "displayName" + + :param str page: (optional) + A token representing the position at which to start retrieving results. This must come from the + `opc-next-page` header field of a previous response. + + :param int limit: (optional) + The maximum number of items to return. + + :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.media_services.models.MediaWorkflowCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_media_workflows API. + """ + resource_path = "/mediaWorkflows" + method = "GET" + operation_name = "list_media_workflows" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "compartment_id", + "id", + "lifecycle_state", + "display_name", + "sort_order", + "sort_by", + "page", + "limit", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_media_workflows got unknown kwargs: {!r}".format(extra_kwargs)) + + if 'lifecycle_state' in kwargs: + lifecycle_state_allowed_values = ["ACTIVE", "NEEDS_ATTENTION", "DELETED"] + if kwargs['lifecycle_state'] not in lifecycle_state_allowed_values: + raise ValueError( + "Invalid value for `lifecycle_state`, must be one of {0}".format(lifecycle_state_allowed_values) + ) + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + "Invalid value for `sort_order`, must be one of {0}".format(sort_order_allowed_values) + ) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["timeCreated", "displayName"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) + ) + + query_params = { + "compartmentId": kwargs.get("compartment_id", missing), + "id": kwargs.get("id", missing), + "lifecycleState": kwargs.get("lifecycle_state", missing), + "displayName": kwargs.get("display_name", missing), + "sortOrder": kwargs.get("sort_order", missing), + "sortBy": kwargs.get("sort_by", missing), + "page": kwargs.get("page", missing), + "limit": kwargs.get("limit", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + if retry_strategy 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="MediaWorkflowCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + query_params=query_params, + header_params=header_params, + response_type="MediaWorkflowCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def list_stream_cdn_configs(self, distribution_channel_id, **kwargs): + """ + Lists the StreamCdnConfig. + + + :param str distribution_channel_id: (required) + The Stream Distribution Channel identifier this CdnConfig belongs to. + + :param str id: (optional) + Unique StreamCdnConfig identifier. + + :param str lifecycle_state: (optional) + A filter to return only the resources with lifecycleState matching the given lifecycleState. + + Allowed values are: "ACTIVE", "NEEDS_ATTENTION", "DELETED" + + :param str display_name: (optional) + A filter to return only the resources that match the entire display name given. + + :param str sort_order: (optional) + The sort order to use, either 'ASC' or 'DESC'. + + Allowed values are: "ASC", "DESC" + + :param str sort_by: (optional) + The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default + order for displayName is ascending. + + Allowed values are: "timeCreated", "displayName" + + :param str page: (optional) + A token representing the position at which to start retrieving results. This must come from the + `opc-next-page` header field of a previous response. + + :param int limit: (optional) + The maximum number of items to return. + + :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.media_services.models.StreamCdnConfigCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_stream_cdn_configs API. + """ + resource_path = "/streamCdnConfigs" + method = "GET" + operation_name = "list_stream_cdn_configs" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "id", + "lifecycle_state", + "display_name", + "sort_order", + "sort_by", + "page", + "limit", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_stream_cdn_configs got unknown kwargs: {!r}".format(extra_kwargs)) + + if 'lifecycle_state' in kwargs: + lifecycle_state_allowed_values = ["ACTIVE", "NEEDS_ATTENTION", "DELETED"] + if kwargs['lifecycle_state'] not in lifecycle_state_allowed_values: + raise ValueError( + "Invalid value for `lifecycle_state`, must be one of {0}".format(lifecycle_state_allowed_values) + ) + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + "Invalid value for `sort_order`, must be one of {0}".format(sort_order_allowed_values) + ) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["timeCreated", "displayName"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) + ) + + query_params = { + "distributionChannelId": distribution_channel_id, + "id": kwargs.get("id", missing), + "lifecycleState": kwargs.get("lifecycle_state", missing), + "displayName": kwargs.get("display_name", missing), + "sortOrder": kwargs.get("sort_order", missing), + "sortBy": kwargs.get("sort_by", missing), + "page": kwargs.get("page", missing), + "limit": kwargs.get("limit", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + if retry_strategy 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="StreamCdnConfigCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + query_params=query_params, + header_params=header_params, + response_type="StreamCdnConfigCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def list_stream_distribution_channels(self, **kwargs): + """ + Lists the Stream Distribution Channels. + + + :param str compartment_id: (optional) + The ID of the compartment in which to list resources. + + :param str id: (optional) + Unique Stream Distribution Channel identifier. + + :param str lifecycle_state: (optional) + A filter to return only the resources with lifecycleState matching the given lifecycleState. + + Allowed values are: "ACTIVE", "NEEDS_ATTENTION", "DELETED" + + :param str display_name: (optional) + A filter to return only the resources that match the entire display name given. + + :param str sort_order: (optional) + The sort order to use, either 'ASC' or 'DESC'. + + Allowed values are: "ASC", "DESC" + + :param str sort_by: (optional) + The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default + order for displayName is ascending. + + Allowed values are: "timeCreated", "displayName" + + :param str page: (optional) + A token representing the position at which to start retrieving results. This must come from the + `opc-next-page` header field of a previous response. + + :param int limit: (optional) + The maximum number of items to return. + + :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.media_services.models.StreamDistributionChannelCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_stream_distribution_channels API. + """ + resource_path = "/streamDistributionChannels" + method = "GET" + operation_name = "list_stream_distribution_channels" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "compartment_id", + "id", + "lifecycle_state", + "display_name", + "sort_order", + "sort_by", + "page", + "limit", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_stream_distribution_channels got unknown kwargs: {!r}".format(extra_kwargs)) + + if 'lifecycle_state' in kwargs: + lifecycle_state_allowed_values = ["ACTIVE", "NEEDS_ATTENTION", "DELETED"] + if kwargs['lifecycle_state'] not in lifecycle_state_allowed_values: + raise ValueError( + "Invalid value for `lifecycle_state`, must be one of {0}".format(lifecycle_state_allowed_values) + ) + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + "Invalid value for `sort_order`, must be one of {0}".format(sort_order_allowed_values) + ) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["timeCreated", "displayName"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) + ) + + query_params = { + "compartmentId": kwargs.get("compartment_id", missing), + "id": kwargs.get("id", missing), + "lifecycleState": kwargs.get("lifecycle_state", missing), + "displayName": kwargs.get("display_name", missing), + "sortOrder": kwargs.get("sort_order", missing), + "sortBy": kwargs.get("sort_by", missing), + "page": kwargs.get("page", missing), + "limit": kwargs.get("limit", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + if retry_strategy 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="StreamDistributionChannelCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + query_params=query_params, + header_params=header_params, + response_type="StreamDistributionChannelCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def list_stream_packaging_configs(self, distribution_channel_id, **kwargs): + """ + Lists the Stream Packaging Configurations. + + + :param str distribution_channel_id: (required) + Unique Stream Distribution Channel identifier. + + :param str stream_packaging_config_id: (optional) + Unique Stream Packaging Configuration identifier. + + :param str lifecycle_state: (optional) + A filter to return only the resources with lifecycleState matching the given lifecycleState. + + Allowed values are: "ACTIVE", "NEEDS_ATTENTION", "DELETED" + + :param str display_name: (optional) + A filter to return only the resources that match the entire display name given. + + :param str sort_order: (optional) + The sort order to use, either 'ASC' or 'DESC'. + + Allowed values are: "ASC", "DESC" + + :param str sort_by: (optional) + The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default + order for displayName is ascending. + + Allowed values are: "timeCreated", "displayName" + + :param str page: (optional) + A token representing the position at which to start retrieving results. This must come from the + `opc-next-page` header field of a previous response. + + :param int limit: (optional) + The maximum number of items to return. + + :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.media_services.models.StreamPackagingConfigCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_stream_packaging_configs API. + """ + resource_path = "/streamPackagingConfigs" + method = "GET" + operation_name = "list_stream_packaging_configs" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "stream_packaging_config_id", + "lifecycle_state", + "display_name", + "sort_order", + "sort_by", + "page", + "limit", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_stream_packaging_configs got unknown kwargs: {!r}".format(extra_kwargs)) + + if 'lifecycle_state' in kwargs: + lifecycle_state_allowed_values = ["ACTIVE", "NEEDS_ATTENTION", "DELETED"] + if kwargs['lifecycle_state'] not in lifecycle_state_allowed_values: + raise ValueError( + "Invalid value for `lifecycle_state`, must be one of {0}".format(lifecycle_state_allowed_values) + ) + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + "Invalid value for `sort_order`, must be one of {0}".format(sort_order_allowed_values) + ) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["timeCreated", "displayName"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) + ) + + query_params = { + "distributionChannelId": distribution_channel_id, + "streamPackagingConfigId": kwargs.get("stream_packaging_config_id", missing), + "lifecycleState": kwargs.get("lifecycle_state", missing), + "displayName": kwargs.get("display_name", missing), + "sortOrder": kwargs.get("sort_order", missing), + "sortBy": kwargs.get("sort_by", missing), + "page": kwargs.get("page", missing), + "limit": kwargs.get("limit", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + if retry_strategy 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="StreamPackagingConfigCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + query_params=query_params, + header_params=header_params, + response_type="StreamPackagingConfigCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def list_system_media_workflows(self, **kwargs): + """ + Lists the SystemMediaWorkflows that can be used to run a job by name or as a template to create a MediaWorkflow. + + + :param str compartment_id: (optional) + The ID of the compartment in which to list resources. + + :param str name: (optional) + A filter to return only the resources with their system defined, unique name matching the given name. + + :param str sort_order: (optional) + The sort order to use, either 'ASC' or 'DESC'. + + Allowed values are: "ASC", "DESC" + + :param str page: (optional) + A token representing the position at which to start retrieving results. This must come from the + `opc-next-page` header field of a previous response. + + :param int limit: (optional) + The maximum number of items to return. + + :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.media_services.models.SystemMediaWorkflowCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_system_media_workflows API. + """ + resource_path = "/systemMediaWorkflows" + method = "GET" + operation_name = "list_system_media_workflows" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "compartment_id", + "name", + "sort_order", + "page", + "limit", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_system_media_workflows got unknown kwargs: {!r}".format(extra_kwargs)) + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + "Invalid value for `sort_order`, must be one of {0}".format(sort_order_allowed_values) + ) + + query_params = { + "compartmentId": kwargs.get("compartment_id", missing), + "name": kwargs.get("name", missing), + "sortOrder": kwargs.get("sort_order", missing), + "page": kwargs.get("page", missing), + "limit": kwargs.get("limit", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + if retry_strategy 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="SystemMediaWorkflowCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + query_params=query_params, + header_params=header_params, + response_type="SystemMediaWorkflowCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def update_media_asset(self, media_asset_id, update_media_asset_details, **kwargs): + """ + Updates the MediaAsset. + + + :param str media_asset_id: (required) + Unique MediaAsset identifier + + :param oci.media_services.models.UpdateMediaAssetDetails update_media_asset_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 will be updated or deleted only if the etag you + provide matches the resource's current etag value. + + :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.media_services.models.MediaAsset` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use update_media_asset API. + """ + resource_path = "/mediaAssets/{mediaAssetId}" + method = "PUT" + operation_name = "update_media_asset" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "if_match", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "update_media_asset got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "mediaAssetId": media_asset_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "if-match": kwargs.get("if_match", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=update_media_asset_details, + response_type="MediaAsset", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=update_media_asset_details, + response_type="MediaAsset", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def update_media_workflow(self, media_workflow_id, update_media_workflow_details, **kwargs): + """ + Updates the MediaWorkflow. + + + :param str media_workflow_id: (required) + Unique MediaWorkflow identifier. + + :param oci.media_services.models.UpdateMediaWorkflowDetails update_media_workflow_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 will be updated or deleted only if the etag you + provide matches the resource's current etag value. + + :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.media_services.models.MediaWorkflow` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use update_media_workflow API. + """ + resource_path = "/mediaWorkflows/{mediaWorkflowId}" + method = "PUT" + operation_name = "update_media_workflow" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "if_match", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "update_media_workflow got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "mediaWorkflowId": media_workflow_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "if-match": kwargs.get("if_match", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=update_media_workflow_details, + response_type="MediaWorkflow", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=update_media_workflow_details, + response_type="MediaWorkflow", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def update_media_workflow_configuration(self, media_workflow_configuration_id, update_media_workflow_configuration_details, **kwargs): + """ + Updates the MediaWorkflowConfiguration. + + + :param str media_workflow_configuration_id: (required) + Unique MediaWorkflowConfiguration identifier. + + :param oci.media_services.models.UpdateMediaWorkflowConfigurationDetails update_media_workflow_configuration_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 will be updated or deleted only if the etag you + provide matches the resource's current etag value. + + :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.media_services.models.MediaWorkflowConfiguration` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use update_media_workflow_configuration API. + """ + resource_path = "/mediaWorkflowConfigurations/{mediaWorkflowConfigurationId}" + method = "PUT" + operation_name = "update_media_workflow_configuration" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "if_match", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "update_media_workflow_configuration got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "mediaWorkflowConfigurationId": media_workflow_configuration_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "if-match": kwargs.get("if_match", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=update_media_workflow_configuration_details, + response_type="MediaWorkflowConfiguration", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=update_media_workflow_configuration_details, + response_type="MediaWorkflowConfiguration", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def update_media_workflow_job(self, media_workflow_job_id, update_media_workflow_job_details, **kwargs): + """ + Updates the MediaWorkflowJob. + + + :param str media_workflow_job_id: (required) + Unique MediaWorkflowJob identifier. + + :param oci.media_services.models.UpdateMediaWorkflowJobDetails update_media_workflow_job_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 will be updated or deleted only if the etag you + provide matches the resource's current etag value. + + :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.media_services.models.MediaWorkflowJob` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use update_media_workflow_job API. + """ + resource_path = "/mediaWorkflowJobs/{mediaWorkflowJobId}" + method = "PUT" + operation_name = "update_media_workflow_job" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "if_match", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "update_media_workflow_job got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "mediaWorkflowJobId": media_workflow_job_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "if-match": kwargs.get("if_match", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=update_media_workflow_job_details, + response_type="MediaWorkflowJob", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=update_media_workflow_job_details, + response_type="MediaWorkflowJob", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def update_stream_cdn_config(self, stream_cdn_config_id, update_stream_cdn_config_details, **kwargs): + """ + Updates the StreamCdnConfig. + + + :param str stream_cdn_config_id: (required) + Unique StreamCdnConfig identifier. + + :param oci.media_services.models.UpdateStreamCdnConfigDetails update_stream_cdn_config_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 will be updated or deleted only if the etag you + provide matches the resource's current etag value. + + :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.media_services.models.StreamCdnConfig` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use update_stream_cdn_config API. + """ + resource_path = "/streamCdnConfigs/{streamCdnConfigId}" + method = "PUT" + operation_name = "update_stream_cdn_config" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "if_match", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "update_stream_cdn_config got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "streamCdnConfigId": stream_cdn_config_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "if-match": kwargs.get("if_match", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=update_stream_cdn_config_details, + response_type="StreamCdnConfig", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=update_stream_cdn_config_details, + response_type="StreamCdnConfig", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def update_stream_distribution_channel(self, stream_distribution_channel_id, update_stream_distribution_channel_details, **kwargs): + """ + Updates the Stream Distribution Channel. + + + :param str stream_distribution_channel_id: (required) + Unique Stream Distribution Channel path identifier. + + :param oci.media_services.models.UpdateStreamDistributionChannelDetails update_stream_distribution_channel_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 will be updated or deleted only if the etag you + provide matches the resource's current etag value. + + :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.media_services.models.StreamDistributionChannel` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use update_stream_distribution_channel API. + """ + resource_path = "/streamDistributionChannels/{streamDistributionChannelId}" + method = "PUT" + operation_name = "update_stream_distribution_channel" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "if_match", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "update_stream_distribution_channel got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "streamDistributionChannelId": stream_distribution_channel_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "if-match": kwargs.get("if_match", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=update_stream_distribution_channel_details, + response_type="StreamDistributionChannel", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=update_stream_distribution_channel_details, + response_type="StreamDistributionChannel", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def update_stream_packaging_config(self, stream_packaging_config_id, update_stream_packaging_config_details, **kwargs): + """ + Updates the Stream Packaging Configuration. + + + :param str stream_packaging_config_id: (required) + Unique Stream Packaging Configuration path identifier. + + :param oci.media_services.models.UpdateStreamPackagingConfigDetails update_stream_packaging_config_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 will be updated or deleted only if the etag you + provide matches the resource's current etag value. + + :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.media_services.models.StreamPackagingConfig` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use update_stream_packaging_config API. + """ + resource_path = "/streamPackagingConfigs/{streamPackagingConfigId}" + method = "PUT" + operation_name = "update_stream_packaging_config" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "if_match", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "update_stream_packaging_config got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "streamPackagingConfigId": stream_packaging_config_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "if-match": kwargs.get("if_match", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=update_stream_packaging_config_details, + response_type="StreamPackagingConfig", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=update_stream_packaging_config_details, + response_type="StreamPackagingConfig", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) diff --git a/src/oci/media_services/media_services_client_composite_operations.py b/src/oci/media_services/media_services_client_composite_operations.py new file mode 100644 index 0000000000..aa4556d8ff --- /dev/null +++ b/src/oci/media_services/media_services_client_composite_operations.py @@ -0,0 +1,906 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, 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. + +import oci # noqa: F401 +from oci.util import WAIT_RESOURCE_NOT_FOUND # noqa: F401 + + +class MediaServicesClientCompositeOperations(object): + """ + This class provides a wrapper around :py:class:`~oci.media_services.MediaServicesClient` and offers convenience methods + for operations that would otherwise need to be chained together. For example, instead of performing an action + on a resource (e.g. launching an instance, creating a load balancer) and then using a waiter to wait for the resource + to enter a given state, you can call a single method in this class to accomplish the same functionality + """ + + def __init__(self, client, **kwargs): + """ + Creates a new MediaServicesClientCompositeOperations object + + :param MediaServicesClient client: + The service client which will be wrapped by this object + """ + self.client = client + + def create_media_asset_and_wait_for_state(self, create_media_asset_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.media_services.MediaServicesClient.create_media_asset` and waits for the :py:class:`~oci.media_services.models.MediaAsset` acted upon + to enter the given state(s). + + :param oci.media_services.models.CreateMediaAssetDetails create_media_asset_details: (required) + Details for the new MediaAsset. + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.media_services.models.MediaAsset.lifecycle_state` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.media_services.MediaServicesClient.create_media_asset` + + :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_media_asset(create_media_asset_details, **operation_kwargs) + if not wait_for_states: + return operation_result + + lowered_wait_for_states = [w.lower() for w in wait_for_states] + wait_for_resource_id = operation_result.data.id + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_media_asset(wait_for_resource_id), + 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 Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + + def create_media_workflow_and_wait_for_state(self, create_media_workflow_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.media_services.MediaServicesClient.create_media_workflow` and waits for the :py:class:`~oci.media_services.models.MediaWorkflow` acted upon + to enter the given state(s). + + :param oci.media_services.models.CreateMediaWorkflowDetails create_media_workflow_details: (required) + Details for the new MediaWorkflow. + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.media_services.models.MediaWorkflow.lifecycle_state` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.media_services.MediaServicesClient.create_media_workflow` + + :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_media_workflow(create_media_workflow_details, **operation_kwargs) + if not wait_for_states: + return operation_result + + lowered_wait_for_states = [w.lower() for w in wait_for_states] + wait_for_resource_id = operation_result.data.id + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_media_workflow(wait_for_resource_id), + 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 Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + + def create_media_workflow_configuration_and_wait_for_state(self, create_media_workflow_configuration_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.media_services.MediaServicesClient.create_media_workflow_configuration` and waits for the :py:class:`~oci.media_services.models.MediaWorkflowConfiguration` acted upon + to enter the given state(s). + + :param oci.media_services.models.CreateMediaWorkflowConfigurationDetails create_media_workflow_configuration_details: (required) + Details for the new MediaWorkflowConfiguration. + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.media_services.models.MediaWorkflowConfiguration.lifecycle_state` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.media_services.MediaServicesClient.create_media_workflow_configuration` + + :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_media_workflow_configuration(create_media_workflow_configuration_details, **operation_kwargs) + if not wait_for_states: + return operation_result + + lowered_wait_for_states = [w.lower() for w in wait_for_states] + wait_for_resource_id = operation_result.data.id + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_media_workflow_configuration(wait_for_resource_id), + 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 Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + + def create_media_workflow_job_and_wait_for_state(self, create_media_workflow_job_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.media_services.MediaServicesClient.create_media_workflow_job` and waits for the :py:class:`~oci.media_services.models.MediaWorkflowJob` acted upon + to enter the given state(s). + + :param oci.media_services.models.CreateMediaWorkflowJobDetails create_media_workflow_job_details: (required) + The information to run the mediaWorkflow. + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.media_services.models.MediaWorkflowJob.lifecycle_state` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.media_services.MediaServicesClient.create_media_workflow_job` + + :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_media_workflow_job(create_media_workflow_job_details, **operation_kwargs) + if not wait_for_states: + return operation_result + + lowered_wait_for_states = [w.lower() for w in wait_for_states] + wait_for_resource_id = operation_result.data.id + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_media_workflow_job(wait_for_resource_id), + 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 Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + + def create_stream_cdn_config_and_wait_for_state(self, create_stream_cdn_config_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.media_services.MediaServicesClient.create_stream_cdn_config` and waits for the :py:class:`~oci.media_services.models.StreamCdnConfig` acted upon + to enter the given state(s). + + :param oci.media_services.models.CreateStreamCdnConfigDetails create_stream_cdn_config_details: (required) + Details for the new StreamCdnConfig. + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.media_services.models.StreamCdnConfig.lifecycle_state` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.media_services.MediaServicesClient.create_stream_cdn_config` + + :param dict waiter_kwargs: + A dictionary of keyword arguments to pass to the :py:func:`oci.wait_until` function. For example, you could pass ``max_interval_seconds`` or ``max_interval_seconds`` + as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait + """ + operation_result = self.client.create_stream_cdn_config(create_stream_cdn_config_details, **operation_kwargs) + if not wait_for_states: + return operation_result + + lowered_wait_for_states = [w.lower() for w in wait_for_states] + wait_for_resource_id = operation_result.data.id + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_stream_cdn_config(wait_for_resource_id), + 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 Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + + def create_stream_distribution_channel_and_wait_for_state(self, create_stream_distribution_channel_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.media_services.MediaServicesClient.create_stream_distribution_channel` and waits for the :py:class:`~oci.media_services.models.StreamDistributionChannel` acted upon + to enter the given state(s). + + :param oci.media_services.models.CreateStreamDistributionChannelDetails create_stream_distribution_channel_details: (required) + Details for the new Stream Distribution Channel. + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.media_services.models.StreamDistributionChannel.lifecycle_state` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.media_services.MediaServicesClient.create_stream_distribution_channel` + + :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_stream_distribution_channel(create_stream_distribution_channel_details, **operation_kwargs) + if not wait_for_states: + return operation_result + + lowered_wait_for_states = [w.lower() for w in wait_for_states] + wait_for_resource_id = operation_result.data.id + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_stream_distribution_channel(wait_for_resource_id), + 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 Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + + def create_stream_packaging_config_and_wait_for_state(self, create_stream_packaging_config_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.media_services.MediaServicesClient.create_stream_packaging_config` and waits for the :py:class:`~oci.media_services.models.StreamPackagingConfig` acted upon + to enter the given state(s). + + :param oci.media_services.models.CreateStreamPackagingConfigDetails create_stream_packaging_config_details: (required) + Details for the new Stream Packaging Configuration. + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.media_services.models.StreamPackagingConfig.lifecycle_state` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.media_services.MediaServicesClient.create_stream_packaging_config` + + :param dict waiter_kwargs: + A dictionary of keyword arguments to pass to the :py:func:`oci.wait_until` function. For example, you could pass ``max_interval_seconds`` or ``max_interval_seconds`` + as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait + """ + operation_result = self.client.create_stream_packaging_config(create_stream_packaging_config_details, **operation_kwargs) + if not wait_for_states: + return operation_result + + lowered_wait_for_states = [w.lower() for w in wait_for_states] + wait_for_resource_id = operation_result.data.id + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_stream_packaging_config(wait_for_resource_id), + 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 Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + + def delete_media_asset_and_wait_for_state(self, media_asset_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.media_services.MediaServicesClient.delete_media_asset` and waits for the :py:class:`~oci.media_services.models.MediaAsset` acted upon + to enter the given state(s). + + :param str media_asset_id: (required) + Unique MediaAsset identifier + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.media_services.models.MediaAsset.lifecycle_state` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.media_services.MediaServicesClient.delete_media_asset` + + :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_media_asset(media_asset_id) + operation_result = None + try: + operation_result = self.client.delete_media_asset(media_asset_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: + waiter_result = oci.wait_until( + self.client, + initial_get_result, + evaluate_response=lambda r: getattr(r.data, 'lifecycle_state') and getattr(r.data, 'lifecycle_state').lower() in lowered_wait_for_states, + succeed_on_not_found=True, + **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_media_workflow_and_wait_for_state(self, media_workflow_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.media_services.MediaServicesClient.delete_media_workflow` and waits for the :py:class:`~oci.media_services.models.MediaWorkflow` acted upon + to enter the given state(s). + + :param str media_workflow_id: (required) + Unique MediaWorkflow identifier. + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.media_services.models.MediaWorkflow.lifecycle_state` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.media_services.MediaServicesClient.delete_media_workflow` + + :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_media_workflow(media_workflow_id) + operation_result = None + try: + operation_result = self.client.delete_media_workflow(media_workflow_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: + waiter_result = oci.wait_until( + self.client, + initial_get_result, + evaluate_response=lambda r: getattr(r.data, 'lifecycle_state') and getattr(r.data, 'lifecycle_state').lower() in lowered_wait_for_states, + succeed_on_not_found=True, + **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_media_workflow_configuration_and_wait_for_state(self, media_workflow_configuration_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.media_services.MediaServicesClient.delete_media_workflow_configuration` and waits for the :py:class:`~oci.media_services.models.MediaWorkflowConfiguration` acted upon + to enter the given state(s). + + :param str media_workflow_configuration_id: (required) + Unique MediaWorkflowConfiguration identifier. + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.media_services.models.MediaWorkflowConfiguration.lifecycle_state` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.media_services.MediaServicesClient.delete_media_workflow_configuration` + + :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_media_workflow_configuration(media_workflow_configuration_id) + operation_result = None + try: + operation_result = self.client.delete_media_workflow_configuration(media_workflow_configuration_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: + waiter_result = oci.wait_until( + self.client, + initial_get_result, + evaluate_response=lambda r: getattr(r.data, 'lifecycle_state') and getattr(r.data, 'lifecycle_state').lower() in lowered_wait_for_states, + succeed_on_not_found=True, + **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_media_workflow_job_and_wait_for_state(self, media_workflow_job_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.media_services.MediaServicesClient.delete_media_workflow_job` and waits for the :py:class:`~oci.media_services.models.MediaWorkflowJob` acted upon + to enter the given state(s). + + :param str media_workflow_job_id: (required) + Unique MediaWorkflowJob identifier. + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.media_services.models.MediaWorkflowJob.lifecycle_state` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.media_services.MediaServicesClient.delete_media_workflow_job` + + :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_media_workflow_job(media_workflow_job_id) + operation_result = None + try: + operation_result = self.client.delete_media_workflow_job(media_workflow_job_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: + waiter_result = oci.wait_until( + self.client, + initial_get_result, + evaluate_response=lambda r: getattr(r.data, 'lifecycle_state') and getattr(r.data, 'lifecycle_state').lower() in lowered_wait_for_states, + succeed_on_not_found=True, + **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_stream_cdn_config_and_wait_for_state(self, stream_cdn_config_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.media_services.MediaServicesClient.delete_stream_cdn_config` and waits for the :py:class:`~oci.media_services.models.StreamCdnConfig` acted upon + to enter the given state(s). + + :param str stream_cdn_config_id: (required) + Unique StreamCdnConfig identifier. + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.media_services.models.StreamCdnConfig.lifecycle_state` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.media_services.MediaServicesClient.delete_stream_cdn_config` + + :param dict waiter_kwargs: + A dictionary of keyword arguments to pass to the :py:func:`oci.wait_until` function. For example, you could pass ``max_interval_seconds`` or ``max_interval_seconds`` + as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait + """ + initial_get_result = self.client.get_stream_cdn_config(stream_cdn_config_id) + operation_result = None + try: + operation_result = self.client.delete_stream_cdn_config(stream_cdn_config_id, **operation_kwargs) + except oci.exceptions.ServiceError as e: + if e.status == 404: + return WAIT_RESOURCE_NOT_FOUND + else: + raise e + + if not wait_for_states: + return operation_result + + lowered_wait_for_states = [w.lower() for w in wait_for_states] + + try: + waiter_result = oci.wait_until( + self.client, + initial_get_result, + evaluate_response=lambda r: getattr(r.data, 'lifecycle_state') and getattr(r.data, 'lifecycle_state').lower() in lowered_wait_for_states, + succeed_on_not_found=True, + **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_stream_distribution_channel_and_wait_for_state(self, stream_distribution_channel_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.media_services.MediaServicesClient.delete_stream_distribution_channel` and waits for the :py:class:`~oci.media_services.models.StreamDistributionChannel` acted upon + to enter the given state(s). + + :param str stream_distribution_channel_id: (required) + Unique Stream Distribution Channel path identifier. + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.media_services.models.StreamDistributionChannel.lifecycle_state` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.media_services.MediaServicesClient.delete_stream_distribution_channel` + + :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_stream_distribution_channel(stream_distribution_channel_id) + operation_result = None + try: + operation_result = self.client.delete_stream_distribution_channel(stream_distribution_channel_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: + waiter_result = oci.wait_until( + self.client, + initial_get_result, + evaluate_response=lambda r: getattr(r.data, 'lifecycle_state') and getattr(r.data, 'lifecycle_state').lower() in lowered_wait_for_states, + succeed_on_not_found=True, + **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_stream_packaging_config_and_wait_for_state(self, stream_packaging_config_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.media_services.MediaServicesClient.delete_stream_packaging_config` and waits for the :py:class:`~oci.media_services.models.StreamPackagingConfig` acted upon + to enter the given state(s). + + :param str stream_packaging_config_id: (required) + Unique Stream Packaging Configuration path identifier. + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.media_services.models.StreamPackagingConfig.lifecycle_state` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.media_services.MediaServicesClient.delete_stream_packaging_config` + + :param dict waiter_kwargs: + A dictionary of keyword arguments to pass to the :py:func:`oci.wait_until` function. For example, you could pass ``max_interval_seconds`` or ``max_interval_seconds`` + as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait + """ + initial_get_result = self.client.get_stream_packaging_config(stream_packaging_config_id) + operation_result = None + try: + operation_result = self.client.delete_stream_packaging_config(stream_packaging_config_id, **operation_kwargs) + except oci.exceptions.ServiceError as e: + if e.status == 404: + return WAIT_RESOURCE_NOT_FOUND + else: + raise e + + if not wait_for_states: + return operation_result + + lowered_wait_for_states = [w.lower() for w in wait_for_states] + + try: + waiter_result = oci.wait_until( + self.client, + initial_get_result, + evaluate_response=lambda r: getattr(r.data, 'lifecycle_state') and getattr(r.data, 'lifecycle_state').lower() in lowered_wait_for_states, + succeed_on_not_found=True, + **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_media_asset_and_wait_for_state(self, media_asset_id, update_media_asset_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.media_services.MediaServicesClient.update_media_asset` and waits for the :py:class:`~oci.media_services.models.MediaAsset` acted upon + to enter the given state(s). + + :param str media_asset_id: (required) + Unique MediaAsset identifier + + :param oci.media_services.models.UpdateMediaAssetDetails update_media_asset_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.media_services.models.MediaAsset.lifecycle_state` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.media_services.MediaServicesClient.update_media_asset` + + :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_media_asset(media_asset_id, update_media_asset_details, **operation_kwargs) + if not wait_for_states: + return operation_result + + lowered_wait_for_states = [w.lower() for w in wait_for_states] + wait_for_resource_id = operation_result.data.id + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_media_asset(wait_for_resource_id), + 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 Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + + def update_media_workflow_and_wait_for_state(self, media_workflow_id, update_media_workflow_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.media_services.MediaServicesClient.update_media_workflow` and waits for the :py:class:`~oci.media_services.models.MediaWorkflow` acted upon + to enter the given state(s). + + :param str media_workflow_id: (required) + Unique MediaWorkflow identifier. + + :param oci.media_services.models.UpdateMediaWorkflowDetails update_media_workflow_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.media_services.models.MediaWorkflow.lifecycle_state` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.media_services.MediaServicesClient.update_media_workflow` + + :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_media_workflow(media_workflow_id, update_media_workflow_details, **operation_kwargs) + if not wait_for_states: + return operation_result + + lowered_wait_for_states = [w.lower() for w in wait_for_states] + wait_for_resource_id = operation_result.data.id + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_media_workflow(wait_for_resource_id), + 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 Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + + def update_media_workflow_configuration_and_wait_for_state(self, media_workflow_configuration_id, update_media_workflow_configuration_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.media_services.MediaServicesClient.update_media_workflow_configuration` and waits for the :py:class:`~oci.media_services.models.MediaWorkflowConfiguration` acted upon + to enter the given state(s). + + :param str media_workflow_configuration_id: (required) + Unique MediaWorkflowConfiguration identifier. + + :param oci.media_services.models.UpdateMediaWorkflowConfigurationDetails update_media_workflow_configuration_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.media_services.models.MediaWorkflowConfiguration.lifecycle_state` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.media_services.MediaServicesClient.update_media_workflow_configuration` + + :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_media_workflow_configuration(media_workflow_configuration_id, update_media_workflow_configuration_details, **operation_kwargs) + if not wait_for_states: + return operation_result + + lowered_wait_for_states = [w.lower() for w in wait_for_states] + wait_for_resource_id = operation_result.data.id + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_media_workflow_configuration(wait_for_resource_id), + 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 Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + + def update_media_workflow_job_and_wait_for_state(self, media_workflow_job_id, update_media_workflow_job_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.media_services.MediaServicesClient.update_media_workflow_job` and waits for the :py:class:`~oci.media_services.models.MediaWorkflowJob` acted upon + to enter the given state(s). + + :param str media_workflow_job_id: (required) + Unique MediaWorkflowJob identifier. + + :param oci.media_services.models.UpdateMediaWorkflowJobDetails update_media_workflow_job_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.media_services.models.MediaWorkflowJob.lifecycle_state` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.media_services.MediaServicesClient.update_media_workflow_job` + + :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_media_workflow_job(media_workflow_job_id, update_media_workflow_job_details, **operation_kwargs) + if not wait_for_states: + return operation_result + + lowered_wait_for_states = [w.lower() for w in wait_for_states] + wait_for_resource_id = operation_result.data.id + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_media_workflow_job(wait_for_resource_id), + 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 Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + + def update_stream_cdn_config_and_wait_for_state(self, stream_cdn_config_id, update_stream_cdn_config_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.media_services.MediaServicesClient.update_stream_cdn_config` and waits for the :py:class:`~oci.media_services.models.StreamCdnConfig` acted upon + to enter the given state(s). + + :param str stream_cdn_config_id: (required) + Unique StreamCdnConfig identifier. + + :param oci.media_services.models.UpdateStreamCdnConfigDetails update_stream_cdn_config_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.media_services.models.StreamCdnConfig.lifecycle_state` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.media_services.MediaServicesClient.update_stream_cdn_config` + + :param dict waiter_kwargs: + A dictionary of keyword arguments to pass to the :py:func:`oci.wait_until` function. For example, you could pass ``max_interval_seconds`` or ``max_interval_seconds`` + as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait + """ + operation_result = self.client.update_stream_cdn_config(stream_cdn_config_id, update_stream_cdn_config_details, **operation_kwargs) + if not wait_for_states: + return operation_result + + lowered_wait_for_states = [w.lower() for w in wait_for_states] + wait_for_resource_id = operation_result.data.id + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_stream_cdn_config(wait_for_resource_id), + 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 Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + + def update_stream_distribution_channel_and_wait_for_state(self, stream_distribution_channel_id, update_stream_distribution_channel_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.media_services.MediaServicesClient.update_stream_distribution_channel` and waits for the :py:class:`~oci.media_services.models.StreamDistributionChannel` acted upon + to enter the given state(s). + + :param str stream_distribution_channel_id: (required) + Unique Stream Distribution Channel path identifier. + + :param oci.media_services.models.UpdateStreamDistributionChannelDetails update_stream_distribution_channel_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.media_services.models.StreamDistributionChannel.lifecycle_state` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.media_services.MediaServicesClient.update_stream_distribution_channel` + + :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_stream_distribution_channel(stream_distribution_channel_id, update_stream_distribution_channel_details, **operation_kwargs) + if not wait_for_states: + return operation_result + + lowered_wait_for_states = [w.lower() for w in wait_for_states] + wait_for_resource_id = operation_result.data.id + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_stream_distribution_channel(wait_for_resource_id), + 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 Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + + def update_stream_packaging_config_and_wait_for_state(self, stream_packaging_config_id, update_stream_packaging_config_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.media_services.MediaServicesClient.update_stream_packaging_config` and waits for the :py:class:`~oci.media_services.models.StreamPackagingConfig` acted upon + to enter the given state(s). + + :param str stream_packaging_config_id: (required) + Unique Stream Packaging Configuration path identifier. + + :param oci.media_services.models.UpdateStreamPackagingConfigDetails update_stream_packaging_config_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.media_services.models.StreamPackagingConfig.lifecycle_state` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.media_services.MediaServicesClient.update_stream_packaging_config` + + :param dict waiter_kwargs: + A dictionary of keyword arguments to pass to the :py:func:`oci.wait_until` function. For example, you could pass ``max_interval_seconds`` or ``max_interval_seconds`` + as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait + """ + operation_result = self.client.update_stream_packaging_config(stream_packaging_config_id, update_stream_packaging_config_details, **operation_kwargs) + if not wait_for_states: + return operation_result + + lowered_wait_for_states = [w.lower() for w in wait_for_states] + wait_for_resource_id = operation_result.data.id + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_stream_packaging_config(wait_for_resource_id), + 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 Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) diff --git a/src/oci/media_services/models/__init__.py b/src/oci/media_services/models/__init__.py new file mode 100644 index 0000000000..2a41d4fe79 --- /dev/null +++ b/src/oci/media_services/models/__init__.py @@ -0,0 +1,146 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from __future__ import absolute_import + +from .akamai_manual_stream_cdn_config import AkamaiManualStreamCdnConfig +from .asset_metadata_entry_details import AssetMetadataEntryDetails +from .change_media_asset_compartment_details import ChangeMediaAssetCompartmentDetails +from .change_media_workflow_compartment_details import ChangeMediaWorkflowCompartmentDetails +from .change_media_workflow_configuration_compartment_details import ChangeMediaWorkflowConfigurationCompartmentDetails +from .change_media_workflow_job_compartment_details import ChangeMediaWorkflowJobCompartmentDetails +from .change_stream_distribution_channel_compartment_details import ChangeStreamDistributionChannelCompartmentDetails +from .create_media_asset_details import CreateMediaAssetDetails +from .create_media_workflow_configuration_details import CreateMediaWorkflowConfigurationDetails +from .create_media_workflow_details import CreateMediaWorkflowDetails +from .create_media_workflow_job_by_id_details import CreateMediaWorkflowJobByIdDetails +from .create_media_workflow_job_by_name_details import CreateMediaWorkflowJobByNameDetails +from .create_media_workflow_job_details import CreateMediaWorkflowJobDetails +from .create_stream_cdn_config_details import CreateStreamCdnConfigDetails +from .create_stream_distribution_channel_details import CreateStreamDistributionChannelDetails +from .create_stream_packaging_config_details import CreateStreamPackagingConfigDetails +from .dash_stream_packaging_config import DashStreamPackagingConfig +from .edge_stream_cdn_config import EdgeStreamCdnConfig +from .hls_stream_packaging_config import HlsStreamPackagingConfig +from .ingest_stream_distribution_channel_details import IngestStreamDistributionChannelDetails +from .ingest_stream_distribution_channel_result import IngestStreamDistributionChannelResult +from .job_output import JobOutput +from .media_asset import MediaAsset +from .media_asset_collection import MediaAssetCollection +from .media_asset_distribution_channel_attachment import MediaAssetDistributionChannelAttachment +from .media_asset_distribution_channel_attachment_collection import MediaAssetDistributionChannelAttachmentCollection +from .media_asset_distribution_channel_attachment_summary import MediaAssetDistributionChannelAttachmentSummary +from .media_asset_summary import MediaAssetSummary +from .media_asset_tag import MediaAssetTag +from .media_workflow import MediaWorkflow +from .media_workflow_collection import MediaWorkflowCollection +from .media_workflow_configuration import MediaWorkflowConfiguration +from .media_workflow_configuration_collection import MediaWorkflowConfigurationCollection +from .media_workflow_configuration_summary import MediaWorkflowConfigurationSummary +from .media_workflow_job import MediaWorkflowJob +from .media_workflow_job_collection import MediaWorkflowJobCollection +from .media_workflow_job_fact import MediaWorkflowJobFact +from .media_workflow_job_fact_collection import MediaWorkflowJobFactCollection +from .media_workflow_job_fact_summary import MediaWorkflowJobFactSummary +from .media_workflow_job_summary import MediaWorkflowJobSummary +from .media_workflow_summary import MediaWorkflowSummary +from .media_workflow_task import MediaWorkflowTask +from .media_workflow_task_declaration import MediaWorkflowTaskDeclaration +from .media_workflow_task_declaration_collection import MediaWorkflowTaskDeclarationCollection +from .media_workflow_task_state import MediaWorkflowTaskState +from .metadata import Metadata +from .stream_cdn_config import StreamCdnConfig +from .stream_cdn_config_collection import StreamCdnConfigCollection +from .stream_cdn_config_section import StreamCdnConfigSection +from .stream_cdn_config_summary import StreamCdnConfigSummary +from .stream_distribution_channel import StreamDistributionChannel +from .stream_distribution_channel_collection import StreamDistributionChannelCollection +from .stream_distribution_channel_summary import StreamDistributionChannelSummary +from .stream_packaging_config import StreamPackagingConfig +from .stream_packaging_config_collection import StreamPackagingConfigCollection +from .stream_packaging_config_encryption import StreamPackagingConfigEncryption +from .stream_packaging_config_encryption_aes128 import StreamPackagingConfigEncryptionAes128 +from .stream_packaging_config_encryption_none import StreamPackagingConfigEncryptionNone +from .stream_packaging_config_summary import StreamPackagingConfigSummary +from .system_media_workflow import SystemMediaWorkflow +from .system_media_workflow_collection import SystemMediaWorkflowCollection +from .update_media_asset_details import UpdateMediaAssetDetails +from .update_media_workflow_configuration_details import UpdateMediaWorkflowConfigurationDetails +from .update_media_workflow_details import UpdateMediaWorkflowDetails +from .update_media_workflow_job_details import UpdateMediaWorkflowJobDetails +from .update_stream_cdn_config_details import UpdateStreamCdnConfigDetails +from .update_stream_distribution_channel_details import UpdateStreamDistributionChannelDetails +from .update_stream_packaging_config_details import UpdateStreamPackagingConfigDetails + +# Maps type names to classes for media_services services. +media_services_type_mapping = { + "AkamaiManualStreamCdnConfig": AkamaiManualStreamCdnConfig, + "AssetMetadataEntryDetails": AssetMetadataEntryDetails, + "ChangeMediaAssetCompartmentDetails": ChangeMediaAssetCompartmentDetails, + "ChangeMediaWorkflowCompartmentDetails": ChangeMediaWorkflowCompartmentDetails, + "ChangeMediaWorkflowConfigurationCompartmentDetails": ChangeMediaWorkflowConfigurationCompartmentDetails, + "ChangeMediaWorkflowJobCompartmentDetails": ChangeMediaWorkflowJobCompartmentDetails, + "ChangeStreamDistributionChannelCompartmentDetails": ChangeStreamDistributionChannelCompartmentDetails, + "CreateMediaAssetDetails": CreateMediaAssetDetails, + "CreateMediaWorkflowConfigurationDetails": CreateMediaWorkflowConfigurationDetails, + "CreateMediaWorkflowDetails": CreateMediaWorkflowDetails, + "CreateMediaWorkflowJobByIdDetails": CreateMediaWorkflowJobByIdDetails, + "CreateMediaWorkflowJobByNameDetails": CreateMediaWorkflowJobByNameDetails, + "CreateMediaWorkflowJobDetails": CreateMediaWorkflowJobDetails, + "CreateStreamCdnConfigDetails": CreateStreamCdnConfigDetails, + "CreateStreamDistributionChannelDetails": CreateStreamDistributionChannelDetails, + "CreateStreamPackagingConfigDetails": CreateStreamPackagingConfigDetails, + "DashStreamPackagingConfig": DashStreamPackagingConfig, + "EdgeStreamCdnConfig": EdgeStreamCdnConfig, + "HlsStreamPackagingConfig": HlsStreamPackagingConfig, + "IngestStreamDistributionChannelDetails": IngestStreamDistributionChannelDetails, + "IngestStreamDistributionChannelResult": IngestStreamDistributionChannelResult, + "JobOutput": JobOutput, + "MediaAsset": MediaAsset, + "MediaAssetCollection": MediaAssetCollection, + "MediaAssetDistributionChannelAttachment": MediaAssetDistributionChannelAttachment, + "MediaAssetDistributionChannelAttachmentCollection": MediaAssetDistributionChannelAttachmentCollection, + "MediaAssetDistributionChannelAttachmentSummary": MediaAssetDistributionChannelAttachmentSummary, + "MediaAssetSummary": MediaAssetSummary, + "MediaAssetTag": MediaAssetTag, + "MediaWorkflow": MediaWorkflow, + "MediaWorkflowCollection": MediaWorkflowCollection, + "MediaWorkflowConfiguration": MediaWorkflowConfiguration, + "MediaWorkflowConfigurationCollection": MediaWorkflowConfigurationCollection, + "MediaWorkflowConfigurationSummary": MediaWorkflowConfigurationSummary, + "MediaWorkflowJob": MediaWorkflowJob, + "MediaWorkflowJobCollection": MediaWorkflowJobCollection, + "MediaWorkflowJobFact": MediaWorkflowJobFact, + "MediaWorkflowJobFactCollection": MediaWorkflowJobFactCollection, + "MediaWorkflowJobFactSummary": MediaWorkflowJobFactSummary, + "MediaWorkflowJobSummary": MediaWorkflowJobSummary, + "MediaWorkflowSummary": MediaWorkflowSummary, + "MediaWorkflowTask": MediaWorkflowTask, + "MediaWorkflowTaskDeclaration": MediaWorkflowTaskDeclaration, + "MediaWorkflowTaskDeclarationCollection": MediaWorkflowTaskDeclarationCollection, + "MediaWorkflowTaskState": MediaWorkflowTaskState, + "Metadata": Metadata, + "StreamCdnConfig": StreamCdnConfig, + "StreamCdnConfigCollection": StreamCdnConfigCollection, + "StreamCdnConfigSection": StreamCdnConfigSection, + "StreamCdnConfigSummary": StreamCdnConfigSummary, + "StreamDistributionChannel": StreamDistributionChannel, + "StreamDistributionChannelCollection": StreamDistributionChannelCollection, + "StreamDistributionChannelSummary": StreamDistributionChannelSummary, + "StreamPackagingConfig": StreamPackagingConfig, + "StreamPackagingConfigCollection": StreamPackagingConfigCollection, + "StreamPackagingConfigEncryption": StreamPackagingConfigEncryption, + "StreamPackagingConfigEncryptionAes128": StreamPackagingConfigEncryptionAes128, + "StreamPackagingConfigEncryptionNone": StreamPackagingConfigEncryptionNone, + "StreamPackagingConfigSummary": StreamPackagingConfigSummary, + "SystemMediaWorkflow": SystemMediaWorkflow, + "SystemMediaWorkflowCollection": SystemMediaWorkflowCollection, + "UpdateMediaAssetDetails": UpdateMediaAssetDetails, + "UpdateMediaWorkflowConfigurationDetails": UpdateMediaWorkflowConfigurationDetails, + "UpdateMediaWorkflowDetails": UpdateMediaWorkflowDetails, + "UpdateMediaWorkflowJobDetails": UpdateMediaWorkflowJobDetails, + "UpdateStreamCdnConfigDetails": UpdateStreamCdnConfigDetails, + "UpdateStreamDistributionChannelDetails": UpdateStreamDistributionChannelDetails, + "UpdateStreamPackagingConfigDetails": UpdateStreamPackagingConfigDetails +} diff --git a/src/oci/media_services/models/akamai_manual_stream_cdn_config.py b/src/oci/media_services/models/akamai_manual_stream_cdn_config.py new file mode 100644 index 0000000000..a9691b86aa --- /dev/null +++ b/src/oci/media_services/models/akamai_manual_stream_cdn_config.py @@ -0,0 +1,415 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .stream_cdn_config_section import StreamCdnConfigSection +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 AkamaiManualStreamCdnConfig(StreamCdnConfigSection): + """ + Configuration fields for manual Akamai configuration. + """ + + #: A constant which can be used with the origin_auth_sign_type property of a AkamaiManualStreamCdnConfig. + #: This constant has a value of "ForwardURL" + ORIGIN_AUTH_SIGN_TYPE_FORWARD_URL = "ForwardURL" + + #: A constant which can be used with the origin_auth_sign_encryption property of a AkamaiManualStreamCdnConfig. + #: This constant has a value of "SHA256-HMAC" + ORIGIN_AUTH_SIGN_ENCRYPTION_SHA256_HMAC = "SHA256-HMAC" + + def __init__(self, **kwargs): + """ + Initializes a new AkamaiManualStreamCdnConfig object with values from keyword arguments. The default value of the :py:attr:`~oci.media_services.models.AkamaiManualStreamCdnConfig.type` attribute + of this class is ``AKAMAI_MANUAL`` 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 AkamaiManualStreamCdnConfig. + Allowed values for this property are: "EDGE", "AKAMAI_MANUAL", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type type: str + + :param origin_auth_sign_type: + The value to assign to the origin_auth_sign_type property of this AkamaiManualStreamCdnConfig. + Allowed values for this property are: "ForwardURL", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type origin_auth_sign_type: str + + :param origin_auth_sign_encryption: + The value to assign to the origin_auth_sign_encryption property of this AkamaiManualStreamCdnConfig. + Allowed values for this property are: "SHA256-HMAC", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type origin_auth_sign_encryption: str + + :param origin_auth_secret_key_a: + The value to assign to the origin_auth_secret_key_a property of this AkamaiManualStreamCdnConfig. + :type origin_auth_secret_key_a: str + + :param origin_auth_secret_key_nonce_a: + The value to assign to the origin_auth_secret_key_nonce_a property of this AkamaiManualStreamCdnConfig. + :type origin_auth_secret_key_nonce_a: str + + :param origin_auth_secret_key_b: + The value to assign to the origin_auth_secret_key_b property of this AkamaiManualStreamCdnConfig. + :type origin_auth_secret_key_b: str + + :param origin_auth_secret_key_nonce_b: + The value to assign to the origin_auth_secret_key_nonce_b property of this AkamaiManualStreamCdnConfig. + :type origin_auth_secret_key_nonce_b: str + + :param edge_hostname: + The value to assign to the edge_hostname property of this AkamaiManualStreamCdnConfig. + :type edge_hostname: str + + :param edge_path_prefix: + The value to assign to the edge_path_prefix property of this AkamaiManualStreamCdnConfig. + :type edge_path_prefix: str + + :param is_edge_token_auth: + The value to assign to the is_edge_token_auth property of this AkamaiManualStreamCdnConfig. + :type is_edge_token_auth: bool + + :param edge_token_key: + The value to assign to the edge_token_key property of this AkamaiManualStreamCdnConfig. + :type edge_token_key: str + + :param edge_token_salt: + The value to assign to the edge_token_salt property of this AkamaiManualStreamCdnConfig. + :type edge_token_salt: str + + """ + self.swagger_types = { + 'type': 'str', + 'origin_auth_sign_type': 'str', + 'origin_auth_sign_encryption': 'str', + 'origin_auth_secret_key_a': 'str', + 'origin_auth_secret_key_nonce_a': 'str', + 'origin_auth_secret_key_b': 'str', + 'origin_auth_secret_key_nonce_b': 'str', + 'edge_hostname': 'str', + 'edge_path_prefix': 'str', + 'is_edge_token_auth': 'bool', + 'edge_token_key': 'str', + 'edge_token_salt': 'str' + } + + self.attribute_map = { + 'type': 'type', + 'origin_auth_sign_type': 'originAuthSignType', + 'origin_auth_sign_encryption': 'originAuthSignEncryption', + 'origin_auth_secret_key_a': 'originAuthSecretKeyA', + 'origin_auth_secret_key_nonce_a': 'originAuthSecretKeyNonceA', + 'origin_auth_secret_key_b': 'originAuthSecretKeyB', + 'origin_auth_secret_key_nonce_b': 'originAuthSecretKeyNonceB', + 'edge_hostname': 'edgeHostname', + 'edge_path_prefix': 'edgePathPrefix', + 'is_edge_token_auth': 'isEdgeTokenAuth', + 'edge_token_key': 'edgeTokenKey', + 'edge_token_salt': 'edgeTokenSalt' + } + + self._type = None + self._origin_auth_sign_type = None + self._origin_auth_sign_encryption = None + self._origin_auth_secret_key_a = None + self._origin_auth_secret_key_nonce_a = None + self._origin_auth_secret_key_b = None + self._origin_auth_secret_key_nonce_b = None + self._edge_hostname = None + self._edge_path_prefix = None + self._is_edge_token_auth = None + self._edge_token_key = None + self._edge_token_salt = None + self._type = 'AKAMAI_MANUAL' + + @property + def origin_auth_sign_type(self): + """ + Gets the origin_auth_sign_type of this AkamaiManualStreamCdnConfig. + The type of data used to compute the signature. + + Allowed values for this property are: "ForwardURL", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The origin_auth_sign_type of this AkamaiManualStreamCdnConfig. + :rtype: str + """ + return self._origin_auth_sign_type + + @origin_auth_sign_type.setter + def origin_auth_sign_type(self, origin_auth_sign_type): + """ + Sets the origin_auth_sign_type of this AkamaiManualStreamCdnConfig. + The type of data used to compute the signature. + + + :param origin_auth_sign_type: The origin_auth_sign_type of this AkamaiManualStreamCdnConfig. + :type: str + """ + allowed_values = ["ForwardURL"] + if not value_allowed_none_or_none_sentinel(origin_auth_sign_type, allowed_values): + origin_auth_sign_type = 'UNKNOWN_ENUM_VALUE' + self._origin_auth_sign_type = origin_auth_sign_type + + @property + def origin_auth_sign_encryption(self): + """ + Gets the origin_auth_sign_encryption of this AkamaiManualStreamCdnConfig. + The type of encryption used to compute the signature. + + Allowed values for this property are: "SHA256-HMAC", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The origin_auth_sign_encryption of this AkamaiManualStreamCdnConfig. + :rtype: str + """ + return self._origin_auth_sign_encryption + + @origin_auth_sign_encryption.setter + def origin_auth_sign_encryption(self, origin_auth_sign_encryption): + """ + Sets the origin_auth_sign_encryption of this AkamaiManualStreamCdnConfig. + The type of encryption used to compute the signature. + + + :param origin_auth_sign_encryption: The origin_auth_sign_encryption of this AkamaiManualStreamCdnConfig. + :type: str + """ + allowed_values = ["SHA256-HMAC"] + if not value_allowed_none_or_none_sentinel(origin_auth_sign_encryption, allowed_values): + origin_auth_sign_encryption = 'UNKNOWN_ENUM_VALUE' + self._origin_auth_sign_encryption = origin_auth_sign_encryption + + @property + def origin_auth_secret_key_a(self): + """ + Gets the origin_auth_secret_key_a of this AkamaiManualStreamCdnConfig. + The shared secret key A, two for errorless key rotation. + + + :return: The origin_auth_secret_key_a of this AkamaiManualStreamCdnConfig. + :rtype: str + """ + return self._origin_auth_secret_key_a + + @origin_auth_secret_key_a.setter + def origin_auth_secret_key_a(self, origin_auth_secret_key_a): + """ + Sets the origin_auth_secret_key_a of this AkamaiManualStreamCdnConfig. + The shared secret key A, two for errorless key rotation. + + + :param origin_auth_secret_key_a: The origin_auth_secret_key_a of this AkamaiManualStreamCdnConfig. + :type: str + """ + self._origin_auth_secret_key_a = origin_auth_secret_key_a + + @property + def origin_auth_secret_key_nonce_a(self): + """ + Gets the origin_auth_secret_key_nonce_a of this AkamaiManualStreamCdnConfig. + Nonce identifier for originAuthSecretKeyA (used to determine key used to sign). + + + :return: The origin_auth_secret_key_nonce_a of this AkamaiManualStreamCdnConfig. + :rtype: str + """ + return self._origin_auth_secret_key_nonce_a + + @origin_auth_secret_key_nonce_a.setter + def origin_auth_secret_key_nonce_a(self, origin_auth_secret_key_nonce_a): + """ + Sets the origin_auth_secret_key_nonce_a of this AkamaiManualStreamCdnConfig. + Nonce identifier for originAuthSecretKeyA (used to determine key used to sign). + + + :param origin_auth_secret_key_nonce_a: The origin_auth_secret_key_nonce_a of this AkamaiManualStreamCdnConfig. + :type: str + """ + self._origin_auth_secret_key_nonce_a = origin_auth_secret_key_nonce_a + + @property + def origin_auth_secret_key_b(self): + """ + Gets the origin_auth_secret_key_b of this AkamaiManualStreamCdnConfig. + The shared secret key B, two for errorless key rotation. + + + :return: The origin_auth_secret_key_b of this AkamaiManualStreamCdnConfig. + :rtype: str + """ + return self._origin_auth_secret_key_b + + @origin_auth_secret_key_b.setter + def origin_auth_secret_key_b(self, origin_auth_secret_key_b): + """ + Sets the origin_auth_secret_key_b of this AkamaiManualStreamCdnConfig. + The shared secret key B, two for errorless key rotation. + + + :param origin_auth_secret_key_b: The origin_auth_secret_key_b of this AkamaiManualStreamCdnConfig. + :type: str + """ + self._origin_auth_secret_key_b = origin_auth_secret_key_b + + @property + def origin_auth_secret_key_nonce_b(self): + """ + Gets the origin_auth_secret_key_nonce_b of this AkamaiManualStreamCdnConfig. + Nonce identifier for originAuthSecretKeyB (used to determine key used to sign). + + + :return: The origin_auth_secret_key_nonce_b of this AkamaiManualStreamCdnConfig. + :rtype: str + """ + return self._origin_auth_secret_key_nonce_b + + @origin_auth_secret_key_nonce_b.setter + def origin_auth_secret_key_nonce_b(self, origin_auth_secret_key_nonce_b): + """ + Sets the origin_auth_secret_key_nonce_b of this AkamaiManualStreamCdnConfig. + Nonce identifier for originAuthSecretKeyB (used to determine key used to sign). + + + :param origin_auth_secret_key_nonce_b: The origin_auth_secret_key_nonce_b of this AkamaiManualStreamCdnConfig. + :type: str + """ + self._origin_auth_secret_key_nonce_b = origin_auth_secret_key_nonce_b + + @property + def edge_hostname(self): + """ + Gets the edge_hostname of this AkamaiManualStreamCdnConfig. + The hostname of the CDN edge server to use when building CDN URLs. + + + :return: The edge_hostname of this AkamaiManualStreamCdnConfig. + :rtype: str + """ + return self._edge_hostname + + @edge_hostname.setter + def edge_hostname(self, edge_hostname): + """ + Sets the edge_hostname of this AkamaiManualStreamCdnConfig. + The hostname of the CDN edge server to use when building CDN URLs. + + + :param edge_hostname: The edge_hostname of this AkamaiManualStreamCdnConfig. + :type: str + """ + self._edge_hostname = edge_hostname + + @property + def edge_path_prefix(self): + """ + Gets the edge_path_prefix of this AkamaiManualStreamCdnConfig. + The path to prepend when building CDN URLs. + + + :return: The edge_path_prefix of this AkamaiManualStreamCdnConfig. + :rtype: str + """ + return self._edge_path_prefix + + @edge_path_prefix.setter + def edge_path_prefix(self, edge_path_prefix): + """ + Sets the edge_path_prefix of this AkamaiManualStreamCdnConfig. + The path to prepend when building CDN URLs. + + + :param edge_path_prefix: The edge_path_prefix of this AkamaiManualStreamCdnConfig. + :type: str + """ + self._edge_path_prefix = edge_path_prefix + + @property + def is_edge_token_auth(self): + """ + Gets the is_edge_token_auth of this AkamaiManualStreamCdnConfig. + Whether token authentication should be used at the CDN edge. + + + :return: The is_edge_token_auth of this AkamaiManualStreamCdnConfig. + :rtype: bool + """ + return self._is_edge_token_auth + + @is_edge_token_auth.setter + def is_edge_token_auth(self, is_edge_token_auth): + """ + Sets the is_edge_token_auth of this AkamaiManualStreamCdnConfig. + Whether token authentication should be used at the CDN edge. + + + :param is_edge_token_auth: The is_edge_token_auth of this AkamaiManualStreamCdnConfig. + :type: bool + """ + self._is_edge_token_auth = is_edge_token_auth + + @property + def edge_token_key(self): + """ + Gets the edge_token_key of this AkamaiManualStreamCdnConfig. + The encryption key to use for edge token authentication. + + + :return: The edge_token_key of this AkamaiManualStreamCdnConfig. + :rtype: str + """ + return self._edge_token_key + + @edge_token_key.setter + def edge_token_key(self, edge_token_key): + """ + Sets the edge_token_key of this AkamaiManualStreamCdnConfig. + The encryption key to use for edge token authentication. + + + :param edge_token_key: The edge_token_key of this AkamaiManualStreamCdnConfig. + :type: str + """ + self._edge_token_key = edge_token_key + + @property + def edge_token_salt(self): + """ + Gets the edge_token_salt of this AkamaiManualStreamCdnConfig. + Salt to use when encrypting authentication token. + + + :return: The edge_token_salt of this AkamaiManualStreamCdnConfig. + :rtype: str + """ + return self._edge_token_salt + + @edge_token_salt.setter + def edge_token_salt(self, edge_token_salt): + """ + Sets the edge_token_salt of this AkamaiManualStreamCdnConfig. + Salt to use when encrypting authentication token. + + + :param edge_token_salt: The edge_token_salt of this AkamaiManualStreamCdnConfig. + :type: str + """ + self._edge_token_salt = edge_token_salt + + 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/media_services/models/asset_metadata_entry_details.py b/src/oci/media_services/models/asset_metadata_entry_details.py new file mode 100644 index 0000000000..2a6b17a5f2 --- /dev/null +++ b/src/oci/media_services/models/asset_metadata_entry_details.py @@ -0,0 +1,111 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .ingest_stream_distribution_channel_details import IngestStreamDistributionChannelDetails +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 AssetMetadataEntryDetails(IngestStreamDistributionChannelDetails): + """ + Asset Metadata entry information. + """ + + def __init__(self, **kwargs): + """ + Initializes a new AssetMetadataEntryDetails object with values from keyword arguments. The default value of the :py:attr:`~oci.media_services.models.AssetMetadataEntryDetails.ingest_payload_type` attribute + of this class is ``ASSET_METADATA_MEDIA_ASSET`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param ingest_payload_type: + The value to assign to the ingest_payload_type property of this AssetMetadataEntryDetails. + Allowed values for this property are: "ASSET_METADATA_MEDIA_ASSET" + :type ingest_payload_type: str + + :param media_asset_id: + The value to assign to the media_asset_id property of this AssetMetadataEntryDetails. + :type media_asset_id: str + + :param compartment_id: + The value to assign to the compartment_id property of this AssetMetadataEntryDetails. + :type compartment_id: str + + """ + self.swagger_types = { + 'ingest_payload_type': 'str', + 'media_asset_id': 'str', + 'compartment_id': 'str' + } + + self.attribute_map = { + 'ingest_payload_type': 'ingestPayloadType', + 'media_asset_id': 'mediaAssetId', + 'compartment_id': 'compartmentId' + } + + self._ingest_payload_type = None + self._media_asset_id = None + self._compartment_id = None + self._ingest_payload_type = 'ASSET_METADATA_MEDIA_ASSET' + + @property + def media_asset_id(self): + """ + **[Required]** Gets the media_asset_id of this AssetMetadataEntryDetails. + The Media Asset ID to ingest into the Distribution Channel. + + + :return: The media_asset_id of this AssetMetadataEntryDetails. + :rtype: str + """ + return self._media_asset_id + + @media_asset_id.setter + def media_asset_id(self, media_asset_id): + """ + Sets the media_asset_id of this AssetMetadataEntryDetails. + The Media Asset ID to ingest into the Distribution Channel. + + + :param media_asset_id: The media_asset_id of this AssetMetadataEntryDetails. + :type: str + """ + self._media_asset_id = media_asset_id + + @property + def compartment_id(self): + """ + Gets the compartment_id of this AssetMetadataEntryDetails. + The compartment ID where the Ingest Workflow Job will be run. + + + :return: The compartment_id of this AssetMetadataEntryDetails. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this AssetMetadataEntryDetails. + The compartment ID where the Ingest Workflow Job will be run. + + + :param compartment_id: The compartment_id of this AssetMetadataEntryDetails. + :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/media_services/models/change_media_asset_compartment_details.py b/src/oci/media_services/models/change_media_asset_compartment_details.py new file mode 100644 index 0000000000..0518e3503d --- /dev/null +++ b/src/oci/media_services/models/change_media_asset_compartment_details.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 ChangeMediaAssetCompartmentDetails(object): + """ + The information to be updated. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ChangeMediaAssetCompartmentDetails 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 ChangeMediaAssetCompartmentDetails. + :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 ChangeMediaAssetCompartmentDetails. + Compartment Identifier. + + + :return: The compartment_id of this ChangeMediaAssetCompartmentDetails. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this ChangeMediaAssetCompartmentDetails. + Compartment Identifier. + + + :param compartment_id: The compartment_id of this ChangeMediaAssetCompartmentDetails. + :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/media_services/models/change_media_workflow_compartment_details.py b/src/oci/media_services/models/change_media_workflow_compartment_details.py new file mode 100644 index 0000000000..a41982dbe7 --- /dev/null +++ b/src/oci/media_services/models/change_media_workflow_compartment_details.py @@ -0,0 +1,76 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 ChangeMediaWorkflowCompartmentDetails(object): + """ + The information to be updated. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ChangeMediaWorkflowCompartmentDetails 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 ChangeMediaWorkflowCompartmentDetails. + :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 ChangeMediaWorkflowCompartmentDetails. + 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 ChangeMediaWorkflowCompartmentDetails. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this ChangeMediaWorkflowCompartmentDetails. + 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 ChangeMediaWorkflowCompartmentDetails. + :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/media_services/models/change_media_workflow_configuration_compartment_details.py b/src/oci/media_services/models/change_media_workflow_configuration_compartment_details.py new file mode 100644 index 0000000000..43b1f63612 --- /dev/null +++ b/src/oci/media_services/models/change_media_workflow_configuration_compartment_details.py @@ -0,0 +1,76 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 ChangeMediaWorkflowConfigurationCompartmentDetails(object): + """ + The details of the compartment to which the MediaWorkflowConfiguration will be moved. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ChangeMediaWorkflowConfigurationCompartmentDetails 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 ChangeMediaWorkflowConfigurationCompartmentDetails. + :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 ChangeMediaWorkflowConfigurationCompartmentDetails. + 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 ChangeMediaWorkflowConfigurationCompartmentDetails. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this ChangeMediaWorkflowConfigurationCompartmentDetails. + 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 ChangeMediaWorkflowConfigurationCompartmentDetails. + :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/media_services/models/change_media_workflow_job_compartment_details.py b/src/oci/media_services/models/change_media_workflow_job_compartment_details.py new file mode 100644 index 0000000000..ca0aa09261 --- /dev/null +++ b/src/oci/media_services/models/change_media_workflow_job_compartment_details.py @@ -0,0 +1,76 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 ChangeMediaWorkflowJobCompartmentDetails(object): + """ + The information to be updated. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ChangeMediaWorkflowJobCompartmentDetails 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 ChangeMediaWorkflowJobCompartmentDetails. + :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 ChangeMediaWorkflowJobCompartmentDetails. + 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 ChangeMediaWorkflowJobCompartmentDetails. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this ChangeMediaWorkflowJobCompartmentDetails. + 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 ChangeMediaWorkflowJobCompartmentDetails. + :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/media_services/models/change_stream_distribution_channel_compartment_details.py b/src/oci/media_services/models/change_stream_distribution_channel_compartment_details.py new file mode 100644 index 0000000000..f8dc61b72b --- /dev/null +++ b/src/oci/media_services/models/change_stream_distribution_channel_compartment_details.py @@ -0,0 +1,76 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 ChangeStreamDistributionChannelCompartmentDetails(object): + """ + The information to be updated. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ChangeStreamDistributionChannelCompartmentDetails 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 ChangeStreamDistributionChannelCompartmentDetails. + :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 ChangeStreamDistributionChannelCompartmentDetails. + 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 ChangeStreamDistributionChannelCompartmentDetails. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this ChangeStreamDistributionChannelCompartmentDetails. + 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 ChangeStreamDistributionChannelCompartmentDetails. + :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/media_services/models/create_media_asset_details.py b/src/oci/media_services/models/create_media_asset_details.py new file mode 100644 index 0000000000..1d3b5ed9c4 --- /dev/null +++ b/src/oci/media_services/models/create_media_asset_details.py @@ -0,0 +1,634 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 CreateMediaAssetDetails(object): + """ + The information about new MediaAsset. + """ + + #: A constant which can be used with the type property of a CreateMediaAssetDetails. + #: This constant has a value of "AUDIO" + TYPE_AUDIO = "AUDIO" + + #: A constant which can be used with the type property of a CreateMediaAssetDetails. + #: This constant has a value of "VIDEO" + TYPE_VIDEO = "VIDEO" + + #: A constant which can be used with the type property of a CreateMediaAssetDetails. + #: This constant has a value of "PLAYLIST" + TYPE_PLAYLIST = "PLAYLIST" + + #: A constant which can be used with the type property of a CreateMediaAssetDetails. + #: This constant has a value of "IMAGE" + TYPE_IMAGE = "IMAGE" + + #: A constant which can be used with the type property of a CreateMediaAssetDetails. + #: This constant has a value of "CAPTION_FILE" + TYPE_CAPTION_FILE = "CAPTION_FILE" + + #: A constant which can be used with the type property of a CreateMediaAssetDetails. + #: This constant has a value of "UNKNOWN" + TYPE_UNKNOWN = "UNKNOWN" + + def __init__(self, **kwargs): + """ + Initializes a new CreateMediaAssetDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param source_media_workflow_id: + The value to assign to the source_media_workflow_id property of this CreateMediaAssetDetails. + :type source_media_workflow_id: str + + :param media_workflow_job_id: + The value to assign to the media_workflow_job_id property of this CreateMediaAssetDetails. + :type media_workflow_job_id: str + + :param source_media_workflow_version: + The value to assign to the source_media_workflow_version property of this CreateMediaAssetDetails. + :type source_media_workflow_version: int + + :param display_name: + The value to assign to the display_name property of this CreateMediaAssetDetails. + :type display_name: str + + :param compartment_id: + The value to assign to the compartment_id property of this CreateMediaAssetDetails. + :type compartment_id: str + + :param type: + The value to assign to the type property of this CreateMediaAssetDetails. + Allowed values for this property are: "AUDIO", "VIDEO", "PLAYLIST", "IMAGE", "CAPTION_FILE", "UNKNOWN" + :type type: str + + :param parent_media_asset_id: + The value to assign to the parent_media_asset_id property of this CreateMediaAssetDetails. + :type parent_media_asset_id: str + + :param master_media_asset_id: + The value to assign to the master_media_asset_id property of this CreateMediaAssetDetails. + :type master_media_asset_id: str + + :param bucket_name: + The value to assign to the bucket_name property of this CreateMediaAssetDetails. + :type bucket_name: str + + :param namespace_name: + The value to assign to the namespace_name property of this CreateMediaAssetDetails. + :type namespace_name: str + + :param object_name: + The value to assign to the object_name property of this CreateMediaAssetDetails. + :type object_name: str + + :param object_etag: + The value to assign to the object_etag property of this CreateMediaAssetDetails. + :type object_etag: str + + :param metadata: + The value to assign to the metadata property of this CreateMediaAssetDetails. + :type metadata: list[oci.media_services.models.Metadata] + + :param segment_range_start_index: + The value to assign to the segment_range_start_index property of this CreateMediaAssetDetails. + :type segment_range_start_index: int + + :param segment_range_end_index: + The value to assign to the segment_range_end_index property of this CreateMediaAssetDetails. + :type segment_range_end_index: int + + :param media_asset_tags: + The value to assign to the media_asset_tags property of this CreateMediaAssetDetails. + :type media_asset_tags: list[oci.media_services.models.MediaAssetTag] + + :param freeform_tags: + The value to assign to the freeform_tags property of this CreateMediaAssetDetails. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this CreateMediaAssetDetails. + :type defined_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'source_media_workflow_id': 'str', + 'media_workflow_job_id': 'str', + 'source_media_workflow_version': 'int', + 'display_name': 'str', + 'compartment_id': 'str', + 'type': 'str', + 'parent_media_asset_id': 'str', + 'master_media_asset_id': 'str', + 'bucket_name': 'str', + 'namespace_name': 'str', + 'object_name': 'str', + 'object_etag': 'str', + 'metadata': 'list[Metadata]', + 'segment_range_start_index': 'int', + 'segment_range_end_index': 'int', + 'media_asset_tags': 'list[MediaAssetTag]', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))' + } + + self.attribute_map = { + 'source_media_workflow_id': 'sourceMediaWorkflowId', + 'media_workflow_job_id': 'mediaWorkflowJobId', + 'source_media_workflow_version': 'sourceMediaWorkflowVersion', + 'display_name': 'displayName', + 'compartment_id': 'compartmentId', + 'type': 'type', + 'parent_media_asset_id': 'parentMediaAssetId', + 'master_media_asset_id': 'masterMediaAssetId', + 'bucket_name': 'bucketName', + 'namespace_name': 'namespaceName', + 'object_name': 'objectName', + 'object_etag': 'objectEtag', + 'metadata': 'metadata', + 'segment_range_start_index': 'segmentRangeStartIndex', + 'segment_range_end_index': 'segmentRangeEndIndex', + 'media_asset_tags': 'mediaAssetTags', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags' + } + + self._source_media_workflow_id = None + self._media_workflow_job_id = None + self._source_media_workflow_version = None + self._display_name = None + self._compartment_id = None + self._type = None + self._parent_media_asset_id = None + self._master_media_asset_id = None + self._bucket_name = None + self._namespace_name = None + self._object_name = None + self._object_etag = None + self._metadata = None + self._segment_range_start_index = None + self._segment_range_end_index = None + self._media_asset_tags = None + self._freeform_tags = None + self._defined_tags = None + + @property + def source_media_workflow_id(self): + """ + Gets the source_media_workflow_id of this CreateMediaAssetDetails. + The ID of the MediaWorkflow used to produce this asset. + + + :return: The source_media_workflow_id of this CreateMediaAssetDetails. + :rtype: str + """ + return self._source_media_workflow_id + + @source_media_workflow_id.setter + def source_media_workflow_id(self, source_media_workflow_id): + """ + Sets the source_media_workflow_id of this CreateMediaAssetDetails. + The ID of the MediaWorkflow used to produce this asset. + + + :param source_media_workflow_id: The source_media_workflow_id of this CreateMediaAssetDetails. + :type: str + """ + self._source_media_workflow_id = source_media_workflow_id + + @property + def media_workflow_job_id(self): + """ + Gets the media_workflow_job_id of this CreateMediaAssetDetails. + The ID of the MediaWorkflowJob used to produce this asset. + + + :return: The media_workflow_job_id of this CreateMediaAssetDetails. + :rtype: str + """ + return self._media_workflow_job_id + + @media_workflow_job_id.setter + def media_workflow_job_id(self, media_workflow_job_id): + """ + Sets the media_workflow_job_id of this CreateMediaAssetDetails. + The ID of the MediaWorkflowJob used to produce this asset. + + + :param media_workflow_job_id: The media_workflow_job_id of this CreateMediaAssetDetails. + :type: str + """ + self._media_workflow_job_id = media_workflow_job_id + + @property + def source_media_workflow_version(self): + """ + Gets the source_media_workflow_version of this CreateMediaAssetDetails. + The version of the MediaWorkflow used to produce this asset. + + + :return: The source_media_workflow_version of this CreateMediaAssetDetails. + :rtype: int + """ + return self._source_media_workflow_version + + @source_media_workflow_version.setter + def source_media_workflow_version(self, source_media_workflow_version): + """ + Sets the source_media_workflow_version of this CreateMediaAssetDetails. + The version of the MediaWorkflow used to produce this asset. + + + :param source_media_workflow_version: The source_media_workflow_version of this CreateMediaAssetDetails. + :type: int + """ + self._source_media_workflow_version = source_media_workflow_version + + @property + def display_name(self): + """ + Gets the display_name of this CreateMediaAssetDetails. + Display name for the Media Asset. Does not have to be unique. Avoid entering confidential information. + + + :return: The display_name of this CreateMediaAssetDetails. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this CreateMediaAssetDetails. + Display name for the Media Asset. Does not have to be unique. Avoid entering confidential information. + + + :param display_name: The display_name of this CreateMediaAssetDetails. + :type: str + """ + self._display_name = display_name + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this CreateMediaAssetDetails. + Compartment Identifier. + + + :return: The compartment_id of this CreateMediaAssetDetails. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this CreateMediaAssetDetails. + Compartment Identifier. + + + :param compartment_id: The compartment_id of this CreateMediaAssetDetails. + :type: str + """ + self._compartment_id = compartment_id + + @property + def type(self): + """ + **[Required]** Gets the type of this CreateMediaAssetDetails. + The type of the media asset. + + Allowed values for this property are: "AUDIO", "VIDEO", "PLAYLIST", "IMAGE", "CAPTION_FILE", "UNKNOWN" + + + :return: The type of this CreateMediaAssetDetails. + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """ + Sets the type of this CreateMediaAssetDetails. + The type of the media asset. + + + :param type: The type of this CreateMediaAssetDetails. + :type: str + """ + allowed_values = ["AUDIO", "VIDEO", "PLAYLIST", "IMAGE", "CAPTION_FILE", "UNKNOWN"] + if not value_allowed_none_or_none_sentinel(type, allowed_values): + raise ValueError( + "Invalid value for `type`, must be None or one of {0}" + .format(allowed_values) + ) + self._type = type + + @property + def parent_media_asset_id(self): + """ + Gets the parent_media_asset_id of this CreateMediaAssetDetails. + The ID of the parent asset from which this asset is derived. + + + :return: The parent_media_asset_id of this CreateMediaAssetDetails. + :rtype: str + """ + return self._parent_media_asset_id + + @parent_media_asset_id.setter + def parent_media_asset_id(self, parent_media_asset_id): + """ + Sets the parent_media_asset_id of this CreateMediaAssetDetails. + The ID of the parent asset from which this asset is derived. + + + :param parent_media_asset_id: The parent_media_asset_id of this CreateMediaAssetDetails. + :type: str + """ + self._parent_media_asset_id = parent_media_asset_id + + @property + def master_media_asset_id(self): + """ + Gets the master_media_asset_id of this CreateMediaAssetDetails. + The ID of the senior most asset from which this asset is derived. + + + :return: The master_media_asset_id of this CreateMediaAssetDetails. + :rtype: str + """ + return self._master_media_asset_id + + @master_media_asset_id.setter + def master_media_asset_id(self, master_media_asset_id): + """ + Sets the master_media_asset_id of this CreateMediaAssetDetails. + The ID of the senior most asset from which this asset is derived. + + + :param master_media_asset_id: The master_media_asset_id of this CreateMediaAssetDetails. + :type: str + """ + self._master_media_asset_id = master_media_asset_id + + @property + def bucket_name(self): + """ + Gets the bucket_name of this CreateMediaAssetDetails. + The name of the object storage bucket where this asset is located. + + + :return: The bucket_name of this CreateMediaAssetDetails. + :rtype: str + """ + return self._bucket_name + + @bucket_name.setter + def bucket_name(self, bucket_name): + """ + Sets the bucket_name of this CreateMediaAssetDetails. + The name of the object storage bucket where this asset is located. + + + :param bucket_name: The bucket_name of this CreateMediaAssetDetails. + :type: str + """ + self._bucket_name = bucket_name + + @property + def namespace_name(self): + """ + Gets the namespace_name of this CreateMediaAssetDetails. + The object storage namespace where this asset is located. + + + :return: The namespace_name of this CreateMediaAssetDetails. + :rtype: str + """ + return self._namespace_name + + @namespace_name.setter + def namespace_name(self, namespace_name): + """ + Sets the namespace_name of this CreateMediaAssetDetails. + The object storage namespace where this asset is located. + + + :param namespace_name: The namespace_name of this CreateMediaAssetDetails. + :type: str + """ + self._namespace_name = namespace_name + + @property + def object_name(self): + """ + Gets the object_name of this CreateMediaAssetDetails. + The object storage object name that identifies this asset. + + + :return: The object_name of this CreateMediaAssetDetails. + :rtype: str + """ + return self._object_name + + @object_name.setter + def object_name(self, object_name): + """ + Sets the object_name of this CreateMediaAssetDetails. + The object storage object name that identifies this asset. + + + :param object_name: The object_name of this CreateMediaAssetDetails. + :type: str + """ + self._object_name = object_name + + @property + def object_etag(self): + """ + Gets the object_etag of this CreateMediaAssetDetails. + eTag of the underlying object storage object. + + + :return: The object_etag of this CreateMediaAssetDetails. + :rtype: str + """ + return self._object_etag + + @object_etag.setter + def object_etag(self, object_etag): + """ + Sets the object_etag of this CreateMediaAssetDetails. + eTag of the underlying object storage object. + + + :param object_etag: The object_etag of this CreateMediaAssetDetails. + :type: str + """ + self._object_etag = object_etag + + @property + def metadata(self): + """ + Gets the metadata of this CreateMediaAssetDetails. + List of Metadata. + + + :return: The metadata of this CreateMediaAssetDetails. + :rtype: list[oci.media_services.models.Metadata] + """ + return self._metadata + + @metadata.setter + def metadata(self, metadata): + """ + Sets the metadata of this CreateMediaAssetDetails. + List of Metadata. + + + :param metadata: The metadata of this CreateMediaAssetDetails. + :type: list[oci.media_services.models.Metadata] + """ + self._metadata = metadata + + @property + def segment_range_start_index(self): + """ + Gets the segment_range_start_index of this CreateMediaAssetDetails. + The start index for video segment files. + + + :return: The segment_range_start_index of this CreateMediaAssetDetails. + :rtype: int + """ + return self._segment_range_start_index + + @segment_range_start_index.setter + def segment_range_start_index(self, segment_range_start_index): + """ + Sets the segment_range_start_index of this CreateMediaAssetDetails. + The start index for video segment files. + + + :param segment_range_start_index: The segment_range_start_index of this CreateMediaAssetDetails. + :type: int + """ + self._segment_range_start_index = segment_range_start_index + + @property + def segment_range_end_index(self): + """ + Gets the segment_range_end_index of this CreateMediaAssetDetails. + The end index for video segment files. + + + :return: The segment_range_end_index of this CreateMediaAssetDetails. + :rtype: int + """ + return self._segment_range_end_index + + @segment_range_end_index.setter + def segment_range_end_index(self, segment_range_end_index): + """ + Sets the segment_range_end_index of this CreateMediaAssetDetails. + The end index for video segment files. + + + :param segment_range_end_index: The segment_range_end_index of this CreateMediaAssetDetails. + :type: int + """ + self._segment_range_end_index = segment_range_end_index + + @property + def media_asset_tags(self): + """ + Gets the media_asset_tags of this CreateMediaAssetDetails. + list of tags for the MediaAsset. + + + :return: The media_asset_tags of this CreateMediaAssetDetails. + :rtype: list[oci.media_services.models.MediaAssetTag] + """ + return self._media_asset_tags + + @media_asset_tags.setter + def media_asset_tags(self, media_asset_tags): + """ + Sets the media_asset_tags of this CreateMediaAssetDetails. + list of tags for the MediaAsset. + + + :param media_asset_tags: The media_asset_tags of this CreateMediaAssetDetails. + :type: list[oci.media_services.models.MediaAssetTag] + """ + self._media_asset_tags = media_asset_tags + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this CreateMediaAssetDetails. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :return: The freeform_tags of this CreateMediaAssetDetails. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this CreateMediaAssetDetails. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :param freeform_tags: The freeform_tags of this CreateMediaAssetDetails. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this CreateMediaAssetDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this CreateMediaAssetDetails. + :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 CreateMediaAssetDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this CreateMediaAssetDetails. + :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/media_services/models/create_media_workflow_configuration_details.py b/src/oci/media_services/models/create_media_workflow_configuration_details.py new file mode 100644 index 0000000000..561716caca --- /dev/null +++ b/src/oci/media_services/models/create_media_workflow_configuration_details.py @@ -0,0 +1,204 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 CreateMediaWorkflowConfigurationDetails(object): + """ + The information needed to create a new MediaWorkflowConfiguration. + """ + + def __init__(self, **kwargs): + """ + Initializes a new CreateMediaWorkflowConfigurationDetails 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 CreateMediaWorkflowConfigurationDetails. + :type display_name: str + + :param parameters: + The value to assign to the parameters property of this CreateMediaWorkflowConfigurationDetails. + :type parameters: dict(str, str) + + :param compartment_id: + The value to assign to the compartment_id property of this CreateMediaWorkflowConfigurationDetails. + :type compartment_id: str + + :param freeform_tags: + The value to assign to the freeform_tags property of this CreateMediaWorkflowConfigurationDetails. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this CreateMediaWorkflowConfigurationDetails. + :type defined_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'display_name': 'str', + 'parameters': 'dict(str, str)', + 'compartment_id': 'str', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))' + } + + self.attribute_map = { + 'display_name': 'displayName', + 'parameters': 'parameters', + 'compartment_id': 'compartmentId', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags' + } + + self._display_name = None + self._parameters = None + self._compartment_id = None + self._freeform_tags = None + self._defined_tags = None + + @property + def display_name(self): + """ + **[Required]** Gets the display_name of this CreateMediaWorkflowConfigurationDetails. + MediaWorkflowConfiguration identifier. + + + :return: The display_name of this CreateMediaWorkflowConfigurationDetails. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this CreateMediaWorkflowConfigurationDetails. + MediaWorkflowConfiguration identifier. + + + :param display_name: The display_name of this CreateMediaWorkflowConfigurationDetails. + :type: str + """ + self._display_name = display_name + + @property + def parameters(self): + """ + **[Required]** Gets the parameters of this CreateMediaWorkflowConfigurationDetails. + Reuseable parameter values encoded as a JSON; the top and second level JSON elements are + objects. Each key of the top level object refers to a task key that is unqiue to the + workflow, each of the second level objects' keys refer to the name of a parameter that is + unique to the task. taskKey -> parameterName -> parameterValue + + + :return: The parameters of this CreateMediaWorkflowConfigurationDetails. + :rtype: dict(str, str) + """ + return self._parameters + + @parameters.setter + def parameters(self, parameters): + """ + Sets the parameters of this CreateMediaWorkflowConfigurationDetails. + Reuseable parameter values encoded as a JSON; the top and second level JSON elements are + objects. Each key of the top level object refers to a task key that is unqiue to the + workflow, each of the second level objects' keys refer to the name of a parameter that is + unique to the task. taskKey -> parameterName -> parameterValue + + + :param parameters: The parameters of this CreateMediaWorkflowConfigurationDetails. + :type: dict(str, str) + """ + self._parameters = parameters + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this CreateMediaWorkflowConfigurationDetails. + Compartment Identifier. + + + :return: The compartment_id of this CreateMediaWorkflowConfigurationDetails. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this CreateMediaWorkflowConfigurationDetails. + Compartment Identifier. + + + :param compartment_id: The compartment_id of this CreateMediaWorkflowConfigurationDetails. + :type: str + """ + self._compartment_id = compartment_id + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this CreateMediaWorkflowConfigurationDetails. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :return: The freeform_tags of this CreateMediaWorkflowConfigurationDetails. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this CreateMediaWorkflowConfigurationDetails. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :param freeform_tags: The freeform_tags of this CreateMediaWorkflowConfigurationDetails. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this CreateMediaWorkflowConfigurationDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this CreateMediaWorkflowConfigurationDetails. + :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 CreateMediaWorkflowConfigurationDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this CreateMediaWorkflowConfigurationDetails. + :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/media_services/models/create_media_workflow_details.py b/src/oci/media_services/models/create_media_workflow_details.py new file mode 100644 index 0000000000..482b929f97 --- /dev/null +++ b/src/oci/media_services/models/create_media_workflow_details.py @@ -0,0 +1,270 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 CreateMediaWorkflowDetails(object): + """ + The information about new MediaWorkflow. + """ + + def __init__(self, **kwargs): + """ + Initializes a new CreateMediaWorkflowDetails 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 CreateMediaWorkflowDetails. + :type display_name: str + + :param compartment_id: + The value to assign to the compartment_id property of this CreateMediaWorkflowDetails. + :type compartment_id: str + + :param tasks: + The value to assign to the tasks property of this CreateMediaWorkflowDetails. + :type tasks: list[oci.media_services.models.MediaWorkflowTask] + + :param media_workflow_configuration_ids: + The value to assign to the media_workflow_configuration_ids property of this CreateMediaWorkflowDetails. + :type media_workflow_configuration_ids: list[str] + + :param parameters: + The value to assign to the parameters property of this CreateMediaWorkflowDetails. + :type parameters: dict(str, str) + + :param freeform_tags: + The value to assign to the freeform_tags property of this CreateMediaWorkflowDetails. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this CreateMediaWorkflowDetails. + :type defined_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'display_name': 'str', + 'compartment_id': 'str', + 'tasks': 'list[MediaWorkflowTask]', + 'media_workflow_configuration_ids': 'list[str]', + 'parameters': 'dict(str, str)', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))' + } + + self.attribute_map = { + 'display_name': 'displayName', + 'compartment_id': 'compartmentId', + 'tasks': 'tasks', + 'media_workflow_configuration_ids': 'mediaWorkflowConfigurationIds', + 'parameters': 'parameters', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags' + } + + self._display_name = None + self._compartment_id = None + self._tasks = None + self._media_workflow_configuration_ids = None + self._parameters = None + self._freeform_tags = None + self._defined_tags = None + + @property + def display_name(self): + """ + **[Required]** Gets the display_name of this CreateMediaWorkflowDetails. + Name for the MediaWorkflow. Does not have to be unique, and it's changeable. Avoid entering confidential information. + + + :return: The display_name of this CreateMediaWorkflowDetails. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this CreateMediaWorkflowDetails. + Name for the MediaWorkflow. Does not have to be unique, and it's changeable. Avoid entering confidential information. + + + :param display_name: The display_name of this CreateMediaWorkflowDetails. + :type: str + """ + self._display_name = display_name + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this CreateMediaWorkflowDetails. + Compartment Identifier. + + + :return: The compartment_id of this CreateMediaWorkflowDetails. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this CreateMediaWorkflowDetails. + Compartment Identifier. + + + :param compartment_id: The compartment_id of this CreateMediaWorkflowDetails. + :type: str + """ + self._compartment_id = compartment_id + + @property + def tasks(self): + """ + Gets the tasks of this CreateMediaWorkflowDetails. + The processing to be done in this workflow. Each key of the MediaWorkflowTasks in this array must be unique + within the array. The order of tasks given here will be preserved. + + + :return: The tasks of this CreateMediaWorkflowDetails. + :rtype: list[oci.media_services.models.MediaWorkflowTask] + """ + return self._tasks + + @tasks.setter + def tasks(self, tasks): + """ + Sets the tasks of this CreateMediaWorkflowDetails. + The processing to be done in this workflow. Each key of the MediaWorkflowTasks in this array must be unique + within the array. The order of tasks given here will be preserved. + + + :param tasks: The tasks of this CreateMediaWorkflowDetails. + :type: list[oci.media_services.models.MediaWorkflowTask] + """ + self._tasks = tasks + + @property + def media_workflow_configuration_ids(self): + """ + Gets the media_workflow_configuration_ids of this CreateMediaWorkflowDetails. + Configurations to be applied to all the jobs for this workflow. Parameters in these configurations are + overridden by parameters in the MediaWorkflowConfigurations of the MediaWorkflowJob and the + parameters of the MediaWorkflowJob. + + + :return: The media_workflow_configuration_ids of this CreateMediaWorkflowDetails. + :rtype: list[str] + """ + return self._media_workflow_configuration_ids + + @media_workflow_configuration_ids.setter + def media_workflow_configuration_ids(self, media_workflow_configuration_ids): + """ + Sets the media_workflow_configuration_ids of this CreateMediaWorkflowDetails. + Configurations to be applied to all the jobs for this workflow. Parameters in these configurations are + overridden by parameters in the MediaWorkflowConfigurations of the MediaWorkflowJob and the + parameters of the MediaWorkflowJob. + + + :param media_workflow_configuration_ids: The media_workflow_configuration_ids of this CreateMediaWorkflowDetails. + :type: list[str] + """ + self._media_workflow_configuration_ids = media_workflow_configuration_ids + + @property + def parameters(self): + """ + Gets the parameters of this CreateMediaWorkflowDetails. + JSON object representing named parameters and their default values that can be referenced throughout this workflow. + The values declared here can be overridden by the MediaWorkflowConfigurations or parameters supplied when creating + MediaWorkflowJobs from this MediaWorkflow. + + + :return: The parameters of this CreateMediaWorkflowDetails. + :rtype: dict(str, str) + """ + return self._parameters + + @parameters.setter + def parameters(self, parameters): + """ + Sets the parameters of this CreateMediaWorkflowDetails. + JSON object representing named parameters and their default values that can be referenced throughout this workflow. + The values declared here can be overridden by the MediaWorkflowConfigurations or parameters supplied when creating + MediaWorkflowJobs from this MediaWorkflow. + + + :param parameters: The parameters of this CreateMediaWorkflowDetails. + :type: dict(str, str) + """ + self._parameters = parameters + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this CreateMediaWorkflowDetails. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :return: The freeform_tags of this CreateMediaWorkflowDetails. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this CreateMediaWorkflowDetails. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :param freeform_tags: The freeform_tags of this CreateMediaWorkflowDetails. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this CreateMediaWorkflowDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this CreateMediaWorkflowDetails. + :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 CreateMediaWorkflowDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this CreateMediaWorkflowDetails. + :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/media_services/models/create_media_workflow_job_by_id_details.py b/src/oci/media_services/models/create_media_workflow_job_by_id_details.py new file mode 100644 index 0000000000..8a747f6029 --- /dev/null +++ b/src/oci/media_services/models/create_media_workflow_job_by_id_details.py @@ -0,0 +1,122 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .create_media_workflow_job_details import CreateMediaWorkflowJobDetails +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 CreateMediaWorkflowJobByIdDetails(CreateMediaWorkflowJobDetails): + """ + Information to run a MediaWorkflow identified by its OCID. + """ + + def __init__(self, **kwargs): + """ + Initializes a new CreateMediaWorkflowJobByIdDetails object with values from keyword arguments. The default value of the :py:attr:`~oci.media_services.models.CreateMediaWorkflowJobByIdDetails.workflow_identifier_type` attribute + of this class is ``ID`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param workflow_identifier_type: + The value to assign to the workflow_identifier_type property of this CreateMediaWorkflowJobByIdDetails. + Allowed values for this property are: "ID", "NAME" + :type workflow_identifier_type: str + + :param media_workflow_configuration_ids: + The value to assign to the media_workflow_configuration_ids property of this CreateMediaWorkflowJobByIdDetails. + :type media_workflow_configuration_ids: list[str] + + :param compartment_id: + The value to assign to the compartment_id property of this CreateMediaWorkflowJobByIdDetails. + :type compartment_id: str + + :param display_name: + The value to assign to the display_name property of this CreateMediaWorkflowJobByIdDetails. + :type display_name: str + + :param parameters: + The value to assign to the parameters property of this CreateMediaWorkflowJobByIdDetails. + :type parameters: dict(str, str) + + :param freeform_tags: + The value to assign to the freeform_tags property of this CreateMediaWorkflowJobByIdDetails. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this CreateMediaWorkflowJobByIdDetails. + :type defined_tags: dict(str, dict(str, object)) + + :param media_workflow_id: + The value to assign to the media_workflow_id property of this CreateMediaWorkflowJobByIdDetails. + :type media_workflow_id: str + + """ + self.swagger_types = { + 'workflow_identifier_type': 'str', + 'media_workflow_configuration_ids': 'list[str]', + 'compartment_id': 'str', + 'display_name': 'str', + 'parameters': 'dict(str, str)', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))', + 'media_workflow_id': 'str' + } + + self.attribute_map = { + 'workflow_identifier_type': 'workflowIdentifierType', + 'media_workflow_configuration_ids': 'mediaWorkflowConfigurationIds', + 'compartment_id': 'compartmentId', + 'display_name': 'displayName', + 'parameters': 'parameters', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags', + 'media_workflow_id': 'mediaWorkflowId' + } + + self._workflow_identifier_type = None + self._media_workflow_configuration_ids = None + self._compartment_id = None + self._display_name = None + self._parameters = None + self._freeform_tags = None + self._defined_tags = None + self._media_workflow_id = None + self._workflow_identifier_type = 'ID' + + @property + def media_workflow_id(self): + """ + Gets the media_workflow_id of this CreateMediaWorkflowJobByIdDetails. + OCID of the MediaWorkflow that should be run. + + + :return: The media_workflow_id of this CreateMediaWorkflowJobByIdDetails. + :rtype: str + """ + return self._media_workflow_id + + @media_workflow_id.setter + def media_workflow_id(self, media_workflow_id): + """ + Sets the media_workflow_id of this CreateMediaWorkflowJobByIdDetails. + OCID of the MediaWorkflow that should be run. + + + :param media_workflow_id: The media_workflow_id of this CreateMediaWorkflowJobByIdDetails. + :type: str + """ + self._media_workflow_id = media_workflow_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/media_services/models/create_media_workflow_job_by_name_details.py b/src/oci/media_services/models/create_media_workflow_job_by_name_details.py new file mode 100644 index 0000000000..03eb4bc778 --- /dev/null +++ b/src/oci/media_services/models/create_media_workflow_job_by_name_details.py @@ -0,0 +1,122 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .create_media_workflow_job_details import CreateMediaWorkflowJobDetails +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 CreateMediaWorkflowJobByNameDetails(CreateMediaWorkflowJobDetails): + """ + Information to run a system MediaWorkflow identified by its name. + """ + + def __init__(self, **kwargs): + """ + Initializes a new CreateMediaWorkflowJobByNameDetails object with values from keyword arguments. The default value of the :py:attr:`~oci.media_services.models.CreateMediaWorkflowJobByNameDetails.workflow_identifier_type` attribute + of this class is ``NAME`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param workflow_identifier_type: + The value to assign to the workflow_identifier_type property of this CreateMediaWorkflowJobByNameDetails. + Allowed values for this property are: "ID", "NAME" + :type workflow_identifier_type: str + + :param media_workflow_configuration_ids: + The value to assign to the media_workflow_configuration_ids property of this CreateMediaWorkflowJobByNameDetails. + :type media_workflow_configuration_ids: list[str] + + :param compartment_id: + The value to assign to the compartment_id property of this CreateMediaWorkflowJobByNameDetails. + :type compartment_id: str + + :param display_name: + The value to assign to the display_name property of this CreateMediaWorkflowJobByNameDetails. + :type display_name: str + + :param parameters: + The value to assign to the parameters property of this CreateMediaWorkflowJobByNameDetails. + :type parameters: dict(str, str) + + :param freeform_tags: + The value to assign to the freeform_tags property of this CreateMediaWorkflowJobByNameDetails. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this CreateMediaWorkflowJobByNameDetails. + :type defined_tags: dict(str, dict(str, object)) + + :param media_workflow_name: + The value to assign to the media_workflow_name property of this CreateMediaWorkflowJobByNameDetails. + :type media_workflow_name: str + + """ + self.swagger_types = { + 'workflow_identifier_type': 'str', + 'media_workflow_configuration_ids': 'list[str]', + 'compartment_id': 'str', + 'display_name': 'str', + 'parameters': 'dict(str, str)', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))', + 'media_workflow_name': 'str' + } + + self.attribute_map = { + 'workflow_identifier_type': 'workflowIdentifierType', + 'media_workflow_configuration_ids': 'mediaWorkflowConfigurationIds', + 'compartment_id': 'compartmentId', + 'display_name': 'displayName', + 'parameters': 'parameters', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags', + 'media_workflow_name': 'mediaWorkflowName' + } + + self._workflow_identifier_type = None + self._media_workflow_configuration_ids = None + self._compartment_id = None + self._display_name = None + self._parameters = None + self._freeform_tags = None + self._defined_tags = None + self._media_workflow_name = None + self._workflow_identifier_type = 'NAME' + + @property + def media_workflow_name(self): + """ + Gets the media_workflow_name of this CreateMediaWorkflowJobByNameDetails. + Name of the system MediaWorkflow that should be run. + + + :return: The media_workflow_name of this CreateMediaWorkflowJobByNameDetails. + :rtype: str + """ + return self._media_workflow_name + + @media_workflow_name.setter + def media_workflow_name(self, media_workflow_name): + """ + Sets the media_workflow_name of this CreateMediaWorkflowJobByNameDetails. + Name of the system MediaWorkflow that should be run. + + + :param media_workflow_name: The media_workflow_name of this CreateMediaWorkflowJobByNameDetails. + :type: str + """ + self._media_workflow_name = media_workflow_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/media_services/models/create_media_workflow_job_details.py b/src/oci/media_services/models/create_media_workflow_job_details.py new file mode 100644 index 0000000000..e961c325d0 --- /dev/null +++ b/src/oci/media_services/models/create_media_workflow_job_details.py @@ -0,0 +1,306 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 CreateMediaWorkflowJobDetails(object): + """ + Information to run the MediaWorkflow. + """ + + #: A constant which can be used with the workflow_identifier_type property of a CreateMediaWorkflowJobDetails. + #: This constant has a value of "ID" + WORKFLOW_IDENTIFIER_TYPE_ID = "ID" + + #: A constant which can be used with the workflow_identifier_type property of a CreateMediaWorkflowJobDetails. + #: This constant has a value of "NAME" + WORKFLOW_IDENTIFIER_TYPE_NAME = "NAME" + + def __init__(self, **kwargs): + """ + Initializes a new CreateMediaWorkflowJobDetails 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.media_services.models.CreateMediaWorkflowJobByNameDetails` + * :class:`~oci.media_services.models.CreateMediaWorkflowJobByIdDetails` + + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param workflow_identifier_type: + The value to assign to the workflow_identifier_type property of this CreateMediaWorkflowJobDetails. + Allowed values for this property are: "ID", "NAME" + :type workflow_identifier_type: str + + :param media_workflow_configuration_ids: + The value to assign to the media_workflow_configuration_ids property of this CreateMediaWorkflowJobDetails. + :type media_workflow_configuration_ids: list[str] + + :param compartment_id: + The value to assign to the compartment_id property of this CreateMediaWorkflowJobDetails. + :type compartment_id: str + + :param display_name: + The value to assign to the display_name property of this CreateMediaWorkflowJobDetails. + :type display_name: str + + :param parameters: + The value to assign to the parameters property of this CreateMediaWorkflowJobDetails. + :type parameters: dict(str, str) + + :param freeform_tags: + The value to assign to the freeform_tags property of this CreateMediaWorkflowJobDetails. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this CreateMediaWorkflowJobDetails. + :type defined_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'workflow_identifier_type': 'str', + 'media_workflow_configuration_ids': 'list[str]', + 'compartment_id': 'str', + 'display_name': 'str', + 'parameters': 'dict(str, str)', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))' + } + + self.attribute_map = { + 'workflow_identifier_type': 'workflowIdentifierType', + 'media_workflow_configuration_ids': 'mediaWorkflowConfigurationIds', + 'compartment_id': 'compartmentId', + 'display_name': 'displayName', + 'parameters': 'parameters', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags' + } + + self._workflow_identifier_type = None + self._media_workflow_configuration_ids = None + self._compartment_id = None + self._display_name = None + self._parameters = None + self._freeform_tags = None + self._defined_tags = None + + @staticmethod + def get_subtype(object_dictionary): + """ + Given the hash representation of a subtype of this class, + use the info in the hash to return the class of the subtype. + """ + type = object_dictionary['workflowIdentifierType'] + + if type == 'NAME': + return 'CreateMediaWorkflowJobByNameDetails' + + if type == 'ID': + return 'CreateMediaWorkflowJobByIdDetails' + else: + return 'CreateMediaWorkflowJobDetails' + + @property + def workflow_identifier_type(self): + """ + **[Required]** Gets the workflow_identifier_type of this CreateMediaWorkflowJobDetails. + Discriminate identification of a workflow by name versus a workflow by ID. + + Allowed values for this property are: "ID", "NAME" + + + :return: The workflow_identifier_type of this CreateMediaWorkflowJobDetails. + :rtype: str + """ + return self._workflow_identifier_type + + @workflow_identifier_type.setter + def workflow_identifier_type(self, workflow_identifier_type): + """ + Sets the workflow_identifier_type of this CreateMediaWorkflowJobDetails. + Discriminate identification of a workflow by name versus a workflow by ID. + + + :param workflow_identifier_type: The workflow_identifier_type of this CreateMediaWorkflowJobDetails. + :type: str + """ + allowed_values = ["ID", "NAME"] + if not value_allowed_none_or_none_sentinel(workflow_identifier_type, allowed_values): + raise ValueError( + "Invalid value for `workflow_identifier_type`, must be None or one of {0}" + .format(allowed_values) + ) + self._workflow_identifier_type = workflow_identifier_type + + @property + def media_workflow_configuration_ids(self): + """ + Gets the media_workflow_configuration_ids of this CreateMediaWorkflowJobDetails. + Configurations to be applied to this run of the workflow. + + + :return: The media_workflow_configuration_ids of this CreateMediaWorkflowJobDetails. + :rtype: list[str] + """ + return self._media_workflow_configuration_ids + + @media_workflow_configuration_ids.setter + def media_workflow_configuration_ids(self, media_workflow_configuration_ids): + """ + Sets the media_workflow_configuration_ids of this CreateMediaWorkflowJobDetails. + Configurations to be applied to this run of the workflow. + + + :param media_workflow_configuration_ids: The media_workflow_configuration_ids of this CreateMediaWorkflowJobDetails. + :type: list[str] + """ + self._media_workflow_configuration_ids = media_workflow_configuration_ids + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this CreateMediaWorkflowJobDetails. + ID of the compartment in which the job should be created. + + + :return: The compartment_id of this CreateMediaWorkflowJobDetails. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this CreateMediaWorkflowJobDetails. + ID of the compartment in which the job should be created. + + + :param compartment_id: The compartment_id of this CreateMediaWorkflowJobDetails. + :type: str + """ + self._compartment_id = compartment_id + + @property + def display_name(self): + """ + Gets the display_name of this CreateMediaWorkflowJobDetails. + Name of the Media Workflow Job. Does not have to be unique. Avoid entering confidential information. + + + :return: The display_name of this CreateMediaWorkflowJobDetails. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this CreateMediaWorkflowJobDetails. + Name of the Media Workflow Job. Does not have to be unique. Avoid entering confidential information. + + + :param display_name: The display_name of this CreateMediaWorkflowJobDetails. + :type: str + """ + self._display_name = display_name + + @property + def parameters(self): + """ + Gets the parameters of this CreateMediaWorkflowJobDetails. + Parameters that override parameters specified in MediaWorkflowTaskDeclarations, the MediaWorkflow, + the MediaWorkflow's MediaWorkflowConfigurations and the MediaWorkflowConfigurations of this + MediaWorkflowJob. The parameters are given as JSON. The top level and 2nd level elements must be + JSON objects (vs arrays, scalars, etc). The top level keys refer to a task's key and the 2nd level + keys refer to a parameter's name. + + + :return: The parameters of this CreateMediaWorkflowJobDetails. + :rtype: dict(str, str) + """ + return self._parameters + + @parameters.setter + def parameters(self, parameters): + """ + Sets the parameters of this CreateMediaWorkflowJobDetails. + Parameters that override parameters specified in MediaWorkflowTaskDeclarations, the MediaWorkflow, + the MediaWorkflow's MediaWorkflowConfigurations and the MediaWorkflowConfigurations of this + MediaWorkflowJob. The parameters are given as JSON. The top level and 2nd level elements must be + JSON objects (vs arrays, scalars, etc). The top level keys refer to a task's key and the 2nd level + keys refer to a parameter's name. + + + :param parameters: The parameters of this CreateMediaWorkflowJobDetails. + :type: dict(str, str) + """ + self._parameters = parameters + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this CreateMediaWorkflowJobDetails. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :return: The freeform_tags of this CreateMediaWorkflowJobDetails. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this CreateMediaWorkflowJobDetails. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :param freeform_tags: The freeform_tags of this CreateMediaWorkflowJobDetails. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this CreateMediaWorkflowJobDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this CreateMediaWorkflowJobDetails. + :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 CreateMediaWorkflowJobDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this CreateMediaWorkflowJobDetails. + :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/media_services/models/create_stream_cdn_config_details.py b/src/oci/media_services/models/create_stream_cdn_config_details.py new file mode 100644 index 0000000000..06488c9f6a --- /dev/null +++ b/src/oci/media_services/models/create_stream_cdn_config_details.py @@ -0,0 +1,225 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 CreateStreamCdnConfigDetails(object): + """ + The information about the new CDN Configuration. + """ + + def __init__(self, **kwargs): + """ + Initializes a new CreateStreamCdnConfigDetails 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 CreateStreamCdnConfigDetails. + :type display_name: str + + :param distribution_channel_id: + The value to assign to the distribution_channel_id property of this CreateStreamCdnConfigDetails. + :type distribution_channel_id: str + + :param is_enabled: + The value to assign to the is_enabled property of this CreateStreamCdnConfigDetails. + :type is_enabled: bool + + :param config: + The value to assign to the config property of this CreateStreamCdnConfigDetails. + :type config: oci.media_services.models.StreamCdnConfigSection + + :param freeform_tags: + The value to assign to the freeform_tags property of this CreateStreamCdnConfigDetails. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this CreateStreamCdnConfigDetails. + :type defined_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'display_name': 'str', + 'distribution_channel_id': 'str', + 'is_enabled': 'bool', + 'config': 'StreamCdnConfigSection', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))' + } + + self.attribute_map = { + 'display_name': 'displayName', + 'distribution_channel_id': 'distributionChannelId', + 'is_enabled': 'isEnabled', + 'config': 'config', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags' + } + + self._display_name = None + self._distribution_channel_id = None + self._is_enabled = None + self._config = None + self._freeform_tags = None + self._defined_tags = None + + @property + def display_name(self): + """ + **[Required]** Gets the display_name of this CreateStreamCdnConfigDetails. + CDN Config display name, which can be renamed and is not necessarily unique. Avoid entering confidential information. + + + :return: The display_name of this CreateStreamCdnConfigDetails. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this CreateStreamCdnConfigDetails. + CDN Config display name, which can be renamed and is not necessarily unique. Avoid entering confidential information. + + + :param display_name: The display_name of this CreateStreamCdnConfigDetails. + :type: str + """ + self._display_name = display_name + + @property + def distribution_channel_id(self): + """ + **[Required]** Gets the distribution_channel_id of this CreateStreamCdnConfigDetails. + Distribution Channel Identifier. + + + :return: The distribution_channel_id of this CreateStreamCdnConfigDetails. + :rtype: str + """ + return self._distribution_channel_id + + @distribution_channel_id.setter + def distribution_channel_id(self, distribution_channel_id): + """ + Sets the distribution_channel_id of this CreateStreamCdnConfigDetails. + Distribution Channel Identifier. + + + :param distribution_channel_id: The distribution_channel_id of this CreateStreamCdnConfigDetails. + :type: str + """ + self._distribution_channel_id = distribution_channel_id + + @property + def is_enabled(self): + """ + Gets the is_enabled of this CreateStreamCdnConfigDetails. + Whether publishing to CDN is enabled. + + + :return: The is_enabled of this CreateStreamCdnConfigDetails. + :rtype: bool + """ + return self._is_enabled + + @is_enabled.setter + def is_enabled(self, is_enabled): + """ + Sets the is_enabled of this CreateStreamCdnConfigDetails. + Whether publishing to CDN is enabled. + + + :param is_enabled: The is_enabled of this CreateStreamCdnConfigDetails. + :type: bool + """ + self._is_enabled = is_enabled + + @property + def config(self): + """ + **[Required]** Gets the config of this CreateStreamCdnConfigDetails. + + :return: The config of this CreateStreamCdnConfigDetails. + :rtype: oci.media_services.models.StreamCdnConfigSection + """ + return self._config + + @config.setter + def config(self, config): + """ + Sets the config of this CreateStreamCdnConfigDetails. + + :param config: The config of this CreateStreamCdnConfigDetails. + :type: oci.media_services.models.StreamCdnConfigSection + """ + self._config = config + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this CreateStreamCdnConfigDetails. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :return: The freeform_tags of this CreateStreamCdnConfigDetails. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this CreateStreamCdnConfigDetails. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :param freeform_tags: The freeform_tags of this CreateStreamCdnConfigDetails. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this CreateStreamCdnConfigDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this CreateStreamCdnConfigDetails. + :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 CreateStreamCdnConfigDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this CreateStreamCdnConfigDetails. + :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/media_services/models/create_stream_distribution_channel_details.py b/src/oci/media_services/models/create_stream_distribution_channel_details.py new file mode 100644 index 0000000000..dce3a494be --- /dev/null +++ b/src/oci/media_services/models/create_stream_distribution_channel_details.py @@ -0,0 +1,167 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 CreateStreamDistributionChannelDetails(object): + """ + The information about the new Stream Distribution Channel. + """ + + def __init__(self, **kwargs): + """ + Initializes a new CreateStreamDistributionChannelDetails 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 CreateStreamDistributionChannelDetails. + :type display_name: str + + :param compartment_id: + The value to assign to the compartment_id property of this CreateStreamDistributionChannelDetails. + :type compartment_id: str + + :param freeform_tags: + The value to assign to the freeform_tags property of this CreateStreamDistributionChannelDetails. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this CreateStreamDistributionChannelDetails. + :type defined_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'display_name': 'str', + 'compartment_id': 'str', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))' + } + + self.attribute_map = { + 'display_name': 'displayName', + 'compartment_id': 'compartmentId', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags' + } + + self._display_name = None + self._compartment_id = None + self._freeform_tags = None + self._defined_tags = None + + @property + def display_name(self): + """ + **[Required]** Gets the display_name of this CreateStreamDistributionChannelDetails. + Stream Distribution Channel display name. + + + :return: The display_name of this CreateStreamDistributionChannelDetails. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this CreateStreamDistributionChannelDetails. + Stream Distribution Channel display name. + + + :param display_name: The display_name of this CreateStreamDistributionChannelDetails. + :type: str + """ + self._display_name = display_name + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this CreateStreamDistributionChannelDetails. + Compartment Identifier. + + + :return: The compartment_id of this CreateStreamDistributionChannelDetails. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this CreateStreamDistributionChannelDetails. + Compartment Identifier. + + + :param compartment_id: The compartment_id of this CreateStreamDistributionChannelDetails. + :type: str + """ + self._compartment_id = compartment_id + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this CreateStreamDistributionChannelDetails. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :return: The freeform_tags of this CreateStreamDistributionChannelDetails. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this CreateStreamDistributionChannelDetails. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :param freeform_tags: The freeform_tags of this CreateStreamDistributionChannelDetails. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this CreateStreamDistributionChannelDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this CreateStreamDistributionChannelDetails. + :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 CreateStreamDistributionChannelDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this CreateStreamDistributionChannelDetails. + :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/media_services/models/create_stream_packaging_config_details.py b/src/oci/media_services/models/create_stream_packaging_config_details.py new file mode 100644 index 0000000000..71b0dc2412 --- /dev/null +++ b/src/oci/media_services/models/create_stream_packaging_config_details.py @@ -0,0 +1,273 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 CreateStreamPackagingConfigDetails(object): + """ + The information about the new Packaging Configuration. + """ + + #: A constant which can be used with the stream_packaging_format property of a CreateStreamPackagingConfigDetails. + #: This constant has a value of "HLS" + STREAM_PACKAGING_FORMAT_HLS = "HLS" + + #: A constant which can be used with the stream_packaging_format property of a CreateStreamPackagingConfigDetails. + #: This constant has a value of "DASH" + STREAM_PACKAGING_FORMAT_DASH = "DASH" + + def __init__(self, **kwargs): + """ + Initializes a new CreateStreamPackagingConfigDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param distribution_channel_id: + The value to assign to the distribution_channel_id property of this CreateStreamPackagingConfigDetails. + :type distribution_channel_id: str + + :param display_name: + The value to assign to the display_name property of this CreateStreamPackagingConfigDetails. + :type display_name: str + + :param stream_packaging_format: + The value to assign to the stream_packaging_format property of this CreateStreamPackagingConfigDetails. + Allowed values for this property are: "HLS", "DASH" + :type stream_packaging_format: str + + :param segment_time_in_seconds: + The value to assign to the segment_time_in_seconds property of this CreateStreamPackagingConfigDetails. + :type segment_time_in_seconds: int + + :param encryption: + The value to assign to the encryption property of this CreateStreamPackagingConfigDetails. + :type encryption: oci.media_services.models.StreamPackagingConfigEncryption + + :param freeform_tags: + The value to assign to the freeform_tags property of this CreateStreamPackagingConfigDetails. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this CreateStreamPackagingConfigDetails. + :type defined_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'distribution_channel_id': 'str', + 'display_name': 'str', + 'stream_packaging_format': 'str', + 'segment_time_in_seconds': 'int', + 'encryption': 'StreamPackagingConfigEncryption', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))' + } + + self.attribute_map = { + 'distribution_channel_id': 'distributionChannelId', + 'display_name': 'displayName', + 'stream_packaging_format': 'streamPackagingFormat', + 'segment_time_in_seconds': 'segmentTimeInSeconds', + 'encryption': 'encryption', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags' + } + + self._distribution_channel_id = None + self._display_name = None + self._stream_packaging_format = None + self._segment_time_in_seconds = None + self._encryption = None + self._freeform_tags = None + self._defined_tags = None + + @property + def distribution_channel_id(self): + """ + **[Required]** Gets the distribution_channel_id of this CreateStreamPackagingConfigDetails. + Unique identifier of the Distribution Channel that this stream packaging configuration belongs to. + + + :return: The distribution_channel_id of this CreateStreamPackagingConfigDetails. + :rtype: str + """ + return self._distribution_channel_id + + @distribution_channel_id.setter + def distribution_channel_id(self, distribution_channel_id): + """ + Sets the distribution_channel_id of this CreateStreamPackagingConfigDetails. + Unique identifier of the Distribution Channel that this stream packaging configuration belongs to. + + + :param distribution_channel_id: The distribution_channel_id of this CreateStreamPackagingConfigDetails. + :type: str + """ + self._distribution_channel_id = distribution_channel_id + + @property + def display_name(self): + """ + **[Required]** Gets the display_name of this CreateStreamPackagingConfigDetails. + The name of the stream Packaging Configuration. + + + :return: The display_name of this CreateStreamPackagingConfigDetails. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this CreateStreamPackagingConfigDetails. + The name of the stream Packaging Configuration. + + + :param display_name: The display_name of this CreateStreamPackagingConfigDetails. + :type: str + """ + self._display_name = display_name + + @property + def stream_packaging_format(self): + """ + **[Required]** Gets the stream_packaging_format of this CreateStreamPackagingConfigDetails. + The output format for the package. + + Allowed values for this property are: "HLS", "DASH" + + + :return: The stream_packaging_format of this CreateStreamPackagingConfigDetails. + :rtype: str + """ + return self._stream_packaging_format + + @stream_packaging_format.setter + def stream_packaging_format(self, stream_packaging_format): + """ + Sets the stream_packaging_format of this CreateStreamPackagingConfigDetails. + The output format for the package. + + + :param stream_packaging_format: The stream_packaging_format of this CreateStreamPackagingConfigDetails. + :type: str + """ + allowed_values = ["HLS", "DASH"] + if not value_allowed_none_or_none_sentinel(stream_packaging_format, allowed_values): + raise ValueError( + "Invalid value for `stream_packaging_format`, must be None or one of {0}" + .format(allowed_values) + ) + self._stream_packaging_format = stream_packaging_format + + @property + def segment_time_in_seconds(self): + """ + **[Required]** Gets the segment_time_in_seconds of this CreateStreamPackagingConfigDetails. + The duration in seconds for each fragment. + + + :return: The segment_time_in_seconds of this CreateStreamPackagingConfigDetails. + :rtype: int + """ + return self._segment_time_in_seconds + + @segment_time_in_seconds.setter + def segment_time_in_seconds(self, segment_time_in_seconds): + """ + Sets the segment_time_in_seconds of this CreateStreamPackagingConfigDetails. + The duration in seconds for each fragment. + + + :param segment_time_in_seconds: The segment_time_in_seconds of this CreateStreamPackagingConfigDetails. + :type: int + """ + self._segment_time_in_seconds = segment_time_in_seconds + + @property + def encryption(self): + """ + Gets the encryption of this CreateStreamPackagingConfigDetails. + + :return: The encryption of this CreateStreamPackagingConfigDetails. + :rtype: oci.media_services.models.StreamPackagingConfigEncryption + """ + return self._encryption + + @encryption.setter + def encryption(self, encryption): + """ + Sets the encryption of this CreateStreamPackagingConfigDetails. + + :param encryption: The encryption of this CreateStreamPackagingConfigDetails. + :type: oci.media_services.models.StreamPackagingConfigEncryption + """ + self._encryption = encryption + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this CreateStreamPackagingConfigDetails. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :return: The freeform_tags of this CreateStreamPackagingConfigDetails. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this CreateStreamPackagingConfigDetails. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :param freeform_tags: The freeform_tags of this CreateStreamPackagingConfigDetails. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this CreateStreamPackagingConfigDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this CreateStreamPackagingConfigDetails. + :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 CreateStreamPackagingConfigDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this CreateStreamPackagingConfigDetails. + :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/media_services/models/dash_stream_packaging_config.py b/src/oci/media_services/models/dash_stream_packaging_config.py new file mode 100644 index 0000000000..433b5900b2 --- /dev/null +++ b/src/oci/media_services/models/dash_stream_packaging_config.py @@ -0,0 +1,134 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .stream_packaging_config import StreamPackagingConfig +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 DashStreamPackagingConfig(StreamPackagingConfig): + """ + Configuration fields for a DASH Packaging Configuration. + """ + + def __init__(self, **kwargs): + """ + Initializes a new DashStreamPackagingConfig object with values from keyword arguments. The default value of the :py:attr:`~oci.media_services.models.DashStreamPackagingConfig.stream_packaging_format` attribute + of this class is ``DASH`` 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 DashStreamPackagingConfig. + :type id: str + + :param compartment_id: + The value to assign to the compartment_id property of this DashStreamPackagingConfig. + :type compartment_id: str + + :param distribution_channel_id: + The value to assign to the distribution_channel_id property of this DashStreamPackagingConfig. + :type distribution_channel_id: str + + :param display_name: + The value to assign to the display_name property of this DashStreamPackagingConfig. + :type display_name: str + + :param stream_packaging_format: + The value to assign to the stream_packaging_format property of this DashStreamPackagingConfig. + Allowed values for this property are: "HLS", "DASH" + :type stream_packaging_format: str + + :param segment_time_in_seconds: + The value to assign to the segment_time_in_seconds property of this DashStreamPackagingConfig. + :type segment_time_in_seconds: int + + :param encryption: + The value to assign to the encryption property of this DashStreamPackagingConfig. + :type encryption: oci.media_services.models.StreamPackagingConfigEncryption + + :param time_created: + The value to assign to the time_created property of this DashStreamPackagingConfig. + :type time_created: datetime + + :param time_updated: + The value to assign to the time_updated property of this DashStreamPackagingConfig. + :type time_updated: datetime + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this DashStreamPackagingConfig. + Allowed values for this property are: "ACTIVE", "NEEDS_ATTENTION", "DELETED" + :type lifecycle_state: str + + :param freeform_tags: + The value to assign to the freeform_tags property of this DashStreamPackagingConfig. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this DashStreamPackagingConfig. + :type defined_tags: dict(str, dict(str, object)) + + :param system_tags: + The value to assign to the system_tags property of this DashStreamPackagingConfig. + :type system_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'id': 'str', + 'compartment_id': 'str', + 'distribution_channel_id': 'str', + 'display_name': 'str', + 'stream_packaging_format': 'str', + 'segment_time_in_seconds': 'int', + 'encryption': 'StreamPackagingConfigEncryption', + 'time_created': 'datetime', + 'time_updated': 'datetime', + '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', + 'compartment_id': 'compartmentId', + 'distribution_channel_id': 'distributionChannelId', + 'display_name': 'displayName', + 'stream_packaging_format': 'streamPackagingFormat', + 'segment_time_in_seconds': 'segmentTimeInSeconds', + 'encryption': 'encryption', + 'time_created': 'timeCreated', + 'time_updated': 'timeUpdated', + 'lifecycle_state': 'lifecycleState', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags', + 'system_tags': 'systemTags' + } + + self._id = None + self._compartment_id = None + self._distribution_channel_id = None + self._display_name = None + self._stream_packaging_format = None + self._segment_time_in_seconds = None + self._encryption = None + self._time_created = None + self._time_updated = None + self._lifecycle_state = None + self._freeform_tags = None + self._defined_tags = None + self._system_tags = None + self._stream_packaging_format = 'DASH' + + 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/media_services/models/edge_stream_cdn_config.py b/src/oci/media_services/models/edge_stream_cdn_config.py new file mode 100644 index 0000000000..61660e708e --- /dev/null +++ b/src/oci/media_services/models/edge_stream_cdn_config.py @@ -0,0 +1,49 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .stream_cdn_config_section import StreamCdnConfigSection +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 EdgeStreamCdnConfig(StreamCdnConfigSection): + """ + Configuration fields for Edge configuration. + """ + + def __init__(self, **kwargs): + """ + Initializes a new EdgeStreamCdnConfig object with values from keyword arguments. The default value of the :py:attr:`~oci.media_services.models.EdgeStreamCdnConfig.type` attribute + of this class is ``EDGE`` 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 EdgeStreamCdnConfig. + Allowed values for this property are: "EDGE", "AKAMAI_MANUAL" + :type type: str + + """ + self.swagger_types = { + 'type': 'str' + } + + self.attribute_map = { + 'type': 'type' + } + + self._type = None + self._type = 'EDGE' + + 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/media_services/models/hls_stream_packaging_config.py b/src/oci/media_services/models/hls_stream_packaging_config.py new file mode 100644 index 0000000000..1368771deb --- /dev/null +++ b/src/oci/media_services/models/hls_stream_packaging_config.py @@ -0,0 +1,134 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .stream_packaging_config import StreamPackagingConfig +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 HlsStreamPackagingConfig(StreamPackagingConfig): + """ + Configuration fields for a HLS Packaging Configuration. + """ + + def __init__(self, **kwargs): + """ + Initializes a new HlsStreamPackagingConfig object with values from keyword arguments. The default value of the :py:attr:`~oci.media_services.models.HlsStreamPackagingConfig.stream_packaging_format` attribute + of this class is ``HLS`` 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 HlsStreamPackagingConfig. + :type id: str + + :param compartment_id: + The value to assign to the compartment_id property of this HlsStreamPackagingConfig. + :type compartment_id: str + + :param distribution_channel_id: + The value to assign to the distribution_channel_id property of this HlsStreamPackagingConfig. + :type distribution_channel_id: str + + :param display_name: + The value to assign to the display_name property of this HlsStreamPackagingConfig. + :type display_name: str + + :param stream_packaging_format: + The value to assign to the stream_packaging_format property of this HlsStreamPackagingConfig. + Allowed values for this property are: "HLS", "DASH" + :type stream_packaging_format: str + + :param segment_time_in_seconds: + The value to assign to the segment_time_in_seconds property of this HlsStreamPackagingConfig. + :type segment_time_in_seconds: int + + :param encryption: + The value to assign to the encryption property of this HlsStreamPackagingConfig. + :type encryption: oci.media_services.models.StreamPackagingConfigEncryption + + :param time_created: + The value to assign to the time_created property of this HlsStreamPackagingConfig. + :type time_created: datetime + + :param time_updated: + The value to assign to the time_updated property of this HlsStreamPackagingConfig. + :type time_updated: datetime + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this HlsStreamPackagingConfig. + Allowed values for this property are: "ACTIVE", "NEEDS_ATTENTION", "DELETED" + :type lifecycle_state: str + + :param freeform_tags: + The value to assign to the freeform_tags property of this HlsStreamPackagingConfig. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this HlsStreamPackagingConfig. + :type defined_tags: dict(str, dict(str, object)) + + :param system_tags: + The value to assign to the system_tags property of this HlsStreamPackagingConfig. + :type system_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'id': 'str', + 'compartment_id': 'str', + 'distribution_channel_id': 'str', + 'display_name': 'str', + 'stream_packaging_format': 'str', + 'segment_time_in_seconds': 'int', + 'encryption': 'StreamPackagingConfigEncryption', + 'time_created': 'datetime', + 'time_updated': 'datetime', + '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', + 'compartment_id': 'compartmentId', + 'distribution_channel_id': 'distributionChannelId', + 'display_name': 'displayName', + 'stream_packaging_format': 'streamPackagingFormat', + 'segment_time_in_seconds': 'segmentTimeInSeconds', + 'encryption': 'encryption', + 'time_created': 'timeCreated', + 'time_updated': 'timeUpdated', + 'lifecycle_state': 'lifecycleState', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags', + 'system_tags': 'systemTags' + } + + self._id = None + self._compartment_id = None + self._distribution_channel_id = None + self._display_name = None + self._stream_packaging_format = None + self._segment_time_in_seconds = None + self._encryption = None + self._time_created = None + self._time_updated = None + self._lifecycle_state = None + self._freeform_tags = None + self._defined_tags = None + self._system_tags = None + self._stream_packaging_format = 'HLS' + + 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/media_services/models/ingest_stream_distribution_channel_details.py b/src/oci/media_services/models/ingest_stream_distribution_channel_details.py new file mode 100644 index 0000000000..5ba1c9aa65 --- /dev/null +++ b/src/oci/media_services/models/ingest_stream_distribution_channel_details.py @@ -0,0 +1,100 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 IngestStreamDistributionChannelDetails(object): + """ + Ingest Payload Information. + """ + + #: A constant which can be used with the ingest_payload_type property of a IngestStreamDistributionChannelDetails. + #: This constant has a value of "ASSET_METADATA_MEDIA_ASSET" + INGEST_PAYLOAD_TYPE_ASSET_METADATA_MEDIA_ASSET = "ASSET_METADATA_MEDIA_ASSET" + + def __init__(self, **kwargs): + """ + Initializes a new IngestStreamDistributionChannelDetails 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.media_services.models.AssetMetadataEntryDetails` + + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param ingest_payload_type: + The value to assign to the ingest_payload_type property of this IngestStreamDistributionChannelDetails. + Allowed values for this property are: "ASSET_METADATA_MEDIA_ASSET" + :type ingest_payload_type: str + + """ + self.swagger_types = { + 'ingest_payload_type': 'str' + } + + self.attribute_map = { + 'ingest_payload_type': 'ingestPayloadType' + } + + self._ingest_payload_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['ingestPayloadType'] + + if type == 'ASSET_METADATA_MEDIA_ASSET': + return 'AssetMetadataEntryDetails' + else: + return 'IngestStreamDistributionChannelDetails' + + @property + def ingest_payload_type(self): + """ + **[Required]** Gets the ingest_payload_type of this IngestStreamDistributionChannelDetails. + Ingest Payload Type + + Allowed values for this property are: "ASSET_METADATA_MEDIA_ASSET" + + + :return: The ingest_payload_type of this IngestStreamDistributionChannelDetails. + :rtype: str + """ + return self._ingest_payload_type + + @ingest_payload_type.setter + def ingest_payload_type(self, ingest_payload_type): + """ + Sets the ingest_payload_type of this IngestStreamDistributionChannelDetails. + Ingest Payload Type + + + :param ingest_payload_type: The ingest_payload_type of this IngestStreamDistributionChannelDetails. + :type: str + """ + allowed_values = ["ASSET_METADATA_MEDIA_ASSET"] + if not value_allowed_none_or_none_sentinel(ingest_payload_type, allowed_values): + raise ValueError( + "Invalid value for `ingest_payload_type`, must be None or one of {0}" + .format(allowed_values) + ) + self._ingest_payload_type = ingest_payload_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/media_services/models/ingest_stream_distribution_channel_result.py b/src/oci/media_services/models/ingest_stream_distribution_channel_result.py new file mode 100644 index 0000000000..a47c833f70 --- /dev/null +++ b/src/oci/media_services/models/ingest_stream_distribution_channel_result.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 IngestStreamDistributionChannelResult(object): + """ + The Ingest Workflow Job information. + """ + + def __init__(self, **kwargs): + """ + Initializes a new IngestStreamDistributionChannelResult object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param media_workflow_job_id: + The value to assign to the media_workflow_job_id property of this IngestStreamDistributionChannelResult. + :type media_workflow_job_id: str + + """ + self.swagger_types = { + 'media_workflow_job_id': 'str' + } + + self.attribute_map = { + 'media_workflow_job_id': 'mediaWorkflowJobId' + } + + self._media_workflow_job_id = None + + @property + def media_workflow_job_id(self): + """ + **[Required]** Gets the media_workflow_job_id of this IngestStreamDistributionChannelResult. + Identifier of the Ingest Workflow Job created. + + + :return: The media_workflow_job_id of this IngestStreamDistributionChannelResult. + :rtype: str + """ + return self._media_workflow_job_id + + @media_workflow_job_id.setter + def media_workflow_job_id(self, media_workflow_job_id): + """ + Sets the media_workflow_job_id of this IngestStreamDistributionChannelResult. + Identifier of the Ingest Workflow Job created. + + + :param media_workflow_job_id: The media_workflow_job_id of this IngestStreamDistributionChannelResult. + :type: str + """ + self._media_workflow_job_id = media_workflow_job_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/media_services/models/job_output.py b/src/oci/media_services/models/job_output.py new file mode 100644 index 0000000000..4ee8ef7bc8 --- /dev/null +++ b/src/oci/media_services/models/job_output.py @@ -0,0 +1,238 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 JobOutput(object): + """ + The output result of an executed MediaWorkflowJob. + """ + + #: A constant which can be used with the asset_type property of a JobOutput. + #: This constant has a value of "AUDIO" + ASSET_TYPE_AUDIO = "AUDIO" + + #: A constant which can be used with the asset_type property of a JobOutput. + #: This constant has a value of "VIDEO" + ASSET_TYPE_VIDEO = "VIDEO" + + #: A constant which can be used with the asset_type property of a JobOutput. + #: This constant has a value of "PLAYLIST" + ASSET_TYPE_PLAYLIST = "PLAYLIST" + + #: A constant which can be used with the asset_type property of a JobOutput. + #: This constant has a value of "IMAGE" + ASSET_TYPE_IMAGE = "IMAGE" + + #: A constant which can be used with the asset_type property of a JobOutput. + #: This constant has a value of "CAPTION_FILE" + ASSET_TYPE_CAPTION_FILE = "CAPTION_FILE" + + #: A constant which can be used with the asset_type property of a JobOutput. + #: This constant has a value of "TRANSCRIPTION_JOB" + ASSET_TYPE_TRANSCRIPTION_JOB = "TRANSCRIPTION_JOB" + + #: A constant which can be used with the asset_type property of a JobOutput. + #: This constant has a value of "VISION_JOB" + ASSET_TYPE_VISION_JOB = "VISION_JOB" + + #: A constant which can be used with the asset_type property of a JobOutput. + #: This constant has a value of "TEXT_ANALYSIS" + ASSET_TYPE_TEXT_ANALYSIS = "TEXT_ANALYSIS" + + #: A constant which can be used with the asset_type property of a JobOutput. + #: This constant has a value of "OTHER" + ASSET_TYPE_OTHER = "OTHER" + + def __init__(self, **kwargs): + """ + Initializes a new JobOutput object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param asset_type: + The value to assign to the asset_type property of this JobOutput. + Allowed values for this property are: "AUDIO", "VIDEO", "PLAYLIST", "IMAGE", "CAPTION_FILE", "TRANSCRIPTION_JOB", "VISION_JOB", "TEXT_ANALYSIS", "OTHER", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type asset_type: str + + :param namespace_name: + The value to assign to the namespace_name property of this JobOutput. + :type namespace_name: str + + :param bucket_name: + The value to assign to the bucket_name property of this JobOutput. + :type bucket_name: str + + :param object_name: + The value to assign to the object_name property of this JobOutput. + :type object_name: str + + :param id: + The value to assign to the id property of this JobOutput. + :type id: str + + """ + self.swagger_types = { + 'asset_type': 'str', + 'namespace_name': 'str', + 'bucket_name': 'str', + 'object_name': 'str', + 'id': 'str' + } + + self.attribute_map = { + 'asset_type': 'assetType', + 'namespace_name': 'namespaceName', + 'bucket_name': 'bucketName', + 'object_name': 'objectName', + 'id': 'id' + } + + self._asset_type = None + self._namespace_name = None + self._bucket_name = None + self._object_name = None + self._id = None + + @property + def asset_type(self): + """ + Gets the asset_type of this JobOutput. + Type of job output. + + Allowed values for this property are: "AUDIO", "VIDEO", "PLAYLIST", "IMAGE", "CAPTION_FILE", "TRANSCRIPTION_JOB", "VISION_JOB", "TEXT_ANALYSIS", "OTHER", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The asset_type of this JobOutput. + :rtype: str + """ + return self._asset_type + + @asset_type.setter + def asset_type(self, asset_type): + """ + Sets the asset_type of this JobOutput. + Type of job output. + + + :param asset_type: The asset_type of this JobOutput. + :type: str + """ + allowed_values = ["AUDIO", "VIDEO", "PLAYLIST", "IMAGE", "CAPTION_FILE", "TRANSCRIPTION_JOB", "VISION_JOB", "TEXT_ANALYSIS", "OTHER"] + if not value_allowed_none_or_none_sentinel(asset_type, allowed_values): + asset_type = 'UNKNOWN_ENUM_VALUE' + self._asset_type = asset_type + + @property + def namespace_name(self): + """ + Gets the namespace_name of this JobOutput. + The namespace name of the job output. + + + :return: The namespace_name of this JobOutput. + :rtype: str + """ + return self._namespace_name + + @namespace_name.setter + def namespace_name(self, namespace_name): + """ + Sets the namespace_name of this JobOutput. + The namespace name of the job output. + + + :param namespace_name: The namespace_name of this JobOutput. + :type: str + """ + self._namespace_name = namespace_name + + @property + def bucket_name(self): + """ + Gets the bucket_name of this JobOutput. + The bucket name of the job output. + + + :return: The bucket_name of this JobOutput. + :rtype: str + """ + return self._bucket_name + + @bucket_name.setter + def bucket_name(self, bucket_name): + """ + Sets the bucket_name of this JobOutput. + The bucket name of the job output. + + + :param bucket_name: The bucket_name of this JobOutput. + :type: str + """ + self._bucket_name = bucket_name + + @property + def object_name(self): + """ + Gets the object_name of this JobOutput. + The object name of the job output. + + + :return: The object_name of this JobOutput. + :rtype: str + """ + return self._object_name + + @object_name.setter + def object_name(self, object_name): + """ + Sets the object_name of this JobOutput. + The object name of the job output. + + + :param object_name: The object_name of this JobOutput. + :type: str + """ + self._object_name = object_name + + @property + def id(self): + """ + Gets the id of this JobOutput. + The ID associated with the job output. + + + :return: The id of this JobOutput. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this JobOutput. + The ID associated with the job output. + + + :param id: The id of this JobOutput. + :type: str + """ + self._id = 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/media_services/models/media_asset.py b/src/oci/media_services/models/media_asset.py new file mode 100644 index 0000000000..3ad49a75cd --- /dev/null +++ b/src/oci/media_services/models/media_asset.py @@ -0,0 +1,822 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 MediaAsset(object): + """ + Represents the metadata associated with an asset that has been either produced by or registered with Media Services. + """ + + #: A constant which can be used with the lifecycle_state property of a MediaAsset. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + #: A constant which can be used with the lifecycle_state property of a MediaAsset. + #: This constant has a value of "UPDATING" + LIFECYCLE_STATE_UPDATING = "UPDATING" + + #: A constant which can be used with the lifecycle_state property of a MediaAsset. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a MediaAsset. + #: This constant has a value of "DELETING" + LIFECYCLE_STATE_DELETING = "DELETING" + + #: A constant which can be used with the lifecycle_state property of a MediaAsset. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" + + #: A constant which can be used with the lifecycle_state property of a MediaAsset. + #: This constant has a value of "FAILED" + LIFECYCLE_STATE_FAILED = "FAILED" + + #: A constant which can be used with the type property of a MediaAsset. + #: This constant has a value of "AUDIO" + TYPE_AUDIO = "AUDIO" + + #: A constant which can be used with the type property of a MediaAsset. + #: This constant has a value of "VIDEO" + TYPE_VIDEO = "VIDEO" + + #: A constant which can be used with the type property of a MediaAsset. + #: This constant has a value of "PLAYLIST" + TYPE_PLAYLIST = "PLAYLIST" + + #: A constant which can be used with the type property of a MediaAsset. + #: This constant has a value of "IMAGE" + TYPE_IMAGE = "IMAGE" + + #: A constant which can be used with the type property of a MediaAsset. + #: This constant has a value of "CAPTION_FILE" + TYPE_CAPTION_FILE = "CAPTION_FILE" + + #: A constant which can be used with the type property of a MediaAsset. + #: This constant has a value of "UNKNOWN" + TYPE_UNKNOWN = "UNKNOWN" + + def __init__(self, **kwargs): + """ + Initializes a new MediaAsset 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 MediaAsset. + :type id: str + + :param compartment_id: + The value to assign to the compartment_id property of this MediaAsset. + :type compartment_id: str + + :param source_media_workflow_id: + The value to assign to the source_media_workflow_id property of this MediaAsset. + :type source_media_workflow_id: str + + :param media_workflow_job_id: + The value to assign to the media_workflow_job_id property of this MediaAsset. + :type media_workflow_job_id: str + + :param source_media_workflow_version: + The value to assign to the source_media_workflow_version property of this MediaAsset. + :type source_media_workflow_version: int + + :param display_name: + The value to assign to the display_name property of this MediaAsset. + :type display_name: str + + :param time_created: + The value to assign to the time_created property of this MediaAsset. + :type time_created: datetime + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this MediaAsset. + Allowed values for this property are: "CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type lifecycle_state: str + + :param type: + The value to assign to the type property of this MediaAsset. + Allowed values for this property are: "AUDIO", "VIDEO", "PLAYLIST", "IMAGE", "CAPTION_FILE", "UNKNOWN", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type type: str + + :param parent_media_asset_id: + The value to assign to the parent_media_asset_id property of this MediaAsset. + :type parent_media_asset_id: str + + :param master_media_asset_id: + The value to assign to the master_media_asset_id property of this MediaAsset. + :type master_media_asset_id: str + + :param bucket_name: + The value to assign to the bucket_name property of this MediaAsset. + :type bucket_name: str + + :param namespace_name: + The value to assign to the namespace_name property of this MediaAsset. + :type namespace_name: str + + :param object_name: + The value to assign to the object_name property of this MediaAsset. + :type object_name: str + + :param object_etag: + The value to assign to the object_etag property of this MediaAsset. + :type object_etag: str + + :param time_updated: + The value to assign to the time_updated property of this MediaAsset. + :type time_updated: datetime + + :param segment_range_start_index: + The value to assign to the segment_range_start_index property of this MediaAsset. + :type segment_range_start_index: int + + :param segment_range_end_index: + The value to assign to the segment_range_end_index property of this MediaAsset. + :type segment_range_end_index: int + + :param metadata: + The value to assign to the metadata property of this MediaAsset. + :type metadata: list[oci.media_services.models.Metadata] + + :param media_asset_tags: + The value to assign to the media_asset_tags property of this MediaAsset. + :type media_asset_tags: list[oci.media_services.models.MediaAssetTag] + + :param freeform_tags: + The value to assign to the freeform_tags property of this MediaAsset. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this MediaAsset. + :type defined_tags: dict(str, dict(str, object)) + + :param system_tags: + The value to assign to the system_tags property of this MediaAsset. + :type system_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'id': 'str', + 'compartment_id': 'str', + 'source_media_workflow_id': 'str', + 'media_workflow_job_id': 'str', + 'source_media_workflow_version': 'int', + 'display_name': 'str', + 'time_created': 'datetime', + 'lifecycle_state': 'str', + 'type': 'str', + 'parent_media_asset_id': 'str', + 'master_media_asset_id': 'str', + 'bucket_name': 'str', + 'namespace_name': 'str', + 'object_name': 'str', + 'object_etag': 'str', + 'time_updated': 'datetime', + 'segment_range_start_index': 'int', + 'segment_range_end_index': 'int', + 'metadata': 'list[Metadata]', + 'media_asset_tags': 'list[MediaAssetTag]', + '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', + 'source_media_workflow_id': 'sourceMediaWorkflowId', + 'media_workflow_job_id': 'mediaWorkflowJobId', + 'source_media_workflow_version': 'sourceMediaWorkflowVersion', + 'display_name': 'displayName', + 'time_created': 'timeCreated', + 'lifecycle_state': 'lifecycleState', + 'type': 'type', + 'parent_media_asset_id': 'parentMediaAssetId', + 'master_media_asset_id': 'masterMediaAssetId', + 'bucket_name': 'bucketName', + 'namespace_name': 'namespaceName', + 'object_name': 'objectName', + 'object_etag': 'objectEtag', + 'time_updated': 'timeUpdated', + 'segment_range_start_index': 'segmentRangeStartIndex', + 'segment_range_end_index': 'segmentRangeEndIndex', + 'metadata': 'metadata', + 'media_asset_tags': 'mediaAssetTags', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags', + 'system_tags': 'systemTags' + } + + self._id = None + self._compartment_id = None + self._source_media_workflow_id = None + self._media_workflow_job_id = None + self._source_media_workflow_version = None + self._display_name = None + self._time_created = None + self._lifecycle_state = None + self._type = None + self._parent_media_asset_id = None + self._master_media_asset_id = None + self._bucket_name = None + self._namespace_name = None + self._object_name = None + self._object_etag = None + self._time_updated = None + self._segment_range_start_index = None + self._segment_range_end_index = None + self._metadata = None + self._media_asset_tags = None + self._freeform_tags = None + self._defined_tags = None + self._system_tags = None + + @property + def id(self): + """ + **[Required]** Gets the id of this MediaAsset. + Unique identifier that is immutable on creation. + + + :return: The id of this MediaAsset. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this MediaAsset. + Unique identifier that is immutable on creation. + + + :param id: The id of this MediaAsset. + :type: str + """ + self._id = id + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this MediaAsset. + The ID of the compartment containing the MediaAsset. + + + :return: The compartment_id of this MediaAsset. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this MediaAsset. + The ID of the compartment containing the MediaAsset. + + + :param compartment_id: The compartment_id of this MediaAsset. + :type: str + """ + self._compartment_id = compartment_id + + @property + def source_media_workflow_id(self): + """ + Gets the source_media_workflow_id of this MediaAsset. + The ID of the MediaWorkflow used to produce this asset. + + + :return: The source_media_workflow_id of this MediaAsset. + :rtype: str + """ + return self._source_media_workflow_id + + @source_media_workflow_id.setter + def source_media_workflow_id(self, source_media_workflow_id): + """ + Sets the source_media_workflow_id of this MediaAsset. + The ID of the MediaWorkflow used to produce this asset. + + + :param source_media_workflow_id: The source_media_workflow_id of this MediaAsset. + :type: str + """ + self._source_media_workflow_id = source_media_workflow_id + + @property + def media_workflow_job_id(self): + """ + Gets the media_workflow_job_id of this MediaAsset. + The ID of the MediaWorkflowJob used to produce this asset. + + + :return: The media_workflow_job_id of this MediaAsset. + :rtype: str + """ + return self._media_workflow_job_id + + @media_workflow_job_id.setter + def media_workflow_job_id(self, media_workflow_job_id): + """ + Sets the media_workflow_job_id of this MediaAsset. + The ID of the MediaWorkflowJob used to produce this asset. + + + :param media_workflow_job_id: The media_workflow_job_id of this MediaAsset. + :type: str + """ + self._media_workflow_job_id = media_workflow_job_id + + @property + def source_media_workflow_version(self): + """ + Gets the source_media_workflow_version of this MediaAsset. + The version of the MediaWorkflow used to produce this asset. + + + :return: The source_media_workflow_version of this MediaAsset. + :rtype: int + """ + return self._source_media_workflow_version + + @source_media_workflow_version.setter + def source_media_workflow_version(self, source_media_workflow_version): + """ + Sets the source_media_workflow_version of this MediaAsset. + The version of the MediaWorkflow used to produce this asset. + + + :param source_media_workflow_version: The source_media_workflow_version of this MediaAsset. + :type: int + """ + self._source_media_workflow_version = source_media_workflow_version + + @property + def display_name(self): + """ + Gets the display_name of this MediaAsset. + A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. + + + :return: The display_name of this MediaAsset. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this MediaAsset. + A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. + + + :param display_name: The display_name of this MediaAsset. + :type: str + """ + self._display_name = display_name + + @property + def time_created(self): + """ + Gets the time_created of this MediaAsset. + The time when the MediaAsset was created. An RFC3339 formatted datetime string. + + + :return: The time_created of this MediaAsset. + :rtype: datetime + """ + return self._time_created + + @time_created.setter + def time_created(self, time_created): + """ + Sets the time_created of this MediaAsset. + The time when the MediaAsset was created. An RFC3339 formatted datetime string. + + + :param time_created: The time_created of this MediaAsset. + :type: datetime + """ + self._time_created = time_created + + @property + def lifecycle_state(self): + """ + **[Required]** Gets the lifecycle_state of this MediaAsset. + The current state of the MediaAsset. + + Allowed values for this property are: "CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The lifecycle_state of this MediaAsset. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this MediaAsset. + The current state of the MediaAsset. + + + :param lifecycle_state: The lifecycle_state of this MediaAsset. + :type: str + """ + allowed_values = ["CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED"] + if not value_allowed_none_or_none_sentinel(lifecycle_state, allowed_values): + lifecycle_state = 'UNKNOWN_ENUM_VALUE' + self._lifecycle_state = lifecycle_state + + @property + def type(self): + """ + **[Required]** Gets the type of this MediaAsset. + The type of the media asset. + + Allowed values for this property are: "AUDIO", "VIDEO", "PLAYLIST", "IMAGE", "CAPTION_FILE", "UNKNOWN", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The type of this MediaAsset. + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """ + Sets the type of this MediaAsset. + The type of the media asset. + + + :param type: The type of this MediaAsset. + :type: str + """ + allowed_values = ["AUDIO", "VIDEO", "PLAYLIST", "IMAGE", "CAPTION_FILE", "UNKNOWN"] + if not value_allowed_none_or_none_sentinel(type, allowed_values): + type = 'UNKNOWN_ENUM_VALUE' + self._type = type + + @property + def parent_media_asset_id(self): + """ + Gets the parent_media_asset_id of this MediaAsset. + The ID of the parent asset from which this asset is derived. + + + :return: The parent_media_asset_id of this MediaAsset. + :rtype: str + """ + return self._parent_media_asset_id + + @parent_media_asset_id.setter + def parent_media_asset_id(self, parent_media_asset_id): + """ + Sets the parent_media_asset_id of this MediaAsset. + The ID of the parent asset from which this asset is derived. + + + :param parent_media_asset_id: The parent_media_asset_id of this MediaAsset. + :type: str + """ + self._parent_media_asset_id = parent_media_asset_id + + @property + def master_media_asset_id(self): + """ + Gets the master_media_asset_id of this MediaAsset. + The ID of the senior most asset from which this asset is derived. + + + :return: The master_media_asset_id of this MediaAsset. + :rtype: str + """ + return self._master_media_asset_id + + @master_media_asset_id.setter + def master_media_asset_id(self, master_media_asset_id): + """ + Sets the master_media_asset_id of this MediaAsset. + The ID of the senior most asset from which this asset is derived. + + + :param master_media_asset_id: The master_media_asset_id of this MediaAsset. + :type: str + """ + self._master_media_asset_id = master_media_asset_id + + @property + def bucket_name(self): + """ + Gets the bucket_name of this MediaAsset. + The name of the object storage bucket where this represented asset is located. + + + :return: The bucket_name of this MediaAsset. + :rtype: str + """ + return self._bucket_name + + @bucket_name.setter + def bucket_name(self, bucket_name): + """ + Sets the bucket_name of this MediaAsset. + The name of the object storage bucket where this represented asset is located. + + + :param bucket_name: The bucket_name of this MediaAsset. + :type: str + """ + self._bucket_name = bucket_name + + @property + def namespace_name(self): + """ + Gets the namespace_name of this MediaAsset. + The object storage namespace where this asset is located. + + + :return: The namespace_name of this MediaAsset. + :rtype: str + """ + return self._namespace_name + + @namespace_name.setter + def namespace_name(self, namespace_name): + """ + Sets the namespace_name of this MediaAsset. + The object storage namespace where this asset is located. + + + :param namespace_name: The namespace_name of this MediaAsset. + :type: str + """ + self._namespace_name = namespace_name + + @property + def object_name(self): + """ + Gets the object_name of this MediaAsset. + The object storage object name that identifies this asset. + + + :return: The object_name of this MediaAsset. + :rtype: str + """ + return self._object_name + + @object_name.setter + def object_name(self, object_name): + """ + Sets the object_name of this MediaAsset. + The object storage object name that identifies this asset. + + + :param object_name: The object_name of this MediaAsset. + :type: str + """ + self._object_name = object_name + + @property + def object_etag(self): + """ + Gets the object_etag of this MediaAsset. + eTag of the underlying object storage object. + + + :return: The object_etag of this MediaAsset. + :rtype: str + """ + return self._object_etag + + @object_etag.setter + def object_etag(self, object_etag): + """ + Sets the object_etag of this MediaAsset. + eTag of the underlying object storage object. + + + :param object_etag: The object_etag of this MediaAsset. + :type: str + """ + self._object_etag = object_etag + + @property + def time_updated(self): + """ + Gets the time_updated of this MediaAsset. + The time when the MediaAsset was updated. An RFC3339 formatted datetime string. + + + :return: The time_updated of this MediaAsset. + :rtype: datetime + """ + return self._time_updated + + @time_updated.setter + def time_updated(self, time_updated): + """ + Sets the time_updated of this MediaAsset. + The time when the MediaAsset was updated. An RFC3339 formatted datetime string. + + + :param time_updated: The time_updated of this MediaAsset. + :type: datetime + """ + self._time_updated = time_updated + + @property + def segment_range_start_index(self): + """ + Gets the segment_range_start_index of this MediaAsset. + The start index for video segment files. + + + :return: The segment_range_start_index of this MediaAsset. + :rtype: int + """ + return self._segment_range_start_index + + @segment_range_start_index.setter + def segment_range_start_index(self, segment_range_start_index): + """ + Sets the segment_range_start_index of this MediaAsset. + The start index for video segment files. + + + :param segment_range_start_index: The segment_range_start_index of this MediaAsset. + :type: int + """ + self._segment_range_start_index = segment_range_start_index + + @property + def segment_range_end_index(self): + """ + Gets the segment_range_end_index of this MediaAsset. + The end index of video segment files. + + + :return: The segment_range_end_index of this MediaAsset. + :rtype: int + """ + return self._segment_range_end_index + + @segment_range_end_index.setter + def segment_range_end_index(self, segment_range_end_index): + """ + Sets the segment_range_end_index of this MediaAsset. + The end index of video segment files. + + + :param segment_range_end_index: The segment_range_end_index of this MediaAsset. + :type: int + """ + self._segment_range_end_index = segment_range_end_index + + @property + def metadata(self): + """ + Gets the metadata of this MediaAsset. + List of Metadata. + + + :return: The metadata of this MediaAsset. + :rtype: list[oci.media_services.models.Metadata] + """ + return self._metadata + + @metadata.setter + def metadata(self, metadata): + """ + Sets the metadata of this MediaAsset. + List of Metadata. + + + :param metadata: The metadata of this MediaAsset. + :type: list[oci.media_services.models.Metadata] + """ + self._metadata = metadata + + @property + def media_asset_tags(self): + """ + Gets the media_asset_tags of this MediaAsset. + List of tags for the MediaAsset. + + + :return: The media_asset_tags of this MediaAsset. + :rtype: list[oci.media_services.models.MediaAssetTag] + """ + return self._media_asset_tags + + @media_asset_tags.setter + def media_asset_tags(self, media_asset_tags): + """ + Sets the media_asset_tags of this MediaAsset. + List of tags for the MediaAsset. + + + :param media_asset_tags: The media_asset_tags of this MediaAsset. + :type: list[oci.media_services.models.MediaAssetTag] + """ + self._media_asset_tags = media_asset_tags + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this MediaAsset. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :return: The freeform_tags of this MediaAsset. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this MediaAsset. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :param freeform_tags: The freeform_tags of this MediaAsset. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this MediaAsset. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this MediaAsset. + :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 MediaAsset. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this MediaAsset. + :type: dict(str, dict(str, object)) + """ + self._defined_tags = defined_tags + + @property + def system_tags(self): + """ + Gets the system_tags of this MediaAsset. + 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 MediaAsset. + :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 MediaAsset. + 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 MediaAsset. + :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/media_services/models/media_asset_collection.py b/src/oci/media_services/models/media_asset_collection.py new file mode 100644 index 0000000000..0ffc399a5e --- /dev/null +++ b/src/oci/media_services/models/media_asset_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 MediaAssetCollection(object): + """ + Results of a mediaAsset search. Contains both MediaAssetSummary items and other data. + """ + + def __init__(self, **kwargs): + """ + Initializes a new MediaAssetCollection 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 MediaAssetCollection. + :type items: list[oci.media_services.models.MediaAssetSummary] + + """ + self.swagger_types = { + 'items': 'list[MediaAssetSummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this MediaAssetCollection. + List of mediaAssets. + + + :return: The items of this MediaAssetCollection. + :rtype: list[oci.media_services.models.MediaAssetSummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this MediaAssetCollection. + List of mediaAssets. + + + :param items: The items of this MediaAssetCollection. + :type: list[oci.media_services.models.MediaAssetSummary] + """ + 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/media_services/models/media_asset_distribution_channel_attachment.py b/src/oci/media_services/models/media_asset_distribution_channel_attachment.py new file mode 100644 index 0000000000..214180cc7e --- /dev/null +++ b/src/oci/media_services/models/media_asset_distribution_channel_attachment.py @@ -0,0 +1,249 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 MediaAssetDistributionChannelAttachment(object): + """ + Attachment between MediaAsset and streaming DistributionChannel. + """ + + #: A constant which can be used with the lifecycle_state property of a MediaAssetDistributionChannelAttachment. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + #: A constant which can be used with the lifecycle_state property of a MediaAssetDistributionChannelAttachment. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a MediaAssetDistributionChannelAttachment. + #: This constant has a value of "NEEDS_ATTENTION" + LIFECYCLE_STATE_NEEDS_ATTENTION = "NEEDS_ATTENTION" + + #: A constant which can be used with the lifecycle_state property of a MediaAssetDistributionChannelAttachment. + #: This constant has a value of "UPDATING" + LIFECYCLE_STATE_UPDATING = "UPDATING" + + def __init__(self, **kwargs): + """ + Initializes a new MediaAssetDistributionChannelAttachment object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param distribution_channel_id: + The value to assign to the distribution_channel_id property of this MediaAssetDistributionChannelAttachment. + :type distribution_channel_id: str + + :param display_name: + The value to assign to the display_name property of this MediaAssetDistributionChannelAttachment. + :type display_name: str + + :param version: + The value to assign to the version property of this MediaAssetDistributionChannelAttachment. + :type version: int + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this MediaAssetDistributionChannelAttachment. + Allowed values for this property are: "CREATING", "ACTIVE", "NEEDS_ATTENTION", "UPDATING", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type lifecycle_state: str + + :param metadata_ref: + The value to assign to the metadata_ref property of this MediaAssetDistributionChannelAttachment. + :type metadata_ref: str + + :param media_workflow_job_id: + The value to assign to the media_workflow_job_id property of this MediaAssetDistributionChannelAttachment. + :type media_workflow_job_id: str + + """ + self.swagger_types = { + 'distribution_channel_id': 'str', + 'display_name': 'str', + 'version': 'int', + 'lifecycle_state': 'str', + 'metadata_ref': 'str', + 'media_workflow_job_id': 'str' + } + + self.attribute_map = { + 'distribution_channel_id': 'distributionChannelId', + 'display_name': 'displayName', + 'version': 'version', + 'lifecycle_state': 'lifecycleState', + 'metadata_ref': 'metadataRef', + 'media_workflow_job_id': 'mediaWorkflowJobId' + } + + self._distribution_channel_id = None + self._display_name = None + self._version = None + self._lifecycle_state = None + self._metadata_ref = None + self._media_workflow_job_id = None + + @property + def distribution_channel_id(self): + """ + **[Required]** Gets the distribution_channel_id of this MediaAssetDistributionChannelAttachment. + OCID of associated Distribution Channel. + + + :return: The distribution_channel_id of this MediaAssetDistributionChannelAttachment. + :rtype: str + """ + return self._distribution_channel_id + + @distribution_channel_id.setter + def distribution_channel_id(self, distribution_channel_id): + """ + Sets the distribution_channel_id of this MediaAssetDistributionChannelAttachment. + OCID of associated Distribution Channel. + + + :param distribution_channel_id: The distribution_channel_id of this MediaAssetDistributionChannelAttachment. + :type: str + """ + self._distribution_channel_id = distribution_channel_id + + @property + def display_name(self): + """ + Gets the display_name of this MediaAssetDistributionChannelAttachment. + A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. + + + :return: The display_name of this MediaAssetDistributionChannelAttachment. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this MediaAssetDistributionChannelAttachment. + A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. + + + :param display_name: The display_name of this MediaAssetDistributionChannelAttachment. + :type: str + """ + self._display_name = display_name + + @property + def version(self): + """ + **[Required]** Gets the version of this MediaAssetDistributionChannelAttachment. + Version of the attachment. + + + :return: The version of this MediaAssetDistributionChannelAttachment. + :rtype: int + """ + return self._version + + @version.setter + def version(self, version): + """ + Sets the version of this MediaAssetDistributionChannelAttachment. + Version of the attachment. + + + :param version: The version of this MediaAssetDistributionChannelAttachment. + :type: int + """ + self._version = version + + @property + def lifecycle_state(self): + """ + **[Required]** Gets the lifecycle_state of this MediaAssetDistributionChannelAttachment. + Lifecycle state of the attachment. + + Allowed values for this property are: "CREATING", "ACTIVE", "NEEDS_ATTENTION", "UPDATING", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The lifecycle_state of this MediaAssetDistributionChannelAttachment. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this MediaAssetDistributionChannelAttachment. + Lifecycle state of the attachment. + + + :param lifecycle_state: The lifecycle_state of this MediaAssetDistributionChannelAttachment. + :type: str + """ + allowed_values = ["CREATING", "ACTIVE", "NEEDS_ATTENTION", "UPDATING"] + if not value_allowed_none_or_none_sentinel(lifecycle_state, allowed_values): + lifecycle_state = 'UNKNOWN_ENUM_VALUE' + self._lifecycle_state = lifecycle_state + + @property + def metadata_ref(self): + """ + **[Required]** Gets the metadata_ref of this MediaAssetDistributionChannelAttachment. + The identifier for the metadata. + + + :return: The metadata_ref of this MediaAssetDistributionChannelAttachment. + :rtype: str + """ + return self._metadata_ref + + @metadata_ref.setter + def metadata_ref(self, metadata_ref): + """ + Sets the metadata_ref of this MediaAssetDistributionChannelAttachment. + The identifier for the metadata. + + + :param metadata_ref: The metadata_ref of this MediaAssetDistributionChannelAttachment. + :type: str + """ + self._metadata_ref = metadata_ref + + @property + def media_workflow_job_id(self): + """ + Gets the media_workflow_job_id of this MediaAssetDistributionChannelAttachment. + The ingest MediaWorkflowJob ID that created this attachment. + + + :return: The media_workflow_job_id of this MediaAssetDistributionChannelAttachment. + :rtype: str + """ + return self._media_workflow_job_id + + @media_workflow_job_id.setter + def media_workflow_job_id(self, media_workflow_job_id): + """ + Sets the media_workflow_job_id of this MediaAssetDistributionChannelAttachment. + The ingest MediaWorkflowJob ID that created this attachment. + + + :param media_workflow_job_id: The media_workflow_job_id of this MediaAssetDistributionChannelAttachment. + :type: str + """ + self._media_workflow_job_id = media_workflow_job_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/media_services/models/media_asset_distribution_channel_attachment_collection.py b/src/oci/media_services/models/media_asset_distribution_channel_attachment_collection.py new file mode 100644 index 0000000000..fbf22a8dff --- /dev/null +++ b/src/oci/media_services/models/media_asset_distribution_channel_attachment_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 MediaAssetDistributionChannelAttachmentCollection(object): + """ + Results of a MediaAssetDistributionChannelAttachment search. Contains the MediaAssetDistributionChannelAttachmentSummary items. + """ + + def __init__(self, **kwargs): + """ + Initializes a new MediaAssetDistributionChannelAttachmentCollection 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 MediaAssetDistributionChannelAttachmentCollection. + :type items: list[oci.media_services.models.MediaAssetDistributionChannelAttachmentSummary] + + """ + self.swagger_types = { + 'items': 'list[MediaAssetDistributionChannelAttachmentSummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this MediaAssetDistributionChannelAttachmentCollection. + List of Distribution Channel attachments. + + + :return: The items of this MediaAssetDistributionChannelAttachmentCollection. + :rtype: list[oci.media_services.models.MediaAssetDistributionChannelAttachmentSummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this MediaAssetDistributionChannelAttachmentCollection. + List of Distribution Channel attachments. + + + :param items: The items of this MediaAssetDistributionChannelAttachmentCollection. + :type: list[oci.media_services.models.MediaAssetDistributionChannelAttachmentSummary] + """ + 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/media_services/models/media_asset_distribution_channel_attachment_summary.py b/src/oci/media_services/models/media_asset_distribution_channel_attachment_summary.py new file mode 100644 index 0000000000..4e8df95a8f --- /dev/null +++ b/src/oci/media_services/models/media_asset_distribution_channel_attachment_summary.py @@ -0,0 +1,280 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 MediaAssetDistributionChannelAttachmentSummary(object): + """ + Summary of the MediaAssetDistributionChannelAttachment. + """ + + #: A constant which can be used with the lifecycle_state property of a MediaAssetDistributionChannelAttachmentSummary. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + #: A constant which can be used with the lifecycle_state property of a MediaAssetDistributionChannelAttachmentSummary. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a MediaAssetDistributionChannelAttachmentSummary. + #: This constant has a value of "NEEDS_ATTENTION" + LIFECYCLE_STATE_NEEDS_ATTENTION = "NEEDS_ATTENTION" + + #: A constant which can be used with the lifecycle_state property of a MediaAssetDistributionChannelAttachmentSummary. + #: This constant has a value of "UPDATING" + LIFECYCLE_STATE_UPDATING = "UPDATING" + + def __init__(self, **kwargs): + """ + Initializes a new MediaAssetDistributionChannelAttachmentSummary object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param media_asset_id: + The value to assign to the media_asset_id property of this MediaAssetDistributionChannelAttachmentSummary. + :type media_asset_id: str + + :param display_name: + The value to assign to the display_name property of this MediaAssetDistributionChannelAttachmentSummary. + :type display_name: str + + :param distribution_channel_id: + The value to assign to the distribution_channel_id property of this MediaAssetDistributionChannelAttachmentSummary. + :type distribution_channel_id: str + + :param version: + The value to assign to the version property of this MediaAssetDistributionChannelAttachmentSummary. + :type version: int + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this MediaAssetDistributionChannelAttachmentSummary. + Allowed values for this property are: "CREATING", "ACTIVE", "NEEDS_ATTENTION", "UPDATING", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type lifecycle_state: str + + :param metadata_ref: + The value to assign to the metadata_ref property of this MediaAssetDistributionChannelAttachmentSummary. + :type metadata_ref: str + + :param media_workflow_job_id: + The value to assign to the media_workflow_job_id property of this MediaAssetDistributionChannelAttachmentSummary. + :type media_workflow_job_id: str + + """ + self.swagger_types = { + 'media_asset_id': 'str', + 'display_name': 'str', + 'distribution_channel_id': 'str', + 'version': 'int', + 'lifecycle_state': 'str', + 'metadata_ref': 'str', + 'media_workflow_job_id': 'str' + } + + self.attribute_map = { + 'media_asset_id': 'mediaAssetId', + 'display_name': 'displayName', + 'distribution_channel_id': 'distributionChannelId', + 'version': 'version', + 'lifecycle_state': 'lifecycleState', + 'metadata_ref': 'metadataRef', + 'media_workflow_job_id': 'mediaWorkflowJobId' + } + + self._media_asset_id = None + self._display_name = None + self._distribution_channel_id = None + self._version = None + self._lifecycle_state = None + self._metadata_ref = None + self._media_workflow_job_id = None + + @property + def media_asset_id(self): + """ + **[Required]** Gets the media_asset_id of this MediaAssetDistributionChannelAttachmentSummary. + OCID of associated media asset. + + + :return: The media_asset_id of this MediaAssetDistributionChannelAttachmentSummary. + :rtype: str + """ + return self._media_asset_id + + @media_asset_id.setter + def media_asset_id(self, media_asset_id): + """ + Sets the media_asset_id of this MediaAssetDistributionChannelAttachmentSummary. + OCID of associated media asset. + + + :param media_asset_id: The media_asset_id of this MediaAssetDistributionChannelAttachmentSummary. + :type: str + """ + self._media_asset_id = media_asset_id + + @property + def display_name(self): + """ + Gets the display_name of this MediaAssetDistributionChannelAttachmentSummary. + Display name for the MediaAssetDistributionChannelAttachment. Does not have to be unique, and it's changeable. Avoid entering confidential information. + + + :return: The display_name of this MediaAssetDistributionChannelAttachmentSummary. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this MediaAssetDistributionChannelAttachmentSummary. + Display name for the MediaAssetDistributionChannelAttachment. Does not have to be unique, and it's changeable. Avoid entering confidential information. + + + :param display_name: The display_name of this MediaAssetDistributionChannelAttachmentSummary. + :type: str + """ + self._display_name = display_name + + @property + def distribution_channel_id(self): + """ + **[Required]** Gets the distribution_channel_id of this MediaAssetDistributionChannelAttachmentSummary. + OCID of associated Distribution Channel. + + + :return: The distribution_channel_id of this MediaAssetDistributionChannelAttachmentSummary. + :rtype: str + """ + return self._distribution_channel_id + + @distribution_channel_id.setter + def distribution_channel_id(self, distribution_channel_id): + """ + Sets the distribution_channel_id of this MediaAssetDistributionChannelAttachmentSummary. + OCID of associated Distribution Channel. + + + :param distribution_channel_id: The distribution_channel_id of this MediaAssetDistributionChannelAttachmentSummary. + :type: str + """ + self._distribution_channel_id = distribution_channel_id + + @property + def version(self): + """ + **[Required]** Gets the version of this MediaAssetDistributionChannelAttachmentSummary. + Version number of the attachment. + + + :return: The version of this MediaAssetDistributionChannelAttachmentSummary. + :rtype: int + """ + return self._version + + @version.setter + def version(self, version): + """ + Sets the version of this MediaAssetDistributionChannelAttachmentSummary. + Version number of the attachment. + + + :param version: The version of this MediaAssetDistributionChannelAttachmentSummary. + :type: int + """ + self._version = version + + @property + def lifecycle_state(self): + """ + **[Required]** Gets the lifecycle_state of this MediaAssetDistributionChannelAttachmentSummary. + Lifecycle state of the attachment. + + Allowed values for this property are: "CREATING", "ACTIVE", "NEEDS_ATTENTION", "UPDATING", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The lifecycle_state of this MediaAssetDistributionChannelAttachmentSummary. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this MediaAssetDistributionChannelAttachmentSummary. + Lifecycle state of the attachment. + + + :param lifecycle_state: The lifecycle_state of this MediaAssetDistributionChannelAttachmentSummary. + :type: str + """ + allowed_values = ["CREATING", "ACTIVE", "NEEDS_ATTENTION", "UPDATING"] + if not value_allowed_none_or_none_sentinel(lifecycle_state, allowed_values): + lifecycle_state = 'UNKNOWN_ENUM_VALUE' + self._lifecycle_state = lifecycle_state + + @property + def metadata_ref(self): + """ + **[Required]** Gets the metadata_ref of this MediaAssetDistributionChannelAttachmentSummary. + The identifier for the metadata. + + + :return: The metadata_ref of this MediaAssetDistributionChannelAttachmentSummary. + :rtype: str + """ + return self._metadata_ref + + @metadata_ref.setter + def metadata_ref(self, metadata_ref): + """ + Sets the metadata_ref of this MediaAssetDistributionChannelAttachmentSummary. + The identifier for the metadata. + + + :param metadata_ref: The metadata_ref of this MediaAssetDistributionChannelAttachmentSummary. + :type: str + """ + self._metadata_ref = metadata_ref + + @property + def media_workflow_job_id(self): + """ + Gets the media_workflow_job_id of this MediaAssetDistributionChannelAttachmentSummary. + The ingest MediaWorkflowJob ID that created this attachment. + + + :return: The media_workflow_job_id of this MediaAssetDistributionChannelAttachmentSummary. + :rtype: str + """ + return self._media_workflow_job_id + + @media_workflow_job_id.setter + def media_workflow_job_id(self, media_workflow_job_id): + """ + Sets the media_workflow_job_id of this MediaAssetDistributionChannelAttachmentSummary. + The ingest MediaWorkflowJob ID that created this attachment. + + + :param media_workflow_job_id: The media_workflow_job_id of this MediaAssetDistributionChannelAttachmentSummary. + :type: str + """ + self._media_workflow_job_id = media_workflow_job_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/media_services/models/media_asset_summary.py b/src/oci/media_services/models/media_asset_summary.py new file mode 100644 index 0000000000..eff4958a2e --- /dev/null +++ b/src/oci/media_services/models/media_asset_summary.py @@ -0,0 +1,481 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 MediaAssetSummary(object): + """ + Summary of the MediaAsset. + """ + + #: A constant which can be used with the lifecycle_state property of a MediaAssetSummary. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + #: A constant which can be used with the lifecycle_state property of a MediaAssetSummary. + #: This constant has a value of "UPDATING" + LIFECYCLE_STATE_UPDATING = "UPDATING" + + #: A constant which can be used with the lifecycle_state property of a MediaAssetSummary. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a MediaAssetSummary. + #: This constant has a value of "DELETING" + LIFECYCLE_STATE_DELETING = "DELETING" + + #: A constant which can be used with the lifecycle_state property of a MediaAssetSummary. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" + + #: A constant which can be used with the lifecycle_state property of a MediaAssetSummary. + #: This constant has a value of "FAILED" + LIFECYCLE_STATE_FAILED = "FAILED" + + #: A constant which can be used with the type property of a MediaAssetSummary. + #: This constant has a value of "AUDIO" + TYPE_AUDIO = "AUDIO" + + #: A constant which can be used with the type property of a MediaAssetSummary. + #: This constant has a value of "VIDEO" + TYPE_VIDEO = "VIDEO" + + #: A constant which can be used with the type property of a MediaAssetSummary. + #: This constant has a value of "PLAYLIST" + TYPE_PLAYLIST = "PLAYLIST" + + #: A constant which can be used with the type property of a MediaAssetSummary. + #: This constant has a value of "IMAGE" + TYPE_IMAGE = "IMAGE" + + #: A constant which can be used with the type property of a MediaAssetSummary. + #: This constant has a value of "CAPTION_FILE" + TYPE_CAPTION_FILE = "CAPTION_FILE" + + #: A constant which can be used with the type property of a MediaAssetSummary. + #: This constant has a value of "UNKNOWN" + TYPE_UNKNOWN = "UNKNOWN" + + def __init__(self, **kwargs): + """ + Initializes a new MediaAssetSummary 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 MediaAssetSummary. + :type id: str + + :param compartment_id: + The value to assign to the compartment_id property of this MediaAssetSummary. + :type compartment_id: str + + :param display_name: + The value to assign to the display_name property of this MediaAssetSummary. + :type display_name: str + + :param time_created: + The value to assign to the time_created property of this MediaAssetSummary. + :type time_created: datetime + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this MediaAssetSummary. + Allowed values for this property are: "CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type lifecycle_state: str + + :param type: + The value to assign to the type property of this MediaAssetSummary. + Allowed values for this property are: "AUDIO", "VIDEO", "PLAYLIST", "IMAGE", "CAPTION_FILE", "UNKNOWN", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type type: str + + :param time_updated: + The value to assign to the time_updated property of this MediaAssetSummary. + :type time_updated: datetime + + :param master_media_asset_id: + The value to assign to the master_media_asset_id property of this MediaAssetSummary. + :type master_media_asset_id: str + + :param parent_media_asset_id: + The value to assign to the parent_media_asset_id property of this MediaAssetSummary. + :type parent_media_asset_id: str + + :param freeform_tags: + The value to assign to the freeform_tags property of this MediaAssetSummary. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this MediaAssetSummary. + :type defined_tags: dict(str, dict(str, object)) + + :param system_tags: + The value to assign to the system_tags property of this MediaAssetSummary. + :type system_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'id': 'str', + 'compartment_id': 'str', + 'display_name': 'str', + 'time_created': 'datetime', + 'lifecycle_state': 'str', + 'type': 'str', + 'time_updated': 'datetime', + 'master_media_asset_id': 'str', + 'parent_media_asset_id': 'str', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))', + 'system_tags': 'dict(str, dict(str, object))' + } + + self.attribute_map = { + 'id': 'id', + 'compartment_id': 'compartmentId', + 'display_name': 'displayName', + 'time_created': 'timeCreated', + 'lifecycle_state': 'lifecycleState', + 'type': 'type', + 'time_updated': 'timeUpdated', + 'master_media_asset_id': 'masterMediaAssetId', + 'parent_media_asset_id': 'parentMediaAssetId', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags', + 'system_tags': 'systemTags' + } + + self._id = None + self._compartment_id = None + self._display_name = None + self._time_created = None + self._lifecycle_state = None + self._type = None + self._time_updated = None + self._master_media_asset_id = None + self._parent_media_asset_id = None + self._freeform_tags = None + self._defined_tags = None + self._system_tags = None + + @property + def id(self): + """ + **[Required]** Gets the id of this MediaAssetSummary. + Unique identifier that is immutable on creation. + + + :return: The id of this MediaAssetSummary. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this MediaAssetSummary. + Unique identifier that is immutable on creation. + + + :param id: The id of this MediaAssetSummary. + :type: str + """ + self._id = id + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this MediaAssetSummary. + The ID of the compartment containing the MediaAsset. + + + :return: The compartment_id of this MediaAssetSummary. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this MediaAssetSummary. + The ID of the compartment containing the MediaAsset. + + + :param compartment_id: The compartment_id of this MediaAssetSummary. + :type: str + """ + self._compartment_id = compartment_id + + @property + def display_name(self): + """ + Gets the display_name of this MediaAssetSummary. + MediaAsset name. Does not have to be unique, and it's changeable. Avoid entering confidential information. + + + :return: The display_name of this MediaAssetSummary. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this MediaAssetSummary. + MediaAsset name. Does not have to be unique, and it's changeable. Avoid entering confidential information. + + + :param display_name: The display_name of this MediaAssetSummary. + :type: str + """ + self._display_name = display_name + + @property + def time_created(self): + """ + Gets the time_created of this MediaAssetSummary. + The time the the MediaAsset was created. An RFC3339 formatted datetime string. + + + :return: The time_created of this MediaAssetSummary. + :rtype: datetime + """ + return self._time_created + + @time_created.setter + def time_created(self, time_created): + """ + Sets the time_created of this MediaAssetSummary. + The time the the MediaAsset was created. An RFC3339 formatted datetime string. + + + :param time_created: The time_created of this MediaAssetSummary. + :type: datetime + """ + self._time_created = time_created + + @property + def lifecycle_state(self): + """ + **[Required]** Gets the lifecycle_state of this MediaAssetSummary. + The current state of the MediaAsset. + + Allowed values for this property are: "CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The lifecycle_state of this MediaAssetSummary. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this MediaAssetSummary. + The current state of the MediaAsset. + + + :param lifecycle_state: The lifecycle_state of this MediaAssetSummary. + :type: str + """ + allowed_values = ["CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED"] + if not value_allowed_none_or_none_sentinel(lifecycle_state, allowed_values): + lifecycle_state = 'UNKNOWN_ENUM_VALUE' + self._lifecycle_state = lifecycle_state + + @property + def type(self): + """ + **[Required]** Gets the type of this MediaAssetSummary. + The type of the media asset. + + Allowed values for this property are: "AUDIO", "VIDEO", "PLAYLIST", "IMAGE", "CAPTION_FILE", "UNKNOWN", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The type of this MediaAssetSummary. + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """ + Sets the type of this MediaAssetSummary. + The type of the media asset. + + + :param type: The type of this MediaAssetSummary. + :type: str + """ + allowed_values = ["AUDIO", "VIDEO", "PLAYLIST", "IMAGE", "CAPTION_FILE", "UNKNOWN"] + if not value_allowed_none_or_none_sentinel(type, allowed_values): + type = 'UNKNOWN_ENUM_VALUE' + self._type = type + + @property + def time_updated(self): + """ + Gets the time_updated of this MediaAssetSummary. + The time the MediaAsset was updated. An RFC3339 formatted datetime string. + + + :return: The time_updated of this MediaAssetSummary. + :rtype: datetime + """ + return self._time_updated + + @time_updated.setter + def time_updated(self, time_updated): + """ + Sets the time_updated of this MediaAssetSummary. + The time the MediaAsset was updated. An RFC3339 formatted datetime string. + + + :param time_updated: The time_updated of this MediaAssetSummary. + :type: datetime + """ + self._time_updated = time_updated + + @property + def master_media_asset_id(self): + """ + Gets the master_media_asset_id of this MediaAssetSummary. + The ID of the senior most asset from which this asset is derived. + + + :return: The master_media_asset_id of this MediaAssetSummary. + :rtype: str + """ + return self._master_media_asset_id + + @master_media_asset_id.setter + def master_media_asset_id(self, master_media_asset_id): + """ + Sets the master_media_asset_id of this MediaAssetSummary. + The ID of the senior most asset from which this asset is derived. + + + :param master_media_asset_id: The master_media_asset_id of this MediaAssetSummary. + :type: str + """ + self._master_media_asset_id = master_media_asset_id + + @property + def parent_media_asset_id(self): + """ + Gets the parent_media_asset_id of this MediaAssetSummary. + The ID of the parent asset from which this asset is derived. + + + :return: The parent_media_asset_id of this MediaAssetSummary. + :rtype: str + """ + return self._parent_media_asset_id + + @parent_media_asset_id.setter + def parent_media_asset_id(self, parent_media_asset_id): + """ + Sets the parent_media_asset_id of this MediaAssetSummary. + The ID of the parent asset from which this asset is derived. + + + :param parent_media_asset_id: The parent_media_asset_id of this MediaAssetSummary. + :type: str + """ + self._parent_media_asset_id = parent_media_asset_id + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this MediaAssetSummary. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :return: The freeform_tags of this MediaAssetSummary. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this MediaAssetSummary. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :param freeform_tags: The freeform_tags of this MediaAssetSummary. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this MediaAssetSummary. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this MediaAssetSummary. + :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 MediaAssetSummary. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this MediaAssetSummary. + :type: dict(str, dict(str, object)) + """ + self._defined_tags = defined_tags + + @property + def system_tags(self): + """ + Gets the system_tags of this MediaAssetSummary. + 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 MediaAssetSummary. + :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 MediaAssetSummary. + 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 MediaAssetSummary. + :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/media_services/models/media_asset_tag.py b/src/oci/media_services/models/media_asset_tag.py new file mode 100644 index 0000000000..463df00ba3 --- /dev/null +++ b/src/oci/media_services/models/media_asset_tag.py @@ -0,0 +1,117 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 MediaAssetTag(object): + """ + Tags of the MediaAsset. + """ + + #: A constant which can be used with the type property of a MediaAssetTag. + #: This constant has a value of "USER" + TYPE_USER = "USER" + + #: A constant which can be used with the type property of a MediaAssetTag. + #: This constant has a value of "SYSTEM" + TYPE_SYSTEM = "SYSTEM" + + def __init__(self, **kwargs): + """ + Initializes a new MediaAssetTag object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param type: + The value to assign to the type property of this MediaAssetTag. + Allowed values for this property are: "USER", "SYSTEM", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type type: str + + :param value: + The value to assign to the value property of this MediaAssetTag. + :type value: str + + """ + self.swagger_types = { + 'type': 'str', + 'value': 'str' + } + + self.attribute_map = { + 'type': 'type', + 'value': 'value' + } + + self._type = None + self._value = None + + @property + def type(self): + """ + Gets the type of this MediaAssetTag. + Type of the tag. + + Allowed values for this property are: "USER", "SYSTEM", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The type of this MediaAssetTag. + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """ + Sets the type of this MediaAssetTag. + Type of the tag. + + + :param type: The type of this MediaAssetTag. + :type: str + """ + allowed_values = ["USER", "SYSTEM"] + if not value_allowed_none_or_none_sentinel(type, allowed_values): + type = 'UNKNOWN_ENUM_VALUE' + self._type = type + + @property + def value(self): + """ + **[Required]** Gets the value of this MediaAssetTag. + Tag of the MediaAsset. + + + :return: The value of this MediaAssetTag. + :rtype: str + """ + return self._value + + @value.setter + def value(self, value): + """ + Sets the value of this MediaAssetTag. + Tag of the MediaAsset. + + + :param value: The value of this MediaAssetTag. + :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/media_services/models/media_workflow.py b/src/oci/media_services/models/media_workflow.py new file mode 100644 index 0000000000..27eaefde55 --- /dev/null +++ b/src/oci/media_services/models/media_workflow.py @@ -0,0 +1,513 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 MediaWorkflow(object): + """ + Configurable workflows that define the series of tasks that will be used to process video files. + """ + + #: A constant which can be used with the lifecycle_state property of a MediaWorkflow. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a MediaWorkflow. + #: This constant has a value of "NEEDS_ATTENTION" + LIFECYCLE_STATE_NEEDS_ATTENTION = "NEEDS_ATTENTION" + + #: A constant which can be used with the lifecycle_state property of a MediaWorkflow. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" + + def __init__(self, **kwargs): + """ + Initializes a new MediaWorkflow 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 MediaWorkflow. + :type id: str + + :param display_name: + The value to assign to the display_name property of this MediaWorkflow. + :type display_name: str + + :param compartment_id: + The value to assign to the compartment_id property of this MediaWorkflow. + :type compartment_id: str + + :param tasks: + The value to assign to the tasks property of this MediaWorkflow. + :type tasks: list[oci.media_services.models.MediaWorkflowTask] + + :param media_workflow_configuration_ids: + The value to assign to the media_workflow_configuration_ids property of this MediaWorkflow. + :type media_workflow_configuration_ids: list[str] + + :param parameters: + The value to assign to the parameters property of this MediaWorkflow. + :type parameters: dict(str, str) + + :param time_created: + The value to assign to the time_created property of this MediaWorkflow. + :type time_created: datetime + + :param time_updated: + The value to assign to the time_updated property of this MediaWorkflow. + :type time_updated: datetime + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this MediaWorkflow. + Allowed values for this property are: "ACTIVE", "NEEDS_ATTENTION", "DELETED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type lifecycle_state: str + + :param lifecyle_details: + The value to assign to the lifecyle_details property of this MediaWorkflow. + :type lifecyle_details: str + + :param version: + The value to assign to the version property of this MediaWorkflow. + :type version: int + + :param freeform_tags: + The value to assign to the freeform_tags property of this MediaWorkflow. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this MediaWorkflow. + :type defined_tags: dict(str, dict(str, object)) + + :param system_tags: + The value to assign to the system_tags property of this MediaWorkflow. + :type system_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'id': 'str', + 'display_name': 'str', + 'compartment_id': 'str', + 'tasks': 'list[MediaWorkflowTask]', + 'media_workflow_configuration_ids': 'list[str]', + 'parameters': 'dict(str, str)', + 'time_created': 'datetime', + 'time_updated': 'datetime', + 'lifecycle_state': 'str', + 'lifecyle_details': 'str', + 'version': 'int', + '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', + 'tasks': 'tasks', + 'media_workflow_configuration_ids': 'mediaWorkflowConfigurationIds', + 'parameters': 'parameters', + 'time_created': 'timeCreated', + 'time_updated': 'timeUpdated', + 'lifecycle_state': 'lifecycleState', + 'lifecyle_details': 'lifecyleDetails', + 'version': 'version', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags', + 'system_tags': 'systemTags' + } + + self._id = None + self._display_name = None + self._compartment_id = None + self._tasks = None + self._media_workflow_configuration_ids = None + self._parameters = None + self._time_created = None + self._time_updated = None + self._lifecycle_state = None + self._lifecyle_details = None + self._version = None + self._freeform_tags = None + self._defined_tags = None + self._system_tags = None + + @property + def id(self): + """ + **[Required]** Gets the id of this MediaWorkflow. + Unique identifier that is immutable on creation. + + + :return: The id of this MediaWorkflow. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this MediaWorkflow. + Unique identifier that is immutable on creation. + + + :param id: The id of this MediaWorkflow. + :type: str + """ + self._id = id + + @property + def display_name(self): + """ + **[Required]** Gets the display_name of this MediaWorkflow. + Name of the Media Workflow. Does not have to be unique, and it's changeable. Avoid entering confidential information. + + + :return: The display_name of this MediaWorkflow. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this MediaWorkflow. + Name of the Media Workflow. Does not have to be unique, and it's changeable. Avoid entering confidential information. + + + :param display_name: The display_name of this MediaWorkflow. + :type: str + """ + self._display_name = display_name + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this MediaWorkflow. + Compartment Identifier. + + + :return: The compartment_id of this MediaWorkflow. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this MediaWorkflow. + Compartment Identifier. + + + :param compartment_id: The compartment_id of this MediaWorkflow. + :type: str + """ + self._compartment_id = compartment_id + + @property + def tasks(self): + """ + Gets the tasks of this MediaWorkflow. + The processing to be done in this workflow. Each key of the MediaWorkflowTasks in this array is unique + within the array. The order of the items is preserved from the order of the tasks array in + CreateMediaWorkflowDetails or UpdateMediaWorkflowDetails. + + + :return: The tasks of this MediaWorkflow. + :rtype: list[oci.media_services.models.MediaWorkflowTask] + """ + return self._tasks + + @tasks.setter + def tasks(self, tasks): + """ + Sets the tasks of this MediaWorkflow. + The processing to be done in this workflow. Each key of the MediaWorkflowTasks in this array is unique + within the array. The order of the items is preserved from the order of the tasks array in + CreateMediaWorkflowDetails or UpdateMediaWorkflowDetails. + + + :param tasks: The tasks of this MediaWorkflow. + :type: list[oci.media_services.models.MediaWorkflowTask] + """ + self._tasks = tasks + + @property + def media_workflow_configuration_ids(self): + """ + Gets the media_workflow_configuration_ids of this MediaWorkflow. + Configurations to be applied to all the runs of this workflow. Parameters in these configurations are + overridden by parameters in the MediaWorkflowConfigurations of the MediaWorkflowJob and the + parameters of the MediaWorkflowJob. If the same parameter appears in multiple configurations, the values that + appear in the configuration at the highest index will be used. + + + :return: The media_workflow_configuration_ids of this MediaWorkflow. + :rtype: list[str] + """ + return self._media_workflow_configuration_ids + + @media_workflow_configuration_ids.setter + def media_workflow_configuration_ids(self, media_workflow_configuration_ids): + """ + Sets the media_workflow_configuration_ids of this MediaWorkflow. + Configurations to be applied to all the runs of this workflow. Parameters in these configurations are + overridden by parameters in the MediaWorkflowConfigurations of the MediaWorkflowJob and the + parameters of the MediaWorkflowJob. If the same parameter appears in multiple configurations, the values that + appear in the configuration at the highest index will be used. + + + :param media_workflow_configuration_ids: The media_workflow_configuration_ids of this MediaWorkflow. + :type: list[str] + """ + self._media_workflow_configuration_ids = media_workflow_configuration_ids + + @property + def parameters(self): + """ + Gets the parameters of this MediaWorkflow. + JSON object representing named parameters and their default values that can be referenced throughout this workflow. + The values declared here can be overridden by the MediaWorkflowConfigurations or parameters supplied when creating + MediaWorkflowJobs from this MediaWorkflow. + + + :return: The parameters of this MediaWorkflow. + :rtype: dict(str, str) + """ + return self._parameters + + @parameters.setter + def parameters(self, parameters): + """ + Sets the parameters of this MediaWorkflow. + JSON object representing named parameters and their default values that can be referenced throughout this workflow. + The values declared here can be overridden by the MediaWorkflowConfigurations or parameters supplied when creating + MediaWorkflowJobs from this MediaWorkflow. + + + :param parameters: The parameters of this MediaWorkflow. + :type: dict(str, str) + """ + self._parameters = parameters + + @property + def time_created(self): + """ + Gets the time_created of this MediaWorkflow. + The time when the MediaWorkflow was created. An RFC3339 formatted datetime string. + + + :return: The time_created of this MediaWorkflow. + :rtype: datetime + """ + return self._time_created + + @time_created.setter + def time_created(self, time_created): + """ + Sets the time_created of this MediaWorkflow. + The time when the MediaWorkflow was created. An RFC3339 formatted datetime string. + + + :param time_created: The time_created of this MediaWorkflow. + :type: datetime + """ + self._time_created = time_created + + @property + def time_updated(self): + """ + Gets the time_updated of this MediaWorkflow. + The time when the MediaWorkflow was updated. An RFC3339 formatted datetime string. + + + :return: The time_updated of this MediaWorkflow. + :rtype: datetime + """ + return self._time_updated + + @time_updated.setter + def time_updated(self, time_updated): + """ + Sets the time_updated of this MediaWorkflow. + The time when the MediaWorkflow was updated. An RFC3339 formatted datetime string. + + + :param time_updated: The time_updated of this MediaWorkflow. + :type: datetime + """ + self._time_updated = time_updated + + @property + def lifecycle_state(self): + """ + Gets the lifecycle_state of this MediaWorkflow. + The current state of the MediaWorkflow. + + Allowed values for this property are: "ACTIVE", "NEEDS_ATTENTION", "DELETED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The lifecycle_state of this MediaWorkflow. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this MediaWorkflow. + The current state of the MediaWorkflow. + + + :param lifecycle_state: The lifecycle_state of this MediaWorkflow. + :type: str + """ + allowed_values = ["ACTIVE", "NEEDS_ATTENTION", "DELETED"] + if not value_allowed_none_or_none_sentinel(lifecycle_state, allowed_values): + lifecycle_state = 'UNKNOWN_ENUM_VALUE' + self._lifecycle_state = lifecycle_state + + @property + def lifecyle_details(self): + """ + Gets the lifecyle_details of this MediaWorkflow. + A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. + + + :return: The lifecyle_details of this MediaWorkflow. + :rtype: str + """ + return self._lifecyle_details + + @lifecyle_details.setter + def lifecyle_details(self, lifecyle_details): + """ + Sets the lifecyle_details of this MediaWorkflow. + A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. + + + :param lifecyle_details: The lifecyle_details of this MediaWorkflow. + :type: str + """ + self._lifecyle_details = lifecyle_details + + @property + def version(self): + """ + Gets the version of this MediaWorkflow. + The version of the MediaWorkflow. + + + :return: The version of this MediaWorkflow. + :rtype: int + """ + return self._version + + @version.setter + def version(self, version): + """ + Sets the version of this MediaWorkflow. + The version of the MediaWorkflow. + + + :param version: The version of this MediaWorkflow. + :type: int + """ + self._version = version + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this MediaWorkflow. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :return: The freeform_tags of this MediaWorkflow. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this MediaWorkflow. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :param freeform_tags: The freeform_tags of this MediaWorkflow. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this MediaWorkflow. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this MediaWorkflow. + :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 MediaWorkflow. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this MediaWorkflow. + :type: dict(str, dict(str, object)) + """ + self._defined_tags = defined_tags + + @property + def system_tags(self): + """ + Gets the system_tags of this MediaWorkflow. + 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 MediaWorkflow. + :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 MediaWorkflow. + 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 MediaWorkflow. + :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/media_services/models/media_workflow_collection.py b/src/oci/media_services/models/media_workflow_collection.py new file mode 100644 index 0000000000..ebb1400a2c --- /dev/null +++ b/src/oci/media_services/models/media_workflow_collection.py @@ -0,0 +1,71 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 MediaWorkflowCollection(object): + """ + Results of a MediaWorkflow search. Contains both MediaWorkflowSummary items and other information, such as + metadata. + """ + + def __init__(self, **kwargs): + """ + Initializes a new MediaWorkflowCollection 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 MediaWorkflowCollection. + :type items: list[oci.media_services.models.MediaWorkflowSummary] + + """ + self.swagger_types = { + 'items': 'list[MediaWorkflowSummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this MediaWorkflowCollection. + List of all MediaWorkflows. + + + :return: The items of this MediaWorkflowCollection. + :rtype: list[oci.media_services.models.MediaWorkflowSummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this MediaWorkflowCollection. + List of all MediaWorkflows. + + + :param items: The items of this MediaWorkflowCollection. + :type: list[oci.media_services.models.MediaWorkflowSummary] + """ + 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/media_services/models/media_workflow_configuration.py b/src/oci/media_services/models/media_workflow_configuration.py new file mode 100644 index 0000000000..3e0357de9f --- /dev/null +++ b/src/oci/media_services/models/media_workflow_configuration.py @@ -0,0 +1,408 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 MediaWorkflowConfiguration(object): + """ + Resusable set of values that can be referenced either in a MediaWorkflow or when running a MediaWorkflowJob. + """ + + #: A constant which can be used with the lifecycle_state property of a MediaWorkflowConfiguration. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a MediaWorkflowConfiguration. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" + + def __init__(self, **kwargs): + """ + Initializes a new MediaWorkflowConfiguration 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 MediaWorkflowConfiguration. + :type id: str + + :param display_name: + The value to assign to the display_name property of this MediaWorkflowConfiguration. + :type display_name: str + + :param compartment_id: + The value to assign to the compartment_id property of this MediaWorkflowConfiguration. + :type compartment_id: str + + :param parameters: + The value to assign to the parameters property of this MediaWorkflowConfiguration. + :type parameters: dict(str, str) + + :param time_created: + The value to assign to the time_created property of this MediaWorkflowConfiguration. + :type time_created: datetime + + :param time_updated: + The value to assign to the time_updated property of this MediaWorkflowConfiguration. + :type time_updated: datetime + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this MediaWorkflowConfiguration. + Allowed values for this property are: "ACTIVE", "DELETED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type lifecycle_state: str + + :param lifecyle_details: + The value to assign to the lifecyle_details property of this MediaWorkflowConfiguration. + :type lifecyle_details: str + + :param freeform_tags: + The value to assign to the freeform_tags property of this MediaWorkflowConfiguration. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this MediaWorkflowConfiguration. + :type defined_tags: dict(str, dict(str, object)) + + :param system_tags: + The value to assign to the system_tags property of this MediaWorkflowConfiguration. + :type system_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'id': 'str', + 'display_name': 'str', + 'compartment_id': 'str', + 'parameters': 'dict(str, str)', + 'time_created': 'datetime', + 'time_updated': 'datetime', + 'lifecycle_state': 'str', + 'lifecyle_details': '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', + 'parameters': 'parameters', + 'time_created': 'timeCreated', + 'time_updated': 'timeUpdated', + 'lifecycle_state': 'lifecycleState', + 'lifecyle_details': 'lifecyleDetails', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags', + 'system_tags': 'systemTags' + } + + self._id = None + self._display_name = None + self._compartment_id = None + self._parameters = None + self._time_created = None + self._time_updated = None + self._lifecycle_state = None + self._lifecyle_details = None + self._freeform_tags = None + self._defined_tags = None + self._system_tags = None + + @property + def id(self): + """ + **[Required]** Gets the id of this MediaWorkflowConfiguration. + Unique identifier that is immutable on creation. + + + :return: The id of this MediaWorkflowConfiguration. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this MediaWorkflowConfiguration. + Unique identifier that is immutable on creation. + + + :param id: The id of this MediaWorkflowConfiguration. + :type: str + """ + self._id = id + + @property + def display_name(self): + """ + **[Required]** Gets the display_name of this MediaWorkflowConfiguration. + Display name for the MediaWorkflowConfiguration. + + + :return: The display_name of this MediaWorkflowConfiguration. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this MediaWorkflowConfiguration. + Display name for the MediaWorkflowConfiguration. + + + :param display_name: The display_name of this MediaWorkflowConfiguration. + :type: str + """ + self._display_name = display_name + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this MediaWorkflowConfiguration. + Compartment Identifier. + + + :return: The compartment_id of this MediaWorkflowConfiguration. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this MediaWorkflowConfiguration. + Compartment Identifier. + + + :param compartment_id: The compartment_id of this MediaWorkflowConfiguration. + :type: str + """ + self._compartment_id = compartment_id + + @property + def parameters(self): + """ + **[Required]** Gets the parameters of this MediaWorkflowConfiguration. + Reuseable parameter values encoded as a JSON; the top and second level JSON elements are + objects. Each key of the top level object refer to a task key that is unqiue to the + workflow, each of the second level objects' keys refer to the name of a parameter that is + unique to the task. taskKey -> parameterName -> parameterValue + + + :return: The parameters of this MediaWorkflowConfiguration. + :rtype: dict(str, str) + """ + return self._parameters + + @parameters.setter + def parameters(self, parameters): + """ + Sets the parameters of this MediaWorkflowConfiguration. + Reuseable parameter values encoded as a JSON; the top and second level JSON elements are + objects. Each key of the top level object refer to a task key that is unqiue to the + workflow, each of the second level objects' keys refer to the name of a parameter that is + unique to the task. taskKey -> parameterName -> parameterValue + + + :param parameters: The parameters of this MediaWorkflowConfiguration. + :type: dict(str, str) + """ + self._parameters = parameters + + @property + def time_created(self): + """ + Gets the time_created of this MediaWorkflowConfiguration. + The time when the the MediaWorkflowConfiguration was created. An RFC3339 formatted datetime string. + + + :return: The time_created of this MediaWorkflowConfiguration. + :rtype: datetime + """ + return self._time_created + + @time_created.setter + def time_created(self, time_created): + """ + Sets the time_created of this MediaWorkflowConfiguration. + The time when the the MediaWorkflowConfiguration was created. An RFC3339 formatted datetime string. + + + :param time_created: The time_created of this MediaWorkflowConfiguration. + :type: datetime + """ + self._time_created = time_created + + @property + def time_updated(self): + """ + Gets the time_updated of this MediaWorkflowConfiguration. + The time when the MediaWorkflowConfiguration was updated. An RFC3339 formatted datetime string. + + + :return: The time_updated of this MediaWorkflowConfiguration. + :rtype: datetime + """ + return self._time_updated + + @time_updated.setter + def time_updated(self, time_updated): + """ + Sets the time_updated of this MediaWorkflowConfiguration. + The time when the MediaWorkflowConfiguration was updated. An RFC3339 formatted datetime string. + + + :param time_updated: The time_updated of this MediaWorkflowConfiguration. + :type: datetime + """ + self._time_updated = time_updated + + @property + def lifecycle_state(self): + """ + Gets the lifecycle_state of this MediaWorkflowConfiguration. + The current state of the MediaWorkflowConfiguration. + + Allowed values for this property are: "ACTIVE", "DELETED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The lifecycle_state of this MediaWorkflowConfiguration. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this MediaWorkflowConfiguration. + The current state of the MediaWorkflowConfiguration. + + + :param lifecycle_state: The lifecycle_state of this MediaWorkflowConfiguration. + :type: str + """ + allowed_values = ["ACTIVE", "DELETED"] + if not value_allowed_none_or_none_sentinel(lifecycle_state, allowed_values): + lifecycle_state = 'UNKNOWN_ENUM_VALUE' + self._lifecycle_state = lifecycle_state + + @property + def lifecyle_details(self): + """ + Gets the lifecyle_details of this MediaWorkflowConfiguration. + A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. + + + :return: The lifecyle_details of this MediaWorkflowConfiguration. + :rtype: str + """ + return self._lifecyle_details + + @lifecyle_details.setter + def lifecyle_details(self, lifecyle_details): + """ + Sets the lifecyle_details of this MediaWorkflowConfiguration. + A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. + + + :param lifecyle_details: The lifecyle_details of this MediaWorkflowConfiguration. + :type: str + """ + self._lifecyle_details = lifecyle_details + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this MediaWorkflowConfiguration. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :return: The freeform_tags of this MediaWorkflowConfiguration. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this MediaWorkflowConfiguration. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :param freeform_tags: The freeform_tags of this MediaWorkflowConfiguration. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this MediaWorkflowConfiguration. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this MediaWorkflowConfiguration. + :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 MediaWorkflowConfiguration. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this MediaWorkflowConfiguration. + :type: dict(str, dict(str, object)) + """ + self._defined_tags = defined_tags + + @property + def system_tags(self): + """ + Gets the system_tags of this MediaWorkflowConfiguration. + 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 MediaWorkflowConfiguration. + :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 MediaWorkflowConfiguration. + 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 MediaWorkflowConfiguration. + :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/media_services/models/media_workflow_configuration_collection.py b/src/oci/media_services/models/media_workflow_configuration_collection.py new file mode 100644 index 0000000000..2faf70b28a --- /dev/null +++ b/src/oci/media_services/models/media_workflow_configuration_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 MediaWorkflowConfigurationCollection(object): + """ + Results of a mediaWorkflowConfiguration search. Contains boh MediaWorkflowConfigurationSummary items and other information, such as metadata. + """ + + def __init__(self, **kwargs): + """ + Initializes a new MediaWorkflowConfigurationCollection 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 MediaWorkflowConfigurationCollection. + :type items: list[oci.media_services.models.MediaWorkflowConfigurationSummary] + + """ + self.swagger_types = { + 'items': 'list[MediaWorkflowConfigurationSummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this MediaWorkflowConfigurationCollection. + List of the mediaWorkflowConfigurationSummary objects. + + + :return: The items of this MediaWorkflowConfigurationCollection. + :rtype: list[oci.media_services.models.MediaWorkflowConfigurationSummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this MediaWorkflowConfigurationCollection. + List of the mediaWorkflowConfigurationSummary objects. + + + :param items: The items of this MediaWorkflowConfigurationCollection. + :type: list[oci.media_services.models.MediaWorkflowConfigurationSummary] + """ + 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/media_services/models/media_workflow_configuration_summary.py b/src/oci/media_services/models/media_workflow_configuration_summary.py new file mode 100644 index 0000000000..7b32fecd92 --- /dev/null +++ b/src/oci/media_services/models/media_workflow_configuration_summary.py @@ -0,0 +1,355 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 MediaWorkflowConfigurationSummary(object): + """ + Summary of the MediaWorkflowConfiguration. + """ + + def __init__(self, **kwargs): + """ + Initializes a new MediaWorkflowConfigurationSummary 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 MediaWorkflowConfigurationSummary. + :type id: str + + :param display_name: + The value to assign to the display_name property of this MediaWorkflowConfigurationSummary. + :type display_name: str + + :param compartment_id: + The value to assign to the compartment_id property of this MediaWorkflowConfigurationSummary. + :type compartment_id: str + + :param time_created: + The value to assign to the time_created property of this MediaWorkflowConfigurationSummary. + :type time_created: datetime + + :param time_updated: + The value to assign to the time_updated property of this MediaWorkflowConfigurationSummary. + :type time_updated: datetime + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this MediaWorkflowConfigurationSummary. + :type lifecycle_state: str + + :param lifecycle_details: + The value to assign to the lifecycle_details property of this MediaWorkflowConfigurationSummary. + :type lifecycle_details: str + + :param freeform_tags: + The value to assign to the freeform_tags property of this MediaWorkflowConfigurationSummary. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this MediaWorkflowConfigurationSummary. + :type defined_tags: dict(str, dict(str, object)) + + :param system_tags: + The value to assign to the system_tags property of this MediaWorkflowConfigurationSummary. + :type system_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', + 'lifecycle_details': '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', + 'time_created': 'timeCreated', + 'time_updated': 'timeUpdated', + 'lifecycle_state': 'lifecycleState', + 'lifecycle_details': 'lifecycleDetails', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags', + 'system_tags': 'systemTags' + } + + self._id = None + self._display_name = None + self._compartment_id = None + self._time_created = None + self._time_updated = None + self._lifecycle_state = None + self._lifecycle_details = None + self._freeform_tags = None + self._defined_tags = None + self._system_tags = None + + @property + def id(self): + """ + **[Required]** Gets the id of this MediaWorkflowConfigurationSummary. + Immutable unique identifier for the MediaWorkflowConfiguration. + + + :return: The id of this MediaWorkflowConfigurationSummary. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this MediaWorkflowConfigurationSummary. + Immutable unique identifier for the MediaWorkflowConfiguration. + + + :param id: The id of this MediaWorkflowConfigurationSummary. + :type: str + """ + self._id = id + + @property + def display_name(self): + """ + **[Required]** Gets the display_name of this MediaWorkflowConfigurationSummary. + Name of the MediaWorkflowConfiguration. + + + :return: The display_name of this MediaWorkflowConfigurationSummary. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this MediaWorkflowConfigurationSummary. + Name of the MediaWorkflowConfiguration. + + + :param display_name: The display_name of this MediaWorkflowConfigurationSummary. + :type: str + """ + self._display_name = display_name + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this MediaWorkflowConfigurationSummary. + Compartment identifier + + + :return: The compartment_id of this MediaWorkflowConfigurationSummary. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this MediaWorkflowConfigurationSummary. + Compartment identifier + + + :param compartment_id: The compartment_id of this MediaWorkflowConfigurationSummary. + :type: str + """ + self._compartment_id = compartment_id + + @property + def time_created(self): + """ + Gets the time_created of this MediaWorkflowConfigurationSummary. + The time when the MediaWorkflowConfiguration was created. An RFC3339 formatted datetime string. + + + :return: The time_created of this MediaWorkflowConfigurationSummary. + :rtype: datetime + """ + return self._time_created + + @time_created.setter + def time_created(self, time_created): + """ + Sets the time_created of this MediaWorkflowConfigurationSummary. + The time when the MediaWorkflowConfiguration was created. An RFC3339 formatted datetime string. + + + :param time_created: The time_created of this MediaWorkflowConfigurationSummary. + :type: datetime + """ + self._time_created = time_created + + @property + def time_updated(self): + """ + Gets the time_updated of this MediaWorkflowConfigurationSummary. + The time when the MediaWorkflowConfiguration was updated. An RFC3339 formatted datetime string. + + + :return: The time_updated of this MediaWorkflowConfigurationSummary. + :rtype: datetime + """ + return self._time_updated + + @time_updated.setter + def time_updated(self, time_updated): + """ + Sets the time_updated of this MediaWorkflowConfigurationSummary. + The time when the MediaWorkflowConfiguration was updated. An RFC3339 formatted datetime string. + + + :param time_updated: The time_updated of this MediaWorkflowConfigurationSummary. + :type: datetime + """ + self._time_updated = time_updated + + @property + def lifecycle_state(self): + """ + Gets the lifecycle_state of this MediaWorkflowConfigurationSummary. + The current state of the MediaWorkflowConfiguration. + + + :return: The lifecycle_state of this MediaWorkflowConfigurationSummary. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this MediaWorkflowConfigurationSummary. + The current state of the MediaWorkflowConfiguration. + + + :param lifecycle_state: The lifecycle_state of this MediaWorkflowConfigurationSummary. + :type: str + """ + self._lifecycle_state = lifecycle_state + + @property + def lifecycle_details(self): + """ + Gets the lifecycle_details of this MediaWorkflowConfigurationSummary. + A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. + + + :return: The lifecycle_details of this MediaWorkflowConfigurationSummary. + :rtype: str + """ + return self._lifecycle_details + + @lifecycle_details.setter + def lifecycle_details(self, lifecycle_details): + """ + Sets the lifecycle_details of this MediaWorkflowConfigurationSummary. + A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. + + + :param lifecycle_details: The lifecycle_details of this MediaWorkflowConfigurationSummary. + :type: str + """ + self._lifecycle_details = lifecycle_details + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this MediaWorkflowConfigurationSummary. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :return: The freeform_tags of this MediaWorkflowConfigurationSummary. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this MediaWorkflowConfigurationSummary. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :param freeform_tags: The freeform_tags of this MediaWorkflowConfigurationSummary. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this MediaWorkflowConfigurationSummary. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this MediaWorkflowConfigurationSummary. + :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 MediaWorkflowConfigurationSummary. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this MediaWorkflowConfigurationSummary. + :type: dict(str, dict(str, object)) + """ + self._defined_tags = defined_tags + + @property + def system_tags(self): + """ + Gets the system_tags of this MediaWorkflowConfigurationSummary. + 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 MediaWorkflowConfigurationSummary. + :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 MediaWorkflowConfigurationSummary. + 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 MediaWorkflowConfigurationSummary. + :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/media_services/models/media_workflow_job.py b/src/oci/media_services/models/media_workflow_job.py new file mode 100644 index 0000000000..c02af3fbc2 --- /dev/null +++ b/src/oci/media_services/models/media_workflow_job.py @@ -0,0 +1,649 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 MediaWorkflowJob(object): + """ + A MediaWorkflowJob represents a run of a MediaWorkflow for a specific set of parameters and configurations. + """ + + #: A constant which can be used with the lifecycle_state property of a MediaWorkflowJob. + #: This constant has a value of "ACCEPTED" + LIFECYCLE_STATE_ACCEPTED = "ACCEPTED" + + #: A constant which can be used with the lifecycle_state property of a MediaWorkflowJob. + #: This constant has a value of "IN_PROGRESS" + LIFECYCLE_STATE_IN_PROGRESS = "IN_PROGRESS" + + #: A constant which can be used with the lifecycle_state property of a MediaWorkflowJob. + #: This constant has a value of "WAITING" + LIFECYCLE_STATE_WAITING = "WAITING" + + #: A constant which can be used with the lifecycle_state property of a MediaWorkflowJob. + #: This constant has a value of "FAILED" + LIFECYCLE_STATE_FAILED = "FAILED" + + #: A constant which can be used with the lifecycle_state property of a MediaWorkflowJob. + #: This constant has a value of "SUCCEEDED" + LIFECYCLE_STATE_SUCCEEDED = "SUCCEEDED" + + #: A constant which can be used with the lifecycle_state property of a MediaWorkflowJob. + #: This constant has a value of "CANCELING" + LIFECYCLE_STATE_CANCELING = "CANCELING" + + #: A constant which can be used with the lifecycle_state property of a MediaWorkflowJob. + #: This constant has a value of "CANCELED" + LIFECYCLE_STATE_CANCELED = "CANCELED" + + def __init__(self, **kwargs): + """ + Initializes a new MediaWorkflowJob object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param media_workflow_configuration_ids: + The value to assign to the media_workflow_configuration_ids property of this MediaWorkflowJob. + :type media_workflow_configuration_ids: list[str] + + :param media_workflow_id: + The value to assign to the media_workflow_id property of this MediaWorkflowJob. + :type media_workflow_id: str + + :param id: + The value to assign to the id property of this MediaWorkflowJob. + :type id: str + + :param compartment_id: + The value to assign to the compartment_id property of this MediaWorkflowJob. + :type compartment_id: str + + :param display_name: + The value to assign to the display_name property of this MediaWorkflowJob. + :type display_name: str + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this MediaWorkflowJob. + Allowed values for this property are: "ACCEPTED", "IN_PROGRESS", "WAITING", "FAILED", "SUCCEEDED", "CANCELING", "CANCELED", '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 MediaWorkflowJob. + :type lifecycle_details: str + + :param task_lifecycle_state: + The value to assign to the task_lifecycle_state property of this MediaWorkflowJob. + :type task_lifecycle_state: list[oci.media_services.models.MediaWorkflowTaskState] + + :param parameters: + The value to assign to the parameters property of this MediaWorkflowJob. + :type parameters: dict(str, str) + + :param time_created: + The value to assign to the time_created property of this MediaWorkflowJob. + :type time_created: datetime + + :param time_updated: + The value to assign to the time_updated property of this MediaWorkflowJob. + :type time_updated: datetime + + :param runnable: + The value to assign to the runnable property of this MediaWorkflowJob. + :type runnable: dict(str, str) + + :param outputs: + The value to assign to the outputs property of this MediaWorkflowJob. + :type outputs: list[oci.media_services.models.JobOutput] + + :param time_started: + The value to assign to the time_started property of this MediaWorkflowJob. + :type time_started: datetime + + :param time_ended: + The value to assign to the time_ended property of this MediaWorkflowJob. + :type time_ended: datetime + + :param freeform_tags: + The value to assign to the freeform_tags property of this MediaWorkflowJob. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this MediaWorkflowJob. + :type defined_tags: dict(str, dict(str, object)) + + :param system_tags: + The value to assign to the system_tags property of this MediaWorkflowJob. + :type system_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'media_workflow_configuration_ids': 'list[str]', + 'media_workflow_id': 'str', + 'id': 'str', + 'compartment_id': 'str', + 'display_name': 'str', + 'lifecycle_state': 'str', + 'lifecycle_details': 'str', + 'task_lifecycle_state': 'list[MediaWorkflowTaskState]', + 'parameters': 'dict(str, str)', + 'time_created': 'datetime', + 'time_updated': 'datetime', + 'runnable': 'dict(str, str)', + 'outputs': 'list[JobOutput]', + 'time_started': 'datetime', + 'time_ended': 'datetime', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))', + 'system_tags': 'dict(str, dict(str, object))' + } + + self.attribute_map = { + 'media_workflow_configuration_ids': 'mediaWorkflowConfigurationIds', + 'media_workflow_id': 'mediaWorkflowId', + 'id': 'id', + 'compartment_id': 'compartmentId', + 'display_name': 'displayName', + 'lifecycle_state': 'lifecycleState', + 'lifecycle_details': 'lifecycleDetails', + 'task_lifecycle_state': 'taskLifecycleState', + 'parameters': 'parameters', + 'time_created': 'timeCreated', + 'time_updated': 'timeUpdated', + 'runnable': 'runnable', + 'outputs': 'outputs', + 'time_started': 'timeStarted', + 'time_ended': 'timeEnded', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags', + 'system_tags': 'systemTags' + } + + self._media_workflow_configuration_ids = None + self._media_workflow_id = None + self._id = None + self._compartment_id = None + self._display_name = None + self._lifecycle_state = None + self._lifecycle_details = None + self._task_lifecycle_state = None + self._parameters = None + self._time_created = None + self._time_updated = None + self._runnable = None + self._outputs = None + self._time_started = None + self._time_ended = None + self._freeform_tags = None + self._defined_tags = None + self._system_tags = None + + @property + def media_workflow_configuration_ids(self): + """ + Gets the media_workflow_configuration_ids of this MediaWorkflowJob. + Configurations to be applied to this run of the workflow. + + + :return: The media_workflow_configuration_ids of this MediaWorkflowJob. + :rtype: list[str] + """ + return self._media_workflow_configuration_ids + + @media_workflow_configuration_ids.setter + def media_workflow_configuration_ids(self, media_workflow_configuration_ids): + """ + Sets the media_workflow_configuration_ids of this MediaWorkflowJob. + Configurations to be applied to this run of the workflow. + + + :param media_workflow_configuration_ids: The media_workflow_configuration_ids of this MediaWorkflowJob. + :type: list[str] + """ + self._media_workflow_configuration_ids = media_workflow_configuration_ids + + @property + def media_workflow_id(self): + """ + **[Required]** Gets the media_workflow_id of this MediaWorkflowJob. + The workflow to execute. + + + :return: The media_workflow_id of this MediaWorkflowJob. + :rtype: str + """ + return self._media_workflow_id + + @media_workflow_id.setter + def media_workflow_id(self, media_workflow_id): + """ + Sets the media_workflow_id of this MediaWorkflowJob. + The workflow to execute. + + + :param media_workflow_id: The media_workflow_id of this MediaWorkflowJob. + :type: str + """ + self._media_workflow_id = media_workflow_id + + @property + def id(self): + """ + **[Required]** Gets the id of this MediaWorkflowJob. + Unique identifier for this run of the workflow. + + + :return: The id of this MediaWorkflowJob. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this MediaWorkflowJob. + Unique identifier for this run of the workflow. + + + :param id: The id of this MediaWorkflowJob. + :type: str + """ + self._id = id + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this MediaWorkflowJob. + Compartment Identifier. + + + :return: The compartment_id of this MediaWorkflowJob. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this MediaWorkflowJob. + Compartment Identifier. + + + :param compartment_id: The compartment_id of this MediaWorkflowJob. + :type: str + """ + self._compartment_id = compartment_id + + @property + def display_name(self): + """ + Gets the display_name of this MediaWorkflowJob. + Name of the Media Workflow Job. Does not have to be unique. Avoid entering confidential information. + + + :return: The display_name of this MediaWorkflowJob. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this MediaWorkflowJob. + Name of the Media Workflow Job. Does not have to be unique. Avoid entering confidential information. + + + :param display_name: The display_name of this MediaWorkflowJob. + :type: str + """ + self._display_name = display_name + + @property + def lifecycle_state(self): + """ + Gets the lifecycle_state of this MediaWorkflowJob. + The current state of the MediaWorkflowJob. + + Allowed values for this property are: "ACCEPTED", "IN_PROGRESS", "WAITING", "FAILED", "SUCCEEDED", "CANCELING", "CANCELED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The lifecycle_state of this MediaWorkflowJob. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this MediaWorkflowJob. + The current state of the MediaWorkflowJob. + + + :param lifecycle_state: The lifecycle_state of this MediaWorkflowJob. + :type: str + """ + allowed_values = ["ACCEPTED", "IN_PROGRESS", "WAITING", "FAILED", "SUCCEEDED", "CANCELING", "CANCELED"] + 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 MediaWorkflowJob. + The lifecyle details. + + + :return: The lifecycle_details of this MediaWorkflowJob. + :rtype: str + """ + return self._lifecycle_details + + @lifecycle_details.setter + def lifecycle_details(self, lifecycle_details): + """ + Sets the lifecycle_details of this MediaWorkflowJob. + The lifecyle details. + + + :param lifecycle_details: The lifecycle_details of this MediaWorkflowJob. + :type: str + """ + self._lifecycle_details = lifecycle_details + + @property + def task_lifecycle_state(self): + """ + Gets the task_lifecycle_state of this MediaWorkflowJob. + Status of each task. + + + :return: The task_lifecycle_state of this MediaWorkflowJob. + :rtype: list[oci.media_services.models.MediaWorkflowTaskState] + """ + return self._task_lifecycle_state + + @task_lifecycle_state.setter + def task_lifecycle_state(self, task_lifecycle_state): + """ + Sets the task_lifecycle_state of this MediaWorkflowJob. + Status of each task. + + + :param task_lifecycle_state: The task_lifecycle_state of this MediaWorkflowJob. + :type: list[oci.media_services.models.MediaWorkflowTaskState] + """ + self._task_lifecycle_state = task_lifecycle_state + + @property + def parameters(self): + """ + Gets the parameters of this MediaWorkflowJob. + Parameters that override parameters specified in MediaWorkflowTaskDeclarations, the MediaWorkflow, + the MediaWorkflow's MediaWorkflowConfigurations and the MediaWorkflowConfigurations of this + MediaWorkflowJob. The parameters are given as JSON. The top level and 2nd level elements must be + JSON objects (vs arrays, scalars, etc). The top level keys refer to a task's key and the 2nd level + keys refer to a parameter's name. + + + :return: The parameters of this MediaWorkflowJob. + :rtype: dict(str, str) + """ + return self._parameters + + @parameters.setter + def parameters(self, parameters): + """ + Sets the parameters of this MediaWorkflowJob. + Parameters that override parameters specified in MediaWorkflowTaskDeclarations, the MediaWorkflow, + the MediaWorkflow's MediaWorkflowConfigurations and the MediaWorkflowConfigurations of this + MediaWorkflowJob. The parameters are given as JSON. The top level and 2nd level elements must be + JSON objects (vs arrays, scalars, etc). The top level keys refer to a task's key and the 2nd level + keys refer to a parameter's name. + + + :param parameters: The parameters of this MediaWorkflowJob. + :type: dict(str, str) + """ + self._parameters = parameters + + @property + def time_created(self): + """ + Gets the time_created of this MediaWorkflowJob. + Creation time of the job. An RFC3339 formatted datetime string. + + + :return: The time_created of this MediaWorkflowJob. + :rtype: datetime + """ + return self._time_created + + @time_created.setter + def time_created(self, time_created): + """ + Sets the time_created of this MediaWorkflowJob. + Creation time of the job. An RFC3339 formatted datetime string. + + + :param time_created: The time_created of this MediaWorkflowJob. + :type: datetime + """ + self._time_created = time_created + + @property + def time_updated(self): + """ + Gets the time_updated of this MediaWorkflowJob. + Updated time of the job. An RFC3339 formatted datetime string. + + + :return: The time_updated of this MediaWorkflowJob. + :rtype: datetime + """ + return self._time_updated + + @time_updated.setter + def time_updated(self, time_updated): + """ + Sets the time_updated of this MediaWorkflowJob. + Updated time of the job. An RFC3339 formatted datetime string. + + + :param time_updated: The time_updated of this MediaWorkflowJob. + :type: datetime + """ + self._time_updated = time_updated + + @property + def runnable(self): + """ + Gets the runnable of this MediaWorkflowJob. + A JSON representation of the job as it will be run by the system. All the task declarations, configurations + and parameters are merged. Parameter values are all fully resolved. + + + :return: The runnable of this MediaWorkflowJob. + :rtype: dict(str, str) + """ + return self._runnable + + @runnable.setter + def runnable(self, runnable): + """ + Sets the runnable of this MediaWorkflowJob. + A JSON representation of the job as it will be run by the system. All the task declarations, configurations + and parameters are merged. Parameter values are all fully resolved. + + + :param runnable: The runnable of this MediaWorkflowJob. + :type: dict(str, str) + """ + self._runnable = runnable + + @property + def outputs(self): + """ + Gets the outputs of this MediaWorkflowJob. + A list of JobOutput for the workflowJob. + + + :return: The outputs of this MediaWorkflowJob. + :rtype: list[oci.media_services.models.JobOutput] + """ + return self._outputs + + @outputs.setter + def outputs(self, outputs): + """ + Sets the outputs of this MediaWorkflowJob. + A list of JobOutput for the workflowJob. + + + :param outputs: The outputs of this MediaWorkflowJob. + :type: list[oci.media_services.models.JobOutput] + """ + self._outputs = outputs + + @property + def time_started(self): + """ + Gets the time_started of this MediaWorkflowJob. + Time when the job started to execute. An RFC3339 formatted datetime string. + + + :return: The time_started of this MediaWorkflowJob. + :rtype: datetime + """ + return self._time_started + + @time_started.setter + def time_started(self, time_started): + """ + Sets the time_started of this MediaWorkflowJob. + Time when the job started to execute. An RFC3339 formatted datetime string. + + + :param time_started: The time_started of this MediaWorkflowJob. + :type: datetime + """ + self._time_started = time_started + + @property + def time_ended(self): + """ + Gets the time_ended of this MediaWorkflowJob. + Time when the job finished. An RFC3339 formatted datetime string. + + + :return: The time_ended of this MediaWorkflowJob. + :rtype: datetime + """ + return self._time_ended + + @time_ended.setter + def time_ended(self, time_ended): + """ + Sets the time_ended of this MediaWorkflowJob. + Time when the job finished. An RFC3339 formatted datetime string. + + + :param time_ended: The time_ended of this MediaWorkflowJob. + :type: datetime + """ + self._time_ended = time_ended + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this MediaWorkflowJob. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :return: The freeform_tags of this MediaWorkflowJob. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this MediaWorkflowJob. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :param freeform_tags: The freeform_tags of this MediaWorkflowJob. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this MediaWorkflowJob. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this MediaWorkflowJob. + :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 MediaWorkflowJob. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this MediaWorkflowJob. + :type: dict(str, dict(str, object)) + """ + self._defined_tags = defined_tags + + @property + def system_tags(self): + """ + Gets the system_tags of this MediaWorkflowJob. + 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 MediaWorkflowJob. + :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 MediaWorkflowJob. + 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 MediaWorkflowJob. + :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/media_services/models/media_workflow_job_collection.py b/src/oci/media_services/models/media_workflow_job_collection.py new file mode 100644 index 0000000000..294e6b5397 --- /dev/null +++ b/src/oci/media_services/models/media_workflow_job_collection.py @@ -0,0 +1,71 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 MediaWorkflowJobCollection(object): + """ + Results of a mediaWorkflowJob search, a list of MediaWorkflowJobSummary items and metadata of the + search. + """ + + def __init__(self, **kwargs): + """ + Initializes a new MediaWorkflowJobCollection 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 MediaWorkflowJobCollection. + :type items: list[oci.media_services.models.MediaWorkflowJobSummary] + + """ + self.swagger_types = { + 'items': 'list[MediaWorkflowJobSummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this MediaWorkflowJobCollection. + List of mediaWorkflowJob items. + + + :return: The items of this MediaWorkflowJobCollection. + :rtype: list[oci.media_services.models.MediaWorkflowJobSummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this MediaWorkflowJobCollection. + List of mediaWorkflowJob items. + + + :param items: The items of this MediaWorkflowJobCollection. + :type: list[oci.media_services.models.MediaWorkflowJobSummary] + """ + 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/media_services/models/media_workflow_job_fact.py b/src/oci/media_services/models/media_workflow_job_fact.py new file mode 100644 index 0000000000..2e0a7fd874 --- /dev/null +++ b/src/oci/media_services/models/media_workflow_job_fact.py @@ -0,0 +1,196 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 MediaWorkflowJobFact(object): + """ + One fact of a list of facts associated to a MediaWorkflowJob that presents a point-in-time + snapshot of the resources, data and events that were composed to generate a runnable job. + This information will be used internally to trouble-shoot problematic workflows or jobs. + """ + + def __init__(self, **kwargs): + """ + Initializes a new MediaWorkflowJobFact object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param media_workflow_job_id: + The value to assign to the media_workflow_job_id property of this MediaWorkflowJobFact. + :type media_workflow_job_id: str + + :param key: + The value to assign to the key property of this MediaWorkflowJobFact. + :type key: int + + :param name: + The value to assign to the name property of this MediaWorkflowJobFact. + :type name: str + + :param type: + The value to assign to the type property of this MediaWorkflowJobFact. + :type type: str + + :param detail: + The value to assign to the detail property of this MediaWorkflowJobFact. + :type detail: dict(str, str) + + """ + self.swagger_types = { + 'media_workflow_job_id': 'str', + 'key': 'int', + 'name': 'str', + 'type': 'str', + 'detail': 'dict(str, str)' + } + + self.attribute_map = { + 'media_workflow_job_id': 'mediaWorkflowJobId', + 'key': 'key', + 'name': 'name', + 'type': 'type', + 'detail': 'detail' + } + + self._media_workflow_job_id = None + self._key = None + self._name = None + self._type = None + self._detail = None + + @property + def media_workflow_job_id(self): + """ + **[Required]** Gets the media_workflow_job_id of this MediaWorkflowJobFact. + Reference to the parent job. + + + :return: The media_workflow_job_id of this MediaWorkflowJobFact. + :rtype: str + """ + return self._media_workflow_job_id + + @media_workflow_job_id.setter + def media_workflow_job_id(self, media_workflow_job_id): + """ + Sets the media_workflow_job_id of this MediaWorkflowJobFact. + Reference to the parent job. + + + :param media_workflow_job_id: The media_workflow_job_id of this MediaWorkflowJobFact. + :type: str + """ + self._media_workflow_job_id = media_workflow_job_id + + @property + def key(self): + """ + **[Required]** Gets the key of this MediaWorkflowJobFact. + System generated serial number to uniquely identify a detail in order within a MediaWorkflowJob. + + + :return: The key of this MediaWorkflowJobFact. + :rtype: int + """ + return self._key + + @key.setter + def key(self, key): + """ + Sets the key of this MediaWorkflowJobFact. + System generated serial number to uniquely identify a detail in order within a MediaWorkflowJob. + + + :param key: The key of this MediaWorkflowJobFact. + :type: int + """ + self._key = key + + @property + def name(self): + """ + **[Required]** Gets the name of this MediaWorkflowJobFact. + Unique name. It is read-only and generated for the fact. + + + :return: The name of this MediaWorkflowJobFact. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this MediaWorkflowJobFact. + Unique name. It is read-only and generated for the fact. + + + :param name: The name of this MediaWorkflowJobFact. + :type: str + """ + self._name = name + + @property + def type(self): + """ + **[Required]** Gets the type of this MediaWorkflowJobFact. + The type of information contained in this detail. + + + :return: The type of this MediaWorkflowJobFact. + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """ + Sets the type of this MediaWorkflowJobFact. + The type of information contained in this detail. + + + :param type: The type of this MediaWorkflowJobFact. + :type: str + """ + self._type = type + + @property + def detail(self): + """ + **[Required]** Gets the detail of this MediaWorkflowJobFact. + The body of the detail captured as JSON. + + + :return: The detail of this MediaWorkflowJobFact. + :rtype: dict(str, str) + """ + return self._detail + + @detail.setter + def detail(self, detail): + """ + Sets the detail of this MediaWorkflowJobFact. + The body of the detail captured as JSON. + + + :param detail: The detail of this MediaWorkflowJobFact. + :type: dict(str, str) + """ + self._detail = detail + + 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/media_services/models/media_workflow_job_fact_collection.py b/src/oci/media_services/models/media_workflow_job_fact_collection.py new file mode 100644 index 0000000000..0dbddccfdf --- /dev/null +++ b/src/oci/media_services/models/media_workflow_job_fact_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 MediaWorkflowJobFactCollection(object): + """ + Results of a jobDetail search, a list of MediaWorkflowJobFacts items and metadata of the search. + """ + + def __init__(self, **kwargs): + """ + Initializes a new MediaWorkflowJobFactCollection 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 MediaWorkflowJobFactCollection. + :type items: list[oci.media_services.models.MediaWorkflowJobFactSummary] + + """ + self.swagger_types = { + 'items': 'list[MediaWorkflowJobFactSummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this MediaWorkflowJobFactCollection. + List of mediaWorkflowJob items. + + + :return: The items of this MediaWorkflowJobFactCollection. + :rtype: list[oci.media_services.models.MediaWorkflowJobFactSummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this MediaWorkflowJobFactCollection. + List of mediaWorkflowJob items. + + + :param items: The items of this MediaWorkflowJobFactCollection. + :type: list[oci.media_services.models.MediaWorkflowJobFactSummary] + """ + 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/media_services/models/media_workflow_job_fact_summary.py b/src/oci/media_services/models/media_workflow_job_fact_summary.py new file mode 100644 index 0000000000..4273fd443c --- /dev/null +++ b/src/oci/media_services/models/media_workflow_job_fact_summary.py @@ -0,0 +1,163 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 MediaWorkflowJobFactSummary(object): + """ + Summary of a MediaWorkflowJobFact + """ + + def __init__(self, **kwargs): + """ + Initializes a new MediaWorkflowJobFactSummary object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param media_workflow_job_id: + The value to assign to the media_workflow_job_id property of this MediaWorkflowJobFactSummary. + :type media_workflow_job_id: str + + :param key: + The value to assign to the key property of this MediaWorkflowJobFactSummary. + :type key: int + + :param name: + The value to assign to the name property of this MediaWorkflowJobFactSummary. + :type name: str + + :param type: + The value to assign to the type property of this MediaWorkflowJobFactSummary. + :type type: str + + """ + self.swagger_types = { + 'media_workflow_job_id': 'str', + 'key': 'int', + 'name': 'str', + 'type': 'str' + } + + self.attribute_map = { + 'media_workflow_job_id': 'mediaWorkflowJobId', + 'key': 'key', + 'name': 'name', + 'type': 'type' + } + + self._media_workflow_job_id = None + self._key = None + self._name = None + self._type = None + + @property + def media_workflow_job_id(self): + """ + **[Required]** Gets the media_workflow_job_id of this MediaWorkflowJobFactSummary. + Reference to the parent job. + + + :return: The media_workflow_job_id of this MediaWorkflowJobFactSummary. + :rtype: str + """ + return self._media_workflow_job_id + + @media_workflow_job_id.setter + def media_workflow_job_id(self, media_workflow_job_id): + """ + Sets the media_workflow_job_id of this MediaWorkflowJobFactSummary. + Reference to the parent job. + + + :param media_workflow_job_id: The media_workflow_job_id of this MediaWorkflowJobFactSummary. + :type: str + """ + self._media_workflow_job_id = media_workflow_job_id + + @property + def key(self): + """ + **[Required]** Gets the key of this MediaWorkflowJobFactSummary. + System generated serial number to uniquely identify a detail in order within a MediaWorkflowJob. + + + :return: The key of this MediaWorkflowJobFactSummary. + :rtype: int + """ + return self._key + + @key.setter + def key(self, key): + """ + Sets the key of this MediaWorkflowJobFactSummary. + System generated serial number to uniquely identify a detail in order within a MediaWorkflowJob. + + + :param key: The key of this MediaWorkflowJobFactSummary. + :type: int + """ + self._key = key + + @property + def name(self): + """ + **[Required]** Gets the name of this MediaWorkflowJobFactSummary. + Unique name. It is read-only and generated for the fact. + + + :return: The name of this MediaWorkflowJobFactSummary. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this MediaWorkflowJobFactSummary. + Unique name. It is read-only and generated for the fact. + + + :param name: The name of this MediaWorkflowJobFactSummary. + :type: str + """ + self._name = name + + @property + def type(self): + """ + **[Required]** Gets the type of this MediaWorkflowJobFactSummary. + The type of information contained in this detail. + + + :return: The type of this MediaWorkflowJobFactSummary. + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """ + Sets the type of this MediaWorkflowJobFactSummary. + The type of information contained in this detail. + + + :param type: The type of this MediaWorkflowJobFactSummary. + :type: str + """ + 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/media_services/models/media_workflow_job_summary.py b/src/oci/media_services/models/media_workflow_job_summary.py new file mode 100644 index 0000000000..f93c9ebb10 --- /dev/null +++ b/src/oci/media_services/models/media_workflow_job_summary.py @@ -0,0 +1,355 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 MediaWorkflowJobSummary(object): + """ + Summary of a MediaWorkflowJob. + """ + + def __init__(self, **kwargs): + """ + Initializes a new MediaWorkflowJobSummary object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param media_workflow_id: + The value to assign to the media_workflow_id property of this MediaWorkflowJobSummary. + :type media_workflow_id: str + + :param id: + The value to assign to the id property of this MediaWorkflowJobSummary. + :type id: str + + :param display_name: + The value to assign to the display_name property of this MediaWorkflowJobSummary. + :type display_name: str + + :param time_created: + The value to assign to the time_created property of this MediaWorkflowJobSummary. + :type time_created: datetime + + :param time_updated: + The value to assign to the time_updated property of this MediaWorkflowJobSummary. + :type time_updated: datetime + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this MediaWorkflowJobSummary. + :type lifecycle_state: str + + :param lifecycle_details: + The value to assign to the lifecycle_details property of this MediaWorkflowJobSummary. + :type lifecycle_details: str + + :param freeform_tags: + The value to assign to the freeform_tags property of this MediaWorkflowJobSummary. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this MediaWorkflowJobSummary. + :type defined_tags: dict(str, dict(str, object)) + + :param system_tags: + The value to assign to the system_tags property of this MediaWorkflowJobSummary. + :type system_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'media_workflow_id': 'str', + 'id': 'str', + 'display_name': 'str', + 'time_created': 'datetime', + 'time_updated': 'datetime', + 'lifecycle_state': 'str', + 'lifecycle_details': 'str', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))', + 'system_tags': 'dict(str, dict(str, object))' + } + + self.attribute_map = { + 'media_workflow_id': 'mediaWorkflowId', + 'id': 'id', + 'display_name': 'displayName', + 'time_created': 'timeCreated', + 'time_updated': 'timeUpdated', + 'lifecycle_state': 'lifecycleState', + 'lifecycle_details': 'lifecycleDetails', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags', + 'system_tags': 'systemTags' + } + + self._media_workflow_id = None + self._id = None + self._display_name = None + self._time_created = None + self._time_updated = None + self._lifecycle_state = None + self._lifecycle_details = None + self._freeform_tags = None + self._defined_tags = None + self._system_tags = None + + @property + def media_workflow_id(self): + """ + Gets the media_workflow_id of this MediaWorkflowJobSummary. + The workflow to execute. + + + :return: The media_workflow_id of this MediaWorkflowJobSummary. + :rtype: str + """ + return self._media_workflow_id + + @media_workflow_id.setter + def media_workflow_id(self, media_workflow_id): + """ + Sets the media_workflow_id of this MediaWorkflowJobSummary. + The workflow to execute. + + + :param media_workflow_id: The media_workflow_id of this MediaWorkflowJobSummary. + :type: str + """ + self._media_workflow_id = media_workflow_id + + @property + def id(self): + """ + Gets the id of this MediaWorkflowJobSummary. + Unique identifier for this job. + + + :return: The id of this MediaWorkflowJobSummary. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this MediaWorkflowJobSummary. + Unique identifier for this job. + + + :param id: The id of this MediaWorkflowJobSummary. + :type: str + """ + self._id = id + + @property + def display_name(self): + """ + Gets the display_name of this MediaWorkflowJobSummary. + Name of the Media Workflow Job. Does not have to be unique. Avoid entering confidential information. + + + :return: The display_name of this MediaWorkflowJobSummary. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this MediaWorkflowJobSummary. + Name of the Media Workflow Job. Does not have to be unique. Avoid entering confidential information. + + + :param display_name: The display_name of this MediaWorkflowJobSummary. + :type: str + """ + self._display_name = display_name + + @property + def time_created(self): + """ + Gets the time_created of this MediaWorkflowJobSummary. + Creation time of the job. An RFC3339 formatted datetime string. + + + :return: The time_created of this MediaWorkflowJobSummary. + :rtype: datetime + """ + return self._time_created + + @time_created.setter + def time_created(self, time_created): + """ + Sets the time_created of this MediaWorkflowJobSummary. + Creation time of the job. An RFC3339 formatted datetime string. + + + :param time_created: The time_created of this MediaWorkflowJobSummary. + :type: datetime + """ + self._time_created = time_created + + @property + def time_updated(self): + """ + Gets the time_updated of this MediaWorkflowJobSummary. + Updated time of the job. An RFC3339 formatted datetime string. + + + :return: The time_updated of this MediaWorkflowJobSummary. + :rtype: datetime + """ + return self._time_updated + + @time_updated.setter + def time_updated(self, time_updated): + """ + Sets the time_updated of this MediaWorkflowJobSummary. + Updated time of the job. An RFC3339 formatted datetime string. + + + :param time_updated: The time_updated of this MediaWorkflowJobSummary. + :type: datetime + """ + self._time_updated = time_updated + + @property + def lifecycle_state(self): + """ + Gets the lifecycle_state of this MediaWorkflowJobSummary. + The current state of the MediaWorkflowJob. + + + :return: The lifecycle_state of this MediaWorkflowJobSummary. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this MediaWorkflowJobSummary. + The current state of the MediaWorkflowJob. + + + :param lifecycle_state: The lifecycle_state of this MediaWorkflowJobSummary. + :type: str + """ + self._lifecycle_state = lifecycle_state + + @property + def lifecycle_details(self): + """ + Gets the lifecycle_details of this MediaWorkflowJobSummary. + The lifecyle details. + + + :return: The lifecycle_details of this MediaWorkflowJobSummary. + :rtype: str + """ + return self._lifecycle_details + + @lifecycle_details.setter + def lifecycle_details(self, lifecycle_details): + """ + Sets the lifecycle_details of this MediaWorkflowJobSummary. + The lifecyle details. + + + :param lifecycle_details: The lifecycle_details of this MediaWorkflowJobSummary. + :type: str + """ + self._lifecycle_details = lifecycle_details + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this MediaWorkflowJobSummary. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :return: The freeform_tags of this MediaWorkflowJobSummary. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this MediaWorkflowJobSummary. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :param freeform_tags: The freeform_tags of this MediaWorkflowJobSummary. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this MediaWorkflowJobSummary. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this MediaWorkflowJobSummary. + :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 MediaWorkflowJobSummary. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this MediaWorkflowJobSummary. + :type: dict(str, dict(str, object)) + """ + self._defined_tags = defined_tags + + @property + def system_tags(self): + """ + Gets the system_tags of this MediaWorkflowJobSummary. + 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 MediaWorkflowJobSummary. + :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 MediaWorkflowJobSummary. + 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 MediaWorkflowJobSummary. + :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/media_services/models/media_workflow_summary.py b/src/oci/media_services/models/media_workflow_summary.py new file mode 100644 index 0000000000..562c6593ec --- /dev/null +++ b/src/oci/media_services/models/media_workflow_summary.py @@ -0,0 +1,386 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 MediaWorkflowSummary(object): + """ + Summary of the MediaWorkflow. + """ + + def __init__(self, **kwargs): + """ + Initializes a new MediaWorkflowSummary 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 MediaWorkflowSummary. + :type id: str + + :param display_name: + The value to assign to the display_name property of this MediaWorkflowSummary. + :type display_name: str + + :param compartment_id: + The value to assign to the compartment_id property of this MediaWorkflowSummary. + :type compartment_id: str + + :param time_created: + The value to assign to the time_created property of this MediaWorkflowSummary. + :type time_created: datetime + + :param time_updated: + The value to assign to the time_updated property of this MediaWorkflowSummary. + :type time_updated: datetime + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this MediaWorkflowSummary. + :type lifecycle_state: str + + :param lifecycle_details: + The value to assign to the lifecycle_details property of this MediaWorkflowSummary. + :type lifecycle_details: str + + :param version: + The value to assign to the version property of this MediaWorkflowSummary. + :type version: int + + :param freeform_tags: + The value to assign to the freeform_tags property of this MediaWorkflowSummary. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this MediaWorkflowSummary. + :type defined_tags: dict(str, dict(str, object)) + + :param system_tags: + The value to assign to the system_tags property of this MediaWorkflowSummary. + :type system_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', + 'lifecycle_details': 'str', + 'version': 'int', + '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', + 'time_created': 'timeCreated', + 'time_updated': 'timeUpdated', + 'lifecycle_state': 'lifecycleState', + 'lifecycle_details': 'lifecycleDetails', + 'version': 'version', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags', + 'system_tags': 'systemTags' + } + + self._id = None + self._display_name = None + self._compartment_id = None + self._time_created = None + self._time_updated = None + self._lifecycle_state = None + self._lifecycle_details = None + self._version = None + self._freeform_tags = None + self._defined_tags = None + self._system_tags = None + + @property + def id(self): + """ + **[Required]** Gets the id of this MediaWorkflowSummary. + Unique identifier that is immutable on creation. + + + :return: The id of this MediaWorkflowSummary. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this MediaWorkflowSummary. + Unique identifier that is immutable on creation. + + + :param id: The id of this MediaWorkflowSummary. + :type: str + """ + self._id = id + + @property + def display_name(self): + """ + Gets the display_name of this MediaWorkflowSummary. + Name for the MediaWorkflow. Does not have to be unique, and it's changeable. Avoid entering confidential information. + + + :return: The display_name of this MediaWorkflowSummary. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this MediaWorkflowSummary. + Name for the MediaWorkflow. Does not have to be unique, and it's changeable. Avoid entering confidential information. + + + :param display_name: The display_name of this MediaWorkflowSummary. + :type: str + """ + self._display_name = display_name + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this MediaWorkflowSummary. + Compartment Identifier. + + + :return: The compartment_id of this MediaWorkflowSummary. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this MediaWorkflowSummary. + Compartment Identifier. + + + :param compartment_id: The compartment_id of this MediaWorkflowSummary. + :type: str + """ + self._compartment_id = compartment_id + + @property + def time_created(self): + """ + Gets the time_created of this MediaWorkflowSummary. + The time when the MediaWorkflow was created. An RFC3339 formatted datetime string. + + + :return: The time_created of this MediaWorkflowSummary. + :rtype: datetime + """ + return self._time_created + + @time_created.setter + def time_created(self, time_created): + """ + Sets the time_created of this MediaWorkflowSummary. + The time when the MediaWorkflow was created. An RFC3339 formatted datetime string. + + + :param time_created: The time_created of this MediaWorkflowSummary. + :type: datetime + """ + self._time_created = time_created + + @property + def time_updated(self): + """ + Gets the time_updated of this MediaWorkflowSummary. + The time when the MediaWorkflow was updated. An RFC3339 formatted datetime string. + + + :return: The time_updated of this MediaWorkflowSummary. + :rtype: datetime + """ + return self._time_updated + + @time_updated.setter + def time_updated(self, time_updated): + """ + Sets the time_updated of this MediaWorkflowSummary. + The time when the MediaWorkflow was updated. An RFC3339 formatted datetime string. + + + :param time_updated: The time_updated of this MediaWorkflowSummary. + :type: datetime + """ + self._time_updated = time_updated + + @property + def lifecycle_state(self): + """ + Gets the lifecycle_state of this MediaWorkflowSummary. + The current state of the MediaWorkflow. + + + :return: The lifecycle_state of this MediaWorkflowSummary. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this MediaWorkflowSummary. + The current state of the MediaWorkflow. + + + :param lifecycle_state: The lifecycle_state of this MediaWorkflowSummary. + :type: str + """ + self._lifecycle_state = lifecycle_state + + @property + def lifecycle_details(self): + """ + Gets the lifecycle_details of this MediaWorkflowSummary. + A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. + + + :return: The lifecycle_details of this MediaWorkflowSummary. + :rtype: str + """ + return self._lifecycle_details + + @lifecycle_details.setter + def lifecycle_details(self, lifecycle_details): + """ + Sets the lifecycle_details of this MediaWorkflowSummary. + A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. + + + :param lifecycle_details: The lifecycle_details of this MediaWorkflowSummary. + :type: str + """ + self._lifecycle_details = lifecycle_details + + @property + def version(self): + """ + Gets the version of this MediaWorkflowSummary. + The version of MediaWorkflow. + + + :return: The version of this MediaWorkflowSummary. + :rtype: int + """ + return self._version + + @version.setter + def version(self, version): + """ + Sets the version of this MediaWorkflowSummary. + The version of MediaWorkflow. + + + :param version: The version of this MediaWorkflowSummary. + :type: int + """ + self._version = version + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this MediaWorkflowSummary. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :return: The freeform_tags of this MediaWorkflowSummary. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this MediaWorkflowSummary. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :param freeform_tags: The freeform_tags of this MediaWorkflowSummary. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this MediaWorkflowSummary. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this MediaWorkflowSummary. + :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 MediaWorkflowSummary. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this MediaWorkflowSummary. + :type: dict(str, dict(str, object)) + """ + self._defined_tags = defined_tags + + @property + def system_tags(self): + """ + Gets the system_tags of this MediaWorkflowSummary. + 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 MediaWorkflowSummary. + :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 MediaWorkflowSummary. + 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 MediaWorkflowSummary. + :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/media_services/models/media_workflow_task.py b/src/oci/media_services/models/media_workflow_task.py new file mode 100644 index 0000000000..0f6b8f7afe --- /dev/null +++ b/src/oci/media_services/models/media_workflow_task.py @@ -0,0 +1,273 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 MediaWorkflowTask(object): + """ + Defines the type of processing to be run at a given point in the workflow, parameters to configure the + processing, and any processing that must be completed before this processing begins. + """ + + def __init__(self, **kwargs): + """ + Initializes a new MediaWorkflowTask object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param type: + The value to assign to the type property of this MediaWorkflowTask. + :type type: str + + :param version: + The value to assign to the version property of this MediaWorkflowTask. + :type version: int + + :param key: + The value to assign to the key property of this MediaWorkflowTask. + :type key: str + + :param prerequisites: + The value to assign to the prerequisites property of this MediaWorkflowTask. + :type prerequisites: list[str] + + :param enable_parameter_reference: + The value to assign to the enable_parameter_reference property of this MediaWorkflowTask. + :type enable_parameter_reference: str + + :param enable_when_referenced_parameter_equals: + The value to assign to the enable_when_referenced_parameter_equals property of this MediaWorkflowTask. + :type enable_when_referenced_parameter_equals: dict(str, str) + + :param parameters: + The value to assign to the parameters property of this MediaWorkflowTask. + :type parameters: dict(str, str) + + """ + self.swagger_types = { + 'type': 'str', + 'version': 'int', + 'key': 'str', + 'prerequisites': 'list[str]', + 'enable_parameter_reference': 'str', + 'enable_when_referenced_parameter_equals': 'dict(str, str)', + 'parameters': 'dict(str, str)' + } + + self.attribute_map = { + 'type': 'type', + 'version': 'version', + 'key': 'key', + 'prerequisites': 'prerequisites', + 'enable_parameter_reference': 'enableParameterReference', + 'enable_when_referenced_parameter_equals': 'enableWhenReferencedParameterEquals', + 'parameters': 'parameters' + } + + self._type = None + self._version = None + self._key = None + self._prerequisites = None + self._enable_parameter_reference = None + self._enable_when_referenced_parameter_equals = None + self._parameters = None + + @property + def type(self): + """ + Gets the type of this MediaWorkflowTask. + The type of process to run at this task. Refers to the name of a MediaWorkflowTaskDeclaration. + + + :return: The type of this MediaWorkflowTask. + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """ + Sets the type of this MediaWorkflowTask. + The type of process to run at this task. Refers to the name of a MediaWorkflowTaskDeclaration. + + + :param type: The type of this MediaWorkflowTask. + :type: str + """ + self._type = type + + @property + def version(self): + """ + **[Required]** Gets the version of this MediaWorkflowTask. + The version of the MediaWorkflowTaskDeclaration. + + + :return: The version of this MediaWorkflowTask. + :rtype: int + """ + return self._version + + @version.setter + def version(self, version): + """ + Sets the version of this MediaWorkflowTask. + The version of the MediaWorkflowTaskDeclaration. + + + :param version: The version of this MediaWorkflowTask. + :type: int + """ + self._version = version + + @property + def key(self): + """ + **[Required]** Gets the key of this MediaWorkflowTask. + A unique identifier for this task within its workflow. Keys are used to reference a task within workflows + and MediaWorkflowJobs. Tasks are referenced as prerequisites and to track output and state. + + + :return: The key of this MediaWorkflowTask. + :rtype: str + """ + return self._key + + @key.setter + def key(self, key): + """ + Sets the key of this MediaWorkflowTask. + A unique identifier for this task within its workflow. Keys are used to reference a task within workflows + and MediaWorkflowJobs. Tasks are referenced as prerequisites and to track output and state. + + + :param key: The key of this MediaWorkflowTask. + :type: str + """ + self._key = key + + @property + def prerequisites(self): + """ + Gets the prerequisites of this MediaWorkflowTask. + Keys to the other tasks in this workflow that must be completed before execution of this task can begin. + + + :return: The prerequisites of this MediaWorkflowTask. + :rtype: list[str] + """ + return self._prerequisites + + @prerequisites.setter + def prerequisites(self, prerequisites): + """ + Sets the prerequisites of this MediaWorkflowTask. + Keys to the other tasks in this workflow that must be completed before execution of this task can begin. + + + :param prerequisites: The prerequisites of this MediaWorkflowTask. + :type: list[str] + """ + self._prerequisites = prerequisites + + @property + def enable_parameter_reference(self): + """ + Gets the enable_parameter_reference of this MediaWorkflowTask. + Allows this task to be conditionally enabled. If no value or a blank value is given, the task is + unconditionally enbled. Otherwise the given string specifies a parameter of the job created for this task's + workflow using the JSON pointer syntax. The JSON pointer is validated when a job is created from the workflow of this task. + + + :return: The enable_parameter_reference of this MediaWorkflowTask. + :rtype: str + """ + return self._enable_parameter_reference + + @enable_parameter_reference.setter + def enable_parameter_reference(self, enable_parameter_reference): + """ + Sets the enable_parameter_reference of this MediaWorkflowTask. + Allows this task to be conditionally enabled. If no value or a blank value is given, the task is + unconditionally enbled. Otherwise the given string specifies a parameter of the job created for this task's + workflow using the JSON pointer syntax. The JSON pointer is validated when a job is created from the workflow of this task. + + + :param enable_parameter_reference: The enable_parameter_reference of this MediaWorkflowTask. + :type: str + """ + self._enable_parameter_reference = enable_parameter_reference + + @property + def enable_when_referenced_parameter_equals(self): + """ + Gets the enable_when_referenced_parameter_equals of this MediaWorkflowTask. + Used in conjunction with enableParameterReference to conditionally enable a task. When a job is created + from the workflow of this task, the task will only be enabled if the value of the parameter specified by + enableParameterReference is equal to the value of this property. This property must be prenset if and only if + a enableParameterReference is given. The value is a JSON node. + + + :return: The enable_when_referenced_parameter_equals of this MediaWorkflowTask. + :rtype: dict(str, str) + """ + return self._enable_when_referenced_parameter_equals + + @enable_when_referenced_parameter_equals.setter + def enable_when_referenced_parameter_equals(self, enable_when_referenced_parameter_equals): + """ + Sets the enable_when_referenced_parameter_equals of this MediaWorkflowTask. + Used in conjunction with enableParameterReference to conditionally enable a task. When a job is created + from the workflow of this task, the task will only be enabled if the value of the parameter specified by + enableParameterReference is equal to the value of this property. This property must be prenset if and only if + a enableParameterReference is given. The value is a JSON node. + + + :param enable_when_referenced_parameter_equals: The enable_when_referenced_parameter_equals of this MediaWorkflowTask. + :type: dict(str, str) + """ + self._enable_when_referenced_parameter_equals = enable_when_referenced_parameter_equals + + @property + def parameters(self): + """ + Gets the parameters of this MediaWorkflowTask. + Data specifiying how this task is to be run. The data is a JSON object that must conform to the JSON Schema + specified by the parameters of the MediaWorkflowTaskDeclaration this task references. The parameters may + contain values or references to other parameters. + + + :return: The parameters of this MediaWorkflowTask. + :rtype: dict(str, str) + """ + return self._parameters + + @parameters.setter + def parameters(self, parameters): + """ + Sets the parameters of this MediaWorkflowTask. + Data specifiying how this task is to be run. The data is a JSON object that must conform to the JSON Schema + specified by the parameters of the MediaWorkflowTaskDeclaration this task references. The parameters may + contain values or references to other parameters. + + + :param parameters: The parameters of this MediaWorkflowTask. + :type: dict(str, str) + """ + 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/media_services/models/media_workflow_task_declaration.py b/src/oci/media_services/models/media_workflow_task_declaration.py new file mode 100644 index 0000000000..2216048903 --- /dev/null +++ b/src/oci/media_services/models/media_workflow_task_declaration.py @@ -0,0 +1,171 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 MediaWorkflowTaskDeclaration(object): + """ + The declaration of a type of task that can be used in a MediaWorkflow. + """ + + def __init__(self, **kwargs): + """ + Initializes a new MediaWorkflowTaskDeclaration 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 MediaWorkflowTaskDeclaration. + :type name: str + + :param version: + The value to assign to the version property of this MediaWorkflowTaskDeclaration. + :type version: int + + :param parameters_schema: + The value to assign to the parameters_schema property of this MediaWorkflowTaskDeclaration. + :type parameters_schema: dict(str, str) + + :param parameters_schema_allowing_references: + The value to assign to the parameters_schema_allowing_references property of this MediaWorkflowTaskDeclaration. + :type parameters_schema_allowing_references: dict(str, str) + + """ + self.swagger_types = { + 'name': 'str', + 'version': 'int', + 'parameters_schema': 'dict(str, str)', + 'parameters_schema_allowing_references': 'dict(str, str)' + } + + self.attribute_map = { + 'name': 'name', + 'version': 'version', + 'parameters_schema': 'parametersSchema', + 'parameters_schema_allowing_references': 'parametersSchemaAllowingReferences' + } + + self._name = None + self._version = None + self._parameters_schema = None + self._parameters_schema_allowing_references = None + + @property + def name(self): + """ + **[Required]** Gets the name of this MediaWorkflowTaskDeclaration. + MediaWorkflowTaskDeclaration identifier. The name and version should be unique among + MediaWorkflowTaskDeclarations. + + + :return: The name of this MediaWorkflowTaskDeclaration. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this MediaWorkflowTaskDeclaration. + MediaWorkflowTaskDeclaration identifier. The name and version should be unique among + MediaWorkflowTaskDeclarations. + + + :param name: The name of this MediaWorkflowTaskDeclaration. + :type: str + """ + self._name = name + + @property + def version(self): + """ + **[Required]** Gets the version of this MediaWorkflowTaskDeclaration. + The version of MediaWorkflowTaskDeclaration, incremented whenever the team implementing the task processor + modifies the JSON schema of this declaration's definitions, parameters or list of required parameters. + + + :return: The version of this MediaWorkflowTaskDeclaration. + :rtype: int + """ + return self._version + + @version.setter + def version(self, version): + """ + Sets the version of this MediaWorkflowTaskDeclaration. + The version of MediaWorkflowTaskDeclaration, incremented whenever the team implementing the task processor + modifies the JSON schema of this declaration's definitions, parameters or list of required parameters. + + + :param version: The version of this MediaWorkflowTaskDeclaration. + :type: int + """ + self._version = version + + @property + def parameters_schema(self): + """ + **[Required]** Gets the parameters_schema of this MediaWorkflowTaskDeclaration. + JSON schema specifying the parameters supported by this type of task. This is used to validate tasks' + parameters when jobs are created. + + + :return: The parameters_schema of this MediaWorkflowTaskDeclaration. + :rtype: dict(str, str) + """ + return self._parameters_schema + + @parameters_schema.setter + def parameters_schema(self, parameters_schema): + """ + Sets the parameters_schema of this MediaWorkflowTaskDeclaration. + JSON schema specifying the parameters supported by this type of task. This is used to validate tasks' + parameters when jobs are created. + + + :param parameters_schema: The parameters_schema of this MediaWorkflowTaskDeclaration. + :type: dict(str, str) + """ + self._parameters_schema = parameters_schema + + @property + def parameters_schema_allowing_references(self): + """ + **[Required]** Gets the parameters_schema_allowing_references of this MediaWorkflowTaskDeclaration. + JSON schema similar to the parameterSchema, but permits parameter values to refer to other parameters using the + ${/path/to/another/parmeter} syntax. This is used to validate task parameters when workflows are created. + + + :return: The parameters_schema_allowing_references of this MediaWorkflowTaskDeclaration. + :rtype: dict(str, str) + """ + return self._parameters_schema_allowing_references + + @parameters_schema_allowing_references.setter + def parameters_schema_allowing_references(self, parameters_schema_allowing_references): + """ + Sets the parameters_schema_allowing_references of this MediaWorkflowTaskDeclaration. + JSON schema similar to the parameterSchema, but permits parameter values to refer to other parameters using the + ${/path/to/another/parmeter} syntax. This is used to validate task parameters when workflows are created. + + + :param parameters_schema_allowing_references: The parameters_schema_allowing_references of this MediaWorkflowTaskDeclaration. + :type: dict(str, str) + """ + self._parameters_schema_allowing_references = parameters_schema_allowing_references + + 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/media_services/models/media_workflow_task_declaration_collection.py b/src/oci/media_services/models/media_workflow_task_declaration_collection.py new file mode 100644 index 0000000000..c84bdf0d5a --- /dev/null +++ b/src/oci/media_services/models/media_workflow_task_declaration_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 MediaWorkflowTaskDeclarationCollection(object): + """ + Results of the ListMediaWorkflowTaskDeclaration operation, a list of MediaWorkflowTaskDeclarations. + """ + + def __init__(self, **kwargs): + """ + Initializes a new MediaWorkflowTaskDeclarationCollection 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 MediaWorkflowTaskDeclarationCollection. + :type items: list[oci.media_services.models.MediaWorkflowTaskDeclaration] + + """ + self.swagger_types = { + 'items': 'list[MediaWorkflowTaskDeclaration]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this MediaWorkflowTaskDeclarationCollection. + List of MediaWorkflowTaskDeclaration objects. + + + :return: The items of this MediaWorkflowTaskDeclarationCollection. + :rtype: list[oci.media_services.models.MediaWorkflowTaskDeclaration] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this MediaWorkflowTaskDeclarationCollection. + List of MediaWorkflowTaskDeclaration objects. + + + :param items: The items of this MediaWorkflowTaskDeclarationCollection. + :type: list[oci.media_services.models.MediaWorkflowTaskDeclaration] + """ + 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/media_services/models/media_workflow_task_state.py b/src/oci/media_services/models/media_workflow_task_state.py new file mode 100644 index 0000000000..3c6d8219c5 --- /dev/null +++ b/src/oci/media_services/models/media_workflow_task_state.py @@ -0,0 +1,132 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 MediaWorkflowTaskState(object): + """ + Status of a task in a workflow job being run. + """ + + def __init__(self, **kwargs): + """ + Initializes a new MediaWorkflowTaskState 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 MediaWorkflowTaskState. + :type key: str + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this MediaWorkflowTaskState. + :type lifecycle_state: str + + :param lifecycle_details: + The value to assign to the lifecycle_details property of this MediaWorkflowTaskState. + :type lifecycle_details: str + + """ + self.swagger_types = { + 'key': 'str', + 'lifecycle_state': 'str', + 'lifecycle_details': 'str' + } + + self.attribute_map = { + 'key': 'key', + 'lifecycle_state': 'lifecycleState', + 'lifecycle_details': 'lifecycleDetails' + } + + self._key = None + self._lifecycle_state = None + self._lifecycle_details = None + + @property + def key(self): + """ + Gets the key of this MediaWorkflowTaskState. + Unique key within a MediaWorkflowJob for the task. + + + :return: The key of this MediaWorkflowTaskState. + :rtype: str + """ + return self._key + + @key.setter + def key(self, key): + """ + Sets the key of this MediaWorkflowTaskState. + Unique key within a MediaWorkflowJob for the task. + + + :param key: The key of this MediaWorkflowTaskState. + :type: str + """ + self._key = key + + @property + def lifecycle_state(self): + """ + Gets the lifecycle_state of this MediaWorkflowTaskState. + The current state of the MediaWorkflowJob task. + + + :return: The lifecycle_state of this MediaWorkflowTaskState. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this MediaWorkflowTaskState. + The current state of the MediaWorkflowJob task. + + + :param lifecycle_state: The lifecycle_state of this MediaWorkflowTaskState. + :type: str + """ + self._lifecycle_state = lifecycle_state + + @property + def lifecycle_details(self): + """ + Gets the lifecycle_details of this MediaWorkflowTaskState. + The lifecycle details of MediaWorkflowJob task. + + + :return: The lifecycle_details of this MediaWorkflowTaskState. + :rtype: str + """ + return self._lifecycle_details + + @lifecycle_details.setter + def lifecycle_details(self, lifecycle_details): + """ + Sets the lifecycle_details of this MediaWorkflowTaskState. + The lifecycle details of MediaWorkflowJob task. + + + :param lifecycle_details: The lifecycle_details of this MediaWorkflowTaskState. + :type: str + """ + self._lifecycle_details = lifecycle_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/media_services/models/metadata.py b/src/oci/media_services/models/metadata.py new file mode 100644 index 0000000000..f7cee0d557 --- /dev/null +++ b/src/oci/media_services/models/metadata.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 Metadata(object): + """ + Technical metadata for this asset. + """ + + def __init__(self, **kwargs): + """ + Initializes a new Metadata object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param metadata: + The value to assign to the metadata property of this Metadata. + :type metadata: str + + """ + self.swagger_types = { + 'metadata': 'str' + } + + self.attribute_map = { + 'metadata': 'metadata' + } + + self._metadata = None + + @property + def metadata(self): + """ + **[Required]** Gets the metadata of this Metadata. + JSON string containing the technial metadata for the media asset. + + + :return: The metadata of this Metadata. + :rtype: str + """ + return self._metadata + + @metadata.setter + def metadata(self, metadata): + """ + Sets the metadata of this Metadata. + JSON string containing the technial metadata for the media asset. + + + :param metadata: The metadata of this Metadata. + :type: str + """ + self._metadata = metadata + + 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/media_services/models/stream_cdn_config.py b/src/oci/media_services/models/stream_cdn_config.py new file mode 100644 index 0000000000..4ce3d091b5 --- /dev/null +++ b/src/oci/media_services/models/stream_cdn_config.py @@ -0,0 +1,464 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 StreamCdnConfig(object): + """ + Configuration used for integrating with a CDN. + """ + + #: A constant which can be used with the lifecycle_state property of a StreamCdnConfig. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a StreamCdnConfig. + #: This constant has a value of "NEEDS_ATTENTION" + LIFECYCLE_STATE_NEEDS_ATTENTION = "NEEDS_ATTENTION" + + #: A constant which can be used with the lifecycle_state property of a StreamCdnConfig. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" + + def __init__(self, **kwargs): + """ + Initializes a new StreamCdnConfig 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 StreamCdnConfig. + :type id: str + + :param display_name: + The value to assign to the display_name property of this StreamCdnConfig. + :type display_name: str + + :param compartment_id: + The value to assign to the compartment_id property of this StreamCdnConfig. + :type compartment_id: str + + :param distribution_channel_id: + The value to assign to the distribution_channel_id property of this StreamCdnConfig. + :type distribution_channel_id: str + + :param is_enabled: + The value to assign to the is_enabled property of this StreamCdnConfig. + :type is_enabled: bool + + :param config: + The value to assign to the config property of this StreamCdnConfig. + :type config: oci.media_services.models.StreamCdnConfigSection + + :param time_created: + The value to assign to the time_created property of this StreamCdnConfig. + :type time_created: datetime + + :param time_updated: + The value to assign to the time_updated property of this StreamCdnConfig. + :type time_updated: datetime + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this StreamCdnConfig. + Allowed values for this property are: "ACTIVE", "NEEDS_ATTENTION", "DELETED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type lifecycle_state: str + + :param lifecyle_details: + The value to assign to the lifecyle_details property of this StreamCdnConfig. + :type lifecyle_details: str + + :param freeform_tags: + The value to assign to the freeform_tags property of this StreamCdnConfig. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this StreamCdnConfig. + :type defined_tags: dict(str, dict(str, object)) + + :param system_tags: + The value to assign to the system_tags property of this StreamCdnConfig. + :type system_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'id': 'str', + 'display_name': 'str', + 'compartment_id': 'str', + 'distribution_channel_id': 'str', + 'is_enabled': 'bool', + 'config': 'StreamCdnConfigSection', + 'time_created': 'datetime', + 'time_updated': 'datetime', + 'lifecycle_state': 'str', + 'lifecyle_details': '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', + 'distribution_channel_id': 'distributionChannelId', + 'is_enabled': 'isEnabled', + 'config': 'config', + 'time_created': 'timeCreated', + 'time_updated': 'timeUpdated', + 'lifecycle_state': 'lifecycleState', + 'lifecyle_details': 'lifecyleDetails', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags', + 'system_tags': 'systemTags' + } + + self._id = None + self._display_name = None + self._compartment_id = None + self._distribution_channel_id = None + self._is_enabled = None + self._config = None + self._time_created = None + self._time_updated = None + self._lifecycle_state = None + self._lifecyle_details = None + self._freeform_tags = None + self._defined_tags = None + self._system_tags = None + + @property + def id(self): + """ + **[Required]** Gets the id of this StreamCdnConfig. + Unique identifier that is immutable on creation. + + + :return: The id of this StreamCdnConfig. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this StreamCdnConfig. + Unique identifier that is immutable on creation. + + + :param id: The id of this StreamCdnConfig. + :type: str + """ + self._id = id + + @property + def display_name(self): + """ + **[Required]** Gets the display_name of this StreamCdnConfig. + The CDN Configuration identifier or display name, which can be renamed and is not necessarily unique. Avoid entering confidential information. + + + :return: The display_name of this StreamCdnConfig. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this StreamCdnConfig. + The CDN Configuration identifier or display name, which can be renamed and is not necessarily unique. Avoid entering confidential information. + + + :param display_name: The display_name of this StreamCdnConfig. + :type: str + """ + self._display_name = display_name + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this StreamCdnConfig. + Compartment Identifier. + + + :return: The compartment_id of this StreamCdnConfig. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this StreamCdnConfig. + Compartment Identifier. + + + :param compartment_id: The compartment_id of this StreamCdnConfig. + :type: str + """ + self._compartment_id = compartment_id + + @property + def distribution_channel_id(self): + """ + **[Required]** Gets the distribution_channel_id of this StreamCdnConfig. + Distribution Channel Identifier. + + + :return: The distribution_channel_id of this StreamCdnConfig. + :rtype: str + """ + return self._distribution_channel_id + + @distribution_channel_id.setter + def distribution_channel_id(self, distribution_channel_id): + """ + Sets the distribution_channel_id of this StreamCdnConfig. + Distribution Channel Identifier. + + + :param distribution_channel_id: The distribution_channel_id of this StreamCdnConfig. + :type: str + """ + self._distribution_channel_id = distribution_channel_id + + @property + def is_enabled(self): + """ + **[Required]** Gets the is_enabled of this StreamCdnConfig. + Whether publishing to CDN is enabled. + + + :return: The is_enabled of this StreamCdnConfig. + :rtype: bool + """ + return self._is_enabled + + @is_enabled.setter + def is_enabled(self, is_enabled): + """ + Sets the is_enabled of this StreamCdnConfig. + Whether publishing to CDN is enabled. + + + :param is_enabled: The is_enabled of this StreamCdnConfig. + :type: bool + """ + self._is_enabled = is_enabled + + @property + def config(self): + """ + **[Required]** Gets the config of this StreamCdnConfig. + + :return: The config of this StreamCdnConfig. + :rtype: oci.media_services.models.StreamCdnConfigSection + """ + return self._config + + @config.setter + def config(self, config): + """ + Sets the config of this StreamCdnConfig. + + :param config: The config of this StreamCdnConfig. + :type: oci.media_services.models.StreamCdnConfigSection + """ + self._config = config + + @property + def time_created(self): + """ + Gets the time_created of this StreamCdnConfig. + The time when the CDN Config was created. An RFC3339 formatted datetime string. + + + :return: The time_created of this StreamCdnConfig. + :rtype: datetime + """ + return self._time_created + + @time_created.setter + def time_created(self, time_created): + """ + Sets the time_created of this StreamCdnConfig. + The time when the CDN Config was created. An RFC3339 formatted datetime string. + + + :param time_created: The time_created of this StreamCdnConfig. + :type: datetime + """ + self._time_created = time_created + + @property + def time_updated(self): + """ + Gets the time_updated of this StreamCdnConfig. + The time when the CDN Config was updated. An RFC3339 formatted datetime string. + + + :return: The time_updated of this StreamCdnConfig. + :rtype: datetime + """ + return self._time_updated + + @time_updated.setter + def time_updated(self, time_updated): + """ + Sets the time_updated of this StreamCdnConfig. + The time when the CDN Config was updated. An RFC3339 formatted datetime string. + + + :param time_updated: The time_updated of this StreamCdnConfig. + :type: datetime + """ + self._time_updated = time_updated + + @property + def lifecycle_state(self): + """ + Gets the lifecycle_state of this StreamCdnConfig. + The current state of the CDN Configuration. + + Allowed values for this property are: "ACTIVE", "NEEDS_ATTENTION", "DELETED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The lifecycle_state of this StreamCdnConfig. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this StreamCdnConfig. + The current state of the CDN Configuration. + + + :param lifecycle_state: The lifecycle_state of this StreamCdnConfig. + :type: str + """ + allowed_values = ["ACTIVE", "NEEDS_ATTENTION", "DELETED"] + if not value_allowed_none_or_none_sentinel(lifecycle_state, allowed_values): + lifecycle_state = 'UNKNOWN_ENUM_VALUE' + self._lifecycle_state = lifecycle_state + + @property + def lifecyle_details(self): + """ + Gets the lifecyle_details of this StreamCdnConfig. + A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. + + + :return: The lifecyle_details of this StreamCdnConfig. + :rtype: str + """ + return self._lifecyle_details + + @lifecyle_details.setter + def lifecyle_details(self, lifecyle_details): + """ + Sets the lifecyle_details of this StreamCdnConfig. + A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. + + + :param lifecyle_details: The lifecyle_details of this StreamCdnConfig. + :type: str + """ + self._lifecyle_details = lifecyle_details + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this StreamCdnConfig. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :return: The freeform_tags of this StreamCdnConfig. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this StreamCdnConfig. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :param freeform_tags: The freeform_tags of this StreamCdnConfig. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this StreamCdnConfig. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this StreamCdnConfig. + :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 StreamCdnConfig. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this StreamCdnConfig. + :type: dict(str, dict(str, object)) + """ + self._defined_tags = defined_tags + + @property + def system_tags(self): + """ + Gets the system_tags of this StreamCdnConfig. + 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 StreamCdnConfig. + :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 StreamCdnConfig. + 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 StreamCdnConfig. + :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/media_services/models/stream_cdn_config_collection.py b/src/oci/media_services/models/stream_cdn_config_collection.py new file mode 100644 index 0000000000..3e297b0fda --- /dev/null +++ b/src/oci/media_services/models/stream_cdn_config_collection.py @@ -0,0 +1,71 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 StreamCdnConfigCollection(object): + """ + Results of a streamCdnConfig search. Contains both StreamCdnConfigSummary items and other information, such as + metadata. + """ + + def __init__(self, **kwargs): + """ + Initializes a new StreamCdnConfigCollection 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 StreamCdnConfigCollection. + :type items: list[oci.media_services.models.StreamCdnConfigSummary] + + """ + self.swagger_types = { + 'items': 'list[StreamCdnConfigSummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this StreamCdnConfigCollection. + List of streamCdnConfigs. + + + :return: The items of this StreamCdnConfigCollection. + :rtype: list[oci.media_services.models.StreamCdnConfigSummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this StreamCdnConfigCollection. + List of streamCdnConfigs. + + + :param items: The items of this StreamCdnConfigCollection. + :type: list[oci.media_services.models.StreamCdnConfigSummary] + """ + 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/media_services/models/stream_cdn_config_section.py b/src/oci/media_services/models/stream_cdn_config_section.py new file mode 100644 index 0000000000..88f475ecee --- /dev/null +++ b/src/oci/media_services/models/stream_cdn_config_section.py @@ -0,0 +1,107 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 StreamCdnConfigSection(object): + """ + Base fields of the StreamCdnConfig configuration object. + """ + + #: A constant which can be used with the type property of a StreamCdnConfigSection. + #: This constant has a value of "EDGE" + TYPE_EDGE = "EDGE" + + #: A constant which can be used with the type property of a StreamCdnConfigSection. + #: This constant has a value of "AKAMAI_MANUAL" + TYPE_AKAMAI_MANUAL = "AKAMAI_MANUAL" + + def __init__(self, **kwargs): + """ + Initializes a new StreamCdnConfigSection 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.media_services.models.AkamaiManualStreamCdnConfig` + * :class:`~oci.media_services.models.EdgeStreamCdnConfig` + + 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 StreamCdnConfigSection. + Allowed values for this property are: "EDGE", "AKAMAI_MANUAL", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :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 == 'AKAMAI_MANUAL': + return 'AkamaiManualStreamCdnConfig' + + if type == 'EDGE': + return 'EdgeStreamCdnConfig' + else: + return 'StreamCdnConfigSection' + + @property + def type(self): + """ + **[Required]** Gets the type of this StreamCdnConfigSection. + The name of the CDN configuration type. + + Allowed values for this property are: "EDGE", "AKAMAI_MANUAL", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The type of this StreamCdnConfigSection. + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """ + Sets the type of this StreamCdnConfigSection. + The name of the CDN configuration type. + + + :param type: The type of this StreamCdnConfigSection. + :type: str + """ + allowed_values = ["EDGE", "AKAMAI_MANUAL"] + 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/media_services/models/stream_cdn_config_summary.py b/src/oci/media_services/models/stream_cdn_config_summary.py new file mode 100644 index 0000000000..08c3ffea9e --- /dev/null +++ b/src/oci/media_services/models/stream_cdn_config_summary.py @@ -0,0 +1,417 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 StreamCdnConfigSummary(object): + """ + Summary of the StreamCdnConfig. + """ + + def __init__(self, **kwargs): + """ + Initializes a new StreamCdnConfigSummary 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 StreamCdnConfigSummary. + :type id: str + + :param display_name: + The value to assign to the display_name property of this StreamCdnConfigSummary. + :type display_name: str + + :param compartment_id: + The value to assign to the compartment_id property of this StreamCdnConfigSummary. + :type compartment_id: str + + :param distribution_channel_id: + The value to assign to the distribution_channel_id property of this StreamCdnConfigSummary. + :type distribution_channel_id: str + + :param is_enabled: + The value to assign to the is_enabled property of this StreamCdnConfigSummary. + :type is_enabled: bool + + :param time_created: + The value to assign to the time_created property of this StreamCdnConfigSummary. + :type time_created: datetime + + :param time_updated: + The value to assign to the time_updated property of this StreamCdnConfigSummary. + :type time_updated: datetime + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this StreamCdnConfigSummary. + :type lifecycle_state: str + + :param lifecycle_details: + The value to assign to the lifecycle_details property of this StreamCdnConfigSummary. + :type lifecycle_details: str + + :param freeform_tags: + The value to assign to the freeform_tags property of this StreamCdnConfigSummary. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this StreamCdnConfigSummary. + :type defined_tags: dict(str, dict(str, object)) + + :param system_tags: + The value to assign to the system_tags property of this StreamCdnConfigSummary. + :type system_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'id': 'str', + 'display_name': 'str', + 'compartment_id': 'str', + 'distribution_channel_id': 'str', + 'is_enabled': 'bool', + 'time_created': 'datetime', + 'time_updated': 'datetime', + 'lifecycle_state': 'str', + 'lifecycle_details': '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', + 'distribution_channel_id': 'distributionChannelId', + 'is_enabled': 'isEnabled', + 'time_created': 'timeCreated', + 'time_updated': 'timeUpdated', + 'lifecycle_state': 'lifecycleState', + 'lifecycle_details': 'lifecycleDetails', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags', + 'system_tags': 'systemTags' + } + + self._id = None + self._display_name = None + self._compartment_id = None + self._distribution_channel_id = None + self._is_enabled = None + self._time_created = None + self._time_updated = None + self._lifecycle_state = None + self._lifecycle_details = None + self._freeform_tags = None + self._defined_tags = None + self._system_tags = None + + @property + def id(self): + """ + **[Required]** Gets the id of this StreamCdnConfigSummary. + Unique identifier that is immutable on creation. + + + :return: The id of this StreamCdnConfigSummary. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this StreamCdnConfigSummary. + Unique identifier that is immutable on creation. + + + :param id: The id of this StreamCdnConfigSummary. + :type: str + """ + self._id = id + + @property + def display_name(self): + """ + **[Required]** Gets the display_name of this StreamCdnConfigSummary. + The CDN Configuration identifier or display name, which can be renamed and is not necessarily unique. Avoid entering confidential information. + + + :return: The display_name of this StreamCdnConfigSummary. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this StreamCdnConfigSummary. + The CDN Configuration identifier or display name, which can be renamed and is not necessarily unique. Avoid entering confidential information. + + + :param display_name: The display_name of this StreamCdnConfigSummary. + :type: str + """ + self._display_name = display_name + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this StreamCdnConfigSummary. + Compartment Identifier. + + + :return: The compartment_id of this StreamCdnConfigSummary. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this StreamCdnConfigSummary. + Compartment Identifier. + + + :param compartment_id: The compartment_id of this StreamCdnConfigSummary. + :type: str + """ + self._compartment_id = compartment_id + + @property + def distribution_channel_id(self): + """ + **[Required]** Gets the distribution_channel_id of this StreamCdnConfigSummary. + Distribution Channel Identifier. + + + :return: The distribution_channel_id of this StreamCdnConfigSummary. + :rtype: str + """ + return self._distribution_channel_id + + @distribution_channel_id.setter + def distribution_channel_id(self, distribution_channel_id): + """ + Sets the distribution_channel_id of this StreamCdnConfigSummary. + Distribution Channel Identifier. + + + :param distribution_channel_id: The distribution_channel_id of this StreamCdnConfigSummary. + :type: str + """ + self._distribution_channel_id = distribution_channel_id + + @property + def is_enabled(self): + """ + **[Required]** Gets the is_enabled of this StreamCdnConfigSummary. + Whether publishing to CDN is enabled. + + + :return: The is_enabled of this StreamCdnConfigSummary. + :rtype: bool + """ + return self._is_enabled + + @is_enabled.setter + def is_enabled(self, is_enabled): + """ + Sets the is_enabled of this StreamCdnConfigSummary. + Whether publishing to CDN is enabled. + + + :param is_enabled: The is_enabled of this StreamCdnConfigSummary. + :type: bool + """ + self._is_enabled = is_enabled + + @property + def time_created(self): + """ + Gets the time_created of this StreamCdnConfigSummary. + The time when the the CDN Configuration was created. An RFC3339 formatted datetime string. + + + :return: The time_created of this StreamCdnConfigSummary. + :rtype: datetime + """ + return self._time_created + + @time_created.setter + def time_created(self, time_created): + """ + Sets the time_created of this StreamCdnConfigSummary. + The time when the the CDN Configuration was created. An RFC3339 formatted datetime string. + + + :param time_created: The time_created of this StreamCdnConfigSummary. + :type: datetime + """ + self._time_created = time_created + + @property + def time_updated(self): + """ + Gets the time_updated of this StreamCdnConfigSummary. + The time the CDN Configuration was updated. An RFC3339 formatted datetime string. + + + :return: The time_updated of this StreamCdnConfigSummary. + :rtype: datetime + """ + return self._time_updated + + @time_updated.setter + def time_updated(self, time_updated): + """ + Sets the time_updated of this StreamCdnConfigSummary. + The time the CDN Configuration was updated. An RFC3339 formatted datetime string. + + + :param time_updated: The time_updated of this StreamCdnConfigSummary. + :type: datetime + """ + self._time_updated = time_updated + + @property + def lifecycle_state(self): + """ + Gets the lifecycle_state of this StreamCdnConfigSummary. + The current state of the CDN Configuration. + + + :return: The lifecycle_state of this StreamCdnConfigSummary. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this StreamCdnConfigSummary. + The current state of the CDN Configuration. + + + :param lifecycle_state: The lifecycle_state of this StreamCdnConfigSummary. + :type: str + """ + self._lifecycle_state = lifecycle_state + + @property + def lifecycle_details(self): + """ + Gets the lifecycle_details of this StreamCdnConfigSummary. + A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. + + + :return: The lifecycle_details of this StreamCdnConfigSummary. + :rtype: str + """ + return self._lifecycle_details + + @lifecycle_details.setter + def lifecycle_details(self, lifecycle_details): + """ + Sets the lifecycle_details of this StreamCdnConfigSummary. + A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. + + + :param lifecycle_details: The lifecycle_details of this StreamCdnConfigSummary. + :type: str + """ + self._lifecycle_details = lifecycle_details + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this StreamCdnConfigSummary. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :return: The freeform_tags of this StreamCdnConfigSummary. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this StreamCdnConfigSummary. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :param freeform_tags: The freeform_tags of this StreamCdnConfigSummary. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this StreamCdnConfigSummary. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this StreamCdnConfigSummary. + :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 StreamCdnConfigSummary. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this StreamCdnConfigSummary. + :type: dict(str, dict(str, object)) + """ + self._defined_tags = defined_tags + + @property + def system_tags(self): + """ + Gets the system_tags of this StreamCdnConfigSummary. + 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 StreamCdnConfigSummary. + :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 StreamCdnConfigSummary. + 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 StreamCdnConfigSummary. + :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/media_services/models/stream_distribution_channel.py b/src/oci/media_services/models/stream_distribution_channel.py new file mode 100644 index 0000000000..c6b32ff96e --- /dev/null +++ b/src/oci/media_services/models/stream_distribution_channel.py @@ -0,0 +1,375 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 StreamDistributionChannel(object): + """ + Channel used for delivering video streams to the end-users. + """ + + #: A constant which can be used with the lifecycle_state property of a StreamDistributionChannel. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a StreamDistributionChannel. + #: This constant has a value of "NEEDS_ATTENTION" + LIFECYCLE_STATE_NEEDS_ATTENTION = "NEEDS_ATTENTION" + + #: A constant which can be used with the lifecycle_state property of a StreamDistributionChannel. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" + + def __init__(self, **kwargs): + """ + Initializes a new StreamDistributionChannel 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 StreamDistributionChannel. + :type id: str + + :param display_name: + The value to assign to the display_name property of this StreamDistributionChannel. + :type display_name: str + + :param compartment_id: + The value to assign to the compartment_id property of this StreamDistributionChannel. + :type compartment_id: str + + :param domain_name: + The value to assign to the domain_name property of this StreamDistributionChannel. + :type domain_name: str + + :param time_created: + The value to assign to the time_created property of this StreamDistributionChannel. + :type time_created: datetime + + :param time_updated: + The value to assign to the time_updated property of this StreamDistributionChannel. + :type time_updated: datetime + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this StreamDistributionChannel. + Allowed values for this property are: "ACTIVE", "NEEDS_ATTENTION", "DELETED", '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 StreamDistributionChannel. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this StreamDistributionChannel. + :type defined_tags: dict(str, dict(str, object)) + + :param system_tags: + The value to assign to the system_tags property of this StreamDistributionChannel. + :type system_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'id': 'str', + 'display_name': 'str', + 'compartment_id': 'str', + 'domain_name': 'str', + 'time_created': 'datetime', + 'time_updated': 'datetime', + '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', + 'domain_name': 'domainName', + 'time_created': 'timeCreated', + 'time_updated': 'timeUpdated', + 'lifecycle_state': 'lifecycleState', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags', + 'system_tags': 'systemTags' + } + + self._id = None + self._display_name = None + self._compartment_id = None + self._domain_name = None + self._time_created = None + self._time_updated = 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 StreamDistributionChannel. + Unique identifier that is immutable on creation. + + + :return: The id of this StreamDistributionChannel. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this StreamDistributionChannel. + Unique identifier that is immutable on creation. + + + :param id: The id of this StreamDistributionChannel. + :type: str + """ + self._id = id + + @property + def display_name(self): + """ + **[Required]** Gets the display_name of this StreamDistributionChannel. + Stream Distribution Channel display name. + + + :return: The display_name of this StreamDistributionChannel. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this StreamDistributionChannel. + Stream Distribution Channel display name. + + + :param display_name: The display_name of this StreamDistributionChannel. + :type: str + """ + self._display_name = display_name + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this StreamDistributionChannel. + Compartment Identifier. + + + :return: The compartment_id of this StreamDistributionChannel. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this StreamDistributionChannel. + Compartment Identifier. + + + :param compartment_id: The compartment_id of this StreamDistributionChannel. + :type: str + """ + self._compartment_id = compartment_id + + @property + def domain_name(self): + """ + Gets the domain_name of this StreamDistributionChannel. + Unique domain name of the Distribution Channel. + + + :return: The domain_name of this StreamDistributionChannel. + :rtype: str + """ + return self._domain_name + + @domain_name.setter + def domain_name(self, domain_name): + """ + Sets the domain_name of this StreamDistributionChannel. + Unique domain name of the Distribution Channel. + + + :param domain_name: The domain_name of this StreamDistributionChannel. + :type: str + """ + self._domain_name = domain_name + + @property + def time_created(self): + """ + Gets the time_created of this StreamDistributionChannel. + The time when the Stream Distribution Channel was created. An RFC3339 formatted datetime string. + + + :return: The time_created of this StreamDistributionChannel. + :rtype: datetime + """ + return self._time_created + + @time_created.setter + def time_created(self, time_created): + """ + Sets the time_created of this StreamDistributionChannel. + The time when the Stream Distribution Channel was created. An RFC3339 formatted datetime string. + + + :param time_created: The time_created of this StreamDistributionChannel. + :type: datetime + """ + self._time_created = time_created + + @property + def time_updated(self): + """ + Gets the time_updated of this StreamDistributionChannel. + The time when the Stream Distribution Channel was updated. An RFC3339 formatted datetime string. + + + :return: The time_updated of this StreamDistributionChannel. + :rtype: datetime + """ + return self._time_updated + + @time_updated.setter + def time_updated(self, time_updated): + """ + Sets the time_updated of this StreamDistributionChannel. + The time when the Stream Distribution Channel was updated. An RFC3339 formatted datetime string. + + + :param time_updated: The time_updated of this StreamDistributionChannel. + :type: datetime + """ + self._time_updated = time_updated + + @property + def lifecycle_state(self): + """ + Gets the lifecycle_state of this StreamDistributionChannel. + The current state of the Stream Distribution Channel. + + Allowed values for this property are: "ACTIVE", "NEEDS_ATTENTION", "DELETED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The lifecycle_state of this StreamDistributionChannel. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this StreamDistributionChannel. + The current state of the Stream Distribution Channel. + + + :param lifecycle_state: The lifecycle_state of this StreamDistributionChannel. + :type: str + """ + allowed_values = ["ACTIVE", "NEEDS_ATTENTION", "DELETED"] + 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 StreamDistributionChannel. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :return: The freeform_tags of this StreamDistributionChannel. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this StreamDistributionChannel. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :param freeform_tags: The freeform_tags of this StreamDistributionChannel. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this StreamDistributionChannel. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this StreamDistributionChannel. + :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 StreamDistributionChannel. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this StreamDistributionChannel. + :type: dict(str, dict(str, object)) + """ + self._defined_tags = defined_tags + + @property + def system_tags(self): + """ + Gets the system_tags of this StreamDistributionChannel. + 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 StreamDistributionChannel. + :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 StreamDistributionChannel. + 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 StreamDistributionChannel. + :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/media_services/models/stream_distribution_channel_collection.py b/src/oci/media_services/models/stream_distribution_channel_collection.py new file mode 100644 index 0000000000..f396a60b9c --- /dev/null +++ b/src/oci/media_services/models/stream_distribution_channel_collection.py @@ -0,0 +1,71 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 StreamDistributionChannelCollection(object): + """ + Results of a Stream Distribution Channel search. Contains both StreamDistributionChannelSummary items and other information, such as + metadata. + """ + + def __init__(self, **kwargs): + """ + Initializes a new StreamDistributionChannelCollection 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 StreamDistributionChannelCollection. + :type items: list[oci.media_services.models.StreamDistributionChannelSummary] + + """ + self.swagger_types = { + 'items': 'list[StreamDistributionChannelSummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this StreamDistributionChannelCollection. + List of Stream Distribution Channels. + + + :return: The items of this StreamDistributionChannelCollection. + :rtype: list[oci.media_services.models.StreamDistributionChannelSummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this StreamDistributionChannelCollection. + List of Stream Distribution Channels. + + + :param items: The items of this StreamDistributionChannelCollection. + :type: list[oci.media_services.models.StreamDistributionChannelSummary] + """ + 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/media_services/models/stream_distribution_channel_summary.py b/src/oci/media_services/models/stream_distribution_channel_summary.py new file mode 100644 index 0000000000..c78632572a --- /dev/null +++ b/src/oci/media_services/models/stream_distribution_channel_summary.py @@ -0,0 +1,355 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 StreamDistributionChannelSummary(object): + """ + Summary of the Stream Distribution Channel. + """ + + def __init__(self, **kwargs): + """ + Initializes a new StreamDistributionChannelSummary 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 StreamDistributionChannelSummary. + :type id: str + + :param display_name: + The value to assign to the display_name property of this StreamDistributionChannelSummary. + :type display_name: str + + :param compartment_id: + The value to assign to the compartment_id property of this StreamDistributionChannelSummary. + :type compartment_id: str + + :param domain_name: + The value to assign to the domain_name property of this StreamDistributionChannelSummary. + :type domain_name: str + + :param time_created: + The value to assign to the time_created property of this StreamDistributionChannelSummary. + :type time_created: datetime + + :param time_updated: + The value to assign to the time_updated property of this StreamDistributionChannelSummary. + :type time_updated: datetime + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this StreamDistributionChannelSummary. + :type lifecycle_state: str + + :param freeform_tags: + The value to assign to the freeform_tags property of this StreamDistributionChannelSummary. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this StreamDistributionChannelSummary. + :type defined_tags: dict(str, dict(str, object)) + + :param system_tags: + The value to assign to the system_tags property of this StreamDistributionChannelSummary. + :type system_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'id': 'str', + 'display_name': 'str', + 'compartment_id': 'str', + 'domain_name': 'str', + 'time_created': 'datetime', + 'time_updated': 'datetime', + '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', + 'domain_name': 'domainName', + 'time_created': 'timeCreated', + 'time_updated': 'timeUpdated', + 'lifecycle_state': 'lifecycleState', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags', + 'system_tags': 'systemTags' + } + + self._id = None + self._display_name = None + self._compartment_id = None + self._domain_name = None + self._time_created = None + self._time_updated = 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 StreamDistributionChannelSummary. + Unique identifier that is immutable on creation. + + + :return: The id of this StreamDistributionChannelSummary. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this StreamDistributionChannelSummary. + Unique identifier that is immutable on creation. + + + :param id: The id of this StreamDistributionChannelSummary. + :type: str + """ + self._id = id + + @property + def display_name(self): + """ + **[Required]** Gets the display_name of this StreamDistributionChannelSummary. + Stream Distribution Channel display name. + + + :return: The display_name of this StreamDistributionChannelSummary. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this StreamDistributionChannelSummary. + Stream Distribution Channel display name. + + + :param display_name: The display_name of this StreamDistributionChannelSummary. + :type: str + """ + self._display_name = display_name + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this StreamDistributionChannelSummary. + Compartment Identifier. + + + :return: The compartment_id of this StreamDistributionChannelSummary. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this StreamDistributionChannelSummary. + Compartment Identifier. + + + :param compartment_id: The compartment_id of this StreamDistributionChannelSummary. + :type: str + """ + self._compartment_id = compartment_id + + @property + def domain_name(self): + """ + Gets the domain_name of this StreamDistributionChannelSummary. + The unique domain name of the Distribution Channel. + + + :return: The domain_name of this StreamDistributionChannelSummary. + :rtype: str + """ + return self._domain_name + + @domain_name.setter + def domain_name(self, domain_name): + """ + Sets the domain_name of this StreamDistributionChannelSummary. + The unique domain name of the Distribution Channel. + + + :param domain_name: The domain_name of this StreamDistributionChannelSummary. + :type: str + """ + self._domain_name = domain_name + + @property + def time_created(self): + """ + Gets the time_created of this StreamDistributionChannelSummary. + The time when the Stream Distribution Channel was created. An RFC3339 formatted datetime string. + + + :return: The time_created of this StreamDistributionChannelSummary. + :rtype: datetime + """ + return self._time_created + + @time_created.setter + def time_created(self, time_created): + """ + Sets the time_created of this StreamDistributionChannelSummary. + The time when the Stream Distribution Channel was created. An RFC3339 formatted datetime string. + + + :param time_created: The time_created of this StreamDistributionChannelSummary. + :type: datetime + """ + self._time_created = time_created + + @property + def time_updated(self): + """ + Gets the time_updated of this StreamDistributionChannelSummary. + The time when the Stream Distribution Channel was updated. An RFC3339 formatted datetime string. + + + :return: The time_updated of this StreamDistributionChannelSummary. + :rtype: datetime + """ + return self._time_updated + + @time_updated.setter + def time_updated(self, time_updated): + """ + Sets the time_updated of this StreamDistributionChannelSummary. + The time when the Stream Distribution Channel was updated. An RFC3339 formatted datetime string. + + + :param time_updated: The time_updated of this StreamDistributionChannelSummary. + :type: datetime + """ + self._time_updated = time_updated + + @property + def lifecycle_state(self): + """ + Gets the lifecycle_state of this StreamDistributionChannelSummary. + The current state of the Stream Distribution Channel. + + + :return: The lifecycle_state of this StreamDistributionChannelSummary. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this StreamDistributionChannelSummary. + The current state of the Stream Distribution Channel. + + + :param lifecycle_state: The lifecycle_state of this StreamDistributionChannelSummary. + :type: str + """ + self._lifecycle_state = lifecycle_state + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this StreamDistributionChannelSummary. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :return: The freeform_tags of this StreamDistributionChannelSummary. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this StreamDistributionChannelSummary. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :param freeform_tags: The freeform_tags of this StreamDistributionChannelSummary. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this StreamDistributionChannelSummary. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this StreamDistributionChannelSummary. + :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 StreamDistributionChannelSummary. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this StreamDistributionChannelSummary. + :type: dict(str, dict(str, object)) + """ + self._defined_tags = defined_tags + + @property + def system_tags(self): + """ + Gets the system_tags of this StreamDistributionChannelSummary. + 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 StreamDistributionChannelSummary. + :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 StreamDistributionChannelSummary. + 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 StreamDistributionChannelSummary. + :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/media_services/models/stream_packaging_config.py b/src/oci/media_services/models/stream_packaging_config.py new file mode 100644 index 0000000000..4aee20580d --- /dev/null +++ b/src/oci/media_services/models/stream_packaging_config.py @@ -0,0 +1,501 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 StreamPackagingConfig(object): + """ + A stream packaging configuration for a Distribution Channel. + """ + + #: A constant which can be used with the stream_packaging_format property of a StreamPackagingConfig. + #: This constant has a value of "HLS" + STREAM_PACKAGING_FORMAT_HLS = "HLS" + + #: A constant which can be used with the stream_packaging_format property of a StreamPackagingConfig. + #: This constant has a value of "DASH" + STREAM_PACKAGING_FORMAT_DASH = "DASH" + + #: A constant which can be used with the lifecycle_state property of a StreamPackagingConfig. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a StreamPackagingConfig. + #: This constant has a value of "NEEDS_ATTENTION" + LIFECYCLE_STATE_NEEDS_ATTENTION = "NEEDS_ATTENTION" + + #: A constant which can be used with the lifecycle_state property of a StreamPackagingConfig. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" + + def __init__(self, **kwargs): + """ + Initializes a new StreamPackagingConfig 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.media_services.models.HlsStreamPackagingConfig` + * :class:`~oci.media_services.models.DashStreamPackagingConfig` + + 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 StreamPackagingConfig. + :type id: str + + :param compartment_id: + The value to assign to the compartment_id property of this StreamPackagingConfig. + :type compartment_id: str + + :param distribution_channel_id: + The value to assign to the distribution_channel_id property of this StreamPackagingConfig. + :type distribution_channel_id: str + + :param display_name: + The value to assign to the display_name property of this StreamPackagingConfig. + :type display_name: str + + :param stream_packaging_format: + The value to assign to the stream_packaging_format property of this StreamPackagingConfig. + Allowed values for this property are: "HLS", "DASH", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type stream_packaging_format: str + + :param segment_time_in_seconds: + The value to assign to the segment_time_in_seconds property of this StreamPackagingConfig. + :type segment_time_in_seconds: int + + :param encryption: + The value to assign to the encryption property of this StreamPackagingConfig. + :type encryption: oci.media_services.models.StreamPackagingConfigEncryption + + :param time_created: + The value to assign to the time_created property of this StreamPackagingConfig. + :type time_created: datetime + + :param time_updated: + The value to assign to the time_updated property of this StreamPackagingConfig. + :type time_updated: datetime + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this StreamPackagingConfig. + Allowed values for this property are: "ACTIVE", "NEEDS_ATTENTION", "DELETED", '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 StreamPackagingConfig. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this StreamPackagingConfig. + :type defined_tags: dict(str, dict(str, object)) + + :param system_tags: + The value to assign to the system_tags property of this StreamPackagingConfig. + :type system_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'id': 'str', + 'compartment_id': 'str', + 'distribution_channel_id': 'str', + 'display_name': 'str', + 'stream_packaging_format': 'str', + 'segment_time_in_seconds': 'int', + 'encryption': 'StreamPackagingConfigEncryption', + 'time_created': 'datetime', + 'time_updated': 'datetime', + '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', + 'compartment_id': 'compartmentId', + 'distribution_channel_id': 'distributionChannelId', + 'display_name': 'displayName', + 'stream_packaging_format': 'streamPackagingFormat', + 'segment_time_in_seconds': 'segmentTimeInSeconds', + 'encryption': 'encryption', + 'time_created': 'timeCreated', + 'time_updated': 'timeUpdated', + 'lifecycle_state': 'lifecycleState', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags', + 'system_tags': 'systemTags' + } + + self._id = None + self._compartment_id = None + self._distribution_channel_id = None + self._display_name = None + self._stream_packaging_format = None + self._segment_time_in_seconds = None + self._encryption = None + self._time_created = None + self._time_updated = None + self._lifecycle_state = None + self._freeform_tags = None + self._defined_tags = None + self._system_tags = None + + @staticmethod + def get_subtype(object_dictionary): + """ + Given the hash representation of a subtype of this class, + use the info in the hash to return the class of the subtype. + """ + type = object_dictionary['streamPackagingFormat'] + + if type == 'HLS': + return 'HlsStreamPackagingConfig' + + if type == 'DASH': + return 'DashStreamPackagingConfig' + else: + return 'StreamPackagingConfig' + + @property + def id(self): + """ + **[Required]** Gets the id of this StreamPackagingConfig. + Unique identifier that is immutable on creation. + + + :return: The id of this StreamPackagingConfig. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this StreamPackagingConfig. + Unique identifier that is immutable on creation. + + + :param id: The id of this StreamPackagingConfig. + :type: str + """ + self._id = id + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this StreamPackagingConfig. + Compartment Identifier + + + :return: The compartment_id of this StreamPackagingConfig. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this StreamPackagingConfig. + Compartment Identifier + + + :param compartment_id: The compartment_id of this StreamPackagingConfig. + :type: str + """ + self._compartment_id = compartment_id + + @property + def distribution_channel_id(self): + """ + **[Required]** Gets the distribution_channel_id of this StreamPackagingConfig. + Unique identifier of the Distribution Channel that this stream packaging configuration belongs to. + + + :return: The distribution_channel_id of this StreamPackagingConfig. + :rtype: str + """ + return self._distribution_channel_id + + @distribution_channel_id.setter + def distribution_channel_id(self, distribution_channel_id): + """ + Sets the distribution_channel_id of this StreamPackagingConfig. + Unique identifier of the Distribution Channel that this stream packaging configuration belongs to. + + + :param distribution_channel_id: The distribution_channel_id of this StreamPackagingConfig. + :type: str + """ + self._distribution_channel_id = distribution_channel_id + + @property + def display_name(self): + """ + **[Required]** Gets the display_name of this StreamPackagingConfig. + The name of the stream packaging configuration. + + + :return: The display_name of this StreamPackagingConfig. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this StreamPackagingConfig. + The name of the stream packaging configuration. + + + :param display_name: The display_name of this StreamPackagingConfig. + :type: str + """ + self._display_name = display_name + + @property + def stream_packaging_format(self): + """ + **[Required]** Gets the stream_packaging_format of this StreamPackagingConfig. + The output format for the package. + + Allowed values for this property are: "HLS", "DASH", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The stream_packaging_format of this StreamPackagingConfig. + :rtype: str + """ + return self._stream_packaging_format + + @stream_packaging_format.setter + def stream_packaging_format(self, stream_packaging_format): + """ + Sets the stream_packaging_format of this StreamPackagingConfig. + The output format for the package. + + + :param stream_packaging_format: The stream_packaging_format of this StreamPackagingConfig. + :type: str + """ + allowed_values = ["HLS", "DASH"] + if not value_allowed_none_or_none_sentinel(stream_packaging_format, allowed_values): + stream_packaging_format = 'UNKNOWN_ENUM_VALUE' + self._stream_packaging_format = stream_packaging_format + + @property + def segment_time_in_seconds(self): + """ + **[Required]** Gets the segment_time_in_seconds of this StreamPackagingConfig. + The duration in seconds for each fragment. + + + :return: The segment_time_in_seconds of this StreamPackagingConfig. + :rtype: int + """ + return self._segment_time_in_seconds + + @segment_time_in_seconds.setter + def segment_time_in_seconds(self, segment_time_in_seconds): + """ + Sets the segment_time_in_seconds of this StreamPackagingConfig. + The duration in seconds for each fragment. + + + :param segment_time_in_seconds: The segment_time_in_seconds of this StreamPackagingConfig. + :type: int + """ + self._segment_time_in_seconds = segment_time_in_seconds + + @property + def encryption(self): + """ + Gets the encryption of this StreamPackagingConfig. + + :return: The encryption of this StreamPackagingConfig. + :rtype: oci.media_services.models.StreamPackagingConfigEncryption + """ + return self._encryption + + @encryption.setter + def encryption(self, encryption): + """ + Sets the encryption of this StreamPackagingConfig. + + :param encryption: The encryption of this StreamPackagingConfig. + :type: oci.media_services.models.StreamPackagingConfigEncryption + """ + self._encryption = encryption + + @property + def time_created(self): + """ + Gets the time_created of this StreamPackagingConfig. + The time when the Packaging Configuration was created. An RFC3339 formatted datetime string. + + + :return: The time_created of this StreamPackagingConfig. + :rtype: datetime + """ + return self._time_created + + @time_created.setter + def time_created(self, time_created): + """ + Sets the time_created of this StreamPackagingConfig. + The time when the Packaging Configuration was created. An RFC3339 formatted datetime string. + + + :param time_created: The time_created of this StreamPackagingConfig. + :type: datetime + """ + self._time_created = time_created + + @property + def time_updated(self): + """ + Gets the time_updated of this StreamPackagingConfig. + The time when the Packaging Configuration was updated. An RFC3339 formatted datetime string. + + + :return: The time_updated of this StreamPackagingConfig. + :rtype: datetime + """ + return self._time_updated + + @time_updated.setter + def time_updated(self, time_updated): + """ + Sets the time_updated of this StreamPackagingConfig. + The time when the Packaging Configuration was updated. An RFC3339 formatted datetime string. + + + :param time_updated: The time_updated of this StreamPackagingConfig. + :type: datetime + """ + self._time_updated = time_updated + + @property + def lifecycle_state(self): + """ + Gets the lifecycle_state of this StreamPackagingConfig. + The current state of the Packaging Configuration. + + Allowed values for this property are: "ACTIVE", "NEEDS_ATTENTION", "DELETED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The lifecycle_state of this StreamPackagingConfig. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this StreamPackagingConfig. + The current state of the Packaging Configuration. + + + :param lifecycle_state: The lifecycle_state of this StreamPackagingConfig. + :type: str + """ + allowed_values = ["ACTIVE", "NEEDS_ATTENTION", "DELETED"] + 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 StreamPackagingConfig. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :return: The freeform_tags of this StreamPackagingConfig. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this StreamPackagingConfig. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :param freeform_tags: The freeform_tags of this StreamPackagingConfig. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this StreamPackagingConfig. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this StreamPackagingConfig. + :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 StreamPackagingConfig. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this StreamPackagingConfig. + :type: dict(str, dict(str, object)) + """ + self._defined_tags = defined_tags + + @property + def system_tags(self): + """ + Gets the system_tags of this StreamPackagingConfig. + 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 StreamPackagingConfig. + :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 StreamPackagingConfig. + 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 StreamPackagingConfig. + :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/media_services/models/stream_packaging_config_collection.py b/src/oci/media_services/models/stream_packaging_config_collection.py new file mode 100644 index 0000000000..b3a1fd9e57 --- /dev/null +++ b/src/oci/media_services/models/stream_packaging_config_collection.py @@ -0,0 +1,71 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 StreamPackagingConfigCollection(object): + """ + Results of a Packaging Configuration search. Contains both StreamPackagingConfigSummary items and other information, such as + metadata. + """ + + def __init__(self, **kwargs): + """ + Initializes a new StreamPackagingConfigCollection 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 StreamPackagingConfigCollection. + :type items: list[oci.media_services.models.StreamPackagingConfigSummary] + + """ + self.swagger_types = { + 'items': 'list[StreamPackagingConfigSummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this StreamPackagingConfigCollection. + List of Packaging Configurations. + + + :return: The items of this StreamPackagingConfigCollection. + :rtype: list[oci.media_services.models.StreamPackagingConfigSummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this StreamPackagingConfigCollection. + List of Packaging Configurations. + + + :param items: The items of this StreamPackagingConfigCollection. + :type: list[oci.media_services.models.StreamPackagingConfigSummary] + """ + 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/media_services/models/stream_packaging_config_encryption.py b/src/oci/media_services/models/stream_packaging_config_encryption.py new file mode 100644 index 0000000000..2fd4aeab73 --- /dev/null +++ b/src/oci/media_services/models/stream_packaging_config_encryption.py @@ -0,0 +1,107 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 StreamPackagingConfigEncryption(object): + """ + The encryption used by the stream packaging configuration. + """ + + #: A constant which can be used with the algorithm property of a StreamPackagingConfigEncryption. + #: This constant has a value of "NONE" + ALGORITHM_NONE = "NONE" + + #: A constant which can be used with the algorithm property of a StreamPackagingConfigEncryption. + #: This constant has a value of "AES128" + ALGORITHM_AES128 = "AES128" + + def __init__(self, **kwargs): + """ + Initializes a new StreamPackagingConfigEncryption 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.media_services.models.StreamPackagingConfigEncryptionAes128` + * :class:`~oci.media_services.models.StreamPackagingConfigEncryptionNone` + + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param algorithm: + The value to assign to the algorithm property of this StreamPackagingConfigEncryption. + Allowed values for this property are: "NONE", "AES128", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type algorithm: str + + """ + self.swagger_types = { + 'algorithm': 'str' + } + + self.attribute_map = { + 'algorithm': 'algorithm' + } + + self._algorithm = 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['algorithm'] + + if type == 'AES128': + return 'StreamPackagingConfigEncryptionAes128' + + if type == 'NONE': + return 'StreamPackagingConfigEncryptionNone' + else: + return 'StreamPackagingConfigEncryption' + + @property + def algorithm(self): + """ + **[Required]** Gets the algorithm of this StreamPackagingConfigEncryption. + The encryption algorithm for the stream packaging configuration. + + Allowed values for this property are: "NONE", "AES128", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The algorithm of this StreamPackagingConfigEncryption. + :rtype: str + """ + return self._algorithm + + @algorithm.setter + def algorithm(self, algorithm): + """ + Sets the algorithm of this StreamPackagingConfigEncryption. + The encryption algorithm for the stream packaging configuration. + + + :param algorithm: The algorithm of this StreamPackagingConfigEncryption. + :type: str + """ + allowed_values = ["NONE", "AES128"] + if not value_allowed_none_or_none_sentinel(algorithm, allowed_values): + algorithm = 'UNKNOWN_ENUM_VALUE' + self._algorithm = algorithm + + 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/media_services/models/stream_packaging_config_encryption_aes128.py b/src/oci/media_services/models/stream_packaging_config_encryption_aes128.py new file mode 100644 index 0000000000..5b9a2ebe0a --- /dev/null +++ b/src/oci/media_services/models/stream_packaging_config_encryption_aes128.py @@ -0,0 +1,80 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .stream_packaging_config_encryption import StreamPackagingConfigEncryption +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 StreamPackagingConfigEncryptionAes128(StreamPackagingConfigEncryption): + """ + AES128 encryption type (enabled by default). + """ + + def __init__(self, **kwargs): + """ + Initializes a new StreamPackagingConfigEncryptionAes128 object with values from keyword arguments. The default value of the :py:attr:`~oci.media_services.models.StreamPackagingConfigEncryptionAes128.algorithm` attribute + of this class is ``AES128`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param algorithm: + The value to assign to the algorithm property of this StreamPackagingConfigEncryptionAes128. + Allowed values for this property are: "NONE", "AES128" + :type algorithm: str + + :param kms_key_id: + The value to assign to the kms_key_id property of this StreamPackagingConfigEncryptionAes128. + :type kms_key_id: str + + """ + self.swagger_types = { + 'algorithm': 'str', + 'kms_key_id': 'str' + } + + self.attribute_map = { + 'algorithm': 'algorithm', + 'kms_key_id': 'kmsKeyId' + } + + self._algorithm = None + self._kms_key_id = None + self._algorithm = 'AES128' + + @property + def kms_key_id(self): + """ + Gets the kms_key_id of this StreamPackagingConfigEncryptionAes128. + The identifier of the customer managed Vault KMS symmetric encryption key (null if Oracle managed). + + + :return: The kms_key_id of this StreamPackagingConfigEncryptionAes128. + :rtype: str + """ + return self._kms_key_id + + @kms_key_id.setter + def kms_key_id(self, kms_key_id): + """ + Sets the kms_key_id of this StreamPackagingConfigEncryptionAes128. + The identifier of the customer managed Vault KMS symmetric encryption key (null if Oracle managed). + + + :param kms_key_id: The kms_key_id of this StreamPackagingConfigEncryptionAes128. + :type: str + """ + self._kms_key_id = kms_key_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/media_services/models/stream_packaging_config_encryption_none.py b/src/oci/media_services/models/stream_packaging_config_encryption_none.py new file mode 100644 index 0000000000..d333749cfa --- /dev/null +++ b/src/oci/media_services/models/stream_packaging_config_encryption_none.py @@ -0,0 +1,49 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .stream_packaging_config_encryption import StreamPackagingConfigEncryption +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 StreamPackagingConfigEncryptionNone(StreamPackagingConfigEncryption): + """ + Disables encryption. + """ + + def __init__(self, **kwargs): + """ + Initializes a new StreamPackagingConfigEncryptionNone object with values from keyword arguments. The default value of the :py:attr:`~oci.media_services.models.StreamPackagingConfigEncryptionNone.algorithm` 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 algorithm: + The value to assign to the algorithm property of this StreamPackagingConfigEncryptionNone. + Allowed values for this property are: "NONE", "AES128" + :type algorithm: str + + """ + self.swagger_types = { + 'algorithm': 'str' + } + + self.attribute_map = { + 'algorithm': 'algorithm' + } + + self._algorithm = None + self._algorithm = '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/media_services/models/stream_packaging_config_summary.py b/src/oci/media_services/models/stream_packaging_config_summary.py new file mode 100644 index 0000000000..94acb61784 --- /dev/null +++ b/src/oci/media_services/models/stream_packaging_config_summary.py @@ -0,0 +1,355 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 StreamPackagingConfigSummary(object): + """ + Summary of the Packaging Configuration. + """ + + def __init__(self, **kwargs): + """ + Initializes a new StreamPackagingConfigSummary 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 StreamPackagingConfigSummary. + :type id: str + + :param compartment_id: + The value to assign to the compartment_id property of this StreamPackagingConfigSummary. + :type compartment_id: str + + :param distribution_channel_id: + The value to assign to the distribution_channel_id property of this StreamPackagingConfigSummary. + :type distribution_channel_id: str + + :param display_name: + The value to assign to the display_name property of this StreamPackagingConfigSummary. + :type display_name: str + + :param time_created: + The value to assign to the time_created property of this StreamPackagingConfigSummary. + :type time_created: datetime + + :param time_updated: + The value to assign to the time_updated property of this StreamPackagingConfigSummary. + :type time_updated: datetime + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this StreamPackagingConfigSummary. + :type lifecycle_state: str + + :param freeform_tags: + The value to assign to the freeform_tags property of this StreamPackagingConfigSummary. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this StreamPackagingConfigSummary. + :type defined_tags: dict(str, dict(str, object)) + + :param system_tags: + The value to assign to the system_tags property of this StreamPackagingConfigSummary. + :type system_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'id': 'str', + 'compartment_id': 'str', + 'distribution_channel_id': 'str', + 'display_name': 'str', + 'time_created': 'datetime', + 'time_updated': 'datetime', + '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', + 'compartment_id': 'compartmentId', + 'distribution_channel_id': 'distributionChannelId', + 'display_name': 'displayName', + 'time_created': 'timeCreated', + 'time_updated': 'timeUpdated', + 'lifecycle_state': 'lifecycleState', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags', + 'system_tags': 'systemTags' + } + + self._id = None + self._compartment_id = None + self._distribution_channel_id = None + self._display_name = None + self._time_created = None + self._time_updated = 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 StreamPackagingConfigSummary. + Unique identifier that is immutable on creation. + + + :return: The id of this StreamPackagingConfigSummary. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this StreamPackagingConfigSummary. + Unique identifier that is immutable on creation. + + + :param id: The id of this StreamPackagingConfigSummary. + :type: str + """ + self._id = id + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this StreamPackagingConfigSummary. + Compartment Identifier. + + + :return: The compartment_id of this StreamPackagingConfigSummary. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this StreamPackagingConfigSummary. + Compartment Identifier. + + + :param compartment_id: The compartment_id of this StreamPackagingConfigSummary. + :type: str + """ + self._compartment_id = compartment_id + + @property + def distribution_channel_id(self): + """ + **[Required]** Gets the distribution_channel_id of this StreamPackagingConfigSummary. + Unique identifier of the distribution channel that this stream packaging configuration belongs to. + + + :return: The distribution_channel_id of this StreamPackagingConfigSummary. + :rtype: str + """ + return self._distribution_channel_id + + @distribution_channel_id.setter + def distribution_channel_id(self, distribution_channel_id): + """ + Sets the distribution_channel_id of this StreamPackagingConfigSummary. + Unique identifier of the distribution channel that this stream packaging configuration belongs to. + + + :param distribution_channel_id: The distribution_channel_id of this StreamPackagingConfigSummary. + :type: str + """ + self._distribution_channel_id = distribution_channel_id + + @property + def display_name(self): + """ + **[Required]** Gets the display_name of this StreamPackagingConfigSummary. + Stream Packaging Configuration display name. + + + :return: The display_name of this StreamPackagingConfigSummary. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this StreamPackagingConfigSummary. + Stream Packaging Configuration display name. + + + :param display_name: The display_name of this StreamPackagingConfigSummary. + :type: str + """ + self._display_name = display_name + + @property + def time_created(self): + """ + Gets the time_created of this StreamPackagingConfigSummary. + The time when the Distribution Channel was created. An RFC3339 formatted datetime string. + + + :return: The time_created of this StreamPackagingConfigSummary. + :rtype: datetime + """ + return self._time_created + + @time_created.setter + def time_created(self, time_created): + """ + Sets the time_created of this StreamPackagingConfigSummary. + The time when the Distribution Channel was created. An RFC3339 formatted datetime string. + + + :param time_created: The time_created of this StreamPackagingConfigSummary. + :type: datetime + """ + self._time_created = time_created + + @property + def time_updated(self): + """ + Gets the time_updated of this StreamPackagingConfigSummary. + The time when the Distribution Channel was updated. An RFC3339 formatted datetime string. + + + :return: The time_updated of this StreamPackagingConfigSummary. + :rtype: datetime + """ + return self._time_updated + + @time_updated.setter + def time_updated(self, time_updated): + """ + Sets the time_updated of this StreamPackagingConfigSummary. + The time when the Distribution Channel was updated. An RFC3339 formatted datetime string. + + + :param time_updated: The time_updated of this StreamPackagingConfigSummary. + :type: datetime + """ + self._time_updated = time_updated + + @property + def lifecycle_state(self): + """ + Gets the lifecycle_state of this StreamPackagingConfigSummary. + The current state of the Distribution Channel. + + + :return: The lifecycle_state of this StreamPackagingConfigSummary. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this StreamPackagingConfigSummary. + The current state of the Distribution Channel. + + + :param lifecycle_state: The lifecycle_state of this StreamPackagingConfigSummary. + :type: str + """ + self._lifecycle_state = lifecycle_state + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this StreamPackagingConfigSummary. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :return: The freeform_tags of this StreamPackagingConfigSummary. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this StreamPackagingConfigSummary. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :param freeform_tags: The freeform_tags of this StreamPackagingConfigSummary. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this StreamPackagingConfigSummary. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this StreamPackagingConfigSummary. + :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 StreamPackagingConfigSummary. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this StreamPackagingConfigSummary. + :type: dict(str, dict(str, object)) + """ + self._defined_tags = defined_tags + + @property + def system_tags(self): + """ + Gets the system_tags of this StreamPackagingConfigSummary. + 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 StreamPackagingConfigSummary. + :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 StreamPackagingConfigSummary. + 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 StreamPackagingConfigSummary. + :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/media_services/models/system_media_workflow.py b/src/oci/media_services/models/system_media_workflow.py new file mode 100644 index 0000000000..6a20417774 --- /dev/null +++ b/src/oci/media_services/models/system_media_workflow.py @@ -0,0 +1,173 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 SystemMediaWorkflow(object): + """ + A named list of tasks to be used to run a job or as a template to create a MediaWorkflow. + """ + + def __init__(self, **kwargs): + """ + Initializes a new SystemMediaWorkflow 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 SystemMediaWorkflow. + :type name: str + + :param description: + The value to assign to the description property of this SystemMediaWorkflow. + :type description: str + + :param parameters: + The value to assign to the parameters property of this SystemMediaWorkflow. + :type parameters: dict(str, str) + + :param tasks: + The value to assign to the tasks property of this SystemMediaWorkflow. + :type tasks: list[oci.media_services.models.MediaWorkflowTask] + + """ + self.swagger_types = { + 'name': 'str', + 'description': 'str', + 'parameters': 'dict(str, str)', + 'tasks': 'list[MediaWorkflowTask]' + } + + self.attribute_map = { + 'name': 'name', + 'description': 'description', + 'parameters': 'parameters', + 'tasks': 'tasks' + } + + self._name = None + self._description = None + self._parameters = None + self._tasks = None + + @property + def name(self): + """ + **[Required]** Gets the name of this SystemMediaWorkflow. + System provided unique identifier for this static media workflow. + + + :return: The name of this SystemMediaWorkflow. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this SystemMediaWorkflow. + System provided unique identifier for this static media workflow. + + + :param name: The name of this SystemMediaWorkflow. + :type: str + """ + self._name = name + + @property + def description(self): + """ + Gets the description of this SystemMediaWorkflow. + Description of this workflow's processing and how that processing can be customized by + specifying parameter values. + + + :return: The description of this SystemMediaWorkflow. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this SystemMediaWorkflow. + Description of this workflow's processing and how that processing can be customized by + specifying parameter values. + + + :param description: The description of this SystemMediaWorkflow. + :type: str + """ + self._description = description + + @property + def parameters(self): + """ + Gets the parameters of this SystemMediaWorkflow. + JSON object representing named parameters and their default values that can be referenced throughout this workflow. + The values declared here can be overridden by the MediaWorkflowConfigurations or parameters supplied when creating + MediaWorkflowJobs from this MediaWorkflow. + + + :return: The parameters of this SystemMediaWorkflow. + :rtype: dict(str, str) + """ + return self._parameters + + @parameters.setter + def parameters(self, parameters): + """ + Sets the parameters of this SystemMediaWorkflow. + JSON object representing named parameters and their default values that can be referenced throughout this workflow. + The values declared here can be overridden by the MediaWorkflowConfigurations or parameters supplied when creating + MediaWorkflowJobs from this MediaWorkflow. + + + :param parameters: The parameters of this SystemMediaWorkflow. + :type: dict(str, str) + """ + self._parameters = parameters + + @property + def tasks(self): + """ + **[Required]** Gets the tasks of this SystemMediaWorkflow. + The processing to be done in this workflow. Each key of the MediaWorkflowTasks in this array is unique + within the array. The order of the items is preserved from the order of the tasks array in + CreateMediaWorkflowDetails or UpdateMediaWorkflowDetails. + + + :return: The tasks of this SystemMediaWorkflow. + :rtype: list[oci.media_services.models.MediaWorkflowTask] + """ + return self._tasks + + @tasks.setter + def tasks(self, tasks): + """ + Sets the tasks of this SystemMediaWorkflow. + The processing to be done in this workflow. Each key of the MediaWorkflowTasks in this array is unique + within the array. The order of the items is preserved from the order of the tasks array in + CreateMediaWorkflowDetails or UpdateMediaWorkflowDetails. + + + :param tasks: The tasks of this SystemMediaWorkflow. + :type: list[oci.media_services.models.MediaWorkflowTask] + """ + self._tasks = tasks + + 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/media_services/models/system_media_workflow_collection.py b/src/oci/media_services/models/system_media_workflow_collection.py new file mode 100644 index 0000000000..bdb490c3ad --- /dev/null +++ b/src/oci/media_services/models/system_media_workflow_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 SystemMediaWorkflowCollection(object): + """ + Result for the ListSystemMediaWorkflows operation. + """ + + def __init__(self, **kwargs): + """ + Initializes a new SystemMediaWorkflowCollection 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 SystemMediaWorkflowCollection. + :type items: list[oci.media_services.models.SystemMediaWorkflow] + + """ + self.swagger_types = { + 'items': 'list[SystemMediaWorkflow]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this SystemMediaWorkflowCollection. + List of SytemMediaWorkflow items. + + + :return: The items of this SystemMediaWorkflowCollection. + :rtype: list[oci.media_services.models.SystemMediaWorkflow] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this SystemMediaWorkflowCollection. + List of SytemMediaWorkflow items. + + + :param items: The items of this SystemMediaWorkflowCollection. + :type: list[oci.media_services.models.SystemMediaWorkflow] + """ + 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/media_services/models/update_media_asset_details.py b/src/oci/media_services/models/update_media_asset_details.py new file mode 100644 index 0000000000..69cb9d27ba --- /dev/null +++ b/src/oci/media_services/models/update_media_asset_details.py @@ -0,0 +1,324 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 UpdateMediaAssetDetails(object): + """ + The information to be updated. + """ + + #: A constant which can be used with the type property of a UpdateMediaAssetDetails. + #: This constant has a value of "AUDIO" + TYPE_AUDIO = "AUDIO" + + #: A constant which can be used with the type property of a UpdateMediaAssetDetails. + #: This constant has a value of "VIDEO" + TYPE_VIDEO = "VIDEO" + + #: A constant which can be used with the type property of a UpdateMediaAssetDetails. + #: This constant has a value of "PLAYLIST" + TYPE_PLAYLIST = "PLAYLIST" + + #: A constant which can be used with the type property of a UpdateMediaAssetDetails. + #: This constant has a value of "IMAGE" + TYPE_IMAGE = "IMAGE" + + #: A constant which can be used with the type property of a UpdateMediaAssetDetails. + #: This constant has a value of "CAPTION_FILE" + TYPE_CAPTION_FILE = "CAPTION_FILE" + + #: A constant which can be used with the type property of a UpdateMediaAssetDetails. + #: This constant has a value of "UNKNOWN" + TYPE_UNKNOWN = "UNKNOWN" + + def __init__(self, **kwargs): + """ + Initializes a new UpdateMediaAssetDetails 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 UpdateMediaAssetDetails. + :type display_name: str + + :param type: + The value to assign to the type property of this UpdateMediaAssetDetails. + Allowed values for this property are: "AUDIO", "VIDEO", "PLAYLIST", "IMAGE", "CAPTION_FILE", "UNKNOWN" + :type type: str + + :param parent_media_asset_id: + The value to assign to the parent_media_asset_id property of this UpdateMediaAssetDetails. + :type parent_media_asset_id: str + + :param master_media_asset_id: + The value to assign to the master_media_asset_id property of this UpdateMediaAssetDetails. + :type master_media_asset_id: str + + :param metadata: + The value to assign to the metadata property of this UpdateMediaAssetDetails. + :type metadata: list[oci.media_services.models.Metadata] + + :param media_asset_tags: + The value to assign to the media_asset_tags property of this UpdateMediaAssetDetails. + :type media_asset_tags: list[oci.media_services.models.MediaAssetTag] + + :param freeform_tags: + The value to assign to the freeform_tags property of this UpdateMediaAssetDetails. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this UpdateMediaAssetDetails. + :type defined_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'display_name': 'str', + 'type': 'str', + 'parent_media_asset_id': 'str', + 'master_media_asset_id': 'str', + 'metadata': 'list[Metadata]', + 'media_asset_tags': 'list[MediaAssetTag]', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))' + } + + self.attribute_map = { + 'display_name': 'displayName', + 'type': 'type', + 'parent_media_asset_id': 'parentMediaAssetId', + 'master_media_asset_id': 'masterMediaAssetId', + 'metadata': 'metadata', + 'media_asset_tags': 'mediaAssetTags', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags' + } + + self._display_name = None + self._type = None + self._parent_media_asset_id = None + self._master_media_asset_id = None + self._metadata = None + self._media_asset_tags = None + self._freeform_tags = None + self._defined_tags = None + + @property + def display_name(self): + """ + Gets the display_name of this UpdateMediaAssetDetails. + Display name for the Media Asset. Does not have to be unique. Avoid entering confidential information. + + + :return: The display_name of this UpdateMediaAssetDetails. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this UpdateMediaAssetDetails. + Display name for the Media Asset. Does not have to be unique. Avoid entering confidential information. + + + :param display_name: The display_name of this UpdateMediaAssetDetails. + :type: str + """ + self._display_name = display_name + + @property + def type(self): + """ + Gets the type of this UpdateMediaAssetDetails. + The type of the media asset. + + Allowed values for this property are: "AUDIO", "VIDEO", "PLAYLIST", "IMAGE", "CAPTION_FILE", "UNKNOWN" + + + :return: The type of this UpdateMediaAssetDetails. + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """ + Sets the type of this UpdateMediaAssetDetails. + The type of the media asset. + + + :param type: The type of this UpdateMediaAssetDetails. + :type: str + """ + allowed_values = ["AUDIO", "VIDEO", "PLAYLIST", "IMAGE", "CAPTION_FILE", "UNKNOWN"] + if not value_allowed_none_or_none_sentinel(type, allowed_values): + raise ValueError( + "Invalid value for `type`, must be None or one of {0}" + .format(allowed_values) + ) + self._type = type + + @property + def parent_media_asset_id(self): + """ + Gets the parent_media_asset_id of this UpdateMediaAssetDetails. + The ID of the parent asset from which this asset is derived. + + + :return: The parent_media_asset_id of this UpdateMediaAssetDetails. + :rtype: str + """ + return self._parent_media_asset_id + + @parent_media_asset_id.setter + def parent_media_asset_id(self, parent_media_asset_id): + """ + Sets the parent_media_asset_id of this UpdateMediaAssetDetails. + The ID of the parent asset from which this asset is derived. + + + :param parent_media_asset_id: The parent_media_asset_id of this UpdateMediaAssetDetails. + :type: str + """ + self._parent_media_asset_id = parent_media_asset_id + + @property + def master_media_asset_id(self): + """ + Gets the master_media_asset_id of this UpdateMediaAssetDetails. + The ID of the senior most asset from which this asset is derived. + + + :return: The master_media_asset_id of this UpdateMediaAssetDetails. + :rtype: str + """ + return self._master_media_asset_id + + @master_media_asset_id.setter + def master_media_asset_id(self, master_media_asset_id): + """ + Sets the master_media_asset_id of this UpdateMediaAssetDetails. + The ID of the senior most asset from which this asset is derived. + + + :param master_media_asset_id: The master_media_asset_id of this UpdateMediaAssetDetails. + :type: str + """ + self._master_media_asset_id = master_media_asset_id + + @property + def metadata(self): + """ + Gets the metadata of this UpdateMediaAssetDetails. + List of Metadata. + + + :return: The metadata of this UpdateMediaAssetDetails. + :rtype: list[oci.media_services.models.Metadata] + """ + return self._metadata + + @metadata.setter + def metadata(self, metadata): + """ + Sets the metadata of this UpdateMediaAssetDetails. + List of Metadata. + + + :param metadata: The metadata of this UpdateMediaAssetDetails. + :type: list[oci.media_services.models.Metadata] + """ + self._metadata = metadata + + @property + def media_asset_tags(self): + """ + Gets the media_asset_tags of this UpdateMediaAssetDetails. + List of tags for the MediaAsset. + + + :return: The media_asset_tags of this UpdateMediaAssetDetails. + :rtype: list[oci.media_services.models.MediaAssetTag] + """ + return self._media_asset_tags + + @media_asset_tags.setter + def media_asset_tags(self, media_asset_tags): + """ + Sets the media_asset_tags of this UpdateMediaAssetDetails. + List of tags for the MediaAsset. + + + :param media_asset_tags: The media_asset_tags of this UpdateMediaAssetDetails. + :type: list[oci.media_services.models.MediaAssetTag] + """ + self._media_asset_tags = media_asset_tags + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this UpdateMediaAssetDetails. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :return: The freeform_tags of this UpdateMediaAssetDetails. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this UpdateMediaAssetDetails. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :param freeform_tags: The freeform_tags of this UpdateMediaAssetDetails. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this UpdateMediaAssetDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this UpdateMediaAssetDetails. + :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 UpdateMediaAssetDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this UpdateMediaAssetDetails. + :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/media_services/models/update_media_workflow_configuration_details.py b/src/oci/media_services/models/update_media_workflow_configuration_details.py new file mode 100644 index 0000000000..4e7d6b8a7f --- /dev/null +++ b/src/oci/media_services/models/update_media_workflow_configuration_details.py @@ -0,0 +1,173 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 UpdateMediaWorkflowConfigurationDetails(object): + """ + The information to be updated. + """ + + def __init__(self, **kwargs): + """ + Initializes a new UpdateMediaWorkflowConfigurationDetails 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 UpdateMediaWorkflowConfigurationDetails. + :type display_name: str + + :param parameters: + The value to assign to the parameters property of this UpdateMediaWorkflowConfigurationDetails. + :type parameters: dict(str, str) + + :param freeform_tags: + The value to assign to the freeform_tags property of this UpdateMediaWorkflowConfigurationDetails. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this UpdateMediaWorkflowConfigurationDetails. + :type defined_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'display_name': 'str', + 'parameters': 'dict(str, str)', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))' + } + + self.attribute_map = { + 'display_name': 'displayName', + 'parameters': 'parameters', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags' + } + + self._display_name = None + self._parameters = None + self._freeform_tags = None + self._defined_tags = None + + @property + def display_name(self): + """ + Gets the display_name of this UpdateMediaWorkflowConfigurationDetails. + Name for the MediaWorkflowConfiguration. Does not have to be unique, and it's changeable. Avoid entering confidential information. + + + :return: The display_name of this UpdateMediaWorkflowConfigurationDetails. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this UpdateMediaWorkflowConfigurationDetails. + Name for the MediaWorkflowConfiguration. Does not have to be unique, and it's changeable. Avoid entering confidential information. + + + :param display_name: The display_name of this UpdateMediaWorkflowConfigurationDetails. + :type: str + """ + self._display_name = display_name + + @property + def parameters(self): + """ + Gets the parameters of this UpdateMediaWorkflowConfigurationDetails. + Reuseable parameter values encoded as a JSON; the top and second level JSON elements are + objects. Each key of the top level object refer to a task key that is unqiue to the + workflow, each of the second level objects' keys refer to the name of a parameter that is + unique to the task. taskKey -> parameterName -> parameterValue + + + :return: The parameters of this UpdateMediaWorkflowConfigurationDetails. + :rtype: dict(str, str) + """ + return self._parameters + + @parameters.setter + def parameters(self, parameters): + """ + Sets the parameters of this UpdateMediaWorkflowConfigurationDetails. + Reuseable parameter values encoded as a JSON; the top and second level JSON elements are + objects. Each key of the top level object refer to a task key that is unqiue to the + workflow, each of the second level objects' keys refer to the name of a parameter that is + unique to the task. taskKey -> parameterName -> parameterValue + + + :param parameters: The parameters of this UpdateMediaWorkflowConfigurationDetails. + :type: dict(str, str) + """ + self._parameters = parameters + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this UpdateMediaWorkflowConfigurationDetails. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :return: The freeform_tags of this UpdateMediaWorkflowConfigurationDetails. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this UpdateMediaWorkflowConfigurationDetails. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :param freeform_tags: The freeform_tags of this UpdateMediaWorkflowConfigurationDetails. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this UpdateMediaWorkflowConfigurationDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this UpdateMediaWorkflowConfigurationDetails. + :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 UpdateMediaWorkflowConfigurationDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this UpdateMediaWorkflowConfigurationDetails. + :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/media_services/models/update_media_workflow_details.py b/src/oci/media_services/models/update_media_workflow_details.py new file mode 100644 index 0000000000..41a8059be1 --- /dev/null +++ b/src/oci/media_services/models/update_media_workflow_details.py @@ -0,0 +1,239 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 UpdateMediaWorkflowDetails(object): + """ + The information to be updated. + """ + + def __init__(self, **kwargs): + """ + Initializes a new UpdateMediaWorkflowDetails 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 UpdateMediaWorkflowDetails. + :type display_name: str + + :param tasks: + The value to assign to the tasks property of this UpdateMediaWorkflowDetails. + :type tasks: list[oci.media_services.models.MediaWorkflowTask] + + :param media_workflow_configuration_ids: + The value to assign to the media_workflow_configuration_ids property of this UpdateMediaWorkflowDetails. + :type media_workflow_configuration_ids: list[str] + + :param parameters: + The value to assign to the parameters property of this UpdateMediaWorkflowDetails. + :type parameters: dict(str, str) + + :param freeform_tags: + The value to assign to the freeform_tags property of this UpdateMediaWorkflowDetails. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this UpdateMediaWorkflowDetails. + :type defined_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'display_name': 'str', + 'tasks': 'list[MediaWorkflowTask]', + 'media_workflow_configuration_ids': 'list[str]', + 'parameters': 'dict(str, str)', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))' + } + + self.attribute_map = { + 'display_name': 'displayName', + 'tasks': 'tasks', + 'media_workflow_configuration_ids': 'mediaWorkflowConfigurationIds', + 'parameters': 'parameters', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags' + } + + self._display_name = None + self._tasks = None + self._media_workflow_configuration_ids = None + self._parameters = None + self._freeform_tags = None + self._defined_tags = None + + @property + def display_name(self): + """ + Gets the display_name of this UpdateMediaWorkflowDetails. + Name for the MediaWorkflow. Does not have to be unique, and it's changeable. Avoid entering confidential information. + + + :return: The display_name of this UpdateMediaWorkflowDetails. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this UpdateMediaWorkflowDetails. + Name for the MediaWorkflow. Does not have to be unique, and it's changeable. Avoid entering confidential information. + + + :param display_name: The display_name of this UpdateMediaWorkflowDetails. + :type: str + """ + self._display_name = display_name + + @property + def tasks(self): + """ + Gets the tasks of this UpdateMediaWorkflowDetails. + The processing to be done in this workflow. Each key of the MediaWorkflowTasks in this array must be unique + within the array. + + + :return: The tasks of this UpdateMediaWorkflowDetails. + :rtype: list[oci.media_services.models.MediaWorkflowTask] + """ + return self._tasks + + @tasks.setter + def tasks(self, tasks): + """ + Sets the tasks of this UpdateMediaWorkflowDetails. + The processing to be done in this workflow. Each key of the MediaWorkflowTasks in this array must be unique + within the array. + + + :param tasks: The tasks of this UpdateMediaWorkflowDetails. + :type: list[oci.media_services.models.MediaWorkflowTask] + """ + self._tasks = tasks + + @property + def media_workflow_configuration_ids(self): + """ + Gets the media_workflow_configuration_ids of this UpdateMediaWorkflowDetails. + Configurations to be applied to all jobs for this workflow. Parameters in these configurations are + overridden by parameters in the MediaWorkflowConfigurations of the MediaWorkflogJob and the + parameters of the MediaWorkflowJob. + + + :return: The media_workflow_configuration_ids of this UpdateMediaWorkflowDetails. + :rtype: list[str] + """ + return self._media_workflow_configuration_ids + + @media_workflow_configuration_ids.setter + def media_workflow_configuration_ids(self, media_workflow_configuration_ids): + """ + Sets the media_workflow_configuration_ids of this UpdateMediaWorkflowDetails. + Configurations to be applied to all jobs for this workflow. Parameters in these configurations are + overridden by parameters in the MediaWorkflowConfigurations of the MediaWorkflogJob and the + parameters of the MediaWorkflowJob. + + + :param media_workflow_configuration_ids: The media_workflow_configuration_ids of this UpdateMediaWorkflowDetails. + :type: list[str] + """ + self._media_workflow_configuration_ids = media_workflow_configuration_ids + + @property + def parameters(self): + """ + Gets the parameters of this UpdateMediaWorkflowDetails. + JSON object representing named parameters and their default values that can be referenced throughout this workflow. + The values declared here can be overridden by the MediaWorkflowConfigurations or parameters supplied when creating + MediaWorkflowJobs from this MediaWorkflow. + + + :return: The parameters of this UpdateMediaWorkflowDetails. + :rtype: dict(str, str) + """ + return self._parameters + + @parameters.setter + def parameters(self, parameters): + """ + Sets the parameters of this UpdateMediaWorkflowDetails. + JSON object representing named parameters and their default values that can be referenced throughout this workflow. + The values declared here can be overridden by the MediaWorkflowConfigurations or parameters supplied when creating + MediaWorkflowJobs from this MediaWorkflow. + + + :param parameters: The parameters of this UpdateMediaWorkflowDetails. + :type: dict(str, str) + """ + self._parameters = parameters + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this UpdateMediaWorkflowDetails. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :return: The freeform_tags of this UpdateMediaWorkflowDetails. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this UpdateMediaWorkflowDetails. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :param freeform_tags: The freeform_tags of this UpdateMediaWorkflowDetails. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this UpdateMediaWorkflowDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this UpdateMediaWorkflowDetails. + :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 UpdateMediaWorkflowDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this UpdateMediaWorkflowDetails. + :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/media_services/models/update_media_workflow_job_details.py b/src/oci/media_services/models/update_media_workflow_job_details.py new file mode 100644 index 0000000000..6946b874c9 --- /dev/null +++ b/src/oci/media_services/models/update_media_workflow_job_details.py @@ -0,0 +1,136 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 UpdateMediaWorkflowJobDetails(object): + """ + The information to be updated. + """ + + def __init__(self, **kwargs): + """ + Initializes a new UpdateMediaWorkflowJobDetails 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 UpdateMediaWorkflowJobDetails. + :type display_name: str + + :param freeform_tags: + The value to assign to the freeform_tags property of this UpdateMediaWorkflowJobDetails. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this UpdateMediaWorkflowJobDetails. + :type defined_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'display_name': 'str', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))' + } + + self.attribute_map = { + 'display_name': 'displayName', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags' + } + + self._display_name = None + self._freeform_tags = None + self._defined_tags = None + + @property + def display_name(self): + """ + Gets the display_name of this UpdateMediaWorkflowJobDetails. + Name for the MediaWorkflowJob. Does not have to be unique. Avoid entering confidential information. + + + :return: The display_name of this UpdateMediaWorkflowJobDetails. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this UpdateMediaWorkflowJobDetails. + Name for the MediaWorkflowJob. Does not have to be unique. Avoid entering confidential information. + + + :param display_name: The display_name of this UpdateMediaWorkflowJobDetails. + :type: str + """ + self._display_name = display_name + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this UpdateMediaWorkflowJobDetails. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :return: The freeform_tags of this UpdateMediaWorkflowJobDetails. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this UpdateMediaWorkflowJobDetails. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :param freeform_tags: The freeform_tags of this UpdateMediaWorkflowJobDetails. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this UpdateMediaWorkflowJobDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this UpdateMediaWorkflowJobDetails. + :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 UpdateMediaWorkflowJobDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this UpdateMediaWorkflowJobDetails. + :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/media_services/models/update_stream_cdn_config_details.py b/src/oci/media_services/models/update_stream_cdn_config_details.py new file mode 100644 index 0000000000..3b1f628ea0 --- /dev/null +++ b/src/oci/media_services/models/update_stream_cdn_config_details.py @@ -0,0 +1,194 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 UpdateStreamCdnConfigDetails(object): + """ + The information to be updated. + """ + + def __init__(self, **kwargs): + """ + Initializes a new UpdateStreamCdnConfigDetails 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 UpdateStreamCdnConfigDetails. + :type display_name: str + + :param is_enabled: + The value to assign to the is_enabled property of this UpdateStreamCdnConfigDetails. + :type is_enabled: bool + + :param config: + The value to assign to the config property of this UpdateStreamCdnConfigDetails. + :type config: oci.media_services.models.StreamCdnConfigSection + + :param freeform_tags: + The value to assign to the freeform_tags property of this UpdateStreamCdnConfigDetails. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this UpdateStreamCdnConfigDetails. + :type defined_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'display_name': 'str', + 'is_enabled': 'bool', + 'config': 'StreamCdnConfigSection', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))' + } + + self.attribute_map = { + 'display_name': 'displayName', + 'is_enabled': 'isEnabled', + 'config': 'config', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags' + } + + self._display_name = None + self._is_enabled = None + self._config = None + self._freeform_tags = None + self._defined_tags = None + + @property + def display_name(self): + """ + Gets the display_name of this UpdateStreamCdnConfigDetails. + CDN Config display name. + + + :return: The display_name of this UpdateStreamCdnConfigDetails. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this UpdateStreamCdnConfigDetails. + CDN Config display name. + + + :param display_name: The display_name of this UpdateStreamCdnConfigDetails. + :type: str + """ + self._display_name = display_name + + @property + def is_enabled(self): + """ + Gets the is_enabled of this UpdateStreamCdnConfigDetails. + Whether CDN is enabled for publishing. + + + :return: The is_enabled of this UpdateStreamCdnConfigDetails. + :rtype: bool + """ + return self._is_enabled + + @is_enabled.setter + def is_enabled(self, is_enabled): + """ + Sets the is_enabled of this UpdateStreamCdnConfigDetails. + Whether CDN is enabled for publishing. + + + :param is_enabled: The is_enabled of this UpdateStreamCdnConfigDetails. + :type: bool + """ + self._is_enabled = is_enabled + + @property + def config(self): + """ + Gets the config of this UpdateStreamCdnConfigDetails. + + :return: The config of this UpdateStreamCdnConfigDetails. + :rtype: oci.media_services.models.StreamCdnConfigSection + """ + return self._config + + @config.setter + def config(self, config): + """ + Sets the config of this UpdateStreamCdnConfigDetails. + + :param config: The config of this UpdateStreamCdnConfigDetails. + :type: oci.media_services.models.StreamCdnConfigSection + """ + self._config = config + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this UpdateStreamCdnConfigDetails. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :return: The freeform_tags of this UpdateStreamCdnConfigDetails. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this UpdateStreamCdnConfigDetails. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :param freeform_tags: The freeform_tags of this UpdateStreamCdnConfigDetails. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this UpdateStreamCdnConfigDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this UpdateStreamCdnConfigDetails. + :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 UpdateStreamCdnConfigDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this UpdateStreamCdnConfigDetails. + :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/media_services/models/update_stream_distribution_channel_details.py b/src/oci/media_services/models/update_stream_distribution_channel_details.py new file mode 100644 index 0000000000..7d7a13b3ae --- /dev/null +++ b/src/oci/media_services/models/update_stream_distribution_channel_details.py @@ -0,0 +1,136 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 UpdateStreamDistributionChannelDetails(object): + """ + The information to be updated. + """ + + def __init__(self, **kwargs): + """ + Initializes a new UpdateStreamDistributionChannelDetails 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 UpdateStreamDistributionChannelDetails. + :type display_name: str + + :param freeform_tags: + The value to assign to the freeform_tags property of this UpdateStreamDistributionChannelDetails. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this UpdateStreamDistributionChannelDetails. + :type defined_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'display_name': 'str', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))' + } + + self.attribute_map = { + 'display_name': 'displayName', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags' + } + + self._display_name = None + self._freeform_tags = None + self._defined_tags = None + + @property + def display_name(self): + """ + Gets the display_name of this UpdateStreamDistributionChannelDetails. + Stream Distribution channel display name. + + + :return: The display_name of this UpdateStreamDistributionChannelDetails. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this UpdateStreamDistributionChannelDetails. + Stream Distribution channel display name. + + + :param display_name: The display_name of this UpdateStreamDistributionChannelDetails. + :type: str + """ + self._display_name = display_name + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this UpdateStreamDistributionChannelDetails. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :return: The freeform_tags of this UpdateStreamDistributionChannelDetails. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this UpdateStreamDistributionChannelDetails. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :param freeform_tags: The freeform_tags of this UpdateStreamDistributionChannelDetails. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this UpdateStreamDistributionChannelDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this UpdateStreamDistributionChannelDetails. + :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 UpdateStreamDistributionChannelDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this UpdateStreamDistributionChannelDetails. + :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/media_services/models/update_stream_packaging_config_details.py b/src/oci/media_services/models/update_stream_packaging_config_details.py new file mode 100644 index 0000000000..5e5c52baad --- /dev/null +++ b/src/oci/media_services/models/update_stream_packaging_config_details.py @@ -0,0 +1,136 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 UpdateStreamPackagingConfigDetails(object): + """ + The information to be updated. + """ + + def __init__(self, **kwargs): + """ + Initializes a new UpdateStreamPackagingConfigDetails 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 UpdateStreamPackagingConfigDetails. + :type display_name: str + + :param freeform_tags: + The value to assign to the freeform_tags property of this UpdateStreamPackagingConfigDetails. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this UpdateStreamPackagingConfigDetails. + :type defined_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'display_name': 'str', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))' + } + + self.attribute_map = { + 'display_name': 'displayName', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags' + } + + self._display_name = None + self._freeform_tags = None + self._defined_tags = None + + @property + def display_name(self): + """ + Gets the display_name of this UpdateStreamPackagingConfigDetails. + The name of the stream Packaging Configuration. + + + :return: The display_name of this UpdateStreamPackagingConfigDetails. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this UpdateStreamPackagingConfigDetails. + The name of the stream Packaging Configuration. + + + :param display_name: The display_name of this UpdateStreamPackagingConfigDetails. + :type: str + """ + self._display_name = display_name + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this UpdateStreamPackagingConfigDetails. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :return: The freeform_tags of this UpdateStreamPackagingConfigDetails. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this UpdateStreamPackagingConfigDetails. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :param freeform_tags: The freeform_tags of this UpdateStreamPackagingConfigDetails. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this UpdateStreamPackagingConfigDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this UpdateStreamPackagingConfigDetails. + :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 UpdateStreamPackagingConfigDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this UpdateStreamPackagingConfigDetails. + :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/opa/__init__.py b/src/oci/opa/__init__.py new file mode 100644 index 0000000000..e5613fc773 --- /dev/null +++ b/src/oci/opa/__init__.py @@ -0,0 +1,12 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from __future__ import absolute_import + + +from .opa_instance_client import OpaInstanceClient +from .opa_instance_client_composite_operations import OpaInstanceClientCompositeOperations +from . import models + +__all__ = ["OpaInstanceClient", "OpaInstanceClientCompositeOperations", "models"] diff --git a/src/oci/opa/models/__init__.py b/src/oci/opa/models/__init__.py new file mode 100644 index 0000000000..85f659bc68 --- /dev/null +++ b/src/oci/opa/models/__init__.py @@ -0,0 +1,38 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from __future__ import absolute_import + +from .change_opa_instance_compartment_details import ChangeOpaInstanceCompartmentDetails +from .create_opa_instance_details import CreateOpaInstanceDetails +from .opa_instance import OpaInstance +from .opa_instance_collection import OpaInstanceCollection +from .opa_instance_summary import OpaInstanceSummary +from .update_opa_instance_details import UpdateOpaInstanceDetails +from .work_request import WorkRequest +from .work_request_error import WorkRequestError +from .work_request_error_collection import WorkRequestErrorCollection +from .work_request_log_entry import WorkRequestLogEntry +from .work_request_log_entry_collection import WorkRequestLogEntryCollection +from .work_request_resource import WorkRequestResource +from .work_request_summary import WorkRequestSummary +from .work_request_summary_collection import WorkRequestSummaryCollection + +# Maps type names to classes for opa services. +opa_type_mapping = { + "ChangeOpaInstanceCompartmentDetails": ChangeOpaInstanceCompartmentDetails, + "CreateOpaInstanceDetails": CreateOpaInstanceDetails, + "OpaInstance": OpaInstance, + "OpaInstanceCollection": OpaInstanceCollection, + "OpaInstanceSummary": OpaInstanceSummary, + "UpdateOpaInstanceDetails": UpdateOpaInstanceDetails, + "WorkRequest": WorkRequest, + "WorkRequestError": WorkRequestError, + "WorkRequestErrorCollection": WorkRequestErrorCollection, + "WorkRequestLogEntry": WorkRequestLogEntry, + "WorkRequestLogEntryCollection": WorkRequestLogEntryCollection, + "WorkRequestResource": WorkRequestResource, + "WorkRequestSummary": WorkRequestSummary, + "WorkRequestSummaryCollection": WorkRequestSummaryCollection +} diff --git a/src/oci/opa/models/change_opa_instance_compartment_details.py b/src/oci/opa/models/change_opa_instance_compartment_details.py new file mode 100644 index 0000000000..f18313c707 --- /dev/null +++ b/src/oci/opa/models/change_opa_instance_compartment_details.py @@ -0,0 +1,76 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 ChangeOpaInstanceCompartmentDetails(object): + """ + The information to be updated. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ChangeOpaInstanceCompartmentDetails 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 ChangeOpaInstanceCompartmentDetails. + :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 ChangeOpaInstanceCompartmentDetails. + 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 ChangeOpaInstanceCompartmentDetails. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this ChangeOpaInstanceCompartmentDetails. + 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 ChangeOpaInstanceCompartmentDetails. + :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/opa/models/create_opa_instance_details.py b/src/oci/opa/models/create_opa_instance_details.py new file mode 100644 index 0000000000..8edbb878e7 --- /dev/null +++ b/src/oci/opa/models/create_opa_instance_details.py @@ -0,0 +1,353 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 CreateOpaInstanceDetails(object): + """ + The information about new OpaInstance. + """ + + def __init__(self, **kwargs): + """ + Initializes a new CreateOpaInstanceDetails 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 CreateOpaInstanceDetails. + :type display_name: str + + :param description: + The value to assign to the description property of this CreateOpaInstanceDetails. + :type description: str + + :param compartment_id: + The value to assign to the compartment_id property of this CreateOpaInstanceDetails. + :type compartment_id: str + + :param consumption_model: + The value to assign to the consumption_model property of this CreateOpaInstanceDetails. + :type consumption_model: str + + :param shape_name: + The value to assign to the shape_name property of this CreateOpaInstanceDetails. + :type shape_name: str + + :param metering_type: + The value to assign to the metering_type property of this CreateOpaInstanceDetails. + :type metering_type: str + + :param idcs_at: + The value to assign to the idcs_at property of this CreateOpaInstanceDetails. + :type idcs_at: str + + :param is_breakglass_enabled: + The value to assign to the is_breakglass_enabled property of this CreateOpaInstanceDetails. + :type is_breakglass_enabled: bool + + :param freeform_tags: + The value to assign to the freeform_tags property of this CreateOpaInstanceDetails. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this CreateOpaInstanceDetails. + :type defined_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'display_name': 'str', + 'description': 'str', + 'compartment_id': 'str', + 'consumption_model': 'str', + 'shape_name': 'str', + 'metering_type': 'str', + 'idcs_at': 'str', + 'is_breakglass_enabled': 'bool', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))' + } + + self.attribute_map = { + 'display_name': 'displayName', + 'description': 'description', + 'compartment_id': 'compartmentId', + 'consumption_model': 'consumptionModel', + 'shape_name': 'shapeName', + 'metering_type': 'meteringType', + 'idcs_at': 'idcsAt', + 'is_breakglass_enabled': 'isBreakglassEnabled', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags' + } + + self._display_name = None + self._description = None + self._compartment_id = None + self._consumption_model = None + self._shape_name = None + self._metering_type = None + self._idcs_at = None + self._is_breakglass_enabled = None + self._freeform_tags = None + self._defined_tags = None + + @property + def display_name(self): + """ + **[Required]** Gets the display_name of this CreateOpaInstanceDetails. + OpaInstance Identifier. User-friendly name for the instance. Avoid entering confidential information. You can change this value anytime. + + + :return: The display_name of this CreateOpaInstanceDetails. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this CreateOpaInstanceDetails. + OpaInstance Identifier. User-friendly name for the instance. Avoid entering confidential information. You can change this value anytime. + + + :param display_name: The display_name of this CreateOpaInstanceDetails. + :type: str + """ + self._display_name = display_name + + @property + def description(self): + """ + Gets the description of this CreateOpaInstanceDetails. + Description of the Oracle Process Automation instance. + + + :return: The description of this CreateOpaInstanceDetails. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this CreateOpaInstanceDetails. + Description of the Oracle Process Automation instance. + + + :param description: The description of this CreateOpaInstanceDetails. + :type: str + """ + self._description = description + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this CreateOpaInstanceDetails. + Compartment Identifier + + + :return: The compartment_id of this CreateOpaInstanceDetails. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this CreateOpaInstanceDetails. + Compartment Identifier + + + :param compartment_id: The compartment_id of this CreateOpaInstanceDetails. + :type: str + """ + self._compartment_id = compartment_id + + @property + def consumption_model(self): + """ + Gets the consumption_model of this CreateOpaInstanceDetails. + Parameter specifying which entitlement to use for billing purposes + + + :return: The consumption_model of this CreateOpaInstanceDetails. + :rtype: str + """ + return self._consumption_model + + @consumption_model.setter + def consumption_model(self, consumption_model): + """ + Sets the consumption_model of this CreateOpaInstanceDetails. + Parameter specifying which entitlement to use for billing purposes + + + :param consumption_model: The consumption_model of this CreateOpaInstanceDetails. + :type: str + """ + self._consumption_model = consumption_model + + @property + def shape_name(self): + """ + **[Required]** Gets the shape_name of this CreateOpaInstanceDetails. + Shape of the instance. + + + :return: The shape_name of this CreateOpaInstanceDetails. + :rtype: str + """ + return self._shape_name + + @shape_name.setter + def shape_name(self, shape_name): + """ + Sets the shape_name of this CreateOpaInstanceDetails. + Shape of the instance. + + + :param shape_name: The shape_name of this CreateOpaInstanceDetails. + :type: str + """ + self._shape_name = shape_name + + @property + def metering_type(self): + """ + Gets the metering_type of this CreateOpaInstanceDetails. + MeteringType Identifier + + + :return: The metering_type of this CreateOpaInstanceDetails. + :rtype: str + """ + return self._metering_type + + @metering_type.setter + def metering_type(self, metering_type): + """ + Sets the metering_type of this CreateOpaInstanceDetails. + MeteringType Identifier + + + :param metering_type: The metering_type of this CreateOpaInstanceDetails. + :type: str + """ + self._metering_type = metering_type + + @property + def idcs_at(self): + """ + Gets the idcs_at of this CreateOpaInstanceDetails. + IDCS Authentication token. This is required for all realms with IDCS. This property is optional, as it is not required for non-IDCS realms. + + + :return: The idcs_at of this CreateOpaInstanceDetails. + :rtype: str + """ + return self._idcs_at + + @idcs_at.setter + def idcs_at(self, idcs_at): + """ + Sets the idcs_at of this CreateOpaInstanceDetails. + IDCS Authentication token. This is required for all realms with IDCS. This property is optional, as it is not required for non-IDCS realms. + + + :param idcs_at: The idcs_at of this CreateOpaInstanceDetails. + :type: str + """ + self._idcs_at = idcs_at + + @property + def is_breakglass_enabled(self): + """ + Gets the is_breakglass_enabled of this CreateOpaInstanceDetails. + indicates if breakGlass is enabled for the opa instance. + + + :return: The is_breakglass_enabled of this CreateOpaInstanceDetails. + :rtype: bool + """ + return self._is_breakglass_enabled + + @is_breakglass_enabled.setter + def is_breakglass_enabled(self, is_breakglass_enabled): + """ + Sets the is_breakglass_enabled of this CreateOpaInstanceDetails. + indicates if breakGlass is enabled for the opa instance. + + + :param is_breakglass_enabled: The is_breakglass_enabled of this CreateOpaInstanceDetails. + :type: bool + """ + self._is_breakglass_enabled = is_breakglass_enabled + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this CreateOpaInstanceDetails. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :return: The freeform_tags of this CreateOpaInstanceDetails. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this CreateOpaInstanceDetails. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :param freeform_tags: The freeform_tags of this CreateOpaInstanceDetails. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this CreateOpaInstanceDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this CreateOpaInstanceDetails. + :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 CreateOpaInstanceDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this CreateOpaInstanceDetails. + :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/opa/models/opa_instance.py b/src/oci/opa/models/opa_instance.py new file mode 100644 index 0000000000..4ab07a2655 --- /dev/null +++ b/src/oci/opa/models/opa_instance.py @@ -0,0 +1,726 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 OpaInstance(object): + """ + Description of OpaInstance. + """ + + #: A constant which can be used with the consumption_model property of a OpaInstance. + #: This constant has a value of "UCM" + CONSUMPTION_MODEL_UCM = "UCM" + + #: A constant which can be used with the consumption_model property of a OpaInstance. + #: This constant has a value of "GOV" + CONSUMPTION_MODEL_GOV = "GOV" + + #: A constant which can be used with the consumption_model property of a OpaInstance. + #: This constant has a value of "SAAS" + CONSUMPTION_MODEL_SAAS = "SAAS" + + #: A constant which can be used with the shape_name property of a OpaInstance. + #: This constant has a value of "DEVELOPMENT" + SHAPE_NAME_DEVELOPMENT = "DEVELOPMENT" + + #: A constant which can be used with the shape_name property of a OpaInstance. + #: This constant has a value of "PRODUCTION" + SHAPE_NAME_PRODUCTION = "PRODUCTION" + + #: A constant which can be used with the metering_type property of a OpaInstance. + #: This constant has a value of "EXECUTION_PACK" + METERING_TYPE_EXECUTION_PACK = "EXECUTION_PACK" + + #: A constant which can be used with the metering_type property of a OpaInstance. + #: This constant has a value of "USERS" + METERING_TYPE_USERS = "USERS" + + #: A constant which can be used with the metering_type property of a OpaInstance. + #: This constant has a value of "EMPLOYEE" + METERING_TYPE_EMPLOYEE = "EMPLOYEE" + + #: A constant which can be used with the metering_type property of a OpaInstance. + #: This constant has a value of "NAMED_USER" + METERING_TYPE_NAMED_USER = "NAMED_USER" + + #: A constant which can be used with the lifecycle_state property of a OpaInstance. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + #: A constant which can be used with the lifecycle_state property of a OpaInstance. + #: This constant has a value of "UPDATING" + LIFECYCLE_STATE_UPDATING = "UPDATING" + + #: A constant which can be used with the lifecycle_state property of a OpaInstance. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a OpaInstance. + #: This constant has a value of "DELETING" + LIFECYCLE_STATE_DELETING = "DELETING" + + #: A constant which can be used with the lifecycle_state property of a OpaInstance. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" + + #: A constant which can be used with the lifecycle_state property of a OpaInstance. + #: This constant has a value of "FAILED" + LIFECYCLE_STATE_FAILED = "FAILED" + + def __init__(self, **kwargs): + """ + Initializes a new OpaInstance 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 OpaInstance. + :type id: str + + :param display_name: + The value to assign to the display_name property of this OpaInstance. + :type display_name: str + + :param description: + The value to assign to the description property of this OpaInstance. + :type description: str + + :param compartment_id: + The value to assign to the compartment_id property of this OpaInstance. + :type compartment_id: str + + :param instance_url: + The value to assign to the instance_url property of this OpaInstance. + :type instance_url: str + + :param consumption_model: + The value to assign to the consumption_model property of this OpaInstance. + Allowed values for this property are: "UCM", "GOV", "SAAS", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type consumption_model: str + + :param shape_name: + The value to assign to the shape_name property of this OpaInstance. + Allowed values for this property are: "DEVELOPMENT", "PRODUCTION", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type shape_name: str + + :param metering_type: + The value to assign to the metering_type property of this OpaInstance. + Allowed values for this property are: "EXECUTION_PACK", "USERS", "EMPLOYEE", "NAMED_USER", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type metering_type: str + + :param time_created: + The value to assign to the time_created property of this OpaInstance. + :type time_created: datetime + + :param time_updated: + The value to assign to the time_updated property of this OpaInstance. + :type time_updated: datetime + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this OpaInstance. + Allowed values for this property are: "CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type lifecycle_state: str + + :param identity_app_guid: + The value to assign to the identity_app_guid property of this OpaInstance. + :type identity_app_guid: str + + :param identity_app_display_name: + The value to assign to the identity_app_display_name property of this OpaInstance. + :type identity_app_display_name: str + + :param identity_domain_url: + The value to assign to the identity_domain_url property of this OpaInstance. + :type identity_domain_url: str + + :param identity_app_opc_service_instance_guid: + The value to assign to the identity_app_opc_service_instance_guid property of this OpaInstance. + :type identity_app_opc_service_instance_guid: str + + :param is_breakglass_enabled: + The value to assign to the is_breakglass_enabled property of this OpaInstance. + :type is_breakglass_enabled: bool + + :param freeform_tags: + The value to assign to the freeform_tags property of this OpaInstance. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this OpaInstance. + :type defined_tags: dict(str, dict(str, object)) + + :param system_tags: + The value to assign to the system_tags property of this OpaInstance. + :type system_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'id': 'str', + 'display_name': 'str', + 'description': 'str', + 'compartment_id': 'str', + 'instance_url': 'str', + 'consumption_model': 'str', + 'shape_name': 'str', + 'metering_type': 'str', + 'time_created': 'datetime', + 'time_updated': 'datetime', + 'lifecycle_state': 'str', + 'identity_app_guid': 'str', + 'identity_app_display_name': 'str', + 'identity_domain_url': 'str', + 'identity_app_opc_service_instance_guid': 'str', + 'is_breakglass_enabled': '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', + 'instance_url': 'instanceUrl', + 'consumption_model': 'consumptionModel', + 'shape_name': 'shapeName', + 'metering_type': 'meteringType', + 'time_created': 'timeCreated', + 'time_updated': 'timeUpdated', + 'lifecycle_state': 'lifecycleState', + 'identity_app_guid': 'identityAppGuid', + 'identity_app_display_name': 'identityAppDisplayName', + 'identity_domain_url': 'identityDomainUrl', + 'identity_app_opc_service_instance_guid': 'identityAppOpcServiceInstanceGuid', + 'is_breakglass_enabled': 'isBreakglassEnabled', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags', + 'system_tags': 'systemTags' + } + + self._id = None + self._display_name = None + self._description = None + self._compartment_id = None + self._instance_url = None + self._consumption_model = None + self._shape_name = None + self._metering_type = None + self._time_created = None + self._time_updated = None + self._lifecycle_state = None + self._identity_app_guid = None + self._identity_app_display_name = None + self._identity_domain_url = None + self._identity_app_opc_service_instance_guid = None + self._is_breakglass_enabled = None + self._freeform_tags = None + self._defined_tags = None + self._system_tags = None + + @property + def id(self): + """ + **[Required]** Gets the id of this OpaInstance. + Unique identifier that is immutable on creation + + + :return: The id of this OpaInstance. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this OpaInstance. + Unique identifier that is immutable on creation + + + :param id: The id of this OpaInstance. + :type: str + """ + self._id = id + + @property + def display_name(self): + """ + **[Required]** Gets the display_name of this OpaInstance. + OpaInstance Identifier, can be renamed + + + :return: The display_name of this OpaInstance. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this OpaInstance. + OpaInstance Identifier, can be renamed + + + :param display_name: The display_name of this OpaInstance. + :type: str + """ + self._display_name = display_name + + @property + def description(self): + """ + Gets the description of this OpaInstance. + Description of the Process Automation instance. + + + :return: The description of this OpaInstance. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this OpaInstance. + Description of the Process Automation instance. + + + :param description: The description of this OpaInstance. + :type: str + """ + self._description = description + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this OpaInstance. + Compartment Identifier + + + :return: The compartment_id of this OpaInstance. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this OpaInstance. + Compartment Identifier + + + :param compartment_id: The compartment_id of this OpaInstance. + :type: str + """ + self._compartment_id = compartment_id + + @property + def instance_url(self): + """ + Gets the instance_url of this OpaInstance. + OPA Instance URL + + + :return: The instance_url of this OpaInstance. + :rtype: str + """ + return self._instance_url + + @instance_url.setter + def instance_url(self, instance_url): + """ + Sets the instance_url of this OpaInstance. + OPA Instance URL + + + :param instance_url: The instance_url of this OpaInstance. + :type: str + """ + self._instance_url = instance_url + + @property + def consumption_model(self): + """ + Gets the consumption_model of this OpaInstance. + The entitlement used for billing purposes + + Allowed values for this property are: "UCM", "GOV", "SAAS", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The consumption_model of this OpaInstance. + :rtype: str + """ + return self._consumption_model + + @consumption_model.setter + def consumption_model(self, consumption_model): + """ + Sets the consumption_model of this OpaInstance. + The entitlement used for billing purposes + + + :param consumption_model: The consumption_model of this OpaInstance. + :type: str + """ + allowed_values = ["UCM", "GOV", "SAAS"] + if not value_allowed_none_or_none_sentinel(consumption_model, allowed_values): + consumption_model = 'UNKNOWN_ENUM_VALUE' + self._consumption_model = consumption_model + + @property + def shape_name(self): + """ + **[Required]** Gets the shape_name of this OpaInstance. + Shape of the instance. + + Allowed values for this property are: "DEVELOPMENT", "PRODUCTION", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The shape_name of this OpaInstance. + :rtype: str + """ + return self._shape_name + + @shape_name.setter + def shape_name(self, shape_name): + """ + Sets the shape_name of this OpaInstance. + Shape of the instance. + + + :param shape_name: The shape_name of this OpaInstance. + :type: str + """ + allowed_values = ["DEVELOPMENT", "PRODUCTION"] + if not value_allowed_none_or_none_sentinel(shape_name, allowed_values): + shape_name = 'UNKNOWN_ENUM_VALUE' + self._shape_name = shape_name + + @property + def metering_type(self): + """ + Gets the metering_type of this OpaInstance. + MeteringType Identifier + + Allowed values for this property are: "EXECUTION_PACK", "USERS", "EMPLOYEE", "NAMED_USER", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The metering_type of this OpaInstance. + :rtype: str + """ + return self._metering_type + + @metering_type.setter + def metering_type(self, metering_type): + """ + Sets the metering_type of this OpaInstance. + MeteringType Identifier + + + :param metering_type: The metering_type of this OpaInstance. + :type: str + """ + allowed_values = ["EXECUTION_PACK", "USERS", "EMPLOYEE", "NAMED_USER"] + if not value_allowed_none_or_none_sentinel(metering_type, allowed_values): + metering_type = 'UNKNOWN_ENUM_VALUE' + self._metering_type = metering_type + + @property + def time_created(self): + """ + **[Required]** Gets the time_created of this OpaInstance. + The time when OpaInstance was created. An RFC3339 formatted datetime string + + + :return: The time_created of this OpaInstance. + :rtype: datetime + """ + return self._time_created + + @time_created.setter + def time_created(self, time_created): + """ + Sets the time_created of this OpaInstance. + The time when OpaInstance was created. An RFC3339 formatted datetime string + + + :param time_created: The time_created of this OpaInstance. + :type: datetime + """ + self._time_created = time_created + + @property + def time_updated(self): + """ + Gets the time_updated of this OpaInstance. + The time the OpaInstance was updated. An RFC3339 formatted datetime string + + + :return: The time_updated of this OpaInstance. + :rtype: datetime + """ + return self._time_updated + + @time_updated.setter + def time_updated(self, time_updated): + """ + Sets the time_updated of this OpaInstance. + The time the OpaInstance was updated. An RFC3339 formatted datetime string + + + :param time_updated: The time_updated of this OpaInstance. + :type: datetime + """ + self._time_updated = time_updated + + @property + def lifecycle_state(self): + """ + **[Required]** Gets the lifecycle_state of this OpaInstance. + The current state of the OpaInstance. + + Allowed values for this property are: "CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The lifecycle_state of this OpaInstance. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this OpaInstance. + The current state of the OpaInstance. + + + :param lifecycle_state: The lifecycle_state of this OpaInstance. + :type: str + """ + allowed_values = ["CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED"] + if not value_allowed_none_or_none_sentinel(lifecycle_state, allowed_values): + lifecycle_state = 'UNKNOWN_ENUM_VALUE' + self._lifecycle_state = lifecycle_state + + @property + def identity_app_guid(self): + """ + Gets the identity_app_guid of this OpaInstance. + This property specifies the GUID of the Identity Application instance OPA has created inside the user-specified identity domain. This identity application instance may be used to host user role mappings to grant access to this OPA instance for users within the identity domain. + + + :return: The identity_app_guid of this OpaInstance. + :rtype: str + """ + return self._identity_app_guid + + @identity_app_guid.setter + def identity_app_guid(self, identity_app_guid): + """ + Sets the identity_app_guid of this OpaInstance. + This property specifies the GUID of the Identity Application instance OPA has created inside the user-specified identity domain. This identity application instance may be used to host user role mappings to grant access to this OPA instance for users within the identity domain. + + + :param identity_app_guid: The identity_app_guid of this OpaInstance. + :type: str + """ + self._identity_app_guid = identity_app_guid + + @property + def identity_app_display_name(self): + """ + Gets the identity_app_display_name of this OpaInstance. + This property specifies the name of the Identity Application instance OPA has created inside the user-specified identity domain. This identity application instance may be used to host user roll mappings to grant access to this OPA instance for users within the identity domain. + + + :return: The identity_app_display_name of this OpaInstance. + :rtype: str + """ + return self._identity_app_display_name + + @identity_app_display_name.setter + def identity_app_display_name(self, identity_app_display_name): + """ + Sets the identity_app_display_name of this OpaInstance. + This property specifies the name of the Identity Application instance OPA has created inside the user-specified identity domain. This identity application instance may be used to host user roll mappings to grant access to this OPA instance for users within the identity domain. + + + :param identity_app_display_name: The identity_app_display_name of this OpaInstance. + :type: str + """ + self._identity_app_display_name = identity_app_display_name + + @property + def identity_domain_url(self): + """ + Gets the identity_domain_url of this OpaInstance. + This property specifies the domain url of the Identity Application instance OPA has created inside the user-specified identity domain. This identity application instance may be used to host user roll mappings to grant access to this OPA instance for users within the identity domain. + + + :return: The identity_domain_url of this OpaInstance. + :rtype: str + """ + return self._identity_domain_url + + @identity_domain_url.setter + def identity_domain_url(self, identity_domain_url): + """ + Sets the identity_domain_url of this OpaInstance. + This property specifies the domain url of the Identity Application instance OPA has created inside the user-specified identity domain. This identity application instance may be used to host user roll mappings to grant access to this OPA instance for users within the identity domain. + + + :param identity_domain_url: The identity_domain_url of this OpaInstance. + :type: str + """ + self._identity_domain_url = identity_domain_url + + @property + def identity_app_opc_service_instance_guid(self): + """ + Gets the identity_app_opc_service_instance_guid of this OpaInstance. + This property specifies the OPC Service Instance GUID of the Identity Application instance OPA has created inside the user-specified identity domain. This identity application instance may be used to host user roll mappings to grant access to this OPA instance for users within the identity domain. + + + :return: The identity_app_opc_service_instance_guid of this OpaInstance. + :rtype: str + """ + return self._identity_app_opc_service_instance_guid + + @identity_app_opc_service_instance_guid.setter + def identity_app_opc_service_instance_guid(self, identity_app_opc_service_instance_guid): + """ + Sets the identity_app_opc_service_instance_guid of this OpaInstance. + This property specifies the OPC Service Instance GUID of the Identity Application instance OPA has created inside the user-specified identity domain. This identity application instance may be used to host user roll mappings to grant access to this OPA instance for users within the identity domain. + + + :param identity_app_opc_service_instance_guid: The identity_app_opc_service_instance_guid of this OpaInstance. + :type: str + """ + self._identity_app_opc_service_instance_guid = identity_app_opc_service_instance_guid + + @property + def is_breakglass_enabled(self): + """ + Gets the is_breakglass_enabled of this OpaInstance. + indicates if breakGlass is enabled for the opa instance. + + + :return: The is_breakglass_enabled of this OpaInstance. + :rtype: bool + """ + return self._is_breakglass_enabled + + @is_breakglass_enabled.setter + def is_breakglass_enabled(self, is_breakglass_enabled): + """ + Sets the is_breakglass_enabled of this OpaInstance. + indicates if breakGlass is enabled for the opa instance. + + + :param is_breakglass_enabled: The is_breakglass_enabled of this OpaInstance. + :type: bool + """ + self._is_breakglass_enabled = is_breakglass_enabled + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this OpaInstance. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :return: The freeform_tags of this OpaInstance. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this OpaInstance. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :param freeform_tags: The freeform_tags of this OpaInstance. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this OpaInstance. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this OpaInstance. + :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 OpaInstance. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this OpaInstance. + :type: dict(str, dict(str, object)) + """ + self._defined_tags = defined_tags + + @property + def system_tags(self): + """ + Gets the system_tags of this OpaInstance. + 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 OpaInstance. + :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 OpaInstance. + 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 OpaInstance. + :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/opa/models/opa_instance_collection.py b/src/oci/opa/models/opa_instance_collection.py new file mode 100644 index 0000000000..8ce8853d9f --- /dev/null +++ b/src/oci/opa/models/opa_instance_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 OpaInstanceCollection(object): + """ + Results of a opaInstance search. Contains boh OpaInstanceSummary items and other information, such as metadata. + """ + + def __init__(self, **kwargs): + """ + Initializes a new OpaInstanceCollection 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 OpaInstanceCollection. + :type items: list[oci.opa.models.OpaInstanceSummary] + + """ + self.swagger_types = { + 'items': 'list[OpaInstanceSummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this OpaInstanceCollection. + List of opaInstances. + + + :return: The items of this OpaInstanceCollection. + :rtype: list[oci.opa.models.OpaInstanceSummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this OpaInstanceCollection. + List of opaInstances. + + + :param items: The items of this OpaInstanceCollection. + :type: list[oci.opa.models.OpaInstanceSummary] + """ + 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/opa/models/opa_instance_summary.py b/src/oci/opa/models/opa_instance_summary.py new file mode 100644 index 0000000000..f26e61b3d6 --- /dev/null +++ b/src/oci/opa/models/opa_instance_summary.py @@ -0,0 +1,510 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 OpaInstanceSummary(object): + """ + Summary of the OpaInstance. + """ + + def __init__(self, **kwargs): + """ + Initializes a new OpaInstanceSummary 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 OpaInstanceSummary. + :type id: str + + :param display_name: + The value to assign to the display_name property of this OpaInstanceSummary. + :type display_name: str + + :param description: + The value to assign to the description property of this OpaInstanceSummary. + :type description: str + + :param compartment_id: + The value to assign to the compartment_id property of this OpaInstanceSummary. + :type compartment_id: str + + :param instance_url: + The value to assign to the instance_url property of this OpaInstanceSummary. + :type instance_url: str + + :param consumption_model: + The value to assign to the consumption_model property of this OpaInstanceSummary. + :type consumption_model: str + + :param shape_name: + The value to assign to the shape_name property of this OpaInstanceSummary. + :type shape_name: str + + :param metering_type: + The value to assign to the metering_type property of this OpaInstanceSummary. + :type metering_type: str + + :param time_created: + The value to assign to the time_created property of this OpaInstanceSummary. + :type time_created: datetime + + :param time_updated: + The value to assign to the time_updated property of this OpaInstanceSummary. + :type time_updated: datetime + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this OpaInstanceSummary. + :type lifecycle_state: str + + :param is_breakglass_enabled: + The value to assign to the is_breakglass_enabled property of this OpaInstanceSummary. + :type is_breakglass_enabled: bool + + :param freeform_tags: + The value to assign to the freeform_tags property of this OpaInstanceSummary. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this OpaInstanceSummary. + :type defined_tags: dict(str, dict(str, object)) + + :param system_tags: + The value to assign to the system_tags property of this OpaInstanceSummary. + :type system_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'id': 'str', + 'display_name': 'str', + 'description': 'str', + 'compartment_id': 'str', + 'instance_url': 'str', + 'consumption_model': 'str', + 'shape_name': 'str', + 'metering_type': 'str', + 'time_created': 'datetime', + 'time_updated': 'datetime', + 'lifecycle_state': 'str', + 'is_breakglass_enabled': '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', + 'instance_url': 'instanceUrl', + 'consumption_model': 'consumptionModel', + 'shape_name': 'shapeName', + 'metering_type': 'meteringType', + 'time_created': 'timeCreated', + 'time_updated': 'timeUpdated', + 'lifecycle_state': 'lifecycleState', + 'is_breakglass_enabled': 'isBreakglassEnabled', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags', + 'system_tags': 'systemTags' + } + + self._id = None + self._display_name = None + self._description = None + self._compartment_id = None + self._instance_url = None + self._consumption_model = None + self._shape_name = None + self._metering_type = None + self._time_created = None + self._time_updated = None + self._lifecycle_state = None + self._is_breakglass_enabled = None + self._freeform_tags = None + self._defined_tags = None + self._system_tags = None + + @property + def id(self): + """ + **[Required]** Gets the id of this OpaInstanceSummary. + Unique identifier that is immutable on creation + + + :return: The id of this OpaInstanceSummary. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this OpaInstanceSummary. + Unique identifier that is immutable on creation + + + :param id: The id of this OpaInstanceSummary. + :type: str + """ + self._id = id + + @property + def display_name(self): + """ + **[Required]** Gets the display_name of this OpaInstanceSummary. + OpaInstance Identifier, can be renamed + + + :return: The display_name of this OpaInstanceSummary. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this OpaInstanceSummary. + OpaInstance Identifier, can be renamed + + + :param display_name: The display_name of this OpaInstanceSummary. + :type: str + """ + self._display_name = display_name + + @property + def description(self): + """ + Gets the description of this OpaInstanceSummary. + Description of the Process Automation instance. + + + :return: The description of this OpaInstanceSummary. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this OpaInstanceSummary. + Description of the Process Automation instance. + + + :param description: The description of this OpaInstanceSummary. + :type: str + """ + self._description = description + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this OpaInstanceSummary. + Compartment Identifier + + + :return: The compartment_id of this OpaInstanceSummary. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this OpaInstanceSummary. + Compartment Identifier + + + :param compartment_id: The compartment_id of this OpaInstanceSummary. + :type: str + """ + self._compartment_id = compartment_id + + @property + def instance_url(self): + """ + Gets the instance_url of this OpaInstanceSummary. + OPA Instance URL + + + :return: The instance_url of this OpaInstanceSummary. + :rtype: str + """ + return self._instance_url + + @instance_url.setter + def instance_url(self, instance_url): + """ + Sets the instance_url of this OpaInstanceSummary. + OPA Instance URL + + + :param instance_url: The instance_url of this OpaInstanceSummary. + :type: str + """ + self._instance_url = instance_url + + @property + def consumption_model(self): + """ + Gets the consumption_model of this OpaInstanceSummary. + Parameter specifying which entitlement to use for billing purposes + + + :return: The consumption_model of this OpaInstanceSummary. + :rtype: str + """ + return self._consumption_model + + @consumption_model.setter + def consumption_model(self, consumption_model): + """ + Sets the consumption_model of this OpaInstanceSummary. + Parameter specifying which entitlement to use for billing purposes + + + :param consumption_model: The consumption_model of this OpaInstanceSummary. + :type: str + """ + self._consumption_model = consumption_model + + @property + def shape_name(self): + """ + **[Required]** Gets the shape_name of this OpaInstanceSummary. + Shape of the instance. + + + :return: The shape_name of this OpaInstanceSummary. + :rtype: str + """ + return self._shape_name + + @shape_name.setter + def shape_name(self, shape_name): + """ + Sets the shape_name of this OpaInstanceSummary. + Shape of the instance. + + + :param shape_name: The shape_name of this OpaInstanceSummary. + :type: str + """ + self._shape_name = shape_name + + @property + def metering_type(self): + """ + Gets the metering_type of this OpaInstanceSummary. + MeteringType Identifier + + + :return: The metering_type of this OpaInstanceSummary. + :rtype: str + """ + return self._metering_type + + @metering_type.setter + def metering_type(self, metering_type): + """ + Sets the metering_type of this OpaInstanceSummary. + MeteringType Identifier + + + :param metering_type: The metering_type of this OpaInstanceSummary. + :type: str + """ + self._metering_type = metering_type + + @property + def time_created(self): + """ + **[Required]** Gets the time_created of this OpaInstanceSummary. + The time the the OpaInstance was created. An RFC3339 formatted datetime string + + + :return: The time_created of this OpaInstanceSummary. + :rtype: datetime + """ + return self._time_created + + @time_created.setter + def time_created(self, time_created): + """ + Sets the time_created of this OpaInstanceSummary. + The time the the OpaInstance was created. An RFC3339 formatted datetime string + + + :param time_created: The time_created of this OpaInstanceSummary. + :type: datetime + """ + self._time_created = time_created + + @property + def time_updated(self): + """ + Gets the time_updated of this OpaInstanceSummary. + The time the OpaInstance was updated. An RFC3339 formatted datetime string + + + :return: The time_updated of this OpaInstanceSummary. + :rtype: datetime + """ + return self._time_updated + + @time_updated.setter + def time_updated(self, time_updated): + """ + Sets the time_updated of this OpaInstanceSummary. + The time the OpaInstance was updated. An RFC3339 formatted datetime string + + + :param time_updated: The time_updated of this OpaInstanceSummary. + :type: datetime + """ + self._time_updated = time_updated + + @property + def lifecycle_state(self): + """ + **[Required]** Gets the lifecycle_state of this OpaInstanceSummary. + The current state of the OpaInstance. + + + :return: The lifecycle_state of this OpaInstanceSummary. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this OpaInstanceSummary. + The current state of the OpaInstance. + + + :param lifecycle_state: The lifecycle_state of this OpaInstanceSummary. + :type: str + """ + self._lifecycle_state = lifecycle_state + + @property + def is_breakglass_enabled(self): + """ + Gets the is_breakglass_enabled of this OpaInstanceSummary. + indicates if breakGlass is enabled for the opa instance. + + + :return: The is_breakglass_enabled of this OpaInstanceSummary. + :rtype: bool + """ + return self._is_breakglass_enabled + + @is_breakglass_enabled.setter + def is_breakglass_enabled(self, is_breakglass_enabled): + """ + Sets the is_breakglass_enabled of this OpaInstanceSummary. + indicates if breakGlass is enabled for the opa instance. + + + :param is_breakglass_enabled: The is_breakglass_enabled of this OpaInstanceSummary. + :type: bool + """ + self._is_breakglass_enabled = is_breakglass_enabled + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this OpaInstanceSummary. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :return: The freeform_tags of this OpaInstanceSummary. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this OpaInstanceSummary. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :param freeform_tags: The freeform_tags of this OpaInstanceSummary. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this OpaInstanceSummary. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this OpaInstanceSummary. + :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 OpaInstanceSummary. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this OpaInstanceSummary. + :type: dict(str, dict(str, object)) + """ + self._defined_tags = defined_tags + + @property + def system_tags(self): + """ + Gets the system_tags of this OpaInstanceSummary. + 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 OpaInstanceSummary. + :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 OpaInstanceSummary. + 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 OpaInstanceSummary. + :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/opa/models/update_opa_instance_details.py b/src/oci/opa/models/update_opa_instance_details.py new file mode 100644 index 0000000000..76d0111f17 --- /dev/null +++ b/src/oci/opa/models/update_opa_instance_details.py @@ -0,0 +1,167 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 UpdateOpaInstanceDetails(object): + """ + The information to be updated. + """ + + def __init__(self, **kwargs): + """ + Initializes a new UpdateOpaInstanceDetails 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 UpdateOpaInstanceDetails. + :type display_name: str + + :param description: + The value to assign to the description property of this UpdateOpaInstanceDetails. + :type description: str + + :param freeform_tags: + The value to assign to the freeform_tags property of this UpdateOpaInstanceDetails. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this UpdateOpaInstanceDetails. + :type defined_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'display_name': 'str', + 'description': 'str', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))' + } + + self.attribute_map = { + 'display_name': 'displayName', + 'description': 'description', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags' + } + + self._display_name = None + self._description = None + self._freeform_tags = None + self._defined_tags = None + + @property + def display_name(self): + """ + Gets the display_name of this UpdateOpaInstanceDetails. + OpaInstance Identifier + + + :return: The display_name of this UpdateOpaInstanceDetails. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this UpdateOpaInstanceDetails. + OpaInstance Identifier + + + :param display_name: The display_name of this UpdateOpaInstanceDetails. + :type: str + """ + self._display_name = display_name + + @property + def description(self): + """ + Gets the description of this UpdateOpaInstanceDetails. + Description of the Oracle Process Automation instance. + + + :return: The description of this UpdateOpaInstanceDetails. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this UpdateOpaInstanceDetails. + Description of the Oracle Process Automation instance. + + + :param description: The description of this UpdateOpaInstanceDetails. + :type: str + """ + self._description = description + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this UpdateOpaInstanceDetails. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :return: The freeform_tags of this UpdateOpaInstanceDetails. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this UpdateOpaInstanceDetails. + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :param freeform_tags: The freeform_tags of this UpdateOpaInstanceDetails. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this UpdateOpaInstanceDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this UpdateOpaInstanceDetails. + :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 UpdateOpaInstanceDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this UpdateOpaInstanceDetails. + :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/opa/models/work_request.py b/src/oci/opa/models/work_request.py new file mode 100644 index 0000000000..f95660d114 --- /dev/null +++ b/src/oci/opa/models/work_request.py @@ -0,0 +1,400 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 WorkRequest(object): + """ + A description of workrequest status + """ + + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "CREATE_OPA_INSTANCE" + OPERATION_TYPE_CREATE_OPA_INSTANCE = "CREATE_OPA_INSTANCE" + + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "UPDATE_OPA_INSTANCE" + OPERATION_TYPE_UPDATE_OPA_INSTANCE = "UPDATE_OPA_INSTANCE" + + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "DELETE_OPA_INSTANCE" + OPERATION_TYPE_DELETE_OPA_INSTANCE = "DELETE_OPA_INSTANCE" + + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "MOVE_OPA_INSTANCE" + OPERATION_TYPE_MOVE_OPA_INSTANCE = "MOVE_OPA_INSTANCE" + + #: A constant which can be used with the status property of a WorkRequest. + #: This constant has a value of "ACCEPTED" + STATUS_ACCEPTED = "ACCEPTED" + + #: A constant which can be used with the status property of a WorkRequest. + #: This constant has a value of "IN_PROGRESS" + STATUS_IN_PROGRESS = "IN_PROGRESS" + + #: A constant which can be used with the status property of a WorkRequest. + #: This constant has a value of "WAITING" + STATUS_WAITING = "WAITING" + + #: A constant which can be used with the status property of a WorkRequest. + #: This constant has a value of "FAILED" + STATUS_FAILED = "FAILED" + + #: A constant which can be used with the status property of a WorkRequest. + #: This constant has a value of "SUCCEEDED" + STATUS_SUCCEEDED = "SUCCEEDED" + + #: A constant which can be used with the status property of a WorkRequest. + #: This constant has a value of "CANCELING" + STATUS_CANCELING = "CANCELING" + + #: A constant which can be used with the status property of a WorkRequest. + #: This constant has a value of "CANCELED" + STATUS_CANCELED = "CANCELED" + + def __init__(self, **kwargs): + """ + Initializes a new WorkRequest object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param operation_type: + The value to assign to the operation_type property of this WorkRequest. + Allowed values for this property are: "CREATE_OPA_INSTANCE", "UPDATE_OPA_INSTANCE", "DELETE_OPA_INSTANCE", "MOVE_OPA_INSTANCE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type operation_type: str + + :param status: + The value to assign to the status property of this WorkRequest. + Allowed values for this property are: "ACCEPTED", "IN_PROGRESS", "WAITING", "FAILED", "SUCCEEDED", "CANCELING", "CANCELED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type status: str + + :param id: + The value to assign to the id property of this WorkRequest. + :type id: str + + :param compartment_id: + The value to assign to the compartment_id property of this WorkRequest. + :type compartment_id: str + + :param resources: + The value to assign to the resources property of this WorkRequest. + :type resources: list[oci.opa.models.WorkRequestResource] + + :param percent_complete: + The value to assign to the percent_complete property of this WorkRequest. + :type percent_complete: float + + :param time_accepted: + The value to assign to the time_accepted property of this WorkRequest. + :type time_accepted: datetime + + :param time_started: + The value to assign to the time_started property of this WorkRequest. + :type time_started: datetime + + :param time_finished: + The value to assign to the time_finished property of this WorkRequest. + :type time_finished: datetime + + """ + self.swagger_types = { + 'operation_type': 'str', + 'status': 'str', + 'id': 'str', + 'compartment_id': 'str', + 'resources': 'list[WorkRequestResource]', + 'percent_complete': 'float', + 'time_accepted': 'datetime', + 'time_started': 'datetime', + 'time_finished': 'datetime' + } + + self.attribute_map = { + 'operation_type': 'operationType', + 'status': 'status', + 'id': 'id', + 'compartment_id': 'compartmentId', + 'resources': 'resources', + 'percent_complete': 'percentComplete', + 'time_accepted': 'timeAccepted', + 'time_started': 'timeStarted', + 'time_finished': 'timeFinished' + } + + self._operation_type = None + self._status = None + self._id = None + self._compartment_id = None + self._resources = None + self._percent_complete = None + self._time_accepted = None + self._time_started = None + self._time_finished = None + + @property + def operation_type(self): + """ + **[Required]** Gets the operation_type of this WorkRequest. + Type of the work request + + Allowed values for this property are: "CREATE_OPA_INSTANCE", "UPDATE_OPA_INSTANCE", "DELETE_OPA_INSTANCE", "MOVE_OPA_INSTANCE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The operation_type of this WorkRequest. + :rtype: str + """ + return self._operation_type + + @operation_type.setter + def operation_type(self, operation_type): + """ + Sets the operation_type of this WorkRequest. + Type of the work request + + + :param operation_type: The operation_type of this WorkRequest. + :type: str + """ + allowed_values = ["CREATE_OPA_INSTANCE", "UPDATE_OPA_INSTANCE", "DELETE_OPA_INSTANCE", "MOVE_OPA_INSTANCE"] + if not value_allowed_none_or_none_sentinel(operation_type, allowed_values): + operation_type = 'UNKNOWN_ENUM_VALUE' + self._operation_type = operation_type + + @property + def status(self): + """ + **[Required]** Gets the status of this WorkRequest. + Status of current work request. + + Allowed values for this property are: "ACCEPTED", "IN_PROGRESS", "WAITING", "FAILED", "SUCCEEDED", "CANCELING", "CANCELED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The status of this WorkRequest. + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """ + Sets the status of this WorkRequest. + Status of current work request. + + + :param status: The status of this WorkRequest. + :type: str + """ + allowed_values = ["ACCEPTED", "IN_PROGRESS", "WAITING", "FAILED", "SUCCEEDED", "CANCELING", "CANCELED"] + if not value_allowed_none_or_none_sentinel(status, allowed_values): + status = 'UNKNOWN_ENUM_VALUE' + self._status = status + + @property + def id(self): + """ + **[Required]** Gets the id of this WorkRequest. + The id of the work request. + + + :return: The id of this WorkRequest. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this WorkRequest. + The id of the work request. + + + :param id: The id of this WorkRequest. + :type: str + """ + self._id = id + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this WorkRequest. + The ocid of the compartment that contains the work request. Work requests should be scoped to + the same compartment as the resource the work request affects. If the work request affects multiple resources, + and those resources are not in the same compartment, it is up to the service team to pick the primary + resource whose compartment should be used + + + :return: The compartment_id of this WorkRequest. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this WorkRequest. + The ocid of the compartment that contains the work request. Work requests should be scoped to + the same compartment as the resource the work request affects. If the work request affects multiple resources, + and those resources are not in the same compartment, it is up to the service team to pick the primary + resource whose compartment should be used + + + :param compartment_id: The compartment_id of this WorkRequest. + :type: str + """ + self._compartment_id = compartment_id + + @property + def resources(self): + """ + **[Required]** Gets the resources of this WorkRequest. + The resources affected by this work request. + + + :return: The resources of this WorkRequest. + :rtype: list[oci.opa.models.WorkRequestResource] + """ + return self._resources + + @resources.setter + def resources(self, resources): + """ + Sets the resources of this WorkRequest. + The resources affected by this work request. + + + :param resources: The resources of this WorkRequest. + :type: list[oci.opa.models.WorkRequestResource] + """ + self._resources = resources + + @property + def percent_complete(self): + """ + **[Required]** Gets the percent_complete of this WorkRequest. + Percentage of the request completed. + + + :return: The percent_complete of this WorkRequest. + :rtype: float + """ + return self._percent_complete + + @percent_complete.setter + def percent_complete(self, percent_complete): + """ + Sets the percent_complete of this WorkRequest. + Percentage of the request completed. + + + :param percent_complete: The percent_complete of this WorkRequest. + :type: float + """ + self._percent_complete = percent_complete + + @property + def time_accepted(self): + """ + **[Required]** Gets the time_accepted of this WorkRequest. + The date and time the request was created, as described in + `RFC 3339`__, section 14.29. + + __ https://tools.ietf.org/rfc/rfc3339 + + + :return: The time_accepted of this WorkRequest. + :rtype: datetime + """ + return self._time_accepted + + @time_accepted.setter + def time_accepted(self, time_accepted): + """ + Sets the time_accepted of this WorkRequest. + The date and time the request was created, as described in + `RFC 3339`__, section 14.29. + + __ https://tools.ietf.org/rfc/rfc3339 + + + :param time_accepted: The time_accepted of this WorkRequest. + :type: datetime + """ + self._time_accepted = time_accepted + + @property + def time_started(self): + """ + Gets the time_started of this WorkRequest. + The date and time the request was started, as described in `RFC 3339`__, + section 14.29. + + __ https://tools.ietf.org/rfc/rfc3339 + + + :return: The time_started of this WorkRequest. + :rtype: datetime + """ + return self._time_started + + @time_started.setter + def time_started(self, time_started): + """ + Sets the time_started of this WorkRequest. + The date and time the request was started, as described in `RFC 3339`__, + section 14.29. + + __ https://tools.ietf.org/rfc/rfc3339 + + + :param time_started: The time_started of this WorkRequest. + :type: datetime + """ + self._time_started = time_started + + @property + def time_finished(self): + """ + Gets the time_finished of this WorkRequest. + The date and time the object was finished, as described in `RFC 3339`__. + + __ https://tools.ietf.org/rfc/rfc3339 + + + :return: The time_finished of this WorkRequest. + :rtype: datetime + """ + return self._time_finished + + @time_finished.setter + def time_finished(self, time_finished): + """ + Sets the time_finished of this WorkRequest. + The date and time the object was finished, as described in `RFC 3339`__. + + __ https://tools.ietf.org/rfc/rfc3339 + + + :param time_finished: The time_finished of this WorkRequest. + :type: datetime + """ + self._time_finished = time_finished + + 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/opa/models/work_request_error.py b/src/oci/opa/models/work_request_error.py new file mode 100644 index 0000000000..26ac6a8cc9 --- /dev/null +++ b/src/oci/opa/models/work_request_error.py @@ -0,0 +1,134 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 WorkRequestError(object): + """ + An error encountered while executing a work request. + """ + + def __init__(self, **kwargs): + """ + Initializes a new WorkRequestError object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param code: + The value to assign to the code property of this WorkRequestError. + :type code: str + + :param message: + The value to assign to the message property of this WorkRequestError. + :type message: str + + :param timestamp: + The value to assign to the timestamp property of this WorkRequestError. + :type timestamp: datetime + + """ + self.swagger_types = { + 'code': 'str', + 'message': 'str', + 'timestamp': 'datetime' + } + + self.attribute_map = { + 'code': 'code', + 'message': 'message', + 'timestamp': 'timestamp' + } + + self._code = None + self._message = None + self._timestamp = None + + @property + def code(self): + """ + **[Required]** Gets the code of this WorkRequestError. + A machine-usable code for the error that occured. Error codes are listed on + (https://docs.cloud.oracle.com/Content/API/References/apierrors.htm) + + + :return: The code of this WorkRequestError. + :rtype: str + """ + return self._code + + @code.setter + def code(self, code): + """ + Sets the code of this WorkRequestError. + A machine-usable code for the error that occured. Error codes are listed on + (https://docs.cloud.oracle.com/Content/API/References/apierrors.htm) + + + :param code: The code of this WorkRequestError. + :type: str + """ + self._code = code + + @property + def message(self): + """ + **[Required]** Gets the message of this WorkRequestError. + A human readable description of the issue encountered. + + + :return: The message of this WorkRequestError. + :rtype: str + """ + return self._message + + @message.setter + def message(self, message): + """ + Sets the message of this WorkRequestError. + A human readable description of the issue encountered. + + + :param message: The message of this WorkRequestError. + :type: str + """ + self._message = message + + @property + def timestamp(self): + """ + **[Required]** Gets the timestamp of this WorkRequestError. + The time the error occured. An RFC3339 formatted datetime string. + + + :return: The timestamp of this WorkRequestError. + :rtype: datetime + """ + return self._timestamp + + @timestamp.setter + def timestamp(self, timestamp): + """ + Sets the timestamp of this WorkRequestError. + The time the error occured. An RFC3339 formatted datetime string. + + + :param timestamp: The timestamp of this WorkRequestError. + :type: datetime + """ + self._timestamp = timestamp + + 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/opa/models/work_request_error_collection.py b/src/oci/opa/models/work_request_error_collection.py new file mode 100644 index 0000000000..77188c703f --- /dev/null +++ b/src/oci/opa/models/work_request_error_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 WorkRequestErrorCollection(object): + """ + Results of a workRequestError search. Contains both WorkRequestError items and other information, such as metadata. + """ + + def __init__(self, **kwargs): + """ + Initializes a new WorkRequestErrorCollection 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 WorkRequestErrorCollection. + :type items: list[oci.opa.models.WorkRequestError] + + """ + self.swagger_types = { + 'items': 'list[WorkRequestError]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this WorkRequestErrorCollection. + List of workRequestError objects. + + + :return: The items of this WorkRequestErrorCollection. + :rtype: list[oci.opa.models.WorkRequestError] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this WorkRequestErrorCollection. + List of workRequestError objects. + + + :param items: The items of this WorkRequestErrorCollection. + :type: list[oci.opa.models.WorkRequestError] + """ + 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/opa/models/work_request_log_entry.py b/src/oci/opa/models/work_request_log_entry.py new file mode 100644 index 0000000000..7b37ab8d12 --- /dev/null +++ b/src/oci/opa/models/work_request_log_entry.py @@ -0,0 +1,101 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 WorkRequestLogEntry(object): + """ + A log message from the execution of a work request. + """ + + def __init__(self, **kwargs): + """ + Initializes a new WorkRequestLogEntry object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param message: + The value to assign to the message property of this WorkRequestLogEntry. + :type message: str + + :param timestamp: + The value to assign to the timestamp property of this WorkRequestLogEntry. + :type timestamp: datetime + + """ + self.swagger_types = { + 'message': 'str', + 'timestamp': 'datetime' + } + + self.attribute_map = { + 'message': 'message', + 'timestamp': 'timestamp' + } + + self._message = None + self._timestamp = None + + @property + def message(self): + """ + **[Required]** Gets the message of this WorkRequestLogEntry. + Human-readable log message. + + + :return: The message of this WorkRequestLogEntry. + :rtype: str + """ + return self._message + + @message.setter + def message(self, message): + """ + Sets the message of this WorkRequestLogEntry. + Human-readable log message. + + + :param message: The message of this WorkRequestLogEntry. + :type: str + """ + self._message = message + + @property + def timestamp(self): + """ + **[Required]** Gets the timestamp of this WorkRequestLogEntry. + The time the log message was written. An RFC3339 formatted datetime string + + + :return: The timestamp of this WorkRequestLogEntry. + :rtype: datetime + """ + return self._timestamp + + @timestamp.setter + def timestamp(self, timestamp): + """ + Sets the timestamp of this WorkRequestLogEntry. + The time the log message was written. An RFC3339 formatted datetime string + + + :param timestamp: The timestamp of this WorkRequestLogEntry. + :type: datetime + """ + self._timestamp = timestamp + + 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/opa/models/work_request_log_entry_collection.py b/src/oci/opa/models/work_request_log_entry_collection.py new file mode 100644 index 0000000000..e5ba3e3a46 --- /dev/null +++ b/src/oci/opa/models/work_request_log_entry_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 WorkRequestLogEntryCollection(object): + """ + Results of a workRequestLog search. Contains both workRequestLog items and other information, such as metadata. + """ + + def __init__(self, **kwargs): + """ + Initializes a new WorkRequestLogEntryCollection 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 WorkRequestLogEntryCollection. + :type items: list[oci.opa.models.WorkRequestLogEntry] + + """ + self.swagger_types = { + 'items': 'list[WorkRequestLogEntry]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this WorkRequestLogEntryCollection. + List of workRequestLogEntries. + + + :return: The items of this WorkRequestLogEntryCollection. + :rtype: list[oci.opa.models.WorkRequestLogEntry] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this WorkRequestLogEntryCollection. + List of workRequestLogEntries. + + + :param items: The items of this WorkRequestLogEntryCollection. + :type: list[oci.opa.models.WorkRequestLogEntry] + """ + 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/opa/models/work_request_resource.py b/src/oci/opa/models/work_request_resource.py new file mode 100644 index 0000000000..c9a657433f --- /dev/null +++ b/src/oci/opa/models/work_request_resource.py @@ -0,0 +1,232 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 WorkRequestResource(object): + """ + A resource created or operated on by a work request. + """ + + #: A constant which can be used with the action_type property of a WorkRequestResource. + #: This constant has a value of "CREATED" + ACTION_TYPE_CREATED = "CREATED" + + #: A constant which can be used with the action_type property of a WorkRequestResource. + #: This constant has a value of "UPDATED" + ACTION_TYPE_UPDATED = "UPDATED" + + #: A constant which can be used with the action_type property of a WorkRequestResource. + #: This constant has a value of "DELETED" + ACTION_TYPE_DELETED = "DELETED" + + #: A constant which can be used with the action_type property of a WorkRequestResource. + #: This constant has a value of "IN_PROGRESS" + ACTION_TYPE_IN_PROGRESS = "IN_PROGRESS" + + #: A constant which can be used with the action_type property of a WorkRequestResource. + #: This constant has a value of "RELATED" + ACTION_TYPE_RELATED = "RELATED" + + #: A constant which can be used with the action_type property of a WorkRequestResource. + #: This constant has a value of "FAILED" + ACTION_TYPE_FAILED = "FAILED" + + def __init__(self, **kwargs): + """ + Initializes a new WorkRequestResource object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param entity_type: + The value to assign to the entity_type property of this WorkRequestResource. + :type entity_type: str + + :param action_type: + The value to assign to the action_type property of this WorkRequestResource. + Allowed values for this property are: "CREATED", "UPDATED", "DELETED", "IN_PROGRESS", "RELATED", "FAILED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type action_type: str + + :param identifier: + The value to assign to the identifier property of this WorkRequestResource. + :type identifier: str + + :param entity_uri: + The value to assign to the entity_uri property of this WorkRequestResource. + :type entity_uri: str + + :param metadata: + The value to assign to the metadata property of this WorkRequestResource. + :type metadata: dict(str, str) + + """ + self.swagger_types = { + 'entity_type': 'str', + 'action_type': 'str', + 'identifier': 'str', + 'entity_uri': 'str', + 'metadata': 'dict(str, str)' + } + + self.attribute_map = { + 'entity_type': 'entityType', + 'action_type': 'actionType', + 'identifier': 'identifier', + 'entity_uri': 'entityUri', + 'metadata': 'metadata' + } + + self._entity_type = None + self._action_type = None + self._identifier = None + self._entity_uri = None + self._metadata = None + + @property + def entity_type(self): + """ + **[Required]** Gets the entity_type of this WorkRequestResource. + The resource type the work request affects. + + + :return: The entity_type of this WorkRequestResource. + :rtype: str + """ + return self._entity_type + + @entity_type.setter + def entity_type(self, entity_type): + """ + Sets the entity_type of this WorkRequestResource. + The resource type the work request affects. + + + :param entity_type: The entity_type of this WorkRequestResource. + :type: str + """ + self._entity_type = entity_type + + @property + def action_type(self): + """ + **[Required]** Gets the action_type of this WorkRequestResource. + The way in which this resource is affected by the work tracked in the work request. + A resource being created, updated, or deleted will remain in the IN_PROGRESS state until + work is complete for that resource at which point it will transition to CREATED, UPDATED, + or DELETED, respectively. + + Allowed values for this property are: "CREATED", "UPDATED", "DELETED", "IN_PROGRESS", "RELATED", "FAILED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The action_type of this WorkRequestResource. + :rtype: str + """ + return self._action_type + + @action_type.setter + def action_type(self, action_type): + """ + Sets the action_type of this WorkRequestResource. + The way in which this resource is affected by the work tracked in the work request. + A resource being created, updated, or deleted will remain in the IN_PROGRESS state until + work is complete for that resource at which point it will transition to CREATED, UPDATED, + or DELETED, respectively. + + + :param action_type: The action_type of this WorkRequestResource. + :type: str + """ + allowed_values = ["CREATED", "UPDATED", "DELETED", "IN_PROGRESS", "RELATED", "FAILED"] + if not value_allowed_none_or_none_sentinel(action_type, allowed_values): + action_type = 'UNKNOWN_ENUM_VALUE' + self._action_type = action_type + + @property + def identifier(self): + """ + **[Required]** Gets the identifier of this WorkRequestResource. + The identifier of the resource the work request affects. + + + :return: The identifier of this WorkRequestResource. + :rtype: str + """ + return self._identifier + + @identifier.setter + def identifier(self, identifier): + """ + Sets the identifier of this WorkRequestResource. + The identifier of the resource the work request affects. + + + :param identifier: The identifier of this WorkRequestResource. + :type: str + """ + self._identifier = identifier + + @property + def entity_uri(self): + """ + Gets the entity_uri of this WorkRequestResource. + The URI path that the user can do a GET on to access the resource metadata + + + :return: The entity_uri of this WorkRequestResource. + :rtype: str + """ + return self._entity_uri + + @entity_uri.setter + def entity_uri(self, entity_uri): + """ + Sets the entity_uri of this WorkRequestResource. + The URI path that the user can do a GET on to access the resource metadata + + + :param entity_uri: The entity_uri of this WorkRequestResource. + :type: str + """ + self._entity_uri = entity_uri + + @property + def metadata(self): + """ + Gets the metadata of this WorkRequestResource. + Additional information that helps to explain the resource. + + + :return: The metadata of this WorkRequestResource. + :rtype: dict(str, str) + """ + return self._metadata + + @metadata.setter + def metadata(self, metadata): + """ + Sets the metadata of this WorkRequestResource. + Additional information that helps to explain the resource. + + + :param metadata: The metadata of this WorkRequestResource. + :type: dict(str, str) + """ + self._metadata = metadata + + 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/opa/models/work_request_summary.py b/src/oci/opa/models/work_request_summary.py new file mode 100644 index 0000000000..b620e676dd --- /dev/null +++ b/src/oci/opa/models/work_request_summary.py @@ -0,0 +1,400 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 WorkRequestSummary(object): + """ + A summary of the status of a work request. + """ + + #: A constant which can be used with the operation_type property of a WorkRequestSummary. + #: This constant has a value of "CREATE_OPA_INSTANCE" + OPERATION_TYPE_CREATE_OPA_INSTANCE = "CREATE_OPA_INSTANCE" + + #: A constant which can be used with the operation_type property of a WorkRequestSummary. + #: This constant has a value of "UPDATE_OPA_INSTANCE" + OPERATION_TYPE_UPDATE_OPA_INSTANCE = "UPDATE_OPA_INSTANCE" + + #: A constant which can be used with the operation_type property of a WorkRequestSummary. + #: This constant has a value of "DELETE_OPA_INSTANCE" + OPERATION_TYPE_DELETE_OPA_INSTANCE = "DELETE_OPA_INSTANCE" + + #: A constant which can be used with the operation_type property of a WorkRequestSummary. + #: This constant has a value of "MOVE_OPA_INSTANCE" + OPERATION_TYPE_MOVE_OPA_INSTANCE = "MOVE_OPA_INSTANCE" + + #: A constant which can be used with the status property of a WorkRequestSummary. + #: This constant has a value of "ACCEPTED" + STATUS_ACCEPTED = "ACCEPTED" + + #: A constant which can be used with the status property of a WorkRequestSummary. + #: This constant has a value of "IN_PROGRESS" + STATUS_IN_PROGRESS = "IN_PROGRESS" + + #: A constant which can be used with the status property of a WorkRequestSummary. + #: This constant has a value of "WAITING" + STATUS_WAITING = "WAITING" + + #: A constant which can be used with the status property of a WorkRequestSummary. + #: This constant has a value of "FAILED" + STATUS_FAILED = "FAILED" + + #: A constant which can be used with the status property of a WorkRequestSummary. + #: This constant has a value of "SUCCEEDED" + STATUS_SUCCEEDED = "SUCCEEDED" + + #: A constant which can be used with the status property of a WorkRequestSummary. + #: This constant has a value of "CANCELING" + STATUS_CANCELING = "CANCELING" + + #: A constant which can be used with the status property of a WorkRequestSummary. + #: This constant has a value of "CANCELED" + STATUS_CANCELED = "CANCELED" + + def __init__(self, **kwargs): + """ + Initializes a new WorkRequestSummary object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param operation_type: + The value to assign to the operation_type property of this WorkRequestSummary. + Allowed values for this property are: "CREATE_OPA_INSTANCE", "UPDATE_OPA_INSTANCE", "DELETE_OPA_INSTANCE", "MOVE_OPA_INSTANCE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type operation_type: str + + :param status: + The value to assign to the status property of this WorkRequestSummary. + Allowed values for this property are: "ACCEPTED", "IN_PROGRESS", "WAITING", "FAILED", "SUCCEEDED", "CANCELING", "CANCELED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type status: str + + :param id: + The value to assign to the id property of this WorkRequestSummary. + :type id: str + + :param compartment_id: + The value to assign to the compartment_id property of this WorkRequestSummary. + :type compartment_id: str + + :param resources: + The value to assign to the resources property of this WorkRequestSummary. + :type resources: list[oci.opa.models.WorkRequestResource] + + :param percent_complete: + The value to assign to the percent_complete property of this WorkRequestSummary. + :type percent_complete: float + + :param time_accepted: + The value to assign to the time_accepted property of this WorkRequestSummary. + :type time_accepted: datetime + + :param time_started: + The value to assign to the time_started property of this WorkRequestSummary. + :type time_started: datetime + + :param time_finished: + The value to assign to the time_finished property of this WorkRequestSummary. + :type time_finished: datetime + + """ + self.swagger_types = { + 'operation_type': 'str', + 'status': 'str', + 'id': 'str', + 'compartment_id': 'str', + 'resources': 'list[WorkRequestResource]', + 'percent_complete': 'float', + 'time_accepted': 'datetime', + 'time_started': 'datetime', + 'time_finished': 'datetime' + } + + self.attribute_map = { + 'operation_type': 'operationType', + 'status': 'status', + 'id': 'id', + 'compartment_id': 'compartmentId', + 'resources': 'resources', + 'percent_complete': 'percentComplete', + 'time_accepted': 'timeAccepted', + 'time_started': 'timeStarted', + 'time_finished': 'timeFinished' + } + + self._operation_type = None + self._status = None + self._id = None + self._compartment_id = None + self._resources = None + self._percent_complete = None + self._time_accepted = None + self._time_started = None + self._time_finished = None + + @property + def operation_type(self): + """ + **[Required]** Gets the operation_type of this WorkRequestSummary. + Type of the work request + + Allowed values for this property are: "CREATE_OPA_INSTANCE", "UPDATE_OPA_INSTANCE", "DELETE_OPA_INSTANCE", "MOVE_OPA_INSTANCE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The operation_type of this WorkRequestSummary. + :rtype: str + """ + return self._operation_type + + @operation_type.setter + def operation_type(self, operation_type): + """ + Sets the operation_type of this WorkRequestSummary. + Type of the work request + + + :param operation_type: The operation_type of this WorkRequestSummary. + :type: str + """ + allowed_values = ["CREATE_OPA_INSTANCE", "UPDATE_OPA_INSTANCE", "DELETE_OPA_INSTANCE", "MOVE_OPA_INSTANCE"] + if not value_allowed_none_or_none_sentinel(operation_type, allowed_values): + operation_type = 'UNKNOWN_ENUM_VALUE' + self._operation_type = operation_type + + @property + def status(self): + """ + **[Required]** Gets the status of this WorkRequestSummary. + Status of current work request. + + Allowed values for this property are: "ACCEPTED", "IN_PROGRESS", "WAITING", "FAILED", "SUCCEEDED", "CANCELING", "CANCELED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The status of this WorkRequestSummary. + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """ + Sets the status of this WorkRequestSummary. + Status of current work request. + + + :param status: The status of this WorkRequestSummary. + :type: str + """ + allowed_values = ["ACCEPTED", "IN_PROGRESS", "WAITING", "FAILED", "SUCCEEDED", "CANCELING", "CANCELED"] + if not value_allowed_none_or_none_sentinel(status, allowed_values): + status = 'UNKNOWN_ENUM_VALUE' + self._status = status + + @property + def id(self): + """ + **[Required]** Gets the id of this WorkRequestSummary. + The id of the work request. + + + :return: The id of this WorkRequestSummary. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this WorkRequestSummary. + The id of the work request. + + + :param id: The id of this WorkRequestSummary. + :type: str + """ + self._id = id + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this WorkRequestSummary. + The ocid of the compartment that contains the work request. Work requests should be scoped to + the same compartment as the resource the work request affects. If the work request affects multiple resources, + and those resources are not in the same compartment, it is up to the service team to pick the primary + resource whose compartment should be used + + + :return: The compartment_id of this WorkRequestSummary. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this WorkRequestSummary. + The ocid of the compartment that contains the work request. Work requests should be scoped to + the same compartment as the resource the work request affects. If the work request affects multiple resources, + and those resources are not in the same compartment, it is up to the service team to pick the primary + resource whose compartment should be used + + + :param compartment_id: The compartment_id of this WorkRequestSummary. + :type: str + """ + self._compartment_id = compartment_id + + @property + def resources(self): + """ + **[Required]** Gets the resources of this WorkRequestSummary. + The resources affected by this work request. + + + :return: The resources of this WorkRequestSummary. + :rtype: list[oci.opa.models.WorkRequestResource] + """ + return self._resources + + @resources.setter + def resources(self, resources): + """ + Sets the resources of this WorkRequestSummary. + The resources affected by this work request. + + + :param resources: The resources of this WorkRequestSummary. + :type: list[oci.opa.models.WorkRequestResource] + """ + self._resources = resources + + @property + def percent_complete(self): + """ + **[Required]** Gets the percent_complete of this WorkRequestSummary. + Percentage of the request completed. + + + :return: The percent_complete of this WorkRequestSummary. + :rtype: float + """ + return self._percent_complete + + @percent_complete.setter + def percent_complete(self, percent_complete): + """ + Sets the percent_complete of this WorkRequestSummary. + Percentage of the request completed. + + + :param percent_complete: The percent_complete of this WorkRequestSummary. + :type: float + """ + self._percent_complete = percent_complete + + @property + def time_accepted(self): + """ + **[Required]** Gets the time_accepted of this WorkRequestSummary. + The date and time the request was created, as described in + `RFC 3339`__, section 14.29. + + __ https://tools.ietf.org/rfc/rfc3339 + + + :return: The time_accepted of this WorkRequestSummary. + :rtype: datetime + """ + return self._time_accepted + + @time_accepted.setter + def time_accepted(self, time_accepted): + """ + Sets the time_accepted of this WorkRequestSummary. + The date and time the request was created, as described in + `RFC 3339`__, section 14.29. + + __ https://tools.ietf.org/rfc/rfc3339 + + + :param time_accepted: The time_accepted of this WorkRequestSummary. + :type: datetime + """ + self._time_accepted = time_accepted + + @property + def time_started(self): + """ + Gets the time_started of this WorkRequestSummary. + The date and time the request was started, as described in `RFC 3339`__, + section 14.29. + + __ https://tools.ietf.org/rfc/rfc3339 + + + :return: The time_started of this WorkRequestSummary. + :rtype: datetime + """ + return self._time_started + + @time_started.setter + def time_started(self, time_started): + """ + Sets the time_started of this WorkRequestSummary. + The date and time the request was started, as described in `RFC 3339`__, + section 14.29. + + __ https://tools.ietf.org/rfc/rfc3339 + + + :param time_started: The time_started of this WorkRequestSummary. + :type: datetime + """ + self._time_started = time_started + + @property + def time_finished(self): + """ + Gets the time_finished of this WorkRequestSummary. + The date and time the object was finished, as described in `RFC 3339`__. + + __ https://tools.ietf.org/rfc/rfc3339 + + + :return: The time_finished of this WorkRequestSummary. + :rtype: datetime + """ + return self._time_finished + + @time_finished.setter + def time_finished(self, time_finished): + """ + Sets the time_finished of this WorkRequestSummary. + The date and time the object was finished, as described in `RFC 3339`__. + + __ https://tools.ietf.org/rfc/rfc3339 + + + :param time_finished: The time_finished of this WorkRequestSummary. + :type: datetime + """ + self._time_finished = time_finished + + 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/opa/models/work_request_summary_collection.py b/src/oci/opa/models/work_request_summary_collection.py new file mode 100644 index 0000000000..5e14c7c44c --- /dev/null +++ b/src/oci/opa/models/work_request_summary_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from 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 WorkRequestSummaryCollection(object): + """ + Results of a workRequest search. Contains both WorkRequest items and other information, such as metadata. + """ + + def __init__(self, **kwargs): + """ + Initializes a new WorkRequestSummaryCollection 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 WorkRequestSummaryCollection. + :type items: list[oci.opa.models.WorkRequestSummary] + + """ + self.swagger_types = { + 'items': 'list[WorkRequestSummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this WorkRequestSummaryCollection. + List of workRequestSummary objects. + + + :return: The items of this WorkRequestSummaryCollection. + :rtype: list[oci.opa.models.WorkRequestSummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this WorkRequestSummaryCollection. + List of workRequestSummary objects. + + + :param items: The items of this WorkRequestSummaryCollection. + :type: list[oci.opa.models.WorkRequestSummary] + """ + 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/opa/opa_instance_client.py b/src/oci/opa/opa_instance_client.py new file mode 100644 index 0000000000..8a16615b92 --- /dev/null +++ b/src/oci/opa/opa_instance_client.py @@ -0,0 +1,1357 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from __future__ import absolute_import + +from oci._vendor import requests # noqa: F401 +from oci._vendor import six + +from oci import retry, circuit_breaker # noqa: F401 +from oci.base_client import BaseClient +from oci.config import get_config_value_or_default, validate_config +from oci.signer import Signer +from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from .models import opa_type_mapping +missing = Sentinel("Missing") + + +class OpaInstanceClient(object): + """ + A description of the OracleProcessAutomation API + """ + + def __init__(self, config, **kwargs): + """ + Creates a new service client + + :param dict config: + Configuration keys and values as per `SDK and Tool Configuration `__. + The :py:meth:`~oci.config.from_file` method can be used to load configuration from a file. Alternatively, a ``dict`` can be passed. You can validate_config + the dict using :py:meth:`~oci.config.validate_config` + + :param str service_endpoint: (optional) + The endpoint of the service to call using this client. For example ``https://iaas.us-ashburn-1.oraclecloud.com``. If this keyword argument is + not provided then it will be derived using the region in the config parameter. You should only provide this keyword argument if you have an explicit + need to specify a service endpoint. + + :param timeout: (optional) + The connection and read timeouts for the client. The default values are connection timeout 10 seconds and read timeout 60 seconds. This keyword argument can be provided + as a single float, in which case the value provided is used for both the read and connection timeouts, or as a tuple of two floats. If + a tuple is provided then the first value is used as the connection timeout and the second value as the read timeout. + :type timeout: float or tuple(float, float) + + :param signer: (optional) + The signer to use when signing requests made by the service client. The default is to use a :py:class:`~oci.signer.Signer` based on the values + provided in the config parameter. + + One use case for this parameter is for `Instance Principals authentication `__ + by passing an instance of :py:class:`~oci.auth.signers.InstancePrincipalsSecurityTokenSigner` as the value for this keyword argument + :type signer: :py:class:`~oci.signer.AbstractBaseSigner` + + :param obj retry_strategy: (optional) + A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. + Retry strategies can also be applied at the operation level by passing a ``retry_strategy`` keyword argument as part of calling the operation. + Any value provided at the operation level will override whatever is specified at the client level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` + is also available. The specifics of the default retry strategy are described `here `__. + + :param obj circuit_breaker_strategy: (optional) + A circuit breaker strategy to apply to all calls made by this service client (i.e. at the client level). + This client uses :py:data:`~oci.circuit_breaker.DEFAULT_CIRCUIT_BREAKER_STRATEGY` as default if no circuit breaker strategy is provided. + The specifics of circuit breaker strategy are described `here `__. + + :param function circuit_breaker_callback: (optional) + Callback function to receive any exceptions triggerred by the circuit breaker. + + :param allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not + allow control characters to be in the response object. + """ + validate_config(config, signer=kwargs.get('signer')) + if 'signer' in kwargs: + signer = kwargs['signer'] + + elif AUTHENTICATION_TYPE_FIELD_NAME in config: + signer = get_signer_from_authentication_type(config) + + else: + signer = Signer( + tenancy=config["tenancy"], + user=config["user"], + fingerprint=config["fingerprint"], + private_key_file_location=config.get("key_file"), + pass_phrase=get_config_value_or_default(config, "pass_phrase"), + private_key_content=config.get("key_content") + ) + + base_client_init_kwargs = { + 'regional_client': True, + 'service_endpoint': kwargs.get('service_endpoint'), + 'base_path': '/20210621', + 'service_endpoint_template': 'https://process-automation.{region}.oci.{secondLevelDomain}', + 'skip_deserialization': kwargs.get('skip_deserialization', False), + 'circuit_breaker_strategy': kwargs.get('circuit_breaker_strategy', circuit_breaker.GLOBAL_CIRCUIT_BREAKER_STRATEGY) + } + if 'timeout' in kwargs: + base_client_init_kwargs['timeout'] = kwargs.get('timeout') + if base_client_init_kwargs.get('circuit_breaker_strategy') is None: + base_client_init_kwargs['circuit_breaker_strategy'] = circuit_breaker.DEFAULT_CIRCUIT_BREAKER_STRATEGY + if 'allow_control_chars' in kwargs: + base_client_init_kwargs['allow_control_chars'] = kwargs.get('allow_control_chars') + self.base_client = BaseClient("opa_instance", config, signer, opa_type_mapping, **base_client_init_kwargs) + self.retry_strategy = kwargs.get('retry_strategy') + self.circuit_breaker_callback = kwargs.get('circuit_breaker_callback') + + def cancel_work_request(self, work_request_id, **kwargs): + """ + Cancel work request with the given ID. + + + :param str work_request_id: (required) + The ID of the asynchronous 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 str opc_request_id: (optional) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use cancel_work_request API. + """ + resource_path = "/workRequests/{workRequestId}" + method = "DELETE" + operation_name = "cancel_work_request" + api_reference_link = "" + + # 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( + "cancel_work_request got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "workRequestId": work_request_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "if-match": kwargs.get("if_match", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + 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) + 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) + + def change_opa_instance_compartment(self, opa_instance_id, change_opa_instance_compartment_details, **kwargs): + """ + Moves a OpaInstance resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource. + + + :param str opa_instance_id: (required) + unique OpaInstance identifier + + :param oci.opa.models.ChangeOpaInstanceCompartmentDetails change_opa_instance_compartment_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 will be updated or deleted only if the etag you + provide matches the resource's current etag value. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use change_opa_instance_compartment API. + """ + resource_path = "/opaInstances/{opaInstanceId}/actions/changeCompartment" + method = "POST" + operation_name = "change_opa_instance_compartment" + api_reference_link = "" + + # 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( + "change_opa_instance_compartment got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "opaInstanceId": opa_instance_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "if-match": kwargs.get("if_match", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + 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=change_opa_instance_compartment_details, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=change_opa_instance_compartment_details, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def create_opa_instance(self, create_opa_instance_details, **kwargs): + """ + Creates a new OpaInstance. + + + :param oci.opa.models.CreateOpaInstanceDetails create_opa_instance_details: (required) + Details for the new OpaInstance. + + :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) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use create_opa_instance API. + """ + resource_path = "/opaInstances" + method = "POST" + operation_name = "create_opa_instance" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_retry_token", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "create_opa_instance got unknown kwargs: {!r}".format(extra_kwargs)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-retry-token": kwargs.get("opc_retry_token", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + 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_opa_instance_details, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + header_params=header_params, + body=create_opa_instance_details, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def delete_opa_instance(self, opa_instance_id, **kwargs): + """ + Deletes a OpaInstance resource by identifier + + + :param str opa_instance_id: (required) + unique OpaInstance identifier + + :param str if_match: (optional) + For optimistic concurrency control. In the PUT or DELETE call + for a resource, set the `if-match` parameter to the value of the + etag from a previous GET or POST response for that resource. + The resource will be updated or deleted only if the etag you + provide matches the resource's current etag value. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use delete_opa_instance API. + """ + resource_path = "/opaInstances/{opaInstanceId}" + method = "DELETE" + operation_name = "delete_opa_instance" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "if_match", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "delete_opa_instance got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "opaInstanceId": opa_instance_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "if-match": kwargs.get("if_match", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + 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) + 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) + + def get_opa_instance(self, opa_instance_id, **kwargs): + """ + Gets a OpaInstance by identifier + + + :param str opa_instance_id: (required) + unique OpaInstance identifier + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.opa.models.OpaInstance` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_opa_instance API. + """ + resource_path = "/opaInstances/{opaInstanceId}" + method = "GET" + operation_name = "get_opa_instance" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "get_opa_instance got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "opaInstanceId": opa_instance_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="OpaInstance", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="OpaInstance", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def get_work_request(self, work_request_id, **kwargs): + """ + Gets the status of the work request with the given ID. + + + :param str work_request_id: (required) + The ID of the asynchronous request. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.opa.models.WorkRequest` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_work_request API. + """ + resource_path = "/workRequests/{workRequestId}" + method = "GET" + operation_name = "get_work_request" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "get_work_request got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "workRequestId": work_request_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="WorkRequest", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="WorkRequest", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def list_opa_instances(self, **kwargs): + """ + Returns a list of OpaInstances. + + + :param str compartment_id: (optional) + The ID of the compartment in which to list resources. + + :param str lifecycle_state: (optional) + A filter to return only resources their lifecycleState matches the given lifecycleState. + + Allowed values are: "CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED" + + :param str display_name: (optional) + A filter to return only resources that match the entire display name given. + + :param str id: (optional) + unique OpaInstance identifier + + :param int limit: (optional) + The maximum number of items to return. + + :param str page: (optional) + A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response. + + :param str sort_order: (optional) + The sort order to use, either 'ASC' or 'DESC'. + + Allowed values are: "ASC", "DESC" + + :param str sort_by: (optional) + The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. + + Allowed values are: "timeCreated", "displayName" + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.opa.models.OpaInstanceCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_opa_instances API. + """ + resource_path = "/opaInstances" + method = "GET" + operation_name = "list_opa_instances" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "compartment_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( + "list_opa_instances got unknown kwargs: {!r}".format(extra_kwargs)) + + if 'lifecycle_state' in kwargs: + lifecycle_state_allowed_values = ["CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED"] + if kwargs['lifecycle_state'] not in lifecycle_state_allowed_values: + raise ValueError( + "Invalid value for `lifecycle_state`, must be one of {0}".format(lifecycle_state_allowed_values) + ) + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + "Invalid value for `sort_order`, must be one of {0}".format(sort_order_allowed_values) + ) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["timeCreated", "displayName"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) + ) + + query_params = { + "compartmentId": kwargs.get("compartment_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: + 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="OpaInstanceCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + query_params=query_params, + header_params=header_params, + response_type="OpaInstanceCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def list_work_request_errors(self, work_request_id, **kwargs): + """ + Return a (paginated) list of errors for a given work request. + + + :param str work_request_id: (required) + The ID of the asynchronous request. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param str page: (optional) + A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response. + + :param int limit: (optional) + The maximum number of items to return. + + :param str sort_by: (optional) + The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending. + + Allowed values are: "timeAccepted" + + :param str sort_order: (optional) + The sort order to use, either 'ASC' or 'DESC'. + + Allowed values are: "ASC", "DESC" + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.opa.models.WorkRequestErrorCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_work_request_errors API. + """ + resource_path = "/workRequests/{workRequestId}/errors" + method = "GET" + operation_name = "list_work_request_errors" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id", + "page", + "limit", + "sort_by", + "sort_order" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_work_request_errors got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "workRequestId": work_request_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["timeAccepted"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) + ) + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + "Invalid value for `sort_order`, must be one of {0}".format(sort_order_allowed_values) + ) + + query_params = { + "page": kwargs.get("page", missing), + "limit": kwargs.get("limit", missing), + "sortBy": kwargs.get("sort_by", missing), + "sortOrder": kwargs.get("sort_order", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + query_params=query_params, + header_params=header_params, + response_type="WorkRequestErrorCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + 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="WorkRequestErrorCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def list_work_request_logs(self, work_request_id, **kwargs): + """ + Return a (paginated) list of logs for a given work request. + + + :param str work_request_id: (required) + The ID of the asynchronous request. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param str page: (optional) + A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response. + + :param int limit: (optional) + The maximum number of items to return. + + :param str sort_by: (optional) + The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending. + + Allowed values are: "timeAccepted" + + :param str sort_order: (optional) + The sort order to use, either 'ASC' or 'DESC'. + + Allowed values are: "ASC", "DESC" + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.opa.models.WorkRequestLogEntryCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_work_request_logs API. + """ + resource_path = "/workRequests/{workRequestId}/logs" + method = "GET" + operation_name = "list_work_request_logs" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id", + "page", + "limit", + "sort_by", + "sort_order" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_work_request_logs got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "workRequestId": work_request_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["timeAccepted"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) + ) + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + "Invalid value for `sort_order`, must be one of {0}".format(sort_order_allowed_values) + ) + + query_params = { + "page": kwargs.get("page", missing), + "limit": kwargs.get("limit", missing), + "sortBy": kwargs.get("sort_by", missing), + "sortOrder": kwargs.get("sort_order", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + query_params=query_params, + header_params=header_params, + response_type="WorkRequestLogEntryCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + 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="WorkRequestLogEntryCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def list_work_requests(self, **kwargs): + """ + Lists the work requests in a compartment. + + + :param str compartment_id: (optional) + The ID of the compartment in which to list resources. + + :param str work_request_id: (optional) + The ID of the asynchronous work request. + + :param str status: (optional) + A filter to return only resources their lifecycleState matches the given OperationStatus. + + Allowed values are: "ACCEPTED", "IN_PROGRESS", "WAITING", "FAILED", "SUCCEEDED", "CANCELING", "CANCELED" + + :param str resource_id: (optional) + The ID of the resource affected by the work request. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param str page: (optional) + A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response. + + :param int limit: (optional) + The maximum number of items to return. + + :param str sort_order: (optional) + The sort order to use, either 'ASC' or 'DESC'. + + Allowed values are: "ASC", "DESC" + + :param str sort_by: (optional) + The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending. + + Allowed values are: "timeAccepted" + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.opa.models.WorkRequestSummaryCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_work_requests API. + """ + resource_path = "/workRequests" + method = "GET" + operation_name = "list_work_requests" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "compartment_id", + "work_request_id", + "status", + "resource_id", + "opc_request_id", + "page", + "limit", + "sort_order", + "sort_by" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_work_requests got unknown kwargs: {!r}".format(extra_kwargs)) + + if 'status' in kwargs: + status_allowed_values = ["ACCEPTED", "IN_PROGRESS", "WAITING", "FAILED", "SUCCEEDED", "CANCELING", "CANCELED"] + if kwargs['status'] not in status_allowed_values: + raise ValueError( + "Invalid value for `status`, must be one of {0}".format(status_allowed_values) + ) + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + "Invalid value for `sort_order`, must be one of {0}".format(sort_order_allowed_values) + ) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["timeAccepted"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) + ) + + query_params = { + "compartmentId": kwargs.get("compartment_id", missing), + "workRequestId": kwargs.get("work_request_id", missing), + "status": kwargs.get("status", missing), + "resourceId": kwargs.get("resource_id", missing), + "page": kwargs.get("page", missing), + "limit": kwargs.get("limit", 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: + 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="WorkRequestSummaryCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + query_params=query_params, + header_params=header_params, + response_type="WorkRequestSummaryCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + + def update_opa_instance(self, opa_instance_id, update_opa_instance_details, **kwargs): + """ + Updates the OpaInstance + + + :param str opa_instance_id: (required) + unique OpaInstance identifier + + :param oci.opa.models.UpdateOpaInstanceDetails update_opa_instance_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 will be updated or deleted only if the etag you + provide matches the resource's current etag value. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use update_opa_instance API. + """ + resource_path = "/opaInstances/{opaInstanceId}" + method = "PUT" + operation_name = "update_opa_instance" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "if_match", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "update_opa_instance got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "opaInstanceId": opa_instance_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "if-match": kwargs.get("if_match", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + 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_opa_instance_details, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=update_opa_instance_details, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) diff --git a/src/oci/opa/opa_instance_client_composite_operations.py b/src/oci/opa/opa_instance_client_composite_operations.py new file mode 100644 index 0000000000..d5c2f728bf --- /dev/null +++ b/src/oci/opa/opa_instance_client_composite_operations.py @@ -0,0 +1,190 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, 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. + +import oci # noqa: F401 +from oci.util import WAIT_RESOURCE_NOT_FOUND # noqa: F401 + + +class OpaInstanceClientCompositeOperations(object): + """ + This class provides a wrapper around :py:class:`~oci.opa.OpaInstanceClient` and offers convenience methods + for operations that would otherwise need to be chained together. For example, instead of performing an action + on a resource (e.g. launching an instance, creating a load balancer) and then using a waiter to wait for the resource + to enter a given state, you can call a single method in this class to accomplish the same functionality + """ + + def __init__(self, client, **kwargs): + """ + Creates a new OpaInstanceClientCompositeOperations object + + :param OpaInstanceClient client: + The service client which will be wrapped by this object + """ + self.client = client + + def change_opa_instance_compartment_and_wait_for_state(self, opa_instance_id, change_opa_instance_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.opa.OpaInstanceClient.change_opa_instance_compartment` and waits for the :py:class:`~oci.opa.models.WorkRequest` + to enter the given state(s). + + :param str opa_instance_id: (required) + unique OpaInstance identifier + + :param oci.opa.models.ChangeOpaInstanceCompartmentDetails change_opa_instance_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.opa.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.opa.OpaInstanceClient.change_opa_instance_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_opa_instance_compartment(opa_instance_id, change_opa_instance_compartment_details, **operation_kwargs) + if not wait_for_states: + return operation_result + + lowered_wait_for_states = [w.lower() for w in wait_for_states] + 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_opa_instance_and_wait_for_state(self, create_opa_instance_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.opa.OpaInstanceClient.create_opa_instance` and waits for the :py:class:`~oci.opa.models.WorkRequest` + to enter the given state(s). + + :param oci.opa.models.CreateOpaInstanceDetails create_opa_instance_details: (required) + Details for the new OpaInstance. + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.opa.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.opa.OpaInstanceClient.create_opa_instance` + + :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_opa_instance(create_opa_instance_details, **operation_kwargs) + if not wait_for_states: + return operation_result + + lowered_wait_for_states = [w.lower() for w in wait_for_states] + 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_opa_instance_and_wait_for_state(self, opa_instance_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.opa.OpaInstanceClient.delete_opa_instance` and waits for the :py:class:`~oci.opa.models.WorkRequest` + to enter the given state(s). + + :param str opa_instance_id: (required) + unique OpaInstance identifier + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.opa.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.opa.OpaInstanceClient.delete_opa_instance` + + :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_opa_instance(opa_instance_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] + 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_opa_instance_and_wait_for_state(self, opa_instance_id, update_opa_instance_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.opa.OpaInstanceClient.update_opa_instance` and waits for the :py:class:`~oci.opa.models.WorkRequest` + to enter the given state(s). + + :param str opa_instance_id: (required) + unique OpaInstance identifier + + :param oci.opa.models.UpdateOpaInstanceDetails update_opa_instance_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.opa.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.opa.OpaInstanceClient.update_opa_instance` + + :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_opa_instance(opa_instance_id, update_opa_instance_details, **operation_kwargs) + if not wait_for_states: + return operation_result + + lowered_wait_for_states = [w.lower() for w in wait_for_states] + 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/regions_definitions.py b/src/oci/regions_definitions.py index a505aa0712..96982c0321 100644 --- a/src/oci/regions_definitions.py +++ b/src/oci/regions_definitions.py @@ -34,6 +34,7 @@ 'arn': 'eu-stockholm-1', 'jnb': 'af-johannesburg-1', 'cdg': 'eu-paris-1', + 'qro': 'mx-queretaro-1', 'lfi': 'us-langley-1', 'luf': 'us-luke-1', 'ric': 'us-gov-ashburn-1', @@ -78,6 +79,7 @@ 'eu-stockholm-1': 'oc1', 'af-johannesburg-1': 'oc1', 'eu-paris-1': 'oc1', + 'mx-queretaro-1': 'oc1', 'us-langley-1': 'oc2', 'us-luke-1': 'oc2', @@ -137,6 +139,7 @@ 'eu-stockholm-1', 'af-johannesburg-1', 'eu-paris-1', + 'mx-queretaro-1', 'us-langley-1', 'us-luke-1', 'us-gov-ashburn-1', diff --git a/src/oci/stack_monitoring/models/discovery_details.py b/src/oci/stack_monitoring/models/discovery_details.py index cb5a1e9343..fa076022ec 100644 --- a/src/oci/stack_monitoring/models/discovery_details.py +++ b/src/oci/stack_monitoring/models/discovery_details.py @@ -25,6 +25,18 @@ class DiscoveryDetails(object): #: This constant has a value of "ORACLE_DATABASE" RESOURCE_TYPE_ORACLE_DATABASE = "ORACLE_DATABASE" + #: A constant which can be used with the resource_type property of a DiscoveryDetails. + #: This constant has a value of "OCI_ORACLE_DB" + RESOURCE_TYPE_OCI_ORACLE_DB = "OCI_ORACLE_DB" + + #: A constant which can be used with the resource_type property of a DiscoveryDetails. + #: This constant has a value of "OCI_ORACLE_CDB" + RESOURCE_TYPE_OCI_ORACLE_CDB = "OCI_ORACLE_CDB" + + #: A constant which can be used with the resource_type property of a DiscoveryDetails. + #: This constant has a value of "OCI_ORACLE_PDB" + RESOURCE_TYPE_OCI_ORACLE_PDB = "OCI_ORACLE_PDB" + def __init__(self, **kwargs): """ Initializes a new DiscoveryDetails object with values from keyword arguments. @@ -36,7 +48,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", "ORACLE_DATABASE", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "WEBLOGIC_DOMAIN", "EBS_INSTANCE", "ORACLE_DATABASE", "OCI_ORACLE_DB", "OCI_ORACLE_CDB", "OCI_ORACLE_PDB", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type resource_type: str @@ -112,7 +124,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", "ORACLE_DATABASE", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "WEBLOGIC_DOMAIN", "EBS_INSTANCE", "ORACLE_DATABASE", "OCI_ORACLE_DB", "OCI_ORACLE_CDB", "OCI_ORACLE_PDB", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -131,7 +143,7 @@ def resource_type(self, resource_type): :param resource_type: The resource_type of this DiscoveryDetails. :type: str """ - allowed_values = ["WEBLOGIC_DOMAIN", "EBS_INSTANCE", "ORACLE_DATABASE"] + allowed_values = ["WEBLOGIC_DOMAIN", "EBS_INSTANCE", "ORACLE_DATABASE", "OCI_ORACLE_DB", "OCI_ORACLE_CDB", "OCI_ORACLE_PDB"] 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 0dbc732150..ad72079b19 100644 --- a/src/oci/stack_monitoring/models/discovery_job_summary.py +++ b/src/oci/stack_monitoring/models/discovery_job_summary.py @@ -25,6 +25,18 @@ class DiscoveryJobSummary(object): #: This constant has a value of "ORACLE_DATABASE" RESOURCE_TYPE_ORACLE_DATABASE = "ORACLE_DATABASE" + #: A constant which can be used with the resource_type property of a DiscoveryJobSummary. + #: This constant has a value of "OCI_ORACLE_DB" + RESOURCE_TYPE_OCI_ORACLE_DB = "OCI_ORACLE_DB" + + #: A constant which can be used with the resource_type property of a DiscoveryJobSummary. + #: This constant has a value of "OCI_ORACLE_CDB" + RESOURCE_TYPE_OCI_ORACLE_CDB = "OCI_ORACLE_CDB" + + #: A constant which can be used with the resource_type property of a DiscoveryJobSummary. + #: This constant has a value of "OCI_ORACLE_PDB" + RESOURCE_TYPE_OCI_ORACLE_PDB = "OCI_ORACLE_PDB" + #: A constant which can be used with the discovery_type property of a DiscoveryJobSummary. #: This constant has a value of "ADD" DISCOVERY_TYPE_ADD = "ADD" @@ -96,7 +108,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", "ORACLE_DATABASE", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "WEBLOGIC_DOMAIN", "EBS_INSTANCE", "ORACLE_DATABASE", "OCI_ORACLE_DB", "OCI_ORACLE_CDB", "OCI_ORACLE_PDB", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type resource_type: str @@ -234,7 +246,7 @@ def resource_type(self): Gets the resource_type of this DiscoveryJobSummary. Resource Type - Allowed values for this property are: "WEBLOGIC_DOMAIN", "EBS_INSTANCE", "ORACLE_DATABASE", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "WEBLOGIC_DOMAIN", "EBS_INSTANCE", "ORACLE_DATABASE", "OCI_ORACLE_DB", "OCI_ORACLE_CDB", "OCI_ORACLE_PDB", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -253,7 +265,7 @@ def resource_type(self, resource_type): :param resource_type: The resource_type of this DiscoveryJobSummary. :type: str """ - allowed_values = ["WEBLOGIC_DOMAIN", "EBS_INSTANCE", "ORACLE_DATABASE"] + allowed_values = ["WEBLOGIC_DOMAIN", "EBS_INSTANCE", "ORACLE_DATABASE", "OCI_ORACLE_DB", "OCI_ORACLE_CDB", "OCI_ORACLE_PDB"] 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/work_request.py b/src/oci/stack_monitoring/models/work_request.py index 040e2532ab..e4e1428efa 100644 --- a/src/oci/stack_monitoring/models/work_request.py +++ b/src/oci/stack_monitoring/models/work_request.py @@ -41,6 +41,10 @@ class WorkRequest(object): #: This constant has a value of "ADD_SOURCES_TO_AGENT" OPERATION_TYPE_ADD_SOURCES_TO_AGENT = "ADD_SOURCES_TO_AGENT" + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "BULK_ADD_RESOURCES" + OPERATION_TYPE_BULK_ADD_RESOURCES = "BULK_ADD_RESOURCES" + #: A constant which can be used with the status property of a WorkRequest. #: This constant has a value of "ACCEPTED" STATUS_ACCEPTED = "ACCEPTED" @@ -76,7 +80,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: "CREATE_RESOURCES", "UPDATE_RESOURCES", "DELETE_RESOURCES", "MOVE_RESOURCES", "ENABLE_EXTERNAL_DATABASE", "DISABLE_EXTERNAL_DATABASE", "ADD_SOURCES_TO_AGENT", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "CREATE_RESOURCES", "UPDATE_RESOURCES", "DELETE_RESOURCES", "MOVE_RESOURCES", "ENABLE_EXTERNAL_DATABASE", "DISABLE_EXTERNAL_DATABASE", "ADD_SOURCES_TO_AGENT", "BULK_ADD_RESOURCES", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type operation_type: str @@ -155,7 +159,7 @@ def operation_type(self): **[Required]** Gets the operation_type of this WorkRequest. Type of the work request - Allowed values for this property are: "CREATE_RESOURCES", "UPDATE_RESOURCES", "DELETE_RESOURCES", "MOVE_RESOURCES", "ENABLE_EXTERNAL_DATABASE", "DISABLE_EXTERNAL_DATABASE", "ADD_SOURCES_TO_AGENT", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "CREATE_RESOURCES", "UPDATE_RESOURCES", "DELETE_RESOURCES", "MOVE_RESOURCES", "ENABLE_EXTERNAL_DATABASE", "DISABLE_EXTERNAL_DATABASE", "ADD_SOURCES_TO_AGENT", "BULK_ADD_RESOURCES", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -174,7 +178,7 @@ def operation_type(self, operation_type): :param operation_type: The operation_type of this WorkRequest. :type: str """ - allowed_values = ["CREATE_RESOURCES", "UPDATE_RESOURCES", "DELETE_RESOURCES", "MOVE_RESOURCES", "ENABLE_EXTERNAL_DATABASE", "DISABLE_EXTERNAL_DATABASE", "ADD_SOURCES_TO_AGENT"] + allowed_values = ["CREATE_RESOURCES", "UPDATE_RESOURCES", "DELETE_RESOURCES", "MOVE_RESOURCES", "ENABLE_EXTERNAL_DATABASE", "DISABLE_EXTERNAL_DATABASE", "ADD_SOURCES_TO_AGENT", "BULK_ADD_RESOURCES"] 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/stack_monitoring/models/work_request_summary.py b/src/oci/stack_monitoring/models/work_request_summary.py index bc95063434..ab074a0e8f 100644 --- a/src/oci/stack_monitoring/models/work_request_summary.py +++ b/src/oci/stack_monitoring/models/work_request_summary.py @@ -41,6 +41,10 @@ class WorkRequestSummary(object): #: This constant has a value of "ADD_SOURCES_TO_AGENT" OPERATION_TYPE_ADD_SOURCES_TO_AGENT = "ADD_SOURCES_TO_AGENT" + #: A constant which can be used with the operation_type property of a WorkRequestSummary. + #: This constant has a value of "BULK_ADD_RESOURCES" + OPERATION_TYPE_BULK_ADD_RESOURCES = "BULK_ADD_RESOURCES" + #: A constant which can be used with the status property of a WorkRequestSummary. #: This constant has a value of "ACCEPTED" STATUS_ACCEPTED = "ACCEPTED" @@ -76,7 +80,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: "CREATE_RESOURCES", "UPDATE_RESOURCES", "DELETE_RESOURCES", "MOVE_RESOURCES", "ENABLE_EXTERNAL_DATABASE", "DISABLE_EXTERNAL_DATABASE", "ADD_SOURCES_TO_AGENT", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "CREATE_RESOURCES", "UPDATE_RESOURCES", "DELETE_RESOURCES", "MOVE_RESOURCES", "ENABLE_EXTERNAL_DATABASE", "DISABLE_EXTERNAL_DATABASE", "ADD_SOURCES_TO_AGENT", "BULK_ADD_RESOURCES", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type operation_type: str @@ -155,7 +159,7 @@ def operation_type(self): **[Required]** Gets the operation_type of this WorkRequestSummary. Type of the work request - Allowed values for this property are: "CREATE_RESOURCES", "UPDATE_RESOURCES", "DELETE_RESOURCES", "MOVE_RESOURCES", "ENABLE_EXTERNAL_DATABASE", "DISABLE_EXTERNAL_DATABASE", "ADD_SOURCES_TO_AGENT", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "CREATE_RESOURCES", "UPDATE_RESOURCES", "DELETE_RESOURCES", "MOVE_RESOURCES", "ENABLE_EXTERNAL_DATABASE", "DISABLE_EXTERNAL_DATABASE", "ADD_SOURCES_TO_AGENT", "BULK_ADD_RESOURCES", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -174,7 +178,7 @@ def operation_type(self, operation_type): :param operation_type: The operation_type of this WorkRequestSummary. :type: str """ - allowed_values = ["CREATE_RESOURCES", "UPDATE_RESOURCES", "DELETE_RESOURCES", "MOVE_RESOURCES", "ENABLE_EXTERNAL_DATABASE", "DISABLE_EXTERNAL_DATABASE", "ADD_SOURCES_TO_AGENT"] + allowed_values = ["CREATE_RESOURCES", "UPDATE_RESOURCES", "DELETE_RESOURCES", "MOVE_RESOURCES", "ENABLE_EXTERNAL_DATABASE", "DISABLE_EXTERNAL_DATABASE", "ADD_SOURCES_TO_AGENT", "BULK_ADD_RESOURCES"] 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/version.py b/src/oci/version.py index 45c2358397..d7325d6e03 100644 --- a/src/oci/version.py +++ b/src/oci/version.py @@ -2,4 +2,4 @@ # Copyright (c) 2016, 2022, 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.75.0" +__version__ = "2.75.1"